3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
13 #include "InsetMathSqrt.h"
14 #include "MacroTable.h"
15 #include "InsetMathMacroTemplate.h"
16 #include "InsetMathMacroArgument.h"
17 #include "MathParser.h"
18 #include "MathStream.h"
19 #include "MathSupport.h"
20 #include "InsetMathNest.h"
23 #include "DocIterator.h"
24 #include "InsetList.h"
27 #include "support/debug.h"
28 #include "support/gettext.h"
29 #include "support/lassert.h"
38 /////////////////////////////////////////////////////////////////////
42 /////////////////////////////////////////////////////////////////////
44 MacroData::MacroData(Buffer * buf)
45 : buffer_(buf), queried_(true), numargs_(0), sym_(0), optionals_(0),
46 lockCount_(0), redefinition_(false), type_(MacroTypeNewcommand)
50 MacroData::MacroData(Buffer * buf, DocIterator const & pos)
51 : buffer_(buf), pos_(pos), queried_(false), numargs_(0), sym_(0),
52 optionals_(0), lockCount_(0), redefinition_(false),
53 type_(MacroTypeNewcommand)
58 MacroData::MacroData(Buffer * buf, InsetMathMacroTemplate const & macro)
59 : buffer_(buf), queried_(false), numargs_(0), sym_(0), optionals_(0),
60 lockCount_(0), redefinition_(false), type_(MacroTypeNewcommand)
66 bool MacroData::expand(vector<MathData> const & args, MathData & to) const
70 // Hack. Any inset with a cell would do.
71 InsetMathSqrt inset(const_cast<Buffer *>(buffer_));
73 docstring const & definition(display_.empty() ? definition_ : display_);
74 asArray(definition, inset.cell(0), Parse::QUIET | Parse::MACRODEF);
75 //lyxerr << "MathData::expand: args: " << args << endl;
76 //LYXERR0("MathData::expand: ar: " << inset.cell(0));
77 for (DocIterator it = doc_iterator_begin(buffer_, &inset); it; it.forwardChar()) {
80 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
82 //it.cell().erase(it.pos());
83 //it.cell().insert(it.pos(), it.nextInset()->asInsetMath()
84 size_t n = static_cast<InsetMathMacroArgument*>(it.nextInset())->number();
85 if (n <= args.size()) {
86 it.cell().erase(it.pos());
87 it.cell().insert(it.pos(), args[n - 1]);
90 //LYXERR0("MathData::expand: res: " << inset.cell(0));
92 // If the result is equal to the definition then we either have a
93 // recursive loop, or the definition did not contain any macro in the
95 return asString(to) != definition;
99 size_t MacroData::optionals() const
106 vector<docstring> const & MacroData::defaults() const
113 string const MacroData::required() const
116 return sym_->required;
121 bool MacroData::hidden() const
129 docstring const MacroData::htmlname() const
132 return sym_->htmlname;
137 docstring const MacroData::xmlname() const
140 return sym_->xmlname;
145 char const * MacroData::MathMLtype() const
147 return sym_ ? sym_->MathMLtype() : 0;
151 void MacroData::unlock() const
154 LASSERT(lockCount_ >= 0, lockCount_ = 0);
158 void MacroData::queryData(InsetMathMacroTemplate const & macro) const
164 definition_ = macro.definition();
165 numargs_ = macro.numArgs();
166 display_ = macro.displayDefinition();
167 redefinition_ = macro.redefinition();
168 type_ = macro.type();
169 optionals_ = macro.numOptionals();
171 macro.getDefaults(defaults_);
175 void MacroData::updateData() const
182 // Try to fix position DocIterator. Should not do anything in theory.
185 // find macro template
186 Inset * inset = pos_.nextInset();
187 if (inset == 0 || inset->lyxCode() != MATHMACRO_CODE) {
188 lyxerr << "BUG: No macro template found by MacroData" << endl;
192 // query the data from the macro template
193 queryData(static_cast<InsetMathMacroTemplate const &>(*inset));
197 int MacroData::write(odocstream & os, bool overwriteRedefinition) const
201 // find macro template
202 Inset * inset = pos_.nextInset();
203 if (inset == 0 || inset->lyxCode() != MATHMACRO_CODE) {
204 lyxerr << "BUG: No macro template found by MacroData" << endl;
209 InsetMathMacroTemplate const & tmpl =
210 static_cast<InsetMathMacroTemplate const &>(*inset);
211 otexrowstream ots(os);
212 WriteStream wi(ots, false, true, WriteStream::wsDefault);
213 return tmpl.write(wi, overwriteRedefinition);
217 /////////////////////////////////////////////////////////////////////
219 // The global table of macros
221 /////////////////////////////////////////////////////////////////////
223 MacroTable & MacroTable::globalMacros()
225 static MacroTable theGlobalMacros;
226 return theGlobalMacros;
230 MacroData const * MacroTable::get(docstring const & name) const
232 const_iterator it = find(name);
233 return it == end() ? 0 : &it->second;
238 MacroTable::insert(docstring const & name, MacroData const & data)
240 //lyxerr << "MacroTable::insert: " << to_utf8(name) << endl;
241 iterator it = find(name);
243 it = map<docstring, MacroData>::insert(
244 make_pair(name, data)).first;
252 MacroTable::insert(Buffer * buf, docstring const & def)
254 //lyxerr << "MacroTable::insert, def: " << to_utf8(def) << endl;
255 InsetMathMacroTemplate mac(buf);
257 MacroData data(buf, mac);
258 return insert(mac.name(), data);
262 void MacroTable::getMacroNames(std::set<docstring> & names, bool gethidden) const
264 for (const_iterator it = begin(); it != end(); ++it)
265 if (gethidden || !it->second.hidden())
266 names.insert(it->first);
270 void MacroTable::dump()
272 lyxerr << "\n------------------------------------------" << endl;
273 for (const_iterator it = begin(); it != end(); ++it)
274 lyxerr << to_utf8(it->first)
275 << " [" << to_utf8(it->second.definition()) << "] : "
276 << " [" << to_utf8(it->second.display()) << "] : "
278 lyxerr << "------------------------------------------" << endl;
282 /////////////////////////////////////////////////////////////////////
286 /////////////////////////////////////////////////////////////////////
288 MacroContext::MacroContext(Buffer const * buf, DocIterator const & pos)
289 : buf_(buf), pos_(pos)
294 MacroData const * MacroContext::get(docstring const & name) const
296 return buf_->getMacro(name, pos_);