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