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 "lyxfont.h"
  18 #include "lyxcursor.h"
  19 #include "layout.h"
  20 #include "LColor.h"
  21 #include "insets/inset.h"
  22 #include "RowList.h"
  23 #include "bufferview_funcs.h"
  24 #include "textcursor.h"
  25
  26 class Buffer;
  27 class BufferParams;
  28 class BufferView;
  29 class InsetText;
  30 class Paragraph;
  31 class Row;
  32 class Spacing;
  33 class UpdatableInset;
  34 class VSpace;
  35 class WordLangTuple;
  36 class ParagraphList;
  37
  38
  39 /**
  40   This class holds the mapping between buffer paragraphs and screen rows.
  41   */
  42
  43 // The inheritance from TextCursor should go. It's just there to ease
  44 // transition...
  45 class LyXText : public TextCursor {
  46 public:
  47         /// Constructor
  48         LyXText(BufferView *);
  49         /// sets inset as owner
  50         LyXText(BufferView *, InsetText *);
  51
  52         void init(BufferView *);
  53         ///
  54         int height;
  55         ///
  56         unsigned int width;
  57         /// the current font settings
  58         LyXFont current_font;
  59         /// the current font
  60         LyXFont real_current_font;
  61 private:
  62         /** the 'anchor' row: the position of this row remains constant
  63          *  with respect to the top of the screen
  64          */
  65         RowList::iterator anchor_row_;
  66         /** the pixel offset with respect to this row of top_y
  67          */
  68         int anchor_row_offset_;
  69 public:
  70         /// update all cached row positions
  71         void updateRowPositions();
  72         /// get the y coord. of the top of the screen (relative to doc start)
  73         int top_y() const;
  74         /// set the y coord. of the top of the screen (relative to doc start)
  75         void top_y(int newy);
  76         /// set the anchoring row. top_y will be computed relative to this
  77         void anchor_row(RowList::iterator rit);
  78         ///
  79         InsetText * inset_owner;
  80         ///
  81         UpdatableInset * the_locking_inset;
  82
  83         ///
  84         int getRealCursorX() const;
  85         ///
  86         LyXFont const getFont(Buffer const *, ParagraphList::iterator pit,
  87                 lyx::pos_type pos) const;
  88         ///
  89         LyXFont const getLayoutFont(Buffer const *,
  90                                     ParagraphList::iterator pit) const;
  91         ///
  92         LyXFont const getLabelFont(Buffer const *,
  93                                    ParagraphList::iterator pit) const;
  94         ///
  95         void setCharFont(Buffer const *, ParagraphList::iterator pit,
  96                          lyx::pos_type pos, LyXFont const & font);
  97         void setCharFont(ParagraphList::iterator pit,
  98                          lyx::pos_type pos,
  99                          LyXFont const & font, bool toggleall);
 100
 101         ///
 102         void breakAgainOneRow(RowList::iterator rit);
 103         /// what you expect when pressing <enter> at cursor position
 104         void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0);
 105
 106         /** set layout over selection and make a total rebreak of
 107           those paragraphs
 108           */
 109         ParagraphList::iterator
 110         setLayout(LyXCursor & actual_cursor,
 111                   LyXCursor & selection_start,
 112                   LyXCursor & selection_end,
 113                   string const & layout);
 114         ///
 115         void setLayout(string const & layout);
 116
 117         /**
 118          * Increase or decrease the nesting depth of the selected paragraph(s)
 119          * if test_only, don't change any depths. Returns whether something
 120          * (would have) changed
 121          */
 122         bool changeDepth(bv_funcs::DEPTH_CHANGE type, bool test_only);
 123
 124         /// get the depth at current cursor position
 125         int getDepth() const;
 126
 127         /** set font over selection and make a total rebreak of those
 128           paragraphs.
 129           toggleall defaults to false.
 130           */
 131         void setFont(LyXFont const &, bool toggleall = false);
 132
 133         /** deletes and inserts again all paragaphs between the cursor
 134           and the specified par. The Cursor is needed to set the refreshing
 135           parameters.
 136           This function is needed after SetLayout and SetFont etc.
 137           */
 138         void redoParagraphs(LyXCursor const & cursor,
 139                             ParagraphList::iterator endpit);
 140         ///
 141         void redoParagraph();
 142
 143         ///
 144         void toggleFree(LyXFont const &, bool toggleall = false);
 145
 146         ///
 147         string getStringToIndex();
 148
 149         /** recalculates the heights of all previous rows of the
 150             specified paragraph.  needed, if the last characters font
 151             has changed.
 152             */
 153         void redoHeightOfParagraph();
 154
 155         /** insert a character, moves all the following breaks in the
 156           same Paragraph one to the right and make a little rebreak
 157           */
 158         void insertChar(char c);
 159         ///
 160         void insertInset(Inset * inset);
 161
 162         /// Completes the insertion with a rebreak from 'need_break_row' on
 163         void partialRebreak();
 164         /// a full rebreak of the whole text
 165         void fullRebreak();
 166
 167         ///
 168         RowList::iterator need_break_row;
 169
 170         /// clear any pending paints
 171         void clearPaint();
 172
 173         /// submit repaint request
 174         void postPaint();
 175
 176         ///
 177         Inset::RESULT dispatch(FuncRequest const & cmd);
 178
 179         BufferView * bv();
 180
 181         BufferView * bv() const;
 182
 183         friend class LyXScreen;
 184
 185         /**
 186          * Return the status. This represents what repaints are
 187          * pending after some operation (e.g. inserting a char).
 188          */
 189         bool needRefresh() const;
 190
 191 private:
 192         // do we need a refresh?
 193         bool need_refresh_;
 194
 195 public:
 196         /// only the top-level LyXText has this non-zero
 197         BufferView * bv_owner;
 198
 199 private:
 200         /// returns a pointer to a specified row.
 201         RowList::iterator
 202         getRow(ParagraphList::iterator pit, lyx::pos_type pos) const;
 203 public:
 204         /// returns a pointer cursor row
 205         RowList::iterator getRow(LyXCursor const & cursor) const;
 206         /// convenience
 207         RowList::iterator cursorRow() const;
 208         /**
 209          * Return the next row, when cursor is at the end of the
 210          * previous row, for insets that take a full row.
 211          *
 212          * FIXME: explain why we need this ? especially for y...
 213          */
 214         RowList::iterator cursorIRow() const;
 215
 216         /** returns a pointer to the row near the specified y-coordinate
 217           (relative to the whole text). y is set to the real beginning
 218           of this row
 219           */
 220         RowList::iterator getRowNearY(int & y) const;
 221
 222         /** returns the column near the specified x-coordinate of the row
 223          x is set to the real beginning of this column
 224          */
 225         lyx::pos_type getColumnNearX(RowList::iterator rit,
 226                                      int & x, bool & boundary) const;
 227
 228         /** returns a pointer to a specified row. y is set to the beginning
 229          of the row
 230          */
 231         RowList::iterator
 232         getRow(ParagraphList::iterator pit, lyx::pos_type pos, int & y) const;
 233
 234         RowList & rows() const {
 235                 return rowlist_;
 236         }
 237
 238
 239         /// need the selection cursor:
 240         void setSelection();
 241         ///
 242         void clearSelection();
 243
 244         /// select the word we need depending on word_location
 245         void getWord(LyXCursor & from, LyXCursor & to, lyx::word_location const);
 246         /// just selects the word the cursor is in
 247         void selectWord(lyx::word_location loc);
 248         /// returns the inset at cursor (if it exists), 0 otherwise
 249         Inset * getInset() const;
 250
 251         /// accept selected change
 252         void acceptChange();
 253
 254         /// reject selected change
 255         void rejectChange();
 256
 257         /** 'selects" the next word, where the cursor is not in
 258          and returns this word as string. THe cursor will be moved
 259          to the beginning of this word.
 260          With SelectSelectedWord can this be highlighted really
 261          */
 262         WordLangTuple const selectNextWordToSpellcheck(float & value);
 263         ///
 264         void selectSelectedWord();
 265         /// returns true if par was empty and was removed
 266         bool setCursor(ParagraphList::iterator pit,
 267                        lyx::pos_type pos,
 268                        bool setfont = true,
 269                        bool boundary = false);
 270         ///
 271         void setCursor(LyXCursor &, ParagraphList::iterator pit,
 272                        lyx::pos_type pos,
 273                        bool boundary = false);
 274         ///
 275         void setCursorIntern(ParagraphList::iterator pit,
 276                              lyx::pos_type pos,
 277                              bool setfont = true,
 278                              bool boundary = false);
 279         ///
 280         void setCurrentFont();
 281
 282         ///
 283         bool isBoundary(Buffer const *, Paragraph const & par,
 284                         lyx::pos_type pos) const;
 285         ///
 286         bool isBoundary(Buffer const *, Paragraph const & par,
 287                          lyx::pos_type pos,
 288                          LyXFont const & font) const;
 289
 290         ///
 291         void setCursorFromCoordinates(int x, int y);
 292         ///
 293         void setCursorFromCoordinates(LyXCursor &,
 294                                       int x, int y);
 295         ///
 296         void cursorUp(bool selecting = false);
 297         ///
 298         void cursorDown(bool selecting = false);
 299         ///
 300         void cursorLeft(bool internal = true);
 301         ///
 302         void cursorRight(bool internal = true);
 303         ///
 304         void cursorLeftOneWord();
 305         ///
 306         void cursorRightOneWord();
 307         ///
 308         void cursorUpParagraph();
 309         ///
 310         void cursorDownParagraph();
 311         ///
 312         void cursorHome();
 313         ///
 314         void cursorEnd();
 315         ///
 316         void cursorPrevious();
 317         ///
 318         void cursorNext();
 319         ///
 320         void cursorTop();
 321         ///
 322         void cursorBottom();
 323         ///
 324         void Delete();
 325         ///
 326         void backspace();
 327         ///
 328         bool selectWordWhenUnderCursor(lyx::word_location);
 329         ///
 330         enum TextCase {
 331                 ///
 332                 text_lowercase = 0,
 333                 ///
 334                 text_capitalization = 1,
 335                 ///
 336                 text_uppercase = 2
 337         };
 338         /// Change the case of the word at cursor position.
 339         void changeCase(TextCase action);
 340
 341         ///
 342         void toggleInset();
 343         ///
 344         void cutSelection(bool doclear = true, bool realcut = true);
 345         ///
 346         void copySelection();
 347         ///
 348         void pasteSelection(size_t sel_index = 0);
 349
 350         /** the DTP switches for paragraphs. LyX will store the top settings
 351          always in the first physical paragraph, the bottom settings in the
 352          last. When a paragraph is broken, the top settings rest, the bottom
 353          settings are given to the new one. So I can make shure, they do not
 354          duplicate themself (and you cannnot make dirty things with them! )
 355          */
 356         void setParagraph(bool line_top, bool line_bottom,
 357                           bool pagebreak_top, bool pagebreak_bottom,
 358                           VSpace const & space_top,
 359                           VSpace const & space_bottom,
 360                           Spacing const & spacing,
 361                           LyXAlignment align,
 362                           string const & labelwidthstring,
 363                           bool noindent);
 364
 365         /* these things are for search and replace */
 366
 367         /**
 368          * Sets the selection from the current cursor position to length
 369          * characters to the right. No safety checks.
 370          */
 371         void setSelectionRange(lyx::pos_type length);
 372
 373         /** simple replacing. The font of the first selected character
 374           is used
 375           */
 376         void replaceSelectionWithString(string const & str);
 377
 378         /// needed to insert the selection
 379         void insertStringAsLines(string const & str);
 380         /// needed to insert the selection
 381         void insertStringAsParagraphs(string const & str);
 382
 383         /// Find next inset of some specified type.
 384         bool gotoNextInset(std::vector<Inset::Code> const & codes,
 385                            string const & contents = string());
 386         ///
 387         void gotoInset(std::vector<Inset::Code> const & codes,
 388                        bool same_content);
 389         ///
 390         void gotoInset(Inset::Code code, bool same_content);
 391         ///
 392
 393         /* for the greater insets */
 394
 395         /// returns false if inset wasn't found
 396         bool updateInset(Inset *);
 397         ///
 398         void checkParagraph(ParagraphList::iterator pit, lyx::pos_type pos);
 399         ///
 400         int workWidth() const;
 401         /// returns width of row containing inset
 402         int workWidth(Inset const * inset) const;
 403
 404         ///
 405         void computeBidiTables(Buffer const *, RowList::iterator row) const;
 406         /// Maps positions in the visual string to positions in logical string.
 407         lyx::pos_type log2vis(lyx::pos_type pos) const;
 408         /// Maps positions in the logical string to positions in visual string.
 409         lyx::pos_type vis2log(lyx::pos_type pos) const;
 410         ///
 411         lyx::pos_type bidi_level(lyx::pos_type pos) const;
 412         ///
 413         bool bidi_InRange(lyx::pos_type pos) const;
 414 private:
 415         ///
 416         mutable RowList rowlist_;
 417
 418         ///
 419         float getCursorX(RowList::iterator rit, lyx::pos_type pos,
 420                          lyx::pos_type last, bool boundary) const;
 421         /// used in setlayout
 422         void makeFontEntriesLayoutSpecific(Buffer const &, Paragraph & par);
 423
 424         /** forces the redrawing of a paragraph. Needed when manipulating a
 425             right address box
 426             */
 427         void redoDrawingOfParagraph(LyXCursor const & cursor);
 428
 429         /// removes the row and reset the touched counters
 430         void removeRow(RowList::iterator rit);
 431
 432         /// remove all following rows of the paragraph of the specified row.
 433         void removeParagraph(RowList::iterator rit);
 434
 435         /// insert the specified paragraph behind the specified row
 436         void insertParagraph(ParagraphList::iterator pit,
 437                              RowList::iterator rowit);
 438
 439         /** appends  the implizit specified paragraph behind the specified row,
 440          * start at the implizit given position */
 441         void appendParagraph(RowList::iterator rowit);
 442
 443         ///
 444         void breakAgain(RowList::iterator rit);
 445         /// Calculate and set the height of the row
 446         void setHeightOfRow(RowList::iterator rit);
 447
 448         // fix the cursor `cur' after a characters has been deleted at `where'
 449         // position. Called by deleteEmptyParagraphMechanism
 450         void fixCursorAfterDelete(LyXCursor & cur,
 451                                   LyXCursor const & where);
 452
 453         /// delete double space (false) or empty paragraphs (true) around old_cursor
 454         bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor);
 455
 456 public:
 457         /** Updates all counters starting BEHIND the row. Changed paragraphs
 458          * with a dynamic left margin will be rebroken. */
 459         void updateCounters();
 460         ///
 461         void update();
 462         /**
 463          * Returns an inset if inset was hit, or 0 if not.
 464          * If hit, the coordinates are changed relative to the inset.
 465          */
 466         Inset * checkInsetHit(int & x, int & y);
 467
 468         ///
 469         int singleWidth(ParagraphList::iterator pit,
 470                 lyx::pos_type pos) const;
 471         ///
 472         int singleWidth(ParagraphList::iterator pit,
 473                 lyx::pos_type pos, char c) const;
 474
 475         /// return the color of the canvas
 476         LColor::color backgroundColor() const;
 477
 478         ///
 479         mutable bool bidi_same_direction;
 480
 481         unsigned char transformChar(unsigned char c, Paragraph const & par,
 482                                     lyx::pos_type pos) const;
 483
 484         /**
 485          * Returns the left beginning of the text.
 486          * This information cannot be taken from the layout object, because
 487          * in LaTeX the beginning of the text fits in some cases
 488          * (for example sections) exactly the label-width.
 489          */
 490         int leftMargin(Row const & row) const;
 491         ///
 492         int rightMargin(Buffer const &, Row const & row) const;
 493
 494         /** this calculates the specified parameters. needed when setting
 495          * the cursor and when creating a visible row */
 496         void prepareToPrint(RowList::iterator row, float & x,
 497                             float & fill_separator,
 498                             float & fill_hfill,
 499                             float & fill_label_hfill,
 500                             bool bidi = true) const;
 501
 502 private:
 503         ///
 504         void setCounter(Buffer const *, ParagraphList::iterator pit);
 505         ///
 506         void deleteWordForward();
 507         ///
 508         void deleteWordBackward();
 509         ///
 510         void deleteLineForward();
 511
 512         /*
 513          * some low level functions
 514          */
 515
 516
 517         /// return the pos value *before* which a row should break.
 518         /// for example, the pos at which IsNewLine(pos) == true
 519         lyx::pos_type rowBreakPoint(Row const & row) const;
 520
 521         /// returns the minimum space a row needs on the screen in pixel
 522         int fill(RowList::iterator row, int workwidth) const;
 523
 524         /**
 525          * returns the minimum space a manual label needs on the
 526          * screen in pixels
 527          */
 528         int labelFill(Row const & row) const;
 529
 530         /// FIXME
 531         int labelEnd(Row const & row) const;
 532
 533         ///
 534         mutable std::vector<lyx::pos_type> log2vis_list;
 535         ///
 536         mutable std::vector<lyx::pos_type> vis2log_list;
 537         ///
 538         mutable std::vector<lyx::pos_type> bidi_levels;
 539         ///
 540         mutable lyx::pos_type bidi_start;
 541         ///
 542         mutable lyx::pos_type bidi_end;
 543
 544         ///
 545         void charInserted();
 546 public:
 547         //
 548         // special owner functions
 549         ///
 550         ParagraphList & ownerParagraphs() const;
 551
 552         /// return true if this is owned by an inset.
 553         bool isInInset() const;
 554
 555 private:
 556         /** Cursor related data.
 557           Later this variable has to be removed. There should be now internal
 558           cursor in a text */
 559         ///
 560         ///TextCursor cursor_;
 561 };
 562
 563 /// return the default height of a row in pixels, considering font zoom
 564 extern int defaultRowHeight();
 565
 566 #endif // LYXTEXT_H