src/mathed/MathMacroTemplate.h

   1 // -*- C++ -*-
   2 /**
   3  * \file math_macrotemplate.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_MACROTEMPLATE_H
  14 #define MATH_MACROTEMPLATE_H
  15
  16 #include "InsetMathNest.h"
  17 #include "MacroTable.h"
  18 #include "MathData.h"
  19
  20 #include "support/types.h"
  21
  22
  23 namespace lyx {
  24
  25 /// This class contains the macro definition.
  26 class MathMacroTemplate : public InsetMathNest {
  27 public:
  28         ///
  29         MathMacroTemplate();
  30         ///
  31         MathMacroTemplate(docstring const & name, int nargs, int optional,
  32                 MacroType type,
  33                 std::vector<MathData> const & optionalValues = std::vector<MathData>(),
  34                 MathData const & def = MathData(),
  35                 MathData const & display = MathData());
  36         ///
  37         explicit MathMacroTemplate(const docstring & str);
  38         ///
  39         EDITABLE editable() const { return HIGHLY_EDITABLE; }
  40         ///
  41         void edit(Cursor & cur, bool left);
  42         ///
  43         bool notifyCursorLeaves(Cursor & cur);
  44         ///
  45         void read(Buffer const &, Lexer & lex);
  46         ///
  47         void write(Buffer const &, std::ostream & os) const;
  48         ///
  49         void write(WriteStream & os) const;
  50         /// Output LaTeX code, but assume that the macro is not definied yet
  51         /// if overwriteRedefinition is true
  52         void write(WriteStream & os, bool overwriteRedefinition) const;
  53         ///
  54         int plaintext(Buffer const &, odocstream &,
  55                 OutputParams const &) const;
  56         ///
  57         bool noFontChange() const { return true; }
  58
  59         ///
  60         docstring name() const;
  61         ///
  62         void getDefaults(std::vector<docstring> & defaults) const;
  63         ///
  64         docstring definition() const;
  65         ///
  66         docstring displayDefinition() const;
  67         ///
  68         size_t numArgs() const;
  69         ///
  70         size_t numOptionals() const;
  71         ///
  72         bool redefinition() const { return redefinition_; }
  73         ///
  74         MacroType type() const { return type_; }
  75
  76         /// check name and possible other formal properties
  77         bool validMacro() const;
  78         ///
  79         bool validName() const;
  80         /// Remove everything from the name which makes it invalid
  81         /// and return true iff it is valid.
  82         bool fixNameAndCheckIfValid();
  83
  84         /// decide whether its a redefinition
  85         void updateToContext(MacroContext const & mc) const;
  86
  87         ///
  88         void draw(PainterInfo & pi, int x, int y) const;
  89         ///
  90         void metrics(MetricsInfo & mi, Dimension & dim) const;
  91         /// identifies macro templates
  92         MathMacroTemplate * asMacroTemplate() { return this; }
  93         /// identifies macro templates
  94         MathMacroTemplate const * asMacroTemplate() const { return this; }
  95         ///
  96         InsetCode lyxCode() const { return MATHMACRO_CODE; }
  97         ///
  98         void infoize(odocstream & os) const;
  99
 100 protected:
 101         ///
 102         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 103         /// do we want to handle this event?
 104         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 105                 FuncStatus & status) const;
 106
 107 private:
 108         friend class InsetLabelBox;
 109         friend class DisplayLabelBox;
 110
 111         ///
 112         virtual Inset * clone() const;
 113
 114         /// remove #n with from<=n<=to
 115         void removeArguments(Cursor & cur, int from, int to);
 116         /// shift every #n with from<=n, i.e. #n -> #(n-by)
 117         void shiftArguments(size_t from, int by);
 118         ///
 119         void insertParameter(Cursor & cur, int pos, bool greedy = false);
 120         ///
 121         void removeParameter(Cursor & cur, int pos, bool greedy = false );
 122         ///
 123         void makeOptional(Cursor & cur);
 124         ///
 125         void makeNonOptional(Cursor & cur);
 126         ///
 127         idx_type defIdx() const { return optionals_ + 1; }
 128         /// index of default value cell of optional parameter (#1 -> n=0)
 129         idx_type optIdx(idx_type n) const { return n + 1; }
 130         ///
 131         idx_type displayIdx() const { return optionals_ + 2; }
 132         ///
 133         void updateLook() const;
 134         /// The representation of the macro tempalte, with some holes to edit
 135         mutable MathData look_;
 136         ///
 137         mutable int numargs_;
 138         ///
 139         int optionals_;
 140         /// keeps the old optional default value when an
 141         /// optional argument is disabled
 142         std::vector<MathData> optionalValues_;
 143
 144         /// (re)newcommand or def
 145         mutable MacroType type_;
 146         /// defined before already?
 147         mutable bool redefinition_;
 148         ///
 149         void createLook() const;
 150         ///
 151         mutable bool lookOutdated_;
 152         /// true if in pre-calculations of metrics to get height of boxes
 153         mutable bool premetrics_;
 154         ///
 155         mutable int labelBoxAscent_;
 156         ///
 157         mutable int labelBoxDescent_;
 158         ///
 159         bool premetrics() const { return premetrics_; }
 160         ///
 161         int commonLabelBoxAscent() const { return labelBoxAscent_; }
 162         ///
 163         int commonLabelBoxDescent() const { return labelBoxDescent_; }
 164 };
 165
 166
 167 } // namespace lyx
 168
 169 #endif