4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup
8 * \author Lars Gullik Bjønnes
10 * \author André Pönitz
11 * \author Jürgen Vigna
13 * Full author contact details are available in file CREDITS.
19 #include "FontEnums.h"
20 #include "SpellChecker.h"
22 #include "insets/InsetCode.h"
24 #include "support/strfwd.h"
25 #include "support/types.h"
53 class ParagraphParameters;
61 /// Invalid font span containing no character
62 FontSpan() : first(0), last(-1) {}
63 /// Span including first and last
64 FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
67 /// Range including first and last.
70 inline bool operator<(FontSpan const & s) const
72 return first < s.first;
75 inline bool operator==(FontSpan const & s) const
77 return first == s.first && last == s.last;
80 inline bool inside(pos_type p) const
82 return first <= p && p <= last;
92 text_capitalization = 1,
99 enum AsStringParameter
101 AS_STR_NONE = 0, ///< No option, only printable characters.
102 AS_STR_LABEL = 1, ///< Prefix with paragraph label.
103 AS_STR_INSETS = 2, ///< Go into insets.
104 AS_STR_NEWLINES = 4 ///< Get also newline characters.
108 /// A Paragraph holds all text, attributes and insets in a text paragraph
114 /// Copy constructor.
115 Paragraph(Paragraph const &);
116 /// Partial copy constructor.
117 /// Copy the Paragraph contents from \p beg to \p end (without end).
118 Paragraph(Paragraph const & par, pos_type beg, pos_type end);
120 Paragraph & operator=(Paragraph const &);
129 void addChangesToToc(DocIterator const & cdit, Buffer const & buf) const;
131 Language const * getParLanguage(BufferParams const &) const;
133 bool isRTL(BufferParams const &) const;
135 void changeLanguage(BufferParams const & bparams,
136 Language const * from, Language const * to);
138 bool isMultiLingual(BufferParams const &) const;
140 void getLanguages(std::set<Language const *> &) const;
142 /// Convert the paragraph to a string.
143 /// \param AsStringParameter options. This can contain any combination of
144 /// asStringParameter values. Valid examples:
145 /// asString(AS_STR_LABEL)
146 /// asString(AS_STR_LABEL | AS_STR_INSETS)
147 /// asString(AS_STR_INSETS)
148 docstring asString(int options = AS_STR_NONE) const;
150 docstring asString(pos_type beg, pos_type end,
151 int options = AS_STR_NONE) const;
153 /// Extract only the explicitly visible text (without any formatting),
154 /// descending into insets
155 docstring stringify(pos_type beg, pos_type end, int options, OutputParams & runparams) const;
158 void write(std::ostream &, BufferParams const &,
159 depth_type & depth) const;
161 void validate(LaTeXFeatures &) const;
163 /// \param force means: output even if layout.inpreamble is true.
164 void latex(BufferParams const &, Font const & outerfont, odocstream &,
165 TexRow & texrow, OutputParams const &,
166 int start_pos = 0, int end_pos = -1, bool force = false) const;
168 /// Can we drop the standard paragraph wrapper?
169 bool emptyTag() const;
171 /// Get the id of the paragraph, usefull for docbook
172 std::string getID(Buffer const & buf, OutputParams const & runparams) const;
174 /// Output the first word of a paragraph, return the position where it left.
175 pos_type firstWordDocBook(odocstream & os, OutputParams const & runparams) const;
177 /// Output the first word of a paragraph, return the position where it left.
178 pos_type firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams) const;
180 /// Writes to stream the docbook representation
181 void simpleDocBookOnePar(Buffer const & buf,
183 OutputParams const & runparams,
184 Font const & outerfont,
185 pos_type initial = 0) const;
186 /// \return any material that has had to be deferred until after the
187 /// paragraph has closed.
188 docstring simpleLyXHTMLOnePar(Buffer const & buf,
190 OutputParams const & runparams,
191 Font const & outerfont,
192 pos_type initial = 0) const;
195 bool hasSameLayout(Paragraph const & par) const;
198 void makeSameLayout(Paragraph const & par);
201 void setInsetOwner(Inset const * inset);
203 Inset const & inInset() const;
205 bool allowParagraphCustomization() const;
207 bool usePlainLayout() const;
209 pos_type size() const;
214 Layout const & layout() const;
215 /// Do not pass a temporary to this!
216 void setLayout(Layout const & layout);
218 void setPlainOrDefaultLayout(DocumentClass const & tc);
220 void setDefaultLayout(DocumentClass const & tc);
222 void setPlainLayout(DocumentClass const & tc);
224 /// This is the item depth, only used by enumerate and itemize
225 signed char itemdepth;
227 /// look up change at given pos
228 Change const & lookupChange(pos_type pos) const;
230 /// is there a change within the given range ?
231 bool isChanged(pos_type start, pos_type end) const;
232 /// is there an unchanged char at the given pos ?
233 bool isChanged(pos_type pos) const;
234 /// is there an insertion at the given pos ?
235 bool isInserted(pos_type pos) const;
236 /// is there a deletion at the given pos ?
237 bool isDeleted(pos_type pos) const;
238 /// is the whole paragraph deleted ?
239 bool isDeleted(pos_type start, pos_type end) const;
241 /// will the paragraph be physically merged with the next
242 /// one if the imaginary end-of-par character is logically deleted?
243 bool isMergedOnEndOfParDeletion(bool trackChanges) const;
245 /// set change for the entire par
246 void setChange(Change const & change);
248 /// set change at given pos
249 void setChange(pos_type pos, Change const & change);
251 /// accept changes within the given range
252 void acceptChanges(pos_type start, pos_type end);
254 /// reject changes within the given range
255 void rejectChanges(pos_type start, pos_type end);
257 /// Paragraphs can contain "manual labels", for example, Description
258 /// environment. The text for this user-editable label is stored in
259 /// the paragraph alongside the text of the rest of the paragraph
260 /// (the body). This function returns the starting position of the
261 /// body of the text in the paragraph.
262 pos_type beginOfBody() const;
263 /// recompute this value
264 void setBeginOfBody();
267 docstring expandLabel(Layout const &, BufferParams const &) const;
269 docstring expandDocBookLabel(Layout const &, BufferParams const &) const;
271 docstring const & labelString() const;
272 /// the next two functions are for the manual labels
273 docstring const getLabelWidthString() const;
274 /// Set label width string.
275 void setLabelWidthString(docstring const & s);
276 /// Actual paragraph alignment used
277 char getAlign() const;
278 /// The nesting depth of a paragraph
279 depth_type getDepth() const;
280 /// The maximal possible depth of a paragraph after this one
281 depth_type getMaxDepthAfter() const;
283 void applyLayout(Layout const & new_layout);
285 /// (logically) erase the char at pos; return true if it was actually erased
286 bool eraseChar(pos_type pos, bool trackChanges);
287 /// (logically) erase the given range; return the number of chars actually erased
288 int eraseChars(pos_type start, pos_type end, bool trackChanges);
291 void resetFonts(Font const & font);
293 /** Get uninstantiated font setting. Returns the difference
294 between the characters font and the layoutfont.
295 This is what is stored in the fonttable
298 getFontSettings(BufferParams const &, pos_type pos) const;
300 Font const & getFirstFontSettings(BufferParams const &) const;
302 /** Get fully instantiated font. If pos == -1, use the layout
303 font attached to this paragraph.
304 If pos == -2, use the label font of the layout attached here.
305 In all cases, the font is instantiated, i.e. does not have any
306 attributes with values FONT_INHERIT, FONT_IGNORE or
309 Font const getFont(BufferParams const &, pos_type pos,
310 Font const & outerfont) const;
311 Font const getLayoutFont(BufferParams const &,
312 Font const & outerfont) const;
313 Font const getLabelFont(BufferParams const &,
314 Font const & outerfont) const;
316 * The font returned by the above functions is the same in a
317 * span of characters. This method will return the first and
318 * the last positions in the paragraph for which that font is
319 * the same. This can be used to avoid unnecessary calls to getFont.
321 FontSpan fontSpan(pos_type pos) const;
323 char_type getChar(pos_type pos) const;
324 /// Get the char, but mirror all bracket characters if it is right-to-left
325 char_type getUChar(BufferParams const &, pos_type pos) const;
326 /// pos <= size() (there is a dummy font change at the end of each par)
327 void setFont(pos_type pos, Font const & font);
328 /// Returns the height of the highest font in range
329 FontSize highestFontInRange(pos_type startpos,
330 pos_type endpos, FontSize def_size) const;
332 void insert(pos_type pos, docstring const & str,
333 Font const & font, Change const & change);
336 void appendString(docstring const & s, Font const & font,
337 Change const & change);
339 void appendChar(char_type c, Font const & font, Change const & change);
341 void insertChar(pos_type pos, char_type c, bool trackChanges);
343 void insertChar(pos_type pos, char_type c,
344 Font const &, bool trackChanges);
346 void insertChar(pos_type pos, char_type c,
347 Font const &, Change const & change);
348 /// Insert \p inset at position \p pos with \p change traking status.
349 /// \return true if successful.
350 bool insertInset(pos_type pos, Inset * inset,
351 Change const & change);
352 /// Insert \p inset at position \p pos with \p change traking status and
354 /// \return true if successful.
355 bool insertInset(pos_type pos, Inset * inset,
356 Font const & font, Change const & change);
358 Inset * getInset(pos_type pos);
360 Inset const * getInset(pos_type pos) const;
362 /// Release inset at given position.
363 /// \warning does not honour change tracking!
364 /// Therefore, it should only be used for breaking and merging
366 Inset * releaseInset(pos_type pos);
369 InsetList const & insetList() const;
371 void setBuffer(Buffer &);
374 bool isHfill(pos_type pos) const;
376 /// hinted by profiler
377 bool isInset(pos_type pos) const;
379 bool isNewline(pos_type pos) const;
380 /// return true if the char is a word separator
381 bool isSeparator(pos_type pos) const;
383 bool isLineSeparator(pos_type pos) const;
384 /// True if the character/inset at this point is a word separator.
385 /// Note that digits in particular are not considered as word separator.
386 bool isWordSeparator(pos_type pos) const;
387 /// True if the element at this point is a character that is not a letter.
388 bool isChar(pos_type pos) const;
389 /// True if the element at this point is a space
390 bool isSpace(pos_type pos) const;
392 /// returns true if at least one line break or line separator has been deleted
393 /// at the beginning of the paragraph (either physically or logically)
394 bool stripLeadingSpaces(bool trackChanges);
396 /// return true if we allow multiple spaces
397 bool isFreeSpacing() const;
399 /// return true if we allow this par to stay empty
400 bool allowEmpty() const;
402 char_type transformChar(char_type c, pos_type pos) const;
404 ParagraphParameters & params();
406 ParagraphParameters const & params() const;
408 /// Check if we are in a Biblio environment and insert or
409 /// delete InsetBibitems as necessary.
410 /// \retval int 1, if we had to add an inset, in which case
411 /// the cursor will need to move cursor forward; -pos, if we deleted
412 /// an inset, in which case pos is the position from which the inset
413 /// was deleted, and the cursor will need to be moved back one if it
414 /// was previously past that position. Return 0 otherwise.
415 int checkBiblio(Buffer const & buffer);
417 /// For each author, set 'used' to true if there is a change
418 /// by this author in the paragraph.
419 void checkAuthors(AuthorList const & authorList);
422 void changeCase(BufferParams const & bparams, pos_type pos,
423 pos_type & right, TextCase action);
425 /// find \param str string inside Paragraph.
426 /// \return true if the specified string is at the specified position
427 /// \param del specifies whether deleted strings in ct mode will be considered
429 docstring const & str, ///< string to search
432 pos_type pos, ///< start from here.
433 bool del = true) const;
435 void locateWord(pos_type & from, pos_type & to,
436 word_location const loc) const;
440 /// Spellcheck word at position \p from and fill in found misspelled word
441 /// and \p suggestions if \p do_suggestion is true.
442 /// \return result from spell checker, SpellChecker::UNKNOWN_WORD when misspelled.
443 SpellChecker::Result spellCheck(pos_type & from, pos_type & to, WordLangTuple & wl,
444 docstring_list & suggestions, bool do_suggestion = true,
445 bool check_learned = false) const;
447 /// Spell checker status at position \p pos.
448 /// \return true if pointed position is misspelled.
449 bool isMisspelled(pos_type pos) const;
451 /// spell check of whole paragraph
452 /// remember results until call of requestSpellCheck()
453 void spellCheck() const;
455 /// query state of spell checker results
456 bool needsSpellCheck() const;
457 /// mark position of text manipulation to inform the spell checker
458 /// default value -1 marks the whole paragraph to be checked (again)
459 void requestSpellCheck(pos_type pos = -1);
461 /// an automatically generated identifying label for this paragraph.
462 /// presently used only in the XHTML output routines.
463 std::string magicLabel() const;
466 /// Expand the counters for the labelstring of \c layout
467 docstring expandParagraphLabel(Layout const &, BufferParams const &,
468 bool process_appendix) const;
470 void deregisterWords();
474 void registerWords();
479 friend class Paragraph::Private;
486 #endif // PARAGRAPH_H