3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
15 #include "BufferParams.h"
17 #include "DispatchResult.h"
18 #include "InsetLabel.h"
19 #include "LaTeXFeatures.h"
21 #include "OutputParams.h"
22 #include "output_xhtml.h"
23 #include "ParIterator.h"
25 #include "TocBackend.h"
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"
33 using namespace lyx::support;
39 InsetRef::InsetRef(Buffer * buf, InsetCommandParams const & p)
40 : InsetCommand(buf, p)
44 InsetRef::InsetRef(InsetRef const & ir)
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.
62 ParamInfo const & InsetRef::findInfo(string const & /* cmdName */)
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);
74 // the ref argument is the label name we are referencing.
75 // we expect ref to be in the form: pfx:suffix.
77 // if it isn't, then we can't produce a formatted reference,
78 // so we return "\ref" and put ref into label.
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}.
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}.
88 docstring InsetRef::getFormattedCmd(docstring const & ref,
89 docstring & label, docstring & prefix) const
91 static docstring const defcmd = from_ascii("\\ref");
92 static docstring const prtcmd = from_ascii("\\prettyref");
94 label = split(ref, prefix, ':');
96 // we have to have xxx:xxxxx...
98 LYXERR0("Label `" << ref << "' contains no prefix.");
100 prefix = from_ascii("");
104 if (prefix.empty()) {
110 if (!buffer().params().use_refstyle) {
111 // \prettyref uses the whole label
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.");
127 return from_ascii("\\") + prefix + from_ascii("ref");
131 docstring InsetRef::getEscapedLabel(OutputParams const & rp) const
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());
140 void InsetRef::latex(otexstream & os, OutputParams const & rp) const
142 string const cmd = getCmdName();
143 docstring const data = getEscapedLabel(rp);
148 if (cmd == "eqref" && buffer().params().use_refstyle) {
149 // we advertise this as printing "(n)", so we'll do that, at least
150 // for refstyle, since refstlye's own \eqref prints, by default,
151 // "equation n". if one wants \eqref, one can get it by using a
152 // formatted label in this case.
153 os << '(' << from_ascii("\\ref{") << data << from_ascii("})");
155 else if (cmd == "formatted") {
158 docstring const fcmd = getFormattedCmd(data, label, prefix);
159 os << fcmd << '{' << label << '}';
162 // We don't want to output p_["name"], since that is only used
163 // in docbook. So we construct new params, without it, and use that.
164 InsetCommandParams p(REF_CODE, cmd);
165 docstring const ref = getParam("reference");
166 p["reference"] = ref;
167 os << p.getCommand(rp);
175 int InsetRef::plaintext(odocstream & os, OutputParams const &) const
177 docstring const str = getParam("reference");
178 os << '[' << str << ']';
179 return 2 + str.size();
183 int InsetRef::docbook(odocstream & os, OutputParams const & runparams) const
185 docstring const & name = getParam("name");
187 if (runparams.flavor == OutputParams::XML) {
188 os << "<xref linkend=\""
189 << sgml::cleanID(buffer(), runparams, getParam("reference"))
192 os << "<xref linkend=\""
193 << sgml::cleanID(buffer(), runparams, getParam("reference"))
197 os << "<link linkend=\""
198 << sgml::cleanID(buffer(), runparams, getParam("reference"))
208 docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const &) const
210 docstring const & ref = getParam("reference");
211 InsetLabel const * il = buffer().insetLabel(ref);
212 string const & cmd = params().getCmdName();
213 docstring display_string;
215 if (il && !il->counterValue().empty()) {
216 // Try to construct a label from the InsetLabel we reference.
217 docstring const & value = il->counterValue();
219 display_string = value;
220 else if (cmd == "vref")
221 // normally, would be "ref on page #", but we have no pages
222 display_string = value;
223 else if (cmd == "pageref" || cmd == "vpageref")
224 // normally would be "on page #", but we have no pages
225 display_string = _("elsewhere");
226 else if (cmd == "eqref")
227 display_string = bformat(from_ascii("equation (%1$s)"), value);
228 else if (cmd == "formatted"
229 // we don't really have the ability to handle these
230 // properly in XHTML output
232 display_string = il->prettyCounter();
234 display_string = ref;
236 // FIXME What we'd really like to do is to be able to output some
237 // appropriate sort of text here. But to do that, we need to associate
238 // some sort of counter with the label, and we don't have that yet.
239 string const attr = "href=\"#" + html::cleanAttr(to_utf8(ref)) + "\"";
240 xs << html::StartTag("a", attr);
241 xs << display_string;
242 xs << html::EndTag("a");
247 void InsetRef::toString(odocstream & os) const
249 plaintext(os, OutputParams(0));
253 void InsetRef::forToc(docstring & os, size_t) const
255 // There's no need for details in the TOC, and a long label
256 // will just get in the way.
261 void InsetRef::updateBuffer(ParIterator const & it, UpdateType)
263 docstring const & ref = getParam("reference");
264 // register this inset into the buffer reference cache.
265 buffer().references(ref).push_back(make_pair(this, it));
268 for (int i = 0; !types[i].latex_name.empty(); ++i) {
269 if (getCmdName() == types[i].latex_name) {
270 label = _(types[i].short_gui_name);
276 if (!buffer().params().isLatex() && !getParam("name").empty()) {
278 label += getParam("name");
281 screen_label_ = label;
282 bool shortened = false;
283 unsigned int const maxLabelChars = 24;
284 if (screen_label_.size() > maxLabelChars) {
285 screen_label_.erase(maxLabelChars - 3);
286 screen_label_ += "...";
292 tooltip_ = from_ascii("");
296 void InsetRef::addToToc(DocIterator const & cpit) const
298 docstring const & label = getParam("reference");
299 if (buffer().insetLabel(label))
300 // This InsetRef has already been taken care of in InsetLabel::addToToc().
303 // It seems that this reference does not point to any valid label.
304 screen_label_ = _("BROKEN: ") + screen_label_;
305 Toc & toc = buffer().tocBackend().toc("label");
306 toc.push_back(TocItem(cpit, 0, screen_label_));
310 void InsetRef::validate(LaTeXFeatures & features) const
312 string const cmd = getCmdName();
313 if (cmd == "vref" || cmd == "vpageref")
314 features.require("varioref");
315 else if (cmd == "formatted") {
316 docstring const data = getEscapedLabel(features.runparams());
319 string const fcmd = to_utf8(getFormattedCmd(data, label, prefix));
320 if (buffer().params().use_refstyle) {
321 features.require("refstyle");
322 if (!prefix.empty()) {
323 string lcmd = "\\AtBeginDocument{\\providecommand" +
324 fcmd + "[1]{\\ref{" + to_utf8(prefix) + ":#1}}}";
325 features.addPreambleSnippet(lcmd);
326 } else if (prefix == "cha")
327 features.addPreambleSnippet("\\let\\charef=\\chapref");
329 features.require("prettyref");
330 // prettyref uses "cha" for chapters, so we provide a kind of
332 if (prefix == "chap")
333 features.addPreambleSnippet("\\let\\pr@chap=\\pr@cha");
335 } else if (cmd == "eqref" && !buffer().params().use_refstyle)
336 // with refstyle, we simply output "(\ref{label})"
337 features.require("amsmath");
338 else if (cmd == "nameref")
339 features.require("nameref");
343 InsetRef::type_info InsetRef::types[] = {
344 { "ref", N_("Standard"), N_("Ref: ")},
345 { "eqref", N_("Equation"), N_("EqRef: ")},
346 { "pageref", N_("Page Number"), N_("Page: ")},
347 { "vpageref", N_("Textual Page Number"), N_("TextPage: ")},
348 { "vref", N_("Standard+Textual Page"), N_("Ref+Text: ")},
349 { "formatted", N_("Formatted"), N_("Format: ")},
350 { "nameref", N_("Reference to Name"), N_("NameRef:")},
355 int InsetRef::getType(string const & name)
357 for (int i = 0; !types[i].latex_name.empty(); ++i)
358 if (name == types[i].latex_name)
364 string const & InsetRef::getName(int type)
366 return types[type].latex_name;