]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetref.C
Final touch 'inset display()'; fix 'is a bit silly' bug
[lyx.git] / src / insets / insetref.C
index a35d9875236f590f9cfda36064ecaf610adb9211..959f3e903ce9182c52bba1e7e9b114db7253e30c 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 <stdlib.h>
-
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
-#include FORMS_H_LOCATION 
 #include "insetref.h"
+
 #include "buffer.h"
-#include "error.h"
-#include "lyx_gui_misc.h" // CancelCloseBoxCB
-#include "LyXView.h"
-#include "lyxfunc.h"
-#include "commandtags.h"
+#include "BufferView.h"
+#include "funcrequest.h"
 #include "gettext.h"
+#include "LaTeXFeatures.h"
 
-extern BufferView *current_view;
-
-// Temporarily disabled the GUI code. Reasons:
-// - Only page-ref button works currently, IMO we should use a LyX action
-//   instead, to toggle the kind of refs.
-// - To change the label, IMO it's faster to delete the old one and insert
-//   a new one.
-// - To goto to the label, IMO it's much faster to just click on the
-//   inset. That's how I've implemented it now, I hope you'll like it.
-// - The more GUI code we can remove, the less work we'll have at
-//   the toolkit switch.
-//   (ale 970723)
-
-#if 0
-
-/* Header file generated with fdesign. */
-
-/**** Callback routines ****/
-
-static void ref_close_cb(FL_OBJECT *, long);
-static void goto_label_cb(FL_OBJECT *, long);
-static void label_change_cb(FL_OBJECT *, long);
-
-/**** Forms and Objects ****/
-
-typedef struct {
-       FL_FORM *ref;
-       void *vdata;
-       long ldata;
-       FL_OBJECT *pg_grp;
-       FL_OBJECT *flag1;
-       FL_OBJECT *flag2;
-} FD_ref;
-
-/* Form definition file generated with fdesign. */
-
-static
-FD_ref *create_form_ref(void)
-{
-  FL_OBJECT *obj;
-  FD_ref *fdui = (FD_ref *) fl_calloc(1, sizeof(*fdui));
-
-  fdui->ref = fl_bgn_form(FL_NO_BOX, 210, 170);
-  obj = fl_add_box(FL_UP_BOX,0,0,210,170,"");
-  obj = fl_add_frame(FL_ENGRAVED_FRAME,10,20,130,60,"");
-  obj = fl_add_button(FL_RETURN_BUTTON,120,130,80,30,_("Close"));
-    fl_set_object_lsize(obj,FL_NORMAL_SIZE);
-    fl_set_object_callback(obj,ref_close_cb,0);
-  obj = fl_add_text(FL_NORMAL_TEXT,20,10,110,20,_("Reference Type"));
-    fl_set_object_lsize(obj,FL_NORMAL_SIZE);
-    fl_set_object_lalign(obj,FL_ALIGN_LEFT|FL_ALIGN_INSIDE);
-  obj = fl_add_button(FL_NORMAL_BUTTON,10,130,100,30,_("Goto Label"));
-    fl_set_object_lsize(obj,FL_NORMAL_SIZE);
-    fl_set_object_callback(obj,goto_label_cb,0);
-  obj = fl_add_button(FL_NORMAL_BUTTON,10,90,100,30,_("Change Label"));
-    fl_set_object_lsize(obj,FL_NORMAL_SIZE);
-    fl_set_object_callback(obj,label_change_cb,0);
-
-  fdui->pg_grp = fl_bgn_group();
-  fdui->flag1 = obj = fl_add_checkbutton(FL_RADIO_BUTTON,20,30,20,20,_("Page Number"));
-    fl_set_object_lsize(obj,FL_NORMAL_SIZE);
-  fdui->flag2 = obj = fl_add_checkbutton(FL_RADIO_BUTTON,20,50,20,20,_("Reference"));
-    fl_set_object_lsize(obj,FL_NORMAL_SIZE);
-  fl_end_group();
-
-  fl_end_form();
-
-  fdui->ref->fdui = fdui;
-
-  return fdui;
-}
-/*---------------------------------------*/
-
-
-static FD_ref *form = 0;
+#include "frontends/LyXView.h"
 
+#include "support/lstrings.h"
 
-static
-void ref_close_cb(FL_OBJECT *, long)
-{
-       InsetRef *inset = (InsetRef*)form->vdata;
-
-       if (fl_get_button(form->flag1)) {
-               inset->setFlag(InsetRef::PAGE_REF);
-               inset->setCmdName("pageref");
-       } else {
-               inset->setFlag(InsetRef::REF);
-               inset->setCmdName("ref");
-       }
-               
-       fl_hide_form(form->ref);
-}
-
-
-static
-void goto_label_cb(FL_OBJECT *, long)
-{
-       // code yet to be written
-       InsetRef *inset = (InsetRef*)form->vdata;
-        inset->gotoLabel();
-#warning MAKEME!
-}
 
+using lyx::support::escape;
 
-static
-void label_change_cb(FL_OBJECT *, long)
-{
-       // code yet to be written
-       InsetRef *inset = (InsetRef*)form->vdata;
-#warning MAKEME!
-}
+using std::string;
+using std::ostream;
 
-#endif
 
