#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"
//
/////////////////////////////////////////////////////////////////////
-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")))
{}
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_;
}
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;
}
}
+docstring InsetNomencl::xhtml(XHTMLStream &, OutputParams const &) const
+{
+ return docstring();
+}
+
+
int InsetNomencl::docbookGlossary(odocstream & os) const
{
os << "<glossentry id=\"" << nomenclature_entry_id << "\">\n"
}
+void InsetNomencl::addToToc(DocIterator const & cpit, bool output_active,
+ UpdateType) 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)
{}
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_;
}
}
+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<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()) {
+
+ 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 << "<glossary>\n";
}
-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;
if (inset->lyxCode() != NOMENCL_CODE)
continue;
nomencl = static_cast<InsetNomencl const *>(inset);
- docstring const symbol = nomencl->getParam("symbol");
- // we can only check for the number of characters, since it is
- // impossible to get the info that "iiiii" is smaller than "WW"
- // we therefore output w times "W" as string ("W" is always the
- // widest character)
- int const wx = symbol.size();
- if (wx > w)
+ docstring const symbol =
+ nomencl->getParam("symbol");
+ // 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 as w times a "W"
- for (int n = 1; n <= w; ++n)
- symb = symb + "W";
- return symb;
+ // 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;
}
+} // namespace anon
-int InsetPrintNomencl::latex(odocstream & os, OutputParams const &) const
+void InsetPrintNomencl::latex(otexstream & os, OutputParams const & runparams_in) const
{
- int lines = 0;
- docstring widest = nomenclWidest(buffer());
- // 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
- os << "\\settowidth{\\nomlabelwidth}{" << widest <<"}\n";
- os << "\\ifthenelse{%\n \\lengthtest{\\nomlabelwidth < 1cm}}\n";
- os << " {\\setlength{\\nomlabelwidth}{1cm}}\n {}\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)
+ << "]{}";
+ 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");
}
}
+string InsetPrintNomencl::contextMenuName() const
+{
+ return "context-nomenclprint";
+}
+
+
} // namespace lyx