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