]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/MathMacro.h
Merge branch 'master' of git.lyx.org:lyx
[lyx.git] / src / mathed / MathMacro.h
index 45239e83eba630d41cd517af3f9994ef8e928ef1..b7308562ff2df2c26b58733081e78e2a3e8522e8 100644 (file)
@@ -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.
  */
 #include "MacroTable.h"
 #include "MathData.h"
 
-namespace lyx {
+#include <map>
 
+namespace lyx {
 
 /// This class contains the data for a macro.
 class MathMacro : public InsetMathNest {
 public:
        /// A macro can be built from an existing template
-       MathMacro(docstring const & name);
+       MathMacro(Buffer * buf, docstring const & name);
        ///
        virtual MathMacro * asMacro() { return this; }
        ///
@@ -40,27 +41,27 @@ public:
        ///
        void metrics(MetricsInfo & mi, Dimension & dim) const;
        ///
-       int kerning() 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);
 
-       /// target pos when we enter the inset from the left by pressing "Right"
+       /// target pos when we enter the inset while moving forward
        bool idxFirst(Cursor &) const;
-       /// target pos when we enter the inset from the right by pressing "Left"
+       /// target pos when we enter the inset while moving backwards
        bool idxLast(Cursor &) const;
 
        ///
-       virtual bool notifyCursorLeaves(Cursor &);
+       virtual bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
        
        /// Remove cell (starting from 0)
-       void removeArgument(size_t pos);
+       void removeArgument(pos_type pos);
        /// Insert empty cell (starting from 0)
-       void insertArgument(size_t pos);
+       void insertArgument(pos_type pos);
 
        ///
        void validate(LaTeXFeatures &) const;
@@ -68,10 +69,14 @@ public:
        ///
        void write(WriteStream & os) const;
        ///
+       void normalize(NormalStream & os) const;
+       ///
        void maple(MapleStream &) const;
        ///
        void mathmlize(MathStream &) const;
        ///
+       void htmlize(HtmlStream &) const;
+       ///
        void octave(OctaveStream &) const;
        ///
        void infoize(odocstream &) const;
@@ -87,9 +92,9 @@ public:
                
        enum DisplayMode {
                DISPLAY_INIT,
-               DISPLAY_NONGREEDY_INIT,
+               DISPLAY_INTERACTIVE_INIT,
                DISPLAY_UNFOLDED,
-               DISPLAY_NORMAL,
+               DISPLAY_NORMAL
        };
 
        ///
@@ -98,7 +103,6 @@ public:
        ///
        bool extraBraces() const { return displayMode_ == DISPLAY_NORMAL && arity() > 0; }
 
-       
        ///
        docstring name() const;
        ///
@@ -112,26 +116,30 @@ public:
        }
                
        ///
-       int optionals() const { return optionals_; }
+       size_t optionals() const { return optionals_; }
        ///
        void setOptionals(int n) { 
                if (n <= int(nargs()))
                        optionals_ = n;
        }
-       
+       /// Return the maximal number of arguments the macro is greedy for.
+       size_t appetite() const { return appetite_; }
+       ///
+       InsetCode lyxCode() const { return MATH_MACRO_CODE; }
+
 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(MetricsInfo const & mi) const;
+       DisplayMode computeDisplayMode() const;
        /// update macro definition
-       void updateMacro(MetricsInfo & mi);
+       void updateMacro(MacroContext const & mc);
        /// check if macro definition changed, argument changed etc. and adapt
-       void updateRepresentation(MetricsInfo & mi);
+       void updateRepresentation(Cursor * cur, MacroContext const & mc, UpdateType);
        /// empty macro, put arguments into args, possibly strip arity-attachedArgsNum_ empty ones.
        /// Includes the optional arguments.
        void detachArguments(std::vector<MathData> & args, bool strip);
@@ -139,30 +147,28 @@ protected:
        /// including the optional ones (even if it can be empty here)
        void attachArguments(std::vector<MathData> const & args, size_t arity, int optionals);
        ///
-       bool editing() { return editing_; }
-       ///
        MacroData const * macro() { return macro_; }
+       ///
+       bool editMetrics(BufferView const * bv) const;
 
 private:
        ///
        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;
+       bool editMode(BufferView const * bv) const;
        
        /// name of macro
        docstring name_;
        /// current display mode
        DisplayMode displayMode_;
-       /// display mode before change
+       /// expanded macro with ArgumentProxies
        InsetMathSqrt expanded_;
+       /// macro definition with #1,#2,.. insets
+       MathData definition_;
        /// number of arguments that were really attached
        size_t attachedArgsNum_;
-       /// cursor position during last draw
-       int previousCurIdx_;
        /// optional argument attached? (only in DISPLAY_NORMAL mode)
-       int optionals_;
+       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
@@ -172,11 +178,31 @@ private:
        /// this might invalidate after metrics was called
        MacroData const * macro_;
        ///
-       bool editing_;
+       mutable std::map<BufferView const *, bool> editing_;
        ///
        std::string requires_;
        /// update macro representation
        bool needsUpdate_;
+       /// maximal number of arguments the macro is greedy for
+       size_t appetite_;
+
+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