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