* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author André Pönitz
+ * \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#ifndef MATH_NESTINSET_H
#define MATH_NESTINSET_H
-#include "InsetMathDim.h"
+#include "InsetMath.h"
+#include "MathData.h"
+#include <map>
namespace lyx {
-
/** Abstract base class for all math objects that contain nested items.
This is basically everything that is not a single character or a
single symbol.
*/
-class InsetMathNest : public InsetMathDim {
+class InsetMathNest : public InsetMath {
public:
/// nestinsets have a fixed size to start with
- explicit InsetMathNest(idx_type ncells);
+ InsetMathNest(Buffer * buf, idx_type ncells);
+ ///
+ virtual ~InsetMathNest();
+ ///
+ void setBuffer(Buffer &);
- /// the size is usually some sort of convex hull of the cells
- /// hides inset::metrics() intentionally!
- void metrics(MetricsInfo const & mi) const;
+ /// Update the cells metrics
+ void cellsMetrics(MetricsInfo const & mi) const;
/// draw background if locked
void draw(PainterInfo & pi, int x, int y) const;
- /// draw selection background
- void drawSelection(PainterInfo & pi, int x, int y) const;
- /// draw decorations.
- void drawDecoration(PainterInfo & pi, int x, int y) const
- { drawMarkers(pi, x, y); }
+ ///
+ void updateBuffer(ParIterator const &, UpdateType);
/// identifies NestInsets
InsetMathNest * asNestInset() { return this; }
/// identifies NestInsets
void cursorPos(BufferView const & bv, CursorSlice const & sl,
bool boundary, int & x, int & y) const;
///
- void edit(LCursor & cur, bool left);
+ void edit(Cursor & cur, bool front,
+ EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
///
- InsetBase * editXY(LCursor & cur, int x, int y);
+ Inset * editXY(Cursor & cur, int x, int y);
+
+ /// order of movement through the cells when moving backwards
+ bool idxBackward(Cursor &) const;
+ /// order of movement through the cells when moving forward
+ bool idxForward(Cursor &) const;
- /// order of movement through the cells when pressing the left key
- bool idxLeft(LCursor &) const;
- /// order of movement through the cells when pressing the right key
- bool idxRight(LCursor &) const;
+ /// move to next cell
+ bool idxNext(Cursor &) const;
+ /// move to previous cell
+ bool idxPrev(Cursor &) const;
- /// move one physical cell up
- bool idxNext(LCursor &) const;
- /// move one physical cell down
- bool idxPrev(LCursor &) const;
+ // The index of the cell entered while moving forward
+ virtual idx_type firstIdx() const { return 0; }
+ // The index of the cell entered while moving backward
+ virtual idx_type lastIdx() const { return nargs() - 1; }
- /// target pos when we enter the inset from the left by pressing "Right"
- bool idxFirst(LCursor &) const;
- /// target pos when we enter the inset from the right by pressing "Left"
- bool idxLast(LCursor &) const;
+ /// target pos when we enter the inset while moving forward
+ bool idxFirst(Cursor &) const;
+ /// target pos when we enter the inset while moving backwards
+ bool idxLast(Cursor &) const;
/// number of cells currently governed by us
idx_type nargs() const;
/// access to the lock
void lock(bool);
/// get notification when the cursor leaves this inset
- bool notifyCursorLeaves(LCursor & cur);
+ bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
- /// direct access to the cell
- MathArray & cell(idx_type);
- /// direct access to the cell
- MathArray const & cell(idx_type) const;
+ //@{
+ /// direct access to the cell.
+ /// Inlined because of performance reasons.
+ MathData & cell(idx_type i) { return cells_[i]; }
+ MathData const & cell(idx_type i) const { return cells_[i]; }
+ //@}
/// can we move into this cell (see macroarg.h)
bool isActive() const;
/// replace in all cells
void replace(ReplaceData &);
/// do we contain a given pattern?
- bool contains(MathArray const &) const;
+ bool contains(MathData const &) const;
/// glue everything to a single cell
- MathArray glue() const;
+ MathData glue() const;
/// debug helper
void dump() const;
/// writes [, name(), and args in []
void normalize(NormalStream & os) const;
///
- int latex(Buffer const &, odocstream & os,
- OutputParams const & runparams) const;
+ void latex(otexstream & os, OutputParams const & runparams) const;
+ ///
+ bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
+ ///
+ bool mouseHovered(BufferView const * bv) const
+ { return mouse_hover_[bv]; }
+
+ ///
+ 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;
+ ///
+ InsetCode lyxCode() const { return MATH_NEST_CODE; }
+
+ ///
+ bool confirmDeletion() const { return nargs() > 0; }
protected:
///
- virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
+ InsetMathNest(InsetMathNest const & inset);
+ ///
+ InsetMathNest & operator=(InsetMathNest const &);
+
+ ///
+ virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
/// do we want to handle this event?
- bool getStatus(LCursor & cur, FuncRequest const & cmd,
+ bool getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & status) const;
///
- void handleFont(LCursor & cur,
+ void handleFont(Cursor & cur,
docstring const & arg, docstring const & font);
- void handleFont(LCursor & cur,
+ void handleFont(Cursor & cur,
docstring const & arg, char const * const font);
///
- void handleFont2(LCursor & cur, docstring const & arg);
+ void handleFont2(Cursor & cur, docstring const & arg);
+ /// Grab and erase selection and insert the InsetMathNest atom in every
+ /// previously selected cell, insert the grabbed former data and \c arg
+ /// in the first cell of the inserted atom.
+ void handleNest(Cursor & cur, MathAtom const & nest);
+ void handleNest(Cursor & cur, MathAtom const & nest, docstring const & arg);
/// interpret \p c and insert the result at the current position of
/// of \p cur. Return whether the cursor should stay in the formula.
- bool interpretChar(LCursor & cur, char_type c);
+ bool interpretChar(Cursor & cur, char_type c);
///
- bool script(LCursor & cur, bool,
- docstring const & save_selection = docstring());
+ bool script(Cursor & cur, bool);
+ bool script(Cursor & cur, bool, docstring const & save_selection);
public:
/// interpret \p str and insert the result at the current position of
/// \p cur if it is something known. Return whether \p cur was
- /// inserted.
- bool interpretString(LCursor & cur, docstring const & str);
+ /// inserted. Handles undo.
+ virtual bool interpretString(Cursor & cur, docstring const & str);
private:
/// lfun handler
- void lfunMousePress(LCursor &, FuncRequest &);
+ void lfunMousePress(Cursor &, FuncRequest &);
///
- void lfunMouseRelease(LCursor &, FuncRequest &);
+ void lfunMouseRelease(Cursor &, FuncRequest &);
///
- void lfunMouseMotion(LCursor &, FuncRequest &);
+ void lfunMouseMotion(Cursor &, FuncRequest &);
+ /// Find a macro to fold or unfold, starting at searchCur and searchCur.nextInset() pointing to a macro
+ /// afterwards if found
+ bool findMacroToFoldUnfold(Cursor & searchCur, bool fold) const;
+ /// move cursor forward
+ bool cursorMathForward(Cursor & cur, bool enter = true);
+ /// move cursor backwards
+ bool cursorMathBackward(Cursor & cur, bool enter = true);
protected:
/// we store the cells in a vector
- typedef std::vector<MathArray> cells_type;
+ typedef std::vector<MathData> cells_type;
/// thusly:
cells_type cells_;
/// if the inset is locked, it can't be entered with the cursor
bool lock_;
+ ///
+ mutable std::map<BufferView const *, bool> mouse_hover_;
};