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 map<docstring, docstring> InsetCitation::getQualifiedLists(docstring const p) const
 333 {
 334         vector<docstring> ps =
 335                 getVectorFromString(p, from_ascii("\t"));
 336         std::map<docstring, docstring> res;
 337         for (docstring const & s: ps) {
 338                 docstring key;
 339                 docstring val = split(s, key, ' ');
 340                 res[key] = val;
 341         }
 342         return res;
 343 }
 344
 345 docstring InsetCitation::generateLabel(bool for_xhtml) const
 346 {
 347         docstring label;
 348         label = complexLabel(for_xhtml);
 349
 350         // Fallback to fail-safe
 351         if (label.empty())
 352                 label = basicLabel(for_xhtml);
 353
 354         return label;
 355 }
 356
 357
 358 docstring InsetCitation::complexLabel(bool for_xhtml) const
 359 {
 360         Buffer const & buf = buffer();
 361         // Only start the process off after the buffer is loaded from file.
 362         if (!buf.isFullyLoaded())
 363                 return docstring();
 364
 365         BiblioInfo const & biblist = buf.masterBibInfo();
 366         if (biblist.empty())
 367                 return docstring();
 368
 369         docstring const & key = getParam("key");
 370         if (key.empty())
 371                 return _("No citations selected!");
 372
 373         string cite_type = getCmdName();
 374         bool const uppercase = isUpperCase(cite_type[0]);
 375         if (uppercase)
 376                 cite_type[0] = lowercase(cite_type[0]);
 377         bool const starred = (cite_type[cite_type.size() - 1] == '*');
 378         if (starred)
 379                 cite_type = cite_type.substr(0, cite_type.size() - 1);
 380
 381         // handle alias
 382         string const alias = buf.masterParams().getCiteAlias(cite_type);
 383         if (!alias.empty())
 384                 cite_type = alias;
 385
 386         // FIXME: allow to add cite macros
 387         /*
 388         buffer().params().documentClass().addCiteMacro("!textbefore", to_utf8(before));
 389         buffer().params().documentClass().addCiteMacro("!textafter", to_utf8(after));
 390         */
 391         docstring label;
 392         // we only really want the last 'false', to suppress trimming, but
 393         // we need to give the other defaults, too, to set it.
 394         vector<docstring> keys =
 395                 getVectorFromString(key, from_ascii(","), false, false);
 396         CitationStyle cs = getCitationStyle(buffer().masterParams(),
 397                         cite_type, buffer().masterParams().citeStyles());
 398         bool const qualified = cs.hasQualifiedList
 399                 && (keys.size() > 1
 400                     || !getParam("pretextlist").empty()
 401                     || !getParam("posttextlist").empty());
 402         map<docstring, docstring> pres = getQualifiedLists(getParam("pretextlist"));
 403         map<docstring, docstring> posts = getQualifiedLists(getParam("posttextlist"));
 404
 405         CiteItem ci;
 406         ci.textBefore = getParam("before");
 407         ci.textAfter = getParam("after");
 408         ci.forceUpperCase = uppercase;
 409         ci.Starred = starred;
 410         ci.max_size = UINT_MAX;
 411         ci.isQualified = qualified;
 412         ci.pretexts = pres;
 413         ci.posttexts = posts;
 414         if (for_xhtml) {
 415                 ci.max_key_size = UINT_MAX;
 416                 ci.context = CiteItem::Export;
 417         }
 418         ci.richtext = for_xhtml;
 419         label = biblist.getLabel(keys, buffer(), cite_type, ci);
 420         return label;
 421 }
 422
 423
 424 docstring InsetCitation::basicLabel(bool for_xhtml) const
 425 {
 426         docstring keys = getParam("key");
 427         docstring label;
 428
 429         docstring key;
 430         do {
 431                 // if there is no comma, then everything goes into key
 432                 // and keys will be empty.
 433                 keys = split(keys, key, ',');
 434                 if (!label.empty())
 435                         label += ", ";
 436                 label += wrapCitation(key, key, for_xhtml);
 437         } while (!keys.empty());
 438
 439         docstring const & after = getParam("after");
 440         if (!after.empty())
 441                 label += ", " + after;
 442
 443         return '[' + label + ']';
 444 }
 445
 446 docstring InsetCitation::screenLabel() const
 447 {
 448         return cache.screen_label;
 449 }
 450
 451
 452 void InsetCitation::updateBuffer(ParIterator const &, UpdateType)
 453 {
 454         if (!cache.recalculate && buffer().citeLabelsValid())
 455                 return;
 456         // The label may have changed, so we have to re-create it.
 457         docstring const glabel = generateLabel();
 458         cache.recalculate = false;
 459         cache.generated_label = glabel;
 460         unsigned int const maxLabelChars = 45;
 461         cache.screen_label = glabel.substr(0, maxLabelChars + 1);
 462         support::truncateWithEllipsis(cache.screen_label, maxLabelChars);
 463 }
 464
 465
 466 void InsetCitation::addToToc(DocIterator const & cpit, bool output_active,
 467                                                          UpdateType, TocBackend & backend) const
 468 {
 469         // NOTE
 470         // BiblioInfo::collectCitedEntries() uses the TOC to collect the citations
 471         // from the document. It is used indirectly, via BiblioInfo::makeCitationLables,
 472         // by both XHTML and plaintext output. So, if we change what goes into the TOC,
 473         // then we will also need to change that routine.
 474         docstring const tocitem = getParam("key");
 475         TocBuilder & b = backend.builder("citation");
 476         b.pushItem(cpit, tocitem, output_active);
 477         b.pop();
 478 }
 479
 480
 481 int InsetCitation::plaintext(odocstringstream & os,
 482        OutputParams const &, size_t) const
 483 {
 484         string const & cmd = getCmdName();
 485         if (cmd == "nocite")
 486                 return 0;
 487
 488         docstring const label = generateLabel(false);
 489         os << label;
 490         return label.size();
 491 }
 492
 493
 494 static docstring const cleanupWhitespace(docstring const & citelist)
 495 {
 496         docstring::const_iterator it  = citelist.begin();
 497         docstring::const_iterator end = citelist.end();
 498         // Paranoia check: make sure that there is no whitespace in here
 499         // -- at least not behind commas or at the beginning
 500         docstring result;
 501         char_type last = ',';
 502         for (; it != end; ++it) {
 503                 if (*it != ' ')
 504                         last = *it;
 505                 if (*it != ' ' || last != ',')
 506                         result += *it;
 507         }
 508         return result;
 509 }
 510
 511
 512 int InsetCitation::docbook(odocstream & os, OutputParams const &) const
 513 {
 514         os << from_ascii("<citation>")
 515            << cleanupWhitespace(getParam("key"))
 516            << from_ascii("</citation>");
 517         return 0;
 518 }
 519
 520
 521 docstring InsetCitation::xhtml(XHTMLStream & xs, OutputParams const &) const
 522 {
 523         string const & cmd = getCmdName();
 524         if (cmd == "nocite")
 525                 return docstring();
 526
 527         // have to output this raw, because generateLabel() will include tags
 528         xs << XHTMLStream::ESCAPE_NONE << generateLabel(true);
 529
 530         return docstring();
 531 }
 532
 533
 534 void InsetCitation::toString(odocstream & os) const
 535 {
 536         odocstringstream ods;
 537         plaintext(ods, OutputParams(0));
 538         os << ods.str();
 539 }
 540
 541
 542 void InsetCitation::forOutliner(docstring & os, size_t const, bool const) const
 543 {
 544         os += screenLabel();
 545 }
 546
 547
 548 // Have to overwrite the default InsetCommand method in order to check that
 549 // the \cite command is valid. Eg, the user has natbib enabled, inputs some
 550 // citations and then changes his mind, turning natbib support off. The output
 551 // should revert to the default citation command as provided by the citation
 552 // engine, e.g. \cite[]{} for the basic engine.
 553 void InsetCitation::latex(otexstream & os, OutputParams const & runparams) const
 554 {
 555         // When this is a child compiled on its own, we use the childs
 556         // own bibinfo, else the master's
 557         BiblioInfo const & bi = runparams.is_child
 558                         ? buffer().masterBibInfo() : buffer().bibInfo();
 559         docstring const key = getParam("key");
 560         // "keyonly" command: output the plain key and stop.
 561         if (getCmdName() == "keyonly") {
 562                 // Special command to only return the key
 563                 if (!bi.isBibtex(getParam("key")))
 564                         // escape chars with bibitems
 565                         os << escape(cleanupWhitespace(key));
 566                 else
 567                         os << cleanupWhitespace(key);
 568                 return;
 569         }
 570         vector<CitationStyle> citation_styles = buffer().masterParams().citeStyles();
 571         CitationStyle cs = asValidLatexCommand(buffer().masterParams(),
 572                                                getCmdName(), citation_styles);
 573         // FIXME UNICODE
 574         docstring const cite_str = from_utf8(citationStyleToString(cs, true));
 575
 576         // check if we have to do a qualified list
 577         vector<docstring> keys = getVectorFromString(cleanupWhitespace(key));
 578         bool const qualified = cs.hasQualifiedList
 579                 && (!getParam("pretextlist").empty()
 580                     || !getParam("posttextlist").empty());
 581
 582         if (runparams.inulemcmd > 0)
 583                 os << "\\mbox{";
 584
 585         os << "\\" << cite_str;
 586
 587         if (qualified)
 588                 os << "s";
 589
 590         ParamInfo const & pinfo = findInfo(string());
 591         docstring before = params().prepareCommand(runparams, getParam("before"),
 592                                                    pinfo["before"].handling());
 593         docstring after = params().prepareCommand(runparams, getParam("after"),
 594                                                    pinfo["after"].handling());
 595         if (!before.empty() && cs.textBefore) {
 596                 if (qualified)
 597                         os << '(' << protectArgument(before, '(', ')')
 598                            << ")(" << protectArgument(after, '(', ')') << ')';
 599                 else
 600                         os << '[' << protectArgument(before) << "]["
 601                            << protectArgument(after) << ']';
 602         } else if (!after.empty() && cs.textAfter) {
 603                 if (qualified)
 604                         os << '(' << protectArgument(after, '(', ')') << ')';
 605                 else
 606                         os << '[' << protectArgument(after) << ']';
 607         }
 608
 609         if (!bi.isBibtex(key))
 610                 // escape chars with bibitems
 611                 os << '{' << escape(cleanupWhitespace(key)) << '}';
 612         else {
 613                 if (qualified) {
 614                         map<docstring, docstring> pres = getQualifiedLists(getParam("pretextlist"));
 615                         map<docstring, docstring> posts = getQualifiedLists(getParam("posttextlist"));
 616                         for (docstring const & k: keys) {
 617                                 docstring bef = params().prepareCommand(runparams, pres[k],
 618                                                    pinfo["pretextlist"].handling());
 619                                 docstring aft = params().prepareCommand(runparams, posts[k],
 620                                                    pinfo["posttextlist"].handling());
 621                                 if (!bef.empty())
 622                                         os << '[' << protectArgument(bef)
 623                                            << "][" << protectArgument(aft) << ']';
 624                                 else if (!aft.empty())
 625                                         os << '[' << protectArgument(aft) << ']';
 626                                 os << '{' << k << '}';
 627                         }
 628                 } else
 629                         os << '{' << cleanupWhitespace(key) << '}';
 630         }
 631
 632         if (runparams.inulemcmd)
 633                 os << "}";
 634 }
 635
 636
 637 string InsetCitation::contextMenuName() const
 638 {
 639         return "context-citation";
 640 }
 641
 642
 643 } // namespace lyx