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