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