#include "InsetNote.h"
#include "Buffer.h"
+#include "Cursor.h"
#include "DispatchResult.h"
+#include "Font.h"
+#include "Encoding.h"
#include "FuncRequest.h"
-#include "InsetIterator.h"
+#include "FuncStatus.h"
+#include "InsetLayout.h"
#include "InsetList.h"
+#include "Language.h"
#include "LaTeXFeatures.h"
-#include "MetricsInfo.h"
-#include "sgml.h"
+#include "LyX.h"
+#include "xml.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/Length.h"
#include "support/lstrings.h"
using namespace std;
//
/////////////////////////////////////////////////////////////////////
-InsetNomencl::InsetNomencl(InsetCommandParams const & p)
- : InsetCommand(p, "nomenclature"),
- nomenclature_entry_id(sgml::uniqueID(from_ascii("nomen")))
+InsetNomencl::InsetNomencl(Buffer * buf, InsetCommandParams const & p)
+ : InsetCommand(buf, p)
{}
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::ParamHandling(ParamInfo::HANDLING_LATEXIFY
+ | ParamInfo::HANDLING_INDEX_ESCAPE));
+ param_info_.add("description", ParamInfo::LATEX_REQUIRED,
+ ParamInfo::ParamHandling(ParamInfo::HANDLING_LATEXIFY
+ | ParamInfo::HANDLING_INDEX_ESCAPE));
+ param_info_.add("literal", ParamInfo::LYX_INTERNAL);
}
return param_info_;
}
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;
}
}
+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
+void InsetNomencl::docbook(XMLStream & xs, OutputParams const &) const
{
- os << "<glossterm linkend=\"" << nomenclature_entry_id << "\">"
- << sgml::escapeString(getParam("symbol"))
- << "</glossterm>";
- return 0;
+ docstring attr = "linkend=\"" + xml::cleanID(from_ascii("nomen") + getParam("symbol")) + "\"";
+ xs << xml::StartTag("glossterm", attr);
+ xs << xml::escapeString(getParam("symbol"));
+ xs << xml::EndTag("glossterm");
}
-int InsetNomencl::docbookGlossary(odocstream & os) const
+docstring InsetNomencl::xhtml(XMLStream &, OutputParams const &) 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;
+ return docstring();
}
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();
}
//
/////////////////////////////////////////////////////////////////////
-InsetPrintNomencl::InsetPrintNomencl(InsetCommandParams const & p)
- : InsetCommand(p, "printnomenclature")
+InsetPrintNomencl::InsetPrintNomencl(Buffer * buf, InsetCommandParams const & p)
+ : InsetCommand(buf, p)
{}
ParamInfo const & InsetPrintNomencl::findInfo(string const & /* cmdName */)
{
- // there are no parameters to give because the symbol width is set via
- // nomencl's \nomlabelwidth in InsetPrintNomencl::latex and not as
- // optional parameter of \printnomenclature
+ // The symbol width is set via nomencl's \nomlabelwidth in
+ // InsetPrintNomencl::latex and not as optional parameter of
+ // \printnomenclature
static ParamInfo param_info_;
+ if (param_info_.empty()) {
+ // how is the width set?
+ // values: none|auto|custom
+ param_info_.add("set_width", ParamInfo::LYX_INTERNAL);
+ // custom width
+ param_info_.add("width", ParamInfo::LYX_INTERNAL);
+ }
return param_info_;
}
}
-int InsetPrintNomencl::docbook(odocstream & os, OutputParams const &) 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;
+struct NomenclEntry {
+ NomenclEntry() : par(nullptr) {}
+ 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(XMLStream &, 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;
+ XMLStream xs(ods);
+
+ InsetLayout const & il = getLayout();
+ string const & tag = il.htmltag();
+ docstring toclabel = translateIfPossible(from_ascii("Nomenclature"),
+ op.local_font->language()->lang());
+
+ 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 << xml::StartTag("dt")
+ << xml::StartTag("a", "href='#" + parid + "' class='nomencl'")
+ << ne.symbol
+ << xml::EndTag("a")
+ << xml::EndTag("dt")
+ << xml::CR()
+ << xml::StartTag("dd")
+ << ne.desc
+ << xml::EndTag("dd")
+ << xml::CR();
+ }
+
+ xs << xml::EndTag("dl")
+ << xml::CR()
+ << xml::EndTag("div")
+ << xml::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);
+ }
+}
+
+
+void InsetPrintNomencl::docbook(XMLStream & xs, OutputParams const & runparams) 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;
+ 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);
}
- os << "</glossary>\n";
- return newlines;
+
+ 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;
+
+ xs << xml::StartTag("glossentry", "xml:id=\"" + xml::cleanID(from_ascii("nomen") + ne.symbol) + "\"");
+ 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();
+ }
+
+ xs << xml::EndTag("glossary");
+ xs << xml::CR();
}
-docstring nomenclWidest(Buffer const & buffer)
+namespace {
+docstring nomenclWidest(Buffer const & buffer, OutputParams const & runparams)
{
- // nomenclWidest() determines and returns the widest used nomenclature
- // symbol in the document
+ // nomenclWidest() determines and returns the widest used
+ // nomenclature symbol in the document
int w = 0;
docstring symb;
- InsetNomencl const * nomencl = 0;
-
+ InsetNomencl const * nomencl = nullptr;
ParagraphList::const_iterator it = buffer.paragraphs().begin();
ParagraphList::const_iterator end = buffer.paragraphs().end();
if (inset->lyxCode() != NOMENCL_CODE)
continue;
nomencl = static_cast<InsetNomencl const *>(inset);
- docstring const symbol = nomencl->getParam("symbol");
- int const wx = symbol.size();
+ // Use proper formatting. We do not escape makeindex chars here
+ docstring symbol = nomencl ?
+ nomencl->params().prepareCommand(runparams, nomencl->getParam("symbol"),
+ ParamInfo::HANDLING_LATEXIFY)
+ : docstring();
+ // strip out % characters which are used as escape in nomencl
+ // but act as comment in our context here
+ symbol = subst(symbol, from_ascii("%"), docstring());
+ // This is only an approximation,
+ // but the best we can get.
+ int const wx = use_gui ?
+ theFontMetrics(Font()).width(symbol) :
+ symbol.size();
if (wx > w) {
w = wx;
symb = symbol;
}
}
}
-
- // return the widest symbol
+ // return the widest (or an empty) string
return symb;
}
+} // namespace
-int InsetPrintNomencl::latex(odocstream & os, OutputParams const &) const
+void InsetPrintNomencl::latex(otexstream & os, OutputParams const & runparams_in) const
{
- int lines = 0;
- // this must be output before the command \printnomenclature
- docstring widest = nomenclWidest(buffer());
- if (!widest.empty()) {
- // set the label width via nomencl's command \nomlabelwidth
- os << "\\settowidth{\\nomlabelwidth}{";
- os << widest <<"}\n";
- ++lines;
+ OutputParams runparams = runparams_in;
+ if (getParam("set_width") == "auto") {
+ 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";
+ }
+ } 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)
+ << "]"
+ << termcmd;
+ return;
}
// output the command \printnomenclature
- os << getCommand();
- return lines;
+ os << getCommand(runparams);
}
void InsetPrintNomencl::validate(LaTeXFeatures & features) const
{
+ features.useInsetLayout(getLayout());
features.require("nomencl");
}
}
+string InsetPrintNomencl::contextMenuName() const
+{
+ return "context-nomenclprint";
+}
+
+
} // namespace lyx
projects / lyx.git / blobdiff