X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fmathed%2FMathMacroTemplate.h;h=b0c301897761a0caeb9124c91270386b960875a9;hb=02e82157ec583c3900e359de86be79fac6512387;hp=b90c8a96cb0c01d4f283118c3befef7fa0c14d8c;hpb=565475a43917af9c52a3d9d8272e020160d0b971;p=lyx.git diff --git a/src/mathed/MathMacroTemplate.h b/src/mathed/MathMacroTemplate.h index b90c8a96cb..b0c3018977 100644 --- a/src/mathed/MathMacroTemplate.h +++ b/src/mathed/MathMacroTemplate.h @@ -5,7 +5,7 @@ * Licence details can be found in the file COPYING. * * \author Alejandro Aguilar Sierra - * \author André Pönitz + * \author André Pönitz * * Full author contact details are available in file CREDITS. */ @@ -17,44 +17,78 @@ #include "MacroTable.h" #include "MathData.h" -#include "support/types.h" - namespace lyx { +class OutputParams; +class XHTMLStream; + /// This class contains the macro definition. class MathMacroTemplate : public InsetMathNest { public: /// - MathMacroTemplate(); + MathMacroTemplate(Buffer * buf); /// - MathMacroTemplate(docstring const & name, int nargs, int optional, - docstring const & type, + MathMacroTemplate(Buffer * buf, docstring const & name, int nargs, + int optional, MacroType type, std::vector const & optionalValues = std::vector(), MathData const & def = MathData(), MathData const & display = MathData()); + /// parses from string, returns false if failed + bool fromString (const docstring & str); /// - explicit MathMacroTemplate(const docstring & str); + bool editable() const { return true; } /// - EDITABLE editable() const { return HIGHLY_EDITABLE; } + void edit(Cursor & cur, bool front, EntryDirection entry_from); /// - void read(Buffer const &, Lexer & lex); + bool notifyCursorLeaves(Cursor const & old, Cursor & cur); /// - void write(Buffer const &, std::ostream & os) const; + void read(Lexer & lex); + /// + void write(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 + int write(WriteStream & os, bool overwriteRedefinition) const; + /// Nothing happens. This is simply to suppress the default output. + docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// + int plaintext(odocstringstream &, OutputParams const &, size_t) const; /// - int plaintext(Buffer const &, odocstream &, - OutputParams const &) const; + bool inheritFont() const { return false; } /// docstring name() const; + /// + void getDefaults(std::vector & 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; - /// - MacroData asMacroData() 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); + /// void draw(PainterInfo & pi, int x, int y) const; /// @@ -65,7 +99,13 @@ public: MathMacroTemplate const * asMacroTemplate() const { return this; } /// InsetCode lyxCode() const { return MATHMACRO_CODE; } - + /// + void infoize(odocstream & os) const; + /// + std::string contextMenuName() const; + /// + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype) const; protected: /// virtual void doDispatch(Cursor & cur, FuncRequest & cmd); @@ -74,36 +114,76 @@ protected: FuncStatus & status) const; private: + friend class InsetLabelBox; + friend class DisplayLabelBox; + + /// virtual Inset * clone() const; /// remove #n with from<=n<=to - void removeArguments(Cursor & cur, int from, int to); + void removeArguments(Cursor & cur, DocIterator const & inset_pos, + 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 insertParameter(Cursor & cur, DocIterator const & inset_pos, + int pos, bool greedy = false, bool addarg = true); /// - void removeParameter(Cursor & cur, int pos, bool greedy = false ); + void removeParameter(Cursor & cur, DocIterator const & inset_pos, + int pos, bool greedy = false); /// - void makeOptional(Cursor & cur); + void makeOptional(Cursor & cur, DocIterator const & inset_pos); /// - void makeNonOptional(Cursor & cur); + void makeNonOptional(Cursor & cur, DocIterator const & inset_pos); /// 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; } - /// The label with some holes to edit - mutable MathData label_; + /// + void updateLook() const; + /// look through the macro for #n arguments + int maxArgumentInDefinition() const; + /// add missing #n arguments up to \c maxArg + void insertMissingArguments(int maxArg); + /// change the arity + void changeArity(Cursor & cur, DocIterator const & inset_pos, + int newNumArg); + /// find arguments in definition and adapt the arity accordingly + void commitEditChanges(Cursor & cur, DocIterator const & inset_pos); + /// The representation of the macro template, with some holes to edit + mutable MathData look_; /// mutable int numargs_; /// + mutable int argsInLook_; + /// int optionals_; - /// keeps the old optional default value when an optional argument is disabled + /// keeps the old optional default value when an + /// optional argument is disabled std::vector optionalValues_; - /// newcommand or renewcommand or def - mutable docstring type_; + + /// (re)newcommand or def + mutable MacroType type_; + /// defined before already? + bool redefinition_; + /// + void createLook(int args) 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 commonLabelBoxAscent() const { return labelBoxAscent_; } + /// + int commonLabelBoxDescent() const { return labelBoxDescent_; } };