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;
41 /// Constructor to make STL containers happy
42 explicit MacroData(Buffer * buf = 0);
43 /// Create lazy MacroData which only queries the macro template when needed
44 MacroData(Buffer * buf, DocIterator const & pos);
45 /// Create non-lazy MacroData which directly queries the macro template
46 MacroData(Buffer * buf, InsetMathMacroTemplate const & macro);
49 docstring const & definition() const { updateData(); return definition_; }
51 docstring const & display() const { updateData(); return display_; }
52 /// arity including optional arguments (if there is any)
53 size_t numargs() const { updateData(); return numargs_; }
54 /// replace #1,#2,... by given MathAtom 0,1,.., _including_ the possible
56 /// \return whether anything was expanded
57 bool expand(std::vector<MathData> const & from, MathData & to) const;
58 /// number of optional arguments
59 size_t optionals() const;
61 std::vector<docstring> const & defaults() const;
63 std::string const required() const;
67 docstring const xmlname() const;
69 char const * MathMLtype() const;
71 latexkeys const * symbol() const { return sym_; }
73 void setSymbol(latexkeys const * sym) { sym_ = sym; }
75 DocIterator const & pos() { return pos_; }
77 /// lock while being drawn to avoid recursions
78 int lock() const { return ++lockCount_; }
79 /// is it being drawn?
80 bool locked() const { return lockCount_ != 0; }
85 bool redefinition() const { updateData(); return redefinition_; }
88 MacroType type() const { updateData(); return type_; }
90 /// output as TeX macro, only works for lazy MacroData!!!
91 int write(odocstream & os, bool overwriteRedefinition) const;
94 bool operator==(MacroData const & x) const {
97 return definition_ == x.definition_
98 && numargs_ == x.numargs_
99 && display_ == x.display_
101 && optionals_ == x.optionals_
102 && defaults_ == x.defaults_;
105 bool operator!=(MacroData const & x) const { return !operator==(x); }
109 void queryData(InsetMathMacroTemplate const & macro) const;
111 void updateData() const;
113 Buffer const * buffer_;
114 /// The position of the definition in the buffer.
115 /// There is no guarantee it stays valid if the buffer
116 /// changes. But it (normally) exists only until the
117 /// next Buffer::updateMacros call where new MacroData
118 /// objects are created for each macro definition.
119 /// In the worst case, it is invalidated and the MacroData
120 /// returns its defaults values and the user sees unfolded
122 mutable DocIterator pos_;
124 mutable bool queried_;
126 mutable docstring definition_;
128 mutable size_t numargs_;
130 mutable docstring display_;
132 latexkeys const * sym_;
134 mutable size_t optionals_;
136 mutable std::vector<docstring> defaults_;
138 mutable int lockCount_;
140 mutable bool redefinition_;
142 mutable MacroType type_;
147 class MacroNameSet : public std::set<docstring> {};
149 class MacroSet : public std::set<MacroData const *> {};
152 /// A lookup table of macro definitions.
154 * This contains a table of "global" macros that are always accessible,
155 * either because they implement a feature of standard LaTeX or some
156 * hack to display certain contents nicely.
159 class MacroTable : public std::map<docstring, MacroData>
162 /// Parse full "\\def..." or "\\newcommand..." or ...
163 iterator insert(Buffer * buf, docstring const & definition);
164 /// Insert pre-digested macro definition
165 iterator insert(docstring const & name, MacroData const & data);
167 MacroData const * get(docstring const & name) const;
171 void getMacroNames(std::set<docstring> & names, bool gethidden) const;
174 static MacroTable & globalMacros();
178 /// A context to lookup macros at a certain position in a buffer.
180 * The MacroContext is used during metrics calculation to resolve
181 * macro instances according to the position of them in the buffer
182 * document. Only macro definition in front of the macro instance
183 * are visible and are resolved.
188 /// construct context for the insets at pos
189 MacroContext(Buffer const * buf, DocIterator const & pos);
192 MacroData const * get(docstring const & name) const;
198 DocIterator const & pos_;