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                 ///
 100                 THEOREM_CODE,
 101                 ///
 102                 CAPTION_CODE,
 103                 ///
 104                 MATHMACRO_CODE, // 30
 105                 ///
 106                 ERROR_CODE,
 107                 ///
 108                 CITE_CODE,
 109                 ///
 110                 FLOAT_LIST_CODE,
 111                 ///
 112                 INDEX_PRINT_CODE
 113         };
 114
 115         ///
 116         enum {
 117                 ///
 118                 TEXT_TO_INSET_OFFSET = 2
 119         };
 120
 121         ///
 122         enum EDITABLE {
 123                 ///
 124                 NOT_EDITABLE = 0,
 125                 ///
 126                 IS_EDITABLE,
 127                 ///
 128                 HIGHLY_EDITABLE
 129         };
 130
 131         ///
 132         Inset() : top_x(0), top_baseline(0), scx(0), id_(inset_id++), owner_(0), background_color_(LColor::inherit) {}
 133         /// Virtual base destructor
 134         virtual ~Inset() {}
 135         ///
 136         virtual int ascent(BufferView *, LyXFont const &) const = 0;
 137         ///
 138         virtual int descent(BufferView *, LyXFont const &) const = 0;
 139         ///
 140         virtual int width(BufferView *, LyXFont const &) const = 0;
 141         ///
 142         virtual void draw(BufferView *, LyXFont const &,
 143                           int baseline, float & x, bool cleared) const = 0;
 144         /// update the inset representation
 145         virtual void update(BufferView *, LyXFont const &, bool = false)
 146                 {}
 147         ///
 148         virtual LyXFont const convertFont(LyXFont const & font) const;
 149         /// what appears in the minibuffer when opening
 150         virtual string const editMessage() const;
 151         ///
 152         virtual void edit(BufferView *, int x, int y, unsigned int button);
 153         ///
 154         virtual void edit(BufferView *, bool front = true);
 155         ///
 156         virtual EDITABLE editable() const;
 157         /// This is called when the user clicks inside an inset
 158         virtual void insetButtonPress(BufferView *, int, int, int) {}
 159         /// This is called when the user releases the button inside an inset
 160         virtual void insetButtonRelease(BufferView *, int, int, int) {}
 161         /// This is called when the user moves the mouse inside an inset
 162         virtual void insetMotionNotify(BufferView *, int , int , int) {}
 163         ///
 164         virtual bool isTextInset() const { return false; }
 165         ///
 166         virtual bool doClearArea() const { return true; }
 167         ///
 168         virtual bool autoDelete() const;
 169         /// returns true the inset can hold an inset of given type
 170         virtual bool insetAllowed(Inset::Code) const { return false; }
 171         /// wrapper around the above
 172         bool insetAllowed(Inset * in) const {
 173                 return insetAllowed(in->lyxCode());
 174         }
 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         /// return the cursor if we own one otherwise giv'em just the
 268         /// BufferView cursor to work with.
 269         virtual LyXCursor const & cursor(BufferView * bview) const;
 270         /// id functions
 271         int id() const;
 272         void id(int id_arg);
 273
 274         /// used to toggle insets
 275         // is the inset open?
 276         virtual bool isOpen() const { return false; }
 277         // open or close the inset, depending on the bool
 278         virtual void open(BufferView *, bool) {}
 279 protected:
 280         ///
 281         mutable int top_x;
 282         ///
 283         mutable int top_baseline;
 284         ///
 285         mutable int scx;
 286         ///
 287         unsigned int id_;
 288         ///
 289         static unsigned int inset_id;
 290
 291 private:
 292         ///
 293         Inset * owner_;
 294         ///
 295         string name;
 296         ///
 297         LColor::color background_color_;
 298 };
 299
 300
 301 //  Updatable Insets. These insets can be locked and receive
 302 //  directly user interaction. Currently used only for mathed.
 303 //  Note that all pure methods from Inset class are pure here too.
 304 //  [Alejandro 080596]
 305
 306 /** Extracted from Matthias notes:
 307  *
 308  * An inset can simple call LockInset in it's edit call and *ONLY*
 309  * in it's edit call.
 310  *
 311  * Unlocking is either done by LyX or the inset itself with a
 312  * UnlockInset-call
 313  *
 314  * During the lock, all button and keyboard events will be modified
 315  * and send to the inset through the following inset-features. Note that
 316  * Inset::insetUnlock will be called from inside UnlockInset. It is meant
 317  * to contain the code for restoring the menus and things like this.
 318  *
 319  * If a inset wishes any redraw and/or update it just has to call
 320  * UpdateInset(this).
 321  *
 322  * It's is completly irrelevant, where the inset is. UpdateInset will
 323  * find it in any paragraph in any buffer.
 324  * Of course the_locking_inset and the insets in the current paragraph/buffer
 325  *  are checked first, so no performance problem should occur.
 326  */
 327 class UpdatableInset : public Inset {
 328 public:
 329         /** Dispatch result codes
 330             Now that nested updatable insets are allowed, the local dispatch
 331             becomes a bit complex, just two possible results (boolean)
 332             are not enough.
 333
 334             DISPATCHED   = the inset catched the action
 335             DISPATCHED_NOUPDATE = the inset catched the action and no update
 336                                   is needed here to redraw the inset
 337             FINISHED     = the inset must be unlocked as a result
 338                            of the action
 339             UNDISPATCHED = the action was not catched, it should be
 340                            dispatched by lower level insets
 341         */
 342         enum RESULT {
 343                 UNDISPATCHED = 0,
 344                 DISPATCHED,
 345                 DISPATCHED_NOUPDATE,
 346                 FINISHED
 347         };
 348
 349         /// To convert old binary dispatch results
 350         RESULT DISPATCH_RESULT(bool b) {
 351                 return b ? DISPATCHED : FINISHED;
 352         }
 353
 354         ///
 355         UpdatableInset() : cursor_visible_(false), block_drawing_(false) {}
 356
 357         ///
 358         virtual EDITABLE editable() const;
 359
 360         /// may call ToggleLockedInsetCursor
 361         virtual void toggleInsetCursor(BufferView *);
 362         ///
 363         virtual void showInsetCursor(BufferView *, bool show = true);
 364         ///
 365         virtual void hideInsetCursor(BufferView *);
 366         ///
 367         virtual void fitInsetCursor(BufferView *) const;
 368         ///
 369         virtual void getCursorPos(BufferView *, int &, int &) const {}
 370         ///
 371         virtual void insetButtonPress(BufferView *, int x, int y, int button);
 372         ///
 373         virtual void insetButtonRelease(BufferView *,
 374                                         int x, int y, int button);
 375         ///
 376         virtual void insetKeyPress(XKeyEvent * ev);
 377         ///
 378         virtual void insetMotionNotify(BufferView *, int x, int y, int state);
 379         ///
 380         virtual void insetUnlock(BufferView *);
 381         ///
 382         virtual void edit(BufferView *, int x, int y, unsigned int button);
 383         ///
 384         virtual void edit(BufferView *, bool front = true);
 385         ///
 386         virtual void draw(BufferView *, LyXFont const &,
 387                           int baseline, float & x, bool cleared) const;
 388         ///
 389         virtual void setFont(BufferView *, LyXFont const &,
 390                          bool toggleall = false, bool selectall = false);
 391         ///
 392         virtual bool insertInset(BufferView *, Inset *) { return false; }
 393         ///
 394         virtual UpdatableInset * getLockingInset() const {
 395                 return const_cast<UpdatableInset *>(this);
 396         }
 397         ///
 398         virtual UpdatableInset * getFirstLockingInsetOfType(Inset::Code c)
 399                 { return (c == lyxCode()) ? this : 0; }
 400         ///
 401         virtual unsigned int insetInInsetY() { return 0; }
 402         ///
 403         virtual bool updateInsetInInset(BufferView *, Inset *)
 404                 { return false; }
 405         ///
 406         virtual bool lockInsetInInset(BufferView *, UpdatableInset *)
 407                 { return false; }
 408         ///
 409         virtual bool unlockInsetInInset(BufferView *, UpdatableInset *,
 410                                         bool /*lr*/ = false)
 411                 { return false; }
 412         ///  An updatable inset could handle lyx editing commands
 413         virtual RESULT localDispatch(BufferView *, kb_action, string const &);
 414         ///
 415         bool isCursorVisible() const { return cursor_visible_; }
 416         ///
 417         virtual int getMaxWidth(BufferView * bv, UpdatableInset const *) const;
 418         ///
 419         int scroll(bool recursive = true) const {
 420                 // We need this method to not clobber the real method in Inset
 421                 return Inset::scroll(recursive);
 422         }
 423         ///
 424         virtual bool showInsetDialog(BufferView *) const { return false; }
 425         ///
 426         virtual void nodraw(bool b) {
 427                 block_drawing_ = b;
 428         }
 429         ///
 430         virtual bool nodraw() const {
 431                 return block_drawing_;
 432         }
 433         ///
 434         // needed for spellchecking text
 435         ///
 436         virtual string selectNextWord(BufferView *, float & value) const;
 437         virtual void selectSelectedWord(BufferView *) { return; }
 438         virtual void toggleSelection(BufferView *, bool /*kill_selection*/) {
 439                 return;
 440         }
 441         ///
 442         // needed for search/replace functionality
 443         ///
 444         virtual bool searchForward(BufferView *, string const &,
 445                                    bool const & = true, bool const & = false);
 446         virtual bool searchBackward(BufferView *, string const &,
 447                                     bool const & = true, bool const & = false);
 448
 449 protected:
 450         ///
 451         void toggleCursorVisible() const {
 452                 cursor_visible_ = !cursor_visible_;
 453         }
 454         ///
 455         void setCursorVisible(bool b) const {
 456                 cursor_visible_ = b;
 457         }
 458         /// scrolls to absolute position in bufferview-workwidth * sx units
 459         void scroll(BufferView *, float sx) const;
 460         /// scrolls offset pixels
 461         void scroll(BufferView *, int offset) const;
 462
 463 private:
 464         ///
 465         mutable bool cursor_visible_;
 466         ///
 467         bool block_drawing_;
 468 };
 469 #endif