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