src/insets/InsetRef.cpp

   1 /**
   2  * \file InsetRef.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author José Matos
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10 #include <config.h>
  11
  12 #include "InsetRef.h"
  13
  14 #include "Buffer.h"
  15 #include "BufferParams.h"
  16 #include "Cursor.h"
  17 #include "DispatchResult.h"
  18 #include "FuncStatus.h"
  19 #include "InsetLabel.h"
  20 #include "Language.h"
  21 #include "LaTeXFeatures.h"
  22 #include "LyX.h"
  23 #include "OutputParams.h"
  24 #include "output_xhtml.h"
  25 #include "Paragraph.h"
  26 #include "ParIterator.h"
  27 #include "xml.h"
  28 #include "texstream.h"
  29 #include "TocBackend.h"
  30
  31 #include "support/debug.h"
  32 #include "support/docstream.h"
  33 #include "support/gettext.h"
  34 #include "support/lstrings.h"
  35 #include "support/textutils.h"
  36
  37 using namespace lyx::support;
  38 using namespace std;
  39
  40 namespace lyx {
  41
  42
  43 InsetRef::InsetRef(Buffer * buf, InsetCommandParams const & p)
  44         : InsetCommand(buf, p), broken_(false), active_(true)
  45 {}
  46
  47
  48 InsetRef::InsetRef(InsetRef const & ir)
  49         : InsetCommand(ir), broken_(false), active_(true)
  50 {}
  51
  52
  53 bool InsetRef::isCompatibleCommand(string const & s) {
  54         //FIXME This is likely not the best way to handle this.
  55         //But this stuff is hardcoded elsewhere already.
  56         return s == "ref"
  57                 || s == "pageref"
  58                 || s == "vref"
  59                 || s == "vpageref"
  60                 || s == "formatted"
  61                 || s == "prettyref" // for InsetMathRef FIXME
  62                 || s == "eqref"
  63                 || s == "nameref"
  64                 || s == "labelonly";
  65 }
  66
  67
  68 ParamInfo const & InsetRef::findInfo(string const & /* cmdName */)
  69 {
  70         static ParamInfo param_info_;
  71         if (param_info_.empty()) {
  72                 param_info_.add("name", ParamInfo::LATEX_OPTIONAL);
  73                 param_info_.add("reference", ParamInfo::LATEX_REQUIRED,
  74                                 ParamInfo::HANDLING_ESCAPE);
  75                 param_info_.add("plural", ParamInfo::LYX_INTERNAL);
  76                 param_info_.add("caps", ParamInfo::LYX_INTERNAL);
  77                 param_info_.add("noprefix", ParamInfo::LYX_INTERNAL);
  78         }
  79         return param_info_;
  80 }
  81
  82
  83 docstring InsetRef::layoutName() const
  84 {
  85         return from_ascii("Ref");
  86 }
  87
  88
  89 void InsetRef::changeTarget(docstring const & new_label)
  90 {
  91         // With change tracking, we insert a new ref
  92         // and delete the old one
  93         if (buffer().masterParams().track_changes) {
  94                 InsetCommandParams icp(REF_CODE, "ref");
  95                 icp["reference"] = new_label;
  96                 string const data = InsetCommand::params2string(icp);
  97                 lyx::dispatch(FuncRequest(LFUN_INSET_INSERT, data));
  98                 lyx::dispatch(FuncRequest(LFUN_CHAR_DELETE_FORWARD));
  99         } else
 100                 setParam("reference", new_label);
 101 }
 102
 103
 104
 105 void InsetRef::doDispatch(Cursor & cur, FuncRequest & cmd)
 106 {
 107         string const inset = cmd.getArg(0);
 108         string const arg   = cmd.getArg(1);
 109         string pstring;
 110         if (cmd.action() == LFUN_INSET_MODIFY && inset == "ref") {
 111                 if (arg == "toggle-plural")
 112                         pstring = "plural";
 113                 else if (arg == "toggle-caps")
 114                         pstring = "caps";
 115                 else if (arg == "toggle-noprefix")
 116                         pstring = "noprefix";
 117                 else if (arg == "changetarget") {
 118                         string const oldtarget = cmd.getArg(2);
 119                         string const newtarget = cmd.getArg(3);
 120                         if (!oldtarget.empty() && !newtarget.empty()
 121                             && getParam("reference") == from_utf8(oldtarget))
 122                                 changeTarget(from_utf8(newtarget));
 123                         cur.forceBufferUpdate();
 124                         return;
 125                 }
 126         }
 127         // otherwise not for us
 128         if (pstring.empty())
 129                 return InsetCommand::doDispatch(cur, cmd);
 130
 131         bool const isSet = (getParam(pstring) == "true");
 132         setParam(pstring, from_ascii(isSet ? "false"  : "true"));
 133 }
 134
 135
 136 bool InsetRef::getStatus(Cursor & cur, FuncRequest const & cmd,
 137         FuncStatus & status) const
 138 {
 139         if (cmd.action() != LFUN_INSET_MODIFY)
 140                 return InsetCommand::getStatus(cur, cmd, status);
 141         if (cmd.getArg(0) != "ref")
 142                 return InsetCommand::getStatus(cur, cmd, status);
 143
 144         string const arg = cmd.getArg(1);
 145         string pstring;
 146         if (arg == "changetarget")
 147                 return true;
 148         if (arg == "toggle-plural")
 149                 pstring = "plural";
 150         else if (arg == "toggle-caps")
 151                 pstring = "caps";
 152         if (!pstring.empty()) {
 153                 status.setEnabled(buffer().params().use_refstyle &&
 154                         params().getCmdName() == "formatted");
 155                 bool const isSet = (getParam(pstring) == "true");
 156                 status.setOnOff(isSet);
 157                 return true;
 158         }
 159         if (arg == "toggle-noprefix") {
 160                 status.setEnabled(params().getCmdName() == "labelonly");
 161                 bool const isSet = (getParam("noprefix") == "true");
 162                 status.setOnOff(isSet);
 163                 return true;
 164         }
 165         // otherwise not for us
 166         return InsetCommand::getStatus(cur, cmd, status);
 167 }
 168
 169
 170 namespace {
 171
 172 void capitalize(docstring & s) {
 173         char_type t = uppercase(s[0]);
 174         s[0] = t;
 175 }
 176
 177 } // namespace
 178
 179
 180 // the ref argument is the label name we are referencing.
 181 // we expect ref to be in the form: pfx:suffix.
 182 //
 183 // if it isn't, then we can't produce a formatted reference,
 184 // so we return "\ref" and put ref into label.
 185 //
 186 // for refstyle, we return "\pfxcmd", and put suffix into
 187 // label and pfx into prefix. this is because refstyle expects
 188 // the command: \pfxcmd{suffix}.
 189 //
 190 // for prettyref, we return "\prettyref" and put ref into label
 191 // and pfx into prefix. this is because prettyref uses the whole
 192 // label, thus: \prettyref{pfx:suffix}.
 193 //
 194 docstring InsetRef::getFormattedCmd(docstring const & ref,
 195         docstring & label, docstring & prefix, docstring const & caps) const
 196 {
 197         static docstring const defcmd = from_ascii("\\ref");
 198         static docstring const prtcmd = from_ascii("\\prettyref");
 199
 200         label = split(ref, prefix, ':');
 201
 202         // we have to have xxx:xxxxx...
 203         if (label.empty()) {
 204                 LYXERR0("Label `" << ref << "' contains no `:' separator.");
 205                 label = ref;
 206                 prefix = from_ascii("");
 207                 return defcmd;
 208         }
 209
 210         if (prefix.empty()) {
 211                 // we have ":xxxx"
 212                 label = ref;
 213                 return defcmd;
 214         }
 215
 216         if (!buffer().params().use_refstyle) {
 217                 // \prettyref uses the whole label
 218                 label = ref;
 219                 return prtcmd;
 220         }
 221
 222         // make sure the prefix is legal for a latex command
 223         int const len = prefix.size();
 224         for (int i = 0; i < len; i++) {
 225                 char_type const c = prefix[i];
 226                 if (!isAlphaASCII(c)) {
 227                         LYXERR0("Prefix `" << prefix << "' is invalid for LaTeX.");
 228                         // restore the label
 229                         label = ref;
 230                         return defcmd;
 231                 }
 232         }
 233         if (caps == "true") {
 234                 capitalize(prefix);
 235         }
 236         return from_ascii("\\") + prefix + from_ascii("ref");
 237 }
 238
 239
 240 docstring InsetRef::getEscapedLabel(OutputParams const & rp) const
 241 {
 242         InsetCommandParams const & p = params();
 243         ParamInfo const & pi = p.info();
 244         ParamInfo::ParamData const & pd = pi["reference"];
 245         return p.prepareCommand(rp, getParam("reference"), pd.handling());
 246 }
 247
 248
 249 void InsetRef::latex(otexstream & os, OutputParams const & rp) const
 250 {
 251         string const & cmd = getCmdName();
 252         docstring const & data = getEscapedLabel(rp);
 253
 254         if (rp.inulemcmd > 0)
 255                 os << "\\mbox{";
 256
 257         if (cmd == "eqref" && buffer().params().use_refstyle) {
 258                 // we advertise this as printing "(n)", so we'll do that, at least
 259                 // for refstyle, since refstlye's own \eqref prints, by default,
 260                 // "equation n". if one wants \eqref, one can get it by using a
 261                 // formatted label in this case.
 262                 os << '(' << from_ascii("\\ref{") << data << from_ascii("})");
 263         }
 264         else if (cmd == "formatted") {
 265                 docstring label;
 266                 docstring prefix;
 267                 docstring const fcmd =
 268                         getFormattedCmd(data, label, prefix, getParam("caps"));
 269                 os << fcmd;
 270                 if (buffer().params().use_refstyle && getParam("plural") == "true")
 271                     os << "[s]";
 272                 os << '{' << label << '}';
 273         }
 274         else if (cmd == "labelonly") {
 275                 docstring const & ref = getParam("reference");
 276                 if (getParam("noprefix") != "true")
 277                         os << ref;
 278                 else {
 279                         docstring prefix;
 280                         docstring suffix = split(ref, prefix, ':');
 281                         if (suffix.empty()) {
 282                     LYXERR0("Label `" << ref << "' contains no `:' separator.");
 283                                 os << ref;
 284                         } else {
 285                                 os << suffix;
 286                         }
 287                 }
 288         }
 289         else {
 290                 // We don't want to output p_["name"], since that is only used
 291                 // in docbook. So we construct new params, without it, and use that.
 292                 InsetCommandParams p(REF_CODE, cmd);
 293                 docstring const ref = getParam("reference");
 294                 p["reference"] = ref;
 295                 os << p.getCommand(rp);
 296         }
 297
 298         if (rp.inulemcmd > 0)
 299                 os << "}";
 300 }
 301
 302
 303 int InsetRef::plaintext(odocstringstream & os,
 304         OutputParams const &, size_t) const
 305 {
 306         docstring const str = getParam("reference");
 307         os << '[' << str << ']';
 308         return 2 + str.size();
 309 }
 310
 311
 312 void InsetRef::docbook(XMLStream & xs, OutputParams const &) const
 313 {
 314         docstring const & ref = getParam("reference");
 315         InsetLabel const * il = buffer().insetLabel(ref, true);
 316         string const & cmd = params().getCmdName();
 317         docstring linkend = xml::cleanID(ref);
 318
 319         // A name is provided, LyX will provide it. This is supposed to be a very rare case.
 320         // Link with linkend, as is it within the document (not outside, in which case xlink:href is better suited).
 321         docstring const & name = getParam("name");
 322         if (!name.empty()) {
 323                 docstring attr = from_utf8("linkend=\"") + linkend + from_utf8("\"");
 324
 325                 xs << xml::StartTag("link", to_utf8(attr));
 326                 xs << name;
 327                 xs << xml::EndTag("link");
 328                 return;
 329         }
 330
 331         // The DocBook processor will generate the name when required.
 332         docstring display_before;
 333         docstring display_after;
 334         docstring role;
 335
 336         if (il && !il->counterValue().empty()) {
 337                 // Try to construct a label from the InsetLabel we reference.
 338                 if (cmd == "vref" || cmd == "pageref" || cmd == "vpageref" || cmd == "nameref" || cmd == "formatted") {
 339                         // "ref on page #", "on page #", etc. The DocBook processor deals with generating the right text,
 340                         // including in the right language.
 341                         role = from_ascii(cmd);
 342
 343                         if (cmd == "formatted") {
 344                                 // A formatted reference may have many parameters. Generate all of them as roles, the only
 345                                 // way arbitrary parameters can be passed into DocBook.
 346                                 if (buffer().params().use_refstyle && getParam("caps") == "true")
 347                                         role += " refstyle-caps";
 348                                 if (buffer().params().use_refstyle && getParam("plural") == "true")
 349                                         role += " refstyle-plural";
 350                         }
 351                 } else if (cmd == "eqref") {
 352                         display_before = from_ascii("(");
 353                         display_after = from_ascii(")");
 354                 }
 355                 // TODO: what about labelonly? I don't get how this is supposed to work...
 356         }
 357
 358         // No name, ask DocBook to generate one.
 359         docstring attr = from_utf8("linkend=\"") + ref + from_utf8("\"");
 360         if (!role.empty())
 361                 attr += " role=\"" + role + "\"";
 362         xs << display_before;
 363         xs << xml::CompTag("xref", to_utf8(attr));
 364         xs << display_after;
 365 }
 366
 367
 368 docstring InsetRef::xhtml(XMLStream & xs, OutputParams const & op) const
 369 {
 370         docstring const & ref = getParam("reference");
 371         InsetLabel const * il = buffer().insetLabel(ref, true);
 372         string const & cmd = params().getCmdName();
 373         docstring display_string;
 374
 375         if (il && !il->counterValue().empty()) {
 376                 // Try to construct a label from the InsetLabel we reference.
 377                 docstring const & value = il->counterValue();
 378                 if (cmd == "ref")
 379                         display_string = value;
 380                 else if (cmd == "vref")
 381                         // normally, would be "ref on page #", but we have no pages
 382                         display_string = value;
 383                 else if (cmd == "pageref" || cmd == "vpageref")
 384                         // normally would be "on page #", but we have no pages.
 385                         display_string = translateIfPossible(from_ascii("elsewhere"),
 386                                 op.local_font->language()->lang());
 387                 else if (cmd == "eqref")
 388                         display_string = '(' + value + ')';
 389                 else if (cmd == "formatted") {
 390                         display_string = il->prettyCounter();
 391                         if (buffer().params().use_refstyle && getParam("caps") == "true")
 392                                 capitalize(display_string);
 393                         // it is hard to see what to do about plurals...
 394                 }
 395                 else if (cmd == "nameref")
 396                         // FIXME We don't really have the ability to handle these
 397                         // properly in XHTML output yet (bug #8599).
 398                         // It might not be that hard to do. We have the InsetLabel,
 399                         // and we can presumably find its paragraph using the TOC.
 400                         // But the label might be referencing a section, yet not be
 401                         // in that section. So this is not trivial.
 402                         display_string = il->prettyCounter();
 403         } else
 404                         display_string = ref;
 405
 406         // FIXME What we'd really like to do is to be able to output some
 407         // appropriate sort of text here. But to do that, we need to associate
 408         // some sort of counter with the label, and we don't have that yet.
 409         docstring const attr = "href=\"#" + xml::cleanAttr(ref) + '"';
 410         xs << xml::StartTag("a", to_utf8(attr));
 411         xs << display_string;
 412         xs << xml::EndTag("a");
 413         return docstring();
 414 }
 415
 416
 417 void InsetRef::toString(odocstream & os) const
 418 {
 419         odocstringstream ods;
 420         plaintext(ods, OutputParams(0));
 421         os << ods.str();
 422 }
 423
 424
 425 void InsetRef::forOutliner(docstring & os, size_t const, bool const) const
 426 {
 427         // There's no need for details in the TOC, and a long label
 428         // will just get in the way.
 429         os += '#';
 430 }
 431
 432
 433 void InsetRef::updateBuffer(ParIterator const & it, UpdateType, bool const /*deleted*/)
 434 {
 435         docstring const & ref = getParam("reference");
 436
 437         // Check if this one is active (i.e., neither deleted with change-tracking
 438         // nor in an inset that does not produce output, such as notes or inactive branches)
 439         Paragraph const & para = it.paragraph();
 440         active_ = !para.isDeleted(it.pos()) && para.inInset().producesOutput();
 441         // If not, check whether we are in a deleted/non-outputting inset
 442         if (active_) {
 443                 for (size_type sl = 0 ; sl < it.depth() ; ++sl) {
 444                         Paragraph const & outer_par = it[sl].paragraph();
 445                         if (outer_par.isDeleted(it[sl].pos())
 446                             || !outer_par.inInset().producesOutput()) {
 447                                 active_ = false;
 448                                 break;
 449                         }
 450                 }
 451         }
 452
 453         // register this inset into the buffer reference cache.
 454         buffer().addReference(ref, this, it);
 455
 456         docstring label;
 457         string const & cmd = getCmdName();
 458         for (int i = 0; !types[i].latex_name.empty(); ++i) {
 459                 if (cmd == types[i].latex_name) {
 460                         label = _(types[i].short_gui_name);
 461                         break;
 462                 }
 463         }
 464
 465         if (cmd != "labelonly")
 466                 label += ref;
 467         else {
 468                 if (getParam("noprefix") != "true")
 469                         label += ref;
 470                 else {
 471                         docstring prefix;
 472                         docstring suffix = split(ref, prefix, ':');
 473                         if (suffix.empty()) {
 474                                 label += ref;
 475                         } else {
 476                                 label += suffix;
 477                         }
 478                 }
 479         }
 480
 481         if (!buffer().params().isLatex() && !getParam("name").empty()) {
 482                 label += "||";
 483                 label += getParam("name");
 484         }
 485
 486         unsigned int const maxLabelChars = 24;
 487         if (label.size() > maxLabelChars) {
 488                 tooltip_ = label;
 489                 support::truncateWithEllipsis(label, maxLabelChars);
 490         } else
 491                 tooltip_ = from_ascii("");
 492
 493         screen_label_ = label;
 494         broken_ = false;
 495         setBroken(broken_);
 496 }
 497
 498
 499 docstring InsetRef::screenLabel() const
 500 {
 501         return (broken_ ? _("BROKEN: ") : docstring()) + screen_label_;
 502 }
 503
 504
 505 void InsetRef::addToToc(DocIterator const & cpit, bool output_active,
 506                         UpdateType, TocBackend & backend) const
 507 {
 508         active_ = output_active;
 509         docstring const & label = getParam("reference");
 510         if (buffer().insetLabel(label)) {
 511                 broken_ = !buffer().activeLabel(label);
 512                 setBroken(broken_);
 513                 if (broken_ && output_active) {
 514                         shared_ptr<Toc> toc2 = backend.toc("brokenrefs");
 515                         toc2->push_back(TocItem(cpit, 0, screenLabel(), output_active));
 516                 }
 517                 // This InsetRef has already been taken care of in InsetLabel::addToToc().
 518                 return;
 519         }
 520
 521         // It seems that this reference does not point to any valid label.
 522         broken_ = true;
 523         setBroken(broken_);
 524         shared_ptr<Toc> toc = backend.toc("label");
 525         toc->push_back(TocItem(cpit, 0, screenLabel(), output_active));
 526         shared_ptr<Toc> toc2 = backend.toc("brokenrefs");
 527         toc2->push_back(TocItem(cpit, 0, screenLabel(), output_active));
 528 }
 529
 530
 531 void InsetRef::validate(LaTeXFeatures & features) const
 532 {
 533         string const cmd = getCmdName();
 534         if (cmd == "vref" || cmd == "vpageref")
 535                 features.require("varioref");
 536         else if (cmd == "formatted") {
 537                 docstring const data = getEscapedLabel(features.runparams());
 538                 docstring label;
 539                 docstring prefix;
 540                 docstring const fcmd =
 541                         getFormattedCmd(data, label, prefix, getParam("caps"));
 542                 if (buffer().params().use_refstyle) {
 543                         features.require("refstyle");
 544                         if (prefix == "cha")
 545                                 features.addPreambleSnippet(from_ascii("\\let\\charef=\\chapref"));
 546                         else if (!prefix.empty()) {
 547                                 docstring lcmd = "\\AtBeginDocument{\\providecommand" +
 548                                                 fcmd + "[1]{\\ref{" + prefix + ":#1}}}";
 549                                 features.addPreambleSnippet(lcmd);
 550                         }
 551                 } else {
 552                         features.require("prettyref");
 553                         // prettyref uses "cha" for chapters, so we provide a kind of
 554                         // translation.
 555                         if (prefix == "chap")
 556                                 features.addPreambleSnippet(from_ascii("\\let\\pr@chap=\\pr@cha"));
 557                 }
 558         } else if (cmd == "eqref" && !buffer().params().use_refstyle)
 559                 // with refstyle, we simply output "(\ref{label})"
 560                 features.require("amsmath");
 561         else if (cmd == "nameref")
 562                 features.require("nameref");
 563 }
 564
 565 bool InsetRef::forceLTR(OutputParams const & rp) const
 566 {
 567         // We force LTR for references. However,
 568         // * Namerefs are output in the scripts direction
 569         //   at least with fontspec/bidi and luabidi, though (see #11518).
 570         // * Parentheses are automatically swapped with XeTeX/bidi
 571         //   [not with LuaTeX/luabidi] (see #11626).
 572         // FIXME: Re-Audit all other RTL cases.
 573         if (rp.useBidiPackage())
 574                 return false;
 575         return (getCmdName() != "nameref" || !buffer().masterParams().useNonTeXFonts);
 576 }
 577
 578
 579 InsetRef::type_info const InsetRef::types[] = {
 580         { "ref",       N_("Standard"),              N_("Ref: ")},
 581         { "eqref",     N_("Equation"),              N_("EqRef: ")},
 582         { "pageref",   N_("Page Number"),           N_("Page: ")},
 583         { "vpageref",  N_("Textual Page Number"),   N_("TextPage: ")},
 584         { "vref",      N_("Standard+Textual Page"), N_("Ref+Text: ")},
 585         { "nameref",   N_("Reference to Name"),     N_("NameRef: ")},
 586         { "formatted", N_("Formatted"),             N_("Format: ")},
 587         { "labelonly", N_("Label Only"),            N_("Label: ")},
 588         { "", "", "" }
 589 };
 590
 591
 592 docstring InsetRef::getTOCString() const
 593 {
 594         docstring const & label = getParam("reference");
 595         if (buffer().insetLabel(label))
 596                 broken_ = !buffer().activeLabel(label) && active_;
 597         else
 598                 broken_ = active_;
 599         return tooltip_.empty() ? screenLabel() : tooltip_;
 600 }
 601
 602 } // namespace lyx