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