]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetIndex.cpp
Remove all BufferParam arguments in InsetXXX methods (since insets know about their...
[lyx.git] / src / insets / InsetIndex.cpp
index 998089be3a3876d08c6dc4889d2b2e856b4d3da4..e64685335b7af1bab160fd15216e641cc0da0f78 100644 (file)
@@ -4,6 +4,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Lars Gullik Bjønnes
+ * \author Jürgen Spitzmüller
  *
  * Full author contact details are available in file CREDITS.
  */
 #include "InsetIndex.h"
 
 #include "Buffer.h"
+#include "BufferParams.h"
+#include "BufferView.h"
+#include "ColorSet.h"
 #include "DispatchResult.h"
 #include "Encoding.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
+#include "IndicesList.h"
 #include "LaTeXFeatures.h"
+#include "Lexer.h"
 #include "MetricsInfo.h"
 #include "sgml.h"
 #include "TocBackend.h"
@@ -42,16 +48,23 @@ namespace lyx {
 ///////////////////////////////////////////////////////////////////////
 
 
-InsetIndex::InsetIndex(Buffer const & buf)
-       : InsetCollapsable(buf)
+InsetIndex::InsetIndex(Buffer const & buf, InsetIndexParams const & params)
+       : InsetCollapsable(buf), params_(params)
 {}
 
 
 int InsetIndex::latex(odocstream & os,
                      OutputParams const & runparams) const
 {
-       os << "\\index";
-       os << '{';
+       if (buffer().masterBuffer()->params().use_indices && !params_.index.empty()
+           && params_.index != "idx") {
+               os << "\\sindex[";
+               os << params_.index;
+               os << "]{";
+       } else {
+               os << "\\index";
+               os << '{';
+       }
        int i = 0;
 
        // get contents of InsetText as LaTeX and plaintext
@@ -158,13 +171,163 @@ int InsetIndex::docbook(odocstream & os, OutputParams const & runparams) const
 }
 
 
+docstring InsetIndex::xhtml(odocstream &, OutputParams const &) const
+{
+       return docstring();
+}
+
+
+bool InsetIndex::showInsetDialog(BufferView * bv) const
+{
+       bv->showDialog("index", params2string(params_),
+                       const_cast<InsetIndex *>(this));
+       return true;
+}
+
+
+void InsetIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
+{
+       switch (cmd.action) {
+
+       case LFUN_INSET_MODIFY: {
+               if (cmd.getArg(0) == "changetype") {
+                       params_.index = from_utf8(cmd.getArg(1));
+                       setLayout();
+                       break;
+               }
+               InsetIndexParams params;
+               InsetIndex::string2params(to_utf8(cmd.argument()), params);
+               params_.index = params.index;
+               setLayout();
+               break;
+       }
+
+       case LFUN_INSET_DIALOG_UPDATE:
+               cur.bv().updateDialog("index", params2string(params_));
+               break;
+
+       default:
+               InsetCollapsable::doDispatch(cur, cmd);
+               break;
+       }
+}
+
+
+bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
+               FuncStatus & flag) const
+{
+       switch (cmd.action) {
+
+       case LFUN_INSET_MODIFY:
+               if (cmd.getArg(0) == "changetype") {
+                       docstring const newtype = from_utf8(cmd.getArg(1));
+                       Buffer const & realbuffer = *buffer().masterBuffer();
+                       IndicesList const & indiceslist = realbuffer.params().indiceslist();
+                       Index const * index = indiceslist.findShortcut(newtype);
+                       flag.setEnabled(index != 0);
+                       flag.setOnOff(
+                               from_utf8(cmd.getArg(1)) == params_.index);
+                       return true;
+               }
+               flag.setEnabled(true);
+               return true;
+
+       case LFUN_INSET_DIALOG_UPDATE: {
+               Buffer const & realbuffer = *buffer().masterBuffer();
+               flag.setEnabled(realbuffer.params().use_indices);
+               return true;
+       }
+
+       default:
+               return InsetCollapsable::getStatus(cur, cmd, flag);
+       }
+}
+
+
+docstring const InsetIndex::buttonLabel(BufferView const & bv) const
+{
+       docstring s = _("Idx");
+       if (decoration() == InsetLayout::CLASSIC)
+               return isOpen(bv) ? s : getNewLabel(s);
+       else
+               return getNewLabel(s);
+}
+
+
+ColorCode InsetIndex::labelColor() const
+{
+       if (params_.index.empty() || params_.index == from_ascii("idx"))
+               return InsetCollapsable::labelColor();
+       // FIXME UNICODE
+       ColorCode c = lcolor.getFromLyXName(to_utf8(params_.index));
+       if (c == Color_none)
+               c = InsetCollapsable::labelColor();
+       return c;
+}
+
+
+docstring InsetIndex::toolTip(BufferView const &, int, int) const
+{
+       docstring tip = _("Index Entry");
+       if (buffer().params().use_indices && !params_.index.empty()) {
+               Buffer const & realbuffer = *buffer().masterBuffer();
+               IndicesList const & indiceslist = realbuffer.params().indiceslist();
+               tip += " (";
+               Index const * index = indiceslist.findShortcut(params_.index);
+               if (!index)
+                       tip += _("unknown type!");
+               else
+                       tip += index->index();
+               tip += ")";
+       }
+       tip += ": ";
+       OutputParams rp(&buffer().params().encoding());
+       odocstringstream ods;
+       InsetText::plaintext(ods, rp);
+       tip += ods.str();
+       return wrapParas(tip);
+}
+
+
 void InsetIndex::write(ostream & os) const
 {
-       os << to_utf8(name()) << "\n";
+       os << to_utf8(name());
+       params_.write(os);
        InsetCollapsable::write(os);
 }
 
 
+void InsetIndex::read(Lexer & lex)
+{
+       params_.read(lex);
+       InsetCollapsable::read(lex);
+}
+
+
+string InsetIndex::params2string(InsetIndexParams const & params)
+{
+       ostringstream data;
+       data << "index";
+       params.write(data);
+       return data.str();
+}
+
+
+void InsetIndex::string2params(string const & in, InsetIndexParams & params)
+{
+       params = InsetIndexParams();
+       if (in.empty())
+               return;
+
+       istringstream data(in);
+       Lexer lex;
+       lex.setStream(data);
+       lex.setContext("InsetIndex::string2params");
+       lex >> "index";
+       params.read(lex);
+}
+
+
 void InsetIndex::addToToc(DocIterator const & cpit)
 {
        DocIterator pit = cpit;
@@ -176,6 +339,56 @@ void InsetIndex::addToToc(DocIterator const & cpit)
 }
 
 
+void InsetIndex::validate(LaTeXFeatures & features) const
+{
+       if (buffer().masterBuffer()->params().use_indices
+           && !params_.index.empty()
+           && params_.index != "idx")
+               features.require("splitidx");
+}
+
+
+docstring InsetIndex::contextMenu(BufferView const &, int, int) const
+{
+       return from_ascii("context-index");
+}
+
+
+bool InsetIndex::hasSettings() const
+{
+       return buffer().masterBuffer()->params().use_indices;
+}
+
+
+
+
+/////////////////////////////////////////////////////////////////////
+//
+// InsetIndexParams
+//
+///////////////////////////////////////////////////////////////////////
+
+
+void InsetIndexParams::write(ostream & os) const
+{
+       os << ' ';
+       if (!index.empty())
+               os << to_utf8(index);
+       else
+               os << "idx";
+       os << '\n';
+}
+
+
+void InsetIndexParams::read(Lexer & lex)
+{
+       if (lex.eatLine())
+               index = lex.getDocString();
+       else
+               index = from_ascii("idx");
+}
+
+
 /////////////////////////////////////////////////////////////////////
 //
 // InsetPrintIndex
@@ -183,34 +396,172 @@ void InsetIndex::addToToc(DocIterator const & cpit)
 ///////////////////////////////////////////////////////////////////////
 
 InsetPrintIndex::InsetPrintIndex(InsetCommandParams const & p)
-       : InsetCommand(p, string())
+       : InsetCommand(p, "index_print")
 {}
 
 
 ParamInfo const & InsetPrintIndex::findInfo(string const & /* cmdName */)
 {
        static ParamInfo param_info_;
-       if (param_info_.empty())
+       if (param_info_.empty()) {
+               param_info_.add("type", ParamInfo::LATEX_OPTIONAL);
                param_info_.add("name", ParamInfo::LATEX_REQUIRED);
+       }
        return param_info_;
 }
 
 
 docstring InsetPrintIndex::screenLabel() const
 {
-       return _("Index");
+       bool const printall = suffixIs(getCmdName(), '*');
+       bool const multind = buffer().masterBuffer()->params().use_indices;
+       if ((!multind
+            && getParam("type") == from_ascii("idx"))
+           || (getParam("type").empty() && !printall))
+               return _("Index");
+       Buffer const & realbuffer = *buffer().masterBuffer();
+       IndicesList const & indiceslist = realbuffer.params().indiceslist();
+       Index const * index = indiceslist.findShortcut(getParam("type"));
+       if (!index && !printall)
+               return _("Unknown index type!");
+       docstring res = printall ? _("All indices") : index->index();
+       if (!multind)
+               res += " (" + _("non-active") + ")";
+       else if (contains(getCmdName(), "printsubindex"))
+               res += " (" + _("subindex") + ")";
+       return res;
+}
+
+
+bool InsetPrintIndex::isCompatibleCommand(string const & s)
+{
+       return s == "printindex" || s == "printsubindex"
+               || s == "printindex*" || s == "printsubindex*";
+}
+
+
+void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
+{
+       switch (cmd.action) {
+
+       case LFUN_INSET_MODIFY: {
+               if (cmd.argument() == from_ascii("toggle-subindex")) {
+                       string cmd = getCmdName();
+                       if (contains(cmd, "printindex"))
+                               cmd = subst(cmd, "printindex", "printsubindex");
+                       else
+                               cmd = subst(cmd, "printsubindex", "printindex");
+                       setCmdName(cmd);
+                       break;
+               } else if (cmd.argument() == from_ascii("check-printindex*")) {
+                       string cmd = getCmdName();
+                       if (suffixIs(cmd, '*'))
+                               break;
+                       cmd += '*';
+                       setParam("type", docstring());
+                       setCmdName(cmd);
+                       break;
+               }
+               InsetCommandParams p(INDEX_PRINT_CODE);
+               // FIXME UNICODE
+               InsetCommand::string2params("index_print",
+                       to_utf8(cmd.argument()), p);
+               if (p.getCmdName().empty()) {
+                       cur.noUpdate();
+                       break;
+               }
+               setParams(p);
+               break;
+       }
+
+       default:
+               InsetCommand::doDispatch(cur, cmd);
+               break;
+       }
+}
+
+
+bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
+       FuncStatus & status) const
+{
+       switch (cmd.action) {
+
+       case LFUN_INSET_MODIFY: {
+               if (cmd.argument() == from_ascii("toggle-subindex")) {
+                       status.setEnabled(buffer().masterBuffer()->params().use_indices);
+                       status.setOnOff(contains(getCmdName(), "printsubindex"));
+                       return true;
+               } else if (cmd.argument() == from_ascii("check-printindex*")) {
+                       status.setEnabled(buffer().masterBuffer()->params().use_indices);
+                       status.setOnOff(suffixIs(getCmdName(), '*'));
+                       return true;
+               } if (cmd.getArg(0) == "index_print"
+                   && cmd.getArg(1) == "CommandInset") {
+                       InsetCommandParams p(INDEX_PRINT_CODE);
+                       InsetCommand::string2params("index_print",
+                               to_utf8(cmd.argument()), p);
+                       if (suffixIs(p.getCmdName(), '*')) {
+                               status.setEnabled(true);
+                               status.setOnOff(false);
+                               return true;
+                       }
+                       Buffer const & realbuffer = *buffer().masterBuffer();
+                       IndicesList const & indiceslist =
+                               realbuffer.params().indiceslist();
+                       Index const * index = indiceslist.findShortcut(p["type"]);
+                       status.setEnabled(index != 0);
+                       status.setOnOff(p["type"] == getParam("type"));
+                       return true;
+               } else
+                       return InsetCommand::getStatus(cur, cmd, status);
+       }
+       
+       case LFUN_INSET_DIALOG_UPDATE: {
+               status.setEnabled(buffer().masterBuffer()->params().use_indices);
+               return true;
+       }
+
+       default:
+               return InsetCommand::getStatus(cur, cmd, status);
+       }
+}
+
+
+int InsetPrintIndex::latex(odocstream & os, OutputParams const &) const
+{
+       if (!buffer().masterBuffer()->params().use_indices) {
+               if (getParam("type") == from_ascii("idx"))
+                       os << "\\printindex{}";
+               return 0;
+       }
+       os << getCommand();
+       return 0;
 }
 
 
 void InsetPrintIndex::validate(LaTeXFeatures & features) const
 {
        features.require("makeidx");
+       if (buffer().masterBuffer()->params().use_indices)
+               features.require("splitidx");
 }
 
 
-InsetCode InsetPrintIndex::lyxCode() const
+docstring InsetPrintIndex::contextMenu(BufferView const &, int, int) const
+{
+       return buffer().masterBuffer()->params().use_indices ?
+               from_ascii("context-indexprint") : docstring();
+}
+
+
+bool InsetPrintIndex::hasSettings() const
+{
+       return buffer().masterBuffer()->params().use_indices;
+}
+
+docstring InsetPrintIndex::xhtml(odocstream &, OutputParams const &) const
 {
-       return INDEX_PRINT_CODE;
+       return docstring();
 }
 
 } // namespace lyx