]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetRef.cpp
Merge branch 'master' into biblatex2
[lyx.git] / src / insets / InsetRef.cpp
index 0c8e471d5c9d045e5986a108a5fc03c45337067f..31c0187cc1cadfeb01035c69f69a777d7ce7782f 100644 (file)
 #include "Cursor.h"
 #include "DispatchResult.h"
 #include "InsetLabel.h"
+#include "Language.h"
 #include "LaTeXFeatures.h"
 #include "LyX.h"
 #include "OutputParams.h"
 #include "output_xhtml.h"
 #include "ParIterator.h"
 #include "sgml.h"
+#include "texstream.h"
 #include "TocBackend.h"
 
 #include "support/debug.h"
@@ -55,7 +57,8 @@ bool InsetRef::isCompatibleCommand(string const & s) {
                || s == "vpageref"
                || s == "formatted"
                || s == "eqref"
-               || s == "nameref";
+               || s == "nameref"
+               || s == "labelonly";
 }
 
 
@@ -66,11 +69,24 @@ ParamInfo const & InsetRef::findInfo(string const & /* cmdName */)
                param_info_.add("name", ParamInfo::LATEX_OPTIONAL);
                param_info_.add("reference", ParamInfo::LATEX_REQUIRED,
                                ParamInfo::HANDLING_ESCAPE);
+               param_info_.add("plural", ParamInfo::LYX_INTERNAL);
+               param_info_.add("caps", ParamInfo::LYX_INTERNAL);
+               param_info_.add("noprefix", ParamInfo::LYX_INTERNAL);
        }
        return param_info_;
 }
 
 
+namespace {
+
+void capitalize(docstring & s) {
+       char_type t = uppercase(s[0]);
+       s[0] = t;
+}
+
+}
+
+
 // the ref argument is the label name we are referencing.
 // we expect ref to be in the form: pfx:suffix.
 //
@@ -86,7 +102,7 @@ ParamInfo const & InsetRef::findInfo(string const & /* cmdName */)
 // label, thus: \prettyref{pfx:suffix}.
 //
 docstring InsetRef::getFormattedCmd(docstring const & ref, 
-       docstring & label, docstring & prefix) const
+       docstring & label, docstring & prefix, docstring const & caps) const
 {
        static docstring const defcmd = from_ascii("\\ref");
        static docstring const prtcmd = from_ascii("\\prettyref");
@@ -95,7 +111,7 @@ docstring InsetRef::getFormattedCmd(docstring const & ref,
 
        // we have to have xxx:xxxxx...
        if (label.empty()) {
-               LYXERR0("Label `" << ref << "' contains no prefix.");
+               LYXERR0("Label `" << ref << "' contains no `:' separator.");
                label = ref;
                prefix = from_ascii("");
                return defcmd;
@@ -124,6 +140,9 @@ docstring InsetRef::getFormattedCmd(docstring const & ref,
                        return defcmd;
                }
        }
+       if (caps == "true") {
+               capitalize(prefix);
+       }
        return from_ascii("\\") + prefix + from_ascii("ref");
 }
 
@@ -139,10 +158,10 @@ docstring InsetRef::getEscapedLabel(OutputParams const & rp) const
 
 void InsetRef::latex(otexstream & os, OutputParams const & rp) const
 {
-       string const cmd = getCmdName();
-       docstring const data = getEscapedLabel(rp);
+       string const cmd = getCmdName();
+       docstring const data = getEscapedLabel(rp);
 
-       if (rp.inulemcmd)
+       if (rp.inulemcmd > 0)
                os << "\\mbox{";
 
        if (cmd == "eqref" && buffer().params().use_refstyle) {
@@ -155,8 +174,27 @@ void InsetRef::latex(otexstream & os, OutputParams const & rp) const
        else if (cmd == "formatted") {
                docstring label;
                docstring prefix;
-               docstring const fcmd = getFormattedCmd(data, label, prefix);
-               os << fcmd << '{' << label << '}';
+               docstring const fcmd = 
+                       getFormattedCmd(data, label, prefix, getParam("caps"));
+               os << fcmd;
+               if (buffer().params().use_refstyle && getParam("plural") == "true")
+                   os << "[s]";
+               os << '{' << label << '}';
+       }
+       else if (cmd == "labelonly") {
+               docstring const & ref = getParam("reference");
+               if (getParam("noprefix") != "true")
+                       os << ref;
+               else {
+                       docstring prefix;
+                       docstring suffix = split(ref, prefix, ':');
+                       if (suffix.empty()) {
+                   LYXERR0("Label `" << ref << "' contains no `:' separator.");
+                               os << ref;
+                       } else {
+                               os << suffix;
+                       }
+               }
        }
        else {
                // We don't want to output p_["name"], since that is only used 
@@ -167,7 +205,7 @@ void InsetRef::latex(otexstream & os, OutputParams const & rp) const
                os << p.getCommand(rp);
        }
 
-       if (rp.inulemcmd)
+       if (rp.inulemcmd > 0)
                os << "}";
 }
 
@@ -206,7 +244,7 @@ int InsetRef::docbook(odocstream & os, OutputParams const & runparams) const
 }
 
 
-docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const &) const
+docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const & op) const
 {
        docstring const & ref = getParam("reference");
        InsetLabel const * il = buffer().insetLabel(ref);
@@ -222,19 +260,24 @@ docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const &) const
                        // normally, would be "ref on page #", but we have no pages
                        display_string = value;
                else if (cmd == "pageref" || cmd == "vpageref")
