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