mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-06 11:23:45 +00:00
380 lines
10 KiB
C++
380 lines
10 KiB
C++
/**
|
|
* \file InsetRef.cpp
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author José Matos
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
#include <config.h>
|
|
|
|
#include "InsetRef.h"
|
|
|
|
#include "Buffer.h"
|
|
#include "BufferParams.h"
|
|
#include "Cursor.h"
|
|
#include "DispatchResult.h"
|
|
#include "InsetLabel.h"
|
|
#include "LaTeXFeatures.h"
|
|
#include "LyX.h"
|
|
#include "OutputParams.h"
|
|
#include "output_xhtml.h"
|
|
#include "ParIterator.h"
|
|
#include "sgml.h"
|
|
#include "TocBackend.h"
|
|
|
|
#include "support/debug.h"
|
|
#include "support/docstream.h"
|
|
#include "support/gettext.h"
|
|
#include "support/lstrings.h"
|
|
#include "support/textutils.h"
|
|
|
|
using namespace lyx::support;
|
|
using namespace std;
|
|
|
|
namespace lyx {
|
|
|
|
|
|
InsetRef::InsetRef(Buffer * buf, InsetCommandParams const & p)
|
|
: InsetCommand(buf, p)
|
|
{}
|
|
|
|
|
|
InsetRef::InsetRef(InsetRef const & ir)
|
|
: InsetCommand(ir)
|
|
{}
|
|
|
|
|
|
bool InsetRef::isCompatibleCommand(string const & s) {
|
|
//FIXME This is likely not the best way to handle this.
|
|
//But this stuff is hardcoded elsewhere already.
|
|
return s == "ref"
|
|
|| s == "pageref"
|
|
|| s == "vref"
|
|
|| s == "vpageref"
|
|
|| s == "formatted"
|
|
|| s == "eqref"
|
|
|| s == "nameref";
|
|
}
|
|
|
|
|
|
ParamInfo const & InsetRef::findInfo(string const & /* cmdName */)
|
|
{
|
|
static ParamInfo param_info_;
|
|
if (param_info_.empty()) {
|
|
param_info_.add("name", ParamInfo::LATEX_OPTIONAL);
|
|
param_info_.add("reference", ParamInfo::LATEX_REQUIRED,
|
|
ParamInfo::HANDLING_ESCAPE);
|
|
}
|
|
return param_info_;
|
|
}
|
|
|
|
|
|
// the ref argument is the label name we are referencing.
|
|
// we expect ref to be in the form: pfx:suffix.
|
|
//
|
|
// if it isn't, then we can't produce a formatted reference,
|
|
// so we return "\ref" and put ref into label.
|
|
//
|
|
// for refstyle, we return "\pfxcmd", and put suffix into
|
|
// label and pfx into prefix. this is because refstyle expects
|
|
// the command: \pfxcmd{suffix}.
|
|
//
|
|
// for prettyref, we return "\prettyref" and put ref into label
|
|
// and pfx into prefix. this is because prettyref uses the whole
|
|
// label, thus: \prettyref{pfx:suffix}.
|
|
//
|
|
docstring InsetRef::getFormattedCmd(docstring const & ref,
|
|
docstring & label, docstring & prefix) const
|
|
{
|
|
static docstring const defcmd = from_ascii("\\ref");
|
|
static docstring const prtcmd = from_ascii("\\prettyref");
|
|
|
|
label = split(ref, prefix, ':');
|
|
|
|
// we have to have xxx:xxxxx...
|
|
if (label.empty()) {
|
|
LYXERR0("Label `" << ref << "' contains no prefix.");
|
|
label = ref;
|
|
prefix = from_ascii("");
|
|
return defcmd;
|
|
}
|
|
|
|
if (prefix.empty()) {
|
|
// we have ":xxxx"
|
|
label = ref;
|
|
return defcmd;
|
|
}
|
|
|
|
if (!buffer().params().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++) {
|
|
char_type const c = prefix[i];
|
|
if (!isAlphaASCII(c)) {
|
|
LYXERR0("Prefix `" << prefix << "' is invalid for LaTeX.");
|
|
// 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());
|
|
}
|
|
|
|
|
|
void InsetRef::latex(otexstream & os, OutputParams const & rp) const
|
|
{
|
|
string const cmd = getCmdName();
|
|
docstring const data = getEscapedLabel(rp);
|
|
|
|
if (rp.inulemcmd)
|
|
os << "\\mbox{";
|
|
|
|
if (cmd == "eqref" && buffer().params().use_refstyle) {
|
|
// 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("})");
|
|
}
|
|
else if (cmd == "formatted") {
|
|
docstring label;
|
|
docstring prefix;
|
|
docstring const fcmd = getFormattedCmd(data, label, prefix);
|
|
os << fcmd << '{' << 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;
|
|
os << p.getCommand(rp);
|
|
}
|
|
|
|
if (rp.inulemcmd)
|
|
os << "}";
|
|
}
|
|
|
|
|
|
int InsetRef::plaintext(odocstringstream & os,
|
|
OutputParams const &, size_t) const
|
|
{
|
|
docstring const str = getParam("reference");
|
|
os << '[' << str << ']';
|
|
return 2 + str.size();
|
|
}
|
|
|
|
|
|
int InsetRef::docbook(odocstream & os, OutputParams const & runparams) const
|
|
{
|
|
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"))
|
|
<< "\">";
|
|
}
|
|
} else {
|
|
os << "<link linkend=\""
|
|
<< sgml::cleanID(buffer(), runparams, getParam("reference"))
|
|
<< "\">"
|
|
<< getParam("name")
|
|
<< "</link>";
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
docstring InsetRef::xhtml(XHTMLStream & xs, OutputParams const &) const
|
|
{
|
|
docstring const & ref = getParam("reference");
|
|
InsetLabel const * il = buffer().insetLabel(ref);
|
|
string const & cmd = params().getCmdName();
|
|
docstring display_string;
|
|
|
|
if (il && !il->counterValue().empty()) {
|
|
// Try to construct a label from the InsetLabel we reference.
|
|
docstring const & value = il->counterValue();
|
|
if (cmd == "ref")
|
|
display_string = value;
|
|
else if (cmd == "vref")
|
|
// 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");
|
|
else if (cmd == "eqref")
|
|
display_string = '(' + value + ')';
|
|
else if (cmd == "formatted")
|
|
display_string = il->prettyCounter();
|
|
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?
|
|
display_string = il->prettyCounter();
|
|
} else
|
|
display_string = ref;
|
|
|
|
// 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);
|
|
xs << display_string;
|
|
xs << html::EndTag("a");
|
|
return docstring();
|
|
}
|
|
|
|
|
|
void InsetRef::toString(odocstream & os) const
|
|
{
|
|
odocstringstream ods;
|
|
plaintext(ods, OutputParams(0));
|
|
os << ods.str();
|
|
}
|
|
|
|
|
|
void InsetRef::forToc(docstring & os, size_t) const
|
|
{
|
|
// There's no need for details in the TOC, and a long label
|
|
// will just get in the way.
|
|
os += '#';
|
|
}
|
|
|
|
|
|
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));
|
|
|
|
docstring label;
|
|
for (int i = 0; !types[i].latex_name.empty(); ++i) {
|
|
if (getCmdName() == types[i].latex_name) {
|
|
label = _(types[i].short_gui_name);
|
|
break;
|
|
}
|
|
}
|
|
label += ref;
|
|
|
|
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)
|
|
tooltip_ = label;
|
|
else
|
|
tooltip_ = from_ascii("");
|
|
}
|
|
|
|
|
|
void InsetRef::addToToc(DocIterator const & cpit, bool output_active) const
|
|
{
|
|
docstring const & label = getParam("reference");
|
|
if (buffer().insetLabel(label))
|
|
// This InsetRef has already been taken care of in InsetLabel::addToToc().
|
|
return;
|
|
|
|
// 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));
|
|
}
|
|
|
|
|
|
void InsetRef::validate(LaTeXFeatures & features) const
|
|
{
|
|
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;
|
|
string const fcmd = to_utf8(getFormattedCmd(data, label, prefix));
|
|
if (buffer().params().use_refstyle) {
|
|
features.require("refstyle");
|
|
if (prefix == "cha")
|
|
features.addPreambleSnippet("\\let\\charef=\\chapref");
|
|
else if (!prefix.empty()) {
|
|
string lcmd = "\\AtBeginDocument{\\providecommand" +
|
|
fcmd + "[1]{\\ref{" + to_utf8(prefix) + ":#1}}}";
|
|
features.addPreambleSnippet(lcmd);
|
|
}
|
|
} else {
|
|
features.require("prettyref");
|
|
// prettyref uses "cha" for chapters, so we provide a kind of
|
|
// translation.
|
|
if (prefix == "chap")
|
|
features.addPreambleSnippet("\\let\\pr@chap=\\pr@cha");
|
|
}
|
|
} else if (cmd == "eqref" && !buffer().params().use_refstyle)
|
|
// with refstyle, we simply output "(\ref{label})"
|
|
features.require("amsmath");
|
|
else if (cmd == "nameref")
|
|
features.require("nameref");
|
|
}
|
|
|
|
|
|
InsetRef::type_info 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:")},
|
|
{ "", "", "" }
|
|
};
|
|
|
|
|
|
int InsetRef::getType(string const & name)
|
|
{
|
|
for (int i = 0; !types[i].latex_name.empty(); ++i)
|
|
if (name == types[i].latex_name)
|
|
return i;
|
|
return 0;
|
|
}
|
|
|
|
|
|
string const & InsetRef::getName(int type)
|
|
{
|
|
return types[type].latex_name;
|
|
}
|
|
|
|
|
|
} // namespace lyx
|