]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetRef.cpp
DocBook: support bookauthor in bibliographies.
[lyx.git] / src / insets / InsetRef.cpp
index ed43d6a9505c5a4f37aa108cfa46070794890bc4..c8bc837a5f4d50b0ec74dd843fe87d12426aed16 100644 (file)
@@ -23,6 +23,7 @@
 #include "output_xhtml.h"
 #include "Paragraph.h"
 #include "ParIterator.h"
+#include "PDFOptions.h"
 #include "xml.h"
 #include "texstream.h"
 #include "TocBackend.h"
@@ -74,6 +75,7 @@ ParamInfo const & InsetRef::findInfo(string const & /* cmdName */)
                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_;
 }
@@ -120,6 +122,8 @@ void InsetRef::doDispatch(Cursor & cur, FuncRequest & cmd)
                        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);
@@ -170,6 +174,12 @@ bool InsetRef::getStatus(Cursor & cur, FuncRequest const & cmd,
                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);
 }
@@ -250,23 +260,28 @@ void InsetRef::latex(otexstream & os, OutputParams const & rp) const
 {
        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 (buffer().params().use_refstyle && cmd == "eqref") {
+       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().params().use_refstyle;
+               bool const use_refstyle = buffer().masterParams().use_refstyle;
                docstring const fcmd =
                        getFormattedCmd(data, label, prefix, use_refstyle, use_caps);
                os << fcmd;
@@ -291,9 +306,10 @@ void InsetRef::latex(otexstream & os, OutputParams const & rp) const
        }
        else {
                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)
@@ -366,11 +382,11 @@ void InsetRef::docbook(XMLStream & xs, OutputParams const &) const
 }
 
 
-docstring InsetRef::xhtml(XMLStream & 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()) {
@@ -381,14 +397,14 @@ docstring InsetRef::xhtml(XMLStream & xs, OutputParams const & op) const
                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...
@@ -402,14 +418,21 @@ docstring InsetRef::xhtml(XMLStream & xs, OutputParams const & op) const
                        // 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=\"#" + xml::cleanAttr(ref) + '"';
        xs << xml::StartTag("a", to_utf8(attr));
-       xs << display_string;
+       xs << displayString(ref, cmd, getLocalOrDefaultLang(op)->lang());
        xs << xml::EndTag("a");
        return docstring();
 }
@@ -425,9 +448,11 @@ void InsetRef::toString(odocstream & os) const
 
 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();
 }
 
 
@@ -459,16 +484,22 @@ void InsetRef::updateBuffer(ParIterator const & it, UpdateType, bool const /*del
        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 (isPlural)
-                                       label += from_ascii("+");
                                if (isCaps) {
                                        // up arrow (shift key) symbol
                                        label += docstring(1, char_type(0x21E7));
                                }
+                               if (isPlural)
+                                       label += from_ascii("+");
                        }
                        label += from_ascii(": ");
                        break;
@@ -496,14 +527,20 @@ void InsetRef::updateBuffer(ParIterator const & it, UpdateType, bool const /*del
                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_);
 }
@@ -527,15 +564,25 @@ void InsetRef::addToToc(DocIterator const & cpit, bool output_active,
                        shared_ptr<Toc> toc2 = backend.toc("brokenrefs");
                        toc2->push_back(TocItem(cpit, 0, screenLabel(), output_active));
                }
-               // This InsetRef has already been taken care of in InsetLabel::addToToc().
+
+               // 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));
 }
@@ -550,7 +597,7 @@ void InsetRef::validate(LaTeXFeatures & features) const
                docstring const data = getEscapedLabel(features.runparams());
                docstring label;
                docstring prefix;
-               bool const use_refstyle = buffer().params().use_refstyle;
+               bool const use_refstyle = buffer().masterParams().use_refstyle;
                bool const use_caps   = getParam("caps") == "true";
                docstring const fcmd =
                        getFormattedCmd(data, label, prefix, use_refstyle, use_caps);
@@ -585,7 +632,7 @@ bool InsetRef::forceLTR(OutputParams const & rp) const
        // * Parentheses are automatically swapped with XeTeX/bidi 
        //   [not with LuaTeX/luabidi] (see #11626).
        // FIXME: Re-Audit all other RTL cases.
-       if (rp.useBidiPackage())
+       if (buffer().masterParams().useBidiPackage(rp))
                return false;
        return (getCmdName() != "nameref" || !buffer().masterParams().useNonTeXFonts);
 }