src/insets/insetbase.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insetbase.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author none
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSETBASE_H
  13 #define INSETBASE_H
  14
  15 #include <string>
  16 #include <vector>
  17 #include <memory>
  18
  19 class Buffer;
  20 class BufferView;
  21 class CursorSlice;
  22 class DispatchResult;
  23 class FuncRequest;
  24 class FuncStatus;
  25 class LaTeXFeatures;
  26 class LCursor;
  27 class LyXLex;
  28 class LyXText;
  29 class MathInset;
  30 class MetricsInfo;
  31 class Dimension;
  32 class PainterInfo;
  33 class OutputParams;
  34 class UpdatableInset;
  35
  36 namespace lyx { namespace graphics { class PreviewLoader; } }
  37
  38
  39
  40 /// Common base class to all insets
  41
  42 // Do not add _any_ (non-static) data members as this would inflate
  43 // everything storing large quantities of insets. Mathed e.g. would
  44 // suffer.
  45
  46 class InsetBase {
  47 public:
  48         ///
  49         typedef ptrdiff_t  difference_type;
  50         /// short of anything else reasonable
  51         typedef size_t     size_type;
  52         /// type for cell indices
  53         typedef size_t     idx_type;
  54         /// type for cursor positions
  55         typedef ptrdiff_t  pos_type;
  56         /// type for row numbers
  57         typedef size_t     row_type;
  58         /// type for column numbers
  59         typedef size_t     col_type;
  60
  61         /// virtual base class destructor
  62         virtual ~InsetBase() {}
  63         /// replicate ourselves
  64         virtual std::auto_ptr<InsetBase> clone() const = 0;
  65
  66         /// identification as math inset
  67         virtual MathInset * asMathInset() { return 0; }
  68         /// identification as non-math inset
  69         virtual UpdatableInset * asUpdatableInset() { return 0; }
  70         /// true for 'math' math inset, but not for e.g. mbox
  71         virtual bool inMathed() const { return false; }
  72
  73         // the real dispatcher
  74         void dispatch(LCursor & cur, FuncRequest & cmd);
  75         /// do we want to handle this event?
  76         virtual bool getStatus(LCursor & cur, FuncRequest const & cmd,
  77                 FuncStatus & status) const;
  78
  79         /// cursor enters
  80         virtual void edit(LCursor & cur, bool left);
  81         /// cursor enters
  82         virtual InsetBase * editXY(LCursor & cur, int x, int y);
  83
  84         /// compute the size of the object returned in dim
  85         virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
  86         /// draw inset and update (xo, yo)-cache
  87         virtual void draw(PainterInfo & pi, int x, int y) const = 0;
  88         /// draw inset selection if necessary
  89         virtual void drawSelection(PainterInfo &, int, int) const {}
  90         ///
  91         virtual bool editing(BufferView * bv) const;
  92         /// draw four angular markers
  93         void drawMarkers(PainterInfo & pi, int x, int y) const;
  94         /// draw two angular markers
  95         void drawMarkers2(PainterInfo & pi, int x, int y) const;
  96         /// add space for markers
  97         void metricsMarkers(Dimension & dim, int framesize = 1) const;
  98         /// add space for markers
  99         void metricsMarkers2(Dimension & dim, int framesize = 1) const;
 100         /// last drawn position for 'important' insets
 101         virtual int xo() const { return 0; }
 102         /// last drawn position for 'important' insets
 103         virtual int yo() const { return 0; }
 104         /// set x/y drawing position cache if available
 105         virtual void setPosCache(PainterInfo const &, int, int) const {}
 106         /// do we cover screen position x/y?
 107         virtual bool covers(int x, int y) const;
 108         /// get the screen positions of the cursor (see note in cursor.C)
 109         virtual void getCursorPos(CursorSlice const & cur, int & x, int & y) const;
 110
 111         /// is this an inset that can be moved into?
 112         virtual bool isActive() const { return nargs() > 0; }
 113         /// Where should we go when we press the up or down cursor key?
 114         virtual bool idxUpDown(LCursor & cur, bool up) const;
 115         /// Where should we go when we press the up or down cursor key?
 116         virtual bool idxUpDown2(LCursor & cur, bool up) const;
 117         /// Move one cell to the left
 118         virtual bool idxLeft(LCursor &) const { return false; }
 119         /// Move one cell to the right
 120         virtual bool idxRight(LCursor &) const { return false; }
 121
 122         /// Move one physical cell up
 123         virtual bool idxNext(LCursor &) const { return false; }
 124         /// Move one physical cell down
 125         virtual bool idxPrev(LCursor &) const { return false; }
 126
 127         /// Target pos when we enter the inset from the left by pressing "Right"
 128         virtual bool idxFirst(LCursor &) const { return false; }
 129         /// Target pos when we enter the inset from the right by pressing "Left"
 130         virtual bool idxLast(LCursor &) const { return false; }
 131
 132         /// Delete a cell and move cursor
 133         virtual bool idxDelete(idx_type &) { return false; }
 134         /// pulls cell after pressing erase
 135         virtual void idxGlue(idx_type) {}
 136         // returns list of cell indices that are "between" from and to for
 137         // selection purposes
 138         virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
 139
 140         /// to which column belongs a cell with a given index?
 141         virtual col_type col(idx_type) const { return 0; }
 142         /// to which row belongs a cell with a given index?
 143         virtual row_type row(idx_type) const { return 0; }
 144         /// cell idex corresponding to row and column;
 145         virtual idx_type index(row_type row, col_type col) const;
 146         /// any additional x-offset when drawing a cell?
 147         virtual int cellXOffset(idx_type) const { return 0; }
 148         /// any additional y-offset when drawing a cell?
 149         virtual int cellYOffset(idx_type) const { return 0; }
 150         /// number of embedded cells
 151         virtual size_t nargs() const { return 0; }
 152         /// number of rows in gridlike structures
 153         virtual size_t nrows() const { return 0; }
 154         /// number of columns in gridlike structures
 155         virtual size_t ncols() const { return 0; }
 156         /// is called when the cursor leaves this inset
 157         virtual void notifyCursorLeaves(LCursor &) {}
 158
 159         /// request "external features"
 160         virtual void validate(LaTeXFeatures &) const {}
 161         /// Appends \c list with all labels found within this inset.
 162         virtual void getLabelList(Buffer const &,
 163                                   std::vector<std::string> & /* list */) const {}
 164
 165         /// describe content if cursor inside
 166         virtual void infoize(std::ostream &) const {}
 167         /// describe content if cursor behind
 168         virtual void infoize2(std::ostream &) const {}
 169
 170         /// plain ascii output
 171         virtual int plaintext(Buffer const &, std::ostream & os,
 172                 OutputParams const &) const;
 173         /// linuxdoc output
 174         virtual int linuxdoc(Buffer const &, std::ostream & os,
 175                 OutputParams const &) const;
 176         /// docbook output
 177         virtual int docbook(Buffer const &, std::ostream & os,
 178                 OutputParams const &) const;
 179
 180         ///
 181         enum EDITABLE {
 182                 ///
 183                 NOT_EDITABLE = 0,
 184                 ///
 185                 IS_EDITABLE,
 186                 ///
 187                 HIGHLY_EDITABLE
 188         };
 189         /// what appears in the minibuffer when opening
 190         virtual std::string const editMessage() const;
 191         ///
 192         virtual EDITABLE editable() const;
 193         /// can we go further down on mouse click?
 194         virtual bool descendable() const { return false; }
 195         ///
 196         virtual bool isTextInset() const { return false; }
 197         /// return true if the inset should be removed automatically
 198         virtual bool autoDelete() const;
 199
 200         /** This is not quite the correct place for this enum. I think
 201             the correct would be to let each subclass of Inset declare
 202             its own enum code. Actually the notion of an InsetOld::Code
 203             should be avoided, but I am not sure how this could be done
 204             in a cleaner way. */
 205         enum Code {
 206                 ///
 207                 NO_CODE, // 0
 208                 ///
 209                 TOC_CODE,  // do these insets really need a code? (ale)
 210                 ///
 211                 QUOTE_CODE,
 212                 ///
 213                 MARK_CODE,
 214                 ///
 215                 REF_CODE,
 216                 ///
 217                 URL_CODE, // 5
 218                 ///
 219                 HTMLURL_CODE,
 220                 ///
 221                 SEPARATOR_CODE,
 222                 ///
 223                 ENDING_CODE,
 224                 ///
 225                 LABEL_CODE,
 226                 ///
 227                 NOTE_CODE, // 10
 228                 ///
 229                 ACCENT_CODE,
 230                 ///
 231                 MATH_CODE,
 232                 ///
 233                 INDEX_CODE,
 234                 ///
 235                 INCLUDE_CODE,
 236                 ///
 237                 GRAPHICS_CODE, // 15
 238                 ///
 239                 BIBITEM_CODE,
 240                 ///
 241                 BIBTEX_CODE,
 242                 ///
 243                 TEXT_CODE,
 244                 ///
 245                 ERT_CODE,
 246                 ///
 247                 FOOT_CODE, // 20
 248                 ///
 249                 MARGIN_CODE,
 250                 ///
 251                 FLOAT_CODE,
 252                 ///
 253                 WRAP_CODE,
 254                 ///
 255                 SPACE_CODE, // 25
 256                 ///
 257                 SPECIALCHAR_CODE,
 258                 ///
 259                 TABULAR_CODE,
 260                 ///
 261                 EXTERNAL_CODE,
 262 #if 0
 263                 ///
 264                 THEOREM_CODE,
 265 #endif
 266                 ///
 267                 CAPTION_CODE,
 268                 ///
 269                 MATHMACRO_CODE, // 30
 270                 ///
 271                 ERROR_CODE,
 272                 ///
 273                 CITE_CODE,
 274                 ///
 275                 FLOAT_LIST_CODE,
 276                 ///
 277                 INDEX_PRINT_CODE,
 278                 ///
 279                 OPTARG_CODE, // 35
 280                 ///
 281                 ENVIRONMENT_CODE,
 282                 ///
 283                 HFILL_CODE,
 284                 ///
 285                 NEWLINE_CODE,
 286                 ///
 287                 LINE_CODE,
 288                 ///
 289                 BRANCH_CODE, // 40
 290                 ///
 291                 BOX_CODE,
 292                 ///
 293                 CHARSTYLE_CODE,
 294                 ///
 295                 VSPACE_CODE,
 296                 ///
 297                 MATHGRID_CODE,
 298                 ///
 299                 MATHHULL_CODE
 300         };
 301
 302         /** returns the Code corresponding to the \c name.
 303          *  Eg, translate("branch") == BRANCH_CODE
 304          */
 305         static Code translate(std::string const & name);
 306
 307         /// returns true the inset can hold an inset of given type
 308         virtual bool insetAllowed(Code) const { return false; }
 309         // if this inset has paragraphs should they be output all as default
 310         // paragraphs with "Standard" layout?
 311         virtual bool forceDefaultParagraphs(InsetBase const *) const { return false; }
 312         ///
 313         virtual std::string const & getInsetName() const;
 314         /// used to toggle insets
 315         // is the inset open?
 316         virtual bool isOpen() const { return false; }
 317         /// open the inset
 318         virtual void open() {}
 319         /// close the inset
 320         virtual void close() {}
 321         // should this inset be handled like a normal charater
 322         virtual bool isChar() const { return false; }
 323         // is this equivalent to a letter?
 324         virtual bool isLetter() const { return false; }
 325         // is this equivalent to a space (which is BTW different from
 326         // a line separator)?
 327         virtual bool isSpace() const { return false; }
 328         // should we have a non-filled line before this inset?
 329         virtual bool display() const { return false; }
 330         // should we break lines after this inset?
 331         virtual bool isLineSeparator() const { return false; }
 332         /// dumps content to lyxerr
 333         virtual void dump() const;
 334         ///
 335         virtual void write(Buffer const &, std::ostream &) const {}
 336         ///
 337         virtual void read(Buffer const &, LyXLex &) {}
 338         /// returns the number of rows (\n's) of generated tex code.
 339         virtual int latex(Buffer const &, std::ostream &,
 340                           OutputParams const &) const { return 0; }
 341         /// returns true to override begin and end inset in file
 342         virtual bool directWrite() const;
 343         ///
 344         virtual bool allowSpellCheck() const { return false; }
 345
 346         /// if this insets owns text cells (e.g. InsetText) return cell num
 347         virtual LyXText * getText(int /*num*/) const { return 0; }
 348
 349         /** Adds a LaTeX snippet to the Preview Loader for transformation
 350          *  into a bitmap image. Does not start the laoding process.
 351          *
 352          *  Most insets have no interest in this capability, so the method
 353          *  defaults to empty.
 354          */
 355         virtual void addPreview(lyx::graphics::PreviewLoader &) const {}
 356 protected:
 357         // the real dispatcher
 358         virtual void priv_dispatch(LCursor & cur, FuncRequest & cmd);
 359 public:
 360         /// returns LyX code associated with the inset. Used for TOC, ...)
 361         virtual Code lyxCode() const { return NO_CODE; }
 362
 363         /// -1: text mode, 1: math mode, 0 undecided
 364         enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
 365         /// return text or mathmode if that is possible to determine
 366         virtual mode_type currentMode() const { return UNDECIDED_MODE; }
 367
 368         /// is this inset allowed within a font change?
 369         virtual bool noFontChange() const { return false; }
 370
 371         ///
 372         virtual void markErased();
 373         /// pretty arbitrary
 374         virtual int width() const { return 10; }
 375         /// pretty arbitrary
 376         virtual int ascent() const { return 10; }
 377         /// pretty arbitrary
 378         virtual int descent() const { return 10; }
 379 };
 380
 381
 382 /**
 383  * returns true if pointer argument is valid
 384  * and points to an editable inset
 385  */
 386 bool isEditableInset(InsetBase const * inset);
 387
 388
 389 /**
 390  * returns true if pointer argument is valid
 391  * and points to a highly editable inset
 392  */
 393 bool isHighlyEditableInset(InsetBase const * inset);
 394
 395 #endif