src/mathed/math_macro.h

   1 // -*- C++ -*-
   2 /**
   3  * \file math_macro.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_MACRO_H
  14 #define MATH_MACRO_H
  15
  16 #include "math_nestinset.h"
  17 #include "math_data.h"
  18 #include "math_nestinset.h"
  19 #include "math_macrotable.h"
  20
  21
  22 /// This class contains the data for a macro.
  23 class MathMacro : public MathNestInset {
  24 public:
  25         /// A macro can be built from an existing template
  26         MathMacro(std::string const & name, int numargs);
  27         ///
  28         void draw(PainterInfo & pi, int x, int y) const;
  29         ///
  30         void drawExpanded(PainterInfo & pi, int x, int y) const;
  31         /// draw selection background
  32         void drawSelection(PainterInfo & pi, int x, int y) const;
  33         ///
  34         void metrics(MetricsInfo & mi, Dimension & dim) const;
  35         /// get cursor position
  36         void cursorPos(CursorSlice const & sl, bool boundary, int & x, int & y) const;
  37         ///
  38         InsetBase * editXY(LCursor & cur, int x, int y);
  39         ///
  40         std::string name() const;
  41         ///
  42         void setExpansion(MathArray const & exp, MathArray const & args) const;
  43
  44         ///
  45         void validate(LaTeXFeatures &) const;
  46
  47         ///
  48         void maple(MapleStream &) const;
  49         ///
  50         void mathmlize(MathMLStream &) const;
  51         ///
  52         void octave(OctaveStream &) const;
  53         ///
  54         void infoize(std::ostream &) const;
  55         ///
  56         void infoize2(std::ostream &) const;
  57
  58 private:
  59         virtual std::auto_ptr<InsetBase> doClone() const;
  60         ///
  61         void updateExpansion() const;
  62         ///
  63         void expand() const;
  64
  65         /// name of macro
  66         std::string name_;
  67         /// the unexpanded macro defintition
  68         mutable MathArray tmpl_;
  69         /// the macro substituted with our args
  70         mutable MathArray expanded_;
  71 };
  72
  73
  74 #endif