]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/math_inset.h
float2string #4 (Spacing)
[lyx.git] / src / mathed / math_inset.h
index d292e53ac6967c01a554ad2d92887f780d4e120f..d2b26bc21ac82413efc24c6732f8ebc3933b5fc6 100644 (file)
 // -*- 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, Mathed & 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 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 "insets/insetbase.h"
+
+#include <string>
+
+/**
 
-#include "LString.h"
-#include "symbol_def.h"
+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 Painter;
+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.
 
-/** 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.
 */
-class MathedInset {
-public: 
-       /** A math inset has a name (usually its LaTeX name),
-           type and font-size
-       */
-       MathedInset(string const & nm, short ot, short st);
-       /// The virtual base destructor
-       virtual ~MathedInset() {}
-       /// Draw the object
-       virtual void draw(Painter &, int x, int baseline) = 0;  
-       /// Write LaTeX and Lyx code
-       virtual void Write(std::ostream &, bool fragile) = 0;
-       /// Reproduces itself
-       virtual MathedInset * Clone() = 0;
-       /// Compute the size of the object
-       virtual void Metrics() = 0; 
-       /// 
-       virtual int Ascent() const;
-       ///
-       virtual int Descent() const;
-       ///
-       virtual int Width() const;
-       ///
-       virtual int Height() const;
-       ///
-       virtual bool GetLimits() const;
-       ///
-       virtual void SetLimits(bool);
-       ///
-       string const & GetName() const;
-       ///
-       short GetType() const;
-       ///
-       short GetStyle() const;
-       //Man:  Avoid to use these functions if it's not strictly necessary 
-       ///
-       virtual void  SetType(short t);
-       ///
-       virtual void  SetStyle(short st);
-       ///
-       virtual void  SetName(string const & n);
-       ///
-       static int workWidth;
-       ///
-       static void defaultAscent(int da);
-       ///
-       static void defaultDescent(int dd);
-       ///
-       static void defaultWidth(int dw);
-       ///
-       short size() const;
-protected:
-       ///
-       string name;
-       ///
-       short objtype;
-       ///
-       int width;
-       ///
-       int ascent;
-       ///
-       int descent;
-       /// Default metrics
-       static int df_asc;
-       ///
-       static int df_des;
-       ///
-       static int df_width;
-       /// In a near future maybe we use a better fonts renderer than X
-       void drawStr(Painter &, short, int, int, int, string const &);
-       ///
-       void size(short s);
-       ///
-       void incSize();
-private:
-       ///
-       short size_;
-};
+
+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;
 
 
-inline
-short MathedInset::size() const
-{
-       return size_;
-}
+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; }
+};
 
-inline
-void MathedInset::size(short s)
-{
-       size_ = s;
-}
+std::ostream & operator<<(std::ostream &, MathAtom const &);
 
+// initialize math
+void initMath();
 
-inline
-void MathedInset::incSize()
-{
-       ++size_;
-}
 #endif