// -*- 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.
- *
- * Dependencies: Xlib, XForms
- *
- * Copyright: (c) 1996, 1997 Alejandro Aguilar Sierra
+/**
+ * \file math_inset.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Version: 0.8beta, Mathed & Lyx project.
+ * \author Alejandro Aguilar Sierra
+ * \author André Pönitz
*
- * 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 Mathed and are not derived
-// from lyx inset.
+#ifndef MATH_INSET_H
+#define MATH_INSET_H
-#ifndef __MATH_INSET__
-#define __MATH_INSET__
+#include "math_data.h"
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include <stdio.h>
-#include "math_defs.h"
-#include "symbol_def.h"
-#include "LString.h"
+#include "insets/insetbase.h"
+#include <string>
/**
- Functions or LaTeX names for objects that I don't know how to draw.
- */
-class MathFuncInset: public MathedInset {
-public:
- ///
- MathFuncInset(char const *nm, short ot=LM_OT_FUNC, short st=LM_ST_TEXT);
- ///
- ~MathFuncInset();
- ///
- MathedInset *Clone();
- ///
- void Draw(int, int);
- ///
- void Write(FILE *file);
- ///
- void Write(LString &file);
- ///
- void Metrics();
- ///
- inline bool GetLimits() const;
-protected:
- ///
- int ln;
- ///
- bool lims;
- ///
- char *fname;
-};
-
-
-/// Accents
-class MathAccentInset: public MathedInset {
- public:
- ///
- MathAccentInset(byte, MathedTextCodes, int, short st=LM_ST_TEXT);
- ///
- MathAccentInset(MathedInset *, int, short st=LM_ST_TEXT);
- ///
- ~MathAccentInset();
- ///
- MathedInset *Clone();
- ///
- void Draw(int, int);
- ///
- void Write(FILE *file);
- ///
- void Write(LString &file);
- ///
- void Metrics();
- ///
- int getAccentCode() const { return code; }
-
- protected:
- ///
- byte c;
- ///
- MathedTextCodes fn;
- ///
- int code;
- ///
- MathedInset *inset;
- ///
- int dh, dy;
-};
-
-
-///
-class MathDotsInset: public MathedInset {
- public:
- ///
- MathDotsInset(char const*,int,short st=LM_ST_TEXT);
- ///
- ~MathDotsInset() { };
- ///
- MathedInset *Clone();
- ///
- void Draw(int, int);
- ///
- void Write(FILE *file);
- ///
- void Write(LString &file);
- ///
- void Metrics();
- protected:
- ///
- int dh, code;
-};
-
-
-/// Smart spaces
-class MathSpaceInset: public MathedInset {
- public:
- ///
- MathSpaceInset(int sp, short ot=LM_OT_SPACE, short st=LM_ST_TEXT);
- ///
- ~MathSpaceInset() { };
- ///
- MathedInset *Clone();
- ///
- void Draw(int, int);
- ///
- void Write(FILE *file);
- ///
- void Write(LString &file);
- ///
- inline void Metrics();
- ///
- inline void SetSpace(int sp);
- ///
- int GetSpace() { return space; }
- protected:
- ///
- int space;
-};
-
-
-/// big operators
-class MathBigopInset: public MathedInset {
- public:
- ///
- MathBigopInset(char const*, int, short st=LM_ST_TEXT);
- ///
- ~MathBigopInset() { };
- ///
- MathedInset *Clone();
- ///
- void Draw(int, int);
- ///
- void Write(FILE *file);
- ///
- void Write(LString &file);
- ///
- void Metrics();
- ///
- inline bool GetLimits() const;
- ///
- inline void SetLimits(bool);
- protected:
- ///
- int lims;
- ///
- int sym;
-};
-
-
-//------- All editable insets must be derived from MathParInset.
-///
-class MathSqrtInset: public MathParInset {
- public:
- ///
- MathSqrtInset(short st=LM_ST_TEXT);
- ///
- ~MathSqrtInset() { };
- ///
- MathedInset *Clone();
- ///
- void Draw(int x, int baseline);
- ///
- void Write(FILE *file);
- ///
- void Write(LString &file);
- ///
- void Metrics();
- ///
- bool Inside(int, int);
-
- private:
- ///
- int hmax, wbody;
-};
-
-
-/// Fraction like objects (frac, stackrel, binom)
-class MathFracInset: public MathParInset {
- public:
- ///
- MathFracInset(short ot=LM_OT_FRAC);
- ///
- ~MathFracInset();
- ///
- MathedInset *Clone();
- ///
- void Draw(int x, int baseline);
- ///
- void Write(FILE *file);
- ///
- void Write(LString &file);
- ///
- void Metrics();
-
- /** This does the same that SetData(LyxArrayBase*) but for both
- numerator and denominator at once.
- */
- void SetData(LyxArrayBase*, LyxArrayBase*);
- ///
- void SetData(LyxArrayBase*);
- ///
- void GetXY(int& x, int& y) const;
- ///
- void SetFocus(int,int);
- ///
- bool Inside(int, int);
- ///
- LyxArrayBase * GetData();
- ///
- bool setArgumentIdx(int i); // was bool Up/down(void);
- ///
- int getArgumentIdx() { return (int)idx; }
- ///
- int getMaxArgumentIdx() { return 1; }
- ///
- void SetStyle(short);
- protected:
- ///
- short idx;
- ///
- MathParInset *den;
- ///
- int w0, w1, des0, dh;
-};
-
-
-/// A delimiter
-class MathDelimInset: public MathParInset {
- public:
- ///
- MathDelimInset(int, int, short st=LM_ST_TEXT);
- ///
- ~MathDelimInset() { };
- ///
- MathedInset *Clone();
- ///
- void Draw(int, int);
- ///
- void Write(FILE *file);
- ///
- void Write(LString &file);
- ///
- void Metrics();
- protected:
- ///
- int left, right;
- ///
- int dw, dh;
-};
-
-
-/// Decorations over (below) a math object
-class MathDecorationInset: public MathParInset {
- public:
- ///
- MathDecorationInset(int, short st=LM_ST_TEXT);
- ///
- ~MathDecorationInset() { };
- ///
- MathedInset *Clone();
- ///
- void Draw(int, int);
- ///
- void Write(FILE *file);
- ///
- void Write(LString &file);
- ///
- void Metrics();
- ///
- inline bool GetLimits() const;
- protected:
- ///
- int deco;
- ///
- bool upper;
- ///
- int dw, dh, dy;
+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.
+
+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 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; }
+
+ /// identifies things that can get scripts
+ virtual bool isScriptable() const { return false; }
+ /// 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) {}
+
+ /// 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;
+
+ /// 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 &, MathAtom const &);
-// -------------------- Inline functions ---------------------
-
-
-inline
-MathFuncInset::~MathFuncInset()
-{
- if (fname && GetType()==LM_OT_UNDEF) delete[] fname;
-}
-
-inline
-bool MathFuncInset::GetLimits() const
-{
- return (bool)(lims && (GetStyle()==LM_ST_DISPLAY));
-}
-
-inline
-void MathFuncInset::Write(FILE *file)
-{
- fprintf(file, "\\%s ", name);
-}
-
-inline
-void MathFuncInset::Write(LString &file)
-{
- file += '\\';
- file += name;
- file += ' ';
-}
-
-inline
-void MathSpaceInset::Metrics()
-{
- width = (space) ? space*2: 2;
- if (space>3) width *= 2;
- if (space==5) width *= 2;
- width += 4;
- ascent = 4; descent = 0;
-}
-
-inline
-void MathSpaceInset::SetSpace(int sp)
-{
- space = sp;
- Metrics();
-}
-
-inline
-bool MathBigopInset::GetLimits() const
-{
- // Default case
- if (lims<0) {
- return (bool)(sym!=LM_int && sym!=LM_oint && (GetStyle()==LM_ST_DISPLAY));
- }
-
- // Custom
- return (bool)(lims>0);
-}
-
-inline
-void MathBigopInset::SetLimits(bool ls)
-{
- lims = (ls) ? 1: 0;
-}
-
-inline
-bool MathDecorationInset::GetLimits() const
-{
- return (bool)(deco==LM_underbrace||deco==LM_overbrace);
-}
-
+// initialize math
+void initMath();
#endif
-
projects / lyx.git / blobdiff