* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author José Matos
+ * \author José Matos
*
* Full author contact details are available in file CREDITS.
*/
#include "Cursor.h"
#include "DispatchResult.h"
#include "FuncRequest.h"
-#include "support/gettext.h"
+#include "InsetLabel.h"
#include "LaTeXFeatures.h"
-#include "LyXFunc.h"
+#include "LyX.h"
#include "OutputParams.h"
+#include "output_xhtml.h"
+#include "ParIterator.h"
#include "sgml.h"
+#include "TocBackend.h"
#include "support/docstream.h"
+#include "support/gettext.h"
#include "support/lstrings.h"
-using namespace std;
using namespace lyx::support;
+using namespace std;
namespace lyx {
-InsetRef::InsetRef(InsetCommandParams const & p, Buffer const & buf)
- : InsetCommand(p, "ref"), isLatex(buf.isLatex())
+InsetRef::InsetRef(Buffer * buf, InsetCommandParams const & p)
+ : InsetCommand(buf, p, "ref"), isLatex(buf->isLatex())
{}
}
-CommandInfo const * InsetRef::findInfo(string const & /* cmdName */)
-{
- static const char * const paramnames[] = {"name", "reference", ""};
- static const bool isoptional[] = {true, false};
- static const CommandInfo info = {2, paramnames, isoptional};
- return &info;
-}
-
-
-void InsetRef::doDispatch(Cursor & cur, FuncRequest & cmd)
-{
- switch (cmd.action) {
- case LFUN_MOUSE_RELEASE:
- // Eventually trigger dialog with button 3 not 1
- if (cmd.button() == mouse_button::button3)
- lyx::dispatch(FuncRequest(LFUN_LABEL_GOTO,
- getParam("reference")));
- else
- InsetCommand::doDispatch(cur, cmd);
- break;
-
- default:
- InsetCommand::doDispatch(cur, cmd);
- }
-}
-
-
-docstring const InsetRef::getScreenLabel(Buffer const &) const
+ParamInfo const & InsetRef::findInfo(string const & /* cmdName */)
{
- docstring temp;
- for (int i = 0; !types[i].latex_name.empty(); ++i) {
- if (getCmdName() == types[i].latex_name) {
- temp = _(types[i].short_gui_name);
- break;
- }
+ 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);
}
- temp += getParam("reference");
-
- if (!isLatex && !getParam("name").empty()) {
- temp += "||";
- temp += getParam("name");
- }
- return temp;
+ return param_info_;
}
-int InsetRef::latex(Buffer const &, odocstream & os,
- OutputParams const &) const
+int InsetRef::latex(odocstream & os, OutputParams const & runparams) 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 << escape(p.getCommand());
+ os << p.getCommand(runparams);
return 0;
}
-int InsetRef::plaintext(Buffer const &, odocstream & os,
- OutputParams const &) const
+int InsetRef::plaintext(odocstream & os, OutputParams const &) const
{
docstring const str = getParam("reference");
os << '[' << str << ']';
}
-int InsetRef::docbook(Buffer const & buf, odocstream & os,
- OutputParams const & runparams) const
+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(buf, runparams, getParam("reference"))
+ << sgml::cleanID(buffer(), runparams, getParam("reference"))
<< "\" />";
} else {
os << "<xref linkend=\""
- << sgml::cleanID(buf, runparams, getParam("reference"))
+ << sgml::cleanID(buffer(), runparams, getParam("reference"))
<< "\">";
}
} else {
os << "<link linkend=\""
- << sgml::cleanID(buf, runparams, getParam("reference"))
+ << sgml::cleanID(buffer(), runparams, getParam("reference"))
<< "\">"
<< getParam("name")
<< "</link>";
}
-void InsetRef::textString(Buffer const & buf, odocstream & os) const
+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 = bformat(from_ascii("equation (%1$s)"), value);
+ else { // "prettyref"
+ 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::tocString(odocstream & os) const
+{
+ plaintext(os, OutputParams(0));
+}
+
+
+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 (!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)
{
- plaintext(buf, os, OutputParams(0));
+ 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_));
}
{ "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: ")},
+ { "prettyref", N_("PrettyRef"), N_("FrmtRef: ")},
{ "", "", "" }
};
projects / lyx.git / blobdiff