src/lyxtext.h

   1 // -*- C++ -*-
   2 /**
   3  * \file lyxtext.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author unknown
   8  * \author Lars Gullik Bjønnes
   9  * \author John Levon
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef LYXTEXT_H
  15 #define LYXTEXT_H
  16
  17 #include "bufferview_funcs.h"
  18 #include "Bidi.h"
  19 #include "layout.h"
  20 #include "lyxfont.h"
  21 #include "lyxtextclass.h"
  22 #include "ParagraphList_fwd.h"
  23 #include "RowList_fwd.h"
  24 #include "textcursor.h"
  25
  26 #include "insets/inset.h"
  27
  28 #include <iosfwd>
  29
  30 class Buffer;
  31 class BufferParams;
  32 class BufferView;
  33 class Dimension;
  34 class LColor_color;
  35 class LyXCursor;
  36 class MetricsInfo;
  37 class Paragraph;
  38 class Row;
  39 class Spacing;
  40 class UpdatableInset;
  41 class VSpace;
  42
  43
  44 /**
  45   This class used to hold the mapping between buffer paragraphs and
  46         screen rows. Nowadays, the Paragraphs take care of their rows
  47   themselves and this contains just most of the code for manipulating
  48   them and interaction with the Cursor.
  49   */
  50
  51 // The inheritance from TextCursor should go. It's just there to ease
  52 // transition...
  53 class LyXText : public TextCursor {
  54         // Public Functions
  55 public:
  56         /// Constructor
  57         LyXText(BufferView *, bool ininset);
  58         ///
  59         void init(BufferView *);
  60
  61
  62         /// update y coordinate cache of all paragraphs
  63         void updateParPositions();
  64         ///
  65         LyXFont getFont(ParagraphList::iterator pit, lyx::pos_type pos) const;
  66         ///
  67         LyXFont getLayoutFont(ParagraphList::iterator pit) const;
  68         ///
  69         LyXFont getLabelFont(ParagraphList::iterator pit) const;
  70         ///
  71         void setCharFont(ParagraphList::iterator pit,
  72                          lyx::pos_type pos, LyXFont const & font);
  73         void setCharFont(ParagraphList::iterator pit,
  74                          lyx::pos_type pos,
  75                          LyXFont const & font, bool toggleall);
  76
  77         /// what you expect when pressing <enter> at cursor position
  78         void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0);
  79
  80         /** set layout over selection and make a total rebreak of
  81           those paragraphs
  82           */
  83         ParagraphList::iterator
  84         setLayout(ParagraphList::iterator start,
  85                   ParagraphList::iterator end,
  86                   std::string const & layout);
  87         ///
  88         void setLayout(std::string const & layout);
  89
  90         /// Increase or decrease the nesting depth of the selected paragraph(s)
  91         void changeDepth(bv_funcs::DEPTH_CHANGE type);
  92
  93         /// Returns whether something would be changed by changeDepth
  94         bool changeDepthAllowed(bv_funcs::DEPTH_CHANGE type);
  95
  96         /// get the depth at current cursor position
  97         int getDepth() const;
  98
  99         /** set font over selection and make a total rebreak of those
 100           paragraphs.
 101           toggleall defaults to false.
 102           */
 103         void setFont(LyXFont const &, bool toggleall = false);
 104
 105         /// rebreaks all paragaphs between the given pars.
 106         void redoParagraphs(ParagraphList::iterator begin,
 107                             ParagraphList::iterator end);
 108         /// rebreaks the given par
 109         void redoParagraph(ParagraphList::iterator pit);
 110
 111         /// rebreaks the cursor par
 112         void redoParagraph();
 113
 114         ///
 115         void toggleFree(LyXFont const &, bool toggleall = false);
 116
 117         ///
 118         std::string getStringToIndex();
 119
 120         /** insert a character, moves all the following breaks in the
 121           same Paragraph one to the right and make a little rebreak
 122           */
 123         void insertChar(char c);
 124         ///
 125         void insertInset(InsetOld * inset);
 126
 127         /// a full rebreak of the whole text
 128         void fullRebreak();
 129         /// compute text metrics
 130         void metrics(MetricsInfo & mi, Dimension & dim);
 131         /// draw text (only used for insets)
 132         void draw(PainterInfo & pi, int x, int y) const;
 133
 134         /// try to handle that request
 135         DispatchResult dispatch(FuncRequest const & cmd);
 136
 137         BufferView * bv();
 138
 139         BufferView * bv() const;
 140
 141         friend class LyXScreen;
 142
 143         /// returns an iterator pointing to a cursor paragraph
 144         ParagraphList::iterator getPar(LyXCursor const & cursor) const;
 145         ///
 146         ParagraphList::iterator getPar(lyx::paroffset_type par) const;
 147         ///
 148         int parOffset(ParagraphList::iterator pit) const;
 149         /// convenience
 150         ParagraphList::iterator cursorPar() const;
 151         ///
 152         RowList::iterator cursorRow() const;
 153
 154         /** returns an iterator pointing to the row near the specified
 155           * y-coordinate (relative to the whole text). y is set to the
 156           * real beginning of this row
 157           */
 158         RowList::iterator getRowNearY(int y,
 159                 ParagraphList::iterator & pit) const;
 160
 161         /** returns the column near the specified x-coordinate of the row
 162          x is set to the real beginning of this column
 163          */
 164         lyx::pos_type getColumnNearX(ParagraphList::iterator pit,
 165                 Row const & row, int & x, bool & boundary) const;
 166
 167         /// need the selection cursor:
 168         void setSelection();
 169         ///
 170         void clearSelection();
 171
 172         /// select the word we need depending on word_location
 173         void getWord(LyXCursor & from, LyXCursor & to, lyx::word_location const);
 174         /// just selects the word the cursor is in
 175         void selectWord(lyx::word_location loc);
 176         /// returns the inset at cursor (if it exists), 0 otherwise
 177         InsetOld * getInset() const;
 178
 179         /// accept selected change
 180         void acceptChange();
 181
 182         /// reject selected change
 183         void rejectChange();
 184
 185         /// re-computes the cached coordinates in the cursor
 186         void redoCursor();
 187         ///
 188         void setCursor(ParagraphList::iterator pit, lyx::pos_type pos);
 189         /// returns true if par was empty and was removed
 190         bool setCursor(lyx::paroffset_type par, lyx::pos_type pos,
 191                        bool setfont = true, bool boundary = false);
 192         ///
 193         void setCursor(LyXCursor &, lyx::paroffset_type par,
 194                        lyx::pos_type pos, bool boundary = false);
 195         ///
 196         void setCursorIntern(lyx::paroffset_type par, lyx::pos_type pos,
 197                              bool setfont = true, bool boundary = false);
 198         ///
 199         void setCurrentFont();
 200
 201         ///
 202         void recUndo(lyx::paroffset_type first, lyx::paroffset_type last) const;
 203         ///
 204         void recUndo(lyx::paroffset_type first) const;
 205         ///
 206         void setCursorFromCoordinates(int x, int y);
 207         ///
 208         void setCursorFromCoordinates(LyXCursor &, int x, int y);
 209         ///
 210         void cursorUp(bool selecting = false);
 211         ///
 212         void cursorDown(bool selecting = false);
 213         ///
 214         bool cursorLeft(bool internal = true);
 215         ///
 216         bool cursorRight(bool internal = true);
 217         ///
 218         void cursorLeftOneWord();
 219         ///
 220         void cursorRightOneWord();
 221         ///
 222         void cursorUpParagraph();
 223         ///
 224         void cursorDownParagraph();
 225         ///
 226         void cursorHome();
 227         ///
 228         void cursorEnd();
 229         ///
 230         void cursorPrevious();
 231         ///
 232         void cursorNext();
 233         ///
 234         void cursorTop();
 235         ///
 236         void cursorBottom();
 237         ///
 238         void Delete();
 239         ///
 240         void backspace();
 241         ///
 242         bool selectWordWhenUnderCursor(lyx::word_location);
 243         ///
 244         enum TextCase {
 245                 ///
 246                 text_lowercase = 0,
 247                 ///
 248                 text_capitalization = 1,
 249                 ///
 250                 text_uppercase = 2
 251         };
 252         /// Change the case of the word at cursor position.
 253         void changeCase(TextCase action);
 254
 255         /// returns success
 256         bool toggleInset();
 257         ///
 258         void cutSelection(bool doclear = true, bool realcut = true);
 259         ///
 260         void copySelection();
 261         ///
 262         void pasteSelection(size_t sel_index = 0);
 263
 264         /** the DTP switches for paragraphs. LyX will store the top settings
 265          always in the first physical paragraph, the bottom settings in the
 266          last. When a paragraph is broken, the top settings rest, the bottom
 267          settings are given to the new one.
 268          */
 269         void setParagraph(
 270                           Spacing const & spacing,
 271                           LyXAlignment align,
 272                           std::string const & labelwidthstring,
 273                           bool noindent);
 274
 275         /* these things are for search and replace */
 276
 277         /**
 278          * Sets the selection from the current cursor position to length
 279          * characters to the right. No safety checks.
 280          */
 281         void setSelectionRange(lyx::pos_type length);
 282
 283         /** simple replacing. The font of the first selected character
 284           is used
 285           */
 286         void replaceSelectionWithString(std::string const & str);
 287
 288         /// needed to insert the selection
 289         void insertStringAsLines(std::string const & str);
 290         /// needed to insert the selection
 291         void insertStringAsParagraphs(std::string const & str);
 292
 293         /// Find next inset of some specified type.
 294         bool gotoNextInset(std::vector<InsetOld::Code> const & codes,
 295                            std::string const & contents = std::string());
 296         ///
 297         void gotoInset(std::vector<InsetOld::Code> const & codes,
 298                        bool same_content);
 299         ///
 300         void gotoInset(InsetOld::Code code, bool same_content);
 301
 302         /// current max text width
 303         int textWidth() const;
 304
 305         /// updates all counters
 306         void updateCounters();
 307         /// Returns an inset if inset was hit, or 0 if not.
 308         InsetOld * checkInsetHit(int x, int y);
 309
 310         ///
 311         int singleWidth(ParagraphList::iterator pit, lyx::pos_type pos) const;
 312         ///
 313         int singleWidth(ParagraphList::iterator pit,
 314                 lyx::pos_type pos, char c, LyXFont const & Font) const;
 315
 316         /// return the color of the canvas
 317         LColor_color backgroundColor() const;
 318
 319         /**
 320          * Returns the left beginning of the text.
 321          * This information cannot be taken from the layout object, because
 322          * in LaTeX the beginning of the text fits in some cases
 323          * (for example sections) exactly the label-width.
 324          */
 325         int leftMargin(ParagraphList::iterator pit, lyx::pos_type pos) const;
 326         int leftMargin(ParagraphList::iterator pit) const;
 327         ///
 328         int rightMargin(Paragraph const & par) const;
 329
 330         /** this calculates the specified parameters. needed when setting
 331          * the cursor and when creating a visible row */
 332         void prepareToPrint(ParagraphList::iterator pit, Row & row) const;
 333
 334         //
 335         // special owner functions
 336         ///
 337         ParagraphList & paragraphs() const;
 338
 339         /// return true if this is owned by an inset.
 340         bool isInInset() const;
 341
 342         ///
 343         ParagraphList::iterator firstPar() const;
 344         ///
 345         ParagraphList::iterator lastPar() const;
 346         ///
 347         ParagraphList::iterator endPar() const;
 348
 349         /// return first row of text
 350         RowList::iterator firstRow() const;
 351         /// return last row of text
 352         RowList::iterator lastRow() const;
 353         /// return row "behind" last row of text
 354         RowList::iterator endRow() const;
 355         /// return next row crossing paragraph boundaries
 356         void nextRow(ParagraphList::iterator & pit,
 357                 RowList::iterator & rit) const;
 358         /// return previous row crossing paragraph boundaries
 359         void previousRow(ParagraphList::iterator & pit,
 360                 RowList::iterator & rit) const;
 361
 362         /// is this row the last in the text?
 363         bool isLastRow(ParagraphList::iterator pit, Row const & row) const;
 364         /// is this row the first in the text?
 365         bool isFirstRow(ParagraphList::iterator pit, Row const & row) const;
 366
 367         ///
 368         std::string selectionAsString(Buffer const & buffer, bool label) const;
 369         ///
 370         double spacing(Paragraph const &) const;
 371         ///
 372         void cursorLeftOneWord(LyXCursor &);
 373         ///
 374         void cursorRightOneWord(LyXCursor &);
 375
 376         ///
 377         DispatchResult moveRight();
 378         ///
 379         DispatchResult moveLeft();
 380         ///
 381         DispatchResult moveRightIntern(bool front,
 382                 bool activate_inset, bool selecting);
 383         ///
 384         DispatchResult moveLeftIntern(bool front,
 385                 bool activate_inset, bool selecting);
 386         ///
 387         DispatchResult moveUp();
 388         ///
 389         DispatchResult moveDown();
 390         ///
 391         bool checkAndActivateInset(bool front);
 392
 393         ///
 394         void write(Buffer const & buf, std::ostream & os) const;
 395         /// returns whether we've seen our usual 'end' marker
 396         bool read(Buffer const & buf, LyXLex & lex);
 397
 398 public:
 399         ///
 400         int height;
 401         ///
 402         unsigned int width;
 403         ///
 404         int textwidth_;
 405         /// the current font settings
 406         LyXFont current_font;
 407         /// the current font
 408         LyXFont real_current_font;
 409         /// our buffer's default layout font
 410         LyXFont defaultfont_;
 411         ///
 412         int background_color_;
 413
 414         /// only the top-level LyXText has this non-zero
 415         BufferView * bv_owner;
 416
 417         ///
 418         mutable Bidi bidi;
 419         ///
 420         bool in_inset_;
 421         ///
 422         ParagraphList paragraphs_;
 423
 424         /// absolute document pixel coordinates of this LyXText
 425         mutable int xo_;
 426         mutable int yo_;
 427
 428         /// our 'outermost' Font
 429         LyXFont font_;
 430
 431
 432 private:
 433         /// rebreaks the given par
 434         void redoParagraphInternal(ParagraphList::iterator pit);
 435
 436         ///
 437         float getCursorX(ParagraphList::iterator pit,
 438              Row const & row, lyx::pos_type pos, bool boundary) const;
 439         /// used in setlayout
 440         void makeFontEntriesLayoutSpecific(BufferParams const &, Paragraph & par);
 441
 442         /// Calculate and set the height of the row
 443         void setHeightOfRow(ParagraphList::iterator, Row & row);
 444
 445         // fix the cursor `cur' after a characters has been deleted at `where'
 446         // position. Called by deleteEmptyParagraphMechanism
 447         void fixCursorAfterDelete(LyXCursor & cur, LyXCursor const & where);
 448
 449         /// delete double space (false) or empty paragraphs (true) around old_cursor
 450         bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor);
 451
 452         ///
 453         void setCounter(Buffer const &, ParagraphList::iterator pit);
 454         ///
 455         void deleteWordForward();
 456         ///
 457         void deleteWordBackward();
 458         ///
 459         void deleteLineForward();
 460
 461         /// sets row.end to the pos value *after* which a row should break.
 462         /// for example, the pos after which isNewLine(pos) == true
 463         void rowBreakPoint(ParagraphList::iterator pit, Row & row) const;
 464
 465         /// sets row.witdh to the minimum space a row needs on the screen in pixel
 466         void fill(ParagraphList::iterator pit, Row & row, int workwidth) const;
 467
 468         /**
 469          * returns the minimum space a manual label needs on the
 470          * screen in pixels
 471          */
 472         int labelFill(ParagraphList::iterator pit, Row const & row) const;
 473
 474         /// FIXME
 475         int labelEnd(ParagraphList::iterator pit) const;
 476
 477         ///
 478         void charInserted();
 479         /// set 'number' font property
 480         void number();
 481         /// is the cursor paragraph right-to-left?
 482         bool rtl() const;
 483 };
 484
 485 /// return the default height of a row in pixels, considering font zoom
 486 extern int defaultRowHeight();
 487
 488 ///
 489 std::string expandLabel(LyXTextClass const & textclass,
 490                 LyXLayout_ptr const & layout, bool appendix);
 491
 492 #endif // LYXTEXT_H