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 "dimension.h"
  21 #include "lyxfont.h"
  22 #include "layout.h"
  23 #include "lyxlayout_ptr_fwd.h"
  24 #include "ParagraphList_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 InsetBase_code;
  35 class FuncRequest;
  36 class FuncStatus;
  37 class LColor_color;
  38 class LCursor;
  39 class LyXTextClass;
  40 class MetricsInfo;
  41 class PainterInfo;
  42 class Row;
  43 class RowMetrics;
  44 class Spacing;
  45
  46
  47 /// This class encapsulates the main text data and operations in LyX
  48 class LyXText {
  49 public:
  50         ///
  51         typedef lyx::pos_type pos_type;
  52         ///
  53         typedef lyx::pit_type pit_type;
  54
  55         /// constructor
  56         explicit LyXText(BufferView *);
  57         ///
  58         void init(BufferView *);
  59
  60         ///
  61         LyXFont getFont(Paragraph const & par, pos_type pos) const;
  62         ///
  63         void applyOuterFont(LyXFont &) const;
  64         ///
  65         LyXFont getLayoutFont(pit_type pit) const;
  66         ///
  67         LyXFont getLabelFont(Paragraph const & par) const;
  68         ///
  69         void setCharFont(pit_type pit, pos_type pos, LyXFont const & font);
  70         ///
  71         void setCharFont(pit_type pit, pos_type pos, LyXFont const & font,
  72                 bool toggleall);
  73
  74         /// what you expect when pressing <enter> at cursor position
  75         void breakParagraph(LCursor & cur, bool keep_layout = false);
  76
  77         /// set layout over selection
  78         void setLayout(pit_type start, pit_type end,
  79                 std::string const & layout);
  80         ///
  81         void setLayout(LCursor & cur, std::string const & layout);
  82
  83         /// what type of depth change to make
  84         enum DEPTH_CHANGE {
  85                 INC_DEPTH,
  86                 DEC_DEPTH
  87         };
  88         /// Increase or decrease the nesting depth of the selected paragraph(s)
  89         void changeDepth(LCursor & cur, DEPTH_CHANGE type);
  90
  91         /// Returns whether something would be changed by changeDepth
  92         bool changeDepthAllowed(LCursor & cur, DEPTH_CHANGE type) const;
  93
  94         /// Set font over selection paragraphs and rebreak.
  95         void setFont(LCursor & cur, LyXFont const &, bool toggleall = false);
  96
  97         /// rebreaks the given par
  98         bool redoParagraph(pit_type pit);
  99
 100         /// returns pos in given par at given x coord
 101         pos_type x2pos(pit_type pit, int row, int x) const;
 102         int pos2x(pit_type pit, pos_type pos) const;
 103
 104         ///
 105         void toggleFree(LCursor & cur, LyXFont const &, bool toggleall = false);
 106
 107         ///
 108         std::string getStringToIndex(LCursor const & cur);
 109
 110         /// insert a character at cursor position
 111         void insertChar(LCursor & cur, char c);
 112         /// insert an inset at cursor position
 113         void insertInset(LCursor & cur, InsetBase * inset);
 114
 115         /// compute text metrics
 116         void metrics(MetricsInfo & mi, Dimension & dim);
 117         /// draw text (only used for insets)
 118         void draw(PainterInfo & pi, int x, int y) const;
 119         /// draw textselection
 120         void drawSelection(PainterInfo & pi, int x, int y) const;
 121
 122         /// try to handle that request
 123         void dispatch(LCursor & cur, FuncRequest & cmd);
 124         /// do we want to handle this event?
 125         bool getStatus(LCursor & cur, FuncRequest const & cmd,
 126                 FuncStatus & status) const;
 127
 128         /// access to out BufferView. This should go...
 129         BufferView * bv() const;
 130
 131         /// read-only access to individual paragraph
 132         Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
 133         /// read-write access to individual paragraph
 134         Paragraph & getPar(pit_type pit) { return pars_[pit]; }
 135         // Returns the current font and depth as a message.
 136         std::string currentState(LCursor & cur);
 137
 138         /** returns row near the specified
 139           * y-coordinate in given paragraph (relative to the screen).
 140           */
 141         Row const & getRowNearY(int y, pit_type pit) const;
 142         pit_type getPitNearY(int y) const;
 143
 144         /** returns the column near the specified x-coordinate of the row
 145          x is set to the real beginning of this column
 146          */
 147         pos_type getColumnNearX(pit_type pit,
 148                 Row const & row, int & x, bool & boundary) const;
 149
 150         /** Find the word under \c from in the relative location
 151          *  defined by \c word_location.
 152          *  @param from return here the start of the word
 153          *  @param to return here the end of the word
 154          */
 155         void getWord(CursorSlice & from, CursorSlice & to, lyx::word_location const);
 156         /// just selects the word the cursor is in
 157         void selectWord(LCursor & cur, lyx::word_location loc);
 158
 159         /// accept selected change
 160         void acceptChange(LCursor & cur);
 161         /// reject selected change
 162         void rejectChange(LCursor & cur);
 163
 164         /// returns true if par was empty and was removed
 165         bool setCursor(LCursor & cur, pit_type par, pos_type pos,
 166                        bool setfont = true, bool boundary = false);
 167         ///
 168         void setCursor(CursorSlice &, pit_type par, pos_type pos);
 169         ///
 170         void setCursorIntern(LCursor & cur, pit_type par,
 171                  pos_type pos, bool setfont = true, bool boundary = false);
 172         ///
 173         void setCurrentFont(LCursor & cur);
 174
 175         ///
 176         void recUndo(pit_type first, pit_type last) const;
 177         ///
 178         void recUndo(pit_type first) const;
 179         /// returns true if par was empty and was removed
 180         bool setCursorFromCoordinates(LCursor & cur, int x, int y);
 181         ///
 182         InsetBase * editXY(LCursor & cur, int x, int y);
 183         /// Move cursor one line up.
 184         /**
 185          * Returns true if an update is needed after the move.
 186          */
 187         bool cursorUp(LCursor & cur);
 188         /// Move cursor one line down.
 189         /**
 190          * Returns true if an update is needed after the move.
 191          */
 192         bool cursorDown(LCursor & cur);
 193         /// Move cursor one position left
 194         /**
 195          * Returns true if an update is needed after the move.
 196          */
 197         bool cursorLeft(LCursor & cur);
 198         /// Move cursor one position right
 199         /**
 200          * Returns true if an update is needed after the move.
 201          */
 202         bool cursorRight(LCursor & cur);
 203         ///
 204         bool cursorLeftOneWord(LCursor & cur);
 205         ///
 206         bool cursorRightOneWord(LCursor & cur);
 207         ///
 208         bool cursorUpParagraph(LCursor & cur);
 209         ///
 210         bool cursorDownParagraph(LCursor & cur);
 211         ///
 212         bool cursorHome(LCursor & cur);
 213         ///
 214         bool cursorEnd(LCursor & cur);
 215         ///
 216         bool cursorPrevious(LCursor & cur);
 217         ///
 218         bool cursorNext(LCursor & cur);
 219         ///
 220         bool cursorTop(LCursor & cur);
 221         ///
 222         bool cursorBottom(LCursor & cur);
 223         /// Delete character at cursor. Honour change tracking
 224         bool Delete(LCursor & cur);
 225         /** At cursor position 0, merge paragraph with the one before it.
 226          * Ignore CT (this is used in \c acceptChange, \c rejectChange for
 227          * physical deletion of paragraph break)
 228          */
 229         bool backspacePos0(LCursor & cur);
 230         /// Delete character before cursor. Honour CT
 231         bool backspace(LCursor & cur);
 232         ///
 233         bool selectWordWhenUnderCursor(LCursor & cur, lyx::word_location);
 234         ///
 235         enum TextCase {
 236                 ///
 237                 text_lowercase = 0,
 238                 ///
 239                 text_capitalization = 1,
 240                 ///
 241                 text_uppercase = 2
 242         };
 243         /// Change the case of the word at cursor position.
 244         void changeCase(LCursor & cur, TextCase action);
 245
 246         /** the DTP switches for paragraphs. LyX will store the top settings
 247          always in the first physical paragraph, the bottom settings in the
 248          last. When a paragraph is broken, the top settings rest, the bottom
 249          settings are given to the new one.
 250          */
 251         void setParagraph(LCursor & cur,
 252                           Spacing const & spacing,
 253                           LyXAlignment align,
 254                           std::string const & labelwidthstring,
 255                           bool noindent);
 256
 257         /* these things are for search and replace */
 258
 259         /// needed to insert the selection
 260         void insertStringAsLines(LCursor & cur, std::string const & str);
 261         /// needed to insert the selection
 262         void insertStringAsParagraphs(LCursor & cur, std::string const & str);
 263
 264         /// current text width
 265         int width() const;
 266
 267         /// current text heigth
 268         int height() const;
 269
 270         /// Returns an inset if inset was hit, or 0 if not.
 271         InsetBase * checkInsetHit(int x, int y) const;
 272
 273         ///
 274         int singleWidth(Paragraph const & par, pos_type pos) const;
 275         ///
 276         int singleWidth(Paragraph const & par,
 277                 pos_type pos, char c, LyXFont const & Font) const;
 278
 279         /// return the color of the canvas
 280         LColor_color backgroundColor() const;
 281
 282         /**
 283          * Returns the left beginning of the text.
 284          * This information cannot be taken from the layout object, because
 285          * in LaTeX the beginning of the text fits in some cases
 286          * (for example sections) exactly the label-width.
 287          */
 288         int leftMargin(pit_type pit, pos_type pos) const;
 289         int leftMargin(pit_type pit) const;
 290         ///
 291         int rightMargin(Paragraph const & par) const;
 292
 293         /** this calculates the specified parameters. needed when setting
 294          * the cursor and when creating a visible row */
 295         RowMetrics computeRowMetrics(pit_type pit, Row const & row) const;
 296
 297         /// access to our paragraphs
 298         ParagraphList const & paragraphs() const { return pars_; }
 299         ParagraphList & paragraphs() { return pars_; }
 300         /// return true if this is the main text
 301         bool isMainText() const;
 302
 303         /// return first row of text
 304         Row const & firstRow() const;
 305
 306         /// is this row the last in the text?
 307         bool isLastRow(pit_type pit, Row const & row) const;
 308         /// is this row the first in the text?
 309         bool isFirstRow(pit_type pit, Row const & row) const;
 310
 311         ///
 312         double spacing(Paragraph const & par) const;
 313         /// make a suggestion for a label
 314         std::string getPossibleLabel(LCursor & cur) const;
 315         /// is this paragraph right-to-left?
 316         bool isRTL(Paragraph const & par) const;
 317         ///
 318         bool checkAndActivateInset(LCursor & cur, bool front);
 319
 320         ///
 321         void write(Buffer const & buf, std::ostream & os) const;
 322         /// returns whether we've seen our usual 'end' marker
 323         bool read(Buffer const & buf, LyXLex & lex);
 324
 325         ///
 326         int ascent() const;
 327         ///
 328         int descent() const;
 329         ///
 330         int cursorX(CursorSlice const & cursor, bool boundary) const;
 331         ///
 332         int cursorY(CursorSlice const & cursor, bool boundary) const;
 333
 334         /// delete double space or empty paragraphs around old cursor
 335         bool deleteEmptyParagraphMechanism(LCursor & cur, LCursor & old);
 336
 337         ///
 338         friend class LyXScreen;
 339
 340 public:
 341         ///
 342         Dimension dim_;
 343         ///
 344         int maxwidth_;
 345         /// the current font settings
 346         LyXFont current_font;
 347         /// the current font
 348         LyXFont real_current_font;
 349         ///
 350         int background_color_;
 351
 352         /// only the top-level LyXText has this non-zero
 353         BufferView * bv_owner;
 354
 355         ///
 356         mutable Bidi bidi;
 357         ///
 358         ParagraphList pars_;
 359
 360         /// our 'outermost' font. This is handed down from the surrounding
 361         // inset through the pi/mi parameter (pi.base.font)
 362         LyXFont font_;
 363
 364         ///
 365         bool autoBreakRows_;
 366 private:
 367         /// return past-the-last paragraph influenced by a layout
 368         /// change on pit
 369         pit_type undoSpan(pit_type pit);
 370
 371         /// Calculate and set the height of the row
 372         void setHeightOfRow(pit_type, Row & row);
 373
 374         // fix the cursor `cur' after a characters has been deleted at `where'
 375         // position. Called by deleteEmptyParagraphMechanism
 376         void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
 377
 378         ///
 379         void deleteWordForward(LCursor & cur);
 380         ///
 381         void deleteWordBackward(LCursor & cur);
 382         ///
 383         void deleteLineForward(LCursor & cur);
 384
 385         /// sets row.end to the pos value *after* which a row should break.
 386         /// for example, the pos after which isNewLine(pos) == true
 387         void rowBreakPoint(pit_type pit, Row & row) const;
 388         /// sets row.width to the minimum space a row needs on the screen in pixel
 389         void setRowWidth(pit_type pit, Row & row) const;
 390         /// the minimum space a manual label needs on the screen in pixels
 391         int labelFill(Paragraph const & par, Row const & row) const;
 392         /// FIXME
 393         int labelEnd(pit_type pit) const;
 394
 395         ///
 396         void charInserted();
 397         /// set 'number' font property
 398         void number(LCursor & cur);
 399 };
 400
 401 /// return the default height of a row in pixels, considering font zoom
 402 int defaultRowHeight();
 403
 404 #endif // LYXTEXT_H