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