]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetNomencl.cpp
Fix trailing whitespace in cpp files.
[lyx.git] / src / insets / InsetNomencl.cpp
index 19ff3a23a1b95ef844b2a55e5c9a5cfaef637d56..74d1387599290e43762a6ce4726a41ec5bf8d368 100644 (file)
 #include "InsetNote.h"
 
 #include "Buffer.h"
+#include "Cursor.h"
 #include "DispatchResult.h"
 #include "Font.h"
+#include "Encoding.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
 #include "InsetIterator.h"
 #include "InsetList.h"
+#include "Language.h"
 #include "LaTeXFeatures.h"
 #include "Length.h"
 #include "LyX.h"
-#include "MetricsInfo.h"
+#include "OutputParams.h"
+#include "output_xhtml.h"
 #include "sgml.h"
+#include "texstream.h"
+#include "TocBackend.h"
 
 #include "frontends/FontMetrics.h"
 
+#include "support/debug.h"
 #include "support/docstream.h"
 #include "support/gettext.h"
 #include "support/lstrings.h"
@@ -46,8 +53,8 @@ namespace lyx {
 //
 /////////////////////////////////////////////////////////////////////
 
-InsetNomencl::InsetNomencl(InsetCommandParams const & p)
-       : InsetCommand(p, "nomenclature"),
+InsetNomencl::InsetNomencl(Buffer * buf, InsetCommandParams const & p)
+       : InsetCommand(buf, p),
          nomenclature_entry_id(sgml::uniqueID(from_ascii("nomen")))
 {}
 
@@ -57,8 +64,11 @@ ParamInfo const & InsetNomencl::findInfo(string const & /* cmdName */)
        static ParamInfo param_info_;
        if (param_info_.empty()) {
                param_info_.add("prefix", ParamInfo::LATEX_OPTIONAL);
-               param_info_.add("symbol", ParamInfo::LATEX_REQUIRED);
-               param_info_.add("description", ParamInfo::LATEX_REQUIRED);
+               param_info_.add("symbol", ParamInfo::LATEX_REQUIRED,
+                               ParamInfo::HANDLING_LATEXIFY);
+               param_info_.add("description", ParamInfo::LATEX_REQUIRED,
+                               ParamInfo::HANDLING_LATEXIFY);
+               param_info_.add("literal", ParamInfo::LYX_INTERNAL);
        }
        return param_info_;
 }
@@ -67,12 +77,8 @@ ParamInfo const & InsetNomencl::findInfo(string const & /* cmdName */)
 docstring InsetNomencl::screenLabel() const
 {
        size_t const maxLabelChars = 25;
-
        docstring label = _("Nom: ") + getParam("symbol");
-       if (label.size() > maxLabelChars) {
-               label.erase(maxLabelChars - 3);
-               label += "...";
-       }
+       support::truncateWithEllipsis(label, maxLabelChars);
        return label;
 }
 
@@ -88,6 +94,14 @@ docstring InsetNomencl::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/)
 }
 
 
+int InsetNomencl::plaintext(odocstringstream & os,
+        OutputParams const &, size_t) const
+{
+       docstring s = "[" + getParam("symbol") + ": " + getParam("description") + "]";
+       os << s;
+       return s.size();
+}
+
 
 int InsetNomencl::docbook(odocstream & os, OutputParams const &) const
 {
@@ -98,6 +112,12 @@ int InsetNomencl::docbook(odocstream & os, OutputParams const &) const
 }
 
 
