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 "InsetLabel.h"
  19 #include "LaTeXFeatures.h"
  20 #include "LyX.h"
  21 #include "OutputParams.h"
  22 #include "output_xhtml.h"
  23 #include "ParIterator.h"
  24 #include "sgml.h"
  25 #include "TocBackend.h"
  26
  27 #include "support/debug.h"
  28 #include "support/docstream.h"
  29 #include "support/gettext.h"
  30 #include "support/lstrings.h"
  31 #include "support/textutils.h"
  32
  33 using namespace lyx::support;
  34 using namespace std;
  35
  36 namespace lyx {
  37
  38
  39 InsetRef::InsetRef(Buffer * buf, InsetCommandParams const & p)
  40         : InsetCommand(buf, p)
  41 {}
  42
  43
  44 InsetRef::InsetRef(InsetRef const & ir)
  45         : InsetCommand(ir)
  46 {}
  47
  48
  49 bool InsetRef::isCompatibleCommand(string const & s) {
  50         //FIXME This is likely not the best way to handle this.
  51         //But this stuff is hardcoded elsewhere already.
  52         return s == "ref"
  53                 || s == "pageref"
  54                 || s == "vref"
  55                 || s == "vpageref"
  56                 || s == "formatted"
  57                 || s == "eqref"
  58                 || s == "nameref";
  59 }
  60
  61
  62 ParamInfo const & InsetRef::findInfo(string const & /* cmdName */)
  63 {
  64         static ParamInfo param_info_;
  65         if (param_info_.empty()) {
  66                 param_info_.add("name", ParamInfo::LATEX_OPTIONAL);
  67                 param_info_.add("reference", ParamInfo::LATEX_REQUIRED,
  68                                 ParamInfo::HANDLING_ESCAPE);
  69         }
  70         return param_info_;
  71 }
  72
  73
  74 // the ref argument is the label name we are referencing.
  75 // we expect ref to be in the form: pfx:suffix.
  76 //
  77 // if it isn't, then we can't produce a formatted reference,
  78 // so we return "\ref" and put ref into label.
  79 //
  80 // for refstyle, we return "\pfxcmd", and put suffix into
  81 // label and pfx into prefix. this is because refstyle expects
  82 // the command: \pfxcmd{suffix}.
  83 //
  84 // for prettyref, we return "\prettyref" and put ref into label
  85 // and pfx into prefix. this is because prettyref uses the whole
  86 // label, thus: \prettyref{pfx:suffix}.
  87 //
  88 docstring InsetRef::getFormattedCmd(docstring const & ref,
  89         docstring & label, docstring & prefix) const
  90 {
  91         static docstring const defcmd = from_ascii("\\ref");
  92         static docstring const prtcmd = from_ascii("\\prettyref");
  93
  94         label = split(ref, prefix, ':');
  95
  96         // we have to have xxx:xxxxx...
  97         if (label.empty()) {
  98                 LYXERR0("Label `" << ref << "' contains no prefix.");
  99                 label = ref;
 100                 prefix = from_ascii("");
 101                 return defcmd;
 102         }
 103
 104         if (prefix.empty()) {
 105                 // we have ":xxxx"
 106                 label = ref;
 107                 return defcmd;
 108         }
 109
 110         if (!buffer().params().use_refstyle) {
 111                 // \prettyref uses the whole label
 112                 label = ref;
 113                 return prtcmd;
 114         }
 115
 116         // make sure the prefix is legal for a latex command
 117         int const len = prefix.size();
 118         for (int i = 0; i < len; i++) {
 119                 char_type const c = prefix[i];
 120                 if (!isAlphaASCII(c)) {
 121                         LYXERR0("Prefix `" << prefix << "' is invalid for LaTeX.");
 122                         // restore the label
 123                         label = ref;
 124                         return defcmd;
 125                 }
 126         }
 127         return from_ascii("\\") + prefix + from_ascii("ref");
 128 }
 129
 130
 131 docstring InsetRef::getEscapedLabel(OutputParams const & rp) const
 132 {
 133         InsetCommandParams const & p = params();
 134         ParamInfo const & pi = p.info();
 135         ParamInfo::ParamData const & pd = pi["reference"];
 136         return p.prepareCommand(rp, getParam("reference"), pd.handling());
 137 }
 138
 139
 140 void InsetRef::latex(otexstream & os, OutputParams const & rp) const
 141 {
 142         string const cmd = getCmdName();
 143         docstring const data = getEscapedLabel(rp);
 144
 145         if (cmd == "eqref" && buffer().params().use_refstyle) {
 146                 os << '(' << from_ascii("\\ref{") << data << from_ascii("})");
 147         }
 148         else if (cmd == "formatted") {
 149                 docstring label;
 150                 docstring prefix;
 151                 docstring const fcmd = getFormattedCmd(data, label, prefix);
 152                 os << fcmd << '{' << label << '}';
 153         }
 154         else {
 155                 // We don't want to output p_["name"], since that is only used
 156                 // in docbook. So we construct new params, without it, and use that.
 157                 InsetCommandParams p(REF_CODE, cmd);
 158                 docstring const ref = getParam("reference");
 159                 p["reference"] = ref;
 160                 os << p.getCommand(rp);
 161         }
 162 }
 163
 164
 165 int InsetRef::plaintext(odocstream & os, OutputParams const &) const
 166 {
 167         docstring const str = getParam("reference");
 168         os << '[' << str << ']';
 169         return 2 + str.size();
 170 }
 171
 172
 173 int InsetRef::docbook(odocstream & os, OutputParams const & runparams) const
 174 {
 175         docstring const & name = getParam("name");
 176         if (name.empty()) {
 177                 if (runparams.flavor == OutputParams::XML) {
 178                         os << "<xref linkend=\""
 179                            << sgml::cleanID(buffer(), runparams, getParam("reference"))
 180                            << "\" />";
 181                 } else {
 182                         os << "<xref linkend=\""
 183                            << sgml::cleanID(buffer(), runparams, getParam("reference"))
 184                            << "\">";
 185                 }
 186         } else {
 187                 os << "<link linkend=\""
 188                    << sgml::cleanID(buffer(), runparams, getParam("reference"))
 189                    << "\">"
 190                    << getParam("name")
 191                    << "</link>";
 192         }
 193
 194         return 0;
 195 }
 196
 197
 198 docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const &) const
 199 {
 200         docstring const & ref = getParam("reference");
 201         InsetLabel const * il = buffer().insetLabel(ref);
 202         string const & cmd = params().getCmdName();
 203         docstring display_string;
 204
 205         if (il && !il->counterValue().empty()) {
 206                 // Try to construct a label from the InsetLabel we reference.
 207                 docstring const & value = il->counterValue();
 208                 if (cmd == "ref")
 209                         display_string = value;
 210                 else if (cmd == "vref")
 211                         // normally, would be "ref on page #", but we have no pages
 212                         display_string = value;
 213                 else if (cmd == "pageref" || cmd == "vpageref")
 214                         // normally would be "on page #", but we have no pages
 215                         display_string = _("elsewhere");
 216                 else if (cmd == "eqref")
 217                         display_string = bformat(from_ascii("equation (%1$s)"), value);
 218                 else if (cmd == "prettyref"
 219                          // we don't really have the ability to handle these
 220                          // properly in XHTML output
 221                          || cmd == "nameref")
 222                         display_string = il->prettyCounter();
 223         } else
 224                         display_string = ref;
 225
 226         // FIXME What we'd really like to do is to be able to output some
 227         // appropriate sort of text here. But to do that, we need to associate
 228         // some sort of counter with the label, and we don't have that yet.
 229         string const attr = "href=\"#" + html::cleanAttr(to_utf8(ref)) + "\"";
 230         xs << html::StartTag("a", attr);
 231         xs << display_string;
 232         xs << html::EndTag("a");
 233         return docstring();
 234 }
 235
 236
 237 void InsetRef::toString(odocstream & os) const
 238 {
 239         plaintext(os, OutputParams(0));
 240 }
 241
 242
 243 void InsetRef::forToc(docstring & os, size_t) const
 244 {
 245         // There's no need for details in the TOC, and a long label
 246         // will just get in the way.
 247         os += '#';
 248 }
 249
 250
 251 void InsetRef::updateBuffer(ParIterator const & it, UpdateType)
 252 {
 253         docstring const & ref = getParam("reference");
 254         // register this inset into the buffer reference cache.
 255         buffer().references(ref).push_back(make_pair(this, it));
 256
 257         docstring label;
 258         for (int i = 0; !types[i].latex_name.empty(); ++i) {
 259                 if (getCmdName() == types[i].latex_name) {
 260                         label = _(types[i].short_gui_name);
 261                         break;
 262                 }
 263         }
 264         label += ref;
 265
 266         if (!buffer().isLatex() && !getParam("name").empty()) {
 267                 label += "||";
 268                 label += getParam("name");
 269         }
 270
 271         screen_label_ = label;
 272         bool shortened = false;
 273         unsigned int const maxLabelChars = 24;
 274         if (screen_label_.size() > maxLabelChars) {
 275                 screen_label_.erase(maxLabelChars - 3);
 276                 screen_label_ += "...";
 277                 shortened = true;
 278         }
 279         if (shortened)
 280                 tooltip_ = label;
 281         else
 282                 tooltip_ = from_ascii("");
 283 }
 284
 285
 286 void InsetRef::addToToc(DocIterator const & cpit) const
 287 {
 288         docstring const & label = getParam("reference");
 289         if (buffer().insetLabel(label))
 290                 // This InsetRef has already been taken care of in InsetLabel::addToToc().
 291                 return;
 292
 293         // It seems that this reference does not point to any valid label.
 294         screen_label_ = _("BROKEN: ") + screen_label_;
 295         Toc & toc = buffer().tocBackend().toc("label");
 296         toc.push_back(TocItem(cpit, 0, screen_label_));
 297 }
 298
 299
 300 void InsetRef::validate(LaTeXFeatures & features) const
 301 {
 302         string const cmd = getCmdName();
 303         if (cmd == "vref" || cmd == "vpageref")
 304                 features.require("varioref");
 305         else if (getCmdName() == "formatted") {
 306                 docstring const data = getEscapedLabel(features.runparams());
 307                 docstring label;
 308                 docstring prefix;
 309                 if (buffer().params().use_refstyle) {
 310                         features.require("refstyle");
 311                         string const fcmd = to_utf8(getFormattedCmd(data, label, prefix));
 312                         if (!prefix.empty()) {
 313                                 string lcmd = "\\AtBeginDocument{\\providecommand" +
 314                                                 fcmd + "[1]{\\ref{" + to_utf8(prefix) + ":#1}}}";
 315                                 features.addPreambleSnippet(lcmd);
 316                         } else if (prefix == "cha")
 317                                 features.addPreambleSnippet("\\let\\charef=\\chapref");
 318                 } else {
 319                         features.require("prettyref");
 320                         // prettyref uses "cha" for chapters, so we provide a kind of
 321                         // translation.
 322                         if (prefix == "chap")
 323                                 features.addPreambleSnippet("\\let\\pr@chap=\\pr@cha");
 324                 }
 325         } else if (getCmdName() == "eqref" && !buffer().params().use_refstyle)
 326                 // refstyle defines its own version
 327                 features.require("amsmath");
 328         else if (cmd == "nameref")
 329                 features.require("nameref");
 330 }
 331
 332
 333 InsetRef::type_info InsetRef::types[] = {
 334         { "ref",       N_("Standard"),              N_("Ref: ")},
 335         { "eqref",     N_("Equation"),              N_("EqRef: ")},
 336         { "pageref",   N_("Page Number"),           N_("Page: ")},
 337         { "vpageref",  N_("Textual Page Number"),   N_("TextPage: ")},
 338         { "vref",      N_("Standard+Textual Page"), N_("Ref+Text: ")},
 339         { "formatted", N_("Formatted"),             N_("Format: ")},
 340         { "nameref",   N_("Reference to Name"),     N_("NameRef:")},
 341         { "", "", "" }
 342 };
 343
 344
 345 int InsetRef::getType(string const & name)
 346 {
 347         for (int i = 0; !types[i].latex_name.empty(); ++i)
 348                 if (name == types[i].latex_name)
 349                         return i;
 350         return 0;
 351 }
 352
 353
 354 string const & InsetRef::getName(int type)
 355 {
 356         return types[type].latex_name;
 357 }
 358
 359
 360 } // namespace lyx