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 /**
  35
  36 Abstract base class for all math objects.  A math insets is for use of the
  37 math editor only, it isn't a general LyX inset. It's used to represent all
  38 the math objects.
  39
  40 Math insets do not know there parents, a cursor position or things
  41 like that. The are dumb object that are contained in other math insets
  42 (mathNestInsets, in fact) thus forming a tree. The root of this tree is
  43 always a mathHullInset, which provides an interface to the Outer World by
  44 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
  45
  46 */
  47
  48
  49 class MathArrayInset;
  50 class MathBoxInset;
  51 class MathCharInset;
  52 class MathDelimInset;
  53 class MathFuncInset;
  54 class MathGridInset;
  55 class MathFracInset;
  56 class MathHullInset;
  57 class MathMatrixInset;
  58 class MathNestInset;
  59 class MathScriptInset;
  60 class MathStringInset;
  61 class MathSpaceInset;
  62 class MathSymbolInset;
  63
  64 class NormalStream;
  65 class OctaveStream;
  66 class MapleStream;
  67 class MathMLStream;
  68 class WriteStream;
  69 class MathArray;
  70
  71 class LaTeXFeatures;
  72 class BufferView;
  73 class UpdatableInset;
  74 class MathMacroTemplate;
  75 class MathPosFinder;
  76
  77
  78 class MathInset {
  79 public:
  80         /// short of anything else reasonable
  81         typedef MathArray::size_type        size_type;
  82         /// type for cursor positions differences within a cell
  83         typedef MathArray::difference_type  difference_type;
  84         /// type for cursor positions within a cell
  85         typedef MathArray::size_type        pos_type;
  86         /// type for cell indices
  87         typedef size_type                   idx_type;
  88         /// type for row numbers
  89         typedef size_type                   row_type;
  90         /// type for column numbers
  91         typedef size_type                   col_type;
  92
  93         /// our members behave nicely...
  94         MathInset() {}
  95         /// the virtual base destructor
  96         virtual ~MathInset() {}
  97
  98         /// draw the object
  99         virtual void draw(Painter &, int x, int y) const;
 100         /// write LaTeX and Lyx code
 101         virtual void write(WriteStream & os) const;
 102         /// reproduce itself
 103         virtual MathInset * clone() const = 0;
 104         /// substitutes macro arguments if necessary
 105         virtual void substitute(MathMacro const & macro);
 106         /// compute the size of the object, sets ascend_, descend_ and width_
 107         // updates the (xo,yo)-caches of all contained cells
 108         virtual void metrics(MathMetricsInfo const & st) const;
 109         /// the ascent of the inset above the baseline
 110         virtual int ascent() const { return 1; }
 111         /// the descent of the inset below the baseline
 112         virtual int descent() const { return 1; }
 113         /// total width
 114         virtual int width() const { return 2; }
 115         /// total height (== ascent + descent)
 116         virtual int height() const;
 117
 118         /// Where should we go when we press the up cursor key?
 119         virtual bool idxUp(idx_type & idx) const;
 120         /// The down key
 121         virtual bool idxDown(idx_type & idx) const;
 122         /// The left key
 123         virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
 124         /// The right key
 125         virtual bool idxRight(idx_type & idx, pos_type & pos) const;
 126
 127         /// Move one physical cell up
 128         virtual bool idxNext(idx_type & idx, pos_type & pos) const;
 129         /// Move one physical cell down
 130         virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
 131
 132         /// Target pos when we enter the inset from the left by pressing "Right"
 133         virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
 134         /// Target pos when we enter the inset from the right by pressing "Left"
 135         virtual bool idxLast(idx_type & idx, pos_type & pos) const;
 136
 137         /// Where should we go if we press home?
 138         virtual bool idxHome(idx_type & idx, pos_type & pos) const;
 139         /// Where should we go if we press end?
 140         virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
 141
 142         /// Delete a cell and move cursor
 143         // the return value indicates whether the cursor should leave the inset
 144         // and/or the whole inset should be deleted
 145         virtual void idxDelete(idx_type & idx, bool & popit, bool & deleteit);
 146         // deletes a cell range and moves the cursor
 147         virtual void idxDeleteRange(idx_type from, idx_type to);
 148         // returns list of cell indices that are "between" from and to for
 149         // selection purposes
 150         virtual std::vector<idx_type> idxBetween(idx_type from, idx_type to) const;
 151
 152         /// the number of nested cells this inset owns
 153         virtual idx_type nargs() const;
 154
 155         /// return cell given its number
 156         virtual MathArray & cell(idx_type);
 157         /// return cell given its number
 158         virtual MathArray const & cell(idx_type) const;
 159         /// return cell plus drawing cache given its number
 160         virtual MathXArray & xcell(idx_type);
 161         /// return cell plus drawing cache given its number
 162         virtual MathXArray const & xcell(idx_type) const;
 163
 164         /// the number of columns of this inset if it is grid-like
 165         virtual col_type ncols() const { return 1; }
 166         /// the number of rows of this inset if it is grid-like
 167         virtual row_type nrows() const { return 1; }
 168         /// to which column belongs a cell with a given index?
 169         virtual col_type col(idx_type) const { return 0; }
 170         /// to which row belongs a cell with a given index?
 171         virtual row_type row(idx_type) const { return 0; }
 172         /// cell idex corresponding to row and column;
 173         virtual idx_type index(row_type row, col_type col) const;
 174         /// any additional x-offset when drawing a cell?
 175         virtual int cellXOffset(idx_type) const { return 0; }
 176         /// any additional y-offset when drawing a cell?
 177         virtual int cellYOffset(idx_type) const { return 0; }
 178
 179         /// identifies certain types of insets
 180         virtual MathArrayInset        * asArrayInset()        { return 0; }
 181         virtual MathBoxInset          * asBoxInset()          { return 0; }
 182         virtual MathBoxInset const    * asBoxInset() const    { return 0; }
 183         virtual MathCharInset const   * asCharInset() const   { return 0; }
 184         virtual MathDelimInset        * asDelimInset()        { return 0; }
 185         virtual MathDelimInset const  * asDelimInset() const  { return 0; }
 186         virtual MathFuncInset         * asFuncInset()         { return 0; }
 187         virtual MathFracInset         * asFracInset()         { return 0; }
 188         virtual MathGridInset         * asGridInset()         { return 0; }
 189         virtual MathHullInset         * asHullInset()         { return 0; }
 190         virtual MathHullInset const   * asHullInset() const   { return 0; }
 191         virtual MathMacroTemplate     * asMacroTemplate()     { return 0; }
 192         virtual MathMatrixInset const * asMatrixInset() const { return 0; }
 193         virtual MathNestInset         * asNestInset()         { return 0; }
 194         virtual MathScriptInset       * asScriptInset()       { return 0; }
 195         virtual MathScriptInset const * asScriptInset() const { return 0; }
 196         virtual MathSpaceInset        * asSpaceInset()        { return 0; }
 197         virtual MathStringInset       * asStringInset()       { return 0; }
 198         virtual MathSymbolInset const * asSymbolInset() const { return 0; }
 199         virtual UpdatableInset   * asHyperActiveInset() const { return 0; }
 200
 201         /// identifies things that can get scripts
 202         virtual bool isScriptable() const { return false; }
 203         /// thing that can be moved into
 204         virtual bool isActive() const { return nargs() > 0; }
 205         /// identifies insets from the outer world
 206         virtual bool isHyperActive() const { return 0; }
 207         /// is the a relational operator (used for splitting equations)
 208         virtual bool isRelOp() const { return false; }
 209
 210         /// return the content as char if the inset is able to do so
 211         virtual char getChar() const { return 0; }
 212         /// return the content's char code if it has one
 213         virtual MathTextCodes code() const { return LM_TC_MIN; }
 214         /// identifies things that can get \limits or \nolimits
 215         virtual bool takesLimits() const { return false; }
 216
 217         ///
 218         virtual void edit(BufferView *, int, int, unsigned int) {}
 219
 220         /// request "external features"
 221         virtual void validate(LaTeXFeatures & features) const;
 222         /// char char code if possible
 223         virtual void handleFont(MathTextCodes) {}
 224         /// is this inset equal to a given other inset?
 225         virtual bool match(MathInset *) const { return false; }
 226         /// replace things by other things
 227         virtual void replace(ReplaceData &) {}
 228
 229         /// write normalized content
 230         virtual void normalize(NormalStream &) const;
 231         /// write content as something readable by Maple
 232         virtual void maplize(MapleStream &) const;
 233         /// write content as something resembling MathML
 234         virtual void mathmlize(MathMLStream &) const;
 235         /// write content as something readable by Octave
 236         virtual void octavize(OctaveStream &) const;
 237
 238         /// dump content to stderr for debugging
 239         virtual void dump() const;
 240 };
 241
 242 std::ostream & operator<<(std::ostream &, MathInset const &);
 243
 244 #endif