X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetNomencl.cpp;h=f7f740aa6f4673fbde19818cee36ff27f2141c11;hb=c9d9309c1ecffa218dee04ce4f7991ed4fc0c9bb;hp=0389afe7fe34d72bee32a4bc85b8670ac96857af;hpb=72ae399fad99fb5f8f000c52ce64f333f14949e0;p=lyx.git diff --git a/src/insets/InsetNomencl.cpp b/src/insets/InsetNomencl.cpp index 0389afe7fe..f7f740aa6f 100644 --- a/src/insets/InsetNomencl.cpp +++ b/src/insets/InsetNomencl.cpp @@ -16,17 +16,26 @@ #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 "MetricsInfo.h" +#include "Length.h" +#include "LyX.h" +#include "OutputParams.h" +#include "output_xhtml.h" #include "sgml.h" +#include "TocBackend.h" #include "frontends/FontMetrics.h" +#include "support/debug.h" #include "support/docstream.h" #include "support/gettext.h" #include "support/lstrings.h" @@ -43,8 +52,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"))) {} @@ -54,8 +63,10 @@ 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); } return param_info_; } @@ -95,6 +106,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 << "\n" @@ -115,14 +132,21 @@ void InsetNomencl::validate(LaTeXFeatures & features) const } +void InsetNomencl::addToToc(DocIterator const & cpit, bool output_active) const +{ + docstring const str = getParam("symbol"); + buffer().tocBackend().toc("nomencl").push_back(TocItem(cpit, 0, str, output_active)); +} + + ///////////////////////////////////////////////////////////////////// // // InsetPrintNomencl // ///////////////////////////////////////////////////////////////////// -InsetPrintNomencl::InsetPrintNomencl(InsetCommandParams const & p) - : InsetCommand(p, "printnomenclature") +InsetPrintNomencl::InsetPrintNomencl(Buffer * buf, InsetCommandParams const & p) + : InsetCommand(buf, p) {} @@ -134,8 +158,10 @@ ParamInfo const & InsetPrintNomencl::findInfo(string const & /* cmdName */) static ParamInfo param_info_; if (param_info_.empty()) { // how is the width set? - // values: none|auto + // values: none|auto|custom param_info_.add("set_width", ParamInfo::LYX_INTERNAL); + // custom width + param_info_.add("width", ParamInfo::LYX_INTERNAL); } return param_info_; } @@ -147,6 +173,139 @@ docstring InsetPrintNomencl::screenLabel() const } +struct NomenclEntry { + NomenclEntry() {} + NomenclEntry(docstring s, docstring d, Paragraph const * p) + : symbol(s), desc(d), par(p) + {} + + docstring symbol; + docstring desc; + Paragraph const * par; +}; + + +typedef map EntryMap; + + +docstring InsetPrintNomencl::xhtml(XHTMLStream &, OutputParams const & op) const +{ + 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()) { + + case LFUN_INSET_MODIFY: { + InsetCommandParams p(NOMENCL_PRINT_CODE); + // FIXME UNICODE + InsetCommand::string2params(to_utf8(cmd.argument()), p); + if (p.getCmdName().empty()) { + cur.noScreenUpdate(); + break; + } + + cur.recordUndo(); + setParams(p); + break; + } + + default: + InsetCommand::doDispatch(cur, cmd); + break; + } +} + + +bool InsetPrintNomencl::getStatus(Cursor & cur, FuncRequest const & cmd, + FuncStatus & status) const +{ + switch (cmd.action()) { + + case LFUN_INSET_DIALOG_UPDATE: + case LFUN_INSET_MODIFY: + status.setEnabled(true); + return true; + + default: + return InsetCommand::getStatus(cur, cmd, status); + } +} + + +// 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 << "\n"; @@ -172,7 +331,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 @@ -197,8 +356,9 @@ docstring nomenclWidest(Buffer const & buffer) nomencl->getParam("symbol"); // This is only an approximation, // but the best we can get. - int const wx = - theFontMetrics(Font()).width(symbol); + int const wx = use_gui ? + theFontMetrics(Font()).width(symbol) : + symbol.size(); if (wx > w) { w = wx; symb = symbol; @@ -206,44 +366,52 @@ 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 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()); - // set the label width via nomencl's command - // \nomlabelwidth. This must be output before the command - // \printnomenclature + 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()) { - // assure that the width is never below the - // predefined value of 1 cm - // FIXME: Why this? os << "\\settowidth{\\nomlabelwidth}{" << widest << "}\n"; - os << "\\ifthenelse{%\n"; - os << "\\lengthtest{\\nomlabelwidth < 1cm}}\n"; - os << " {\\setlength{\\nomlabelwidth}{1cm}}\n"; - os << " {}\n"; - lines += 5; } + } else if (getParam("set_width") == "custom") { + // custom length as optional arg of \printnomenclature + string const width = + Length(to_ascii(getParam("width"))).asLatexString(); + os << '\\' + << from_ascii(getCmdName()) + << '[' + << from_ascii(width) + << "]{}"; + return; } // output the command \printnomenclature - os << getCommand(); - return lines; + os << getCommand(runparams); } void InsetPrintNomencl::validate(LaTeXFeatures & features) const { features.require("nomencl"); - // needed for InsetPrintNomencl::latex - features.require("ifthen"); } @@ -253,4 +421,10 @@ InsetCode InsetPrintNomencl::lyxCode() const } +string InsetPrintNomencl::contextMenuName() const +{ + return "context-nomenclprint"; +} + + } // namespace lyx