]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/math_inset.h
rename commandtags.h to lfuns.h and renumber/cleanup. Rebuild the tree !
[lyx.git] / src / mathed / math_inset.h
index 1e5eda10121eb0f1d031ce05ce570b51cdec7d39..ed95d8d3e2f60d0c71808647e522ae44664fbc6f 100644 (file)
@@ -1,5 +1,5 @@
 // -*- C++ -*-
-/*
+/**
  *  File:        math_inset.h
  *  Purpose:     Declaration of insets for mathed
  *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
 #ifndef MATH_INSET_H
 #define MATH_INSET_H
 
-#include <config.h>
 
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include <config.h>
 
 #include "LString.h"
 #include "frontends/mouse_state.h"
-#include "math_xdata.h"
+#include "insets/insetbase.h"
+#include "math_data.h"
 
 /**
 
@@ -49,31 +47,27 @@ inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
 
 class MathArrayInset;
 class MathAMSArrayInset;
-class MathBraceInset;
-class MathBoxInset;
 class MathCharInset;
 class MathDelimInset;
-class MathFboxInset;
-class MathFontInset;
 class MathGridInset;
 class MathFracInset;
+class MathFontInset;
 class MathHullInset;
 class MathMatrixInset;
 class MathNestInset;
-class MathParInset;
+class MathParboxInset;
 class MathScriptInset;
 class MathStringInset;
 class MathSpaceInset;
 class MathSymbolInset;
 class MathUnknownInset;
-class MathXYMatrixInset;
-class MathXYMatrixInset;
 
-class InsetRef;
+class RefInset;
 
 class NormalStream;
 class OctaveStream;
 class MapleStream;
+class MaximaStream;
 class MathematicaStream;
 class MathMLStream;
 class WriteStream;
@@ -85,9 +79,11 @@ class BufferView;
 class UpdatableInset;
 class MathMacroTemplate;
 class MathPosFinder;
+class Dimension;
+class FuncRequest;
 
 
-class MathInset {
+class MathInset : public InsetBase {
 public:
        /// short of anything else reasonable
        typedef MathArray::size_type        size_type;
@@ -104,8 +100,6 @@ public:
 
        /// our members behave nicely...
        MathInset() {}
-       /// the virtual base destructor
-       virtual ~MathInset() {}
 
        /// reproduce itself
        virtual MathInset * clone() const = 0;
@@ -113,9 +107,12 @@ public:
        virtual void substitute(MathMacro const & macro);
        /// compute the size of the object, sets ascend_, descend_ and width_
        // updates the (xo,yo)-caches of all contained cells
-       virtual void metrics(MathMetricsInfo & st) const;
+       virtual void metrics(MathMetricsInfo & mi) const;
        /// draw the object
-       virtual void draw(MathPainterInfo &, int x, int y) const;
+       virtual void draw(MathPainterInfo & pi, int x, int y) const;
+       /// draw selection between two positions
+       virtual void drawSelection(MathPainterInfo & pi,
+               idx_type idx1, pos_type pos1, idx_type idx2, pos_type pos2) const;
        /// the ascent of the inset above the baseline
        /// compute the size of the object for text based drawing
        virtual void metricsT(TextMetricsInfo const & st) const;
@@ -127,11 +124,14 @@ public:
        virtual int descent() const { return 1; }
        /// total width
        virtual int width() const { return 2; }
+       /// all in one batch
+       virtual Dimension dimensions() const;
        /// total height (== ascent + descent)
        virtual int height() const;
 
        /// Where should we go when we press the up or down cursor key?
-       virtual bool idxUpDown(idx_type & idx, bool up) const;
+       virtual bool idxUpDown(idx_type & idx, pos_type & pos, bool up,
+               int targetx) const;
        /// The left key
        virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
        /// The right key
@@ -158,7 +158,7 @@ public:
        virtual void idxGlue(idx_type) {}
        // returns list of cell indices that are "between" from and to for
        // selection purposes
-       virtual std::vector<idx_type> idxBetween(idx_type from, idx_type to) const;
+       virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
 
        /// the number of nested cells this inset owns
        virtual idx_type nargs() const;
@@ -167,10 +167,6 @@ public:
        virtual MathArray & cell(idx_type);
        /// return cell given its number
        virtual MathArray const & cell(idx_type) const;
-       /// return cell plus drawing cache given its number
-       virtual MathXArray & xcell(idx_type);
-       /// return cell plus drawing cache given its number
-       virtual MathXArray const & xcell(idx_type) const;
 
        /// the number of columns of this inset if it is grid-like
        virtual col_type ncols() const { return 1; }
@@ -188,35 +184,41 @@ public:
        virtual int cellYOffset(idx_type) const { return 0; }
        /// can we enter this cell?
        virtual bool validCell(idx_type) const { return true; }
+       /// get coordinates
+       virtual void getPos(idx_type idx, pos_type pos, int & x, int & y) const;
 
        /// identifies certain types of insets
-       virtual MathAMSArrayInset      * asAMSArrayInset()      { return 0; }
-       virtual MathArrayInset         * asArrayInset()         { return 0; }
-       virtual MathBraceInset         * asBraceInset()         { return 0; }
-       virtual MathBoxInset           * asBoxInset()           { return 0; }
-       virtual MathBoxInset const     * asBoxInset() const     { return 0; }
-       virtual MathCharInset const    * asCharInset() const    { return 0; }
-       virtual MathDelimInset         * asDelimInset()         { return 0; }
-       virtual MathDelimInset const   * asDelimInset() const   { return 0; }
-       virtual MathFboxInset          * asFboxInset()          { return 0; }
-       virtual MathFontInset const    * asFontInset() const    { return 0; }
-       virtual MathFracInset          * asFracInset()          { return 0; }
-       virtual MathGridInset          * asGridInset()          { return 0; }
-       virtual MathHullInset          * asHullInset()          { return 0; }
-       virtual MathHullInset const    * asHullInset() const    { return 0; }
-       virtual MathMacroTemplate      * asMacroTemplate()      { return 0; }
-       virtual MathMatrixInset const  * asMatrixInset() const  { return 0; }
-       virtual MathNestInset          * asNestInset()          { return 0; }
-       virtual MathParInset           * asParInset()           { return 0; }
-       virtual MathScriptInset        * asScriptInset()        { return 0; }
-       virtual MathScriptInset const  * asScriptInset() const  { return 0; }
-       virtual MathSpaceInset         * asSpaceInset()         { return 0; }
-       virtual MathStringInset        * asStringInset()        { return 0; }
-       virtual MathSymbolInset const  * asSymbolInset() const  { return 0; }
-       virtual MathUnknownInset       * asUnknownInset()       { return 0; }
-       virtual MathUnknownInset const * asUnknownInset() const { return 0; }
-       virtual MathXYMatrixInset const* asXYMatrixInset() const{ return 0; }
-       virtual InsetRef               * asInsetRef()           { return 0; }
+       virtual MathAMSArrayInset       * asAMSArrayInset()       { return 0; }
+       virtual MathAMSArrayInset const * asAMSArrayInset() const { return 0; }
+       virtual MathArrayInset          * asArrayInset()          { return 0; }
+       virtual MathArrayInset const    * asArrayInset() const    { return 0; }
+       virtual MathCharInset const     * asCharInset() const     { return 0; }
+       virtual MathDelimInset          * asDelimInset()          { return 0; }
+       virtual MathDelimInset const    * asDelimInset() const    { return 0; }
+       virtual MathFracInset           * asFracInset()           { return 0; }
+       virtual MathFracInset const     * asFracInset() const     { return 0; }
+       virtual MathFontInset           * asFontInset()           { return 0; }
+       virtual MathFontInset const     * asFontInset() const     { return 0; }
+       virtual MathGridInset           * asGridInset()           { return 0; }
+       virtual MathGridInset const     * asGridInset() const     { return 0; }
+       virtual MathHullInset           * asHullInset()           { return 0; }
+       virtual MathHullInset const     * asHullInset() const     { return 0; }
+       virtual MathMacroTemplate       * asMacroTemplate()       { return 0; }
+       virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
+       virtual MathMatrixInset const   * asMatrixInset() const   { return 0; }
+       virtual MathNestInset           * asNestInset()           { return 0; }
+       virtual MathNestInset const     * asNestInset() const     { return 0; }
+       virtual MathParboxInset         * asParboxInset()         { return 0; }
+       virtual MathScriptInset         * asScriptInset()         { return 0; }
+       virtual MathScriptInset const   * asScriptInset() const   { return 0; }
+       virtual MathSpaceInset          * asSpaceInset()          { return 0; }
+       virtual MathSpaceInset const    * asSpaceInset() const    { return 0; }
+       virtual MathStringInset         * asStringInset()         { return 0; }
+       virtual MathStringInset const   * asStringInset() const   { return 0; }
+       virtual MathSymbolInset const   * asSymbolInset() const   { return 0; }
+       virtual MathUnknownInset        * asUnknownInset()        { return 0; }
+       virtual MathUnknownInset const  * asUnknownInset() const  { return 0; }
+       virtual RefInset                * asRefInset()            { return 0; }
 
        /// identifies things that can get scripts
        virtual bool isScriptable() const { return false; }
@@ -224,6 +226,12 @@ public:
        virtual bool isActive() const { return nargs() > 0; }
        /// is the a relational operator (used for splitting equations)
        virtual bool isRelOp() const { return false; }
+       /// -1: text mode, 1: math mode, 0 undecided
+       enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
+
+       virtual mode_type currentMode() const { return UNDECIDED_MODE; }
+       /// will this get written as a single block in {..}
+       virtual bool extraBraces() const { return false; }
 
        /// return the content as char if the inset is able to do so
        virtual char getChar() const { return 0; }
@@ -234,36 +242,40 @@ public:
        virtual void edit(BufferView *, int, int, mouse_button::state) {}
 
        /// request "external features"
-       virtual void validate(LaTeXFeatures & features) const;
+       virtual void validate(LaTeXFeatures &) const {}
        /// char char code if possible
        virtual void handleFont(string const &) {}
        /// is this inset equal to a given other inset?
-       virtual bool match(MathInset *) const { return false; }
+       virtual bool match(MathAtom const &) const { return false; }
        /// replace things by other things
        virtual void replace(ReplaceData &) {}
        /// do we contain a given subsequence?
-       virtual bool contains(MathArray const &) { return false; }
+       virtual bool contains(MathArray const &) const { return false; }
        /// access to the lock (only nest array have one)
        virtual bool lock() const { return false; }
        /// access to the lock (only nest array have one)
        virtual void lock(bool) {}
        /// get notification when the cursor leaves this inset
-       virtual void notifyCursorLeaves() {}
+       virtual void notifyCursorLeaves(idx_type) {}
 
        /// write LaTeX and Lyx code
        virtual void write(WriteStream & os) const;
        /// write normalized content
        virtual void normalize(NormalStream &) const;
        /// write content as something readable by Maple
-       virtual void maplize(MapleStream &) const;
+       virtual void maple(MapleStream &) const;
+       /// write content as something readable by Maxima
+       virtual void maxima(MaximaStream &) const;
        /// write content as something readable by Mathematica
-       virtual void mathematicize(MathematicaStream &) const;
+       virtual void mathematica(MathematicaStream &) const;
        /// write content as something resembling MathML
        virtual void mathmlize(MathMLStream &) const;
        /// write content as something readable by Octave
-       virtual void octavize(OctaveStream &) const;
-       /// describe content
+       virtual void octave(OctaveStream &) const;
+       /// describe content if cursor inside
        virtual void infoize(std::ostream &) const {}
+       /// describe content if cursor behind
+       virtual void infoize2(std::ostream &) const {}
        /// plain ascii output
        virtual int ascii(std::ostream & os, int) const;
        /// linuxdoc output
@@ -273,11 +285,10 @@ public:
 
        /// dump content to stderr for debugging
        virtual void dump() const;
-       /// local dispatcher
-       virtual int dispatch(string const & cmd, idx_type idx, pos_type pos);
 
        /// LyXInset stuff
-       virtual std::vector<string> getLabelList() const;
+       /// write labels into a list
+       virtual void getLabelList(std::vector<string> &) const {}
        /// LyXInset stuff
        virtual bool numberedType() const { return false; }
        /// hull type
@@ -286,19 +297,22 @@ public:
        virtual void mutate(string const &) {}
        /// how is the inset called in the .lyx file?
        virtual string fileInsetLabel() const { return "Formula"; }
+       /// usually the latex name
+       virtual string name() const;
+
+protected:
+       /// a dirty hack
+       BufferView * view() const;
 };
 
-std::ostream & operator<<(std::ostream &, MathInset const &);
 std::ostream & operator<<(std::ostream &, MathAtom const &);
 
+// converts single cell to string
 string asString(MathArray const & ar);
+// converts string to single cell
 MathArray asArray(string const & str);
 
-/// here to ssave a few includes in the insets
-class Dialogs;
-class LyXFunc;
-
-Dialogs * getDialogs();
-LyXFunc * getLyXFunc();
+// initialize math
+void initMath();
 
 #endif