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 or selection.
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;
127 /// truncates str to maxlenwith an ellipsis and replaces the characters '\n'
128 /// and '\t' with spaces
129 static void shortenForOutliner(docstring & str, size_t const maxlen);
131 /// Appends a possibly abbreviated representation of our text to \param os,
132 /// where \param maxlen defines the maximum size of \param os. If \param
133 /// shorten is true, then os is shortened as above.
134 void forOutliner(docstring & os, size_t maxlen, bool shorten = true) const;
135 /// Appends a possibly abbreviated representation of our text, from
136 /// start to end, to \param os, where \param maxlen defines the
137 /// maximum size of \param os. Omits the label of the first paragraph.
138 void forOutliner(docstring & os, size_t maxlen, pit_type start, pit_type end,
139 bool shorten = true) const;
141 /// insert a character at cursor position
142 /// FIXME: replace Cursor with DocIterator.
143 void insertChar(Cursor & cur, char_type c);
144 /// insert an inset at cursor position
145 /// FIXME: replace Cursor with DocIterator.
146 void insertInset(Cursor & cur, Inset * inset);
148 /// try to handle that request
149 /// FIXME: replace Cursor with DocIterator.
150 void dispatch(Cursor & cur, FuncRequest & cmd);
151 /// do we want to handle this event?
152 bool getStatus(Cursor & cur, FuncRequest const & cmd,
153 FuncStatus & status) const;
155 /// read-only access to individual paragraph
156 Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
157 /// read-write access to individual paragraph
158 Paragraph & getPar(pit_type pit) { return pars_[pit]; }
159 // Returns the current font and depth as a message.
160 /// FIXME: replace Cursor with DocIterator.
161 docstring currentState(Cursor const & cur) const;
163 /** Find the word under \c from in the relative location
164 * defined by \c word_location.
165 * @param from return here the start of the word
166 * @param to return here the end of the word
168 void getWord(CursorSlice & from, CursorSlice & to, word_location const) const;
169 /// just selects the word the cursor is in
170 void selectWord(Cursor & cur, word_location loc);
172 void selectAll(Cursor & cur);
173 /// convenience function get the previous word or an empty string
174 docstring previousWord(CursorSlice const & sl) const;
176 /// what type of change operation to make
181 /// accept or reject the selected change
182 void acceptOrRejectChanges(Cursor & cur, ChangeOp op);
183 /// accept the changes within the complete Text
184 void acceptChanges();
185 /// reject the changes within the complete Text
186 void rejectChanges();
188 /// returns true if par was empty and was removed
189 bool setCursor(Cursor & cur, pit_type pit, pos_type pos,
190 bool setfont = true, bool boundary = false);
192 void setCursorIntern(Cursor & cur, pit_type pit,
193 pos_type pos, bool setfont = true, bool boundary = false);
195 /// Move cursor one position backwards
197 * Returns true if an update is needed after the move.
199 bool cursorBackward(Cursor & cur);
200 /// Move cursor visually one position to the left
202 * \param skip_inset if true, don't enter insets
203 * Returns true if an update is needed after the move.
205 bool cursorVisLeft(Cursor & cur, bool skip_inset = false);
206 /// Move cursor one position forward
208 * Returns true if an update is needed after the move.
210 bool cursorForward(Cursor & cur);
211 /// Move cursor visually one position to the right
213 * \param skip_inset if true, don't enter insets
214 * Returns true if an update is needed after the move.
216 bool cursorVisRight(Cursor & cur, bool skip_inset = false);
218 bool cursorBackwardOneWord(Cursor & cur);
220 bool cursorForwardOneWord(Cursor & cur);
222 bool cursorVisLeftOneWord(Cursor & cur);
224 bool cursorVisRightOneWord(Cursor & cur);
225 /// Delete from cursor up to the end of the current or next word.
226 void deleteWordForward(Cursor & cur);
227 /// Delete from cursor to start of current or prior word.
228 void deleteWordBackward(Cursor & cur);
230 bool cursorUpParagraph(Cursor & cur);
232 bool cursorDownParagraph(Cursor & cur);
234 bool cursorTop(Cursor & cur);
236 bool cursorBottom(Cursor & cur);
237 /// Erase character at cursor. Honour change tracking
238 /// FIXME: replace Cursor with DocIterator.
239 bool erase(Cursor & cur);
240 /// Delete character before cursor. Honour CT
241 /// FIXME: replace Cursor with DocIterator.
242 bool backspace(Cursor & cur);
243 // Dissolve the inset under cursor
244 /// FIXME: replace Cursor with DocIterator.
245 bool dissolveInset(Cursor & cur);
247 bool selectWordWhenUnderCursor(Cursor & cur, word_location);
248 /// Change the case of the word at cursor position.
249 void changeCase(Cursor & cur, TextCase action, bool partial);
250 /// Transposes the character at the cursor with the one before it
251 void charsTranspose(Cursor & cur);
253 /** the DTP switches for paragraphs. LyX will store the top settings
254 always in the first physical paragraph, the bottom settings in the
255 last. When a paragraph is broken, the top settings rest, the bottom
256 settings are given to the new one.
257 This function will handle a multi-paragraph selection.
259 void setParagraphs(Cursor & cur, docstring arg, bool modify = false);
260 /// Sets parameters for current or selected paragraphs
261 void setParagraphs(Cursor & cur, ParagraphParameters const & p);
263 /* these things are for search and replace */
265 /// needed to insert the selection
266 void insertStringAsLines(Cursor & cur, docstring const & str,
268 /// needed to insert the selection
269 void insertStringAsParagraphs(Cursor & cur, docstring const & str,
272 /// access to our paragraphs
273 ParagraphList const & paragraphs() const { return pars_; }
274 ParagraphList & paragraphs() { return pars_; }
275 /// return true if this is the main text
276 bool isMainText() const;
279 double spacing(Paragraph const & par) const;
280 /// make a suggestion for a label
281 /// FIXME: replace Cursor with DocIterator.
282 docstring getPossibleLabel(Cursor const & cur) const;
283 /// is this paragraph right-to-left?
284 bool isRTL(Paragraph const & par) const;
287 bool checkAndActivateInset(Cursor & cur, bool front);
289 bool checkAndActivateInsetVisual(Cursor & cur, bool movingForward, bool movingLeft);
292 void write(std::ostream & os) const;
293 /// returns true if \end_document has not been read
294 /// insetPtr is the containing Inset
295 bool read(Lexer & lex, ErrorList & errorList,
296 InsetText * insetPtr);
298 /// delete double spaces, leading spaces, and empty paragraphs around old cursor.
299 /// \retval true if a change has happened and we need a redraw.
300 /// FIXME: replace Cursor with DocIterator. This is not possible right
301 /// now because recordUndo() is called which needs a Cursor.
302 static bool deleteEmptyParagraphMechanism(Cursor & cur,
303 Cursor & old, bool & need_anchor_change);
305 /// delete double spaces, leading spaces, and empty paragraphs
306 /// from \first to \last paragraph
307 void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges);
309 /// To resolve macros properly the texts get their DocIterator.
310 /// Every macro definition is stored with its DocIterator
311 /// as well. Only those macros with a smaller iterator become
312 /// visible in a paragraph.
313 DocIterator macrocontextPosition() const;
315 void setMacrocontextPosition(DocIterator const & pos);
318 bool completionSupported(Cursor const & cur) const;
320 CompletionList const * createCompletionList(Cursor const & cur) const;
322 bool insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/);
324 docstring completionPrefix(Cursor const & cur) const;
325 /// find a paragraph before \p par with the given \p depth, if such
326 /// a paragraph cannot be found, \p par is returned
327 pit_type depthHook(pit_type pit, depth_type depth) const;
328 /// find a paragraph before \p par with depth less than the
329 /// depth of \p par. If such paragraph cannot be found because
330 /// \p par already has depth 0, lastpar + 1 is returned. If
331 /// such paragraph cannot be found because there isn't a par
332 /// with less depth before this one, \p par is returned.
333 pit_type outerHook(pit_type pit) const;
334 /// Is it the first par with same depth and layout?
335 bool isFirstInSequence(pit_type pit) const;
336 /// Return the last paragraph with same depth and layout, or a strictly
338 pit_type lastInSequence(pit_type pit) const;
339 /// Is this paragraph in the table of contents?
340 int getTocLevel(pit_type pit) const;
341 /// Get the font of the "environment" of paragraph \p par_offset in \p pars.
342 /// All font changes of the paragraph are relative to this font.
343 Font const outerFont(pit_type pit_offset) const;
346 /// The InsetText owner shall have access to everything.
347 friend class InsetText;
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(Cursor const & cur, docstring const & s);
383 /// position of the text in the buffer.
384 DocIterator macrocontext_position_;
389 void breakParagraphConservative(BufferParams const & bparams,
390 ParagraphList & paragraphs,
395 * Append the next paragraph onto the tail of this one.
396 * Be careful, this doesent make any check at all.
398 void mergeParagraph(BufferParams const & bparams,
399 ParagraphList & paragraphs, pit_type pit);
401 /// accept the changes within the complete ParagraphList
402 void acceptChanges(ParagraphList & pars, BufferParams const & bparams);
404 /// reject the changes within the complete ParagraphList
405 void rejectChanges(ParagraphList & pars, BufferParams const & bparams);