]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetref.C
* In the process of fixing the math background color bug, this commit transfer backgr...
[lyx.git] / src / insets / insetref.C
index bb985a9ed857cc0a88432679440a3a802eb94df3..85dca1c86529ab7fdf0bfa45524a34ee86ee0f8f 100644 (file)
+/**
+ * \file insetref.C
+ * 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 <cstdlib>
-
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
-#include FORMS_H_LOCATION 
 #include "insetref.h"
+
 #include "buffer.h"
-#include "debug.h"
-#include "lyx_gui_misc.h" // CancelCloseBoxCB
-#include "LyXView.h"
-#include "lyxfunc.h"
-#include "commandtags.h"
+#include "cursor.h"
+#include "dispatchresult.h"
+#include "funcrequest.h"
 #include "gettext.h"
+#include "LaTeXFeatures.h"
+#include "lyxfunc.h"
+#include "outputparams.h"
+#include "sgml.h"
+
+#include "support/lstrings.h"
 
+
+namespace lyx {
+
+using support::escape;
+
+using std::string;
 using std::ostream;
 
-extern BufferView * current_view;
 
+InsetRef::InsetRef(InsetCommandParams const & p, Buffer const & buf)
+       : InsetCommand(p, "ref"), isLatex(buf.isLatex())
+{}
+
+
+InsetRef::InsetRef(InsetRef const & ir)
+       : InsetCommand(ir), isLatex(ir.isLatex)
+{}
 
-InsetRef::InsetRef(string const & cmd, Buffer * bf)
-       : master(bf)
+
+void InsetRef::doDispatch(LCursor & cur, FuncRequest & cmd)
 {
-       scanCommand(cmd);
-       if (getCmdName() == "ref")
-               flag = InsetRef::REF;
-       else
-               flag = InsetRef::PAGE_REF;
+       switch (cmd.action) {
+       case LFUN_MOUSE_PRESS:
+               // Eventually trigger dialog with button 3 not 1
+               if (cmd.button() == mouse_button::button3)
+                       lyx::dispatch(FuncRequest(LFUN_LABEL_GOTO, getParam("reference")));
+               else {
+                       InsetCommandMailer("ref", *this).showDialog(&cur.bv());
+                       cur.undispatched();
+               }
+               return;
+
+       case LFUN_MOUSE_RELEASE:
+               return;
+
+       default:
+               return InsetCommand::doDispatch(cur, cmd);
+       }
 }
 
 
-InsetRef::InsetRef(InsetCommand const & inscmd, Buffer * bf)
-       : master(bf)
+docstring const InsetRef::getScreenLabel(Buffer const &) const
 {
-       setCmdName(inscmd.getCmdName());
-       setContents(inscmd.getContents());
-       setOptions(inscmd.getOptions());
-       if (getCmdName() == "ref")
-               flag = InsetRef::REF;
-       else
-               flag = InsetRef::PAGE_REF;
+       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;
+               }
+       }
+       temp += getParam("reference");
+
+       if (!isLatex && !getParam("name").empty()) {
+               temp += "||";
+               temp += getParam("name");
+       }
+       return temp;
 }
 
 
-void InsetRef::Edit(BufferView * bv, int, int, unsigned int)
+int InsetRef::latex(Buffer const &, odocstream & os,
+                    OutputParams const &) const
 {
-        bv->owner()->getLyXFunc()->
-               Dispatch(LFUN_REFGOTO, getContents().c_str());
+       // Don't output p_["name"], this is only used in docbook
+       InsetCommandParams p(getCmdName());
+       p["reference"] = getParam("reference");
+       os << escape(p.getCommand());
+       return 0;
 }
 
 
-string InsetRef::getScreenLabel() const
+int InsetRef::plaintext(Buffer const &, odocstream & os,
+                        OutputParams const &) const
 {
-       string temp;
-       if (flag == InsetRef::PAGE_REF)
-               temp += _("Page: ");
-       else 
-               temp += _("Ref: ");
-       temp += getContents();
-       if(!current_view->buffer()->isLatex()
-          && !getOptions().empty()) {
-               temp += "||";
-               temp += getOptions();
-       }
-       return temp;
+       docstring const str = getParam("reference");
+       os << '[' << str << ']';
+       return 2 + str.size();
 }
 
 
-int InsetRef::Latex(ostream & os,
-                   bool /*fragile*/, bool /*fs*/) const
+int InsetRef::docbook(Buffer const & buf, odocstream & os,
+                      OutputParams const & runparams) const
 {
-       if(getOptions().empty())
-               os << escape(getCommand());
-       else {
-               string ns;
-               InsetCommand clone = InsetCommand(getCmdName(),
-                                                 getContents(), ns);
-               os << escape(clone.getCommand());
+       docstring const & name = getParam("name");
+       if (name.empty()) {
+               if (runparams.flavor == OutputParams::XML) {
+                       os << "<xref linkend=\"" 
+                          << sgml::cleanID(buf, runparams, getParam("reference")) 
+                          << "\" />";
+               } else {
+                       os << "<xref linkend=\"" 
+                          << sgml::cleanID(buf, runparams, getParam("reference")) 
+                          << "\">";
+               }
+       } else {
+               os << "<link linkend=\"" 
+                  << sgml::cleanID(buf, runparams, getParam("reference"))
+                  << "\">" 
+                  << getParam("name")
+                  << "</link>";
        }
+
        return 0;
 }
 
 
-int InsetRef::Linuxdoc(ostream & os) const
+int InsetRef::textString(Buffer const & buf, odocstream & os,
+                      OutputParams const & op) const
 {
-       os << "<ref id=\"" << getContents()
-          << "\" name=\"" << getOptions() << "\" >";
-       return 0;
+       return plaintext(buf, os, op);
+}
+
+
+void InsetRef::validate(LaTeXFeatures & features) const
+{
+       if (getCmdName() == "vref" || getCmdName() == "vpageref")
+               features.require("varioref");
+       else if (getCmdName() == "prettyref")
+               features.require("prettyref");
+       else if (getCmdName() == "eqref")
+               features.require("amsmath");
 }
 
 
-int InsetRef::DocBook(ostream & os) const
+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: ")},
+       { "prettyref", N_("PrettyRef"),             N_("FormatRef: ")},
+       { "", "", "" }
+};
+
+
+int InsetRef::getType(string const & name)
 {
-       os << "<link linkend=\"" << getContents()
-          << "\">" << getOptions() << "</link>";
+       for (int i = 0; !types[i].latex_name.empty(); ++i)
+               if (name == types[i].latex_name)
+                       return i;
        return 0;
 }
 
 
-// This function escapes 8-bit characters and other problematic characters
-// It's exactly the same code as in insetlabel.C.
-string InsetRef::escape(string const & lab) const
+string const & InsetRef::getName(int type)
 {
-       char hexdigit[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
-                             '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' };
-       string enc;
-       for (string::size_type i = 0; i < lab.length(); ++i) {
-               unsigned char c= lab[i];
-               if (c >= 128 || c == '=' || c == '%') {
-                       enc += '=';
-                       enc += hexdigit[c>>4];
-                       enc += hexdigit[c & 15];
-               } else {
-                       enc += c;
-               }
-       }
-       return enc;
+       return types[type].latex_name;
 }
+
+
+} // namespace lyx