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 front, EntryDirection entry_from);
  42         ///
  43         bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
  44         ///
  45         void read(Lexer & lex);
  46         ///
  47         void write(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(odocstream &, OutputParams const &) const;
  55         ///
  56         bool noFontChange() const { return true; }
  57
  58         ///
  59         docstring name() const;
  60         ///
  61         void getDefaults(std::vector<docstring> & defaults) const;
  62         ///
  63         docstring definition() const;
  64         ///
  65         docstring displayDefinition() const;
  66         ///
  67         size_t numArgs() const;
  68         ///
  69         size_t numOptionals() const;
  70         ///
  71         bool redefinition() const { return redefinition_; }
  72         ///
  73         MacroType type() const { return type_; }
  74
  75         /// check name and possible other formal properties
  76         bool validMacro() const;
  77         ///
  78         bool validName() const;
  79         /// Remove everything from the name which makes it invalid
  80         /// and return true iff it is valid.
  81         bool fixNameAndCheckIfValid();
  82
  83         /// request "external features"
  84         virtual void validate(LaTeXFeatures &) const;
  85
  86         /// decide whether its a redefinition
  87         void updateToContext(MacroContext const & mc) const;
  88
  89         ///
  90         void draw(PainterInfo & pi, int x, int y) const;
  91         ///
  92         void metrics(MetricsInfo & mi, Dimension & dim) const;
  93         /// identifies macro templates
  94         MathMacroTemplate * asMacroTemplate() { return this; }
  95         /// identifies macro templates
  96         MathMacroTemplate const * asMacroTemplate() const { return this; }
  97         ///
  98         InsetCode lyxCode() const { return MATHMACRO_CODE; }
  99         ///
 100         void infoize(odocstream & os) const;
 101         ///
 102         docstring contextMenu(BufferView const &, int, int) const;
 103
 104 protected:
 105         ///
 106         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 107         /// do we want to handle this event?
 108         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 109                 FuncStatus & status) const;
 110
 111 private:
 112         friend class InsetLabelBox;
 113         friend class DisplayLabelBox;
 114
 115         ///
 116         virtual Inset * clone() const;
 117
 118         /// remove #n with from<=n<=to
 119         void removeArguments(Cursor & cur, int from, int to);
 120         /// shift every #n with from<=n, i.e. #n -> #(n-by)
 121         void shiftArguments(size_t from, int by);
 122         ///
 123         void insertParameter(Cursor & cur, int pos, bool greedy = false, bool addarg = true);
 124         ///
 125         void removeParameter(Cursor & cur, int pos, bool greedy = false);
 126         ///
 127         void makeOptional(Cursor & cur);
 128         ///
 129         void makeNonOptional(Cursor & cur);
 130         ///
 131         idx_type defIdx() const { return optionals_ + 1; }
 132         /// index of default value cell of optional parameter (#1 -> n=0)
 133         idx_type optIdx(idx_type n) const { return n + 1; }
 134         ///
 135         idx_type displayIdx() const { return optionals_ + 2; }
 136         ///
 137         void updateLook() const;
 138         /// look through the macro for #n arguments
 139         int maxArgumentInDefinition() const;
 140         /// add missing #n arguments up to \c maxArg
 141         void insertMissingArguments(int maxArg);
 142         /// change the arity
 143         void changeArity(Cursor & cur, int newNumArg);
 144         /// find arguments in definition and adapt the arity accordingly
 145         void commitEditChanges(Cursor & cur);
 146         /// The representation of the macro template, with some holes to edit
 147         mutable MathData look_;
 148         ///
 149         mutable int numargs_;
 150         ///
 151         mutable int argsInLook_;
 152         ///
 153         int optionals_;
 154         /// keeps the old optional default value when an
 155         /// optional argument is disabled
 156         std::vector<MathData> optionalValues_;
 157
 158         /// (re)newcommand or def
 159         mutable MacroType type_;
 160         /// defined before already?
 161         mutable bool redefinition_;
 162         ///
 163         void createLook(int args) const;
 164         ///
 165         mutable bool lookOutdated_;
 166         /// true if in pre-calculations of metrics to get height of boxes
 167         mutable bool premetrics_;
 168         ///
 169         mutable int labelBoxAscent_;
 170         ///
 171         mutable int labelBoxDescent_;
 172         ///
 173         bool premetrics() const { return premetrics_; }
 174         ///
 175         int commonLabelBoxAscent() const { return labelBoxAscent_; }
 176         ///
 177         int commonLabelBoxDescent() const { return labelBoxDescent_; }
 178 };
 179
 180
 181 } // namespace lyx
 182
 183 #endif