src/mathed/MacroTable.cpp

   1 /**
   2  * \file MacroTable.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "InsetMathSqrt.h"
  14 #include "MacroTable.h"
  15 #include "MathMacroTemplate.h"
  16 #include "MathMacroArgument.h"
  17 #include "MathParser.h"
  18 #include "MathStream.h"
  19 #include "MathSupport.h"
  20 #include "InsetMathNest.h"
  21
  22 #include "Buffer.h"
  23 #include "DocIterator.h"
  24 #include "InsetList.h"
  25 #include "Text.h"
  26
  27 #include "support/debug.h"
  28 #include "support/gettext.h"
  29 #include "support/lassert.h"
  30
  31 #include <sstream>
  32
  33 using namespace std;
  34
  35 namespace lyx {
  36
  37
  38 /////////////////////////////////////////////////////////////////////
  39 //
  40 // MacroData
  41 //
  42 /////////////////////////////////////////////////////////////////////
  43
  44 MacroData::MacroData(Buffer * buf)
  45         : buffer_(buf), queried_(true), numargs_(0), sym_(0), optionals_(0),
  46           lockCount_(0), redefinition_(false), type_(MacroTypeNewcommand)
  47 {}
  48
  49
  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)
  54 {
  55 }
  56
  57
  58 MacroData::MacroData(Buffer * buf, MathMacroTemplate const & macro)
  59         : buffer_(buf), queried_(false), numargs_(0), sym_(0), optionals_(0),
  60           lockCount_(0), redefinition_(false), type_(MacroTypeNewcommand)
  61 {
  62         queryData(macro);
  63 }
  64
  65
  66 bool MacroData::expand(vector<MathData> const & args, MathData & to) const
  67 {
  68         updateData();
  69
  70         // Hack. Any inset with a cell would do.
  71         static InsetMathSqrt inset(0);
  72         inset.setBuffer(const_cast<Buffer &>(*buffer_));
  73
  74         docstring const & definition(display_.empty() ? definition_ : display_);
  75         asArray(definition, inset.cell(0));
  76         //lyxerr << "MathData::expand: args: " << args << endl;
  77         //LYXERR0("MathData::expand: ar: " << inset.cell(0));
  78         for (DocIterator it = doc_iterator_begin(buffer_, &inset); it; it.forwardChar()) {
  79                 if (!it.nextInset())
  80                         continue;
  81                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
  82                         continue;
  83                 //it.cell().erase(it.pos());
  84                 //it.cell().insert(it.pos(), it.nextInset()->asInsetMath()
  85                 size_t n = static_cast<MathMacroArgument*>(it.nextInset())->number();
  86                 if (n <= args.size()) {
  87                         it.cell().erase(it.pos());
  88                         it.cell().insert(it.pos(), args[n - 1]);
  89                 }
  90         }
  91         //LYXERR0("MathData::expand: res: " << inset.cell(0));
  92         to = inset.cell(0);
  93         // If the result is equal to the definition then we either have a
  94         // recursive loop, or the definition did not contain any macro in the
  95         // first place.
  96         return asString(to) != definition;
  97 }
  98
  99
 100 size_t MacroData::optionals() const
 101 {
 102         updateData();
 103         return optionals_;
 104 }
 105
 106
 107 vector<docstring> const & MacroData::defaults() const
 108 {
 109         updateData();
 110         return defaults_;
 111 }
 112
 113
 114 string const MacroData::requires() const
 115 {
 116         if (sym_)
 117                 return sym_->requires;
 118         return string();
 119 }
 120
 121
 122 bool MacroData::hidden() const
 123 {
 124         if (sym_)
 125                 return sym_->hidden;
 126         return false;
 127 }
 128
 129
 130 docstring const MacroData::xmlname() const
 131 {
 132         if (sym_)
 133                 return sym_->xmlname;
 134         return docstring();
 135 }
 136
 137
 138 char const * MacroData::MathMLtype() const
 139 {
 140         return sym_ ? sym_->MathMLtype() : 0;
 141 }
 142
 143
 144 void MacroData::unlock() const
 145 {
 146         --lockCount_;
 147         LASSERT(lockCount_ >= 0, lockCount_ = 0);
 148 }
 149
 150
 151 void MacroData::queryData(MathMacroTemplate const & macro) const
 152 {
 153         if (queried_)
 154                 return;
 155
 156         queried_ = true;
 157         definition_ = macro.definition();
 158         numargs_ = macro.numArgs();
 159         display_ = macro.displayDefinition();
 160         redefinition_ = macro.redefinition();
 161         type_ = macro.type();
 162         optionals_ = macro.numOptionals();
 163
 164         macro.getDefaults(defaults_);
 165 }
 166
 167
 168 void MacroData::updateData() const
 169 {
 170         if (queried_)
 171                 return;
 172
 173         LBUFERR(buffer_);
 174
 175         // Try to fix position DocIterator. Should not do anything in theory.
 176         pos_.fixIfBroken();
 177
 178         // find macro template
 179         Inset * inset = pos_.nextInset();
 180         if (inset == 0 || inset->lyxCode() != MATHMACRO_CODE) {
 181                 lyxerr << "BUG: No macro template found by MacroData" << endl;
 182                 return;
 183         }
 184
 185         // query the data from the macro template
 186         queryData(static_cast<MathMacroTemplate const &>(*inset));
 187 }
 188
 189
 190 int MacroData::write(odocstream & os, bool overwriteRedefinition) const
 191 {
 192         updateData();
 193
 194         // find macro template
 195         Inset * inset = pos_.nextInset();
 196         if (inset == 0 || inset->lyxCode() != MATHMACRO_CODE) {
 197                 lyxerr << "BUG: No macro template found by MacroData" << endl;
 198                 return 0;
 199         }
 200
 201         // output template
 202         MathMacroTemplate const & tmpl =
 203                 static_cast<MathMacroTemplate const &>(*inset);
 204         WriteStream wi(os, false, true, WriteStream::wsDefault);
 205         return tmpl.write(wi, overwriteRedefinition);
 206 }
 207
 208
 209 /////////////////////////////////////////////////////////////////////
 210 //
 211 // The global table of macros
 212 //
 213 /////////////////////////////////////////////////////////////////////
 214
 215 MacroTable & MacroTable::globalMacros()
 216 {
 217         static MacroTable theGlobalMacros;
 218         return theGlobalMacros;
 219 }
 220
 221
 222 MacroData const * MacroTable::get(docstring const & name) const
 223 {
 224         const_iterator it = find(name);
 225         return it == end() ? 0 : &it->second;
 226 }
 227
 228
 229 MacroTable::iterator
 230 MacroTable::insert(docstring const & name, MacroData const & data)
 231 {
 232         //lyxerr << "MacroTable::insert: " << to_utf8(name) << endl;
 233         iterator it = find(name);
 234         if (it == end())
 235                 it = map<docstring, MacroData>::insert(
 236                                 make_pair(name, data)).first;
 237         else
 238                 it->second = data;
 239         return it;
 240 }
 241
 242
 243 MacroTable::iterator
 244 MacroTable::insert(Buffer * buf, docstring const & def)
 245 {
 246         //lyxerr << "MacroTable::insert, def: " << to_utf8(def) << endl;
 247         MathMacroTemplate mac(buf, def);
 248         MacroData data(buf, mac);
 249         return insert(mac.name(), data);
 250 }
 251
 252
 253 void MacroTable::getMacroNames(std::set<docstring> & names, bool gethidden) const
 254 {
 255         for (const_iterator it = begin(); it != end(); ++it)
 256                 if (gethidden || !it->second.hidden())
 257                         names.insert(it->first);
 258 }
 259
 260
 261 void MacroTable::dump()
 262 {
 263         lyxerr << "\n------------------------------------------" << endl;
 264         for (const_iterator it = begin(); it != end(); ++it)
 265                 lyxerr << to_utf8(it->first)
 266                         << " [" << to_utf8(it->second.definition()) << "] : "
 267                         << " [" << to_utf8(it->second.display()) << "] : "
 268                         << endl;
 269         lyxerr << "------------------------------------------" << endl;
 270 }
 271
 272
 273 /////////////////////////////////////////////////////////////////////
 274 //
 275 // MacroContext
 276 //
 277 /////////////////////////////////////////////////////////////////////
 278
 279 MacroContext::MacroContext(Buffer const * buf, DocIterator const & pos)
 280         : buf_(buf), pos_(pos)
 281 {
 282 }
 283
 284
 285 MacroData const * MacroContext::get(docstring const & name) const
 286 {
 287         return buf_->getMacro(name, pos_);
 288 }
 289
 290 } // namespace lyx