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         ///
 152         virtual LyXFont const convertFont(LyXFont const & font) const;
 153         /// what appears in the minibuffer when opening
 154         virtual string const editMessage() const;
 155         ///
 156         virtual void edit(BufferView *, int x, int y, unsigned int button);
 157         ///
 158         virtual void edit(BufferView *, bool front = true);
 159         ///
 160         virtual EDITABLE editable() const;
 161         /// This is called when the user clicks inside an inset
 162         virtual void insetButtonPress(BufferView *, int, int, int) {}
 163         /// This is called when the user releases the button inside an inset
 164         virtual void insetButtonRelease(BufferView *, int, int, int) {}
 165         /// This is called when the user moves the mouse inside an inset
 166         virtual void insetMotionNotify(BufferView *, int , int , int) {}
 167         ///
 168         virtual bool isTextInset() const { return false; }
 169         ///
 170         virtual bool doClearArea() const { return true; }
 171         ///
 172         virtual bool autoDelete() const;
 173         /// returns true the inset can hold an inset of given type
 174         virtual bool insetAllowed(Inset::Code) const { return false; }
 175         /// wrapper around the above
 176         bool insetAllowed(Inset * in) const;
 177         ///
 178         virtual void write(Buffer const *, std::ostream &) const = 0;
 179         ///
 180         virtual void read(Buffer const *, LyXLex & lex) = 0;
 181         /** returns the number of rows (\n's) of generated tex code.
 182             fragile == true means, that the inset should take care about
 183             fragile commands by adding a \protect before.
 184             If the free_spc (freespacing) variable is set, then this inset
 185             is in a free-spacing paragraph.
 186         */
 187         virtual int latex(Buffer const *, std::ostream &, bool fragile,
 188                           bool free_spc) const = 0;
 189         ///
 190         virtual int ascii(Buffer const *,
 191                           std::ostream &, int linelen = 0) const = 0;
 192         ///
 193         virtual int linuxdoc(Buffer const *, std::ostream &) const = 0;
 194         ///
 195         virtual int docBook(Buffer const *, std::ostream &) const = 0;
 196         /// Updates needed features for this inset.
 197         virtual void validate(LaTeXFeatures & features) const;
 198         ///
 199         virtual bool deletable() const;
 200
 201         /// returns LyX code associated with the inset. Used for TOC, ...)
 202         virtual Inset::Code lyxCode() const { return NO_CODE; }
 203
 204         virtual std::vector<string> const getLabelList() const {
 205                 return std::vector<string>();
 206         }
 207
 208         ///
 209         virtual Inset * clone(Buffer const &, bool same_ids = false) const = 0;
 210
 211         /// returns true to override begin and end inset in file
 212         virtual bool directWrite() const;
 213
 214         /// Returns true if the inset should be centered alone
 215         virtual bool display() const { return false; }
 216         /// Changes the display state of the inset
 217         virtual void display(bool) {}
 218         ///
 219         /// returns true if this inset needs a row on it's own
 220         ///
 221         virtual bool needFullRow() const { return false; }
 222         ///
 223         void setInsetName(string const & s) { name_ = s; }
 224         ///
 225         string const & getInsetName() const { return name_; }
 226         ///
 227         void setOwner(Inset * inset) { owner_ = inset; }
 228         ///
 229         Inset * owner() const { return owner_; }
 230         ///
 231         void setBackgroundColor(LColor::color);
 232         ///
 233         LColor::color backgroundColor() const;
 234         ///
 235         int x() const { return top_x; }
 236         ///
 237         int y() const { return top_baseline; }
 238         //
 239         // because we could have fake text insets and have to call this
 240         // inside them without cast!!!
 241         ///
 242         virtual LyXText * getLyXText(BufferView const *,
 243                                      bool const recursive = false) const;
 244         ///
 245         virtual void deleteLyXText(BufferView *, bool = true) const {}
 246         ///
 247         virtual void resizeLyXText(BufferView *, bool /*force*/= false) const {}
 248         /// returns the actuall scroll-value
 249         virtual int scroll(bool recursive=true) const {
 250                 if (!recursive || !owner_)
 251                         return scx;
 252                 return 0;
 253         }
 254         /// try to get a paragraph pointer from it's id if we have a
 255         /// paragraph to give back!
 256         virtual Paragraph * getParFromID(int /* id */) const {
 257                 return 0;
 258         }
 259         /// try to get a inset pointer from it's id if we have
 260         /// an inset to give back!
 261         virtual Inset * getInsetFromID(int /* id */) const {
 262                 return 0;
 263         }
 264         /// if this insets owns paragraphs (f.ex. InsetText) then it
 265         /// should return it's very first one!
 266         virtual Paragraph * firstParagraph() const {
 267                 return 0;
 268         }
 269         /// return the cursor if we own one otherwise giv'em just the
 270         /// BufferView cursor to work with.
 271         virtual LyXCursor const & cursor(BufferView * bview) const;
 272         /// id functions
 273         int id() const;
 274         ///
 275         void id(int id_arg);
 276
 277         /// used to toggle insets
 278         // is the inset open?
 279         virtual bool isOpen() const { return false; }
 280         /// open the inset
 281         virtual void open(BufferView *) {}
 282         /// close the inset
 283         virtual void close(BufferView *) {}
 284         /// check if the font of the char we want inserting is correct
 285         /// and modify it if it is not.
 286         virtual bool checkInsertChar(LyXFont &);
 287         /// we need this here because collapsed insets are only EDITABLE
 288         virtual void setFont(BufferView *, LyXFont const &,
 289                          bool toggleall = false, bool selectall = false);
 290 protected:
 291         ///
 292         mutable int top_x;
 293         ///
 294         mutable int top_baseline;
 295         ///
 296         mutable int scx;
 297         ///
 298         unsigned int id_;
 299         ///
 300         static unsigned int inset_id;
 301
 302 private:
 303         ///
 304         Inset * owner_;
 305         ///
 306         string name_;
 307         ///
 308         LColor::color background_color_;
 309 };
 310
 311
 312 inline
 313 bool Inset::insetAllowed(Inset * in) const
 314 {
 315         return insetAllowed(in->lyxCode());
 316 }
 317
 318
 319 inline
 320 bool Inset::checkInsertChar(LyXFont &)
 321 {
 322         return true;
 323 }
 324
 325 //  Updatable Insets. These insets can be locked and receive
 326 //  directly user interaction. Currently used only for mathed.
 327 //  Note that all pure methods from Inset class are pure here too.
 328 //  [Alejandro 080596]
 329
 330 /** Extracted from Matthias notes:
 331  *
 332  * An inset can simple call LockInset in it's edit call and *ONLY*
 333  * in it's edit call.
 334  *
 335  * Unlocking is either done by LyX or the inset itself with a
 336  * UnlockInset-call
 337  *
 338  * During the lock, all button and keyboard events will be modified
 339  * and send to the inset through the following inset-features. Note that
 340  * Inset::insetUnlock will be called from inside UnlockInset. It is meant
 341  * to contain the code for restoring the menus and things like this.
 342  *
 343  * If a inset wishes any redraw and/or update it just has to call
 344  * UpdateInset(this).
 345  *
 346  * It's is completly irrelevant, where the inset is. UpdateInset will
 347  * find it in any paragraph in any buffer.
 348  * Of course the_locking_inset and the insets in the current paragraph/buffer
 349  *  are checked first, so no performance problem should occur.
 350  */
 351 class UpdatableInset : public Inset {
 352 public:
 353         /** Dispatch result codes
 354             Now that nested updatable insets are allowed, the local dispatch
 355             becomes a bit complex, just two possible results (boolean)
 356             are not enough.
 357
 358             DISPATCHED   = the inset catched the action
 359             DISPATCHED_NOUPDATE = the inset catched the action and no update
 360                                   is needed here to redraw the inset
 361             FINISHED     = the inset must be unlocked as a result
 362                            of the action
 363             UNDISPATCHED = the action was not catched, it should be
 364                            dispatched by lower level insets
 365         */
 366         enum RESULT {
 367                 UNDISPATCHED = 0,
 368                 DISPATCHED,
 369                 DISPATCHED_NOUPDATE,
 370                 FINISHED
 371         };
 372
 373         /// To convert old binary dispatch results
 374         RESULT DISPATCH_RESULT(bool b) {
 375                 return b ? DISPATCHED : FINISHED;
 376         }
 377
 378         ///
 379         UpdatableInset();
 380         ///
 381         UpdatableInset(UpdatableInset const & in, bool same_id = false);
 382
 383         ///
 384         virtual EDITABLE editable() const;
 385
 386         /// may call ToggleLockedInsetCursor
 387         virtual void toggleInsetCursor(BufferView *);
 388         ///
 389         virtual void showInsetCursor(BufferView *, bool show = true);
 390         ///
 391         virtual void hideInsetCursor(BufferView *);
 392         ///
 393         virtual void fitInsetCursor(BufferView *) const;
 394         ///
 395         virtual void getCursorPos(BufferView *, int &, int &) const {}
 396         ///
 397         virtual void insetButtonPress(BufferView *, int x, int y, int button);
 398         ///
 399         virtual void insetButtonRelease(BufferView *,
 400                                         int x, int y, int button);
 401         ///
 402         virtual void insetKeyPress(XKeyEvent * ev);
 403         ///
 404         virtual void insetMotionNotify(BufferView *, int x, int y, int state);
 405         ///
 406         virtual void insetUnlock(BufferView *);
 407         ///
 408         virtual void edit(BufferView *, int x, int y, unsigned int button);
 409         ///
 410         virtual void edit(BufferView *, bool front = true);
 411         ///
 412         virtual void draw(BufferView *, LyXFont const &,
 413                           int baseline, float & x, bool cleared) const;
 414         ///
 415         virtual bool insertInset(BufferView *, Inset *) { return false; }
 416         ///
 417         virtual UpdatableInset * getLockingInset() const {
 418                 return const_cast<UpdatableInset *>(this);
 419         }
 420         ///
 421         virtual UpdatableInset * getFirstLockingInsetOfType(Inset::Code c)
 422                 { return (c == lyxCode()) ? this : 0; }
 423         ///
 424         virtual unsigned int insetInInsetY() { return 0; }
 425         ///
 426         virtual bool updateInsetInInset(BufferView *, Inset *)
 427                 { return false; }
 428         ///
 429         virtual bool lockInsetInInset(BufferView *, UpdatableInset *)
 430                 { return false; }
 431         ///
 432         virtual bool unlockInsetInInset(BufferView *, UpdatableInset *,
 433                                         bool /*lr*/ = false)
 434                 { return false; }
 435         ///  An updatable inset could handle lyx editing commands
 436         virtual RESULT localDispatch(BufferView *, kb_action, string const &);
 437         ///
 438         bool isCursorVisible() const { return cursor_visible_; }
 439         ///
 440         virtual int getMaxWidth(BufferView * bv, UpdatableInset const *) const;
 441         ///
 442         int scroll(bool recursive = true) const {
 443                 // We need this method to not clobber the real method in Inset
 444                 return Inset::scroll(recursive);
 445         }
 446         ///
 447         virtual bool showInsetDialog(BufferView *) const { return false; }
 448         ///
 449         virtual void nodraw(bool b) const {
 450                 block_drawing_ = b;
 451         }
 452         ///
 453         virtual bool nodraw() const {
 454                 return block_drawing_;
 455         }
 456         ///
 457         // needed for spellchecking text
 458         ///
 459         virtual string const selectNextWord(BufferView *, float & value) const;
 460         ///
 461         virtual void selectSelectedWord(BufferView *) { return; }
 462         ///
 463         virtual void toggleSelection(BufferView *, bool /*kill_selection*/) {
 464                 return;
 465         }
 466         ///
 467         // needed for search/replace functionality
 468         ///
 469         virtual bool searchForward(BufferView *, string const &,
 470                                    bool const & = true, bool const & = false);
 471         ///
 472         virtual bool searchBackward(BufferView *, string const &,
 473                                     bool const & = true, bool const & = false);
 474
 475 protected:
 476         ///
 477         void toggleCursorVisible() const {
 478                 cursor_visible_ = !cursor_visible_;
 479         }
 480         ///
 481         void setCursorVisible(bool b) const {
 482                 cursor_visible_ = b;
 483         }
 484         /// scrolls to absolute position in bufferview-workwidth * sx units
 485         void scroll(BufferView *, float sx) const;
 486         /// scrolls offset pixels
 487         void scroll(BufferView *, int offset) const;
 488
 489 private:
 490         ///
 491         mutable bool cursor_visible_;
 492         ///
 493         mutable bool block_drawing_;
 494 };
 495 #endif