+docstring InsetNomencl::xhtml(XHTMLStream &, OutputParams const &) const
+{
+       return docstring();
+}
+
+
 int InsetNomencl::docbookGlossary(odocstream & os) const
 {
        os << "<glossentry id=\"" << nomenclature_entry_id << "\">\n"
@@ -115,6 +135,17 @@ int InsetNomencl::docbookGlossary(odocstream & os) const
 void InsetNomencl::validate(LaTeXFeatures & features) const
 {
        features.require("nomencl");
+       InsetCommand::validate(features);
+}
+
+
+void InsetNomencl::addToToc(DocIterator const & cpit, bool output_active,
+                                                       UpdateType, TocBackend & backend) const
+{
+       docstring const str = getParam("symbol");
+       TocBuilder & b = backend.builder("nomencl");
+       b.pushItem(cpit, str, output_active);
+       b.pop();
 }
 
 
@@ -124,14 +155,14 @@ void InsetNomencl::validate(LaTeXFeatures & features) const
 //
 /////////////////////////////////////////////////////////////////////
 
-InsetPrintNomencl::InsetPrintNomencl(InsetCommandParams const & p)
-       : InsetCommand(p, "nomencl_print")
+InsetPrintNomencl::InsetPrintNomencl(Buffer * buf, InsetCommandParams const & p)
+       : InsetCommand(buf, p)
 {}
 
 
 ParamInfo const & InsetPrintNomencl::findInfo(string const & /* cmdName */)
 {
-       // The symbol width is set via nomencl's \nomlabelwidth in 
+       // The symbol width is set via nomencl's \nomlabelwidth in
        // InsetPrintNomencl::latex and not as optional parameter of
        // \printnomenclature
        static ParamInfo param_info_;
@@ -152,19 +183,110 @@ docstring InsetPrintNomencl::screenLabel() const
 }
 
 
+struct NomenclEntry {
+       NomenclEntry() : par(0) {}
+       NomenclEntry(docstring s, docstring d, Paragraph const * p)
+         : symbol(s), desc(d), par(p)
+       {}
+
+       docstring symbol;
+       docstring desc;
+       Paragraph const * par;
+};
+
+
+typedef map<docstring, NomenclEntry > EntryMap;
+
+
+docstring InsetPrintNomencl::xhtml(XHTMLStream &, OutputParams const & op) const
+{
+       shared_ptr<Toc const> toc = buffer().tocBackend().toc("nomencl");
+
+       EntryMap entries;
+       Toc::const_iterator it = toc->begin();
+       Toc::const_iterator const en = toc->end();
+       for (; it != en; ++it) {
+               DocIterator dit = it->dit();
+               Paragraph const & par = dit.innerParagraph();
+               Inset const * inset = par.getInset(dit.top().pos());
+               if (!inset)
+                       return docstring();
+               InsetCommand const * ic = inset->asInsetCommand();
+               if (!ic)
+                       return docstring();
+
+               // FIXME We need a link to the paragraph here, so we
+               // need some kind of struct.
+               docstring const symbol = ic->getParam("symbol");
+               docstring const desc = ic->getParam("description");
+               docstring const prefix = ic->getParam("prefix");
+               docstring const sortas = prefix.empty() ? symbol : prefix;
+
+               entries[sortas] = NomenclEntry(symbol, desc, &par);
+       }
+
+       if (entries.empty())
+               return docstring();
+
+       // we'll use our own stream, because we are going to defer everything.
+       // that's how we deal with the fact that we're probably inside a standard
+       // paragraph, and we don't want to be.
+       odocstringstream ods;
+       XHTMLStream xs(ods);
+
+       InsetLayout const & il = getLayout();
+       string const & tag = il.htmltag();
+       docstring toclabel = translateIfPossible(from_ascii("Nomenclature"),
+               op.local_font->language()->lang());
+
+       xs << html::StartTag("div", "class='nomencl'")
+          << html::StartTag(tag, "class='nomencl'")
+                << toclabel
+                << html::EndTag(tag)
+          << html::CR()
+          << html::StartTag("dl")
+          << html::CR();
+
+       EntryMap::const_iterator eit = entries.begin();
+       EntryMap::const_iterator const een = entries.end();
+       for (; eit != een; ++eit) {
+               NomenclEntry const & ne = eit->second;
+               string const parid = ne.par->magicLabel();
+               xs << html::StartTag("dt")
+                  << html::StartTag("a", "href='#" + parid + "' class='nomencl'")
+                  << ne.symbol
+                  << html::EndTag("a")
+                  << html::EndTag("dt")
+                  << html::CR()
+                  << html::StartTag("dd")
+                  << ne.desc
+                  << html::EndTag("dd")
+                  << html::CR();
+       }
+
+       xs << html::EndTag("dl")
+          << html::CR()
+          << html::EndTag("div")
+          << html::CR();
+
+       return ods.str();
+}
+
+
 void InsetPrintNomencl::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       switch (cmd.action) {
+       switch (cmd.action()) {
 
        case LFUN_INSET_MODIFY: {
                InsetCommandParams p(NOMENCL_PRINT_CODE);
                // FIXME UNICODE
-               InsetCommand::string2params("nomencl_print",
-                       to_utf8(cmd.argument()), p);
+               InsetCommand::string2params(to_utf8(cmd.argument()), p);
                if (p.getCmdName().empty()) {
-                       cur.noUpdate();
+                       cur.noScreenUpdate();
                        break;
                }
+
+               cur.recordUndo();
                setParams(p);
                break;
        }
@@ -179,7 +301,7 @@ void InsetPrintNomencl::doDispatch(Cursor & cur, FuncRequest & cmd)
 bool InsetPrintNomencl::getStatus(Cursor & cur, FuncRequest const & cmd,
        FuncStatus & status) const
 {
-       switch (cmd.action) {
+       switch (cmd.action()) {
 
        case LFUN_INSET_DIALOG_UPDATE:
        case LFUN_INSET_MODIFY:
@@ -192,7 +314,8 @@ bool InsetPrintNomencl::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-
+// FIXME This should be changed to use the TOC. Perhaps
+// that could be done when XHTML output is added.
 int InsetPrintNomencl::docbook(odocstream & os, OutputParams const &) const
 {
        os << "<glossary>\n";
@@ -218,7 +341,7 @@ int InsetPrintNomencl::docbook(odocstream & os, OutputParams const &) const
 
 
 namespace {
-docstring nomenclWidest(Buffer const & buffer)
+docstring nomenclWidest(Buffer const & buffer, OutputParams const & runparams)
 {
        // nomenclWidest() determines and returns the widest used
        // nomenclature symbol in the document
@@ -253,23 +376,32 @@ docstring nomenclWidest(Buffer const & buffer)
                }
        }
        // return the widest (or an empty) string
-       return symb;
-}
+       if (symb.empty())
+               return symb;
+
+       // we have to encode the string properly
+       pair<docstring, docstring> latex_symb =
+               runparams.encoding->latexString(symb, runparams.dryrun);
+       if (!latex_symb.second.empty())
+               LYXERR0("Omitting uncodable characters '"
+                       << latex_symb.second
+                       << "' in nomencl widest string!");
+       return latex_symb.first;
 }
+} // namespace anon
 
 
-int InsetPrintNomencl::latex(odocstream & os, OutputParams const &) const
+void InsetPrintNomencl::latex(otexstream & os, OutputParams const & runparams_in) const
 {
-       int lines = 0;
+       OutputParams runparams = runparams_in;
        if (getParam("set_width") == "auto") {
-               docstring widest = nomenclWidest(buffer());
+               docstring widest = nomenclWidest(buffer(), runparams);
                // Set the label width via nomencl's command \nomlabelwidth.
                // This must be output before the command \printnomenclature
                if (!widest.empty()) {
                        os << "\\settowidth{\\nomlabelwidth}{"
                           << widest
                           << "}\n";
-                       ++lines;
                }
        } else if (getParam("set_width") == "custom") {
                // custom length as optional arg of \printnomenclature
@@ -279,12 +411,12 @@ int InsetPrintNomencl::latex(odocstream & os, OutputParams const &) const
                   << from_ascii(getCmdName())
                   << '['
                   << from_ascii(width)
-                  << "]{}";
-               return lines;
+                  << "]"
+                  << termcmd;
+               return;
        }
        // output the command \printnomenclature
-       os << getCommand();
-       return lines;
+       os << getCommand(runparams);
 }
 
 
@@ -300,9 +432,9 @@ InsetCode InsetPrintNomencl::lyxCode() const
 }
 
 
-docstring InsetPrintNomencl::contextMenu(BufferView const &, int, int) const
+string InsetPrintNomencl::contextMenuName() const
 {
-       return from_ascii("context-nomenclprint");
+       return "context-nomenclprint";
 }