]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/qt4/GuiDocument.cpp
This commit changes the way individual LyXModule's are represented, both internally...
[lyx.git] / src / frontends / qt4 / GuiDocument.cpp
index be58327303623abf3ff49a0f65037f11c8f7e43b..573696464114917b323554e51376660f2c95f41d 100644 (file)
@@ -42,6 +42,7 @@
 
 #include "insets/InsetListingsParams.h"
 
+//#include "support/debug.h"
 #include "support/FileName.h"
 #include "support/filetools.h"
 #include "support/lstrings.h"
@@ -134,6 +135,288 @@ vector<pair<string, lyx::docstring> > pagestyles;
 namespace lyx {
 namespace frontend {
 
+namespace {
+       vector<string> getRequiredList(string const & modName) 
+       {
+               LyXModule const * const mod = moduleList[modName];
+               if (!mod)
+                       return vector<string>(); //empty such thing
+               return mod->getRequiredModules();
+       }
+
+
+       vector<string> getExcludedList(string const & modName)
+       {
+               LyXModule const * const mod = moduleList[modName];
+               if (!mod)
+                       return vector<string>(); //empty such thing
+               return mod->getExcludedModules();
+       }
+
+
+       docstring getModuleDescription(string const & modName)
+       {
+               LyXModule const * const mod = moduleList[modName];
+               if (!mod)
+                       return _("Module not found!");
+               return from_ascii(mod->getDescription());
+       }
+
+
+       vector<string> getPackageList(string const & modName)
+       {
+               LyXModule const * const mod = moduleList[modName];
+               if (!mod)
+                       return vector<string>(); //empty such thing
+               return mod->getPackageList();
+       }
+
+
+       bool isModuleAvailable(string const & modName)
+       {
+               LyXModule * mod = moduleList[modName];
+               if (!mod)
+                       return false;
+               return mod->isAvailable();
+       }
+} //anonymous namespace
+
+
+ModuleSelMan::ModuleSelMan(
+       QListView * availableLV, 
+       QListView * selectedLV,
+       QPushButton * addPB, 
+       QPushButton * delPB, 
+       QPushButton * upPB, 
+       QPushButton * downPB,
+       GuiIdListModel * availableModel,
+       GuiIdListModel * selectedModel) :
+GuiSelectionManager(availableLV, selectedLV, addPB, delPB,
+                    upPB, downPB, availableModel, selectedModel) 
+{}
+       
+       
+namespace {
+QModelIndex getSelectedIndex(QListView * lv)
+{
+       QModelIndex retval = QModelIndex();
+       QModelIndexList selIdx = 
+                       lv->selectionModel()->selectedIndexes();
+       if (!selIdx.empty())
+               retval = selIdx.first();
+       return retval;
+}
+}
+
+
+void ModuleSelMan::updateAddPB() 
+{
+       int const arows = availableModel->rowCount();
+       QModelIndexList const availSels = 
+                       availableLV->selectionModel()->selectedIndexes();
+       if (arows == 0 || availSels.isEmpty()  || isSelected(availSels.first())) {
+               addPB->setEnabled(false);
+               return;
+       }
+       
+       QModelIndex const & idx = availableLV->selectionModel()->currentIndex();
+       string const modName = getAvailableModel()->getIDString(idx.row());
+       vector<string> reqs = getRequiredList(modName);
+       vector<string> excl = getExcludedList(modName);
+       
+       if (reqs.empty() && excl.empty()) {
+               addPB->setEnabled(true);
+               return;
+       }
+
+       int const srows = selectedModel->rowCount();
+       vector<string> selModList;
+       for (int i = 0; i < srows; ++i)
+               selModList.push_back(getSelectedModel()->getIDString(i));
+
+       vector<string>::const_iterator selModStart = selModList.begin();
+       vector<string>::const_iterator selModEnd   = selModList.end();
+       
+       //Check whether some required module is available
+       if (!reqs.empty()) {
+               bool foundOne = false;
+               vector<string>::const_iterator it  = reqs.begin();
+               vector<string>::const_iterator end = reqs.end();
+               for (; it != end; ++it) {
+                       if (find(selModStart, selModEnd, *it) != selModEnd) {
+                               foundOne = true;
+                               break;
+                       }
+               }
+               if (!foundOne) {
+                       addPB->setEnabled(false);
+                       return;
+               }
+       }
+       
+       //Check whether any excluded module is being used
+       if (!excl.empty()) {
+               vector<string>::const_iterator it  = excl.begin();
+               vector<string>::const_iterator end = excl.end();
+               for (; it != end; ++it) {
+                       if (find(selModStart, selModEnd, *it) != selModEnd) {
+                               addPB->setEnabled(false);
+                               return;
+                       }
+               }
+       }
+
+       addPB->setEnabled(true);
+}
+
+
+void ModuleSelMan::updateDownPB()
+{
+       int const srows = selectedModel->rowCount();
+       if (srows == 0) {
+               downPB->setEnabled(false);
+               return;
+       }
+       QModelIndexList const selSels = 
+                       selectedLV->selectionModel()->selectedIndexes();
+       //disable if empty or last item is selected
+       if (selSels.empty() || selSels.first().row() == srows - 1) {
+               downPB->setEnabled(false);
+               return;
+       }
+       //determine whether immediately succeding element requires this one
+       QModelIndex const & curIdx = selectedLV->selectionModel()->currentIndex();
+       int curRow = curIdx.row();
+       if (curRow < 0 || curRow >= srows - 1) { //this shouldn't happen...
+               downPB->setEnabled(false);
+               return;
+       }
+       string const curModName = getSelectedModel()->getIDString(curRow);
+       string const nextModName = getSelectedModel()->getIDString(curRow + 1);
+
+       vector<string> reqs = getRequiredList(nextModName);
+
+       //if it doesn't require anything....
+       if (reqs.empty()) {
+               downPB->setEnabled(true);
+               return;
+       }
+
+       //FIXME This should perhaps be more flexible and check whether, even 
+       //if this one is required, there is also an earlier one that is required.
+       //enable it if this module isn't required
+       downPB->setEnabled(
+                       find(reqs.begin(), reqs.end(), curModName) == reqs.end());
+}
+
+void ModuleSelMan::updateUpPB() 
+{
+       int const srows = selectedModel->rowCount();
+       if (srows == 0) {
+               upPB->setEnabled(false);
+               return;
+       }
+       QModelIndexList const selSels = 
+                       selectedLV->selectionModel()->selectedIndexes();
+       //disable if empty or first item is selected
+       if (selSels.empty() || selSels.first().row() == 0) {
+               upPB->setEnabled(false);
+               return;
+       }
+
+       //determine whether immediately preceding element is required by this one
+       QModelIndex const & curIdx = selectedLV->selectionModel()->currentIndex();
+       int curRow = curIdx.row();
+       if (curRow <= -1 || curRow > srows - 1) { //sanity check
+               downPB->setEnabled(false);
+               return;
+       }
+       string const curModName = getSelectedModel()->getIDString(curRow);
+       vector<string> reqs = getRequiredList(curModName);
+       
+       //if this one doesn't require anything....
+       if (reqs.empty()) {
+               upPB->setEnabled(true);
+               return;
+       }
+
+       string preModName = getSelectedModel()->getIDString(curRow - 1);
+
+       //NOTE This is less flexible than it might be. You could check whether, even 
+       //if this one is required, there is also an earlier one that is required.
+       //enable it if the preceding module isn't required
+       upPB->setEnabled(find(reqs.begin(), reqs.end(), preModName) == reqs.end());
+}
+
+void ModuleSelMan::updateDelPB() 
+{
+       int const srows = selectedModel->rowCount();
+       if (srows == 0) {
+               deletePB->setEnabled(false);
+               return;
+       }
+       QModelIndexList const selSels = 
+                       selectedLV->selectionModel()->selectedIndexes();
+       if (selSels.empty() || selSels.first().row() < 0) {
+               deletePB->setEnabled(false);
+               return;
+       }
+       
+       //determine whether some LATER module requires this one
+       //NOTE Things are arranged so that this is the only way there
+       //can be a problem. At least, we hope so.
+       QModelIndex const & curIdx = 
+               selectedLV->selectionModel()->currentIndex();
+       int const curRow = curIdx.row();
+       if (curRow < 0 || curRow >= srows) { //this shouldn't happen
+               deletePB->setEnabled(false);
+               return;
+       }
+               
+       QString const curModName = curIdx.data().toString();
+       
+       //We're looking here for a reason NOT to enable the button. If we
+       //find one, we disable it and return. If we don't, we'll end up at
+       //the end of the function, and then we enable it.
+       for (int i = curRow + 1; i < srows; ++i) {
+               string const thisMod = getSelectedModel()->getIDString(i);
+               vector<string> reqs = getRequiredList(thisMod);
+               //does this one require us?
+               if (find(reqs.begin(), reqs.end(), fromqstr(curModName)) == reqs.end())
+                       //no...
+                       continue;
+
+               //OK, so this module requires us
+               //is there an EARLIER module that also satisfies the require?
+               //NOTE We demand that it be earlier to keep the list of modules
+               //consistent with the rule that a module must be proceeded by a
+               //required module. There would be more flexible ways to proceed,
+               //but that would be a lot more complicated, and the logic here is
+               //already complicated. (That's why I've left the debugging code.)
+               //lyxerr << "Testing " << thisMod << std::endl;
+               bool foundOne = false;
+               for (int j = 0; j < curRow; ++j) {
+                       string const mod = getSelectedModel()->getIDString(j);
+                       //lyxerr << "In loop: Testing " << mod << std::endl;
+                       //do we satisfy the require? 
+                       if (find(reqs.begin(), reqs.end(), mod) != reqs.end()) {
+                               //lyxerr << mod << " does the trick." << std::endl;
+                               foundOne = true;
+                               break;
+                       }
+               }
+               //did we find a module to satisfy the require?
+               if (!foundOne) {
+                       //lyxerr << "No matching module found." << std::endl;
+                       deletePB->setEnabled(false);
+                       return;
+               }
+       }
+       //lyxerr << "All's well that ends well." << std::endl;  
+       deletePB->setEnabled(true);
+}
+
+
 /////////////////////////////////////////////////////////////////////
 //
 // PreambleModule
@@ -566,7 +849,7 @@ GuiDocument::GuiDocument(GuiView & lv)
                this, SLOT(classChanged()));
        
        selectionManager = 
-               new GuiSelectionManager(latexModule->availableLV, latexModule->selectedLV, 
+               new ModuleSelMan(latexModule->availableLV, latexModule->selectedLV, 
                        latexModule->addPB, latexModule->deletePB, 
                        latexModule->upPB, latexModule->downPB, 
                        availableModel(), selectedModel());
@@ -914,55 +1197,108 @@ void GuiDocument::classChanged()
 {
        textclass_type const tc = latexModule->classCO->currentIndex();
        bp_.setBaseClass(tc);
-       if (lyxrc.auto_reset_options)
+       if (lyxrc.auto_reset_options) {
                bp_.useClassDefaults();
-       updateContents();
+               updateContents();
+       }
+}
+
+
+namespace {
+       //This is an insanely complicated attempt to make this sort of thing
+       //work with RTL languages.
+       docstring formatStrVec(vector<string> const & v, docstring const & s) 
+       {
+               //this mess formats the list as "v[0], v[1], ..., [s] v[n]"
+               int const vSize = v.size();
+               if (v.size() == 0)
+                       return docstring();
+               else if (v.size() == 1) 
+                       return from_ascii(v[0]);
+               else if (v.size() == 2) {
+                       docstring retval = _("%1$s and %2$s");
+                       retval = subst(retval, _("and"), s);
+                       return bformat(retval, from_ascii(v[0]), from_ascii(v[1]));
+               }
+               //The idea here is to format all but the last two items...
+               docstring t2 = _("%1$s, %2$s");
+               docstring retval = from_ascii(v[0]);
+               for (int i = 1; i < vSize - 2; ++i)
+                       retval = bformat(t2, retval, from_ascii(v[i])); 
+               //...and then to  plug them, and the last two, into this schema
+               docstring t = _("%1$s, %2$s, and %3$s");
+               t = subst(t, _("and"), s);
+               return bformat(t, retval, from_ascii(v[vSize - 2]), from_ascii(v[vSize - 1]));
+       }
+       
+       vector<string> idsToNames(vector<string> const & idList)
+       {
+               vector<string> retval;
+               vector<string>::const_iterator it  = idList.begin();
+               vector<string>::const_iterator end = idList.end();
+               for (; it != end; ++it) {
+                       LyXModule const * const mod = moduleList[*it];
+                       if (!mod)
+                               retval.push_back(*it + " (Unavailable)");
+                       else
+                               retval.push_back(mod->getName());
+               }
+               return retval;
+       }
 }
 
 
 void GuiDocument::updateModuleInfo()
 {
        selectionManager->update();
+       
        //Module description
-       QListView const * const lv = selectionManager->selectedFocused() ?
-                                    latexModule->selectedLV :
-                       latexModule->availableLV;
-       if (lv->selectionModel()->selectedIndexes().isEmpty())
+       bool const focusOnSelected = selectionManager->selectedFocused();
+       QListView const * const lv = 
+                       focusOnSelected ? latexModule->selectedLV : latexModule->availableLV;
+       if (lv->selectionModel()->selectedIndexes().isEmpty()) {
                latexModule->infoML->document()->clear();
-       else {
-               QModelIndex const idx = lv->selectionModel()->currentIndex();
-               string const modName = fromqstr(idx.data().toString());
-               string desc = getModuleDescription(modName);
-               vector<string> pkgList = getPackageList(modName);
-               string pkgdesc;
-               //this mess formats the package list as "pkg1, pkg2, and pkg3"
-               int const pkgListSize = pkgList.size();
-               for (int i = 0; i < pkgListSize; ++i) {
-                       if (i == 1) {
-                               if (i == pkgListSize - 1) //last element
-                                       pkgdesc += " and ";
-                               else
-                                       pkgdesc += ", ";
-                       } else if (i > 1) {
-                               if (i == pkgListSize - 1) //last element
-                                       pkgdesc += ", and ";
-                               else
-                                       pkgdesc += ", ";
-                       }
-                       pkgdesc += pkgList[i];
-               }
-               if (!pkgdesc.empty()) {
-                       if (!desc.empty())
-                               desc += " ";
-                       desc += ("Requires " + pkgdesc + ".");
-               }
-               if (!isModuleAvailable(modName)) {
-                       if (!desc.empty())
-                               desc += "\n";
-                       desc += "WARNING: Some packages are unavailable!";
-               }
-               latexModule->infoML->document()->setPlainText(toqstr(desc));
+               return;
+       }
+       QModelIndex const & idx = lv->selectionModel()->currentIndex();
+       GuiIdListModel const & idModel = 
+                       focusOnSelected  ? selected_model_ : available_model_;
+       string const modName = idModel.getIDString(idx.row());
+       docstring desc = getModuleDescription(modName);
+
+       vector<string> pkgList = getPackageList(modName);
+       docstring pkgdesc = formatStrVec(pkgList, _("and"));
+       if (!pkgdesc.empty()) {
+               if (!desc.empty())
+                       desc += "\n";
+               desc += bformat(_("Package(s) required: %1$s."), pkgdesc);
+       }
+
+       pkgList = getRequiredList(modName);
+       if (!pkgList.empty()) {
+               vector<string> const reqDescs = idsToNames(pkgList);
+               pkgdesc = formatStrVec(reqDescs, _("or"));
+               if (!desc.empty())
+                       desc += "\n";
+               desc += bformat(_("Module required: %1$s."), pkgdesc);
        }
+
+       pkgList = getExcludedList(modName);
+       if (!pkgList.empty()) {
+               vector<string> const reqDescs = idsToNames(pkgList);
+               pkgdesc = formatStrVec(reqDescs, _( "and"));
+               if (!desc.empty())
+                       desc += "\n";
+               desc += bformat(_("Modules excluded: %1$s."), pkgdesc);
+       }
+
+       if (!isModuleAvailable(modName)) {
+               if (!desc.empty())
+                       desc += "\n";
+               desc += _("WARNING: Some packages are unavailable!");
+       }
+
+       latexModule->infoML->document()->setPlainText(toqstr(desc));
 }
 
 
@@ -970,10 +1306,10 @@ void GuiDocument::updateEmbeddedFileList()
 {
        embeddedFilesModule->filesLW->clear();
        // add current embedded files
-       EmbeddedFiles & files = buffer().embeddedFiles();
+       EmbeddedFileList & files = buffer().embeddedFiles();
        files.update(buffer());
-       EmbeddedFiles::iterator fit = files.begin();
-       EmbeddedFiles::iterator fit_end = files.end();
+       EmbeddedFileList::iterator fit = files.begin();
+       EmbeddedFileList::iterator fit_end = files.end();
        for (; fit != fit_end; ++fit) {
                QString label = toqstr(fit->relFilename(buffer().filePath()));
                if (fit->refCount() > 1)
@@ -1102,9 +1438,10 @@ void GuiDocument::apply(BufferParams & params)
 
        // Modules
        params.clearLayoutModules();
-       QStringList const selMods = selectedModel()->stringList();
-       for (int i = 0; i != selMods.size(); ++i)
-               params.addLayoutModule(lyx::fromqstr(selMods[i]));
+       int const srows = selected_model_.rowCount();
+       vector<string> selModList;
+       for (int i = 0; i < srows; ++i)
+               params.addLayoutModule(selected_model_.getIDString(i));
 
        if (mathsModule->amsautoCB->isChecked()) {
                params.use_amsmath = BufferParams::package_auto;
@@ -1616,23 +1953,40 @@ void GuiDocument::saveDocDefault()
 }
 
 
-void GuiDocument::updateContents()
+void GuiDocument::updateAvailableModules() 
+{
+       available_model_.clear();
+       vector<modInfoStruct> const modInfoList = getModuleInfo();
+       int const mSize = modInfoList.size();
+       for (int i = 0; i < mSize; ++i) {
+               modInfoStruct const & modInfo = modInfoList[i];
+               available_model_.insertRow(i, modInfo.name, modInfo.id);
+       }
+}
+
+
+void GuiDocument::updateSelectedModules() 
 {
-       //update list of available modules
-       QStringList strlist;
-       vector<string> const modNames = getModuleNames();
-       vector<string>::const_iterator it = modNames.begin();
-       for (; it != modNames.end(); ++it)
-               strlist.push_back(toqstr(*it));
-       available_model_.setStringList(strlist);
        //and selected ones, too
-       QStringList strlist2;
-       vector<string> const & selMods = getSelectedModules();
-       it = selMods.begin();
-       for (; it != selMods.end(); ++it)
-               strlist2.push_back(toqstr(*it));
-       selected_model_.setStringList(strlist2);
+       selected_model_.clear();
+       vector<modInfoStruct> const selModList = getSelectedModules();
+       int const sSize = selModList.size();
+       for (int i = 0; i < sSize; ++i) {
+               modInfoStruct const & modInfo = selModList[i];
+               selected_model_.insertRow(i, modInfo.name, modInfo.id);
+       }
+}
+
 
+void GuiDocument::updateContents()
+{
+       updateAvailableModules();
+       updateSelectedModules();
+       
+       //FIXME It'd be nice to make sure here that the selected
+       //modules are consistent: That required modules are actually
+       //selected, and that we don't have conflicts. If so, we could
+       //at least pop up a warning.
        updateParams(bp_);
 }
 
@@ -1663,7 +2017,7 @@ char const * GuiDocument::fontfamilies_gui[5] = {
 bool GuiDocument::initialiseParams(string const &)
 {
        bp_ = buffer().params();
-       loadModuleNames();
+       loadModuleInfo();
        return true;
 }
 
@@ -1680,42 +2034,29 @@ BufferId GuiDocument::id() const
 }
 
 
-vector<string> GuiDocument::getModuleNames()
+vector<GuiDocument::modInfoStruct> const & GuiDocument::getModuleInfo()
 {
        return moduleNames_;
 }
 
 
-vector<string> const & GuiDocument::getSelectedModules()
-{
-       return params().getModules();
-}
-
-
-string GuiDocument::getModuleDescription(string const & modName) const
-{
-       LyXModule const * const mod = moduleList[modName];
-       if (!mod)
-               return string("Module not found!");
-       return mod->description;
-}
-
-
-vector<string> GuiDocument::getPackageList(string const & modName) const
-{
-       LyXModule const * const mod = moduleList[modName];
-       if (!mod)
-               return vector<string>(); //empty such thing
-       return mod->packageList;
-}
-
-
-bool GuiDocument::isModuleAvailable(string const & modName) const
-{
-       LyXModule * mod = moduleList[modName];
-       if (!mod)
-               return false;
-       return mod->isAvailable();
+vector<GuiDocument::modInfoStruct> const GuiDocument::getSelectedModules()
+{
+       vector<string> const & mods = params().getModules();
+       vector<string>::const_iterator it =  mods.begin();
+       vector<string>::const_iterator end = mods.end();
+       vector<modInfoStruct> mInfo;
+       for (; it != end; ++it) {
+               modInfoStruct m;
+               m.id = *it;
+               LyXModule * mod = moduleList[*it];
+               if (mod)
+                       m.name = mod->getName();
+               else 
+                       m.name = *it + " (Not Found)";
+               mInfo.push_back(m);
+       }
+       return mInfo;
 }
 
 
@@ -1835,14 +2176,17 @@ bool GuiDocument::providesScale(string const & font) const
 }
 
 
-void GuiDocument::loadModuleNames ()
+void GuiDocument::loadModuleInfo()
 {
        moduleNames_.clear();
-       LyXModuleList::const_iterator it = moduleList.begin();
-       for (; it != moduleList.end(); ++it)
-               moduleNames_.push_back(it->name);
-       if (!moduleNames_.empty())
-               sort(moduleNames_.begin(), moduleNames_.end());
+       LyXModuleList::const_iterator it  = moduleList.begin();
+       LyXModuleList::const_iterator end = moduleList.end();
+       for (; it != end; ++it) {
+               modInfoStruct m;
+               m.id = it->getID();
+               m.name = it->getName();
+               moduleNames_.push_back(m);
+       }
 }