src/mathed/InsetMathHull.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetMathHull.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_HULLINSET_H
  13 #define MATH_HULLINSET_H
  14
  15 #include "InsetMathGrid.h"
  16
  17 #include "DocIterator.h"
  18 #include "OutputEnums.h"
  19
  20 #include <boost/scoped_ptr.hpp>
  21
  22
  23 namespace lyx {
  24
  25 class InsetLabel;
  26 class ParConstIterator;
  27 class RenderPreview;
  28
  29
  30 /// This provides an interface between "LyX insets" and "LyX math insets"
  31 class InsetMathHull : public InsetMathGrid {
  32 public:
  33         /// How a line is numbered
  34         enum Numbered {
  35                 /// not numbered, LaTeX code \\nonumber if line differs from inset
  36                 NONUMBER,
  37                 /// numbered, LaTeX code \\number if line differs from inset
  38                 NUMBER,
  39                 /// not numbered, LaTeX code \\notag if line differs from inset
  40                 NOTAG
  41         };
  42         ///
  43         InsetMathHull(Buffer * buf);
  44         ///
  45         InsetMathHull(Buffer * buf, HullType type);
  46         ///
  47         virtual ~InsetMathHull();
  48         ///
  49         void setBuffer(Buffer &);
  50         ///
  51         void updateBuffer(ParIterator const &, UpdateType);
  52         ///
  53         void addToToc(DocIterator const & di, bool output_active) const;
  54         ///
  55         InsetMathHull & operator=(InsetMathHull const &);
  56         ///
  57         mode_type currentMode() const;
  58         ///
  59         void metrics(MetricsInfo & mi, Dimension & dim) const;
  60         ///
  61         void drawBackground(PainterInfo & pi, int x, int y) const;
  62         ///
  63         void draw(PainterInfo &, int x, int y) const;
  64         ///
  65         void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
  66         ///
  67         void drawT(TextPainter &, int x, int y) const;
  68         ///
  69         docstring label(row_type row) const;
  70         ///
  71         void label(row_type row, docstring const & label);
  72         ///
  73         std::vector<InsetLabel *> const & getLabels() { return label_; }
  74         ///
  75         ColorCode backgroundColor(PainterInfo const &) const;
  76         ///
  77         void numbered(row_type row, bool num) { numbered(row, num ? NUMBER : NONUMBER); }
  78         ///
  79         void numbered(row_type row, Numbered num);
  80         ///
  81         bool numbered(row_type row) const;
  82         ///
  83         bool numberedType() const;
  84         ///
  85         bool ams() const;
  86         ///
  87         void validate(LaTeXFeatures & features) const;
  88         /// identifies HullInset
  89         InsetMathHull const * asHullInset() const { return this; }
  90         /// identifies HullInset
  91         InsetMathHull * asHullInset() { return this; }
  92
  93         /// add a row
  94         void addRow(row_type row);
  95         /// delete a row
  96         void delRow(row_type row);
  97         /// swap two rows
  98         void swapRow(row_type row);
  99         /// add a column
 100         void addCol(col_type col);
 101         /// delete a column
 102         void delCol(col_type col);
 103
 104         /// get type
 105         HullType getType() const;
 106         /// change type
 107         void mutate(HullType newtype);
 108
 109         ///
 110         int defaultColSpace(col_type col);
 111         ///
 112         char defaultColAlign(col_type col);
 113         ///
 114         char displayColAlign(idx_type idx) const;
 115         ///
 116         bool idxFirst(Cursor &) const;
 117         ///
 118         bool idxLast(Cursor &) const;
 119
 120         ///
 121         void write(WriteStream & os) const;
 122         ///
 123         void normalize(NormalStream &) const;
 124         ///
 125         void infoize(odocstream & os) const;
 126
 127         ///
 128         void write(std::ostream & os) const;
 129         ///
 130         void header_write(WriteStream &) const;
 131         ///
 132         void footer_write(WriteStream &) const;
 133         ///
 134         void read(Lexer & lex);
 135         ///
 136         bool readQuiet(Lexer & lex);
 137         ///
 138         int plaintext(odocstringstream &, OutputParams const &,
 139                       size_t max_length = INT_MAX) const;
 140         ///
 141         int docbook(odocstream &, OutputParams const &) const;
 142         ///
 143         docstring xhtml(XHTMLStream &, OutputParams const &) const;
 144         ///
 145         void mathmlize(MathStream &) const;
 146         ///
 147         void htmlize(HtmlStream &) const;
 148         ///
 149         void mathAsLatex(WriteStream &) const;
 150         ///
 151         void toString(odocstream &) const;
 152         ///
 153         void forOutliner(docstring &, size_t) const;
 154
 155         /// get notification when the cursor leaves this inset
 156         bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
 157         ///
 158         //bool insetAllowed(InsetCode code) const;
 159         ///
 160         void addPreview(DocIterator const & inset_pos,
 161                 graphics::PreviewLoader &) const;
 162         /// Recreates the preview if preview is enabled.
 163         void reloadPreview(DocIterator const & pos) const;
 164         ///
 165         void initUnicodeMath() const;
 166
 167         ///
 168         static int displayMargin() { return 12; }
 169
 170         /// Force inset into LTR environment if surroundings are RTL
 171         virtual bool forceLTR() const { return true; }
 172         ///
 173         void recordLocation(DocIterator const & di);
 174
 175         ///
 176         std::string contextMenuName() const;
 177         ///
 178         InsetCode lyxCode() const { return MATH_HULL_CODE; }
 179
 180 protected:
 181         InsetMathHull(InsetMathHull const &);
 182
 183         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 184
 185         /// do we want to handle this event?
 186         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 187                 FuncStatus & status) const;
 188         ///
 189         docstring eolString(row_type row, bool fragile, bool latex,
 190                         bool last_eoln) const;
 191
 192 private:
 193         virtual Inset * clone() const;
 194         /// Prepare the preview if preview is enabled.
 195         /// \param forexport: whether this is intended for export
 196         /// If so, we ignore LyXRC and wait for the image to be generated.
 197         void preparePreview(DocIterator const & pos,
 198                             bool forexport = false) const;
 199         /// like reloadPreview, but forces load
 200         /// used by image export
 201         void loadPreview(DocIterator const & pos) const;
 202         ///
 203         void setType(HullType type);
 204         ///
 205         void validate1(LaTeXFeatures & features);
 206         ///
 207         docstring nicelabel(row_type row) const;
 208         ///
 209         void doExtern(Cursor & cur, FuncRequest & func);
 210         ///
 211         void glueall(HullType type);
 212         /*!
 213          * split every row at the first relation operator.
 214          * The number of columns must be 1. One column is added.
 215          * The first relation operator and everything after it goes to the
 216          * second column.
 217          */
 218         void splitTo2Cols();
 219         /*!
 220          * split every row at the first relation operator.
 221          * The number of columns must be < 3. One or two columns are added.
 222          * The first relation operator goes to the second column.
 223          * Everything after it goes to the third column.
 224          */
 225         void splitTo3Cols();
 226         /// change number of columns, split or combine columns if necessary.
 227         void changeCols(col_type);
 228         ///
 229         docstring standardFont() const;
 230         ///
 231         ColorCode standardColor() const;
 232         /// consistency check
 233         void check() const;
 234         /// can this change its number of rows?
 235         bool rowChangeOK() const;
 236         /// can this change its number of cols?
 237         bool colChangeOK() const;
 238         /// are any of the equations numbered?
 239         bool haveNumbers() const;
 240
 241         /// "none", "simple", "display", "eqnarray",...
 242         HullType type_;
 243         ///
 244         std::vector<Numbered> numbered_;
 245         ///
 246         std::vector<docstring> numbers_;
 247         ///
 248         std::vector<InsetLabel *> label_;
 249         ///
 250         boost::scoped_ptr<RenderPreview> preview_;
 251         ///
 252         mutable bool use_preview_;
 253         ///
 254         DocIterator docit_;
 255         ///
 256         typedef std::map<docstring, int> CounterMap;
 257         /// used to store current values of important counters
 258         CounterMap counter_map;
 259 //
 260 // Incorporate me
 261 //
 262 public:
 263         ///
 264         virtual void mutateToText();
 265         ///
 266         virtual void revealCodes(Cursor & cur) const;
 267         ///
 268         bool editable() const { return true; }
 269         ///
 270         void edit(Cursor & cur, bool front,
 271                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
 272         ///
 273         Inset * editXY(Cursor & cur, int x, int y);
 274         ///
 275         DisplayType display() const;
 276
 277 protected:
 278         ///
 279         void handleFont(Cursor & cur, docstring const & arg,
 280                 docstring const & font);
 281         ///
 282         void handleFont2(Cursor & cur, docstring const & arg);
 283         ///
 284         bool previewState(BufferView const * const bv) const;
 285         ///
 286         bool previewTooSmall(Dimension const & dim) const;
 287 };
 288
 289
 290
 291 } // namespace lyx
 292 #endif