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