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