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