src/Text.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Text.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 TEXT_H
  15 #define TEXT_H
  16
  17 #include "Bidi.h"
  18 #include "DispatchResult.h"
  19 #include "Font.h"
  20 #include "Layout.h"
  21 #include "lyxlayout_ptr_fwd.h"
  22 #include "ParagraphList.h"
  23
  24 #include <iosfwd>
  25
  26
  27 namespace lyx {
  28
  29 class Buffer;
  30 class BufferParams;
  31 class BufferView;
  32 class CursorSlice;
  33 class DocIterator;
  34 class ErrorList;
  35 class FuncRequest;
  36 class FuncStatus;
  37 class Inset;
  38 class Color_color;
  39 class Cursor;
  40 class PainterInfo;
  41 class Row;
  42 class Spacing;
  43
  44
  45 /// This class encapsulates the main text data and operations in LyX
  46 class Text {
  47 public:
  48         /// constructor
  49         explicit Text();
  50
  51         /// \return true if there's no content at all.
  52         /// \warning a non standard layout on an empty paragraph doesn't
  53         // count as empty.
  54         bool empty() const;
  55
  56         ///
  57         Font getFont(Buffer const & buffer, Paragraph const & par,
  58                 pos_type pos) const;
  59         ///
  60         void applyOuterFont(Buffer const & buffer, Font &) const;
  61         ///
  62         Font getLayoutFont(Buffer const & buffer, pit_type pit) const;
  63         ///
  64         Font getLabelFont(Buffer const & buffer,
  65                 Paragraph const & par) const;
  66         /** Set font of character at position \p pos in paragraph \p pit.
  67          *  Must not be called if \p pos denotes an inset with text contents,
  68          *  and the inset is not allowed inside a font change (see below).
  69          */
  70         void setCharFont(Buffer const & buffer, pit_type pit, pos_type pos,
  71                 Font const & font);
  72
  73         /** Needed to propagate font changes to all text cells of insets
  74          *  that are not allowed inside a font change (bug 1973).
  75          *  Must not be called if \p pos denotes an ordinary character or an
  76          *  inset that is alowed inside a font change.
  77          *  FIXME: This should be removed, see documentation of noFontChange
  78          *  in insetbase.h
  79          */
  80         void setInsetFont(Buffer const & buffer, pit_type pit, pos_type pos,
  81                 Font const & font, bool toggleall = false);
  82
  83         /// what you expect when pressing \<enter\> at cursor position
  84         void breakParagraph(Cursor & cur, bool keep_layout = false);
  85
  86         /// set layout over selection
  87         void setLayout(Buffer const & buffer, pit_type start, pit_type end,
  88                 docstring const & layout);
  89         /// Set given layout to current cursor position.
  90         /// FIXME: replace Cursor with DocIterator.
  91         void setLayout(Cursor & cur, docstring const & layout);
  92
  93         /// what type of depth change to make
  94         enum DEPTH_CHANGE {
  95                 INC_DEPTH,
  96                 DEC_DEPTH
  97         };
  98         /// Increase or decrease the nesting depth of the selected paragraph(s)
  99         /// FIXME: replace Cursor with DocIterator.
 100         void changeDepth(Cursor & cur, DEPTH_CHANGE type);
 101
 102         /// Returns whether something would be changed by changeDepth
 103         /// FIXME: replace Cursor with DocIterator.
 104         bool changeDepthAllowed(Cursor & cur, DEPTH_CHANGE type) const;
 105
 106         /// Set font over selection paragraphs and rebreak.
 107         /// FIXME: replace Cursor with DocIterator.
 108         void setFont(Cursor & cur, Font const &, bool toggleall = false);
 109         /// Set font from \p begin to \p end and rebreak.
 110         void setFont(Buffer const & buffer, CursorSlice const & begin,
 111                 CursorSlice const & end, Font const &,
 112                 bool toggleall = false);
 113
 114         ///
 115         void toggleFree(Cursor & cur, Font const &, bool toggleall = false);
 116
 117         /// ???
 118         /// FIXME: replace Cursor with DocIterator.
 119         docstring getStringToIndex(Cursor const & cur);
 120
 121         /// insert a character at cursor position
 122         /// FIXME: replace Cursor with DocIterator.
 123         void insertChar(Cursor & cur, char_type c);
 124         /// insert an inset at cursor position
 125         /// FIXME: replace Cursor with DocIterator.
 126         void insertInset(Cursor & cur, Inset * inset);
 127
 128         /// try to handle that request
 129         /// FIXME: replace Cursor with DocIterator.
 130         void dispatch(Cursor & cur, FuncRequest & cmd);
 131         /// do we want to handle this event?
 132         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 133                 FuncStatus & status) const;
 134
 135         /// read-only access to individual paragraph
 136         Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
 137         /// read-write access to individual paragraph
 138         Paragraph & getPar(pit_type pit) { return pars_[pit]; }
 139         // Returns the current font and depth as a message.
 140         /// FIXME: replace Cursor with DocIterator.
 141         docstring currentState(Cursor & cur);
 142
 143         /** Find the word under \c from in the relative location
 144          *  defined by \c word_location.
 145          *  @param from return here the start of the word
 146          *  @param to return here the end of the word
 147          */
 148         void getWord(CursorSlice & from, CursorSlice & to, word_location const);
 149         /// just selects the word the cursor is in
 150         void selectWord(Cursor & cur, word_location loc);
 151
 152         /// what type of change operation to make
 153         enum ChangeOp {
 154                 ACCEPT,
 155                 REJECT
 156         };
 157         /// accept or reject the selected change
 158         void acceptOrRejectChanges(Cursor & cur, ChangeOp op);
 159         /// accept the changes within the complete Text
 160         void acceptChanges(BufferParams const & bparams);
 161         /// reject the changes within the complete Text
 162         void rejectChanges(BufferParams const & bparams);
 163
 164         /// returns true if par was empty and was removed
 165         bool setCursor(Cursor & 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(Cursor & cur, pit_type par,
 171                  pos_type pos, bool setfont = true, bool boundary = false);
 172         ///
 173         void setCurrentFont(Cursor & cur);
 174
 175         ///
 176         void recUndo(Cursor & cur, pit_type first, pit_type last) const;
 177         ///
 178         void recUndo(Cursor & cur, pit_type first) const;
 179
 180         /// Move cursor one position left
 181         /**
 182          * Returns true if an update is needed after the move.
 183          */
 184         bool cursorLeft(Cursor & cur);
 185         /// Move cursor one position right
 186         /**
 187          * Returns true if an update is needed after the move.
 188          */
 189         bool cursorRight(Cursor & cur);
 190         ///
 191         bool cursorLeftOneWord(Cursor & cur);
 192         ///
 193         bool cursorRightOneWord(Cursor & cur);
 194         ///
 195         bool cursorUpParagraph(Cursor & cur);
 196         ///
 197         bool cursorDownParagraph(Cursor & cur);
 198         ///
 199         /// FIXME: move to TextMetrics.
 200         bool cursorHome(Cursor & cur);
 201         ///
 202         /// FIXME: move to TextMetrics.
 203         bool cursorEnd(Cursor & cur);
 204         ///
 205         bool cursorTop(Cursor & cur);
 206         ///
 207         bool cursorBottom(Cursor & cur);
 208         /// Erase character at cursor. Honour change tracking
 209         /// FIXME: replace Cursor with DocIterator.
 210         bool erase(Cursor & cur);
 211         /// Delete character before cursor. Honour CT
 212         /// FIXME: replace Cursor with DocIterator.
 213         bool backspace(Cursor & cur);
 214         // Dissolve the inset under cursor
 215         /// FIXME: replace Cursor with DocIterator.
 216         bool dissolveInset(Cursor & cur);
 217         ///
 218         bool selectWordWhenUnderCursor(Cursor & cur, word_location);
 219         ///
 220         enum TextCase {
 221                 ///
 222                 text_lowercase = 0,
 223                 ///
 224                 text_capitalization = 1,
 225                 ///
 226                 text_uppercase = 2
 227         };
 228         /// Change the case of the word at cursor position.
 229         void changeCase(Cursor & cur, TextCase action);
 230         /// Transposes the character at the cursor with the one before it
 231         void charsTranspose(Cursor & cur);
 232
 233         /** the DTP switches for paragraphs. LyX will store the top settings
 234          always in the first physical paragraph, the bottom settings in the
 235          last. When a paragraph is broken, the top settings rest, the bottom
 236          settings are given to the new one.
 237          This function will handle a multi-paragraph selection.
 238          */
 239         void setParagraphs(Cursor & cur, docstring arg, bool modify = false);
 240         /// Sets parameters for current or selected paragraphs
 241         void setParagraphs(Cursor & cur, ParagraphParameters const & p);
 242
 243         /* these things are for search and replace */
 244
 245         /// needed to insert the selection
 246         /// FIXME: replace Cursor with DocIterator.
 247         void insertStringAsLines(Cursor & cur, docstring const & str);
 248         /// needed to insert the selection
 249         /// FIXME: replace Cursor with DocIterator.
 250         void insertStringAsParagraphs(Cursor & cur, docstring const & str);
 251
 252         /// return the color of the canvas
 253         Color_color backgroundColor() const;
 254
 255         /// access to our paragraphs
 256         ParagraphList const & paragraphs() const { return pars_; }
 257         ParagraphList & paragraphs() { return pars_; }
 258         /// return true if this is the main text
 259         bool isMainText(Buffer const &) const;
 260
 261         /// is this row the last in the text?
 262         /// FIXME: move to TextMetrics.
 263         bool isLastRow(pit_type pit, Row const & row) const;
 264         /// is this row the first in the text?
 265         /// FIXME: move to TextMetrics.
 266         bool isFirstRow(pit_type pit, Row const & row) const;
 267
 268         ///
 269         double spacing(Buffer const & buffer, Paragraph const & par) const;
 270         /// make a suggestion for a label
 271         /// FIXME: replace Cursor with DocIterator.
 272         docstring getPossibleLabel(Cursor & cur) const;
 273         /// is this paragraph right-to-left?
 274         bool isRTL(Buffer const &, Paragraph const & par) const;
 275         /// is this position in the paragraph right-to-left?
 276         bool isRTL(Buffer const & buffer, CursorSlice const & sl, bool boundary) const;
 277         /// is between pos-1 and pos an RTL<->LTR boundary?
 278         bool isRTLBoundary(Buffer const & buffer, Paragraph const & par,
 279           pos_type pos) const;
 280         /// would be a RTL<->LTR boundary between pos and the given font?
 281         bool isRTLBoundary(Buffer const & buffer, Paragraph const & par,
 282           pos_type pos, Font const & font) const;
 283
 284         ///
 285         bool checkAndActivateInset(Cursor & cur, bool front);
 286
 287         ///
 288         void write(Buffer const & buf, std::ostream & os) const;
 289         /// returns whether we've seen our usual 'end' marker
 290         bool read(Buffer const & buf, Lexer & lex, ErrorList & errorList);
 291
 292         /// delete double spaces, leading spaces, and empty paragraphs around old cursor.
 293         /// \retval true if a change has happened and we need a redraw.
 294         /// FIXME: replace Cursor with DocIterator. This is not possible right
 295         /// now because recordUndo() is called which needs a Cursor.
 296         static bool deleteEmptyParagraphMechanism(Cursor & cur,
 297                 Cursor & old, bool & need_anchor_change);
 298
 299         /// delete double spaces, leading spaces, and empty paragraphs
 300         /// from \first to \last paragraph
 301         void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges);
 302
 303 public:
 304         /// the current font settings
 305         Font current_font;
 306         /// the current font
 307         Font real_current_font;
 308         ///
 309         int background_color_;
 310
 311         ///
 312         ParagraphList pars_;
 313
 314         /// our 'outermost' font. This is handed down from the surrounding
 315         // inset through the pi/mi parameter (pi.base.font)
 316         Font font_;
 317
 318         ///
 319         bool autoBreakRows_;
 320 private:
 321         /// return past-the-last paragraph influenced by a layout
 322         /// change on pit
 323         pit_type undoSpan(pit_type pit);
 324
 325         // fix the cursor `cur' after a characters has been deleted at `where'
 326         // position. Called by deleteEmptyParagraphMechanism
 327         static void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
 328
 329         // At cursor position 0, try to merge the paragraph with the one before it.
 330         // Ignore change tracking, i.e., physically remove the end-of-par character
 331         bool backspacePos0(Cursor & cur);
 332         /// handle the case where bibitems were deleted
 333         bool handleBibitems(Cursor & cur);
 334
 335         ///
 336         void deleteWordForward(Cursor & cur);
 337         ///
 338         void deleteWordBackward(Cursor & cur);
 339         ///
 340         void deleteLineForward(Cursor & cur);
 341         ///
 342         void charInserted();
 343         /// set 'number' font property
 344         void number(Cursor & cur);
 345
 346         /// paste plain text at current cursor.
 347         /// \param str string to paste
 348         /// \param asParagraphs whether to paste as paragraphs or as lines
 349         void pasteString(Cursor & cur, docstring const & str,
 350                         bool asParagraphs);
 351 };
 352
 353 } // namespace lyx
 354
 355 #endif // LYXTEXT_H