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
 125         /// try to handle that request
 126         DispatchResult dispatch(LCursor & cur, FuncRequest const & cmd);
 127         /// access to out BufferView. This should go...
 128         BufferView * bv();
 129         /// access to out BufferView. This should go...
 130         BufferView * bv() const;
 131
 132         /// returns an iterator pointing to a cursor paragraph
 133         ParagraphList::iterator getPar(CursorSlice const & cursor) const;
 134         ///
 135         ParagraphList::iterator getPar(lyx::paroffset_type par) const;
 136         ///
 137         int parOffset(ParagraphList::iterator pit) const;
 138         /// convenience
 139         ParagraphList::iterator cursorPar() const;
 140         ///
 141         RowList::iterator cursorRow() const;
 142
 143         /** returns an iterator pointing to the row near the specified
 144           * y-coordinate (relative to the whole text). y is set to the
 145           * real beginning of this row
 146           */
 147         RowList::iterator getRowNearY(int y,
 148                 ParagraphList::iterator & pit) const;
 149
 150         /** returns the column near the specified x-coordinate of the row
 151          x is set to the real beginning of this column
 152          */
 153         lyx::pos_type getColumnNearX(ParagraphList::iterator pit,
 154                 Row const & row, int & x, bool & boundary) const;
 155
 156         /** Find the word under \c from in the relative location
 157          *  defined by \c word_location.
 158          *  @param from return here the start of the word
 159          *  @param to return here the end of the word
 160          */
 161         void getWord(CursorSlice & from, CursorSlice & to, lyx::word_location const);
 162         /// just selects the word the cursor is in
 163         void selectWord(lyx::word_location loc);
 164
 165         /// accept selected change
 166         void acceptChange();
 167         /// reject selected change
 168         void rejectChange();
 169
 170         ///
 171         void setCursor(ParagraphList::iterator pit, lyx::pos_type pos);
 172         /// returns true if par was empty and was removed
 173         bool setCursor(lyx::paroffset_type par, lyx::pos_type pos,
 174                        bool setfont = true, bool boundary = false);
 175         ///
 176         void setCursor(CursorSlice &, lyx::paroffset_type par,
 177                        lyx::pos_type pos, bool boundary = false);
 178         ///
 179         void setCursorIntern(lyx::paroffset_type par, lyx::pos_type pos,
 180                              bool setfont = true, bool boundary = false);
 181         ///
 182         void setCurrentFont();
 183
 184         ///
 185         void recUndo(lyx::paroffset_type first, lyx::paroffset_type last) const;
 186         ///
 187         void recUndo(lyx::paroffset_type first) const;
 188         ///
 189         void setCursorFromCoordinates(int x, int y);
 190         ///
 191         void setCursorFromCoordinates(CursorSlice &, int x, int y);
 192         ///
 193         void edit(LCursor & cur, int x, int y);
 194         ///
 195         void cursorUp(bool selecting = false);
 196         ///
 197         void cursorDown(bool selecting = false);
 198         ///
 199         bool cursorLeft(bool internal = true);
 200         ///
 201         bool cursorRight(bool internal = true);
 202         ///
 203         void cursorLeftOneWord();
 204         ///
 205         void cursorRightOneWord();
 206         ///
 207         void cursorUpParagraph();
 208         ///
 209         void cursorDownParagraph();
 210         ///
 211         void cursorHome();
 212         ///
 213         void cursorEnd();
 214         ///
 215         void cursorPrevious();
 216         ///
 217         void cursorNext();
 218         ///
 219         void cursorTop();
 220         ///
 221         void cursorBottom();
 222         ///
 223         void Delete();
 224         ///
 225         void backspace();
 226         ///
 227         bool selectWordWhenUnderCursor(lyx::word_location);
 228         ///
 229         enum TextCase {
 230                 ///
 231                 text_lowercase = 0,
 232                 ///
 233                 text_capitalization = 1,
 234                 ///
 235                 text_uppercase = 2
 236         };
 237         /// Change the case of the word at cursor position.
 238         void changeCase(TextCase action);
 239
 240         /// returns success
 241         bool toggleInset();
 242         ///
 243         void cutSelection(bool doclear = true, bool realcut = true);
 244         ///
 245         void copySelection();
 246         ///
 247         void pasteSelection(size_t sel_index = 0);
 248
 249         /** the DTP switches for paragraphs. LyX will store the top settings
 250          always in the first physical paragraph, the bottom settings in the
 251          last. When a paragraph is broken, the top settings rest, the bottom
 252          settings are given to the new one.
 253          */
 254         void setParagraph(
 255                           Spacing const & spacing,
 256                           LyXAlignment align,
 257                           std::string const & labelwidthstring,
 258                           bool noindent);
 259
 260         /* these things are for search and replace */
 261
 262         /**
 263          * Sets the selection from the current cursor position to length
 264          * characters to the right. No safety checks.
 265          */
 266         void setSelectionRange(lyx::pos_type length);
 267         /** simple replacing. The font of the first selected character
 268           is used
 269           */
 270         void replaceSelectionWithString(std::string const & str);
 271
 272         /// needed to insert the selection
 273         void insertStringAsLines(std::string const & str);
 274         /// needed to insert the selection
 275         void insertStringAsParagraphs(std::string const & str);
 276
 277         /// Find next inset of some specified type.
 278         bool gotoNextInset(std::vector<InsetOld_code> const & codes,
 279                            std::string const & contents = std::string());
 280         ///
 281         void gotoInset(std::vector<InsetOld_code> const & codes,
 282                        bool same_content);
 283         ///
 284         void gotoInset(InsetOld_code code, bool same_content);
 285
 286         /// current max text width
 287         int textWidth() const;
 288
 289         /// updates all counters
 290         void updateCounters();
 291         /// Returns an inset if inset was hit, or 0 if not.
 292         InsetBase * checkInsetHit(int x, int y);
 293
 294         ///
 295         int singleWidth(ParagraphList::iterator pit, lyx::pos_type pos) const;
 296         ///
 297         int singleWidth(ParagraphList::iterator pit,
 298                 lyx::pos_type pos, char c, LyXFont const & Font) const;
 299
 300         /// return the color of the canvas
 301         LColor_color backgroundColor() const;
 302
 303         /**
 304          * Returns the left beginning of the text.
 305          * This information cannot be taken from the layout object, because
 306          * in LaTeX the beginning of the text fits in some cases
 307          * (for example sections) exactly the label-width.
 308          */
 309         int leftMargin(ParagraphList::iterator pit, lyx::pos_type pos) const;
 310         int leftMargin(ParagraphList::iterator pit) const;
 311         ///
 312         int rightMargin(Paragraph const & par) const;
 313
 314         /** this calculates the specified parameters. needed when setting
 315          * the cursor and when creating a visible row */
 316         void prepareToPrint(ParagraphList::iterator pit, Row & row) const;
 317
 318         /// access to our paragraphs
 319         ParagraphList & paragraphs() const;
 320         /// return true if this is owned by an inset.
 321         bool isInInset() const;
 322
 323         /// return first row of text
 324         RowList::iterator firstRow() const;
 325         /// return last row of text
 326         RowList::iterator lastRow() const;
 327         /// return row "behind" last row of text
 328         RowList::iterator endRow() const;
 329         /// return next row crossing paragraph boundaries
 330         void nextRow(ParagraphList::iterator & pit,
 331                 RowList::iterator & rit) const;
 332         /// return previous row crossing paragraph boundaries
 333         void previousRow(ParagraphList::iterator & pit,
 334                 RowList::iterator & rit) const;
 335
 336         /// is this row the last in the text?
 337         bool isLastRow(ParagraphList::iterator pit, Row const & row) const;
 338         /// is this row the first in the text?
 339         bool isFirstRow(ParagraphList::iterator pit, Row const & row) const;
 340
 341         ///
 342         std::string selectionAsString(Buffer const & buffer, bool label) const;
 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