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