X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetRef.cpp;h=bd6b2ecfec204952e81dd455d152a3bd4bad227a;hb=d044d6afa7192b2119784e1415e71dad644bc335;hp=1c00f745f092ca9854d3681f30342f3ae6345835;hpb=d65020b293ab208b1391f96a731e53e0c7274a02;p=lyx.git diff --git a/src/insets/InsetRef.cpp b/src/insets/InsetRef.cpp index 1c00f745f0..bd6b2ecfec 100644 --- a/src/insets/InsetRef.cpp +++ b/src/insets/InsetRef.cpp @@ -12,10 +12,11 @@ #include "InsetRef.h" #include "Buffer.h" +#include "BufferParams.h" #include "Cursor.h" #include "DispatchResult.h" -#include "FuncRequest.h" #include "InsetLabel.h" +#include "Language.h" #include "LaTeXFeatures.h" #include "LyX.h" #include "OutputParams.h" @@ -24,9 +25,11 @@ #include "sgml.h" #include "TocBackend.h" +#include "support/debug.h" #include "support/docstream.h" #include "support/gettext.h" #include "support/lstrings.h" +#include "support/textutils.h" using namespace lyx::support; using namespace std; @@ -35,12 +38,12 @@ namespace lyx { InsetRef::InsetRef(Buffer * buf, InsetCommandParams const & p) - : InsetCommand(buf, p, "ref"), isLatex(buf->isLatex()) + : InsetCommand(buf, p) {} InsetRef::InsetRef(InsetRef const & ir) - : InsetCommand(ir), isLatex(ir.isLatex) + : InsetCommand(ir) {} @@ -51,8 +54,9 @@ bool InsetRef::isCompatibleCommand(string const & s) { || s == "pageref" || s == "vref" || s == "vpageref" - || s == "prettyref" - || s == "eqref"; + || s == "formatted" + || s == "eqref" + || s == "nameref"; } @@ -68,18 +72,109 @@ ParamInfo const & InsetRef::findInfo(string const & /* cmdName */) } -int InsetRef::latex(odocstream & os, OutputParams const & runparams) const +// the ref argument is the label name we are referencing. +// we expect ref to be in the form: pfx:suffix. +// +// if it isn't, then we can't produce a formatted reference, +// so we return "\ref" and put ref into label. +// +// for refstyle, we return "\pfxcmd", and put suffix into +// label and pfx into prefix. this is because refstyle expects +// the command: \pfxcmd{suffix}. +// +// for prettyref, we return "\prettyref" and put ref into label +// and pfx into prefix. this is because prettyref uses the whole +// label, thus: \prettyref{pfx:suffix}. +// +docstring InsetRef::getFormattedCmd(docstring const & ref, + docstring & label, docstring & prefix) const { - // We don't want to output p_["name"], since that is only used - // in docbook. So we construct new params, without it, and use that. - InsetCommandParams p(REF_CODE, getCmdName()); - p["reference"] = getParam("reference"); - os << p.getCommand(runparams); - return 0; + static docstring const defcmd = from_ascii("\\ref"); + static docstring const prtcmd = from_ascii("\\prettyref"); + + label = split(ref, prefix, ':'); + + // we have to have xxx:xxxxx... + if (label.empty()) { + LYXERR0("Label `" << ref << "' contains no prefix."); + label = ref; + prefix = from_ascii(""); + return defcmd; + } + + if (prefix.empty()) { + // we have ":xxxx" + label = ref; + return defcmd; + } + + if (!buffer().params().use_refstyle) { + // \prettyref uses the whole label + label = ref; + return prtcmd; + } + + // make sure the prefix is legal for a latex command + int const len = prefix.size(); + for (int i = 0; i < len; i++) { + char_type const c = prefix[i]; + if (!isAlphaASCII(c)) { + LYXERR0("Prefix `" << prefix << "' is invalid for LaTeX."); + // restore the label + label = ref; + return defcmd; + } + } + return from_ascii("\\") + prefix + from_ascii("ref"); +} + + +docstring InsetRef::getEscapedLabel(OutputParams const & rp) const +{ + InsetCommandParams const & p = params(); + ParamInfo const & pi = p.info(); + ParamInfo::ParamData const & pd = pi["reference"]; + return p.prepareCommand(rp, getParam("reference"), pd.handling()); +} + + +void InsetRef::latex(otexstream & os, OutputParams const & rp) const +{ + string const & cmd = getCmdName(); + docstring const & data = getEscapedLabel(rp); + + if (rp.inulemcmd > 0) + os << "\\mbox{"; + + if (cmd == "eqref" && buffer().params().use_refstyle) { + // we advertise this as printing "(n)", so we'll do that, at least + // for refstyle, since refstlye's own \eqref prints, by default, + // "equation n". if one wants \eqref, one can get it by using a + // formatted label in this case. + os << '(' << from_ascii("\\ref{") << data << from_ascii("})"); + } + else if (cmd == "formatted") { + docstring label; + docstring prefix; + docstring const fcmd = getFormattedCmd(data, label, prefix); + os << fcmd << '{' << label << '}'; + } + else { + // We don't want to output p_["name"], since that is only used + // in docbook. So we construct new params, without it, and use that. + InsetCommandParams p(REF_CODE, cmd); + docstring const ref = getParam("reference"); + p["reference"] = ref; + os << p.getCommand(rp); + } + + if (rp.inulemcmd > 0) + os << "}"; } -int InsetRef::plaintext(odocstream & os, OutputParams const &) const +int InsetRef::plaintext(odocstringstream & os, + OutputParams const &, size_t) const { docstring const str = getParam("reference"); os << '[' << str << ']'; @@ -112,7 +207,7 @@ int InsetRef::docbook(odocstream & os, OutputParams const & runparams) const } -docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const &) const +docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const & op) const { docstring const & ref = getParam("reference"); InsetLabel const * il = buffer().insetLabel(ref); @@ -128,13 +223,21 @@ docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const &) const // normally, would be "ref on page #", but we have no pages display_string = value; else if (cmd == "pageref" || cmd == "vpageref") - // normally would be "on page #", but we have no pages - display_string = _("elsewhere"); + // normally would be "on page #", but we have no pages. + display_string = translateIfPossible(from_ascii("elsewhere"), + op.local_font->language()->lang()); else if (cmd == "eqref") - display_string = bformat(from_ascii("equation (%1$s)"), value); - else { // "prettyref" + display_string = '(' + value + ')'; + else if (cmd == "formatted") + display_string = il->prettyCounter(); + else if (cmd == "nameref") + // FIXME We don't really have the ability to handle these + // properly in XHTML output yet (bug #8599). + // It might not be that hard to do. We have the InsetLabel, + // and we can presumably find its paragraph using the TOC. + // But the label might be referencing a section, yet not be + // in that section. So this is not trivial. display_string = il->prettyCounter(); - } } else display_string = ref; @@ -149,9 +252,19 @@ docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const &) const } -void InsetRef::tocString(odocstream & os) const +void InsetRef::toString(odocstream & os) const { - plaintext(os, OutputParams(0)); + odocstringstream ods; + plaintext(ods, OutputParams(0)); + os << ods.str(); +} + + +void InsetRef::forOutliner(docstring & os, size_t) const +{ + // There's no need for details in the TOC, and a long label + // will just get in the way. + os += '#'; } @@ -159,7 +272,7 @@ void InsetRef::updateBuffer(ParIterator const & it, UpdateType) { docstring const & ref = getParam("reference"); // register this inset into the buffer reference cache. - buffer().references(ref).push_back(make_pair(this, it)); + buffer().addReference(ref, this, it); docstring label; for (int i = 0; !types[i].latex_name.empty(); ++i) { @@ -169,8 +282,8 @@ void InsetRef::updateBuffer(ParIterator const & it, UpdateType) } } label += ref; - - if (!isLatex && !getParam("name").empty()) { + + if (!buffer().params().isLatex() && !getParam("name").empty()) { label += "||"; label += getParam("name"); } @@ -190,7 +303,7 @@ void InsetRef::updateBuffer(ParIterator const & it, UpdateType) } -void InsetRef::addToToc(DocIterator const & cpit) +void InsetRef::addToToc(DocIterator const & cpit, bool output_active) const { docstring const & label = getParam("reference"); if (buffer().insetLabel(label)) @@ -200,28 +313,52 @@ void InsetRef::addToToc(DocIterator const & cpit) // It seems that this reference does not point to any valid label. screen_label_ = _("BROKEN: ") + screen_label_; Toc & toc = buffer().tocBackend().toc("label"); - toc.push_back(TocItem(cpit, 0, screen_label_)); + toc.push_back(TocItem(cpit, 0, screen_label_, output_active)); } void InsetRef::validate(LaTeXFeatures & features) const { - if (getCmdName() == "vref" || getCmdName() == "vpageref") + string const cmd = getCmdName(); + if (cmd == "vref" || cmd == "vpageref") features.require("varioref"); - else if (getCmdName() == "prettyref") - features.require("prettyref"); - else if (getCmdName() == "eqref") + else if (cmd == "formatted") { + docstring const data = getEscapedLabel(features.runparams()); + docstring label; + docstring prefix; + string const fcmd = to_utf8(getFormattedCmd(data, label, prefix)); + if (buffer().params().use_refstyle) { + features.require("refstyle"); + if (prefix == "cha") + features.addPreambleSnippet("\\let\\charef=\\chapref"); + else if (!prefix.empty()) { + string lcmd = "\\AtBeginDocument{\\providecommand" + + fcmd + "[1]{\\ref{" + to_utf8(prefix) + ":#1}}}"; + features.addPreambleSnippet(lcmd); + } + } else { + features.require("prettyref"); + // prettyref uses "cha" for chapters, so we provide a kind of + // translation. + if (prefix == "chap") + features.addPreambleSnippet("\\let\\pr@chap=\\pr@cha"); + } + } else if (cmd == "eqref" && !buffer().params().use_refstyle) + // with refstyle, we simply output "(\ref{label})" features.require("amsmath"); + else if (cmd == "nameref") + features.require("nameref"); } -InsetRef::type_info InsetRef::types[] = { +InsetRef::type_info const InsetRef::types[] = { { "ref", N_("Standard"), N_("Ref: ")}, { "eqref", N_("Equation"), N_("EqRef: ")}, { "pageref", N_("Page Number"), N_("Page: ")}, { "vpageref", N_("Textual Page Number"), N_("TextPage: ")}, { "vref", N_("Standard+Textual Page"), N_("Ref+Text: ")}, - { "prettyref", N_("PrettyRef"), N_("FrmtRef: ")}, + { "formatted", N_("Formatted"), N_("Format: ")}, + { "nameref", N_("Reference to Name"), N_("NameRef:")}, { "", "", "" } }; @@ -241,4 +378,9 @@ string const & InsetRef::getName(int type) } +docstring InsetRef::getTOCString() const +{ + return tooltip_.empty() ? screen_label_ : tooltip_; +} + } // namespace lyx