#include "Language.h"
#include "LaTeXFeatures.h"
#include "LyX.h"
-#include "OutputParams.h"
#include "output_xhtml.h"
+#include "Paragraph.h"
#include "ParIterator.h"
-#include "sgml.h"
+#include "PDFOptions.h"
+#include "xml.h"
#include "texstream.h"
#include "TocBackend.h"
InsetRef::InsetRef(Buffer * buf, InsetCommandParams const & p)
- : InsetCommand(buf, p), broken_(false)
+ : InsetCommand(buf, p), broken_(false), active_(true)
{}
InsetRef::InsetRef(InsetRef const & ir)
- : InsetCommand(ir), broken_(false)
+ : InsetCommand(ir), broken_(false), active_(true)
{}
param_info_.add("plural", ParamInfo::LYX_INTERNAL);
param_info_.add("caps", ParamInfo::LYX_INTERNAL);
param_info_.add("noprefix", ParamInfo::LYX_INTERNAL);
+ param_info_.add("nolink", ParamInfo::LYX_INTERNAL);
}
return param_info_;
}
+docstring InsetRef::layoutName() const
+{
+ return from_ascii("Ref");
+}
+
+
+void InsetRef::changeTarget(docstring const & new_label)
+{
+ // With change tracking, we insert a new ref
+ // and delete the old one
+ if (buffer().masterParams().track_changes) {
+ InsetCommandParams icp(REF_CODE, "ref");
+ icp["reference"] = new_label;
+ string const data = InsetCommand::params2string(icp);
+ lyx::dispatch(FuncRequest(LFUN_INSET_INSERT, data));
+ lyx::dispatch(FuncRequest(LFUN_CHAR_DELETE_FORWARD));
+ } else
+ setParam("reference", new_label);
+}
+
+
+
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;
pstring = "caps";
else if (arg == "toggle-noprefix")
pstring = "noprefix";
+ else if (arg == "toggle-nolink")
+ pstring = "nolink";
+ else if (arg == "changetarget") {
+ string const oldtarget = cmd.getArg(2);
+ string const newtarget = cmd.getArg(3);
+ if (!oldtarget.empty() && !newtarget.empty()
+ && getParam("reference") == from_utf8(oldtarget))
+ changeTarget(from_utf8(newtarget));
+ cur.forceBufferUpdate();
+ 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();
}
string const arg = cmd.getArg(1);
string pstring;
+ if (arg == "changetarget")
+ return true;
if (arg == "toggle-plural")
pstring = "plural";
else if (arg == "toggle-caps")
status.setOnOff(isSet);
return true;
}
+ if (arg == "toggle-nolink") {
+ status.setEnabled(params().getCmdName() != "formatted" && params().getCmdName() != "labelonly");
+ bool const isSet = (getParam("nolink") == "true");
+ status.setOnOff(isSet);
+ return true;
+ }
// otherwise not for us
return InsetCommand::getStatus(cur, cmd, status);
}
-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");
}
{
string const & cmd = getCmdName();
docstring const & data = getEscapedLabel(rp);
+ bool const hyper_on = buffer().masterParams().pdfoptions().use_hyperref;
if (rp.inulemcmd > 0)
os << "\\mbox{";
- if (cmd == "eqref" && buffer().params().use_refstyle) {
+ if (buffer().masterParams().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
// formatted label in this case.
- os << '(' << from_ascii("\\ref{") << data << from_ascii("})");
+ bool const use_nolink = hyper_on && getParam("nolink") == "true";
+ os << '(' << from_ascii("\\ref") +
+ // no hyperlink version?
+ (use_nolink ? from_utf8("*") : from_utf8("")) +
+ from_ascii("{") << data << from_ascii("})");
}
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().masterParams().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);
+ bool const use_nolink = hyper_on && getParam("nolink") == "true";
docstring const ref = getParam("reference");
p["reference"] = ref;
- os << p.getCommand(rp);
+ os << p.getCommand(rp, use_nolink);
}
if (rp.inulemcmd > 0)
{
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=\""
- << sgml::cleanID(buffer(), runparams, getParam("reference"))
- << "\" />";
- } else {
- os << "<xref linkend=\""
- << sgml::cleanID(buffer(), runparams, 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=\""
- << sgml::cleanID(buffer(), runparams, 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;
}
-docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const & op) const
+docstring InsetRef::displayString(docstring const & ref, string const & cmd,
+ string const & language) const
+
{
- docstring const & ref = getParam("reference");
InsetLabel const * il = buffer().insetLabel(ref, true);
- string const & cmd = params().getCmdName();
docstring display_string;
if (il && !il->counterValue().empty()) {
else if (cmd == "vref")
// normally, would be "ref on page #", but we have no pages
display_string = value;
- else if (cmd == "pageref" || cmd == "vpageref")
+ else if (cmd == "pageref" || cmd == "vpageref") {
// 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 =
+ translateIfPossible(from_ascii("elsewhere"), language);
+ } else if (cmd == "eqref")
display_string = '(' + value + ')';
else if (cmd == "formatted") {
- display_string = il->prettyCounter();
+ display_string = il->formattedCounter();
if (buffer().params().use_refstyle && getParam("caps") == "true")
capitalize(display_string);
// it is hard to see what to do about plurals...
// in that section. So this is not trivial.
display_string = il->prettyCounter();
} else
- display_string = ref;
+ display_string = ref;
+ return display_string;
+}
+
+docstring InsetRef::xhtml(XMLStream & xs, OutputParams const & op) const
+ {
+ docstring const & ref = getParam("reference");
+ string const & cmd = params().getCmdName();
// FIXME What we'd really like to do is to be able to output some
// appropriate sort of text here. But to do that, we need to associate
// some sort of counter with the label, and we don't have that yet.
- docstring const attr = "href=\"#" + html::cleanAttr(ref) + '"';
- xs << html::StartTag("a", to_utf8(attr));
- xs << display_string;
- xs << html::EndTag("a");
+ docstring const attr = "href=\"#" + xml::cleanAttr(ref) + '"';
+ xs << xml::StartTag("a", to_utf8(attr));
+ xs << displayString(ref, cmd, getLocalOrDefaultLang(op)->lang());
+ xs << xml::EndTag("a");
return docstring();
}
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();
}
-void InsetRef::updateBuffer(ParIterator const & it, UpdateType)
+void InsetRef::updateBuffer(ParIterator const & it, UpdateType, bool const /*deleted*/)
{
docstring const & ref = getParam("reference");
+
+ // Check if this one is active (i.e., neither deleted with change-tracking
+ // nor in an inset that does not produce output, such as notes or inactive branches)
+ Paragraph const & para = it.paragraph();
+ active_ = !para.isDeleted(it.pos()) && para.inInset().producesOutput();
+ // If not, check whether we are in a deleted/non-outputting inset
+ if (active_) {
+ for (size_type sl = 0 ; sl < it.depth() ; ++sl) {
+ Paragraph const & outer_par = it[sl].paragraph();
+ if (outer_par.isDeleted(it[sl].pos())
+ || !outer_par.inInset().producesOutput()) {
+ active_ = false;
+ break;
+ }
+ }
+ }
+
// register this inset into the buffer reference cache.
buffer().addReference(ref, this, it);
for (int i = 0; !types[i].latex_name.empty(); ++i) {
if (cmd == types[i].latex_name) {
label = _(types[i].short_gui_name);
+ // indicate no hyperlink (starred)
+ if (cmd != "formatted" && cmd != "labelonly") {
+ bool const isNoLink = getParam("nolink") == "true";
+ if (isNoLink)
+ label += from_ascii("*");
+ }
+ // indicate plural and caps
+ if (cmd == "formatted") {
+ bool const isPlural = getParam("plural") == "true";
+ bool const isCaps = getParam("caps") == "true";
+ if (isCaps) {
+ // up arrow (shift key) symbol
+ label += docstring(1, char_type(0x21E7));
+ }
+ if (isPlural)
+ label += from_ascii("+");
+ }
+ label += from_ascii(": ");
break;
}
}
label += getParam("name");
}
+ bool const use_formatted_ref = buffer().params().use_formatted_ref;
unsigned int const maxLabelChars = 24;
- if (label.size() > maxLabelChars) {
+ // Show label in tooltip when formatted references are shown in the work
+ // area or it is too long
+ if (use_formatted_ref || label.size() > maxLabelChars) {
tooltip_ = label;
support::truncateWithEllipsis(label, maxLabelChars);
} else
tooltip_ = from_ascii("");
screen_label_ = label;
+ // If use_formatted_ref is active, this will be overwritten in addToToc.
+ // (We can't do it now because it might be a forward-reference
+ // and so the reference might not be in the label cache yet.
broken_ = false;
+ setBroken(broken_);
}
void InsetRef::addToToc(DocIterator const & cpit, bool output_active,
- UpdateType, TocBackend & backend) const
+ UpdateType, TocBackend & backend) const
{
+ active_ = output_active;
docstring const & label = getParam("reference");
- if (buffer().activeLabel(label))
- // This InsetRef has already been taken care of in InsetLabel::addToToc().
- return;
+ if (buffer().insetLabel(label)) {
+ broken_ = !buffer().activeLabel(label) && active_;
+ setBroken(broken_);
+ if (broken_ && output_active) {
+ shared_ptr<Toc> toc2 = backend.toc("brokenrefs");
+ toc2->push_back(TocItem(cpit, 0, screenLabel(), output_active));
+ }
+ // Code for display of formatted references
+ bool const use_formatted_ref = buffer().params().use_formatted_ref;
+ if (use_formatted_ref) {
+ string const & cmd = getCmdName();
+ docstring const & ref = getParam("reference");
+ if (cmd != "pageref" && cmd != "vpageref" && cmd != "vref" &&
+ cmd != "labelonly")
+ screen_label_ = displayString(ref, cmd);
+ }
+ return;
+ }
// It seems that this reference does not point to any valid label.
-
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().masterParams().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"));
features.require("nameref");
}
-
-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: ")},
- { "formatted", N_("Formatted"), N_("Format: ")},
- { "nameref", N_("Reference to Name"), N_("NameRef: ")},
- { "labelonly", N_("Label Only"), N_("Label: ")},
- { "", "", "" }
-};
-
-
-int InsetRef::getType(string const & name)
+bool InsetRef::forceLTR(OutputParams const & rp) const
{
- for (int i = 0; !types[i].latex_name.empty(); ++i)
- if (name == types[i].latex_name)
- return i;
- return 0;
+ // We force LTR for references. However,
+ // * Namerefs are output in the scripts direction
+ // at least with fontspec/bidi and luabidi, though (see #11518).
+ // * Parentheses are automatically swapped with XeTeX/bidi
+ // [not with LuaTeX/luabidi] (see #11626).
+ // FIXME: Re-Audit all other RTL cases.
+ if (buffer().masterParams().useBidiPackage(rp))
+ return false;
+ return (getCmdName() != "nameref" || !buffer().masterParams().useNonTeXFonts);
}
-string const & InsetRef::getName(int type)
-{
- return types[type].latex_name;
-}
+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")},
+ { "", "", "" }
+};
docstring InsetRef::getTOCString() const
{
+ docstring const & label = getParam("reference");
+ if (buffer().insetLabel(label))
+ broken_ = !buffer().activeLabel(label) && active_;
+ else
+ broken_ = active_;
return tooltip_.empty() ? screenLabel() : tooltip_;
}
projects / lyx.git / blobdiff