#include "Language.h"
#include "LaTeXFeatures.h"
#include "LyX.h"
-#include "OutputParams.h"
#include "output_xhtml.h"
#include "Paragraph.h"
#include "ParIterator.h"
void InsetRef::doDispatch(Cursor & cur, FuncRequest & cmd)
{
+ // Ctrl + click: go to label
+ if (cmd.action() == LFUN_MOUSE_RELEASE && cmd.modifier() == ControlModifier) {
+ lyx::dispatch(FuncRequest(LFUN_BOOKMARK_SAVE, "0"));
+ lyx::dispatch(FuncRequest(LFUN_LABEL_GOTO, getParam("reference")));
+ return;
+ }
+
string const inset = cmd.getArg(0);
string const arg = cmd.getArg(1);
string pstring;
return;
}
}
+
// otherwise not for us
if (pstring.empty())
return InsetCommand::doDispatch(cur, cmd);
bool const isSet = (getParam(pstring) == "true");
setParam(pstring, from_ascii(isSet ? "false" : "true"));
+ cur.forceBufferUpdate();
}
}
-namespace {
-
-void capitalize(docstring & s) {
- char_type t = uppercase(s[0]);
- s[0] = t;
-}
-
-} // namespace
-
-
// the ref argument is the label name we are referencing.
// we expect ref to be in the form: pfx:suffix.
//
// label, thus: \prettyref{pfx:suffix}.
//
docstring InsetRef::getFormattedCmd(docstring const & ref,
- docstring & label, docstring & prefix, docstring const & caps) const
+ docstring & label, docstring & prefix, bool use_refstyle,
+ bool use_caps)
{
static docstring const defcmd = from_ascii("\\ref");
static docstring const prtcmd = from_ascii("\\prettyref");
if (prefix.empty()) {
// we have ":xxxx"
+ LYXERR0("Label `" << ref << "' contains nothign before `:'.");
label = ref;
return defcmd;
}
- if (!buffer().params().use_refstyle) {
+ if (!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++) {
+ size_t const len = prefix.size();
+ for (size_t i = 0; i < len; i++) {
char_type const c = prefix[i];
if (!isAlphaASCII(c)) {
LYXERR0("Prefix `" << prefix << "' is invalid for LaTeX.");
return defcmd;
}
}
- if (caps == "true") {
- capitalize(prefix);
+ if (use_caps) {
+ prefix = support::capitalize(prefix);
}
return from_ascii("\\") + prefix + from_ascii("ref");
}
if (rp.inulemcmd > 0)
os << "\\mbox{";
- if (cmd == "eqref" && buffer().params().use_refstyle) {
+ if (buffer().params().use_refstyle && cmd == "eqref") {
// 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
else if (cmd == "formatted") {
docstring label;
docstring prefix;
+ bool const use_caps = getParam("caps") == "true";
+ bool const use_plural = getParam("plural") == "true";
+ bool const use_refstyle = buffer().params().use_refstyle;
docstring const fcmd =
- getFormattedCmd(data, label, prefix, getParam("caps"));
+ getFormattedCmd(data, label, prefix, use_refstyle, use_caps);
os << fcmd;
- if (buffer().params().use_refstyle && getParam("plural") == "true")
+ if (use_refstyle && use_plural)
os << "[s]";
os << '{' << 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;
{
docstring const str = getParam("reference");
os << '[' << str << ']';
- return 2 + str.size();
+ return 2 + int(str.size());
}
-int InsetRef::docbook(odocstream & os, OutputParams const & runparams) const
+void InsetRef::docbook(XMLStream & xs, OutputParams const &) const
{
+ docstring const & ref = getParam("reference");
+ InsetLabel const * il = buffer().insetLabel(ref, true);
+ string const & cmd = params().getCmdName();
+ docstring linkend = xml::cleanID(ref);
+
+ // A name is provided, LyX will provide it. This is supposed to be a very rare case.
+ // Link with linkend, as is it within the document (not outside, in which case xlink:href is better suited).
docstring const & name = getParam("name");
- if (name.empty()) {
- if (runparams.flavor == OutputParams::XML) {
- os << "<xref linkend=\""
- << xml::cleanID(getParam("reference"))
- << "\" />";
- } else {
- os << "<xref linkend=\""
- << xml::cleanID(getParam("reference"))
- << "\">";
+ if (!name.empty()) {
+ docstring attr = from_utf8("linkend=\"") + linkend + from_utf8("\"");
+
+ xs << xml::StartTag("link", to_utf8(attr));
+ xs << name;
+ xs << xml::EndTag("link");
+ return;
+ }
+
+ // The DocBook processor will generate the name when required.
+ docstring display_before;
+ docstring display_after;
+ docstring role;
+
+ if (il && !il->counterValue().empty()) {
+ // Try to construct a label from the InsetLabel we reference.
+ if (cmd == "vref" || cmd == "pageref" || cmd == "vpageref" || cmd == "nameref" || cmd == "formatted") {
+ // "ref on page #", "on page #", etc. The DocBook processor deals with generating the right text,
+ // including in the right language.
+ role = from_ascii(cmd);
+
+ if (cmd == "formatted") {
+ // A formatted reference may have many parameters. Generate all of them as roles, the only
+ // way arbitrary parameters can be passed into DocBook.
+ if (buffer().params().use_refstyle && getParam("caps") == "true")
+ role += " refstyle-caps";
+ if (buffer().params().use_refstyle && getParam("plural") == "true")
+ role += " refstyle-plural";
+ }
+ } else if (cmd == "eqref") {
+ display_before = from_ascii("(");
+ display_after = from_ascii(")");
}
- } else {
- os << "<link linkend=\""
- << xml::cleanID(getParam("reference"))
- << "\">"
- << getParam("name")
- << "</link>";
+ // TODO: what about labelonly? I don't get how this is supposed to work...
}
- return 0;
+ // No name, ask DocBook to generate one.
+ docstring attr = from_utf8("linkend=\"") + xml::cleanID(ref) + from_utf8("\"");
+ if (!role.empty())
+ attr += " role=\"" + role + "\"";
+ xs << display_before;
+ xs << xml::CompTag("xref", to_utf8(attr));
+ xs << display_after;
}
void InsetRef::toString(odocstream & os) const
{
odocstringstream ods;
- plaintext(ods, OutputParams(0));
+ plaintext(ods, OutputParams(nullptr));
os << ods.str();
}
void InsetRef::forOutliner(docstring & os, size_t const, bool const) const
{
- // There's no need for details in the TOC, and a long label
- // will just get in the way.
- os += '#';
+ // It's hard to know what to do here. Should we show XREF in the TOC?
+ // Or should we just show that there is one? For now, we do the former.
+ odocstringstream ods;
+ plaintext(ods, OutputParams(nullptr));
+ os += ods.str();
}
for (int i = 0; !types[i].latex_name.empty(); ++i) {
if (cmd == types[i].latex_name) {
label = _(types[i].short_gui_name);
+ // indicate plural and caps
+ if (cmd == "formatted") {
+ bool const isPlural = getParam("plural") == "true";
+ bool const isCaps = getParam("caps") == "true";
+ if (isPlural)
+ label += from_ascii("+");
+ if (isCaps) {
+ // up arrow (shift key) symbol
+ label += docstring(1, char_type(0x21E7));
+ }
+ }
+ label += from_ascii(": ");
break;
}
}
active_ = output_active;
docstring const & label = getParam("reference");
if (buffer().insetLabel(label)) {
- broken_ = !buffer().activeLabel(label);
+ broken_ = !buffer().activeLabel(label) && active_;
setBroken(broken_);
if (broken_ && output_active) {
shared_ptr<Toc> toc2 = backend.toc("brokenrefs");
broken_ = true;
setBroken(broken_);
shared_ptr<Toc> toc = backend.toc("label");
- toc->push_back(TocItem(cpit, 0, screenLabel(), output_active));
+ if (TocBackend::findItem(*toc, 0, label) == toc->end())
+ toc->push_back(TocItem(cpit, 0, label, output_active, true));
+ toc->push_back(TocItem(cpit, 1, screenLabel(), output_active));
shared_ptr<Toc> toc2 = backend.toc("brokenrefs");
toc2->push_back(TocItem(cpit, 0, screenLabel(), output_active));
}
void InsetRef::validate(LaTeXFeatures & features) const
{
- string const cmd = getCmdName();
+ string const & cmd = getCmdName();
if (cmd == "vref" || cmd == "vpageref")
features.require("varioref");
else if (cmd == "formatted") {
docstring const data = getEscapedLabel(features.runparams());
docstring label;
docstring prefix;
+ bool const use_refstyle = buffer().params().use_refstyle;
+ bool const use_caps = getParam("caps") == "true";
docstring const fcmd =
- getFormattedCmd(data, label, prefix, getParam("caps"));
- if (buffer().params().use_refstyle) {
+ getFormattedCmd(data, label, prefix, use_refstyle, use_caps);
+ if (use_refstyle) {
features.require("refstyle");
if (prefix == "cha")
features.addPreambleSnippet(from_ascii("\\let\\charef=\\chapref"));
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: ")},
- { "nameref", N_("Reference to Name"), N_("NameRef: ")},
- { "formatted", N_("Formatted"), N_("Format: ")},
- { "labelonly", N_("Label Only"), N_("Label: ")},
+ { "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")},
+ { "nameref", N_("Reference to Name"), N_("NameRef")},
+ { "formatted", N_("Formatted"), N_("Format")},
+ { "labelonly", N_("Label Only"), N_("Label")},
{ "", "", "" }
};
projects / lyx.git / blobdiff