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;
40 /// Constructor to make STL containers happy
41 MacroData(Buffer * buf = 0);
42 /// Create lazy MacroData which only queries the macro template when needed
43 MacroData(Buffer * buf, DocIterator const & pos);
44 /// Create non-lazy MacroData which directly queries the macro template
45 MacroData(Buffer * buf, MathMacroTemplate 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 void expand(std::vector<MathData> const & from, MathData & to) const;
56 /// number of optional arguments
57 size_t optionals() const;
59 std::vector<docstring> const & defaults() const;
61 std::string const & requires() const { updateData(); return requires_; }
63 std::string & requires() { updateData(); return requires_; }
65 /// lock while being drawn to avoid recursions
66 int lock() const { return ++lockCount_; }
67 /// is it being drawn?
68 bool locked() const { return lockCount_ != 0; }
73 bool redefinition() const { return redefinition_; }
75 void setRedefinition(bool redefined) { redefinition_ = redefined; }
78 MacroType type() const { return type_; }
80 MacroType & type() { return type_; }
82 /// output as TeX macro, only works for lazy MacroData!!!
83 int write(odocstream & os, bool overwriteRedefinition) const;
86 bool operator==(MacroData const & x) const {
89 return definition_ == x.definition_
90 && numargs_ == x.numargs_
91 && display_ == x.display_
92 && requires_ == x.requires_
93 && optionals_ == x.optionals_
94 && defaults_ == x.defaults_;
97 bool operator!=(MacroData const & x) const { return !operator==(x); }
101 void queryData(MathMacroTemplate const & macro) const;
103 void updateData() const;
105 Buffer const * buffer_;
106 /// The position of the definition in the buffer.
107 /// There is no guarantee it stays valid if the buffer
108 /// changes. But it (normally) exists only until the
109 /// next Buffer::updateMacros call where new MacroData
110 /// objects are created for each macro definition.
111 /// In the worst case, it is invalidated and the MacroData
112 /// returns its defaults values and the user sees unfolded
114 mutable DocIterator pos_;
116 mutable bool queried_;
118 mutable docstring definition_;
120 mutable size_t numargs_;
122 mutable docstring display_;
124 mutable std::string requires_;
126 mutable size_t optionals_;
128 mutable std::vector<docstring> defaults_;
130 mutable int lockCount_;
132 mutable bool redefinition_;
134 mutable MacroType type_;
139 class MacroNameSet : public std::set<docstring> {};
141 class MacroSet : public std::set<MacroData const *> {};
144 /// A lookup table of macro definitions.
146 * This contains a table of "global" macros that are always accessible,
147 * either because they implement a feature of standard LaTeX or some
148 * hack to display certain contents nicely.
151 class MacroTable : public std::map<docstring, MacroData>
154 /// Parse full "\\def..." or "\\newcommand..." or ...
155 iterator insert(Buffer * buf, docstring const & definition, std::string const &);
156 /// Insert pre-digested macro definition
157 iterator insert(docstring const & name, MacroData const & data);
159 MacroData const * get(docstring const & name) const;
163 void getMacroNames(std::set<docstring> & names) const;
166 static MacroTable & globalMacros();
170 /// A context to lookup macros at a certain position in a buffer.
172 * The MacroContext is used during metrics calculation to resolve
173 * macro instances according to the position of them in the buffer
174 * document. Only macro definition in front of the macro instance
175 * are visible and are resolved.
180 /// construct context for the insets at pos
181 MacroContext(Buffer const * buf, DocIterator const & pos);
184 MacroData const * get(docstring const & name) const;
190 DocIterator const & pos_;