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 "DocIterator.h"
  18 #include "ParagraphList.h"
  19
  20 namespace lyx {
  21
  22 class Buffer;
  23 class BufferParams;
  24 class BufferView;
  25 class CompletionList;
  26 class Cursor;
  27 class CursorSlice;
  28 class DocIterator;
  29 class ErrorList;
  30 class Font;
  31 class FontInfo;
  32 class FuncRequest;
  33 class FuncStatus;
  34 class Inset;
  35 class Lexer;
  36 class PainterInfo;
  37 class Spacing;
  38
  39 /// This class encapsulates the main text data and operations in LyX.
  40 /// This is more or less the private implementation of InsetText.
  41 class Text {
  42 private:
  43         /// Default constructor.
  44         Text(InsetText * owner, bool use_default_layout);
  45
  46         /// Copy constructor.
  47         Text(InsetText * owner, Text const & text);
  48
  49 public:
  50         /// \return true if there's no content at all.
  51         /// \warning a non standard layout on an empty paragraph doesn't
  52         // count as empty.
  53         bool empty() const;
  54         /// Access to owner InsetText.
  55         InsetText const & inset() const;
  56
  57         ///
  58         FontInfo layoutFont(pit_type pit) const;
  59         ///
  60         FontInfo labelFont(Paragraph const & par) const;
  61         /** Set font of character at position \p pos in paragraph \p pit.
  62          *  Must not be called if \p pos denotes an inset with text contents,
  63          *  and the inset is not allowed inside a font change (see below).
  64          */
  65         void setCharFont(pit_type pit, pos_type pos,
  66                 Font const & font, Font const & display_font);
  67
  68         /** Needed to propagate font changes to all text cells of insets
  69          *  that are not allowed inside a font change (bugs 1973, 6919).
  70          *  Must not be called if \p pos denotes an ordinary character or an
  71          *  inset that is alowed inside a font change.
  72          */
  73         void setInsetFont(BufferView const & bv, pit_type pit, pos_type pos,
  74                 Font const & font, bool toggleall = false);
  75
  76         /// what you expect when pressing \<enter\> at cursor position
  77         /// \param inverse_logic if false, the same layout is set for the
  78         /// new paragraph if the layout is an environment; if true, the
  79         /// same layout is set if it is not an environment
  80         void breakParagraph(Cursor & cur, bool inverse_logic = false);
  81
  82         /// set layout over selection
  83         void setLayout(pit_type start, pit_type end,
  84                 docstring const & layout);
  85         /// Set given layout to current cursor position.
  86         /// FIXME: replace Cursor with DocIterator.
  87         void setLayout(Cursor & cur, docstring const & layout);
  88
  89         /// what type of depth change to make
  90         enum DEPTH_CHANGE {
  91                 INC_DEPTH,
  92                 DEC_DEPTH
  93         };
  94         /// Increase or decrease the nesting depth of the selected paragraph(s)
  95         /// FIXME: replace Cursor with DocIterator.
  96         void changeDepth(Cursor & cur, DEPTH_CHANGE type);
  97
  98         /// Returns whether something would be changed by changeDepth
  99         /// FIXME: replace Cursor with DocIterator.
 100         bool changeDepthAllowed(Cursor & cur, DEPTH_CHANGE type) const;
 101
 102         /// Set font over selection paragraphs and rebreak.
 103         /// FIXME: replace Cursor with DocIterator.
 104         void setFont(Cursor & cur, Font const &, bool toggleall = false);
 105         /// Set font from \p begin to \p end and rebreak.
 106         void setFont(BufferView const & bv, CursorSlice const & begin,
 107                 CursorSlice const & end, Font const &,
 108                 bool toggleall = false);
 109
 110         ///
 111         void toggleFree(Cursor & cur, Font const &, bool toggleall = false);
 112
 113         /// ???
 114         /// FIXME: replace Cursor with DocIterator.
 115         docstring getStringToIndex(Cursor const & cur);
 116
 117         /// Convert the paragraphs to a string.
 118         /// \param AsStringParameter options. This can contain any combination of
 119         /// asStringParameter values. Valid examples:
 120         ///             asString(AS_STR_LABEL)
 121         ///             asString(AS_STR_LABEL | AS_STR_INSETS)
 122         ///             asString(AS_STR_INSETS)
 123         docstring asString(int options = AS_STR_NONE) const;
 124         ///
 125         docstring asString(pit_type beg, pit_type end,
 126                 int options = AS_STR_NONE) const;
 127         /// Appends a possibly abbreviated representation of our text
 128         /// to \param os, where \param maxlen defines the maximum size
 129         /// of \param os. If \param shorten is true, then we will shorten
 130         /// \param os to maxlen chars and replace the final three by "...,
 131         /// if \param os is longer than maxlen chars.
 132         /// if \param maxlen is passed as 0, then it is ignored. (In fact,
 133         /// it is reset to the maximum value for size_t.)
 134         void forToc(docstring & os, size_t maxlen, bool shorten = true) const;
 135
 136         /// insert a character at cursor position
 137         /// FIXME: replace Cursor with DocIterator.
 138         void insertChar(Cursor & cur, char_type c);
 139         /// insert an inset at cursor position
 140         /// FIXME: replace Cursor with DocIterator.
 141         void insertInset(Cursor & cur, Inset * inset);
 142
 143         /// try to handle that request
 144         /// FIXME: replace Cursor with DocIterator.
 145         void dispatch(Cursor & cur, FuncRequest & cmd);
 146         /// do we want to handle this event?
 147         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 148                 FuncStatus & status) const;
 149
 150         /// read-only access to individual paragraph
 151         Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
 152         /// read-write access to individual paragraph
 153         Paragraph & getPar(pit_type pit) { return pars_[pit]; }
 154         // Returns the current font and depth as a message.
 155         /// FIXME: replace Cursor with DocIterator.
 156         docstring currentState(Cursor const & cur) 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, word_location const) const;
 164         /// just selects the word the cursor is in
 165         void selectWord(Cursor & cur, word_location loc);
 166         /// select all text
 167         void selectAll(Cursor & cur);
 168         /// convenience function get the previous word or an empty string
 169         docstring previousWord(CursorSlice const & sl) const;
 170
 171         /// what type of change operation to make
 172         enum ChangeOp {
 173                 ACCEPT,
 174                 REJECT
 175         };
 176         /// accept or reject the selected change
 177         void acceptOrRejectChanges(Cursor & cur, ChangeOp op);
 178         /// accept the changes within the complete Text
 179         void acceptChanges();
 180         /// reject the changes within the complete Text
 181         void rejectChanges();
 182
 183         /// returns true if par was empty and was removed
 184         bool setCursor(Cursor & cur, pit_type par, pos_type pos,
 185                        bool setfont = true, bool boundary = false);
 186         ///
 187         void setCursor(CursorSlice &, pit_type par, pos_type pos);
 188         ///
 189         void setCursorIntern(Cursor & cur, pit_type par,
 190                  pos_type pos, bool setfont = true, bool boundary = false);
 191
 192         ///
 193         void recUndo(Cursor & cur, pit_type first, pit_type last) const;
 194         ///
 195         void recUndo(Cursor & cur, pit_type first) const;
 196
 197         /// Move cursor one position backwards
 198         /**
 199          * Returns true if an update is needed after the move.
 200          */
 201         bool cursorBackward(Cursor & cur);
 202         /// Move cursor visually one position to the left
 203         /**
 204          * \param skip_inset if true, don't enter insets
 205          * Returns true if an update is needed after the move.
 206          */
 207         bool cursorVisLeft(Cursor & cur, bool skip_inset = false);
 208         /// Move cursor one position forward
 209         /**
 210          * Returns true if an update is needed after the move.
 211          */
 212         bool cursorForward(Cursor & cur);
 213         /// Move cursor visually one position to the right
 214         /**
 215          * \param skip_inset if true, don't enter insets
 216          * Returns true if an update is needed after the move.
 217          */
 218         bool cursorVisRight(Cursor & cur, bool skip_inset = false);
 219         ///
 220         bool cursorBackwardOneWord(Cursor & cur);
 221         ///
 222         bool cursorForwardOneWord(Cursor & cur);
 223         ///
 224         bool cursorVisLeftOneWord(Cursor & cur);
 225         ///
 226         bool cursorVisRightOneWord(Cursor & cur);
 227         /// Delete from cursor up to the end of the current or next word.
 228         void deleteWordForward(Cursor & cur);
 229         /// Delete from cursor to start of current or prior word.
 230         void deleteWordBackward(Cursor & cur);
 231         ///
 232         bool cursorUpParagraph(Cursor & cur);
 233         ///
 234         bool cursorDownParagraph(Cursor & cur);
 235         ///
 236         bool cursorTop(Cursor & cur);
 237         ///
 238         bool cursorBottom(Cursor & cur);
 239         /// Erase character at cursor. Honour change tracking
 240         /// FIXME: replace Cursor with DocIterator.
 241         bool erase(Cursor & cur);
 242         /// Delete character before cursor. Honour CT
 243         /// FIXME: replace Cursor with DocIterator.
 244         bool backspace(Cursor & cur);
 245         // Dissolve the inset under cursor
 246         /// FIXME: replace Cursor with DocIterator.
 247         bool dissolveInset(Cursor & cur);
 248         ///
 249         bool selectWordWhenUnderCursor(Cursor & cur, word_location);
 250         /// Change the case of the word at cursor position.
 251         void changeCase(Cursor & cur, TextCase action);
 252         /// Transposes the character at the cursor with the one before it
 253         void charsTranspose(Cursor & cur);
 254
 255         /** the DTP switches for paragraphs. LyX will store the top settings
 256          always in the first physical paragraph, the bottom settings in the
 257          last. When a paragraph is broken, the top settings rest, the bottom
 258          settings are given to the new one.
 259          This function will handle a multi-paragraph selection.
 260          */
 261         void setParagraphs(Cursor & cur, docstring arg, bool modify = false);
 262         /// Sets parameters for current or selected paragraphs
 263         void setParagraphs(Cursor & cur, ParagraphParameters const & p);
 264
 265         /* these things are for search and replace */
 266
 267         /// needed to insert the selection
 268         void insertStringAsLines(Cursor & cur, docstring const & str,
 269                 Font const & font);
 270         /// needed to insert the selection
 271         void insertStringAsParagraphs(Cursor & cur, docstring const & str,
 272                 Font const & font);
 273
 274         /// access to our paragraphs
 275         ParagraphList const & paragraphs() const { return pars_; }
 276         ParagraphList & paragraphs() { return pars_; }
 277         /// return true if this is the main text
 278         bool isMainText() const;
 279
 280         ///
 281         double spacing(Paragraph const & par) const;
 282         /// make a suggestion for a label
 283         /// FIXME: replace Cursor with DocIterator.
 284         docstring getPossibleLabel(Cursor const & cur) const;
 285         /// is this paragraph right-to-left?
 286         bool isRTL(Paragraph const & par) const;
 287
 288         ///
 289         bool checkAndActivateInset(Cursor & cur, bool front);
 290         ///
 291         bool checkAndActivateInsetVisual(Cursor & cur, bool movingForward, bool movingLeft);
 292
 293         ///
 294         void write(std::ostream & os) const;
 295         /// returns true if \end_document has not been read
 296         /// insetPtr is the containing Inset
 297         bool read(Lexer & lex, ErrorList & errorList,
 298                   InsetText * insetPtr);
 299
 300         /// delete double spaces, leading spaces, and empty paragraphs around old cursor.
 301         /// \retval true if a change has happened and we need a redraw.
 302         /// FIXME: replace Cursor with DocIterator. This is not possible right
 303         /// now because recordUndo() is called which needs a Cursor.
 304         static bool deleteEmptyParagraphMechanism(Cursor & cur,
 305                 Cursor & old, bool & need_anchor_change);
 306
 307         /// delete double spaces, leading spaces, and empty paragraphs
 308         /// from \first to \last paragraph
 309         void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges);
 310
 311         /// To resolve macros properly the texts get their DocIterator.
 312         /// Every macro definition is stored with its DocIterator
 313         /// as well. Only those macros with a smaller iterator become
 314         /// visible in a paragraph.
 315         DocIterator macrocontextPosition() const;
 316         ///
 317         void setMacrocontextPosition(DocIterator const & pos);
 318
 319         ///
 320         bool completionSupported(Cursor const & cur) const;
 321         ///
 322         CompletionList const * createCompletionList(Cursor const & cur) const;
 323         ///
 324         bool insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/);
 325         ///
 326         docstring completionPrefix(Cursor const & cur) const;
 327         /// for the environments
 328         pit_type depthHook(pit_type par, depth_type depth) const;
 329         ///
 330         pit_type outerHook(pit_type par) const;
 331         /// Is it the first par with same depth and layout?
 332         bool isFirstInSequence(pit_type par) const;
 333         /// Get the font of the "environment" of paragraph \p par_offset in \p pars.
 334         /// All font changes of the paragraph are relative to this font.
 335         Font const outerFont(pit_type par_offset) const;
 336
 337 private:
 338         /// The InsetText owner shall have access to everything.
 339         friend class InsetText;
 340
 341         /// return past-the-last paragraph influenced by a layout
 342         /// change on pit
 343         pit_type undoSpan(pit_type pit);
 344
 345         // fix the cursor `cur' after a characters has been deleted at `where'
 346         // position. Called by deleteEmptyParagraphMechanism
 347         static void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
 348
 349         // At cursor position 0, try to merge the paragraph with the one before it.
 350         // Ignore change tracking, i.e., physically remove the end-of-par character
 351         bool backspacePos0(Cursor & cur);
 352         /// handle the case where bibitems were deleted
 353         bool handleBibitems(Cursor & cur);
 354         /// are we in a list item (description etc.)?
 355         bool inDescriptionItem(Cursor & cur) const;
 356         ///
 357         void charInserted(Cursor & cur);
 358         /// set 'number' font property
 359         void number(Cursor & cur);
 360
 361         /// paste plain text at current cursor.
 362         /// \param str string to paste
 363         /// \param asParagraphs whether to paste as paragraphs or as lines
 364         void pasteString(Cursor & cur, docstring const & str,
 365                         bool asParagraphs);
 366         ///
 367         void readParToken(Paragraph & par, Lexer & lex, std::string const & token,
 368                 Font & font, Change & change, ErrorList & errorList);
 369         ///
 370         void readParagraph(Paragraph & par, Lexer & lex, ErrorList & errorList);
 371         /// Set Label Width string to all paragraphs of the same layout
 372     /// and depth in a sequence.
 373         void setLabelWidthStringToSequence(pit_type const par_offset, docstring const & s);
 374
 375         /// Owner Inset.
 376         InsetText * owner_;
 377         ///
 378         ParagraphList pars_;
 379         ///
 380         bool autoBreakRows_;
 381         /// position of the text in the buffer.
 382         DocIterator macrocontext_position_;
 383         ///
 384         unsigned int undo_counter_;
 385 };
 386
 387
 388 ///
 389 void breakParagraphConservative(BufferParams const & bparams,
 390                                 ParagraphList & paragraphs,
 391                                 pit_type par,
 392                                 pos_type pos);
 393
 394 /**
 395  * Append the next paragraph onto the tail of this one.
 396  * Be careful, this doesent make any check at all.
 397  */
 398 void mergeParagraph(BufferParams const & bparams,
 399         ParagraphList & paragraphs, pit_type par);
 400
 401 /// accept the changes within the complete ParagraphList
 402 void acceptChanges(ParagraphList & pars, BufferParams const & bparams);
 403
 404 /// reject the changes within the complete ParagraphList
 405 void rejectChanges(ParagraphList & pars, BufferParams const & bparams);
 406
 407 } // namespace lyx
 408
 409 #endif // TEXT_H