]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetNomencl.cpp
Rename XHTMLStream to XMLStream, move it to another file, and prepare for DocBook...
[features.git] / src / insets / InsetNomencl.cpp
index f7f740aa6f4673fbde19818cee36ff27f2141c11..5e8813c39840ad1e658320c64d641763aa337fe9 100644 (file)
@@ -30,7 +30,8 @@
 #include "LyX.h"
 #include "OutputParams.h"
 #include "output_xhtml.h"
-#include "sgml.h"
+#include "xml.h"
+#include "texstream.h"
 #include "TocBackend.h"
 
 #include "frontends/FontMetrics.h"
@@ -54,7 +55,7 @@ namespace lyx {
 
 InsetNomencl::InsetNomencl(Buffer * buf, InsetCommandParams const & p)
        : InsetCommand(buf, p),
-         nomenclature_entry_id(sgml::uniqueID(from_ascii("nomen")))
+         nomenclature_entry_id(xml::uniqueID(from_ascii("nomen")))
 {}
 
 
@@ -64,9 +65,12 @@ ParamInfo const & InsetNomencl::findInfo(string const & /* cmdName */)
        if (param_info_.empty()) {
                param_info_.add("prefix", ParamInfo::LATEX_OPTIONAL);
                param_info_.add("symbol", ParamInfo::LATEX_REQUIRED,
-                               ParamInfo::HANDLING_LATEXIFY);
+                               ParamInfo::ParamHandling(ParamInfo::HANDLING_LATEXIFY
+                                                        | ParamInfo::HANDLING_INDEX_ESCAPE));
                param_info_.add("description", ParamInfo::LATEX_REQUIRED,
-                               ParamInfo::HANDLING_LATEXIFY);
+                               ParamInfo::ParamHandling(ParamInfo::HANDLING_LATEXIFY
+                                                        | ParamInfo::HANDLING_INDEX_ESCAPE));
+               param_info_.add("literal", ParamInfo::LYX_INTERNAL);
        }
        return param_info_;
 }
@@ -75,12 +79,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;
 }
 
@@ -96,17 +96,25 @@ 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
 {
        os << "<glossterm linkend=\"" << nomenclature_entry_id << "\">"
-          << sgml::escapeString(getParam("symbol"))
+          << xml::escapeString(getParam("symbol"))
           << "</glossterm>";
        return 0;
 }
 
 
-docstring InsetNomencl::xhtml(XHTMLStream &, OutputParams const &) const
+docstring InsetNomencl::xhtml(XMLStream &, OutputParams const &) const
 {
        return docstring();
 }
@@ -116,10 +124,10 @@ int InsetNomencl::docbookGlossary(odocstream & os) const
 {
        os << "<glossentry id=\"" << nomenclature_entry_id << "\">\n"
           << "<glossterm>"
-          << sgml::escapeString(getParam("symbol"))
+          << xml::escapeString(getParam("symbol"))
           << "</glossterm>\n"
           << "<glossdef><para>"
-          << sgml::escapeString(getParam("description"))
+          << xml::escapeString(getParam("description"))
           << "</para></glossdef>\n"
           <<"</glossentry>\n";
        return 4;
@@ -129,13 +137,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) const
+void InsetNomencl::addToToc(DocIterator const & cpit, bool output_active,
+                                                       UpdateType, TocBackend & backend) const
 {
        docstring const str = getParam("symbol");
-       buffer().tocBackend().toc("nomencl").push_back(TocItem(cpit, 0, str, output_active));
+       TocBuilder & b = backend.builder("nomencl");
+       b.pushItem(cpit, str, output_active);
+       b.pop();
 }
 
 
