src/mathed/math_inset.h

   1 // -*- C++ -*-
   2 /*
   3  *  File:        math_inset.h
   4  *  Purpose:     Declaration of insets for mathed
   5  *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
   6  *  Created:     January 1996
   7  *  Description: Math paragraph and objects for a WYSIWYG math editor.
   8  *
   9  *  Dependencies: Xlib, XForms
  10  *
  11  *  Copyright: 1996, 1997 Alejandro Aguilar Sierra
  12  *
  13  *   Version: 0.8beta, Math & Lyx project.
  14  *
  15  *   You are free to use and modify this code under the terms of
  16  *   the GNU General Public Licence version 2 or later.
  17  */
  18
  19 //  Note: These math insets are internal to Math and are not derived
  20 //        from lyx inset.
  21
  22 #ifndef MATH_INSET_H
  23 #define MATH_INSET_H
  24
  25 #include <config.h>
  26
  27 #ifdef __GNUG__
  28 #pragma interface
  29 #endif
  30
  31 #include "math_xdata.h"
  32 #include "math_defs.h"
  33
  34 /** Abstract base class for all math objects.
  35     A math insets is for use of the math editor only, it isn't a
  36     general LyX inset. It's used to represent all the math objects.
  37     The formulaInset (a LyX inset) encapsulates a math inset.
  38 */
  39
  40
  41 class MathArrayInset;
  42 class MathBoxInset;
  43 class MathCharInset;
  44 class MathDelimInset;
  45 class MathFuncInset;
  46 class MathGridInset;
  47 class MathHullInset;
  48 class MathMatrixInset;
  49 class MathNestInset;
  50 class MathScriptInset;
  51 class MathStringInset;
  52 class MathSpaceInset;
  53 class MathMacroTemplate;
  54
  55 class NormalStream;
  56 class OctaveStream;
  57 class MapleStream;
  58 class MathMLStream;
  59 class WriteStream;
  60 class MathArray;
  61
  62 class LaTeXFeatures;
  63 class BufferView;
  64 class UpdatableInset;
  65
  66
  67 class MathInset {
  68 public:
  69         /// short of anything else reasonable
  70         typedef MathArray::size_type     size_type;
  71         /// type for cursor positions within a cell
  72         typedef MathArray::size_type     pos_type;
  73         /// type for cell indices
  74         typedef size_type                idx_type;
  75         /// type for row numbers
  76         typedef size_type                row_type;
  77         /// type for column numbers
  78         typedef size_type                col_type;
  79
  80         ///
  81         MathInset();
  82         /// the virtual base destructor
  83         virtual ~MathInset();
  84
  85         /// draw the object
  86         virtual void draw(Painter &, int x, int y) const;
  87         /// write LaTeX and Lyx code
  88         virtual void write(WriteStream & os) const;
  89         /// reproduce itself
  90         virtual MathInset * clone() const = 0;
  91         ///substitutes macro arguments if necessary
  92         virtual void substitute(MathMacro const & macro);
  93         /// compute the size of the object, sets ascend_, descend_ and width_
  94         virtual void metrics(MathMetricsInfo const & st) const;
  95         ///
  96         virtual int ascent() const { return 1; }
  97         ///
  98         virtual int descent() const { return 1; }
  99         ///
 100         virtual int width() const { return 2; }
 101         ///
 102         virtual int height() const;
 103
 104         /// Where should we go when we press the up cursor key?
 105         virtual bool idxUp(idx_type & idx, pos_type & pos) const;
 106         /// The down key
 107         virtual bool idxDown(idx_type & idx, pos_type & pos) const;
 108         /// The left key
 109         virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
 110         /// The right key
 111         virtual bool idxRight(idx_type & idx, pos_type & pos) const;
 112
 113         /// Move one physical cell up
 114         virtual bool idxNext(idx_type & idx, pos_type & pos) const;
 115         /// Move one physical cell down
 116         virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
 117
 118         /// Target pos when we enter the inset from the left by pressing "Right"
 119         virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
 120         /// Target pos when we enter the inset from the right by pressing "Left"
 121         virtual bool idxLast(idx_type & idx, pos_type & pos) const;
 122
 123         /// Where should we go if we press home?
 124         virtual bool idxHome(idx_type & idx, pos_type & pos) const;
 125         /// Where should we go if we press end?
 126         virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
 127
 128         /// Delete a cell and move cursor
 129         // the return value indicates whether the cursor should leave the inset
 130         // and/or the whole inset should be deleted
 131         virtual void idxDelete(idx_type & idx, bool & popit, bool & deleteit);
 132         // deletes a cell range and moves the cursor
 133         virtual void idxDeleteRange(idx_type from, idx_type to);
 134         // returns list of cell indices that are "between" from and to for
 135         // selection purposes
 136         virtual std::vector<idx_type> idxBetween(idx_type from, idx_type to) const;
 137
 138         ///
 139         virtual idx_type nargs() const;
 140
 141         ///
 142         virtual MathArray & cell(idx_type);
 143         ///
 144         virtual MathArray const & cell(idx_type) const;
 145         ///
 146         virtual MathXArray & xcell(idx_type);
 147         ///
 148         virtual MathXArray const & xcell(idx_type) const;
 149
 150         ///
 151         virtual col_type ncols() const { return 1; }
 152         ///
 153         virtual row_type nrows() const { return 1; }
 154         ///
 155         virtual col_type col(row_type) const { return 0; }
 156         ///
 157         virtual row_type row(row_type) const { return 0; }
 158         ///
 159         virtual int cellXOffset(row_type) const { return 0; }
 160         ///
 161         virtual int cellYOffset(row_type) const { return 0; }
 162         ///
 163         virtual void addRow(row_type) {}
 164         ///
 165         virtual void delRow(row_type) {}
 166         ///
 167         virtual void addCol(col_type) {}
 168         ///
 169         virtual void delCol(col_type) {}
 170
 171         ///
 172         virtual bool covers(int x, int y) const;
 173
 174         /// identifies certain types of insets
 175         virtual MathArrayInset        * asArrayInset()        { return 0; }
 176         virtual MathBoxInset          * asBoxInset()          { return 0; }
 177         virtual MathCharInset const   * asCharInset() const   { return 0; }
 178         virtual MathDelimInset        * asDelimInset()        { return 0; }
 179         virtual MathDelimInset const  * asDelimInset() const  { return 0; }
 180         virtual MathFuncInset         * asFuncInset()         { return 0; }
 181         virtual MathGridInset         * asGridInset()         { return 0; }
 182         virtual MathHullInset         * asHullInset()         { return 0; }
 183         virtual MathHullInset const   * asHullInset() const   { return 0; }
 184         virtual MathMacroTemplate     * asMacroTemplate()     { return 0; }
 185         virtual MathMatrixInset const * asMatrixInset() const { return 0; }
 186         virtual MathNestInset         * asNestInset()         { return 0; }
 187         virtual MathScriptInset       * asScriptInset()       { return 0; }
 188         virtual MathScriptInset const * asScriptInset() const { return 0; }
 189         virtual MathSpaceInset        * asSpaceInset()        { return 0; }
 190         virtual MathStringInset       * asStringInset()       { return 0; }
 191         virtual UpdatableInset   * asHyperActiveInset() const { return 0; }
 192
 193         /// identifies things that can get scripts
 194         virtual bool isScriptable() const { return false; }
 195         /// thing that can be moved into
 196         virtual bool isActive() const { return nargs() > 0; }
 197         /// identifies insets from the outer world
 198         virtual bool isHyperActive() const { return 0; }
 199         ///
 200         virtual bool isRelOp() const { return false; }
 201         ///
 202         virtual bool isMacro() const { return false; }
 203
 204         ///
 205         virtual char getChar() const { return 0; }
 206         ///
 207         virtual MathTextCodes code() const { return LM_TC_MIN; }
 208         /// identifies things that can get \limits or \nolimits
 209         virtual bool takesLimits() const { return false; }
 210
 211         ///
 212         virtual void dump() const;
 213         ///
 214         virtual void edit(BufferView *, int, int, unsigned int) {}
 215
 216         ///
 217         virtual void validate(LaTeXFeatures & features) const;
 218         ///
 219         virtual void handleFont(MathTextCodes) {}
 220
 221         /// write normalized content
 222         virtual void normalize(NormalStream &) const;
 223         ///
 224         virtual void maplize(MapleStream &) const;
 225         ///
 226         virtual void mathmlize(MathMLStream &) const;
 227         ///
 228         virtual void octavize(OctaveStream &) const;
 229 };
 230
 231 std::ostream & operator<<(std::ostream &, MathInset const &);
 232
 233 #endif