4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Lars Gullik Bjønnes
11 * Full author contact details are available in file CREDITS.
17 #include "DocIterator.h"
18 #include "ParagraphList.h"
39 /// This class encapsulates the main text data and operations in LyX.
40 /// This is more or less the private implementation of InsetText.
43 /// Default constructor.
44 Text(InsetText * owner, bool use_default_layout);
47 Text(InsetText * owner, Text const & text);
50 /// \return true if there's no content at all.
51 /// \warning a non standard layout on an empty paragraph doesn't
54 /// Access to owner InsetText.
55 InsetText const & inset() const;
58 FontInfo layoutFont(pit_type pit) const;
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).
65 void setCharFont(pit_type pit, pos_type pos,
66 Font const & font, Font const & display_font);
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.
73 void setInsetFont(BufferView const & bv, pit_type pit, pos_type pos,
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);
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);
89 /// what type of depth change to make
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);
98 /// Returns whether something would be changed by changeDepth
99 /// FIXME: replace Cursor with DocIterator.
100 bool changeDepthAllowed(Cursor & cur, DEPTH_CHANGE type) const;
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 &);
110 void toggleFree(Cursor & cur, Font const &, bool toggleall = false);
113 /// FIXME: replace Cursor with DocIterator.
114 docstring getStringToIndex(Cursor const & cur);
116 /// Convert the paragraphs to a string.
117 /// \param AsStringParameter options. This can contain any combination of
118 /// asStringParameter values. Valid examples:
119 /// asString(AS_STR_LABEL)
120 /// asString(AS_STR_LABEL | AS_STR_INSETS)
121 /// asString(AS_STR_INSETS)
122 docstring asString(int options = AS_STR_NONE) const;
124 docstring asString(pit_type beg, pit_type end,
125 int options = AS_STR_NONE) const;
126 /// Appends a possibly abbreviated representation of our text
127 /// to \param os, where \param maxlen defines the maximum size
128 /// of \param os. If \param shorten is true, then we will shorten
129 /// \param os to maxlen chars and replace the final three by "...,
130 /// if \param os is longer than maxlen chars.
131 /// if \param maxlen is passed as 0, then it is ignored. (In fact,
132 /// it is reset to the maximum value for size_t.)
133 void forToc(docstring & os, size_t maxlen, bool shorten = true) const;
135 /// insert a character at cursor position
136 /// FIXME: replace Cursor with DocIterator.
137 void insertChar(Cursor & cur, char_type c);
138 /// insert an inset at cursor position
139 /// FIXME: replace Cursor with DocIterator.
140 void insertInset(Cursor & cur, Inset * inset);
142 /// try to handle that request
143 /// FIXME: replace Cursor with DocIterator.
144 void dispatch(Cursor & cur, FuncRequest & cmd);
145 /// do we want to handle this event?
146 bool getStatus(Cursor & cur, FuncRequest const & cmd,
147 FuncStatus & status) const;
149 /// read-only access to individual paragraph
150 Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
151 /// read-write access to individual paragraph
152 Paragraph & getPar(pit_type pit) { return pars_[pit]; }
153 // Returns the current font and depth as a message.
154 /// FIXME: replace Cursor with DocIterator.
155 docstring currentState(Cursor const & cur) const;
157 /** Find the word under \c from in the relative location
158 * defined by \c word_location.
159 * @param from return here the start of the word
160 * @param to return here the end of the word
162 void getWord(CursorSlice & from, CursorSlice & to, word_location const) const;
163 /// just selects the word the cursor is in
164 void selectWord(Cursor & cur, word_location loc);
166 void selectAll(Cursor & cur);
167 /// convenience function get the previous word or an empty string
168 docstring previousWord(CursorSlice const & sl) const;
170 /// what type of change operation to make
175 /// accept or reject the selected change
176 void acceptOrRejectChanges(Cursor & cur, ChangeOp op);
177 /// accept the changes within the complete Text
178 void acceptChanges();
179 /// reject the changes within the complete Text
180 void rejectChanges();
182 /// returns true if par was empty and was removed
183 bool setCursor(Cursor & cur, pit_type par, pos_type pos,
184 bool setfont = true, bool boundary = false);
186 void setCursor(CursorSlice &, pit_type par, pos_type pos);
188 void setCursorIntern(Cursor & cur, pit_type par,
189 pos_type pos, bool setfont = true, bool boundary = false);
192 void recUndo(Cursor & cur, pit_type first, pit_type last) const;
194 void recUndo(Cursor & cur, pit_type first) const;
196 /// Move cursor one position backwards
198 * Returns true if an update is needed after the move.
200 bool cursorBackward(Cursor & cur);
201 /// Move cursor visually one position to the left
203 * \param skip_inset if true, don't enter insets
204 * Returns true if an update is needed after the move.
206 bool cursorVisLeft(Cursor & cur, bool skip_inset = false);
207 /// Move cursor one position forward
209 * Returns true if an update is needed after the move.
211 bool cursorForward(Cursor & cur);
212 /// Move cursor visually one position to the right
214 * \param skip_inset if true, don't enter insets
215 * Returns true if an update is needed after the move.
217 bool cursorVisRight(Cursor & cur, bool skip_inset = false);
219 bool cursorBackwardOneWord(Cursor & cur);
221 bool cursorForwardOneWord(Cursor & cur);
223 bool cursorVisLeftOneWord(Cursor & cur);
225 bool cursorVisRightOneWord(Cursor & cur);
226 /// Delete from cursor up to the end of the current or next word.
227 void deleteWordForward(Cursor & cur);
228 /// Delete from cursor to start of current or prior word.
229 void deleteWordBackward(Cursor & cur);
231 bool cursorUpParagraph(Cursor & cur);
233 bool cursorDownParagraph(Cursor & cur);
235 bool cursorTop(Cursor & cur);
237 bool cursorBottom(Cursor & cur);
238 /// Erase character at cursor. Honour change tracking
239 /// FIXME: replace Cursor with DocIterator.
240 bool erase(Cursor & cur);
241 /// Delete character before cursor. Honour CT
242 /// FIXME: replace Cursor with DocIterator.
243 bool backspace(Cursor & cur);
244 // Dissolve the inset under cursor
245 /// FIXME: replace Cursor with DocIterator.
246 bool dissolveInset(Cursor & cur);
248 bool selectWordWhenUnderCursor(Cursor & cur, word_location);
249 /// Change the case of the word at cursor position.
250 void changeCase(Cursor & cur, TextCase action);
251 /// Transposes the character at the cursor with the one before it
252 void charsTranspose(Cursor & cur);
254 /** the DTP switches for paragraphs. LyX will store the top settings
255 always in the first physical paragraph, the bottom settings in the
256 last. When a paragraph is broken, the top settings rest, the bottom
257 settings are given to the new one.
258 This function will handle a multi-paragraph selection.
260 void setParagraphs(Cursor & cur, docstring arg, bool modify = false);
261 /// Sets parameters for current or selected paragraphs
262 void setParagraphs(Cursor & cur, ParagraphParameters const & p);
264 /* these things are for search and replace */
266 /// needed to insert the selection
267 void insertStringAsLines(Cursor & cur, docstring const & str,
269 /// needed to insert the selection
270 void insertStringAsParagraphs(Cursor & cur, docstring const & str,
273 /// access to our paragraphs
274 ParagraphList const & paragraphs() const { return pars_; }
275 ParagraphList & paragraphs() { return pars_; }
276 /// return true if this is the main text
277 bool isMainText() const;
280 double spacing(Paragraph const & par) const;
281 /// make a suggestion for a label
282 /// FIXME: replace Cursor with DocIterator.
283 docstring getPossibleLabel(Cursor const & cur) const;
284 /// is this paragraph right-to-left?
285 bool isRTL(Paragraph const & par) const;
288 bool checkAndActivateInset(Cursor & cur, bool front);
290 bool checkAndActivateInsetVisual(Cursor & cur, bool movingForward, bool movingLeft);
293 void write(std::ostream & os) const;
294 /// returns true if \end_document has not been read
295 /// insetPtr is the containing Inset
296 bool read(Lexer & lex, ErrorList & errorList,
297 InsetText * insetPtr);
299 /// delete double spaces, leading spaces, and empty paragraphs around old cursor.
300 /// \retval true if a change has happened and we need a redraw.
301 /// FIXME: replace Cursor with DocIterator. This is not possible right
302 /// now because recordUndo() is called which needs a Cursor.
303 static bool deleteEmptyParagraphMechanism(Cursor & cur,
304 Cursor & old, bool & need_anchor_change);
306 /// delete double spaces, leading spaces, and empty paragraphs
307 /// from \first to \last paragraph
308 void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges);
310 /// To resolve macros properly the texts get their DocIterator.
311 /// Every macro definition is stored with its DocIterator
312 /// as well. Only those macros with a smaller iterator become
313 /// visible in a paragraph.
314 DocIterator macrocontextPosition() const;
316 void setMacrocontextPosition(DocIterator const & pos);
319 bool completionSupported(Cursor const & cur) const;
321 CompletionList const * createCompletionList(Cursor const & cur) const;
323 bool insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/);
325 docstring completionPrefix(Cursor const & cur) const;
326 /// find a paragraph before \p par with the given \p depth, if such
327 /// a paragraph cannot be found, \p par is returned
328 pit_type depthHook(pit_type par, depth_type depth) const;
329 /// find a paragraph before \p par with depth less than the
330 /// depth of \p par. If such paragraph cannot be found because
331 /// \p par already has depth 0, lastpar + 1 is returned. If
332 /// such paragraph cannot be found because there isn't a par
333 /// with less depth before this one, \p par is returned.
334 pit_type outerHook(pit_type par) const;
335 /// Is it the first par with same depth and layout?
336 bool isFirstInSequence(pit_type par) const;
337 /// Get the font of the "environment" of paragraph \p par_offset in \p pars.
338 /// All font changes of the paragraph are relative to this font.
339 Font const outerFont(pit_type par_offset) const;
342 /// The InsetText owner shall have access to everything.
343 friend class InsetText;
345 /// return past-the-last paragraph influenced by a layout
347 pit_type undoSpan(pit_type pit);
349 // fix the cursor `cur' after a characters has been deleted at `where'
350 // position. Called by deleteEmptyParagraphMechanism
351 static void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
353 // At cursor position 0, try to merge the paragraph with the one before it.
354 // Ignore change tracking, i.e., physically remove the end-of-par character
355 bool backspacePos0(Cursor & cur);
356 /// handle the case where bibitems were deleted
357 bool handleBibitems(Cursor & cur);
358 /// are we in a list item (description etc.)?
359 bool inDescriptionItem(Cursor & cur) const;
361 void charInserted(Cursor & cur);
362 /// set 'number' font property
363 void number(Cursor & cur);
365 /// paste plain text at current cursor.
366 /// \param str string to paste
367 /// \param asParagraphs whether to paste as paragraphs or as lines
368 void pasteString(Cursor & cur, docstring const & str,
371 void readParToken(Paragraph & par, Lexer & lex, std::string const & token,
372 Font & font, Change & change, ErrorList & errorList);
374 void readParagraph(Paragraph & par, Lexer & lex, ErrorList & errorList);
375 /// Set Label Width string to all paragraphs of the same layout
376 /// and depth in a sequence.
377 void setLabelWidthStringToSequence(pit_type const par_offset, docstring const & s);
385 /// position of the text in the buffer.
386 DocIterator macrocontext_position_;
388 unsigned int undo_counter_;
393 void breakParagraphConservative(BufferParams const & bparams,
394 ParagraphList & paragraphs,
399 * Append the next paragraph onto the tail of this one.
400 * Be careful, this doesent make any check at all.
402 void mergeParagraph(BufferParams const & bparams,
403 ParagraphList & paragraphs, pit_type par);
405 /// accept the changes within the complete ParagraphList
406 void acceptChanges(ParagraphList & pars, BufferParams const & bparams);
408 /// reject the changes within the complete ParagraphList
409 void rejectChanges(ParagraphList & pars, BufferParams const & bparams);