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 CursorData;
  28 class CursorSlice;
  29 class DocIterator;
  30 class ErrorList;
  31 class Font;
  32 class FontInfo;
  33 class FuncRequest;
  34 class FuncStatus;
  35 class Inset;
  36 class Lexer;
  37 class PainterInfo;
  38 class Spacing;
  39
  40 /// This class encapsulates the main text data and operations in LyX.
  41 /// This is more or less the private implementation of InsetText.
  42 class Text {
  43 private:
  44         /// Default constructor.
  45         Text(InsetText * owner, bool use_default_layout);
  46
  47         /// Copy constructor.
  48         Text(InsetText * owner, Text const & text);
  49
  50 public:
  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         /// Access to owner InsetText.
  56         InsetText const & inset() const;
  57
  58         ///
  59         FontInfo layoutFont(pit_type pit) const;
  60         ///
  61         FontInfo labelFont(Paragraph const & par) const;
  62         /** Set font of character at position \p pos in paragraph \p pit.
  63          *  Must not be called if \p pos denotes an inset with text contents,
  64          *  and the inset is not allowed inside a font change (see below).
  65          */
  66         void setCharFont(pit_type pit, pos_type pos,
  67                 Font const & font, Font const & display_font);
  68
  69         /** Needed to propagate font changes to all text cells of insets
  70          *  that are not allowed inside a font change (bugs 1973, 6919).
  71          *  Must not be called if \p pos denotes an ordinary character or an
  72          *  inset that is alowed inside a font change.
  73          */
  74         void setInsetFont(BufferView const & bv, pit_type pit, pos_type pos,
  75                 Font const & font);
  76
  77         /// what you expect when pressing \<enter\> at cursor position
  78         /// \param inverse_logic if false, the same layout is set for the
  79         /// new paragraph if the layout is an environment; if true, the
  80         /// same layout is set if it is not an environment
  81         void breakParagraph(Cursor & cur, bool inverse_logic = false);
  82
  83         /// set layout over selection
  84         void setLayout(pit_type start, pit_type end,
  85                 docstring const & layout);
  86         /// Set given layout to current cursor position or selection.
  87         /// Handles undo.
  88         void setLayout(Cursor & cur, docstring const & layout);
  89
  90         /// what type of depth change to make
  91         enum DEPTH_CHANGE {
  92                 INC_DEPTH,
  93                 DEC_DEPTH
  94         };
  95         /// Increase or decrease the nesting depth of the selected paragraph(s)
  96         /// FIXME: replace Cursor with DocIterator.
  97         void changeDepth(Cursor & cur, DEPTH_CHANGE type);
  98
  99         /// Returns whether something would be changed by changeDepth
 100         /// FIXME: replace Cursor with DocIterator.
 101         bool changeDepthAllowed(Cursor & cur, DEPTH_CHANGE type) const;
 102
 103         /// Set font over selection paragraphs and rebreak.
 104         /// FIXME: replace Cursor with DocIterator.
 105         void setFont(Cursor & cur, Font const &, bool toggleall = false);
 106         /// Set font from \p begin to \p end and rebreak.
 107         void setFont(BufferView const & bv, CursorSlice const & begin,
 108                 CursorSlice const & end, Font const &);
 109
 110         ///
 111         void toggleFree(Cursor & cur, Font const &, bool toggleall = false);
 112
 113         /// ???
 114         /// FIXME: replace Cursor with DocIterator.
 115         docstring getStringForDialog(Cursor & 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
 128         /// truncates str to maxlenwith an ellipsis and replaces the characters '\n'
 129         /// and '\t' with spaces
 130         static void shortenForOutliner(docstring & str, size_t const maxlen);
 131
 132         /// Appends a possibly abbreviated representation of our text to \param os,
 133         /// where \param maxlen defines the maximum size of \param os. If \param
 134         /// shorten is true, then os is shortened as above.
 135         void forOutliner(docstring & os, size_t maxlen, bool shorten = true) const;
 136         /// Appends a possibly abbreviated representation of our text, from
 137         /// start to end, to \param os, where \param maxlen defines the
 138         /// maximum size of \param os. Omits the label of the first paragraph.
 139         void forOutliner(docstring & os, size_t maxlen, pit_type start, pit_type end,
 140                          bool shorten = true) const;
 141
 142         /// insert a character at cursor position
 143         /// FIXME: replace Cursor with DocIterator.
 144         void insertChar(Cursor & cur, char_type c);
 145         /// insert an inset at cursor position
 146         /// FIXME: replace Cursor with DocIterator.
 147         void insertInset(Cursor & cur, Inset * inset);
 148
 149         /// try to handle that request
 150         /// FIXME: replace Cursor with DocIterator.
 151         void dispatch(Cursor & cur, FuncRequest & cmd);
 152         /// do we want to handle this event?
 153         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 154                 FuncStatus & status) const;
 155
 156         /// read-only access to individual paragraph
 157         Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
 158         /// read-write access to individual paragraph
 159         Paragraph & getPar(pit_type pit) { return pars_[pit]; }
 160         // Returns the current font and depth as a message.
 161         // When \param devel_mode is true, add more precise information
 162         docstring currentState(CursorData const & cur, bool devel_mode) const;
 163
 164         /** Find the word under \c from in the relative location
 165          *  defined by \c word_location.
 166          *  @param from return here the start of the word
 167          *  @param to return here the end of the word
 168          */
 169         void getWord(CursorSlice & from, CursorSlice & to, word_location const) const;
 170         /// just selects the word the cursor is in
 171         void selectWord(Cursor & cur, word_location loc);
 172         /// select all text
 173         void selectAll(Cursor & cur);
 174         /// convenience function get the previous word or an empty string
 175         docstring previousWord(CursorSlice const & sl) const;
 176
 177         /// what type of change operation to make
 178         enum ChangeOp {
 179                 ACCEPT,
 180                 REJECT
 181         };
 182         /// accept or reject the selected change
 183         void acceptOrRejectChanges(Cursor & cur, ChangeOp op);
 184         /// accept the changes within the complete Text
 185         void acceptChanges();
 186         /// reject the changes within the complete Text
 187         void rejectChanges();
 188
 189         /// returns true if par was empty and was removed
 190         bool setCursor(Cursor & cur, pit_type pit, pos_type pos,
 191                        bool setfont = true, bool boundary = false);
 192         ///
 193         void setCursorIntern(Cursor & cur, pit_type pit,
 194                  pos_type pos, bool setfont = true, bool boundary = false);
 195
 196         /// Move cursor one position backwards
 197         /**
 198          * Returns true if an update is needed after the move.
 199          */
 200         bool cursorBackward(Cursor & cur);
 201         /// Move cursor visually one position to the left
 202         /**
 203          * \param skip_inset if true, don't enter insets
 204          * Returns true if an update is needed after the move.
 205          */
 206         bool cursorVisLeft(Cursor & cur, bool skip_inset = false);
 207         /// Move cursor one position forward
 208         /**
 209          * Returns true if an update is needed after the move.
 210          */
 211         bool cursorForward(Cursor & cur);
 212         /// Move cursor visually one position to the right
 213         /**
 214          * \param skip_inset if true, don't enter insets
 215          * Returns true if an update is needed after the move.
 216          */
 217         bool cursorVisRight(Cursor & cur, bool skip_inset = false);
 218         ///
 219         bool cursorBackwardOneWord(Cursor & cur);
 220         ///
 221         bool cursorForwardOneWord(Cursor & cur);
 222         ///
 223         bool cursorVisLeftOneWord(Cursor & cur);
 224         ///
 225         bool cursorVisRightOneWord(Cursor & cur);
 226         /// Delete from cursor up to the end of the current or next word.
 227         /// Use force to skip the confirmDeletion check.
 228         void deleteWordForward(Cursor & cur, bool force = false);
 229         /// Delete from cursor to start of current or prior word.
 230         void deleteWordBackward(Cursor & cur, bool force = false);
 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, bool partial);
 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(DocIterator 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         /// find a paragraph before \p par with the given \p depth, if such
 328         /// a paragraph cannot be found, \p par is returned
 329         pit_type depthHook(pit_type pit, depth_type depth) const;
 330         /// find a paragraph before \p par with depth less than the
 331         /// depth of \p par. If such paragraph cannot be found because
 332         /// \p par already has depth 0, lastpar + 1 is returned. If
 333         /// such paragraph cannot be found because there isn't a par
 334         /// with less depth before this one, \p par is returned.
 335         pit_type outerHook(pit_type pit) const;
 336         /// Is it the first par with same depth and layout?
 337         bool isFirstInSequence(pit_type pit) const;
 338         /// Return the last paragraph with same depth and layout, or a strictly
 339         /// greater depth
 340         pit_type lastInSequence(pit_type pit) const;
 341         /// Is this paragraph in the table of contents?
 342         int getTocLevel(pit_type pit) const;
 343         /// Get the font of the "environment" of paragraph \p par_offset in \p pars.
 344         /// All font changes of the paragraph are relative to this font.
 345         Font const outerFont(pit_type pit_offset) const;
 346
 347 private:
 348         /// The InsetText owner shall have access to everything.
 349         friend class InsetText;
 350
 351         // At cursor position 0, try to merge the paragraph with the one before it.
 352         // Ignore change tracking, i.e., physically remove the end-of-par character
 353         bool backspacePos0(Cursor & cur);
 354         /// handle the case where bibitems were deleted
 355         bool handleBibitems(Cursor & cur);
 356         /// are we in a list item (description etc.)?
 357         bool inDescriptionItem(Cursor & cur) const;
 358         ///
 359         void charInserted(Cursor & cur);
 360         /// set 'number' font property
 361         void number(Cursor & cur);
 362
 363         /// paste plain text at current cursor.
 364         /// \param str string to paste
 365         /// \param asParagraphs whether to paste as paragraphs or as lines
 366         void pasteString(Cursor & cur, docstring const & str,
 367                         bool asParagraphs);
 368         ///
 369         void readParToken(Paragraph & par, Lexer & lex, std::string const & token,
 370                 Font & font, Change & change, ErrorList & errorList);
 371         ///
 372         void readParagraph(Paragraph & par, Lexer & lex, ErrorList & errorList);
 373         /// Set Label Width string to all paragraphs of the same layout
 374         /// and depth in a sequence.
 375         void setLabelWidthStringToSequence(Cursor const & cur, docstring const & s);
 376
 377         /// Owner Inset.
 378         InsetText * owner_;
 379         ///
 380         ParagraphList pars_;
 381         /// position of the text in the buffer.
 382         DocIterator macrocontext_position_;
 383 };
 384
 385
 386 ///
 387 void breakParagraphConservative(BufferParams const & bparams,
 388                                 ParagraphList & paragraphs,
 389                                 pit_type pit,
 390                                 pos_type pos);
 391
 392 /**
 393  * Append the next paragraph onto the tail of this one.
 394  * Be careful, this doesent make any check at all.
 395  */
 396 void mergeParagraph(BufferParams const & bparams,
 397         ParagraphList & paragraphs, pit_type pit);
 398
 399 /// accept the changes within the complete ParagraphList
 400 void acceptChanges(ParagraphList & pars, BufferParams const & bparams);
 401
 402 /// reject the changes within the complete ParagraphList
 403 void rejectChanges(ParagraphList & pars, BufferParams const & bparams);
 404
 405 } // namespace lyx
 406
 407 #endif // TEXT_H