// -*- C++ -*-
-/*
- * File: math_inset.h
- * Purpose: Declaration of insets for mathed
- * Author: Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
- * Created: January 1996
- * Description: Math paragraph and objects for a WYSIWYG math editor.
+/**
+ * \file math_inset.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Dependencies: Xlib, XForms
+ * \author Alejandro Aguilar Sierra
+ * \author André Pönitz
*
- * Copyright: 1996, 1997 Alejandro Aguilar Sierra
- *
- * Version: 0.8beta, Math & Lyx project.
- *
- * You are free to use and modify this code under the terms of
- * the GNU General Public Licence version 2 or later.
+ * Full author contact details are available in file CREDITS.
*/
-// Note: These math insets are internal to Math and are not derived
-// from lyx inset.
-
#ifndef MATH_INSET_H
#define MATH_INSET_H
-#include <config.h>
+#include "math_data.h"
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "insets/insetbase.h"
-#include "symbol_def.h"
-#include "xarray.h"
+#include <string>
-/** Abstract base class for all math objects.
- A math insets is for use of the math editor only, it isn't a
- general LyX inset. It's used to represent all the math objects.
- The formulaInset (a LyX inset) encapsulates a math inset.
-*/
+/**
+Abstract base class for all math objects. A math insets is for use of the
+math editor only, it isn't a general LyX inset. It's used to represent all
+the math objects.
-class LaTeXFeatures;
+Math insets do not know there parents, a cursor position or things
+like that. The are dumb object that are contained in other math insets
+(MathNestInsets, in fact) thus forming a tree. The root of this tree is
+always a MathHullInset, which provides an interface to the Outer World by
+inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
-class MathInset {
-public:
- ///
- MathInset();
+*/
- /// the virtual base destructor
- virtual ~MathInset() {}
+class OutputParams;
+class MathArrayInset;
+class MathAMSArrayInset;
+class MathBraceInset;
+class MathCharInset;
+class MathDelimInset;
+class MathFracInset;
+class MathFontInset;
+class MathGridInset;
+class MathHullInset;
+class MathMatrixInset;
+class MathNestInset;
+class MathParboxInset;
+class MathScriptInset;
+class MathStringInset;
+class MathSpaceInset;
+class MathSymbolInset;
+class MathUnknownInset;
+
+class RefInset;
+
+class NormalStream;
+class OctaveStream;
+class MapleStream;
+class MaximaStream;
+class MathematicaStream;
+class MathMLStream;
+class WriteStream;
+class InfoStream;
+
+class MathMacroTemplate;
+class MathMacro;
+class MathPosFinder;
+class Dimension;
+class LCursor;
+class TextPainter;
+class TextMetricsInfo;
+class ReplaceData;
+
+
+class MathInset : public InsetBase {
+public:
+ /// identification as math inset
+ MathInset * asMathInset() { return this; }
+ /// this is overridden in math text insets (i.e. mbox)
+ bool inMathed() const { return true; }
+
+ /// the ascent of the inset above the baseline
+ /// compute the size of the object for text based drawing
+ virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
+ /// draw the object as text
+ virtual void drawT(TextPainter &, int x, int y) const;
+
+ /// return cell given its number
+ virtual MathArray & cell(idx_type);
+ /// return cell given its number
+ virtual MathArray const & cell(idx_type) const;
+
+ /// identifies certain types of insets
+ virtual MathAMSArrayInset * asAMSArrayInset() { return 0; }
+ virtual MathAMSArrayInset const * asAMSArrayInset() const { return 0; }
+ virtual MathArrayInset * asArrayInset() { return 0; }
+ virtual MathArrayInset const * asArrayInset() const { return 0; }
+ virtual MathBraceInset const * asBraceInset() const { return 0; }
+ virtual MathCharInset const * asCharInset() const { return 0; }
+ virtual MathDelimInset * asDelimInset() { return 0; }
+ virtual MathDelimInset const * asDelimInset() const { return 0; }
+ virtual MathFracInset * asFracInset() { return 0; }
+ virtual MathFracInset const * asFracInset() const { return 0; }
+ virtual MathFontInset * asFontInset() { return 0; }
+ virtual MathFontInset const * asFontInset() const { return 0; }
+ virtual MathGridInset * asGridInset() { return 0; }
+ virtual MathGridInset const * asGridInset() const { return 0; }
+ virtual MathHullInset * asHullInset() { return 0; }
+ virtual MathHullInset const * asHullInset() const { return 0; }
+ virtual MathMacro * asMacro() { return 0; }
+ virtual MathMacro const * asMacro() const { return 0; }
+ virtual MathMacroTemplate * asMacroTemplate() { return 0; }
+ virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
+ virtual MathMatrixInset const * asMatrixInset() const { return 0; }
+ virtual MathNestInset * asNestInset() { return 0; }
+ virtual MathNestInset const * asNestInset() const { return 0; }
+ virtual MathParboxInset * asParboxInset() { return 0; }
+ virtual MathScriptInset * asScriptInset() { return 0; }
+ virtual MathScriptInset const * asScriptInset() const { return 0; }
+ virtual MathSpaceInset * asSpaceInset() { return 0; }
+ virtual MathSpaceInset const * asSpaceInset() const { return 0; }
+ virtual MathStringInset * asStringInset() { return 0; }
+ virtual MathStringInset const * asStringInset() const { return 0; }
+ virtual MathSymbolInset const * asSymbolInset() const { return 0; }
+ virtual MathUnknownInset * asUnknownInset() { return 0; }
+ virtual MathUnknownInset const * asUnknownInset() const { return 0; }
+ virtual RefInset * asRefInset() { return 0; }
- /// draw the object, sets xo_ and yo_ cached values
- virtual void draw(Painter &, int x, int y) const;
- /// write LaTeX and Lyx code
- virtual void write(std::ostream &, bool fragile) const;
- /// write normalized content
- virtual void writeNormal(std::ostream &) const;
- /// reproduce itself
- virtual MathInset * clone() const = 0;
- /// appends itself with macro arguments substituted
- virtual void substitute(MathArray & array, MathMacro const & macro) const;
- /// compute the size of the object, sets ascend_, descend_ and width_
- virtual void metrics(MathStyles st) const;
- ///
- virtual int ascent() const { return 1; }
- ///
- virtual int descent() const { return 1; }
- ///
- virtual int width() const { return 2; }
- ///
- virtual int height() const;
- ///
- virtual MathStyles size() const;
-
- /// Where should we go when we press the up cursor key?
- virtual bool idxUp(int & idx, int & pos) const;
- /// The down key
- virtual bool idxDown(int & idx, int & pos) const;
- /// The left key
- virtual bool idxLeft(int & idx, int & pos) const;
- /// The right key
- virtual bool idxRight(int & idx, int & pos) const;
-
- /// Move one physical cell up
- virtual bool idxNext(int & idx, int & pos) const;
- /// Move one physical cell down
- virtual bool idxPrev(int & idx, int & pos) const;
-
- /// Target pos when we enter the inset from the left by pressing "Right"
- virtual bool idxFirst(int & idx, int & pos) const;
- /// Target pos when we enter the inset from the left by pressing "Up"
- virtual bool idxFirstUp(int & idx, int & pos) const;
- /// Target pos when we enter the inset from the left by pressing "Down"
- virtual bool idxFirstDown(int & idx, int & pos) const;
-
- /// Target pos when we enter the inset from the right by pressing "Left"
- virtual bool idxLast(int & idx, int & pos) const;
- /// Target pos when we enter the inset from the right by pressing "Up"
- virtual bool idxLastUp(int & idx, int & pos) const;
- /// Target pos when we enter the inset from the right by pressing "Down"
- virtual bool idxLastDown(int & idx, int & pos) const;
-
- /// Where should we go if we press home?
- virtual bool idxHome(int & idx, int & pos) const;
- /// Where should we go if we press end?
- virtual bool idxEnd(int & idx, int & pos) const;
-
- /// Delete a cell and move cursor
- // the return value indicates whether the cursor should leave the inset
- // and/or the whole inset should be deleted
- virtual void idxDelete(int & idx, bool & popit, bool & deleteit);
- // deletes a cell range and moves the cursor
- virtual void idxDeleteRange(int from, int to);
- // returns list of cell indices that are "between" from and to for
- // selection purposes
- virtual std::vector<int> idxBetween(int from, int to) const;
-
- ///
- virtual int nargs() const;
-
- ///
- virtual MathArray & cell(int);
- ///
- virtual MathArray const & cell(int) const;
- ///
- virtual MathXArray & xcell(int);
- ///
- virtual MathXArray const & xcell(int) const;
-
- ///
- virtual int xo() const;
- ///
- virtual int yo() const;
- ///
- virtual void xo(int tx) const;
- ///
- virtual void yo(int ty) const;
- ///
-
- ///
- virtual int ncols() const { return 1; }
- ///
- virtual int nrows() const { return 1; }
- ///
- virtual int col(int) const { return 0; }
- ///
- virtual int row(int) const { return 0; }
- ///
- virtual int cellXOffset(int) const { return 0; }
- ///
- virtual int cellYOffset(int) const { return 0; }
- ///
- virtual void addRow(int) {}
- ///
- virtual void delRow(int) {}
- ///
- virtual void addCol(int) {}
- ///
- virtual void delCol(int) {}
-
- ///
- virtual void userSetSize(MathStyles &) {}
-
- ///
- virtual void getXY(int & x, int & y) const;
- ///
- virtual bool covers(int x, int y) const;
/// identifies things that can get scripts
virtual bool isScriptable() const { return false; }
- /// identifies ScriptInsets
- virtual bool isScriptInset() const { return false; }
- /// identifies SpaceInsets
- virtual bool isSpaceInset() const { return false; }
- /// identifies GridInsets
- virtual bool isGrid() const { return false; }
- /// identifies ArrayInsets
- virtual bool isArray() const { return false; }
- /// identifies Charinsets
- virtual bool isCharInset() const { return false; }
- ///
- virtual bool isActive() const { return nargs() > 0; }
- ///
+ /// is the a relational operator (used for splitting equations)
virtual bool isRelOp() const { return false; }
- ///
+ /// will this get written as a single block in {..}
+ virtual bool extraBraces() const { return false; }
+
+ /// return the content as char if the inset is able to do so
virtual char getChar() const { return 0; }
+ /// identifies things that can get \limits or \nolimits
+ virtual bool takesLimits() const { return false; }
+
+ /// char char code if possible
+ virtual void handleFont(std::string const &) {}
+ /// replace things by other things
+ virtual void replace(ReplaceData &) {}
+ /// do we contain a given subsequence?
+ virtual bool contains(MathArray const &) const { return false; }
+ /// access to the lock (only nest array have one)
+ virtual bool lock() const { return false; }
+ /// access to the lock (only nest array have one)
+ virtual void lock(bool) {}
- ///
- virtual void push_back(MathInset *);
- ///
- virtual void push_back(unsigned char ch, MathTextCodes fcode);
- ///
+ /// write LaTeX and Lyx code
+ virtual void write(WriteStream & os) const;
+ /// write normalized content
+ virtual void normalize(NormalStream &) const;
+ /// write content as something readable by Maple
+ virtual void maple(MapleStream &) const;
+ /// write content as something readable by Maxima
+ virtual void maxima(MaximaStream &) const;
+ /// write content as something readable by Mathematica
+ virtual void mathematica(MathematicaStream &) const;
+ /// write content as something resembling MathML
+ virtual void mathmlize(MathMLStream &) const;
+ /// write content as something readable by Octave
+ virtual void octave(OctaveStream &) const;
+
+ /// dump content to stderr for debugging
virtual void dump() const;
- ///
- virtual void validate(LaTeXFeatures & features) const;
- ///
- virtual void handleFont(MathTextCodes) {}
-
- ///
- static int workwidth;
-
-protected:
- /// _sets_ style
- void size(MathStyles s) const;
- /// the used font size
- mutable MathStyles size_;
-
-private:
- /// the following are used for positioning the cursor with the mouse
- /// cached cursor start position in pixels from the document left
- mutable int xo_;
- /// cached cursor start position in pixels from the document top
- mutable int yo_;
+ /// LyXInset stuff
+ virtual bool numberedType() const { return false; }
+ /// hull type
+ virtual std::string const & getType() const;
+ /// change type
+ virtual void mutate(std::string const &) {}
+ /// usually the latex name
+ virtual std::string name() const;
+
+ /// math stuff usually isn't allowed in text mode
+ virtual bool allowedIn(mode_type mode) const { return mode == MATH_MODE; }
};
-std::ostream & operator<<(std::ostream &, MathInset const &);
+std::ostream & operator<<(std::ostream &, MathAtom const &);
+
+// initialize math
+void initMath();
#endif
projects / lyx.git / blobdiff