X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetRef.cpp;h=bae4992f66f156cb22cf9126ec652698adf30bca;hb=9c4929ca406091267dafa40f5e083a27db046bf6;hp=85100e809918be6e8ebfa41229d2356de81dd2f1;hpb=47db764ccce139eceee5bcaf47e58173f765682d;p=lyx.git diff --git a/src/insets/InsetRef.cpp b/src/insets/InsetRef.cpp index 85100e8099..bae4992f66 100644 --- a/src/insets/InsetRef.cpp +++ b/src/insets/InsetRef.cpp @@ -12,9 +12,9 @@ #include "InsetRef.h" #include "Buffer.h" +#include "BufferParams.h" #include "Cursor.h" #include "DispatchResult.h" -#include "FuncRequest.h" #include "InsetLabel.h" #include "LaTeXFeatures.h" #include "LyX.h" @@ -24,9 +24,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 +37,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,10 +53,9 @@ bool InsetRef::isCompatibleCommand(string const & s) { || s == "pageref" || s == "vref" || s == "vpageref" - || s == "prettyref" + || s == "formatted" || s == "eqref" - || s == "nameref" - || s == "Nameref"; + || s == "nameref"; } @@ -70,14 +71,104 @@ 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) + 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) + os << "}"; } @@ -134,10 +225,10 @@ docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const &) const display_string = _("elsewhere"); else if (cmd == "eqref") display_string = bformat(from_ascii("equation (%1$s)"), value); - else if (cmd == "prettyref" + else if (cmd == "formatted" // we don't really have the ability to handle these // properly in XHTML output - || cmd == "nameref" || cmd == "Nameref") + || cmd == "nameref") display_string = il->prettyCounter(); } else display_string = ref; @@ -153,12 +244,20 @@ docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const &) const } -void InsetRef::tocString(odocstream & os) const +void InsetRef::toString(odocstream & os) const { plaintext(os, OutputParams(0)); } +void InsetRef::forToc(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 += '#'; +} + + void InsetRef::updateBuffer(ParIterator const & it, UpdateType) { docstring const & ref = getParam("reference"); @@ -173,8 +272,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"); } @@ -194,7 +293,7 @@ void InsetRef::updateBuffer(ParIterator const & it, UpdateType) } -void InsetRef::addToToc(DocIterator const & cpit) +void InsetRef::addToToc(DocIterator const & cpit) const { docstring const & label = getParam("reference"); if (buffer().insetLabel(label)) @@ -213,11 +312,30 @@ void InsetRef::validate(LaTeXFeatures & features) const string const cmd = getCmdName(); if (cmd == "vref" || cmd == "vpageref") features.require("varioref"); - else if (cmd == "prettyref") - features.require("prettyref"); - else if (cmd == "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.empty()) { + string lcmd = "\\AtBeginDocument{\\providecommand" + + fcmd + "[1]{\\ref{" + to_utf8(prefix) + ":#1}}}"; + features.addPreambleSnippet(lcmd); + } else if (prefix == "cha") + features.addPreambleSnippet("\\let\\charef=\\chapref"); + } 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" || cmd == "Nameref") + else if (cmd == "nameref") features.require("nameref"); } @@ -228,9 +346,8 @@ InsetRef::type_info InsetRef::types[] = { { "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:")}, - { "Nameref", N_("Name+Textual Page"), N_("NamePgRef:")}, { "", "", "" } };