src/insets/inset.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995-2001 the LyX Team.
   8  *
   9  * ====================================================== */
  10
  11 #ifndef INSET_H
  12 #define INSET_H
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #include <vector>
  19 #include "LString.h"
  20 #include <X11/Xlib.h>
  21 #include "commandtags.h"
  22 #include "LColor.h"
  23
  24 class LyXFont;
  25 class BufferView;
  26 class Buffer;
  27 class Painter;
  28 class LyXText;
  29 class LyXLex;
  30 class Paragraph;
  31 class LyXCursor;
  32
  33 struct LaTeXFeatures;
  34
  35
  36 /// Insets
  37 class Inset {
  38 public:
  39         /** This is not quite the correct place for this enum. I think
  40             the correct would be to let each subclass of Inset declare
  41             its own enum code. Actually the notion of an Inset::Code
  42             should be avoided, but I am not sure how this could be done
  43             in a cleaner way. */
  44         enum Code {
  45                 ///
  46                 NO_CODE,
  47                 ///
  48                 TOC_CODE,  // do these insets really need a code? (ale)
  49                 ///
  50                 QUOTE_CODE,
  51                 ///
  52                 MARK_CODE,
  53                 ///
  54                 REF_CODE, // 5
  55                 ///
  56                 URL_CODE,
  57                 ///
  58                 HTMLURL_CODE,
  59                 ///
  60                 SEPARATOR_CODE,
  61                 ///
  62                 ENDING_CODE,
  63                 ///
  64                 LABEL_CODE, // 10
  65                 ///
  66                 IGNORE_CODE,
  67                 ///
  68                 ACCENT_CODE,
  69                 ///
  70                 MATH_CODE,
  71                 ///
  72                 INDEX_CODE,
  73                 ///
  74                 INCLUDE_CODE, // 15
  75                 ///
  76                 GRAPHICS_CODE,
  77                 ///
  78                 PARENT_CODE,
  79                 ///
  80                 BIBTEX_CODE,
  81                 ///
  82                 TEXT_CODE,
  83                 ///
  84                 ERT_CODE, // 20
  85                 ///
  86                 FOOT_CODE,
  87                 ///
  88                 MARGIN_CODE,
  89                 ///
  90                 FLOAT_CODE,
  91                 ///
  92                 MINIPAGE_CODE,
  93                 ///
  94                 SPECIALCHAR_CODE, // 25
  95                 ///
  96                 TABULAR_CODE,
  97                 ///
  98                 EXTERNAL_CODE,
  99 #if 0
 100                 ///
 101                 THEOREM_CODE,
 102 #endif
 103                 ///
 104                 CAPTION_CODE,
 105                 ///
 106                 MATHMACRO_CODE, // 30
 107                 ///
 108                 ERROR_CODE,
 109                 ///
 110                 CITE_CODE,
 111                 ///
 112                 FLOAT_LIST_CODE,
 113                 ///
 114                 INDEX_PRINT_CODE
 115         };
 116
 117         ///
 118         enum {
 119                 ///
 120                 TEXT_TO_INSET_OFFSET = 2
 121         };
 122
 123         ///
 124         enum EDITABLE {
 125                 ///
 126                 NOT_EDITABLE = 0,
 127                 ///
 128                 IS_EDITABLE,
 129                 ///
 130                 HIGHLY_EDITABLE
 131         };
 132
 133         ///
 134         Inset();
 135         ///
 136         Inset(Inset const & in, bool same_id = false);
 137         ///
 138         virtual ~Inset() {}
 139         ///
 140         virtual int ascent(BufferView *, LyXFont const &) const = 0;
 141         ///
 142         virtual int descent(BufferView *, LyXFont const &) const = 0;
 143         ///
 144         virtual int width(BufferView *, LyXFont const &) const = 0;
 145         ///
 146         virtual void draw(BufferView *, LyXFont const &,
 147                           int baseline, float & x, bool cleared) const = 0;
 148         /// update the inset representation
 149         virtual void update(BufferView *, LyXFont const &, bool = false)
 150                 {}
 151         /// what appears in the minibuffer when opening
 152         virtual string const editMessage() const;
 153         ///
 154         virtual void edit(BufferView *, int x, int y, unsigned int button);
 155         ///
 156         virtual void edit(BufferView *, bool front = true);
 157         ///
 158         virtual EDITABLE editable() const;
 159         /// This is called when the user clicks inside an inset
 160         virtual void insetButtonPress(BufferView *, int, int, int) {}
 161         /// This is called when the user releases the button inside an inset
 162         virtual void insetButtonRelease(BufferView *, int, int, int) {}
 163         /// This is called when the user moves the mouse inside an inset
 164         virtual void insetMotionNotify(BufferView *, int , int , int) {}
 165         ///
 166         virtual bool isTextInset() const { return false; }
 167         ///
 168         virtual bool doClearArea() const { return true; }
 169         ///
 170         virtual bool autoDelete() const;
 171         /// returns true the inset can hold an inset of given type
 172         virtual bool insetAllowed(Inset::Code) const { return false; }
 173         /// wrapper around the above
 174         bool insetAllowed(Inset * in) const;
 175         ///
 176         virtual void write(Buffer const *, std::ostream &) const = 0;
 177         ///
 178         virtual void read(Buffer const *, LyXLex & lex) = 0;
 179         /** returns the number of rows (\n's) of generated tex code.
 180             fragile == true means, that the inset should take care about
 181             fragile commands by adding a \protect before.
 182             If the free_spc (freespacing) variable is set, then this inset
 183             is in a free-spacing paragraph.
 184         */
 185         virtual int latex(Buffer const *, std::ostream &, bool fragile,
 186                           bool free_spc) const = 0;
 187         ///
 188         virtual int ascii(Buffer const *,
 189                           std::ostream &, int linelen = 0) const = 0;
 190         ///
 191         virtual int linuxdoc(Buffer const *, std::ostream &) const = 0;
 192         ///
 193         virtual int docbook(Buffer const *, std::ostream &) const = 0;
 194         /// Updates needed features for this inset.
 195         virtual void validate(LaTeXFeatures & features) const;
 196         ///
 197         virtual bool deletable() const;
 198
 199         /// returns LyX code associated with the inset. Used for TOC, ...)
 200         virtual Inset::Code lyxCode() const { return NO_CODE; }
 201
 202         virtual std::vector<string> const getLabelList() const {
 203                 return std::vector<string>();
 204         }
 205
 206         ///
 207         virtual Inset * clone(Buffer const &, bool same_ids = false) const = 0;
 208
 209         /// returns true to override begin and end inset in file
 210         virtual bool directWrite() const;
 211
 212         /// Returns true if the inset should be centered alone
 213         virtual bool display() const { return false; }
 214         /// Changes the display state of the inset
 215         virtual void display(bool) {}
 216         ///
 217         /// returns true if this inset needs a row on it's own
 218         ///
 219         virtual bool needFullRow() const { return false; }
 220         ///
 221         void setInsetName(string const & s) { name_ = s; }
 222         ///
 223         string const & getInsetName() const { return name_; }
 224         ///
 225         void setOwner(Inset * inset) { owner_ = inset; }
 226         ///
 227         Inset * owner() const { return owner_; }
 228         ///
 229         void setBackgroundColor(LColor::color);
 230         ///
 231         LColor::color backgroundColor() const;
 232         ///
 233         int x() const { return top_x; }
 234         ///
 235         int y() const { return top_baseline; }
 236         //
 237         // because we could have fake text insets and have to call this
 238         // inside them without cast!!!
 239         ///
 240         virtual LyXText * getLyXText(BufferView const *,
 241                                      bool const recursive = false) const;
 242         ///
 243         virtual void deleteLyXText(BufferView *, bool = true) const {}
 244         ///
 245         virtual void resizeLyXText(BufferView *, bool /*force*/= false) const {}
 246         /// returns the actuall scroll-value
 247         virtual int scroll(bool recursive=true) const {
 248                 if (!recursive || !owner_)
 249                         return scx;
 250                 return 0;
 251         }
 252         /// try to get a paragraph pointer from it's id if we have a
 253         /// paragraph to give back!
 254         virtual Paragraph * getParFromID(int /* id */) const {
 255                 return 0;
 256         }
 257         /// try to get a inset pointer from it's id if we have
 258         /// an inset to give back!
 259         virtual Inset * getInsetFromID(int /* id */) const {
 260                 return 0;
 261         }
 262         /// if this insets owns paragraphs (f.ex. InsetText) then it
 263         /// should return it's very first one!
 264         virtual Paragraph * firstParagraph() const {
 265                 return 0;
 266         }
 267
 268         ///
 269         virtual Paragraph * getFirstParagraph(int /*num*/) const {
 270                 return 0;
 271         }
 272
 273         /// return the cursor if we own one otherwise giv'em just the
 274         /// BufferView cursor to work with.
 275         virtual LyXCursor const & cursor(BufferView * bview) const;
 276         /// id functions
 277         int id() const;
 278         ///
 279         void id(int id_arg);
 280
 281         /// used to toggle insets
 282         // is the inset open?
 283         virtual bool isOpen() const { return false; }
 284         /// open the inset
 285         virtual void open(BufferView *) {}
 286         /// close the inset
 287         virtual void close(BufferView *) const {}
 288         /// check if the font of the char we want inserting is correct
 289         /// and modify it if it is not.
 290         virtual bool checkInsertChar(LyXFont &);
 291         /// we need this here because collapsed insets are only EDITABLE
 292         virtual void setFont(BufferView *, LyXFont const &,
 293                          bool toggleall = false, bool selectall = false);
 294         ///
 295         // needed for spellchecking text
 296         ///
 297         virtual bool allowSpellcheck() { return false; }
 298 protected:
 299         ///
 300         mutable int top_x;
 301         ///
 302         mutable bool topx_set; /* have we already drawn ourself! */
 303         ///
 304         mutable int top_baseline;
 305         ///
 306         mutable int scx;
 307         ///
 308         unsigned int id_;
 309         ///
 310         static unsigned int inset_id;
 311
 312 private:
 313         ///
 314         Inset * owner_;
 315         ///
 316         string name_;
 317         ///
 318         LColor::color background_color_;
 319 };
 320
 321
 322 inline
 323 bool Inset::insetAllowed(Inset * in) const
 324 {
 325         return insetAllowed(in->lyxCode());
 326 }
 327
 328
 329 inline
 330 bool Inset::checkInsertChar(LyXFont &)
 331 {
 332         return true;
 333 }
 334
 335 //  Updatable Insets. These insets can be locked and receive
 336 //  directly user interaction. Currently used only for mathed.
 337 //  Note that all pure methods from Inset class are pure here too.
 338 //  [Alejandro 080596]
 339
 340 /** Extracted from Matthias notes:
 341  *
 342  * An inset can simple call LockInset in it's edit call and *ONLY*
 343  * in it's edit call.
 344  *
 345  * Unlocking is either done by LyX or the inset itself with a
 346  * UnlockInset-call
 347  *
 348  * During the lock, all button and keyboard events will be modified
 349  * and send to the inset through the following inset-features. Note that
 350  * Inset::insetUnlock will be called from inside UnlockInset. It is meant
 351  * to contain the code for restoring the menus and things like this.
 352  *
 353  * If a inset wishes any redraw and/or update it just has to call
 354  * UpdateInset(this).
 355  *
 356  * It's is completly irrelevant, where the inset is. UpdateInset will
 357  * find it in any paragraph in any buffer.
 358  * Of course the_locking_inset and the insets in the current paragraph/buffer
 359  *  are checked first, so no performance problem should occur.
 360  */
 361 class UpdatableInset : public Inset {
 362 public:
 363         /** Dispatch result codes
 364             Now that nested updatable insets are allowed, the local dispatch
 365             becomes a bit complex, just two possible results (boolean)
 366             are not enough.
 367
 368             DISPATCHED          = the inset catched the action
 369             DISPATCHED_NOUPDATE = the inset catched the action and no update
 370                                   is needed here to redraw the inset
 371             FINISHED            = the inset must be unlocked as a result
 372                                   of the action
 373             FINISHED_RIGHT      = FINISHED, but put the cursor to the RIGHT of
 374                                   the inset.
 375             FINISHED_UP         = FINISHED, but put the cursor UP of
 376                                   the inset.
 377             FINISHED_DOWN       = FINISHED, but put the cursor DOWN of
 378                                   the inset.
 379             UNDISPATCHED        = the action was not catched, it should be
 380                                   dispatched by lower level insets
 381         */
 382         enum RESULT {
 383                 UNDISPATCHED = 0,
 384                 DISPATCHED,
 385                 DISPATCHED_NOUPDATE,
 386                 FINISHED,
 387                 FINISHED_RIGHT,
 388                 FINISHED_UP,
 389                 FINISHED_DOWN
 390         };
 391
 392         /// To convert old binary dispatch results
 393         RESULT DISPATCH_RESULT(bool b) {
 394                 return b ? DISPATCHED : FINISHED;
 395         }
 396
 397         ///
 398         UpdatableInset();
 399         ///
 400         UpdatableInset(UpdatableInset const & in, bool same_id = false);
 401
 402         ///
 403         virtual EDITABLE editable() const;
 404
 405         /// may call ToggleLockedInsetCursor
 406         virtual void toggleInsetCursor(BufferView *);
 407         ///
 408         virtual void showInsetCursor(BufferView *, bool show = true);
 409         ///
 410         virtual void hideInsetCursor(BufferView *);
 411         ///
 412         virtual void fitInsetCursor(BufferView *) const;
 413         ///
 414         virtual void getCursorPos(BufferView *, int &, int &) const {}
 415         ///
 416         virtual void insetButtonPress(BufferView *, int x, int y, int button);
 417         ///
 418         virtual void insetButtonRelease(BufferView *,
 419                                         int x, int y, int button);
 420         ///
 421         virtual void insetKeyPress(XKeyEvent * ev);
 422         ///
 423         virtual void insetMotionNotify(BufferView *, int x, int y, int state);
 424         ///
 425         virtual void insetUnlock(BufferView *);
 426         ///
 427         virtual void edit(BufferView *, int x, int y, unsigned int button);
 428         ///
 429         virtual void edit(BufferView *, bool front = true);
 430         ///
 431         virtual void draw(BufferView *, LyXFont const &,
 432                           int baseline, float & x, bool cleared) const;
 433         ///
 434         virtual bool insertInset(BufferView *, Inset *) { return false; }
 435         ///
 436         virtual UpdatableInset * getLockingInset() const {
 437                 return const_cast<UpdatableInset *>(this);
 438         }
 439         ///
 440         virtual UpdatableInset * getFirstLockingInsetOfType(Inset::Code c)
 441                 { return (c == lyxCode()) ? this : 0; }
 442         ///
 443         virtual unsigned int insetInInsetY() { return 0; }
 444         ///
 445         virtual bool updateInsetInInset(BufferView *, Inset *)
 446                 { return false; }
 447         ///
 448         virtual bool lockInsetInInset(BufferView *, UpdatableInset *)
 449                 { return false; }
 450         ///
 451         virtual bool unlockInsetInInset(BufferView *, UpdatableInset *,
 452                                         bool /*lr*/ = false)
 453                 { return false; }
 454         ///  An updatable inset could handle lyx editing commands
 455         virtual RESULT localDispatch(BufferView *, kb_action, string const &);
 456         ///
 457         bool isCursorVisible() const { return cursor_visible_; }
 458         ///
 459         virtual int getMaxWidth(BufferView * bv, UpdatableInset const *) const;
 460         ///
 461         int scroll(bool recursive = true) const {
 462                 // We need this method to not clobber the real method in Inset
 463                 return Inset::scroll(recursive);
 464         }
 465         ///
 466         virtual bool showInsetDialog(BufferView *) const { return false; }
 467         ///
 468         virtual void nodraw(bool b) const {
 469                 block_drawing_ = b;
 470         }
 471         ///
 472         virtual bool nodraw() const {
 473                 return block_drawing_;
 474         }
 475         ///
 476         // needed for spellchecking text
 477         ///
 478         virtual bool allowSpellcheck() { return false; }
 479         ///
 480         virtual string const selectNextWordToSpellcheck(BufferView *, float & value) const;
 481         ///
 482         virtual void selectSelectedWord(BufferView *) { return; }
 483         ///
 484         virtual void toggleSelection(BufferView *, bool /*kill_selection*/) {
 485                 return;
 486         }
 487         ///
 488         // needed for search/replace functionality
 489         ///
 490         virtual bool searchForward(BufferView *, string const &,
 491                                    bool const & = true, bool const & = false);
 492         ///
 493         virtual bool searchBackward(BufferView *, string const &,
 494                                     bool const & = true, bool const & = false);
 495
 496 protected:
 497         ///
 498         void toggleCursorVisible() const {
 499                 cursor_visible_ = !cursor_visible_;
 500         }
 501         ///
 502         void setCursorVisible(bool b) const {
 503                 cursor_visible_ = b;
 504         }
 505         /// scrolls to absolute position in bufferview-workwidth * sx units
 506         void scroll(BufferView *, float sx) const;
 507         /// scrolls offset pixels
 508         void scroll(BufferView *, int offset) const;
 509
 510 private:
 511         ///
 512         mutable bool cursor_visible_;
 513         ///
 514         mutable bool block_drawing_;
 515 };
 516 #endif