src/insets/Inset.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Inset.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alejandro Aguilar Sierra
   8  * \author Jürgen Vigna
   9  * \author Lars Gullik Bjønnes
  10  * \author Matthias Ettrich
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef INSETBASE_H
  16 #define INSETBASE_H
  17
  18 #include "ColorCode.h"
  19 #include "InsetCode.h"
  20 #include "Layout.h"
  21
  22 #include "support/strfwd.h"
  23 #include "support/types.h"
  24
  25
  26 namespace lyx {
  27
  28 class BiblioInfo;
  29 class Buffer;
  30 class BufferParams;
  31 class BufferView;
  32 class Change;
  33 class CompletionList;
  34 class Cursor;
  35 class CursorSlice;
  36 class Dimension;
  37 class DocIterator;
  38 class FuncRequest;
  39 class FuncStatus;
  40 class InsetCollapsable;
  41 class InsetIterator;
  42 class InsetLayout;
  43 class InsetList;
  44 class InsetMath;
  45 class InsetTabular;
  46 class InsetText;
  47 class LaTeXFeatures;
  48 class Lexer;
  49 class MathAtom;
  50 class MetricsInfo;
  51 class OutputParams;
  52 class PainterInfo;
  53 class ParConstIterator;
  54 class ParIterator;
  55 class Text;
  56 class TocList;
  57
  58 namespace graphics { class PreviewLoader; }
  59
  60
  61 /** returns the InsetCode corresponding to the \c name.
  62 *   Eg, insetCode("branch") == BRANCH_CODE
  63 *   Implemented in 'Inset.cpp'.
  64 */
  65 InsetCode insetCode(std::string const & name);
  66 /// the other way
  67 std::string insetName(InsetCode);
  68
  69 /// Common base class to all insets
  70
  71 // Do not add _any_ (non-static) data members as this would inflate
  72 // everything storing large quantities of insets. Mathed e.g. would
  73 // suffer.
  74
  75 class Inset {
  76 public:
  77         ///
  78         enum EntryDirection {
  79                 ENTRY_DIRECTION_IGNORE,
  80                 ENTRY_DIRECTION_RIGHT,
  81                 ENTRY_DIRECTION_LEFT,
  82         };
  83         ///
  84         typedef ptrdiff_t  difference_type;
  85         /// short of anything else reasonable
  86         typedef size_t     size_type;
  87         /// type for cell indices
  88         typedef size_t     idx_type;
  89         /// type for cursor positions
  90         typedef ptrdiff_t  pos_type;
  91         /// type for row numbers
  92         typedef size_t     row_type;
  93         /// type for column numbers
  94         typedef size_t     col_type;
  95
  96         /// virtual base class destructor
  97         virtual ~Inset() {}
  98
  99         /// change associated Buffer
 100         /// FIXME this should go.
 101         virtual void setBuffer(Buffer & buffer);
 102         /// retrieve associated Buffer
 103         virtual Buffer & buffer();
 104         virtual Buffer const & buffer() const;
 105         /// This checks whether the Buffer * actually points to an open
 106         /// Buffer. It might not if that Buffer has been closed.
 107         bool isBufferValid() const;
 108
 109         /// initialize view for this inset.
 110         /**
 111           * This is typically used after this inset is created interactively.
 112           * Intented purpose is to sanitize internal state with regard to current
 113           * Buffer. The default implementation calls updateLabels(buffer()) is
 114           * the inset is labeled.
 115           *
 116           * \sa isLabeled()
 117           **/
 118         virtual void initView();
 119         /// \return true if this inset is labeled.
 120         virtual bool isLabeled() const { return false; }
 121
 122         /// identification as math inset
 123         virtual InsetMath * asInsetMath() { return 0; }
 124         /// true for 'math' math inset, but not for e.g. mbox
 125         virtual bool inMathed() const { return false; }
 126         /// is this inset based on the InsetText class?
 127         virtual InsetText * asInsetText() { return 0; }
 128         /// is this inset based on the InsetText class?
 129         virtual InsetText const * asInsetText() const { return 0; }
 130         /// is this inset based on the InsetCollapsable class?
 131         virtual InsetCollapsable * asInsetCollapsable() { return 0; }
 132         /// is this inset based on the InsetCollapsable class?
 133         virtual InsetCollapsable const * asInsetCollapsable() const { return 0; }
 134         /// is this inset based on the InsetTabular class?
 135         virtual InsetTabular * asInsetTabular() { return 0; }
 136         /// is this inset based on the InsetTabular class?
 137         virtual InsetTabular const * asInsetTabular() const { return 0; }
 138
 139         /// the real dispatcher
 140         void dispatch(Cursor & cur, FuncRequest & cmd);
 141         /**
 142          * \returns true if this function made a definitive decision on
 143          * whether the inset wants to handle the request \p cmd or not.
 144          * The result of this decision is put into \p status.
 145          *
 146          * Every request that is enabled in this method needs to be handled
 147          * in doDispatch(). Normally we have a 1:1 relationship between the
 148          * requests handled in getStatus() and doDispatch(), but there are
 149          * some exceptions:
 150          * - A request that is disabled in getStatus() does not need to
 151          *   appear in doDispatch(). It is guaranteed that doDispatch()
 152          *   is never called with this request.
 153          * - A few requests are en- or disabled in Inset::getStatus().
 154          *   These need to be handled in the doDispatch() methods of the
 155          *   derived insets, since Inset::doDispatch() has not enough
 156          *   information to handle them.
 157          * - LFUN_MOUSE_* need not to be handled in getStatus(), because these
 158          *   are dispatched directly
 159          */
 160         virtual bool getStatus(Cursor & cur, FuncRequest const & cmd,
 161                 FuncStatus & status) const;
 162
 163         /// cursor enters
 164         virtual void edit(Cursor & cur, bool front,
 165                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
 166         /// cursor enters
 167         virtual Inset * editXY(Cursor & cur, int x, int y);
 168
 169         /// compute the size of the object returned in dim
 170         /// \retval true if metrics changed.
 171         virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
 172         /// draw inset and update (xo, yo)-cache
 173         virtual void draw(PainterInfo & pi, int x, int y) const = 0;
 174         /// draw inset selection if necessary
 175         virtual void drawSelection(PainterInfo &, int, int) const {}
 176         ///
 177         virtual bool editing(BufferView const * bv) const;
 178         ///
 179         virtual bool showInsetDialog(BufferView *) const { return false; }
 180
 181         /// draw inset decoration if necessary.
 182         /// This can use \c drawMarkers() for example.
 183         virtual void drawDecoration(PainterInfo &, int, int) const {}
 184         /// draw four angular markers
 185         void drawMarkers(PainterInfo & pi, int x, int y) const;
 186         /// draw two angular markers
 187         void drawMarkers2(PainterInfo & pi, int x, int y) const;
 188         /// add space for markers
 189         void metricsMarkers(Dimension & dim, int framesize = 1) const;
 190         /// add space for markers
 191         void metricsMarkers2(Dimension & dim, int framesize = 1) const;
 192         /// last drawn position for 'important' insets
 193         int xo(BufferView const & bv) const;
 194         /// last drawn position for 'important' insets
 195         int yo(BufferView const & bv) const;
 196         /// set x/y drawing position cache if available
 197         virtual void setPosCache(PainterInfo const &, int, int) const;
 198         ///
 199         void setDimCache(MetricsInfo const &, Dimension const &) const;
 200         /// do we cover screen position x/y?
 201         virtual bool covers(BufferView const & bv, int x, int y) const;
 202         /// get the screen positions of the cursor (see note in Cursor.cpp)
 203         virtual void cursorPos(BufferView const & bv,
 204                 CursorSlice const & sl, bool boundary, int & x, int & y) const;
 205
 206         ///
 207         virtual bool isFreeSpacing() const { return false; }
 208         ///
 209         virtual bool allowEmpty() const { return false; }
 210         /// Force inset into LTR environment if surroundings are RTL?
 211         virtual bool forceLTR() const { return false; }
 212
 213         /// is this an inset that can be moved into?
 214         /// FIXME: merge with editable()
 215         virtual bool isActive() const { return nargs() > 0; }
 216         /// Where should we go when we press the up or down cursor key?
 217         virtual bool idxUpDown(Cursor & cur, bool up) const;
 218         /// Move one cell backwards
 219         virtual bool idxBackward(Cursor &) const { return false; }
 220         /// Move one cell forward
 221         virtual bool idxForward(Cursor &) const { return false; }
 222
 223         /// Move to the next cell
 224         virtual bool idxNext(Cursor &) const { return false; }
 225         /// Move to the previous cell
 226         virtual bool idxPrev(Cursor &) const { return false; }
 227
 228         /// Target pos when we enter the inset while moving forward
 229         virtual bool idxFirst(Cursor &) const { return false; }
 230         /// Target pos when we enter the inset while moving backwards
 231         virtual bool idxLast(Cursor &) const { return false; }
 232
 233         /// Delete a cell and move cursor
 234         virtual bool idxDelete(idx_type &) { return false; }
 235         /// pulls cell after pressing erase
 236         virtual void idxGlue(idx_type) {}
 237         /// returns list of cell indices that are "between" from and to for
 238         /// selection purposes
 239         virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
 240
 241         /// to which column belongs a cell with a given index?
 242         virtual col_type col(idx_type) const { return 0; }
 243         /// to which row belongs a cell with a given index?
 244         virtual row_type row(idx_type) const { return 0; }
 245         /// cell index corresponding to row and column;
 246         virtual idx_type index(row_type row, col_type col) const;
 247         /// any additional x-offset when drawing a cell?
 248         virtual int cellXOffset(idx_type) const { return 0; }
 249         /// any additional y-offset when drawing a cell?
 250         virtual int cellYOffset(idx_type) const { return 0; }
 251         /// number of embedded cells
 252         virtual size_t nargs() const { return 0; }
 253         /// number of rows in gridlike structures
 254         virtual size_t nrows() const { return 0; }
 255         /// number of columns in gridlike structures
 256         virtual size_t ncols() const { return 0; }
 257         /// Is called when the cursor leaves this inset.
 258         /// Returns true if cursor is now invalid, e.g. if former
 259         /// insets in higher cursor slices of \c old do not exist
 260         /// anymore.
 261         /// \c old is the old cursor, i.e. there is a slice pointing to this.
 262         /// \c cur is the new cursor. Use the update flags to cause a redraw.
 263         virtual bool notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/)
 264                 { return false; }
 265         /// is called when the mouse enter or leave this inset
 266         /// return true if this inset needs repaint
 267         virtual bool setMouseHover(bool) { return false; }
 268         /// return true if this inset is hovered (under mouse)
 269         /// This is by now only used by mathed to draw corners
 270         /// (Inset::drawMarkers() and Inset::drawMarkers2()).
 271         /// Other insets do not have to redefine this function to
 272         /// return the correct status of mouseHovered.
 273         virtual bool mouseHovered() const { return false; }
 274
 275         /// request "external features"
 276         virtual void validate(LaTeXFeatures &) const {}
 277
 278         /// describe content if cursor inside
 279         virtual void infoize(odocstream &) const {}
 280         /// describe content if cursor behind
 281         virtual void infoize2(odocstream &) const {}
 282
 283         enum { PLAINTEXT_NEWLINE = 10000 };
 284
 285         /// plain text output in ucs4 encoding
 286         /// return the number of characters; in case of multiple lines of
 287         /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line
 288         virtual int plaintext(odocstream &, OutputParams const &) const = 0;
 289         /// docbook output
 290         virtual int docbook(odocstream & os, OutputParams const &) const;
 291         /// the string that is passed to the TOC
 292         virtual void textString(odocstream &) const {}
 293
 294         /** This enum indicates by which means the inset can be modified:
 295         - NOT_EDITABLE: the inset's content cannot be modified at all
 296           (e.g. printindex, insetspecialchar)
 297         - IS_EDITABLE: content can be edited via dialog (e.g. bibtex, index, href)
 298         - HIGHLY_EDITABLE: content can be edited on screen (normally means that
 299           insettext is contained, e.g. collapsables, tabular) */
 300         // FIXME: This has not yet been fully implemented to math insets
 301         enum EDITABLE {
 302                 ///
 303                 NOT_EDITABLE = 0,
 304                 ///
 305                 IS_EDITABLE,
 306                 ///
 307                 HIGHLY_EDITABLE
 308         };
 309         /// what appears in the minibuffer when opening
 310         virtual docstring editMessage() const;
 311         ///
 312         virtual EDITABLE editable() const;
 313         /// can we go further down on mouse click?
 314         virtual bool descendable() const { return false; }
 315         /// does this contain text that can be change track marked in DVI?
 316         virtual bool canTrackChanges() const { return false; }
 317         /// return true if the inset should be removed automatically
 318         virtual bool autoDelete() const;
 319
 320         /// Returns true if the inset supports completions.
 321         virtual bool completionSupported(Cursor const &) const { return false; }
 322         /// Returns true if the inset supports inline completions at the
 323         /// cursor position. In this case the completion might be stored
 324         /// in the BufferView's inlineCompletion property.
 325         virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const
 326                 { return false; }
 327         /// Return true if the inline completion should be automatic.
 328         virtual bool automaticInlineCompletion() const { return true; }
 329         /// Return true if the popup completion should be automatic.
 330         virtual bool automaticPopupCompletion() const { return true; }
 331         /// Return true if the cursor should indicate a completion.
 332         virtual bool showCompletionCursor() const { return true; }
 333         /// Returns completion suggestions at cursor position. Return an
 334         /// null pointer if no completion is a available or possible.
 335         /// The caller is responsible to free the returned object!
 336         virtual CompletionList const * createCompletionList(Cursor const &) const
 337                 { return 0; }
 338         /// Returns the completion prefix to filter the suggestions for completion.
 339         /// This is only called if completionList returned a non-null list.
 340         virtual docstring completionPrefix(Cursor const &) const;
 341         /// Do a completion at the cursor position. Return true on success.
 342         /// The completion does not contain the prefix. If finished is true, the
 343         /// completion is final. If finished is false, completion might only be
 344         /// a partial completion.
 345         virtual bool insertCompletion(Cursor & /*cur*/,
 346                 docstring const & /*completion*/, bool /*finished*/)
 347                 { return false; }
 348         /// Get the completion inset position and size
 349         virtual void completionPosAndDim(Cursor const &, int & /*x*/, int & /*y*/,
 350                 Dimension & /*dim*/) const {}
 351
 352         /// returns true if the inset can hold an inset of given type
 353         virtual bool insetAllowed(InsetCode) const { return false; }
 354         /// should this inset use the empty layout by default rather than
 355         /// the standard layout? (default: only if that is forced.)
 356         virtual bool usePlainLayout() const { return forcePlainLayout(); }
 357         /// if this inset has paragraphs should they be forced to use the
 358         /// empty layout?
 359         virtual bool forcePlainLayout(idx_type = 0) const { return false; }
 360         /// if this inset has paragraphs should the user be allowed to
 361         /// customize alignment, etc?
 362         virtual bool allowParagraphCustomization(idx_type = 0) const { return true; }
 363         /// Is the width forced to some value?
 364         virtual bool hasFixedWidth() const { return false; }
 365
 366         /// Is the content of this inset part of the output document?
 367         virtual bool producesOutput() const { return true; }
 368
 369         /// \return Tool tip for this inset.
 370         /// This default implementation returns an empty string.
 371         virtual docstring toolTip(BufferView const & bv, int x, int y) const;
 372
 373         /// \return Context menu identifier for this inset.
 374         /// This default implementation returns an empty string.
 375         virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
 376
 377         // FIXME This should really disappear in favor of
 378         //      docstring name() const { return from_ascii(insetName(lyxCode()))); }
 379         // There's no reason to be using different names in different places.
 380         // But to do this we would need to change the file format, since the names
 381         // used there don't correspond to what is used here.
 382         ///
 383         virtual docstring name() const;
 384         ///
 385         virtual InsetLayout const & getLayout(BufferParams const & bp) const;
 386         /// used to toggle insets
 387         /// is the inset open?
 388         /// should this inset be handled like a normal charater
 389         virtual bool isChar() const { return false; }
 390         /// is this equivalent to a letter?
 391         virtual bool isLetter() const { return false; }
 392         /// is this equivalent to a space (which is BTW different from
 393         /// a line separator)?
 394         virtual bool isSpace() const { return false; }
 395         /// is this an expandible space (rubber length)?
 396         virtual bool isStretchableSpace() const { return false; }
 397
 398         enum DisplayType {
 399                 Inline = 0,
 400                 AlignLeft,
 401                 AlignCenter,
 402                 AlignRight
 403         };
 404
 405         /// should we have a non-filled line before this inset?
 406         virtual DisplayType display() const { return Inline; }
 407         ///
 408         virtual LyXAlignment contentAlignment() const { return LYX_ALIGN_NONE; }
 409         /// should we break lines after this inset?
 410         virtual bool isLineSeparator() const { return false; }
 411         /// should paragraph indendation be ommitted in any case?
 412         virtual bool neverIndent() const { return false; }
 413         /// dumps content to lyxerr
 414         virtual void dump() const;
 415         /// write inset in .lyx format
 416         virtual void write(std::ostream &) const {}
 417         /// read inset in .lyx format
 418         virtual void read(Lexer &) {}
 419         /** Export the inset to LaTeX.
 420          *  Don't use a temporary stringstream if the final output is
 421          *  supposed to go to a file.
 422          *  \sa Buffer::writeLaTeXSource for the reason.
 423          *  \return the number of rows (\n's) of generated LaTeX code.
 424          */
 425         virtual int latex(odocstream &, OutputParams const &) const { return 0; }
 426         /// returns true to override begin and end inset in file
 427         virtual bool directWrite() const;
 428         ///
 429         virtual bool allowSpellCheck() const { return false; }
 430
 431         /// if this insets owns text cells (e.g. InsetText) return cell num
 432         virtual Text * getText(int /*num*/) const { return 0; }
 433
 434         /** Adds a LaTeX snippet to the Preview Loader for transformation
 435          *  into a bitmap image. Does not start the laoding process.
 436          *
 437          *  Most insets have no interest in this capability, so the method
 438          *  defaults to empty.
 439          */
 440         virtual void addPreview(graphics::PreviewLoader &) const {}
 441
 442         /** Classifies the unicode characters appearing in a math inset
 443          *  depending on whether they are to be translated as latex
 444          *  math/text commands or used as math symbols without translation.
 445          *
 446          *  Only math insets have interest in this classification, so the
 447          *  method defaults to empty.
 448          */
 449         virtual void initUnicodeMath() const {}
 450
 451         /// Add an entry to the TocList
 452         /// pit is the ParConstIterator of the paragraph containing the inset
 453         virtual void addToToc(DocIterator const &) {}
 454         /// Fill keys with BibTeX information
 455         virtual void fillWithBibKeys(BiblioInfo &, InsetIterator const &) const {}
 456         /// Update the counters of this inset and of its contents
 457         virtual void updateLabels(ParIterator const &) {}
 458
 459         /// Updates the inset's dialog
 460         virtual Buffer const * updateFrontend() const;
 461
 462 public:
 463         /// returns LyX code associated with the inset. Used for TOC, ...)
 464         virtual InsetCode lyxCode() const { return NO_CODE; }
 465
 466         /// -1: text mode, 1: math mode, 0 undecided
 467         enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
 468         /// return text or mathmode if that is possible to determine
 469         virtual mode_type currentMode() const { return UNDECIDED_MODE; }
 470         /// returns whether this inset is allowed in other insets of given mode
 471         virtual bool allowedIn(mode_type) const { return true; }
 472         /**
 473          * Is this inset allowed within a font change?
 474          *
 475          * FIXME: noFontChange means currently that the font change is closed
 476          * in LaTeX before the inset, and that the contents of the inset
 477          * will be in default font. This should be changed so that the inset
 478          * changes the font again.
 479          */
 480         virtual bool noFontChange() const { return false; }
 481
 482         /// set the change for the entire inset
 483         virtual void setChange(Change const &) {}
 484         /// accept the changes within the inset
 485         virtual void acceptChanges(BufferParams const &) {};
 486         /// reject the changes within the inset
 487         virtual void rejectChanges(BufferParams const &) {};
 488
 489         ///
 490         virtual Dimension const dimension(BufferView const &) const;
 491         ///
 492         int scroll() const { return 0; }
 493         ///
 494         virtual ColorCode backgroundColor() const;
 495         ///
 496         enum CollapseStatus {
 497                 Collapsed,
 498                 Open
 499         };
 500         ///
 501         virtual void setStatus(Cursor &, CollapseStatus) {}
 502         //
 503         enum { TEXT_TO_INSET_OFFSET = 4 };
 504
 505 protected:
 506         /// Constructors
 507         Inset() : buffer_(0) {}
 508         Inset(Inset const &) : buffer_(0) {}
 509
 510         /// replicate ourselves
 511         friend class InsetList;
 512         friend class MathAtom;
 513         virtual Inset * clone() const = 0;
 514
 515         /** The real dispatcher.
 516          *  Gets normally called from Cursor::dispatch(). Cursor::dispatch()
 517          *  assumes the common case of 'LFUN handled, need update'.
 518          *  This has to be overriden by calling Cursor::undispatched() or
 519          *  Cursor::noUpdate() if appropriate.
 520          *  If you need to call the dispatch method of some inset directly
 521          *  you may have to explicitly request an update at that place. Don't
 522          *  do it in doDispatch(), since that causes nested updates when
 523          *  called from Cursor::dispatch(), and these can lead to crashes.
 524          *  \sa getStatus
 525          */
 526         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 527
 528         Buffer * buffer_;
 529 };
 530
 531 } // namespace lyx
 532
 533 #endif