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"
38 class ParagraphParameters;
40 /// This class encapsulates the main text data and operations in LyX.
41 /// This is more or less the private implementation of InsetText.
44 /// Default constructor.
45 Text(InsetText * owner, bool use_default_layout);
48 Text(InsetText * owner, Text const & text);
51 /// \return true if there's no content at all.
52 /// \warning a non standard layout on an empty paragraph doesn't
55 /// Access to owner InsetText.
56 InsetText const & inset() const;
59 FontInfo layoutFont(pit_type pit) const;
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).
66 void setCharFont(pit_type pit, pos_type pos,
67 Font const & font, Font const & display_font);
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.
74 void setInsetFont(BufferView const & bv, pit_type pit, pos_type pos,
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);
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.
88 void setLayout(Cursor & cur, docstring const & layout);
90 /// what type of depth change to make
95 /// Increase or decrease the nesting depth of the selected paragraph(s)
96 /// FIXME: replace Cursor with DocIterator.
97 void changeDepth(Cursor const & cur, DEPTH_CHANGE type);
99 /// Returns whether something would be changed by changeDepth
100 /// FIXME: replace Cursor with DocIterator.
101 bool changeDepthAllowed(Cursor const & cur, DEPTH_CHANGE type) const;
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 &);
111 void toggleFree(Cursor & cur, Font const &, bool toggleall = false);
112 /// Stack to save recent text propterty applications
113 std::vector<docstring> getFreeFonts() const;
116 /// FIXME: replace Cursor with DocIterator.
117 docstring getStringForDialog(Cursor & cur);
119 /// Convert the paragraphs to a string.
120 /// \param AsStringParameter options. This can contain any combination of
121 /// asStringParameter values. Valid examples:
122 /// asString(AS_STR_LABEL)
123 /// asString(AS_STR_LABEL | AS_STR_INSETS)
124 /// asString(AS_STR_INSETS)
125 docstring asString(int options = AS_STR_NONE) const;
127 docstring asString(pit_type beg, pit_type end,
128 int options = AS_STR_NONE) const;
130 /// truncates str to maxlenwith an ellipsis and replaces the characters '\n'
131 /// and '\t' with spaces
132 static void shortenForOutliner(docstring & str, size_t const maxlen);
134 /// Appends a possibly abbreviated representation of our text to \param os,
135 /// where \param maxlen defines the maximum size of \param os. If \param
136 /// shorten is true, then os is shortened as above.
137 void forOutliner(docstring & os, size_t maxlen, bool shorten = true) const;
138 /// Appends a possibly abbreviated representation of our text, from
139 /// start to end, to \param os, where \param maxlen defines the
140 /// maximum size of \param os. Omits the label of the first paragraph.
141 void forOutliner(docstring & os, size_t maxlen, pit_type start, pit_type end,
142 bool shorten = true) const;
144 /// insert a character at cursor position
145 /// FIXME: replace Cursor with DocIterator.
146 void insertChar(Cursor & cur, char_type c);
147 /// insert an inset at cursor position
148 /// FIXME: replace Cursor with DocIterator.
149 void insertInset(Cursor & cur, Inset * inset);
151 /// try to handle that request
152 /// FIXME: replace Cursor with DocIterator.
153 void dispatch(Cursor & cur, FuncRequest & cmd);
154 /// do we want to handle this event?
155 bool getStatus(Cursor & cur, FuncRequest const & cmd,
156 FuncStatus & status) const;
158 /// read-only access to individual paragraph
159 Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
160 /// read-write access to individual paragraph
161 Paragraph & getPar(pit_type pit) { return pars_[pit]; }
162 // Returns the current font and depth as a message.
163 // When \param devel_mode is true, add more precise information
164 docstring currentState(CursorData const & cur, bool devel_mode) const;
166 /** Find the word under \c from in the relative location
167 * defined by \c word_location.
168 * @param from return here the start of the word
169 * @param to return here the end of the word
171 void getWord(CursorSlice & from, CursorSlice & to, word_location const) const;
172 /// just selects the word the cursor is in
173 void selectWord(Cursor & cur, word_location loc);
175 void selectAll(Cursor & cur);
177 /// what type of change operation to make
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();
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);
193 void setCursorIntern(Cursor & cur, pit_type pit,
194 pos_type pos, bool setfont = true, bool boundary = false);
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 /// 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);
232 bool cursorUpParagraph(Cursor & cur);
234 bool cursorDownParagraph(Cursor & cur);
236 bool cursorTop(Cursor & cur);
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 /// FIXME: replace Cursor with DocIterator.
249 bool splitInset(Cursor & cur);
251 bool selectWordWhenUnderCursor(Cursor & cur, word_location);
252 /// Change the case of the word at cursor position.
253 void changeCase(Cursor & cur, TextCase action, bool partial);
254 /// Transposes the character at the cursor with the one before it
255 void charsTranspose(Cursor & cur);
257 /** the DTP switches for paragraphs. LyX will store the top settings
258 always in the first physical paragraph, the bottom settings in the
259 last. When a paragraph is broken, the top settings rest, the bottom
260 settings are given to the new one.
261 This function will handle a multi-paragraph selection.
263 void setParagraphs(Cursor const & cur, docstring const & arg, bool merge = false);
264 /// Sets parameters for current or selected paragraphs
265 void setParagraphs(Cursor const & cur, ParagraphParameters const & p);
267 /* these things are for search and replace */
269 /// needed to insert the selection
270 void insertStringAsLines(Cursor & cur, docstring const & str,
272 /// needed to insert the selection
273 void insertStringAsParagraphs(Cursor & cur, docstring const & str,
276 /// access to our paragraphs
277 ParagraphList const & paragraphs() const { return pars_; }
278 ParagraphList & paragraphs() { return pars_; }
279 /// return true if this is the main text
280 bool isMainText() const;
283 double spacing(Paragraph const & par) const;
284 /// make a suggestion for a label
285 /// FIXME: replace Cursor with DocIterator.
286 docstring getPossibleLabel(DocIterator const & cur) const;
287 /// is this paragraph right-to-left?
288 bool isRTL(pit_type pit) const;
291 bool checkAndActivateInset(Cursor & cur, bool front);
293 bool checkAndActivateInsetVisual(Cursor & cur, bool movingForward, bool movingLeft);
296 void write(std::ostream & os) const;
297 /// returns true if \end_document has not been read
298 /// insetPtr is the containing Inset
299 bool read(Lexer & lex, ErrorList & errorList,
300 InsetText * insetPtr);
302 /// delete double spaces, leading spaces, and empty paragraphs around old cursor.
303 /// \retval true if a change has happened and we need a redraw.
305 static bool deleteEmptyParagraphMechanism(Cursor & cur,
306 Cursor & old, bool & need_anchor_change);
308 /// delete double spaces, leading spaces, and empty paragraphs
309 /// from \first to \last paragraph
310 /// Does NOT handle undo (responsibility of the caller)
311 void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges);
313 /// delete double spaces, leading spaces, and empty paragraphs
314 /// from \first to \last paragraph and \first_pos to \last_pos
315 /// Does NOT handle undo (responsibility of the caller)
316 void deleteEmptyParagraphMechanism(pit_type first, pit_type last,
317 pos_type first_pos, pos_type last_pos,
320 /// To resolve macros properly the texts get their DocIterator.
321 /// Every macro definition is stored with its DocIterator
322 /// as well. Only those macros with a smaller iterator become
323 /// visible in a paragraph.
324 DocIterator macrocontextPosition() const;
326 void setMacrocontextPosition(DocIterator const & pos);
329 bool completionSupported(Cursor const & cur) const;
331 CompletionList const * createCompletionList(Cursor const & cur) const;
333 bool insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/);
335 docstring completionPrefix(Cursor const & cur) const;
336 /// find a paragraph before \p par with the given \p depth, if such
337 /// a paragraph cannot be found, \p par is returned
338 pit_type depthHook(pit_type pit, depth_type depth) const;
339 /// find a paragraph before \p par with depth less than the
340 /// depth of \p par. If such paragraph cannot be found because
341 /// \p par already has depth 0, lastpar + 1 is returned. If
342 /// such paragraph cannot be found because there isn't a par
343 /// with less depth before this one, \p par is returned.
344 pit_type outerHook(pit_type pit) const;
345 /// Is it the first par with same depth and layout?
346 bool isFirstInSequence(pit_type pit) const;
347 /// Return the last paragraph with same depth and layout, or a strictly
349 pit_type lastInSequence(pit_type pit) const;
350 /// Is this paragraph in the table of contents?
351 int getTocLevel(pit_type pit) const;
352 /// Get the font of the "environment" of paragraph \p par_offset in \p pars.
353 /// All font changes of the paragraph are relative to this font.
354 Font const outerFont(pit_type pit_offset) const;
355 /// Return the label type at the end of paragraph \c pit.
356 int getEndLabel(pit_type pit) const;
359 /// The InsetText owner shall have access to everything.
360 friend class InsetText;
362 // At cursor position 0, try to merge the paragraph with the one before it.
363 // Ignore change tracking, i.e., physically remove the end-of-par character
364 bool backspacePos0(Cursor & cur);
365 /// handle the case where bibitems were deleted
366 bool handleBibitems(Cursor & cur);
367 /// are we in a list item (description etc.)?
368 bool inDescriptionItem(Cursor const & cur) const;
370 void charInserted(Cursor & cur);
371 /// set 'number' font property
372 void number(Cursor & cur);
374 /// paste plain text at current cursor.
375 /// \param str string to paste
376 /// \param asParagraphs whether to paste as paragraphs or as lines
377 void pasteString(Cursor & cur, docstring const & str,
380 void readParToken(Paragraph & par, Lexer & lex, std::string const & token,
381 Font & font, Change & change, ErrorList & errorList);
383 void readParagraph(Paragraph & par, Lexer & lex, ErrorList & errorList);
384 /// Set Label Width string to all paragraphs of the same layout
385 /// and depth in a sequence.
386 void setLabelWidthStringToSequence(Cursor const & cur, docstring const & s);
392 /// position of the text in the buffer.
393 DocIterator macrocontext_position_;
398 void breakParagraphConservative(BufferParams const & bparams,
399 ParagraphList & paragraphs,
404 * Append the next paragraph onto the tail of this one.
405 * Be careful, this doesent make any check at all.
407 void mergeParagraph(BufferParams const & bparams,
408 ParagraphList & paragraphs, pit_type pit);
410 /// accept the changes within the complete ParagraphList
411 void acceptChanges(ParagraphList & pars, BufferParams const & bparams);
413 /// reject the changes within the complete ParagraphList
414 void rejectChanges(ParagraphList & pars, BufferParams const & bparams);