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 MathMacroTemplate;
41 /// Constructor to make STL containers happy
42 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, MathMacroTemplate 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 requires() const;
67 docstring const xmlname() const;
69 char const * MathMLtype() const;
71 void setSymbol(latexkeys const * sym) { sym_ = sym; }
73 DocIterator const & pos() { return pos_; }
75 /// lock while being drawn to avoid recursions
76 int lock() const { return ++lockCount_; }
77 /// is it being drawn?
78 bool locked() const { return lockCount_ != 0; }
83 bool redefinition() const { updateData(); return redefinition_; }
86 MacroType type() const { updateData(); return type_; }
88 /// output as TeX macro, only works for lazy MacroData!!!
89 int write(odocstream & os, bool overwriteRedefinition) const;
92 bool operator==(MacroData const & x) const {
95 return definition_ == x.definition_
96 && numargs_ == x.numargs_
97 && display_ == x.display_
99 && optionals_ == x.optionals_
100 && defaults_ == x.defaults_;
103 bool operator!=(MacroData const & x) const { return !operator==(x); }
107 void queryData(MathMacroTemplate const & macro) const;
109 void updateData() const;
111 Buffer const * buffer_;
112 /// The position of the definition in the buffer.
113 /// There is no guarantee it stays valid if the buffer
114 /// changes. But it (normally) exists only until the
115 /// next Buffer::updateMacros call where new MacroData
116 /// objects are created for each macro definition.
117 /// In the worst case, it is invalidated and the MacroData
118 /// returns its defaults values and the user sees unfolded
120 mutable DocIterator pos_;
122 mutable bool queried_;
124 mutable docstring definition_;
126 mutable size_t numargs_;
128 mutable docstring display_;
130 latexkeys const * sym_;
132 mutable size_t optionals_;
134 mutable std::vector<docstring> defaults_;
136 mutable int lockCount_;
138 mutable bool redefinition_;
140 mutable MacroType type_;
145 class MacroNameSet : public std::set<docstring> {};
147 class MacroSet : public std::set<MacroData const *> {};
150 /// A lookup table of macro definitions.
152 * This contains a table of "global" macros that are always accessible,
153 * either because they implement a feature of standard LaTeX or some
154 * hack to display certain contents nicely.
157 class MacroTable : public std::map<docstring, MacroData>
160 /// Parse full "\\def..." or "\\newcommand..." or ...
161 iterator insert(Buffer * buf, docstring const & definition);
162 /// Insert pre-digested macro definition
163 iterator insert(docstring const & name, MacroData const & data);
165 MacroData const * get(docstring const & name) const;
169 void getMacroNames(std::set<docstring> & names, bool gethidden) const;
172 static MacroTable & globalMacros();
176 /// A context to lookup macros at a certain position in a buffer.
178 * The MacroContext is used during metrics calculation to resolve
179 * macro instances according to the position of them in the buffer
180 * document. Only macro definition in front of the macro instance
181 * are visible and are resolved.
186 /// construct context for the insets at pos
187 MacroContext(Buffer const * buf, DocIterator const & pos);
190 MacroData const * get(docstring const & name) const;
196 DocIterator const & pos_;