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