src/mathed/MacroTable.h

   1 // -*- C++ -*-
   2 /**
   3  * \file MacroTable.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  * \author Stefan Schimanski
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef MATH_MACROTABLE_H
  14 #define MATH_MACROTABLE_H
  15
  16 #include "DocIterator.h"
  17
  18 #include "support/docstring.h"
  19
  20 #include <map>
  21 #include <set>
  22 #include <vector>
  23
  24 namespace lyx {
  25
  26 class Buffer;
  27 class MathData;
  28 class MathMacroTemplate;
  29 class Paragraph;
  30 class latexkeys;
  31
  32 enum MacroType {
  33         MacroTypeNewcommand,
  34         MacroTypeNewcommandx,
  35         MacroTypeDef
  36 };
  37
  38 ///
  39 class MacroData {
  40 public:
  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);
  47
  48         ///
  49         docstring const & definition() const { updateData(); return definition_; }
  50         ///
  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
  55         /// optional argument
  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;
  60         ///
  61         std::vector<docstring> const & defaults() const;
  62         ///
  63         std::string const requires() const;
  64         ///
  65         bool hidden() const;
  66         ///
  67         docstring const xmlname() const;
  68         ///
  69         char const * MathMLtype() const;
  70         ///
  71         latexkeys const * symbol() const { return sym_; }
  72         ///
  73         void setSymbol(latexkeys const * sym) { sym_ = sym; }
  74         ///
  75         DocIterator const & pos() { return pos_; }
  76
  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; }
  81         ///
  82         void unlock() const;
  83
  84         ///
  85         bool redefinition() const { updateData(); return redefinition_; }
  86
  87         ///
  88         MacroType type() const { updateData(); return type_; }
  89
  90         /// output as TeX macro, only works for lazy MacroData!!!
  91         int write(odocstream & os, bool overwriteRedefinition) const;
  92
  93         ///
  94         bool operator==(MacroData const & x) const {
  95                 updateData();
  96                 x.updateData();
  97                 return definition_ == x.definition_
  98                         && numargs_ == x.numargs_
  99                         && display_ == x.display_
 100                         && sym_ == x.sym_
 101                         && optionals_ == x.optionals_
 102                         && defaults_ == x.defaults_;
 103         }
 104         ///
 105         bool operator!=(MacroData const & x) const { return !operator==(x); }
 106
 107 private:
 108         ///
 109         void queryData(MathMacroTemplate const & macro) const;
 110         ///
 111         void updateData() const;
 112         ///
 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
 121         /// macros.
 122         mutable DocIterator pos_;
 123         ///
 124         mutable bool queried_;
 125         ///
 126         mutable docstring definition_;
 127         ///
 128         mutable size_t numargs_;
 129         ///
 130         mutable docstring display_;
 131         ///
 132         latexkeys const * sym_;
 133         ///
 134         mutable size_t optionals_;
 135         ///
 136         mutable std::vector<docstring> defaults_;
 137         ///
 138         mutable int lockCount_;
 139         ///
 140         mutable bool redefinition_;
 141         ///
 142         mutable MacroType type_;
 143 };
 144
 145
 146 ///
 147 class MacroNameSet : public std::set<docstring> {};
 148 ///
 149 class MacroSet : public std::set<MacroData const *> {};
 150
 151
 152 /// A lookup table of macro definitions.
 153 /**
 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.
 157  *
 158  **/
 159 class MacroTable : public std::map<docstring, MacroData>
 160 {
 161 public:
 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);
 166         ///
 167         MacroData const * get(docstring const & name) const;
 168         ///
 169         void dump();
 170         ///
 171         void getMacroNames(std::set<docstring> & names, bool gethidden) const;
 172
 173         /// the global list
 174         static MacroTable & globalMacros();
 175 };
 176
 177
 178 /// A context to lookup macros at a certain position in a buffer.
 179 /**
 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.
 184  *
 185  **/
 186 class MacroContext {
 187 public:
 188         /// construct context for the insets at pos
 189         MacroContext(Buffer const * buf, DocIterator const & pos);
 190
 191         /// Lookup macro
 192         MacroData const * get(docstring const & name) const;
 193
 194 private:
 195         ///
 196         Buffer const * buf_;
 197         ///
 198         DocIterator const & pos_;
 199 };
 200
 201 } // namespace lyx
 202
 203 #endif