src/mathed/math_inset.h

   1 // -*- C++ -*-
   2 /**
   3  * \file math_inset.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alejandro Aguilar Sierra
   8  * \author André Pönitz
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef MATH_INSET_H
  14 #define MATH_INSET_H
  15
  16 #include "cursor_slice.h"
  17 #include "insets/insetbase.h"
  18
  19 #include <string>
  20
  21 /**
  22
  23 Abstract base class for all math objects.  A math insets is for use of the
  24 math editor only, it isn't a general LyX inset. It's used to represent all
  25 the math objects.
  26
  27 Math insets do not know there parents, a cursor position or things
  28 like that. The are dumb object that are contained in other math insets
  29 (MathNestInsets, in fact) thus forming a tree. The root of this tree is
  30 always a MathHullInset, which provides an interface to the Outer World by
  31 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
  32
  33 */
  34
  35 class OutputParams;
  36 class MathArrayInset;
  37 class MathAMSArrayInset;
  38 class MathCharInset;
  39 class MathDelimInset;
  40 class MathFracInset;
  41 class MathFontInset;
  42 class MathGridInset;
  43 class MathHullInset;
  44 class MathMatrixInset;
  45 class MathNestInset;
  46 class MathParboxInset;
  47 class MathScriptInset;
  48 class MathStringInset;
  49 class MathSpaceInset;
  50 class MathSymbolInset;
  51 class MathUnknownInset;
  52
  53 class RefInset;
  54
  55 class MathArray;
  56 class MathAtom;
  57
  58 class NormalStream;
  59 class OctaveStream;
  60 class MapleStream;
  61 class MaximaStream;
  62 class MathematicaStream;
  63 class MathMLStream;
  64 class WriteStream;
  65 class InfoStream;
  66
  67 class BufferView;
  68 class UpdatableInset;
  69 class MathMacroTemplate;
  70 class MathMacro;
  71 class MathPosFinder;
  72 class Dimension;
  73 class FuncRequest;
  74 class TextPainter;
  75 class TextMetricsInfo;
  76 class ReplaceData;
  77
  78
  79 class MathInset : public InsetBase {
  80 public:
  81         /// our members behave nicely...
  82         MathInset() {}
  83         /// identification as math inset
  84         MathInset * asMathInset() { return this; }
  85
  86         /// substitutes macro arguments if necessary
  87         virtual void substitute(MathMacro const & macro);
  88         /// draw selection between two positions
  89         virtual void drawSelection(PainterInfo & pi,
  90                 idx_type idx1, pos_type pos1, idx_type idx2, pos_type pos2) const;
  91         /// the ascent of the inset above the baseline
  92         /// compute the size of the object for text based drawing
  93         virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
  94         /// draw the object as text
  95         virtual void drawT(TextPainter &, int x, int y) const;
  96
  97         /// Where should we go when we press the up or down cursor key?
  98         virtual bool idxUpDown(BufferView & bv, bool up, int targetx) const;
  99         /// Where should we go when we press the up or down cursor key?
 100         virtual bool idxUpDown2(BufferView & bv, bool up, int targetx) const;
 101         /// The left key
 102         virtual bool idxLeft(BufferView & bv) const;
 103         /// The right key
 104         virtual bool idxRight(BufferView & bv) const;
 105
 106         /// Move one physical cell up
 107         virtual bool idxNext(BufferView & bv) const;
 108         /// Move one physical cell down
 109         virtual bool idxPrev(BufferView & bv) const;
 110
 111         /// Target pos when we enter the inset from the left by pressing "Right"
 112         virtual bool idxFirst(BufferView & bv) const;
 113         /// Target pos when we enter the inset from the right by pressing "Left"
 114         virtual bool idxLast(BufferView & bv) const;
 115
 116         /// Where should we go if we press home?
 117         virtual bool idxHome(BufferView & bv) const;
 118         /// Where should we go if we press end?
 119         virtual bool idxEnd(BufferView & bv) const;
 120
 121         /// Delete a cell and move cursor
 122         virtual bool idxDelete(idx_type &) { return false; }
 123         /// pulls cell after pressing erase
 124         virtual void idxGlue(idx_type) {}
 125         // returns list of cell indices that are "between" from and to for
 126         // selection purposes
 127         virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
 128
 129         /// the number of nested cells this inset owns
 130         virtual idx_type nargs() const;
 131
 132         /// return cell given its number
 133         virtual MathArray & cell(idx_type);
 134         /// return cell given its number
 135         virtual MathArray const & cell(idx_type) const;
 136
 137         /// the number of columns of this inset if it is grid-like
 138         virtual col_type ncols() const { return 1; }
 139         /// the number of rows of this inset if it is grid-like
 140         virtual row_type nrows() const { return 1; }
 141         /// to which column belongs a cell with a given index?
 142         virtual col_type col(idx_type) const { return 0; }
 143         /// to which row belongs a cell with a given index?
 144         virtual row_type row(idx_type) const { return 0; }
 145         /// cell idex corresponding to row and column;
 146         virtual idx_type index(row_type row, col_type col) const;
 147         /// any additional x-offset when drawing a cell?
 148         virtual int cellXOffset(idx_type) const { return 0; }
 149         /// any additional y-offset when drawing a cell?
 150         virtual int cellYOffset(idx_type) const { return 0; }
 151         /// can we enter this cell?
 152         virtual bool validCell(idx_type) const { return true; }
 153         /// get coordinates
 154         virtual void getScreenPos(idx_type idx, pos_type pos, int & x, int & y) const;
 155
 156         /// identifies certain types of insets
 157         virtual MathAMSArrayInset       * asAMSArrayInset()       { return 0; }
 158         virtual MathAMSArrayInset const * asAMSArrayInset() const { return 0; }
 159         virtual MathArrayInset          * asArrayInset()          { return 0; }
 160         virtual MathArrayInset const    * asArrayInset() const    { return 0; }
 161         virtual MathCharInset const     * asCharInset() const     { return 0; }
 162         virtual MathDelimInset          * asDelimInset()          { return 0; }
 163         virtual MathDelimInset const    * asDelimInset() const    { return 0; }
 164         virtual MathFracInset           * asFracInset()           { return 0; }
 165         virtual MathFracInset const     * asFracInset() const     { return 0; }
 166         virtual MathFontInset           * asFontInset()           { return 0; }
 167         virtual MathFontInset const     * asFontInset() const     { return 0; }
 168         virtual MathGridInset           * asGridInset()           { return 0; }
 169         virtual MathGridInset const     * asGridInset() const     { return 0; }
 170         virtual MathHullInset           * asHullInset()           { return 0; }
 171         virtual MathHullInset const     * asHullInset() const     { return 0; }
 172         virtual MathMacroTemplate       * asMacroTemplate()       { return 0; }
 173         virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
 174         virtual MathMatrixInset const   * asMatrixInset() const   { return 0; }
 175         virtual MathNestInset           * asNestInset()           { return 0; }
 176         virtual MathNestInset const     * asNestInset() const     { return 0; }
 177         virtual MathParboxInset         * asParboxInset()         { return 0; }
 178         virtual MathScriptInset         * asScriptInset()         { return 0; }
 179         virtual MathScriptInset const   * asScriptInset() const   { return 0; }
 180         virtual MathSpaceInset          * asSpaceInset()          { return 0; }
 181         virtual MathSpaceInset const    * asSpaceInset() const    { return 0; }
 182         virtual MathStringInset         * asStringInset()         { return 0; }
 183         virtual MathStringInset const   * asStringInset() const   { return 0; }
 184         virtual MathSymbolInset const   * asSymbolInset() const   { return 0; }
 185         virtual MathUnknownInset        * asUnknownInset()        { return 0; }
 186         virtual MathUnknownInset const  * asUnknownInset() const  { return 0; }
 187         virtual RefInset                * asRefInset()            { return 0; }
 188
 189         /// identifies things that can get scripts
 190         virtual bool isScriptable() const { return false; }
 191         /// thing that can be moved into
 192         virtual bool isActive() const { return nargs() > 0; }
 193         /// is the a relational operator (used for splitting equations)
 194         virtual bool isRelOp() const { return false; }
 195         /// -1: text mode, 1: math mode, 0 undecided
 196         enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
 197
 198         virtual mode_type currentMode() const { return UNDECIDED_MODE; }
 199         /// will this get written as a single block in {..}
 200         virtual bool extraBraces() const { return false; }
 201
 202         /// return the content as char if the inset is able to do so
 203         virtual char getChar() const { return 0; }
 204         /// identifies things that can get \limits or \nolimits
 205         virtual bool takesLimits() const { return false; }
 206
 207         /// char char code if possible
 208         virtual void handleFont(std::string const &) {}
 209         /// replace things by other things
 210         virtual void replace(ReplaceData &) {}
 211         /// do we contain a given subsequence?
 212         virtual bool contains(MathArray const &) const { return false; }
 213         /// access to the lock (only nest array have one)
 214         virtual bool lock() const { return false; }
 215         /// access to the lock (only nest array have one)
 216         virtual void lock(bool) {}
 217         /// get notification when the cursor leaves this inset
 218         virtual void notifyCursorLeaves(idx_type) {}
 219
 220         /// write LaTeX and Lyx code
 221         virtual void write(WriteStream & os) const;
 222         /// write normalized content
 223         virtual void normalize(NormalStream &) const;
 224         /// write content as something readable by Maple
 225         virtual void maple(MapleStream &) const;
 226         /// write content as something readable by Maxima
 227         virtual void maxima(MaximaStream &) const;
 228         /// write content as something readable by Mathematica
 229         virtual void mathematica(MathematicaStream &) const;
 230         /// write content as something resembling MathML
 231         virtual void mathmlize(MathMLStream &) const;
 232         /// write content as something readable by Octave
 233         virtual void octave(OctaveStream &) const;
 234         /// describe content if cursor inside
 235         virtual void infoize(std::ostream &) const {}
 236         /// describe content if cursor behind
 237         virtual void infoize2(std::ostream &) const {}
 238         /// plain ascii output
 239         virtual int plaintext(std::ostream & os, OutputParams const &) const;
 240         /// linuxdoc output
 241         virtual int linuxdoc(std::ostream & os, OutputParams const &) const;
 242         /// docbook output
 243         virtual int docbook(std::ostream & os, OutputParams const &) const;
 244
 245         /// dump content to stderr for debugging
 246         virtual void dump() const;
 247
 248         /// LyXInset stuff
 249         virtual bool numberedType() const { return false; }
 250         /// hull type
 251         virtual std::string const & getType() const;
 252         /// change type
 253         virtual void mutate(std::string const &) {}
 254         /// how is the inset called in the .lyx file?
 255         virtual std::string fileInsetLabel() const;
 256         /// usually the latex name
 257         virtual std::string name() const;
 258 };
 259
 260 std::ostream & operator<<(std::ostream &, MathAtom const &);
 261
 262 // initialize math
 263 void initMath();
 264
 265 #endif