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