src/lyxtext.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995 Matthias Ettrich
   8  *           Copyright 1995-2000 The LyX Team.
   9  *
  10  * ====================================================== */
  11
  12 #ifndef LYXTEXT_H
  13 #define LYXTEXT_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "lyxfont.h"
  20 #include "undo.h"
  21 #include "lyxcursor.h"
  22 #include "lyxparagraph.h"
  23 #include "layout.h"
  24
  25 class Buffer;
  26 class BufferParams;
  27 class Row;
  28 class BufferView;
  29
  30 /**
  31   This class holds the mapping between buffer paragraphs and screen rows.
  32   */
  33 class LyXText {
  34 public:
  35         ///
  36         enum text_status {
  37                 ///
  38                 UNCHANGED,
  39                 ///
  40                 NEED_LITTLE_REFRESH,
  41                 ///
  42                 NEED_MORE_REFRESH,
  43                 ///
  44                 NEED_VERY_LITTLE_REFRESH
  45         };
  46
  47         enum Letter_Form {
  48                 FORM_ISOLATED,
  49                 FORM_INITIAL,
  50                 FORM_MEDIAL,
  51                 FORM_FINAL
  52         };
  53
  54         /// Constructor
  55         LyXText(BufferView *, int paperwidth, Buffer *);
  56
  57         /// Destructor
  58         ~LyXText();
  59
  60         /// points to Buffer.params
  61         BufferParams * bparams;
  62         /// points to Buffer
  63         Buffer * buffer;
  64         ///
  65         mutable int number_of_rows;
  66         ///
  67         mutable long height;
  68         /// the current font settings
  69         mutable LyXFont current_font;
  70         /// the current font
  71         mutable LyXFont real_current_font;
  72
  73         ///
  74         void owner(BufferView *);
  75
  76         ///
  77         LyXFont GetFont(LyXParagraph * par,
  78                         LyXParagraph::size_type pos) const;
  79         ///
  80         void SetCharFont(LyXParagraph * par,
  81                          LyXParagraph::size_type pos,
  82                          LyXFont const & font);
  83         /// returns a pointer to the very first LyXParagraph
  84         LyXParagraph * FirstParagraph() const;
  85
  86         /// what you expect when pressing <enter> at cursor position
  87         void BreakParagraph(char keep_layout = 0);
  88
  89         /** set layout over selection and make a total rebreak of
  90           those paragraphs
  91           */
  92         void SetLayout(LyXTextClass::size_type layout);
  93
  94         /// used in setlayout
  95         void MakeFontEntriesLayoutSpecific(LyXParagraph * par);
  96
  97         /** increment depth over selection and make a total rebreak of those
  98           paragraphs
  99           */
 100         void IncDepth();
 101
 102         /** decrement depth over selection and make a total rebreak of those
 103           paragraphs */
 104         void DecDepth();
 105
 106         /** Get the depth at current cursor position
 107          */
 108         int GetDepth() const { return cursor.par->GetDepth(); }
 109
 110         /** set font over selection and make a total rebreak of those
 111           paragraphs.
 112           toggleall defaults to false.
 113           */
 114         void SetFont(LyXFont const & font, bool toggleall = false);
 115
 116         /** deletes and inserts again all paragaphs between the cursor
 117           and the specified par. The Cursor is needed to set the refreshing
 118           parameters.
 119           This function is needed after SetLayout and SetFont etc.
 120           */
 121         void RedoParagraphs(LyXCursor const & cursor,
 122                             LyXParagraph const * end_par) const;
 123         ///
 124         void RedoParagraph() const;
 125
 126         ///
 127         void ToggleFree(LyXFont const & font, bool toggleall = false);
 128
 129         /** recalculates the heights of all previous rows of the
 130             specified paragraph.  needed, if the last characters font
 131             has changed.
 132             */
 133         void RedoHeightOfParagraph(LyXCursor const & cursor);
 134
 135         /** forces the redrawing of a paragraph. Needed when manipulating a
 136             right address box
 137             */
 138         void RedoDrawingOfParagraph(LyXCursor const & cursor);
 139
 140         /** insert a character, moves all the following breaks in the
 141           same Paragraph one to the right and make a little rebreak
 142           */
 143         void InsertChar(char c);
 144         ///
 145         void InsertInset(Inset * inset);
 146
 147         /// completes the insertion with a full rebreak
 148         int FullRebreak();
 149
 150         ///
 151         LyXParagraph::footnote_flag GetFootnoteFlag(int row);
 152         ///
 153         Row * need_break_row;
 154         ///
 155         mutable long refresh_y;
 156         ///
 157         int refresh_height;
 158         ///
 159         int refresh_width;
 160         ///
 161         int refresh_x;
 162         ///
 163         mutable Row * refresh_row;
 164         ///
 165         int refresh_pos;
 166
 167         /** wether the screen needs a refresh,
 168            starting with refresh_y
 169            */
 170         mutable text_status status;
 171
 172         /** returns a pointer to the row near the specified y-coordinate
 173           (relative to the whole text). y is set to the real beginning
 174           of this row
 175           */
 176         Row * GetRowNearY(long & y) const;
 177
 178         /** returns the column near the specified x-coordinate of the row
 179          x is set to the real beginning of this column
 180          */
 181         int GetColumnNearX(Row * row, int & x) const;
 182
 183         /** returns a pointer to a specified row. y is set to the beginning
 184          of the row
 185          */
 186         Row * GetRow(LyXParagraph * par,
 187                      LyXParagraph::size_type pos, long & y) const;
 188         /** returns the height of a default row, needed  for scrollbar
 189          */
 190         int DefaultHeight() const;
 191
 192         /** The cursor.
 193           Later this variable has to be removed. There should be now internal
 194           cursor in a text (and thus not in a buffer). By keeping this it is
 195           (I think) impossible to have several views with the same buffer, but
 196           the cursor placed at different places.
 197           [later]
 198           Since the LyXText now has been moved from Buffer to BufferView
 199           it should not be absolutely needed to move the cursor...
 200           */
 201         mutable LyXCursor cursor;
 202
 203         /* the selection cursor */
 204         ///
 205         mutable bool selection;
 206         ///
 207         mutable bool mark_set;
 208
 209         ///
 210         mutable LyXCursor sel_cursor;
 211         ///
 212         LyXCursor sel_start_cursor;
 213         ///
 214         mutable LyXCursor sel_end_cursor;
 215         /// needed for the toggling
 216         LyXCursor last_sel_cursor;
 217         ///
 218         LyXCursor toggle_cursor;
 219         ///
 220         LyXCursor toggle_end_cursor;
 221
 222         /// need the selection cursor:
 223         void SetSelection();
 224         ///
 225         void ClearSelection() const;
 226
 227         /// just selects the word the cursor is in
 228         void SelectWord();
 229
 230         /** 'selects" the next word, where the cursor is not in
 231          and returns this word as string. THe cursor will be moved
 232          to the beginning of this word.
 233          With SelectSelectedWord can this be highlighted really
 234          */
 235         char * SelectNextWord(float & value);
 236         ///
 237         void SelectSelectedWord();
 238         ///
 239         void SetCursor(LyXParagraph * par,
 240                        LyXParagraph::size_type pos,
 241                        bool setfont = true) const;
 242         ///
 243         void SetCursorIntern(LyXParagraph * par,
 244                              LyXParagraph::size_type pos,
 245                              bool setfont = true) const;
 246         ///
 247         void SetCursorFromCoordinates(int x, long y) const;
 248         void SetCursorFromCoordinates(LyXCursor &, int x, long y) const;
 249         ///
 250         void CursorUp() const;
 251         ///
 252         void CursorDown() const;
 253         ///
 254         void CursorLeft() const;
 255         ///
 256         void CursorRight() const;
 257         ///
 258         void CursorLeftOneWord() const;
 259         ///
 260         void CursorRightOneWord() const;
 261         ///
 262         void CursorUpParagraph() const;
 263         ///
 264         void CursorDownParagraph() const;
 265         ///
 266         void CursorHome() const;
 267         ///
 268         void CursorEnd() const;
 269         ///
 270         void CursorTab() const;
 271         ///
 272         void CursorTop() const;
 273         ///
 274         void CursorBottom() const;
 275         ///
 276         void Delete();
 277         ///
 278         void Backspace();
 279         ///
 280         void DeleteWordForward();
 281         ///
 282         void DeleteWordBackward();
 283         ///
 284         void DeleteLineForward();
 285         ///
 286         int SelectWordWhenUnderCursor();
 287
 288         enum TextCase {
 289                 text_lowercase = 0,
 290                 text_capitalization = 1,
 291                 text_uppercase = 2
 292         };
 293         /// Change the case of the word at cursor position.
 294         void ChangeWordCase(TextCase action);
 295
 296         /** returns a printed row in a pixmap. The y value is needed to
 297           decide, wether it is selected text or not. This is a strange
 298           solution but faster.
 299          */
 300         void GetVisibleRow(int offset, Row * row_ptr, long y);
 301
 302         /* footnotes: */
 303         ///
 304         void ToggleFootnote();
 305         ///
 306         void OpenStuff();
 307         ///
 308         void OpenFootnotes();
 309         ///
 310         void OpenFootnote();
 311         ///
 312         void CloseFootnotes();
 313         ///
 314         void CloseFootnote();
 315
 316         /** turn the selection into a new environment. If there is no
 317           selection, create an empty environment
 318          */
 319         void InsertFootnoteEnvironment(LyXParagraph::footnote_kind kind);
 320         ///
 321         void MeltFootnoteEnvironment();
 322         ///
 323         void CutSelection(bool = true);
 324         ///
 325         void CopySelection();
 326         ///
 327         void PasteSelection();
 328         ///
 329         void copyEnvironmentType();
 330         ///
 331         void pasteEnvironmentType();
 332         ///
 333         void InsertFootnote();
 334         ///
 335         void InsertMarginpar();
 336         ///
 337         void InsertFigure();
 338         ///
 339         void InsertTabular();
 340
 341         /** the DTP switches for paragraphs. LyX will store the top settings
 342          always in the first physical paragraph, the bottom settings in the
 343          last. When a paragraph is broken, the top settings rest, the bottom
 344          settings are given to the new one. So I can make shure, they do not
 345          duplicate themself (and you cannnot make dirty things with them! )
 346          */
 347         void SetParagraph(bool line_top, bool line_bottom,
 348                           bool pagebreak_top, bool pagebreak_bottom,
 349                           VSpace const & space_top,
 350                           VSpace const & space_bottom,
 351                           LyXAlignment align,
 352                           string labelwidthstring,
 353                           bool noindent);
 354         void SetParagraphExtraOpt(int type,
 355                                   char const * width,
 356                                   char const * widthp,
 357                                   int alignment, bool hfill,
 358                                   bool start_minipage);
 359
 360         /* these things are for search and replace */
 361
 362         /** returns true if the specified string is at the specified
 363           position
 364           */
 365         bool IsStringInText(LyXParagraph * par,
 366                             LyXParagraph::size_type pos,
 367                             char const * str) const;
 368         /** sets the selection over the number of characters of string,
 369           no check!!
 370           */
 371         void SetSelectionOverString(char const * str);
 372
 373         /** simple replacing. The font of the first selected character
 374           is used
 375           */
 376         void ReplaceSelectionWithString(char const * str);
 377
 378         /** if the string can be found: return true and set the cursor to
 379           the new position */
 380         bool SearchForward(char const * str) const;
 381         bool SearchBackward(char const * str) const;
 382
 383         /// needed to insert the selection
 384         void InsertStringA(string const & str);
 385         /// needed to insert the selection
 386         void InsertStringB(string const & str);
 387
 388         /// usefull when texing from within LyX
 389         bool GotoNextError() const;
 390
 391         /// just another feature :)
 392         bool GotoNextNote() const;
 393
 394         /* for the greater insets */
 395
 396         /// returns 0 if inset wasn't found
 397         int UpdateInset(Inset * inset);
 398         ///
 399         void CheckParagraph(LyXParagraph * par,
 400                             LyXParagraph::size_type pos);
 401         ///
 402         int NumberOfCell(LyXParagraph * par,
 403                          LyXParagraph::size_type pos) const;
 404         /* table stuff -- begin*/
 405
 406         /** all table features of the text-class are put together in
 407           this function. Possible values of feature are defined in table.h
 408           */
 409         void TableFeatures(int feature, string const & val) const;
 410         ///
 411         void TableFeatures(int feature) const;
 412
 413         /** pos points at the beginning of the next cell (if there is one)
 414          */
 415         int WidthOfCell(LyXParagraph * par,
 416                         LyXParagraph::size_type & pos) const;
 417         ///
 418         void CheckParagraphInTable(LyXParagraph * par,
 419                                    LyXParagraph::size_type pos);
 420         ///
 421         void InsertCharInTable(char c);
 422         ///
 423         void BackspaceInTable();
 424         ///
 425         bool HitInTable(Row * row, int x) const;
 426         ///
 427         bool MouseHitInTable(int x, long y) const;
 428         /* table stuff -- end*/
 429         ///
 430         LyXParagraph * GetParFromID(int id);
 431
 432         // undo functions
 433         /// returns false if no undo possible
 434         bool TextUndo();
 435         /// returns false if no redo possible
 436         bool TextRedo();
 437         /// used by TextUndo/TextRedo
 438         bool TextHandleUndo(Undo * undo);
 439         /// makes sure the next operation will be stored
 440         void FinishUndo();
 441         /// this is dangerous and for internal use only
 442         void FreezeUndo();
 443         /// this is dangerous and for internal use only
 444         void UnFreezeUndo();
 445         /// the flag used by FinishUndo();
 446         mutable bool undo_finished;
 447         /// a flag
 448         bool undo_frozen;
 449         ///
 450         void SetUndo(Undo::undo_kind kind,
 451                      LyXParagraph const * before,
 452                      LyXParagraph const * end) const;
 453         ///
 454         void SetRedo(Undo::undo_kind kind,
 455                      LyXParagraph const * before,
 456                      LyXParagraph const * end);
 457         ///
 458         Undo * CreateUndo(Undo::undo_kind kind,
 459                           LyXParagraph const * before,
 460                           LyXParagraph const * end) const;
 461         /// for external use in lyx_cb.C
 462         void SetCursorParUndo();
 463         ///
 464         void CursorLeftIntern() const;
 465         ///
 466         void CursorRightIntern() const;
 467         ///
 468         void RemoveTableRow(LyXCursor * cursor) const;
 469         ///
 470         bool IsEmptyTableCell() const;
 471         ///
 472         void toggleAppendix();
 473         ///
 474         unsigned short paperWidth() const { return paperwidth; }
 475 private:
 476         ///
 477         BufferView * owner_;
 478
 479         /// width of the paper
 480         unsigned short  paperwidth;
 481
 482         ///
 483         mutable Row * firstrow;
 484         ///
 485         mutable Row * lastrow;
 486
 487         /** Copybuffer for copy environment type
 488           Asger has learned that this should be a buffer-property instead
 489           Lgb has learned that 'char' is a lousy type for non-characters
 490           */
 491         LyXTextClass::size_type copylayouttype;
 492
 493         /// the currentrow is needed to access rows faster*/
 494         mutable Row * currentrow; // pointer to the current row
 495         /// position in the text
 496         mutable long currentrow_y;
 497
 498         /** inserts a new row behind the specified row, increments
 499          * the touched counters */
 500         void InsertRow(Row * row, LyXParagraph * par,
 501                        LyXParagraph::size_type pos) const;
 502         /** removes the row and reset the touched counters */
 503         void RemoveRow(Row * row) const;
 504
 505         /** remove all following rows of the paragraph of the specified row. */
 506         void RemoveParagraph(Row * row) const;
 507
 508         /** insert the specified paragraph behind the specified row */
 509         void InsertParagraph(LyXParagraph * par, Row * row) const;
 510
 511         /** appends  the implizit specified paragraph behind the specified row,
 512          * start at the implizit given position */
 513         void AppendParagraph(Row * row) const;
 514
 515         ///
 516         void BreakAgain(Row * row) const;
 517         ///
 518         void BreakAgainOneRow(Row * row);
 519         /// Calculate and set the height of the row
 520         void SetHeightOfRow(Row * row_ptr) const;
 521
 522         /** this calculates the specified parameters. needed when setting
 523          * the cursor and when creating a visible row */
 524         void PrepareToPrint(Row * row, float & x,
 525                             float & fill_separator,
 526                             float & fill_hfill,
 527                             float & fill_label_hfill,
 528                             bool bidi = true) const;
 529         ///
 530         void DeleteEmptyParagraphMechanism(LyXCursor const & old_cursor) const;
 531
 532         /** Updates all counters starting BEHIND the row. Changed paragraphs
 533          * with a dynamic left margin will be rebroken. */
 534         void UpdateCounters(Row * row) const;
 535         ///
 536         void SetCounter(LyXParagraph * par) const;
 537
 538         /*
 539          * some low level functions
 540          */
 541
 542         ///
 543         int SingleWidth(LyXParagraph * par,
 544                         LyXParagraph::size_type pos) const;
 545         ///
 546         int SingleWidth(LyXParagraph * par,
 547                         LyXParagraph::size_type pos, char c) const;
 548         ///
 549         void draw(Row const * row,
 550                   LyXParagraph::size_type & pos,
 551                   int offset, float & x);
 552
 553         /// get the next breakpoint in a given paragraph
 554         LyXParagraph::size_type NextBreakPoint(Row const * row,
 555                                                int width) const;
 556         /// returns the minimum space a row needs on the screen in pixel
 557         int Fill(Row const * row, int paperwidth) const;
 558
 559         /** returns the minimum space a manual label needs on the
 560           screen in pixel */
 561         int LabelFill(Row const * row) const;
 562
 563         ///
 564         LyXParagraph::size_type BeginningOfMainBody(LyXParagraph * par) const;
 565
 566         /** Returns the left beginning of the text.
 567           This information cannot be taken from the layouts-objekt, because
 568           in LaTeX the beginning of the text fits in some cases
 569           (for example sections) exactly the label-width.
 570           */
 571         int LeftMargin(Row const * row) const;
 572         ///
 573         int RightMargin(Row const * row) const;
 574         ///
 575         int LabelEnd (Row const * row) const;
 576
 577         /** returns the number of separators in the specified row.
 578           The separator on the very last column doesnt count
 579           */
 580         int NumberOfSeparators(Row const * row) const;
 581
 582         /** returns the number of hfills in the specified row. The
 583           LyX-Hfill is a LaTeX \hfill so that the hfills at the
 584           beginning and at the end were ignored. This is {\em MUCH}
 585           more usefull than not to ignore!
 586           */
 587         int NumberOfHfills(Row const * row) const;
 588
 589         /// like NumberOfHfills, but only those in the manual label!
 590         int NumberOfLabelHfills(Row const * row) const;
 591
 592         /** returns true, if a expansion is needed. Rules are given by
 593           LaTeX
 594           */
 595         bool HfillExpansion(Row const * row_ptr,
 596                             LyXParagraph::size_type pos) const;
 597
 598         ///
 599         mutable std::vector<LyXParagraph::size_type> log2vis_list;
 600
 601         ///
 602         mutable std::vector<LyXParagraph::size_type> vis2log_list;
 603
 604         ///
 605         mutable std::vector<LyXParagraph::size_type> bidi_levels;
 606
 607         ///
 608         mutable LyXParagraph::size_type bidi_start;
 609
 610         ///
 611         mutable bool bidi_same_direction;
 612
 613         ///
 614         void ComputeBidiTables(Row *row) const;
 615
 616         /// Maps positions in the visual string to positions in logical string.
 617         inline
 618         LyXParagraph::size_type log2vis(LyXParagraph::size_type pos) const {
 619                 if (bidi_start == -1)
 620                         return pos;
 621                 else
 622                         return log2vis_list[pos-bidi_start];
 623         }
 624
 625         /// Maps positions in the logical string to positions in visual string.
 626         inline
 627         LyXParagraph::size_type vis2log(LyXParagraph::size_type pos) const {
 628                 if (bidi_start == -1)
 629                         return pos;
 630                 else
 631                         return vis2log_list[pos-bidi_start];
 632         }
 633
 634         inline
 635         int bidi_level(LyXParagraph::size_type pos) const {
 636                 if (bidi_start == -1)
 637                         return 0;
 638                 else
 639                         return bidi_levels[pos-bidi_start];
 640         }
 641
 642         ///
 643         unsigned char TransformChar(unsigned char c, Letter_Form form) const;
 644
 645         ///
 646         unsigned char TransformChar(unsigned char c, LyXParagraph * par,
 647                                 LyXParagraph::size_type pos) const;
 648
 649         /** returns the paragraph position of the last character in the
 650           specified row
 651           */
 652         LyXParagraph::size_type RowLast(Row const * row) const;
 653         ///
 654         LyXParagraph::size_type RowLastPrintable(Row const * row) const;
 655
 656         ///
 657         void charInserted();
 658 };
 659
 660 #endif