-InsetRef::InsetRef(LString const & cmd, Buffer *bf)
-       : master(bf)
-{
-       scanCommand(cmd);
-       if (getCmdName() == "ref")
-               flag = InsetRef::REF;
-       else
-               flag = InsetRef::PAGE_REF;
-}
+InsetRef::InsetRef(InsetCommandParams const & p, Buffer const & buf)
+       : InsetCommand(p), isLatex(buf.isLatex())
+{}
 
 
-InsetRef::InsetRef(InsetCommand const &inscmd, Buffer *bf)
-       : master(bf)
+InsetRef::InsetRef(InsetRef const & ir)
+       : InsetCommand(ir), isLatex(ir.isLatex)
 {
-       setCmdName(inscmd.getCmdName());
-       setContents(inscmd.getContents());
-       setOptions(inscmd.getOptions());
-       if (getCmdName() == "ref")
-               flag = InsetRef::REF;
-       else
-               flag = InsetRef::PAGE_REF;
 }
 
 
 InsetRef::~InsetRef()
 {
+       InsetCommandMailer("ref", *this).hideDialog();
 }
 
 
-void InsetRef::Edit(int, int)
+dispatch_result
+InsetRef::priv_dispatch(FuncRequest const & cmd, idx_type & idx, pos_type & pos)
 {
-        current_view->getOwner()->getLyXFunc()->Dispatch(LFUN_REFGOTO
-                                                        , getContents().c_str());
-//        gotoLabel();
-/*    
-        if (!form) { 
-                form = create_form_ref();
-               fl_set_form_atclose(form->ref, IgnoreCloseBoxCB, NULL);
+       switch (cmd.action) {
+       case LFUN_INSET_EDIT:
+               // Eventually trigger dialog with button 3 not 1
+               if (cmd.button() == mouse_button::button3)
+                       cmd.view()->owner()->
+                               dispatch(FuncRequest(LFUN_REF_GOTO, getContents()));
+               else
+                       InsetCommandMailer("ref", *this).showDialog(cmd.view());
+               return DISPATCHED;
+
+       default:
+               return InsetCommand::priv_dispatch(cmd, idx, pos);
        }
-        form->vdata = this; 
-    
-       fl_set_button(form->flag1, (flag == InsetRef::REF) ? 1 : 0);
-       fl_set_button(form->flag2, (flag == InsetRef::PAGE_REF) ? 1 : 0);
-       
-        if (form->ref->visible) {
-               fl_raise_form(form->ref);
-       } else {
-               fl_show_form(form->ref,FL_PLACE_MOUSE, FL_FULLBORDER,
-                            _("Cross-Reference"));
-       }
- */
 }
 
 
-LString InsetRef::getScreenLabel() const
+string const InsetRef::getScreenLabel(Buffer const &) const
 {
-       LString temp;
-       if (flag == InsetRef::PAGE_REF)
-               temp += _("Page: ");
-       else 
-               temp += _("Ref: ");
+       string 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 += getContents();
-       if(!current_view->currentBuffer()->isLatex() && !getOptions().empty()) {
+
+       if (!isLatex
+          && !getOptions().empty()) {
                temp += "||";
                temp += getOptions();
        }
@@ -200,63 +83,79 @@ LString InsetRef::getScreenLabel() const
 }
 
 
-int InsetRef::Latex(FILE *file, signed char /*fragile*/)
+int InsetRef::latex(Buffer const &, ostream & os,
+                   LatexRunParams const &) const
 {
-       if(getOptions().empty())
-               fprintf(file, "%s", escape(getCommand()).c_str());
+       if (getOptions().empty())
+               os << escape(getCommand());
        else {
-               LString ns;
-               InsetCommand clone= InsetCommand(getCmdName(),getContents(),ns);
-               fprintf(file, "%s", escape(clone.getCommand()).c_str());
+               InsetCommandParams p(getCmdName(), getContents(), "");
+               os << escape(p.getCommand());
        }
        return 0;
 }
 
 
-int InsetRef::Latex(LString &file, signed char /*fragile*/)
+int InsetRef::ascii(Buffer const &, ostream & os, int) const
 {
-       if(getOptions().empty())
-               file += escape(getCommand());
-       else {
-               LString ns;
-               InsetCommand clone= InsetCommand(getCmdName(),getContents(),ns);
-               file += escape(clone.getCommand());
-       }
+       os << '[' << getContents() << ']';
+       return 0;
+}
+
+
+int InsetRef::linuxdoc(Buffer const &, ostream & os) const
+{
+       os << "<ref id=\"" << getContents()
+          << "\" name=\"" << getOptions() << "\" >";
        return 0;
 }
 
 
-int InsetRef::Linuxdoc(LString &file)
+int InsetRef::docbook(Buffer const &, ostream & os, bool) const
 {
-       file += "<ref id=\"" + getContents() + "\" name=\""+ getOptions() +"\" >" ;
+       if (getOptions().empty()) {
+               os << "<xref linkend=\"" << getContents() << "\">";
+       } else {
+               os << "<link linkend=\"" << getContents()
+                  << "\">" << getOptions() << "</link>";
+       }
 
        return 0;
 }
 
 
-int InsetRef::DocBook(LString &file)
+void InsetRef::validate(LaTeXFeatures & features) const
 {
-       file += "<link linkend=\"" + getContents() + "\">"+ getOptions() +"</link>" ;
+       if (getCmdName() == "vref" || getCmdName() == "vpageref")
+               features.require("varioref");
+       else if (getCmdName() == "prettyref")
+               features.require("prettyref");
+       else if (getCmdName() == "eqref")
+               features.require("amsmath");
+}
+
 
+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_("PrettyRef: ")},
+       { "", "", "" }
+};
+
+
+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;
 }
 
 
-// This function escapes 8-bit characters and other problematic characters
-// It's exactly the same code as in insetlabel.C.
-LString InsetRef::escape(LString const & lab) const {
-       char hexdigit[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
-                             '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' };
-       LString enc;
-       for (int 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 += (char) c;
-               }
-       }
-       return enc;
+string const & InsetRef::getName(int type)
+{
+       return types[type].latex_name;
 }