src/insets/InsetNomencl.cpp

   1 /**
   2  * \file InsetNomencl.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author O. U. Baran
   8  * \author Uwe Stöhr
   9  * \author Jürgen Spitzmüller
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13 #include <config.h>
  14
  15 #include "InsetNomencl.h"
  16 #include "InsetNote.h"
  17
  18 #include "Buffer.h"
  19 #include "DispatchResult.h"
  20 #include "Font.h"
  21 #include "Encoding.h"
  22 #include "FuncRequest.h"
  23 #include "FuncStatus.h"
  24 #include "InsetIterator.h"
  25 #include "InsetList.h"
  26 #include "LaTeXFeatures.h"
  27 #include "Length.h"
  28 #include "LyX.h"
  29 #include "MetricsInfo.h"
  30 #include "OutputParams.h"
  31 #include "output_xhtml.h"
  32 #include "sgml.h"
  33
  34 #include "frontends/FontMetrics.h"
  35
  36 #include "support/docstream.h"
  37 #include "support/gettext.h"
  38 #include "support/lstrings.h"
  39
  40 using namespace std;
  41 using namespace lyx::support;
  42
  43 namespace lyx {
  44
  45
  46 /////////////////////////////////////////////////////////////////////
  47 //
  48 // InsetNomencl
  49 //
  50 /////////////////////////////////////////////////////////////////////
  51
  52 InsetNomencl::InsetNomencl(Buffer * buf, InsetCommandParams const & p)
  53         : InsetCommand(buf, p, "nomenclature"),
  54           nomenclature_entry_id(sgml::uniqueID(from_ascii("nomen")))
  55 {}
  56
  57
  58 ParamInfo const & InsetNomencl::findInfo(string const & /* cmdName */)
  59 {
  60         static ParamInfo param_info_;
  61         if (param_info_.empty()) {
  62                 param_info_.add("prefix", ParamInfo::LATEX_OPTIONAL);
  63                 param_info_.add("symbol", ParamInfo::LATEX_REQUIRED,
  64                                 ParamInfo::HANDLING_LATEXIFY);
  65                 param_info_.add("description", ParamInfo::LATEX_REQUIRED,
  66                                 ParamInfo::HANDLING_LATEXIFY);
  67         }
  68         return param_info_;
  69 }
  70
  71
  72 docstring InsetNomencl::screenLabel() const
  73 {
  74         size_t const maxLabelChars = 25;
  75
  76         docstring label = _("Nom: ") + getParam("symbol");
  77         if (label.size() > maxLabelChars) {
  78                 label.erase(maxLabelChars - 3);
  79                 label += "...";
  80         }
  81         return label;
  82 }
  83
  84
  85 docstring InsetNomencl::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
  86 {
  87         docstring tip = _("Nomenclature Symbol: ") + getParam("symbol") + "\n";
  88         tip += _("Description: ") + "\t"
  89                 + subst(getParam("description"), from_ascii("\\\\"), from_ascii("\n\t"));
  90         if (!getParam("prefix").empty())
  91                 tip += "\n" + _("Sorting: ") + getParam("prefix");
  92         return tip;
  93 }
  94
  95
  96
  97 int InsetNomencl::docbook(odocstream & os, OutputParams const &) const
  98 {
  99         os << "<glossterm linkend=\"" << nomenclature_entry_id << "\">"
 100            << sgml::escapeString(getParam("symbol"))
 101            << "</glossterm>";
 102         return 0;
 103 }
 104
 105
 106 docstring InsetNomencl::xhtml(XHTMLStream &, OutputParams const &) const
 107 {
 108         return docstring();
 109 }
 110
 111
 112 int InsetNomencl::docbookGlossary(odocstream & os) const
 113 {
 114         os << "<glossentry id=\"" << nomenclature_entry_id << "\">\n"
 115            << "<glossterm>"
 116            << sgml::escapeString(getParam("symbol"))
 117            << "</glossterm>\n"
 118            << "<glossdef><para>"
 119            << sgml::escapeString(getParam("description"))
 120            << "</para></glossdef>\n"
 121            <<"</glossentry>\n";
 122         return 4;
 123 }
 124
 125
 126 void InsetNomencl::validate(LaTeXFeatures & features) const
 127 {
 128         features.require("nomencl");
 129 }
 130
 131
 132 /////////////////////////////////////////////////////////////////////
 133 //
 134 // InsetPrintNomencl
 135 //
 136 /////////////////////////////////////////////////////////////////////
 137
 138 InsetPrintNomencl::InsetPrintNomencl(Buffer * buf, InsetCommandParams const & p)
 139         : InsetCommand(buf, p, "nomencl_print")
 140 {}
 141
 142
 143 ParamInfo const & InsetPrintNomencl::findInfo(string const & /* cmdName */)
 144 {
 145         // The symbol width is set via nomencl's \nomlabelwidth in
 146         // InsetPrintNomencl::latex and not as optional parameter of
 147         // \printnomenclature
 148         static ParamInfo param_info_;
 149         if (param_info_.empty()) {
 150                 // how is the width set?
 151                 // values: none|auto|custom
 152                 param_info_.add("set_width", ParamInfo::LYX_INTERNAL);
 153                 // custom width
 154                 param_info_.add("width", ParamInfo::LYX_INTERNAL);
 155         }
 156         return param_info_;
 157 }
 158
 159
 160 docstring InsetPrintNomencl::screenLabel() const
 161 {
 162         return _("Nomenclature");
 163 }
 164
 165
 166 void InsetPrintNomencl::doDispatch(Cursor & cur, FuncRequest & cmd)
 167 {
 168         switch (cmd.action) {
 169
 170         case LFUN_INSET_MODIFY: {
 171                 InsetCommandParams p(NOMENCL_PRINT_CODE);
 172                 // FIXME UNICODE
 173                 InsetCommand::string2params("nomencl_print",
 174                         to_utf8(cmd.argument()), p);
 175                 if (p.getCmdName().empty()) {
 176                         cur.noUpdate();
 177                         break;
 178                 }
 179                 setParams(p);
 180                 break;
 181         }
 182
 183         default:
 184                 InsetCommand::doDispatch(cur, cmd);
 185                 break;
 186         }
 187 }
 188
 189
 190 bool InsetPrintNomencl::getStatus(Cursor & cur, FuncRequest const & cmd,
 191         FuncStatus & status) const
 192 {
 193         switch (cmd.action) {
 194
 195         case LFUN_INSET_DIALOG_UPDATE:
 196         case LFUN_INSET_MODIFY:
 197                 status.setEnabled(true);
 198                 return true;
 199
 200         default:
 201                 return InsetCommand::getStatus(cur, cmd, status);
 202         }
 203 }
 204
 205
 206 docstring InsetPrintNomencl::xhtml(XHTMLStream &, OutputParams const &) const
 207 {
 208         return docstring();
 209 }
 210
 211
 212 int InsetPrintNomencl::docbook(odocstream & os, OutputParams const &) const
 213 {
 214         os << "<glossary>\n";
 215         int newlines = 2;
 216         InsetIterator it = inset_iterator_begin(buffer().inset());
 217         while (it) {
 218                 if (it->lyxCode() == NOMENCL_CODE) {
 219                         newlines += static_cast<InsetNomencl const &>(*it).docbookGlossary(os);
 220                         ++it;
 221                 } else if (!it->producesOutput()) {
 222                         // Ignore contents of insets that are not in output
 223                         size_t const depth = it.depth();
 224                         ++it;
 225                         while (it.depth() > depth)
 226                                 ++it;
 227                 } else {
 228                         ++it;
 229                 }
 230         }
 231         os << "</glossary>\n";
 232         return newlines;
 233 }
 234
 235
 236 namespace {
 237 docstring nomenclWidest(Buffer const & buffer, OutputParams const & runparams)
 238 {
 239         // nomenclWidest() determines and returns the widest used
 240         // nomenclature symbol in the document
 241
 242         int w = 0;
 243         docstring symb;
 244         InsetNomencl const * nomencl = 0;
 245         ParagraphList::const_iterator it = buffer.paragraphs().begin();
 246         ParagraphList::const_iterator end = buffer.paragraphs().end();
 247
 248         for (; it != end; ++it) {
 249                 if (it->insetList().empty())
 250                         continue;
 251                 InsetList::const_iterator iit = it->insetList().begin();
 252                 InsetList::const_iterator eend = it->insetList().end();
 253                 for (; iit != eend; ++iit) {
 254                         Inset * inset = iit->inset;
 255                         if (inset->lyxCode() != NOMENCL_CODE)
 256                                 continue;
 257                         nomencl = static_cast<InsetNomencl const *>(inset);
 258                         docstring const symbol =
 259                                 nomencl->getParam("symbol");
 260                         // This is only an approximation,
 261                         // but the best we can get.
 262                         int const wx = use_gui ?
 263                                 theFontMetrics(Font()).width(symbol) :
 264                                 symbol.size();
 265                         if (wx > w) {
 266                                 w = wx;
 267                                 symb = symbol;
 268                         }
 269                 }
 270         }
 271         // return the widest (or an empty) string
 272         if (symb.empty())
 273                 return symb;
 274
 275         // we have to encode the string properly
 276         docstring latex_symb;
 277         for (size_t n = 0; n < symb.size(); ++n) {
 278                 try {
 279                         latex_symb += runparams.encoding->latexChar(symb[n]);
 280                 } catch (EncodingException & /* e */) {
 281                         if (runparams.dryrun) {
 282                                 latex_symb += "<" + _("LyX Warning: ")
 283                                            + _("uncodable character") + " '";
 284                                 latex_symb += docstring(1, symb[n]);
 285                                 latex_symb += "'>";
 286                         }
 287                 }
 288         }
 289         return latex_symb;
 290 }
 291 } // namespace anon
 292
 293
 294 int InsetPrintNomencl::latex(odocstream & os, OutputParams const & runparams_in) const
 295 {
 296         OutputParams runparams = runparams_in;
 297         int lines = 0;
 298         if (getParam("set_width") == "auto") {
 299                 docstring widest = nomenclWidest(buffer(), runparams);
 300                 // Set the label width via nomencl's command \nomlabelwidth.
 301                 // This must be output before the command \printnomenclature
 302                 if (!widest.empty()) {
 303                         os << "\\settowidth{\\nomlabelwidth}{"
 304                            << widest
 305                            << "}\n";
 306                         ++lines;
 307                 }
 308         } else if (getParam("set_width") == "custom") {
 309                 // custom length as optional arg of \printnomenclature
 310                 string const width =
 311                         Length(to_ascii(getParam("width"))).asLatexString();
 312                 os << '\\'
 313                    << from_ascii(getCmdName())
 314                    << '['
 315                    << from_ascii(width)
 316                    << "]{}";
 317                 return lines;
 318         }
 319         // output the command \printnomenclature
 320         os << getCommand(runparams);
 321         return lines;
 322 }
 323
 324
 325 void InsetPrintNomencl::validate(LaTeXFeatures & features) const
 326 {
 327         features.require("nomencl");
 328 }
 329
 330
 331 InsetCode InsetPrintNomencl::lyxCode() const
 332 {
 333         return NOMENCL_PRINT_CODE;
 334 }
 335
 336
 337 docstring InsetPrintNomencl::contextMenu(BufferView const &, int, int) const
 338 {
 339         return from_ascii("context-nomenclprint");
 340 }
 341
 342
 343 } // namespace lyx