src/mathed/InsetMathNest.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetMathNest.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef MATH_NESTINSET_H
  13 #define MATH_NESTINSET_H
  14
  15 #include "InsetMath.h"
  16
  17 // FIXME: remove
  18 #include "support/docstring.h"
  19
  20 namespace lyx {
  21
  22 /** Abstract base class for all math objects that contain nested items.
  23     This is basically everything that is not a single character or a
  24     single symbol.
  25 */
  26
  27 class InsetMathNest : public InsetMath {
  28 public:
  29         /// nestinsets have a fixed size to start with
  30         explicit InsetMathNest(idx_type ncells);
  31         ///
  32         virtual ~InsetMathNest() {}
  33         ///
  34         void setBuffer(Buffer &);
  35
  36         /// the size is usually some sort of convex hull of the cells
  37         /// hides inset::metrics() intentionally!
  38         void metrics(MetricsInfo const & mi) const;
  39         /// draw background if locked
  40         void draw(PainterInfo & pi, int x, int y) const;
  41         /// draw selection background
  42         void drawSelection(PainterInfo & pi, int x, int y) const;
  43         /// draw decorations.
  44         void drawDecoration(PainterInfo & pi, int x, int y) const
  45         { drawMarkers(pi, x, y); }
  46         /// identifies NestInsets
  47         InsetMathNest * asNestInset() { return this; }
  48         /// identifies NestInsets
  49         InsetMathNest const * asNestInset() const { return this; }
  50         /// get cursor position
  51         void cursorPos(BufferView const & bv, CursorSlice const & sl,
  52                 bool boundary, int & x, int & y) const;
  53         ///
  54         void edit(Cursor & cur, bool front,
  55                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
  56         ///
  57         Inset * editXY(Cursor & cur, int x, int y);
  58
  59         /// order of movement through the cells when moving backwards
  60         bool idxBackward(Cursor &) const;
  61         /// order of movement through the cells when moving forward
  62         bool idxForward(Cursor &) const;
  63
  64         /// move to next cell
  65         bool idxNext(Cursor &) const;
  66         /// move to previous cell
  67         bool idxPrev(Cursor &) const;
  68
  69         /// target pos when we enter the inset while moving forward
  70         bool idxFirst(Cursor &) const;
  71         /// target pos when we enter the inset while moving backwards
  72         bool idxLast(Cursor &) const;
  73
  74         /// number of cells currently governed by us
  75         idx_type nargs() const;
  76         /// access to the lock
  77         bool lock() const;
  78         /// access to the lock
  79         void lock(bool);
  80         /// get notification when the cursor leaves this inset
  81         bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
  82
  83         /// direct access to the cell.
  84         /// inlined because shows in profile.
  85         //@{
  86         MathData & cell(idx_type i) { return cells_[i]; }
  87         MathData const & cell(idx_type i) const { return cells_[i]; }
  88         //@}
  89
  90         /// can we move into this cell (see macroarg.h)
  91         bool isActive() const;
  92         /// request "external features"
  93         void validate(LaTeXFeatures & features) const;
  94
  95         /// replace in all cells
  96         void replace(ReplaceData &);
  97         /// do we contain a given pattern?
  98         bool contains(MathData const &) const;
  99         /// glue everything to a single cell
 100         MathData glue() const;
 101
 102         /// debug helper
 103         void dump() const;
 104
 105         /// writes \\, name(), and args in braces and '\\lyxlock' if necessary
 106         void write(WriteStream & os) const;
 107         /// writes [, name(), and args in []
 108         void normalize(NormalStream & os) const;
 109         ///
 110         int latex(odocstream & os, OutputParams const & runparams) const;
 111         ///
 112         bool setMouseHover(bool mouse_hover);
 113         ///
 114         bool mouseHovered() const { return mouse_hover_; }
 115
 116         ///
 117         bool completionSupported(Cursor const &) const;
 118         ///
 119         bool inlineCompletionSupported(Cursor const & cur) const;
 120         ///
 121         bool automaticInlineCompletion() const;
 122         ///
 123         bool automaticPopupCompletion() const;
 124         ///
 125         CompletionList const * createCompletionList(Cursor const & cur) const;
 126         ///
 127         docstring completionPrefix(Cursor const & cur) const;
 128         ///
 129         bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
 130         ///
 131         void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
 132         ///
 133         InsetCode lyxCode() const { return MATH_NEST_CODE; }
 134
 135 protected:
 136         ///
 137         InsetMathNest(InsetMathNest const & inset);
 138         ///
 139         InsetMathNest & operator=(InsetMathNest const &);
 140
 141         ///
 142         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 143         /// do we want to handle this event?
 144         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 145                 FuncStatus & status) const;
 146         ///
 147         void handleFont(Cursor & cur,
 148                 docstring const & arg, docstring const & font);
 149         void handleFont(Cursor & cur,
 150                 docstring const & arg, char const * const font);
 151         ///
 152         void handleFont2(Cursor & cur, docstring const & arg);
 153         /// Grab and erase selection and insert the InsetMathNest atom in every
 154         /// previously selected cell, insert the grabbed former data and \c arg
 155         /// in the first cell of the inserted atom.
 156         void handleNest(Cursor & cur, MathAtom const & nest);
 157         void handleNest(Cursor & cur, MathAtom const & nest, docstring const & arg);
 158
 159         /// interpret \p c and insert the result at the current position of
 160         /// of \p cur. Return whether the cursor should stay in the formula.
 161         bool interpretChar(Cursor & cur, char_type c);
 162         ///
 163         bool script(Cursor & cur, bool);
 164         bool script(Cursor & cur, bool, docstring const & save_selection);
 165
 166 public:
 167         /// interpret \p str and insert the result at the current position of
 168         /// \p cur if it is something known. Return whether \p cur was
 169         /// inserted.
 170         bool interpretString(Cursor & cur, docstring const & str);
 171
 172 private:
 173         /// lfun handler
 174         void lfunMousePress(Cursor &, FuncRequest &);
 175         ///
 176         void lfunMouseRelease(Cursor &, FuncRequest &);
 177         ///
 178         void lfunMouseMotion(Cursor &, FuncRequest &);
 179         /// Find a macro to fold or unfold, starting at searchCur and searchCur.nextInset() pointing to a macro
 180         /// afterwards if found
 181         bool findMacroToFoldUnfold(Cursor & searchCur, bool fold) const;
 182         /// move cursor forward
 183         bool cursorMathForward(Cursor & cur);
 184         /// move cursor backwards
 185         bool cursorMathBackward(Cursor & cur);
 186
 187 protected:
 188         /// we store the cells in a vector
 189         typedef std::vector<MathData> cells_type;
 190         /// thusly:
 191         cells_type cells_;
 192         /// if the inset is locked, it can't be entered with the cursor
 193         bool lock_;
 194         ///
 195         bool mouse_hover_;
 196 };
 197
 198
 199
 200 } // namespace lyx
 201 #endif