-                       // normally would be "on page #", but we have no pages
-                       display_string = _("elsewhere");
+                       // 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 = '(' + value + ')';
-               else if (cmd == "formatted")
+               else if (cmd == "formatted") {
                        display_string = il->prettyCounter();
+                       if (buffer().params().use_refstyle && getParam("caps") == "true")
+                               capitalize(display_string);
+                       // it is hard to see what to do about plurals...
+               }
                else if (cmd == "nameref")
                        // FIXME We don't really have the ability to handle these
                        // properly in XHTML output yet (bug #8599).
                        // It might not be that hard to do. We have the InsetLabel,
                        // and we can presumably find its paragraph using the TOC.
-                       // We could then output the contents of the paragraph using
-                       // something?
+                       // But the label might be referencing a section, yet not be
+                       // in that section. So this is not trivial.
                        display_string = il->prettyCounter();
        } else 
                        display_string = ref;
@@ -242,8 +285,8 @@ docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const &) const
        // 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.
-       string const attr = "href=\"#" + html::cleanAttr(to_utf8(ref)) + "\"";
-       xs << html::StartTag("a", attr);
+       docstring const attr = "href=\"#" + html::cleanAttr(ref) + '"';
+       xs << html::StartTag("a", to_utf8(attr));
        xs << display_string;
        xs << html::EndTag("a");
        return docstring();
@@ -258,7 +301,7 @@ void InsetRef::toString(odocstream & os) const
 }
 
 
-void InsetRef::forToc(docstring & os, size_t) 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.
@@ -270,38 +313,50 @@ void InsetRef::updateBuffer(ParIterator const & it, UpdateType)
 {
        docstring const & ref = getParam("reference");
        // register this inset into the buffer reference cache.
-       buffer().references(ref).push_back(make_pair(this, it));
+       buffer().addReference(ref, this, it);
 
        docstring label;
+       string const & cmd = getCmdName();
        for (int i = 0; !types[i].latex_name.empty(); ++i) {
-               if (getCmdName() == types[i].latex_name) {
+               if (cmd == types[i].latex_name) {
                        label = _(types[i].short_gui_name);
                        break;
                }
        }
-       label += ref;
+
+       if (cmd != "labelonly")
+               label += ref;
+       else {
+               if (getParam("noprefix") != "true")
+                       label += ref;
+               else {
+                       docstring prefix;
+                       docstring suffix = split(ref, prefix, ':');
+                       if (suffix.empty()) {
+                               label += ref;
+                       } else {
+                               label += suffix;
+                       }
+               }
+       }
        
        if (!buffer().params().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)
+       if (label.size() > maxLabelChars) {
                tooltip_ = label;
-       else 
+               support::truncateWithEllipsis(label, maxLabelChars);
+       } else
                tooltip_ = from_ascii("");
+       screen_label_ = label;
 }
 
 
-void InsetRef::addToToc(DocIterator const & cpit, bool output_active) const
+void InsetRef::addToToc(DocIterator const & cpit, bool output_active,
+                                               UpdateType) const
 {
        docstring const & label = getParam("reference");
        if (buffer().insetLabel(label))
@@ -310,8 +365,8 @@ void InsetRef::addToToc(DocIterator const & cpit, bool output_active) const
 
        // It seems that this reference does not point to any valid label.
        screen_label_ = _("BROKEN: ") + screen_label_;
-       Toc & toc = buffer().tocBackend().toc("label");
-       toc.push_back(TocItem(cpit, 0, screen_label_, output_active));
+       shared_ptr<Toc> toc = buffer().tocBackend().toc("label");
+       toc->push_back(TocItem(cpit, 0, screen_label_, output_active));
 }
 
 
@@ -324,14 +379,15 @@ void InsetRef::validate(LaTeXFeatures & features) const
                docstring const data = getEscapedLabel(features.runparams());
                docstring label;
                docstring prefix;
-               string const fcmd = to_utf8(getFormattedCmd(data, label, prefix));
+               docstring const fcmd = 
+                       getFormattedCmd(data, label, prefix, getParam("caps"));
                if (buffer().params().use_refstyle) {
                        features.require("refstyle");
                        if (prefix == "cha")
-                               features.addPreambleSnippet("\\let\\charef=\\chapref");
+                               features.addPreambleSnippet(from_ascii("\\let\\charef=\\chapref"));
                        else if (!prefix.empty()) {
-                               string lcmd = "\\AtBeginDocument{\\providecommand" + 
-                                               fcmd + "[1]{\\ref{" + to_utf8(prefix) + ":#1}}}";
+                               docstring lcmd = "\\AtBeginDocument{\\providecommand" +
+                                               fcmd + "[1]{\\ref{" + prefix + ":#1}}}";
                                features.addPreambleSnippet(lcmd);
                        }
                } else {
@@ -339,7 +395,7 @@ void InsetRef::validate(LaTeXFeatures & features) const
                        // prettyref uses "cha" for chapters, so we provide a kind of
                        // translation.
                        if (prefix == "chap")
-                               features.addPreambleSnippet("\\let\\pr@chap=\\pr@cha");
+                               features.addPreambleSnippet(from_ascii("\\let\\pr@chap=\\pr@cha"));
                }
        } else if (cmd == "eqref" && !buffer().params().use_refstyle)
                // with refstyle, we simply output "(\ref{label})"
@@ -349,14 +405,15 @@ void InsetRef::validate(LaTeXFeatures & features) const
 }
 
 
-InsetRef::type_info InsetRef::types[] = {
+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:")},
+       { "nameref",   N_("Reference to Name"),     N_("NameRef: ")},
+       { "labelonly", N_("Label Only"),            N_("Label: ")},
        { "", "", "" }
 };
 
@@ -376,4 +433,9 @@ string const & InsetRef::getName(int type)
 }
 
 
+docstring InsetRef::getTOCString() const 
+{
+       return tooltip_.empty() ? screen_label_ : tooltip_;
+}
+
 } // namespace lyx