]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetRef.cpp
InsetTabular.cpp: fix #6585 also for wrapped floats - thanks Vincent
[lyx.git] / src / insets / InsetRef.cpp
index 0b9227eff90a8695dbe144513cbe22fd52f35de2..47747d36380c8a50df7bfea7cb480d9fcb6ae559 100644 (file)
@@ -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,6 +24,7 @@
 #include "sgml.h"
 #include "TocBackend.h"
 
+#include "support/debug.h"
 #include "support/docstream.h"
 #include "support/gettext.h"
 #include "support/lstrings.h"
@@ -35,12 +36,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 +52,9 @@ bool InsetRef::isCompatibleCommand(string const & s) {
                || s == "pageref"
                || s == "vref" 
                || s == "vpageref"
-               || s == "prettyref"
-               || s == "eqref";
+               || s == "formatted"
+               || s == "eqref"
+               || s == "nameref";
 }
 
 
@@ -68,19 +70,63 @@ ParamInfo const & InsetRef::findInfo(string const & /* cmdName */)
 }
 
 
-docstring InsetRef::screenLabel() const
+// for refstyle, given pfx:suffix, we want to return "\\pfxcmd"
+// and put "suffix" into label
+docstring InsetRef::getFormattedCmd(
+               docstring const & ref, docstring & label) const
 {
-       return screen_label_;
+       static docstring const defcmd = from_ascii("\\ref");
+       if (!buffer().params().use_refstyle) 
+               return from_ascii("\\prettyref");
+
+       docstring prefix;
+       label = split(ref, prefix, ':');
+       if (prefix.empty()) {
+               LYXERR0("Label `" << label << "' contains no prefix.");
+               return defcmd;
+       }
+       
+       // make sure the prefix is legal for a latex command
+       int const len = prefix.size();
+       for (int i = 0; i < len; i++) {
+               if (!isalpha(prefix[i])) {
+                       LYXERR0("Prefix `" << prefix << "' contains non-letters.");
+                       // 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());              
 }
 
 
-int InsetRef::latex(odocstream & os, OutputParams const & runparams) const
+int InsetRef::latex(odocstream & os, OutputParams const & rp) 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);
+       string const cmd = getCmdName();
+       if (cmd != "formatted") {
+               // 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);
+               return 0;
+       } 
+       
+       // so we're doing a formatted reference.
+       docstring const data = getEscapedLabel(rp);
+       docstring label;
+       docstring const fcmd = getFormattedCmd(data, label);
+       os << fcmd << '{' << label << '}';
        return 0;
 }
 
@@ -138,9 +184,11 @@ 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 { // "prettyref"
+               else if (cmd == "prettyref" 
+                        // we don't really have the ability to handle these 
+                        // properly in XHTML output
+                        || cmd == "nameref")
                        display_string = il->prettyCounter();
-               }
        } else 
                        display_string = ref;
 
@@ -161,24 +209,38 @@ void InsetRef::tocString(odocstream & os) const
 }
 
 
-void InsetRef::updateLabels(ParIterator const & it, UpdateType)
+void InsetRef::updateBuffer(ParIterator const & it, UpdateType)
 {
-       docstring const & label = getParam("reference");
+       docstring const & ref = getParam("reference");
        // register this inset into the buffer reference cache.
-       buffer().references(label).push_back(make_pair(this, it));
+       buffer().references(ref).push_back(make_pair(this, it));
 
+       docstring label;
        for (int i = 0; !types[i].latex_name.empty(); ++i) {
                if (getCmdName() == types[i].latex_name) {
-                       screen_label_ = _(types[i].short_gui_name);
+                       label = _(types[i].short_gui_name);
                        break;
                }
        }
-       screen_label_ += label;
-
-       if (!isLatex && !getParam("name").empty()) {
-               screen_label_ += "||";
-               screen_label_ += getParam("name");
+       label += ref;
+       
+       if (!buffer().isLatex() && !getParam("name").empty()) {
+               label += "||";
+               label += getParam("name");
+       }
+       
+       screen_label_ = label;
+       bool shortened = false;
+       unsigned int const maxLabelChars = 24;
+       if (screen_label_.size() > maxLabelChars) {
+               screen_label_.erase(maxLabelChars - 3);
+               screen_label_ += "...";
+               shortened = true;
        }
+       if (shortened)
+               tooltip_ = label;
+       else 
+               tooltip_ = from_ascii("");
 }
 
 
@@ -198,12 +260,26 @@ void InsetRef::addToToc(DocIterator const & cpit)
 
 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 (getCmdName() == "formatted") {
+               if (buffer().params().use_refstyle) {
+                       features.require("refstyle");
+                       docstring const data = getEscapedLabel(features.runparams());
+                       docstring label;
+                       string const fcmd = to_utf8(getFormattedCmd(data, label));
+                       if (fcmd != "\\ref") {
+                               string lcmd = "\\providecommand" + fcmd + "[1]{\\ref{#1}}";
+                               features.addPreambleSnippet(lcmd);
+                       }
+               } else
+                       features.require("prettyref");
+       } else if (getCmdName() == "eqref" && !buffer().params().use_refstyle)
+               // refstyle defines its own version
                features.require("amsmath");
+       else if (cmd == "nameref")
+               features.require("nameref");
 }
 
 
@@ -213,7 +289,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_("FormatRef: ")},
+       { "formatted", N_("Formatted"),             N_("Format: ")},
+       { "nameref",   N_("Reference to Name"),     N_("NameRef:")},
        { "", "", "" }
 };