src/insets/InsetCitation.cpp

   1 /**
   2  * \file InsetCitation.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  * \author Herbert Voß
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetCitation.h"
  15
  16 #include "BiblioInfo.h"
  17 #include "Buffer.h"
  18 #include "buffer_funcs.h"
  19 #include "BufferParams.h"
  20 #include "BufferView.h"
  21 #include "DispatchResult.h"
  22 #include "FuncCode.h"
  23 #include "FuncRequest.h"
  24 #include "FuncStatus.h"
  25 #include "LaTeXFeatures.h"
  26 #include "output_xhtml.h"
  27 #include "ParIterator.h"
  28 #include "texstream.h"
  29 #include "TocBackend.h"
  30
  31 #include "support/debug.h"
  32 #include "support/docstream.h"
  33 #include "support/FileNameList.h"
  34 #include "support/gettext.h"
  35 #include "support/lstrings.h"
  36
  37 #include <algorithm>
  38 #include <climits>
  39
  40 using namespace std;
  41 using namespace lyx::support;
  42
  43 namespace lyx {
  44
  45 InsetCitation::InsetCitation(Buffer * buf, InsetCommandParams const & p)
  46         : InsetCommand(buf, p)
  47 {
  48         buffer().removeBiblioTempFiles();
  49 }
  50
  51
  52 InsetCitation::~InsetCitation()
  53 {
  54         if (isBufferLoaded())
  55                 /* We do not use buffer() because Coverity believes that this
  56                  * may throw an exception. Actually this code path is not
  57                  * taken when buffer_ == 0 */
  58                 buffer_->removeBiblioTempFiles();
  59 }
  60
  61
  62 // May well be over-ridden when session settings are loaded
  63 // in GuiCitation. Unfortunately, that will not happen until
  64 // such a dialog is created.
  65 bool InsetCitation::last_literal = true;
  66
  67
  68 ParamInfo const & InsetCitation::findInfo(string const & /* cmdName */)
  69 {
  70         static ParamInfo param_info_;
  71
  72         // standard cite does only take one argument, but biblatex, jurabib
  73         // and natbib extend this to two arguments, so
  74         // we have to allow both here. InsetCitation takes care that
  75         // LaTeX output is nevertheless correct.
  76         if (param_info_.empty()) {
  77                 param_info_.add("after", ParamInfo::LATEX_OPTIONAL,
  78                                 ParamInfo::HANDLING_LATEXIFY);
  79                 param_info_.add("before", ParamInfo::LATEX_OPTIONAL,
  80                                 ParamInfo::HANDLING_LATEXIFY);
  81                 param_info_.add("key", ParamInfo::LATEX_REQUIRED);
  82                 param_info_.add("pretextlist", ParamInfo::LATEX_OPTIONAL,
  83                                 ParamInfo::HANDLING_LATEXIFY);
  84                 param_info_.add("posttextlist", ParamInfo::LATEX_OPTIONAL,
  85                                 ParamInfo::HANDLING_LATEXIFY);
  86                 param_info_.add("literal", ParamInfo::LYX_INTERNAL);
  87         }
  88         return param_info_;
  89 }
  90
  91
  92 // We allow any command here, since we fall back to cite
  93 // anyway if a command is not allowed by a style
  94 bool InsetCitation::isCompatibleCommand(string const &)
  95 {
  96         return true;
  97 }
  98
  99
 100 CitationStyle InsetCitation::getCitationStyle(BufferParams const & bp, string const & input,
 101                                   vector<CitationStyle> const & valid_styles) const
 102 {
 103         CitationStyle cs = valid_styles[0];
 104         cs.forceUpperCase = false;
 105         cs.hasStarredVersion = false;
 106
 107         string normalized_input = input;
 108         string::size_type const n = input.size() - 1;
 109         if (isUpperCase(input[0]))
 110                 normalized_input[0] = lowercase(input[0]);
 111         if (input[n] == '*')
 112                 normalized_input = normalized_input.substr(0, n);
 113
 114         string const alias = bp.getCiteAlias(normalized_input);
 115         if (!alias.empty())
 116                 normalized_input = alias;
 117
 118         vector<CitationStyle>::const_iterator it  = valid_styles.begin();
 119         vector<CitationStyle>::const_iterator end = valid_styles.end();
 120         for (; it != end; ++it) {
 121                 CitationStyle this_cs = *it;
 122                 if (this_cs.name == normalized_input) {
 123                         cs = *it;
 124                         break;
 125                 }
 126         }
 127
 128         return cs;
 129 }
 130
 131
 132 void InsetCitation::doDispatch(Cursor & cur, FuncRequest & cmd)
 133 {
 134         switch (cmd.action()) {
 135         case LFUN_INSET_MODIFY: {
 136                 buffer().removeBiblioTempFiles();
 137                 cache.recalculate = true;
 138                 if (cmd.getArg(0) == "toggleparam") {
 139                         string cmdname = getCmdName();
 140                         string const alias =
 141                                 buffer().masterParams().getCiteAlias(cmdname);
 142                         if (!alias.empty())
 143                                 cmdname = alias;
 144                         string const par = cmd.getArg(1);
 145                         string newcmdname = cmdname;
 146                         if (par == "star") {
 147                                 if (suffixIs(cmdname, "*"))
 148                                         newcmdname = rtrim(cmdname, "*");
 149                                 else
 150                                         newcmdname = cmdname + "*";
 151                         } else if (par == "casing") {
 152                                 if (isUpperCase(cmdname[0]))
 153                                         newcmdname[0] = lowercase(cmdname[0]);
 154                                 else
 155                                         newcmdname[0] = uppercase(newcmdname[0]);
 156                         }
 157                         cmd = FuncRequest(LFUN_INSET_MODIFY, "changetype " + newcmdname);
 158                 }
 159         }
 160         // fall through
 161         default:
 162                 InsetCommand::doDispatch(cur, cmd);
 163         }
 164 }
 165
 166
 167 bool InsetCitation::getStatus(Cursor & cur, FuncRequest const & cmd,
 168         FuncStatus & status) const
 169 {
 170         switch (cmd.action()) {
 171         // Handle the alias case
 172         case LFUN_INSET_MODIFY:
 173                 if (cmd.getArg(0) == "changetype") {
 174                         string cmdname = getCmdName();
 175                         string const alias =
 176                                 buffer().masterParams().getCiteAlias(cmdname);
 177                         if (!alias.empty())
 178                                 cmdname = alias;
 179                         if (suffixIs(cmdname, "*"))
 180                                 cmdname = rtrim(cmdname, "*");
 181                         string const newtype = cmd.getArg(1);
 182                         status.setEnabled(isCompatibleCommand(newtype));
 183                         status.setOnOff(newtype == cmdname);
 184                 }
 185                 if (cmd.getArg(0) == "toggleparam") {
 186                         string cmdname = getCmdName();
 187                         string const alias =
 188                                 buffer().masterParams().getCiteAlias(cmdname);
 189                         if (!alias.empty())
 190                                 cmdname = alias;
 191                         vector<CitationStyle> citation_styles =
 192                                 buffer().masterParams().citeStyles();
 193                         CitationStyle cs = getCitationStyle(buffer().masterParams(),
 194                                                             cmdname, citation_styles);
 195                         if (cmd.getArg(1) == "star") {
 196                                 status.setEnabled(cs.hasStarredVersion);
 197                                 status.setOnOff(suffixIs(cmdname, "*"));
 198                         }
 199                         else if (cmd.getArg(1) == "casing") {
 200                                 status.setEnabled(cs.forceUpperCase);
 201                                 status.setOnOff(isUpperCase(cmdname[0]));
 202                         }
 203                 }
 204                 return true;
 205         default:
 206                 return InsetCommand::getStatus(cur, cmd, status);
 207         }
 208 }
 209
 210
 211 bool InsetCitation::addKey(string const & key)
 212 {
 213         docstring const ukey = from_utf8(key);
 214         docstring const & curkeys = getParam("key");
 215         if (curkeys.empty()) {
 216                 setParam("key", ukey);
 217                 cache.recalculate = true;
 218                 return true;
 219         }
 220
 221         vector<docstring> keys = getVectorFromString(curkeys);
 222         vector<docstring>::const_iterator it = keys.begin();
 223         vector<docstring>::const_iterator en = keys.end();
 224         for (; it != en; ++it) {
 225                 if (*it == ukey) {
 226                         LYXERR0("Key " << key << " already present.");
 227                         return false;
 228                 }
 229         }
 230         keys.push_back(ukey);
 231         setParam("key", getStringFromVector(keys));
 232         cache.recalculate = true;
 233         return true;
 234 }
 235
 236
 237 docstring InsetCitation::toolTip(BufferView const & bv, int, int) const
 238 {
 239         Buffer const & buf = bv.buffer();
 240         // Only after the buffer is loaded from file...
 241         if (!buf.isFullyLoaded())
 242                 return docstring();
 243
 244         BiblioInfo const & bi = buf.masterBibInfo();
 245         if (bi.empty())
 246                 return _("No bibliography defined!");
 247
 248         docstring const & key = getParam("key");
 249         if (key.empty())
 250                 return _("No citations selected!");
 251
 252         CiteItem ci;
 253         ci.richtext = true;
 254         vector<docstring> keys = getVectorFromString(key);
 255         if (keys.size() == 1)
 256                 return bi.getInfo(keys[0], buffer(), ci);
 257
 258         docstring tip;
 259         tip += "<ol>";
 260         int count = 0;
 261         for (docstring const & kvar : keys) {
 262                 docstring const key_info = bi.getInfo(kvar, buffer(), ci);
 263                 // limit to reasonable size.
 264                 if (count > 9 && keys.size() > 11) {
 265                         tip.push_back(0x2026);// HORIZONTAL ELLIPSIS
 266                         tip += "<p>"
 267                                 + bformat(_("+ %1$d more entries."), int(keys.size() - count))
 268                                 + "</p>";
 269                         break;
 270                 }
 271                 if (key_info.empty())
 272                         continue;
 273                 tip += "<li>" + key_info + "</li>";
 274                 ++count;
 275         }
 276         tip += "</ol>";
 277         return tip;
 278 }
 279
 280
 281 namespace {
 282
 283 CitationStyle asValidLatexCommand(BufferParams const & bp, string const & input,
 284                                   vector<CitationStyle> const & valid_styles)
 285 {
 286         CitationStyle cs = valid_styles[0];
 287         cs.forceUpperCase = false;
 288         cs.hasStarredVersion = false;
 289
 290         string normalized_input = input;
 291         string::size_type const n = input.size() - 1;
 292         if (isUpperCase(input[0]))
 293                 normalized_input[0] = lowercase(input[0]);
 294         if (input[n] == '*')
 295                 normalized_input = normalized_input.substr(0, n);
 296
 297         string const alias = bp.getCiteAlias(normalized_input);
 298         if (!alias.empty())
 299                 normalized_input = alias;
 300
 301         vector<CitationStyle>::const_iterator it  = valid_styles.begin();
 302         vector<CitationStyle>::const_iterator end = valid_styles.end();
 303         for (; it != end; ++it) {
 304                 CitationStyle this_cs = *it;
 305                 if (this_cs.name == normalized_input) {
 306                         cs = *it;
 307                         break;
 308                 }
 309         }
 310
 311         cs.forceUpperCase &= input[0] == uppercase(input[0]);
 312         cs.hasStarredVersion &= input[n] == '*';
 313
 314         return cs;
 315 }
 316
 317
 318 inline docstring wrapCitation(docstring const & key,
 319                 docstring const & content, bool for_xhtml)
 320 {
 321         if (!for_xhtml)
 322                 return content;
 323         // we have to do the escaping here, because we will ultimately
 324         // write this as a raw string, so as not to escape the tags.
 325         return "<a href='#LyXCite-" + html::cleanAttr(key) + "'>" +
 326                         html::htmlize(content, XHTMLStream::ESCAPE_ALL) + "</a>";
 327 }
 328
 329 } // anonymous namespace
 330
 331
 332 vector<pair<docstring, docstring>> InsetCitation::getQualifiedLists(docstring const & p) const
 333 {
 334         vector<docstring> ps =
 335                 getVectorFromString(p, from_ascii("\t"));
 336         QualifiedList res;
 337         for (docstring const & s: ps) {
 338                 docstring key = s;
 339                 docstring val;
 340                 if (contains(s, ' '))
 341                         val = split(s, key, ' ');
 342                 res.push_back(make_pair(key, val));
 343         }
 344         return res;
 345 }
 346
 347 docstring InsetCitation::generateLabel(bool for_xhtml) const
 348 {
 349         docstring label;
 350         label = complexLabel(for_xhtml);
 351
 352         // Fallback to fail-safe
 353         if (label.empty())
 354                 label = basicLabel(for_xhtml);
 355
 356         return label;
 357 }
 358
 359
 360 docstring InsetCitation::complexLabel(bool for_xhtml) const
 361 {
 362         Buffer const & buf = buffer();
 363         // Only start the process off after the buffer is loaded from file.
 364         if (!buf.isFullyLoaded())
 365                 return docstring();
 366
 367         BiblioInfo const & biblist = buf.masterBibInfo();
 368         if (biblist.empty())
 369                 return docstring();
 370
 371         docstring const & key = getParam("key");
 372         if (key.empty())
 373                 return _("No citations selected!");
 374
 375         string cite_type = getCmdName();
 376         bool const uppercase = isUpperCase(cite_type[0]);
 377         if (uppercase)
 378                 cite_type[0] = lowercase(cite_type[0]);
 379         bool const starred = (cite_type[cite_type.size() - 1] == '*');
 380         if (starred)
 381                 cite_type = cite_type.substr(0, cite_type.size() - 1);
 382
 383         // handle alias
 384         string const alias = buf.masterParams().getCiteAlias(cite_type);
 385         if (!alias.empty())
 386                 cite_type = alias;
 387
 388         // FIXME: allow to add cite macros
 389         /*
 390         buffer().params().documentClass().addCiteMacro("!textbefore", to_utf8(before));
 391         buffer().params().documentClass().addCiteMacro("!textafter", to_utf8(after));
 392         */
 393         docstring label;
 394         // we only really want the last 'false', to suppress trimming, but
 395         // we need to give the other defaults, too, to set it.
 396         vector<docstring> keys =
 397                 getVectorFromString(key, from_ascii(","), false, false);
 398         CitationStyle cs = getCitationStyle(buffer().masterParams(),
 399                         cite_type, buffer().masterParams().citeStyles());
 400         bool const qualified = cs.hasQualifiedList
 401                 && (keys.size() > 1
 402                     || !getParam("pretextlist").empty()
 403                     || !getParam("posttextlist").empty());
 404         QualifiedList pres = getQualifiedLists(getParam("pretextlist"));
 405         QualifiedList posts = getQualifiedLists(getParam("posttextlist"));
 406
 407         CiteItem ci;
 408         ci.textBefore = getParam("before");
 409         ci.textAfter = getParam("after");
 410         ci.forceUpperCase = uppercase;
 411         ci.Starred = starred;
 412         ci.max_size = UINT_MAX;
 413         ci.isQualified = qualified;
 414         ci.pretexts = pres;
 415         ci.posttexts = posts;
 416         if (for_xhtml) {
 417                 ci.max_key_size = UINT_MAX;
 418                 ci.context = CiteItem::Export;
 419         }
 420         ci.richtext = for_xhtml;
 421         label = biblist.getLabel(keys, buffer(), cite_type, ci);
 422         return label;
 423 }
 424
 425
 426 docstring InsetCitation::basicLabel(bool for_xhtml) const
 427 {
 428         docstring keys = getParam("key");
 429         docstring label;
 430
 431         docstring key;
 432         do {
 433                 // if there is no comma, then everything goes into key
 434                 // and keys will be empty.
 435                 keys = split(keys, key, ',');
 436                 if (!label.empty())
 437                         label += ", ";
 438                 label += wrapCitation(key, key, for_xhtml);
 439         } while (!keys.empty());
 440
 441         docstring const & after = getParam("after");
 442         if (!after.empty())
 443                 label += ", " + after;
 444
 445         return '[' + label + ']';
 446 }
 447
 448
 449 bool InsetCitation::forceLTR(OutputParams const & rp) const
 450 {
 451         // We have to force LTR for numeric references
 452         // [= bibliography, plain BibTeX, numeric natbib
 453         // and biblatex]. Except for XeTeX/bidi. See #3005.
 454         if (rp.useBidiPackage())
 455                 return false;
 456         return (buffer().masterParams().citeEngine() == "basic"
 457                 || buffer().masterParams().citeEngineType() == ENGINE_TYPE_NUMERICAL);
 458 }
 459
 460 docstring InsetCitation::screenLabel() const
 461 {
 462         return cache.screen_label;
 463 }
 464
 465
 466 void InsetCitation::updateBuffer(ParIterator const &, UpdateType)
 467 {
 468         if (!cache.recalculate && buffer().citeLabelsValid())
 469                 return;
 470         // The label may have changed, so we have to re-create it.
 471         docstring const glabel = generateLabel();
 472         cache.recalculate = false;
 473         cache.generated_label = glabel;
 474         unsigned int const maxLabelChars = 45;
 475         cache.screen_label = glabel;
 476         support::truncateWithEllipsis(cache.screen_label, maxLabelChars, true);
 477 }
 478
 479
 480 void InsetCitation::addToToc(DocIterator const & cpit, bool output_active,
 481                                                          UpdateType, TocBackend & backend) const
 482 {
 483         // NOTE
 484         // BiblioInfo::collectCitedEntries() uses the TOC to collect the citations
 485         // from the document. It is used indirectly, via BiblioInfo::makeCitationLables,
 486         // by both XHTML and plaintext output. So, if we change what goes into the TOC,
 487         // then we will also need to change that routine.
 488         docstring const tocitem = getParam("key");
 489         TocBuilder & b = backend.builder("citation");
 490         b.pushItem(cpit, tocitem, output_active);
 491         b.pop();
 492 }
 493
 494
 495 int InsetCitation::plaintext(odocstringstream & os,
 496        OutputParams const &, size_t) const
 497 {
 498         string const & cmd = getCmdName();
 499         if (cmd == "nocite")
 500                 return 0;
 501
 502         docstring const label = generateLabel(false);
 503         os << label;
 504         return label.size();
 505 }
 506
 507
 508 static docstring const cleanupWhitespace(docstring const & citelist)
 509 {
 510         docstring::const_iterator it  = citelist.begin();
 511         docstring::const_iterator end = citelist.end();
 512         // Paranoia check: make sure that there is no whitespace in here
 513         // -- at least not behind commas or at the beginning
 514         docstring result;
 515         char_type last = ',';
 516         for (; it != end; ++it) {
 517                 if (*it != ' ')
 518                         last = *it;
 519                 if (*it != ' ' || last != ',')
 520                         result += *it;
 521         }
 522         return result;
 523 }
 524
 525
 526 int InsetCitation::docbook(odocstream & os, OutputParams const &) const
 527 {
 528         os << from_ascii("<citation>")
 529            << cleanupWhitespace(getParam("key"))
 530            << from_ascii("</citation>");
 531         return 0;
 532 }
 533
 534
 535 docstring InsetCitation::xhtml(XHTMLStream & xs, OutputParams const &) const
 536 {
 537         string const & cmd = getCmdName();
 538         if (cmd == "nocite")
 539                 return docstring();
 540
 541         // have to output this raw, because generateLabel() will include tags
 542         xs << XHTMLStream::ESCAPE_NONE << generateLabel(true);
 543
 544         return docstring();
 545 }
 546
 547
 548 void InsetCitation::toString(odocstream & os) const
 549 {
 550         odocstringstream ods;
 551         plaintext(ods, OutputParams(0));
 552         os << ods.str();
 553 }
 554
 555
 556 void InsetCitation::forOutliner(docstring & os, size_t const, bool const) const
 557 {
 558         os += screenLabel();
 559 }
 560
 561
 562 // Have to overwrite the default InsetCommand method in order to check that
 563 // the \cite command is valid. Eg, the user has natbib enabled, inputs some
 564 // citations and then changes his mind, turning natbib support off. The output
 565 // should revert to the default citation command as provided by the citation
 566 // engine, e.g. \cite[]{} for the basic engine.
 567 void InsetCitation::latex(otexstream & os, OutputParams const & runparams) const
 568 {
 569         // When this is a child compiled on its own, we use the childs
 570         // own bibinfo, else the master's
 571         BiblioInfo const & bi = runparams.is_child
 572                         ? buffer().masterBibInfo() : buffer().bibInfo();
 573         docstring const key = getParam("key");
 574         // "keyonly" command: output the plain key and stop.
 575         if (getCmdName() == "keyonly") {
 576                 // Special command to only return the key
 577                 if (!bi.isBibtex(getParam("key")))
 578                         // escape chars with bibitems
 579                         os << escape(cleanupWhitespace(key));
 580                 else
 581                         os << cleanupWhitespace(key);
 582                 return;
 583         }
 584         vector<CitationStyle> citation_styles = buffer().masterParams().citeStyles();
 585         CitationStyle cs = asValidLatexCommand(buffer().masterParams(),
 586                                                getCmdName(), citation_styles);
 587         // FIXME UNICODE
 588         docstring const cite_str = from_utf8(citationStyleToString(cs, true));
 589
 590         // check if we have to do a qualified list
 591         vector<docstring> keys = getVectorFromString(cleanupWhitespace(key));
 592         bool const qualified = cs.hasQualifiedList
 593                 && (!getParam("pretextlist").empty()
 594                     || !getParam("posttextlist").empty());
 595
 596         if (runparams.inulemcmd > 0)
 597                 os << "\\mbox{";
 598
 599         os << "\\" << cite_str;
 600
 601         if (qualified)
 602                 os << "s";
 603
 604         ParamInfo const & pinfo = findInfo(string());
 605         docstring before = params().prepareCommand(runparams, getParam("before"),
 606                                                    pinfo["before"].handling());
 607         docstring after = params().prepareCommand(runparams, getParam("after"),
 608                                                    pinfo["after"].handling());
 609         if (!before.empty() && cs.textBefore) {
 610                 if (qualified)
 611                         os << '(' << protectArgument(before, '(', ')')
 612                            << ")(" << protectArgument(after, '(', ')') << ')';
 613                 else
 614                         os << '[' << protectArgument(before) << "]["
 615                            << protectArgument(after) << ']';
 616         } else if (!after.empty() && cs.textAfter) {
 617                 if (qualified)
 618                         os << '(' << protectArgument(after, '(', ')') << ')';
 619                 else
 620                         os << '[' << protectArgument(after) << ']';
 621         }
 622
 623         if (!bi.isBibtex(key))
 624                 // escape chars with bibitems
 625                 os << '{' << escape(cleanupWhitespace(key)) << '}';
 626         else {
 627                 if (qualified) {
 628                         QualifiedList pres = getQualifiedLists(getParam("pretextlist"));
 629                         QualifiedList posts = getQualifiedLists(getParam("posttextlist"));
 630                         for (docstring const & k : keys) {
 631                                 docstring prenote;
 632                                 QualifiedList::iterator it = pres.begin();
 633                                 for (; it != pres.end() ; ++it) {
 634                                         if ((*it).first == k) {
 635                                                 prenote = (*it).second;
 636                                                 pres.erase(it);
 637                                                 break;
 638                                         }
 639                                 }
 640                                 docstring bef = params().prepareCommand(runparams, prenote,
 641                                                    pinfo["pretextlist"].handling());
 642                                 docstring postnote;
 643                                 QualifiedList::iterator pit = posts.begin();
 644                                 for (; pit != posts.end() ; ++pit) {
 645                                         if ((*pit).first == k) {
 646                                                 postnote = (*pit).second;
 647                                                 posts.erase(pit);
 648                                                 break;
 649                                         }
 650                                 }
 651                                 docstring aft = params().prepareCommand(runparams, postnote,
 652                                                    pinfo["posttextlist"].handling());
 653                                 if (!bef.empty())
 654                                         os << '[' << protectArgument(bef)
 655                                            << "][" << protectArgument(aft) << ']';
 656                                 else if (!aft.empty())
 657                                         os << '[' << protectArgument(aft) << ']';
 658                                 os << '{' << k << '}';
 659                         }
 660                 } else
 661                         os << '{' << cleanupWhitespace(key) << '}';
 662         }
 663
 664         if (runparams.inulemcmd)
 665                 os << "}";
 666 }
 667
 668
 669 string InsetCitation::contextMenuName() const
 670 {
 671         return "context-citation";
 672 }
 673
 674
 675 } // namespace lyx