X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fmathed%2FMathMacro.h;h=6e795237e197d2b50480c9b69d6f0e19cde108f0;hb=5fdc577badb1cb133d6a0dc7d831bb1f82576adb;hp=54ca2de8c634b706418ed733c3436153a90cf551;hpb=9ac321f28f4c2ea805d8f5db2555e406f144399c;p=lyx.git diff --git a/src/mathed/MathMacro.h b/src/mathed/MathMacro.h index 54ca2de8c6..6e795237e1 100644 --- a/src/mathed/MathMacro.h +++ b/src/mathed/MathMacro.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. */ @@ -14,7 +14,6 @@ #define MATH_MACRO_H #include "InsetMathNest.h" -#include "InsetMathSqrt.h" #include "MacroTable.h" #include "MathData.h" @@ -26,12 +25,22 @@ namespace lyx { class MathMacro : public InsetMathNest { public: /// A macro can be built from an existing template - MathMacro(docstring const & name); + MathMacro(Buffer * buf, docstring const & name); + /// + MathMacro(MathMacro const &); + /// + MathMacro & operator=(MathMacro const &); + /// + ~MathMacro(); /// virtual MathMacro * asMacro() { return this; } /// virtual MathMacro const * asMacro() const { return this; } /// + /// If the macro is in normal edit mode, dissolve its contents in + /// the row. Otherwise, just insert the inset. + bool addToMathRow(MathRow &, MetricsInfo & mi) const; + /// void draw(PainterInfo & pi, int x, int y) const; /// draw selection background void drawSelection(PainterInfo & pi, int x, int y) const; @@ -40,13 +49,15 @@ public: { drawMarkers2(pi, x, y); } /// void metrics(MetricsInfo & mi, Dimension & dim) const; + /// was the macro in edit mode when computing metrics? + bool editMetrics(BufferView const * bv) const; /// int kerning(BufferView const * bv) const; /// get cursor position void cursorPos(BufferView const & bv, CursorSlice const & sl, bool boundary, int & x, int & y) const; /// - void edit(Cursor & cur, bool left); + void edit(Cursor & cur, bool front, EntryDirection entry_from); /// Inset * editXY(Cursor & cur, int x, int y); @@ -56,8 +67,8 @@ public: bool idxLast(Cursor &) const; /// - virtual bool notifyCursorLeaves(Cursor &); - + virtual bool notifyCursorLeaves(Cursor const & old, Cursor & cur); + /// Remove cell (starting from 0) void removeArgument(pos_type pos); /// Insert empty cell (starting from 0) @@ -65,14 +76,24 @@ public: /// void validate(LaTeXFeatures &) const; + /// + mode_type currentMode() const; /// void write(WriteStream & os) const; /// + void normalize(NormalStream & os) const; + /// void maple(MapleStream &) const; /// + void maxima(MaximaStream &) const; + /// + void mathematica(MathematicaStream &) const; + /// void mathmlize(MathStream &) const; /// + void htmlize(HtmlStream &) const; + /// void octave(OctaveStream &) const; /// void infoize(odocstream &) const; @@ -85,98 +106,105 @@ public: void unfold(Cursor & cur); /// will it be folded or unfolded in the next metric call? bool folded() const; - + enum DisplayMode { DISPLAY_INIT, DISPLAY_INTERACTIVE_INIT, DISPLAY_UNFOLDED, - DISPLAY_NORMAL, + DISPLAY_NORMAL }; /// - DisplayMode displayMode() const { return displayMode_; } + DisplayMode displayMode() const; /// - bool extraBraces() const { return displayMode_ == DISPLAY_NORMAL && arity() > 0; } + bool extraBraces() const; /// docstring name() const; + /// FIXME: Often dangling. + MacroData const * macro() const; + /// + docstring macroName() const; + /// Level of nesting in macros (including this one) + int nesting() const; /// bool validName() const; /// - size_t arity() const { - if (displayMode_ == DISPLAY_NORMAL ) - return cells_.size(); - else - return 0; - } - - /// - size_t optionals() const { return optionals_; } - /// - void setOptionals(int n) { - if (n <= int(nargs())) - optionals_ = n; - } - + size_t arity() const; + + /// + size_t optionals() const; + /// + void setOptionals(int n); + /// Return the maximal number of arguments the macro is greedy for. + size_t appetite() const; + /// + InsetCode lyxCode() const { return MATH_MACRO_CODE; } + /// This is not used for display; however whether it is mathrel determines + /// how to split equations intelligently. + MathClass mathClass() const; //override + protected: friend class MathData; friend class ArgumentProxy; friend class Cursor; /// update the display mode (should only be called after detaching arguments) - void setDisplayMode(DisplayMode mode); + void setDisplayMode(DisplayMode mode, int appetite = -1); /// compute the next display mode DisplayMode computeDisplayMode() const; /// update macro definition void updateMacro(MacroContext const & mc); /// check if macro definition changed, argument changed etc. and adapt - void updateRepresentation(Cursor const * bvCur); + void updateRepresentation(Cursor * cur, MacroContext const & mc, + UpdateType, int nesting); /// empty macro, put arguments into args, possibly strip arity-attachedArgsNum_ empty ones. /// Includes the optional arguments. void detachArguments(std::vector & args, bool strip); /// attach arguments (maybe less than arity at the end of an MathData), /// including the optional ones (even if it can be empty here) void attachArguments(std::vector const & args, size_t arity, int optionals); - /// - bool editing(BufferView * bv) { return editing_[bv]; } - /// - MacroData const * macro() { return macro_; } private: + /// Math mode for output and display. UNDECIDED for user macros: they could + /// be either. + mode_type modeToEnsure() const; + /// This function is needed for now because of two shortfalls of the current + /// implementation: the macro() pointer is often dangling, in which case we + /// fall back to a backup copy, and the macro is not known at inset + /// creation, in which case we fall back to the global macro with this name. + MacroData const * macroBackup() const; /// virtual Inset * clone() const; - /// the index of the cursor slice of the macro, or -1 if it is not edited - int cursorIdx(Cursor const & cur) const; - /// - bool editMode(Cursor const & cur) const; - - /// name of macro - docstring name_; - /// current display mode - DisplayMode displayMode_; - /// display mode before change - InsetMathSqrt expanded_; - /// number of arguments that were really attached - size_t attachedArgsNum_; - /// cursor position during last draw - mutable std::map previousCurIdx_; - /// optional argument attached? (only in DISPLAY_NORMAL mode) - size_t optionals_; - /// fold mode to be set in next metrics call? - bool nextFoldMode_; - /// if macro_ == true, then here is a copy of the macro - /// don't use it for locking - MacroData macroBackup_; - /// if macroNotFound_ == false, then here is a reference to the macro - /// this might invalidate after metrics was called - MacroData const * macro_; - /// - mutable std::map editing_; - /// - std::string requires_; - /// update macro representation - bool needsUpdate_; + /// + bool editMode(BufferView const * bv) const; + + /// + class Private; + /// + Private * d; + /// update lock to avoid loops + class UpdateLocker; + friend class UpdateLocker; + +public: + /// + bool completionSupported(Cursor const &) const; + /// + bool inlineCompletionSupported(Cursor const & cur) const; + /// + bool automaticInlineCompletion() const; + /// + bool automaticPopupCompletion() const; + /// + CompletionList const * createCompletionList(Cursor const & cur) const; + /// + docstring completionPrefix(Cursor const & cur) const; + /// + bool insertCompletion(Cursor & cur, docstring const & s, bool finished); + /// + void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const; }; } // namespace lyx