]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetNomencl.cpp
New DocBook support
[lyx.git] / src / insets / InsetNomencl.cpp
index c8904e67e088432bf549d0f6e79ecf9d2f0e35c5..e7fc8a7d98935ddfc3274e64b556faf83dec64c9 100644 (file)
@@ -29,8 +29,7 @@
 #include "Length.h"
 #include "LyX.h"
 #include "OutputParams.h"
-#include "output_xhtml.h"
-#include "sgml.h"
+#include "xml.h"
 #include "texstream.h"
 #include "TocBackend.h"
 
@@ -55,7 +54,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")))
 {}
 
 
@@ -65,9 +64,11 @@ 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_;
@@ -103,35 +104,21 @@ int InsetNomencl::plaintext(odocstringstream & os,
 }
 
 
-int InsetNomencl::docbook(odocstream & os, OutputParams const &) const
+void InsetNomencl::docbook(XMLStream & xs, OutputParams const &) const
 {
-       os << "<glossterm linkend=\"" << nomenclature_entry_id << "\">"
-          << sgml::escapeString(getParam("symbol"))
-          << "</glossterm>";
-       return 0;
+       docstring attr = "linkend=\"" + nomenclature_entry_id + "\"";
+       xs << xml::StartTag("glossterm", attr);
+       xs << xml::escapeString(getParam("symbol"));
+       xs << xml::EndTag("glossterm");
 }
 
 
-docstring InsetNomencl::xhtml(XHTMLStream &, OutputParams const &) const
+docstring InsetNomencl::xhtml(XMLStream &, OutputParams const &) const
 {
        return docstring();
 }
 
 
-int InsetNomencl::docbookGlossary(odocstream & os) const
-{
-       os << "<glossentry id=\"" << nomenclature_entry_id << "\">\n"
-          << "<glossterm>"
-          << sgml::escapeString(getParam("symbol"))
-          << "</glossterm>\n"
-          << "<glossdef><para>"
-          << sgml::escapeString(getParam("description"))
-          << "</para></glossdef>\n"
-          <<"</glossentry>\n";
-       return 4;
-}
-
-
 void InsetNomencl::validate(LaTeXFeatures & features) const
 {
        features.require("nomencl");
@@ -162,7 +149,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_;
@@ -198,7 +185,7 @@ struct NomenclEntry {
 typedef map<docstring, NomenclEntry > EntryMap;
 
 
-docstring InsetPrintNomencl::xhtml(XHTMLStream &, OutputParams const & op) const
+docstring InsetPrintNomencl::xhtml(XMLStream &, OutputParams const & op) const
 {
        shared_ptr<Toc const> toc = buffer().tocBackend().toc("nomencl");
 
@@ -214,60 +201,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();
 }
@@ -314,29 +301,75 @@ 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
+void InsetPrintNomencl::docbook(XMLStream & xs, OutputParams const & runparams) const
 {
-       os << "<glossary>\n";
-       int newlines = 2;
-       InsetIterator it = inset_iterator_begin(buffer().inset());
-       while (it) {
-               if (it->lyxCode() == NOMENCL_CODE) {
-                       newlines += static_cast<InsetNomencl const &>(*it).docbookGlossary(os);
-                       ++it;
-               } else if (!it->producesOutput()) {
-                       // Ignore contents of insets that are not in output
-                       size_t const depth = it.depth();
-                       ++it;
-                       while (it.depth() > depth)
-                               ++it;
-               } else {
-                       ++it;
-               }
+       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;
+               InsetCommand const * ic = inset->asInsetCommand();
+               if (!ic)
+                       return;
+
+               // 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;
+
+       // As opposed to XHTML, no need to defer everything until the end of time, so write directly to xs.
+       // TODO: At least, that's what was done before...
+
+       docstring toclabel = translateIfPossible(from_ascii("Nomenclature"),
+                                                                                        runparams.local_font->language()->lang());
+
+       xs << xml::StartTag("glossary");
+       xs << xml::CR();
+       xs << xml::StartTag("title");
+       xs << toclabel;
+       xs << xml::EndTag("title");
+       xs << 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 << xml::StartTag("glossentry", "xml:id=\"" + parid + "\"");
+               xs << xml::CR();
+               xs << xml::StartTag("glossterm");
+               xs << ne.symbol;
+               xs << xml::EndTag("glossterm");
+               xs << xml::CR();
+               xs << xml::StartTag("glossdef");
+               xs << xml::CR();
+               xs << xml::StartTag("para");
+               xs << ne.desc;
+               xs << xml::EndTag("para");
+               xs << xml::CR();
+               xs << xml::EndTag("glossdef");
+               xs << xml::CR();
+               xs << xml::EndTag("glossentry");
+               xs << xml::CR();
        }
-       os << "</glossary>\n";
-       return newlines;
+
+       xs << xml::EndTag("glossary");
+       xs << xml::CR();
 }
 
 
@@ -362,8 +395,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 ?
@@ -376,19 +412,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
@@ -422,6 +448,7 @@ void InsetPrintNomencl::latex(otexstream & os, OutputParams const & runparams_in
 
 void InsetPrintNomencl::validate(LaTeXFeatures & features) const
 {
+       features.useInsetLayout(getLayout());
        features.require("nomencl");
 }