#ifndef MATH_MACROTEMPLATE_H
#define MATH_MACROTEMPLATE_H
-#include "MathData.h"
-#include "MathMacroTable.h"
#include "InsetMathNest.h"
+#include "MacroTable.h"
+#include "MathData.h"
#include "support/types.h"
///
MathMacroTemplate();
///
- MathMacroTemplate(docstring const & name, int nargs,
- docstring const & type,
- MathArray const & = MathArray(),
- MathArray const & = MathArray());
+ MathMacroTemplate(docstring const & name, int nargs, int optional,
+ MacroType type,
+ std::vector<MathData> const & optionalValues = std::vector<MathData>(),
+ MathData const & def = MathData(),
+ MathData const & display = MathData());
///
explicit MathMacroTemplate(const docstring & str);
///
- void edit(LCursor & cur, bool left);
- ///
EDITABLE editable() const { return HIGHLY_EDITABLE; }
///
- void read(Buffer const &, LyXLex & lex);
+ void edit(Cursor & cur, bool front, EntryDirection entry_from);
+ ///
+ bool notifyCursorLeaves(Cursor & cur);
+ ///
+ void read(Buffer const &, Lexer & lex);
///
void write(Buffer const &, std::ostream & os) const;
///
void write(WriteStream & os) const;
+ /// Output LaTeX code, but assume that the macro is not definied yet
+ /// if overwriteRedefinition is true
+ void write(WriteStream & os, bool overwriteRedefinition) const;
///
int plaintext(Buffer const &, odocstream &,
- OutputParams const &) const;
-
- /// Number of arguments
- int numargs() const;
+ OutputParams const &) const;
///
- void numargs(int);
+ bool noFontChange() const { return true; }
+
///
docstring name() const;
///
- MacroData asMacroData() const;
+ void getDefaults(std::vector<docstring> & defaults) const;
+ ///
+ docstring definition() const;
+ ///
+ docstring displayDefinition() const;
+ ///
+ size_t numArgs() const;
+ ///
+ size_t numOptionals() const;
+ ///
+ bool redefinition() const { return redefinition_; }
+ ///
+ MacroType type() const { return type_; }
+
+ /// check name and possible other formal properties
+ bool validMacro() const;
+ ///
+ bool validName() const;
+ /// Remove everything from the name which makes it invalid
+ /// and return true iff it is valid.
+ bool fixNameAndCheckIfValid();
+
+ /// request "external features"
+ virtual void validate(LaTeXFeatures &) const;
+
+ /// decide whether its a redefinition
+ void updateToContext(MacroContext const & mc) const;
+
///
void draw(PainterInfo & pi, int x, int y) const;
///
- bool metrics(MetricsInfo & mi, Dimension & dim) const;
+ void metrics(MetricsInfo & mi, Dimension & dim) const;
/// identifies macro templates
MathMacroTemplate * asMacroTemplate() { return this; }
/// identifies macro templates
MathMacroTemplate const * asMacroTemplate() const { return this; }
///
- InsetBase::Code lyxCode() const { return MATHMACRO_CODE; }
+ InsetCode lyxCode() const { return MATHMACRO_CODE; }
+ ///
+ void infoize(odocstream & os) const;
+
+protected:
+ ///
+ virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
+ /// do we want to handle this event?
+ bool getStatus(Cursor & cur, FuncRequest const & cmd,
+ FuncStatus & status) const;
private:
- virtual std::auto_ptr<InsetBase> doClone() const;
- /// prefix in inset
- docstring prefix() const;
+ friend class InsetLabelBox;
+ friend class DisplayLabelBox;
+
+ ///
+ virtual Inset * clone() const;
+ /// remove #n with from<=n<=to
+ void removeArguments(Cursor & cur, int from, int to);
+ /// shift every #n with from<=n, i.e. #n -> #(n-by)
+ void shiftArguments(size_t from, int by);
+ ///
+ void insertParameter(Cursor & cur, int pos, bool greedy = false);
+ ///
+ void removeParameter(Cursor & cur, int pos, bool greedy = false );
+ ///
+ void makeOptional(Cursor & cur);
+ ///
+ void makeNonOptional(Cursor & cur);
+ ///
+ idx_type defIdx() const { return optionals_ + 1; }
+ /// index of default value cell of optional parameter (#1 -> n=0)
+ idx_type optIdx(idx_type n) const { return n + 1; }
+ ///
+ idx_type displayIdx() const { return optionals_ + 2; }
+ ///
+ void updateLook() const;
+ /// The representation of the macro tempalte, with some holes to edit
+ mutable MathData look_;
+ ///
+ mutable int numargs_;
+ ///
+ int optionals_;
+ /// keeps the old optional default value when an
+ /// optional argument is disabled
+ std::vector<MathData> optionalValues_;
+
+ /// (re)newcommand or def
+ mutable MacroType type_;
+ /// defined before already?
+ mutable bool redefinition_;
+ ///
+ void createLook() const;
+ ///
+ mutable bool lookOutdated_;
+ /// true if in pre-calculations of metrics to get height of boxes
+ mutable bool premetrics_;
+ ///
+ mutable int labelBoxAscent_;
+ ///
+ mutable int labelBoxDescent_;
+ ///
+ bool premetrics() const { return premetrics_; }
///
- int numargs_;
+ int commonLabelBoxAscent() const { return labelBoxAscent_; }
///
- docstring name_;
- /// newcommand or renewcommand or def
- docstring type_;
+ int commonLabelBoxDescent() const { return labelBoxDescent_; }
};