@@ -152,7 +164,7 @@ InsetPrintNomencl::InsetPrintNomencl(Buffer * buf, InsetCommandParams const & 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_;
@@ -174,7 +186,7 @@ docstring InsetPrintNomencl::screenLabel() const
 
 
 struct NomenclEntry {
-       NomenclEntry() {}
+       NomenclEntry() : par(0) {}
        NomenclEntry(docstring s, docstring d, Paragraph const * p)
          : symbol(s), desc(d), par(p)
        {}
@@ -188,13 +200,13 @@ struct NomenclEntry {
 typedef map<docstring, NomenclEntry > EntryMap;
 
 
-docstring InsetPrintNomencl::xhtml(XHTMLStream &, OutputParams const & op) const
+docstring InsetPrintNomencl::xhtml(XMLStream &, OutputParams const & op) const
 {
-       Toc const & toc = buffer().tocBackend().toc("nomencl");
+       shared_ptr<Toc const> toc = buffer().tocBackend().toc("nomencl");
 
        EntryMap entries;
-       Toc::const_iterator it = toc.begin();
-       Toc::const_iterator const en = toc.end();
+       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();
@@ -204,60 +216,60 @@ docstring InsetPrintNomencl::xhtml(XHTMLStream &, OutputParams const & op) const
                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);
-       
+       XMLStream 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();
-       
+       xs << xml::StartTag("div", "class='nomencl'")
+          << xml::StartTag(tag, "class='nomencl'")
+                << toclabel
+                << xml::EndTag(tag)
+          << xml::CR()
+          << xml::StartTag("dl")
+          << xml::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'")
+               xs << xml::StartTag("dt")
+                  << xml::StartTag("a", "href='#" + parid + "' class='nomencl'")
                   << ne.symbol
-                  << html::EndTag("a")
-                  << html::EndTag("dt")
-                  << html::CR()
-                  << html::StartTag("dd")
+                  << xml::EndTag("a")
+                  << xml::EndTag("dt")
+                  << xml::CR()
+                  << xml::StartTag("dd")
                   << ne.desc
-                  << html::EndTag("dd")
-                  << html::CR();
+                  << xml::EndTag("dd")
+                  << xml::CR();
        }
 
-       xs << html::EndTag("dl")
-          << html::CR()
-          << html::EndTag("div")
-          << html::CR();
+       xs << xml::EndTag("dl")
+          << xml::CR()
+          << xml::EndTag("div")
+          << xml::CR();
 
        return ods.str();
 }
@@ -352,8 +364,11 @@ docstring nomenclWidest(Buffer const & buffer, OutputParams const & runparams)
                        if (inset->lyxCode() != NOMENCL_CODE)
                                continue;
                        nomencl = static_cast<InsetNomencl const *>(inset);
-                       docstring const symbol =
-                               nomencl->getParam("symbol");
+                       // Use proper formatting. We do not escape makeindex chars here
+                       docstring const symbol = nomencl ?
+                               nomencl->params().prepareCommand(runparams, nomencl->getParam("symbol"),
+                                                       ParamInfo::HANDLING_LATEXIFY)
+                               : docstring();
                        // This is only an approximation,
                        // but the best we can get.
                        int const wx = use_gui ?
@@ -366,19 +381,9 @@ docstring nomenclWidest(Buffer const & buffer, OutputParams const & runparams)
                }
        }
        // return the widest (or an empty) string
-       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;
+       return symb;
 }
-} // namespace anon
+} // namespace
 
 
 void InsetPrintNomencl::latex(otexstream & os, OutputParams const & runparams_in) const
@@ -401,7 +406,8 @@ void InsetPrintNomencl::latex(otexstream & os, OutputParams const & runparams_in
                   << from_ascii(getCmdName())
                   << '['
                   << from_ascii(width)
-                  << "]{}";
+                  << "]"
+                  << termcmd;
                return;
        }
        // output the command \printnomenclature
@@ -411,6 +417,7 @@ void InsetPrintNomencl::latex(otexstream & os, OutputParams const & runparams_in
 
 void InsetPrintNomencl::validate(LaTeXFeatures & features) const
 {
+       features.useInsetLayout(getLayout());
        features.require("nomencl");
 }