]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetRef.cpp
This optional argument to the InsetCollapsable constructor
[lyx.git] / src / insets / InsetRef.cpp
index f1838c28fcf71a2bfe74fce5969dbef1799e7710..f0c45db39ce97d25d979eaea836263ae4b0a882a 100644 (file)
 #include "Cursor.h"
 #include "DispatchResult.h"
 #include "FuncRequest.h"
-#include "gettext.h"
 #include "LaTeXFeatures.h"
 #include "LyXFunc.h"
 #include "OutputParams.h"
+#include "ParIterator.h"
 #include "sgml.h"
+#include "TocBackend.h"
 
+#include "support/docstream.h"
+#include "support/gettext.h"
 #include "support/lstrings.h"
 
+using namespace lyx::support;
+using namespace std;
 
 namespace lyx {
 
-using support::escape;
 
-using std::string;
-using std::ostream;
-
-
-InsetRef::InsetRef(InsetCommandParams const & p, Buffer const & buf)
+InsetRef::InsetRef(Buffer const & buf, InsetCommandParams const & p)
        : InsetCommand(p, "ref"), isLatex(buf.isLatex())
 {}
 
@@ -42,45 +42,36 @@ InsetRef::InsetRef(InsetRef const & ir)
 {}
 
 
-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);
-       }
+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 == "prettyref"
+               || s == "eqref";
 }
 
 
-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);
        }
-       temp += getParam("reference");
+       return param_info_;
+}
 
-       if (!isLatex && !getParam("name").empty()) {
-               temp += "||";
-               temp += getParam("name");
-       }
-       return temp;
+
+docstring InsetRef::screenLabel() const
+{
+       return screen_label_;
 }
 
 
-int InsetRef::latex(Buffer const &, odocstream & os,
-                   OutputParams const &) const
+int InsetRef::latex(odocstream & os, OutputParams const &) 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.
@@ -91,8 +82,7 @@ int InsetRef::latex(Buffer const &, odocstream & os,
 }
 
 
-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 << ']';
@@ -100,23 +90,22 @@ int InsetRef::plaintext(Buffer const &, odocstream & os,
 }
 
 
-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>";
@@ -126,10 +115,44 @@ int InsetRef::docbook(Buffer const & buf, odocstream & os,
 }
 
 
-int InsetRef::textString(Buffer const & buf, odocstream & os,
-                      OutputParams const & op) const
+void InsetRef::textString(odocstream & os) const
+{
+       plaintext(os, OutputParams(0));
+}
+
+
+void InsetRef::updateLabels(ParIterator const & it)
+{
+       docstring const & label = getParam("reference");
+       // register this inset into the buffer reference cache.
+       buffer().references(label).push_back(make_pair(this, it));
+
+       for (int i = 0; !types[i].latex_name.empty(); ++i) {
+               if (getCmdName() == types[i].latex_name) {
+                       screen_label_ = _(types[i].short_gui_name);
+                       break;
+               }
+       }
+       screen_label_ += getParam("reference");
+
+       if (!isLatex && !getParam("name").empty()) {
+               screen_label_ += "||";
+               screen_label_ += getParam("name");
+       }
+}
+
+
+void InsetRef::addToToc(DocIterator const & cpit)
 {
-       return plaintext(buf, os, op);
+       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_));
 }