4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Stefan Schimanski
10 * Full author contact details are available in file CREDITS.
13 #ifndef MATH_MACROTABLE_H
14 #define MATH_MACROTABLE_H
16 #include "DocIterator.h"
18 #include "support/docstring.h"
28 class InsetMathMacroTemplate;
40 /// Constructor to make STL containers happy
41 explicit MacroData(Buffer const * buf = 0);
42 /// Create lazy MacroData which only queries the macro template when needed
43 MacroData(Buffer const * buf, DocIterator const & pos);
44 /// Create non-lazy MacroData which directly queries the macro template
45 MacroData(Buffer const * buf, InsetMathMacroTemplate const & macro);
48 docstring const & definition() const { updateData(); return definition_; }
50 docstring const & display() const { updateData(); return display_; }
51 /// arity including optional arguments (if there is any)
52 size_t numargs() const { updateData(); return numargs_; }
53 /// replace #1,#2,... by given MathAtom 0,1,.., _including_ the possible
55 /// \return whether anything was expanded
56 bool expand(std::vector<MathData> const & from, MathData & to) const;
57 /// number of optional arguments
58 size_t optionals() const;
60 std::vector<docstring> const & defaults() const;
62 std::string const required() const;
66 docstring const xmlname() const;
68 char const * MathMLtype() const;
70 latexkeys const * symbol() const { return sym_; }
72 void setSymbol(latexkeys const * sym) { sym_ = sym; }
74 DocIterator const & pos() const { return pos_; }
76 /// lock while being drawn to avoid recursions
77 int lock() const { return ++lockCount_; }
78 /// is it being drawn?
79 bool locked() const { return lockCount_ != 0; }
84 bool redefinition() const { updateData(); return redefinition_; }
87 MacroType type() const { updateData(); return type_; }
89 /// output as TeX macro, only works for lazy MacroData!!!
90 int write(odocstream & os, bool overwriteRedefinition) const;
93 bool operator==(MacroData const & x) const {
96 return definition_ == x.definition_
97 && numargs_ == x.numargs_
98 && display_ == x.display_
100 && optionals_ == x.optionals_
101 && defaults_ == x.defaults_;
104 bool operator!=(MacroData const & x) const { return !operator==(x); }
108 void queryData(InsetMathMacroTemplate const & macro) const;
110 void updateData() const;
112 Buffer const * buffer_;
113 /// The position of the definition in the buffer.
114 /// There is no guarantee it stays valid if the buffer
115 /// changes. But it (normally) exists only until the
116 /// next Buffer::updateMacros call where new MacroData
117 /// objects are created for each macro definition.
118 /// In the worst case, it is invalidated and the MacroData
119 /// returns its defaults values and the user sees unfolded
121 mutable DocIterator pos_;
123 mutable bool queried_ = false;
125 mutable docstring definition_;
127 mutable size_t numargs_ = 0;
129 mutable docstring display_;
131 latexkeys const * sym_ = nullptr;
133 mutable size_t optionals_ = 0;
135 mutable std::vector<docstring> defaults_;
137 mutable int lockCount_ = 0;
139 mutable bool redefinition_ = false;
141 mutable MacroType type_ = MacroTypeNewcommand;
146 class MacroNameSet : public std::set<docstring> {};
148 class MacroSet : public std::set<MacroData const *> {};
151 /// A lookup table of macro definitions.
153 * This contains a table of "global" macros that are always accessible,
154 * either because they implement a feature of standard LaTeX or some
155 * hack to display certain contents nicely.
158 class MacroTable : public std::map<docstring, MacroData>
161 /// Parse full "\\def..." or "\\newcommand..." or ...
162 iterator insert(Buffer * buf, docstring const & definition);
163 /// Insert pre-digested macro definition
164 iterator insert(docstring const & name, MacroData const & data);
166 MacroData const * get(docstring const & name) const;
170 void getMacroNames(std::set<docstring> & names, bool gethidden) const;
173 static MacroTable & globalMacros();
177 /// A context to lookup macros at a certain position in a buffer.
179 * The MacroContext is used during metrics calculation to resolve
180 * macro instances according to the position of them in the buffer
181 * document. Only macro definition in front of the macro instance
182 * are visible and are resolved.
187 /// construct context for the insets at pos
188 MacroContext(Buffer const * buf, DocIterator const & pos);
191 MacroData const * get(docstring const & name) const;
197 DocIterator const & pos_;