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 "LayoutEnums.h"
20 #include "SpellChecker.h"
22 #include "support/strfwd.h"
23 #include "support/types.h"
44 class ParagraphParameters;
50 /// Inset identifier (above 0x10ffff, for ucs-4)
51 char_type const META_INSET = 0x200001;
55 /// Invalid font span containing no character
56 FontSpan() : first(0), last(-1) {}
57 /// Span including first and last
58 FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
61 /// Range including first and last.
64 inline bool operator<(FontSpan const & s) const
66 return first < s.first;
69 inline bool operator==(FontSpan const & s) const
71 return first == s.first && last == s.last;
74 inline bool contains(pos_type p) const
76 return first <= p && p <= last;
79 inline size_t size() const
81 return empty() ? 0 : last - first;
85 inline FontSpan intersect(FontSpan const & f) const
87 FontSpan result = FontSpan();
88 if (contains(f.first))
89 result.first = f.first;
90 else if (f.contains(first))
96 else if (f.contains(last))
101 inline bool empty() const
112 text_capitalization = 1,
119 enum AsStringParameter
121 AS_STR_NONE = 0, ///< No option, only printable characters.
122 AS_STR_LABEL = 1, ///< Prefix with paragraph label.
123 AS_STR_INSETS = 2, ///< Go into insets.
124 AS_STR_NEWLINES = 4, ///< Get also newline characters.
125 AS_STR_SKIPDELETE = 8, ///< Skip deleted text in change tracking.
126 AS_STR_PLAINTEXT = 16 ///< Don't export formatting when descending into insets.
130 /// A Paragraph holds all text, attributes and insets in a text paragraph
136 /// Copy constructor.
137 Paragraph(Paragraph const &);
138 /// Partial copy constructor.
139 /// Copy the Paragraph contents from \p beg to \p end (without end).
140 Paragraph(Paragraph const & par, pos_type beg, pos_type end);
142 Paragraph & operator=(Paragraph const &);
151 void addChangesToToc(DocIterator const & cdit, Buffer const & buf,
152 bool output_active, TocBackend & backend) const;
154 Language const * getParLanguage(BufferParams const &) const;
156 bool isRTL(BufferParams const &) const;
158 void changeLanguage(BufferParams const & bparams,
159 Language const * from, Language const * to);
161 bool isMultiLingual(BufferParams const &) const;
163 void getLanguages(std::set<Language const *> &) const;
165 /// Convert the paragraph to a string.
166 /// \param AsStringParameter options. This can contain any combination of
167 /// asStringParameter values. Valid examples:
168 /// asString(AS_STR_LABEL)
169 /// asString(AS_STR_LABEL | AS_STR_INSETS)
170 /// asString(AS_STR_INSETS)
171 docstring asString(int options = AS_STR_NONE) const;
173 /// Convert the paragraph to a string.
174 /// \note If options includes AS_STR_PLAINTEXT, then runparams must be != 0
175 docstring asString(pos_type beg, pos_type end,
176 int options = AS_STR_NONE,
177 const OutputParams *runparams = 0) const;
179 void forOutliner(docstring &, size_t maxlen, bool shorten = true,
180 bool label = true) const;
183 void write(std::ostream &, BufferParams const &,
184 depth_type & depth) const;
186 void validate(LaTeXFeatures &) const;
188 /// \param force means: output even if layout.inpreamble is true.
189 void latex(BufferParams const &, Font const & outerfont, otexstream &,
190 OutputParams const &, int start_pos = 0, int end_pos = -1,
191 bool force = false) const;
193 /// Can we drop the standard paragraph wrapper?
194 bool emptyTag() const;
196 /// Get the id of the paragraph, usefull for docbook
197 std::string getID(Buffer const & buf, OutputParams const & runparams) const;
199 /// Output the first word of a paragraph, return the position where it left.
200 pos_type firstWordDocBook(XMLStream & xs, OutputParams const & runparams) const;
202 /// Output the first word of a paragraph, return the position where it left.
203 pos_type firstWordLyXHTML(XMLStream & xs, OutputParams const & runparams) const;
205 /// Outputs to stream the DocBook representation, one element per paragraph.
206 std::vector<docstring> simpleDocBookOnePar(Buffer const & buf,
207 OutputParams const & runparams,
208 Font const & outerfont,
209 pos_type initial = 0,
210 bool is_last_par = false,
211 bool ignore_fonts = false) const;
213 /// \return any material that has had to be deferred until after the
214 /// paragraph has closed.
215 docstring simpleLyXHTMLOnePar(Buffer const & buf,
217 OutputParams const & runparams,
218 Font const & outerfont,
219 bool start_paragraph = true,
220 bool close_paragraph = true,
221 pos_type initial = 0) const;
224 bool hasSameLayout(Paragraph const & par) const;
227 void makeSameLayout(Paragraph const & par);
230 void setInsetOwner(Inset const * inset);
232 Inset const & inInset() const;
234 bool allowParagraphCustomization() const;
236 bool usePlainLayout() const;
238 bool isPassThru() const;
240 pos_type size() const;
245 Layout const & layout() const;
246 /// Do not pass a temporary to this!
247 void setLayout(Layout const & layout);
249 void setPlainOrDefaultLayout(DocumentClass const & tc);
251 void setDefaultLayout(DocumentClass const & tc);
253 void setPlainLayout(DocumentClass const & tc);
255 /// This is the item depth, only used by enumerate and itemize
256 signed char itemdepth;
258 /// look up change at given pos
259 Change const & lookupChange(pos_type pos) const;
261 /// is there a change within the given range (does not
262 /// check contained paragraphs)
263 bool isChanged(pos_type start, pos_type end) const;
264 /// Are there insets containing changes in the range?
265 bool hasChangedInsets(pos_type start, pos_type end) const;
266 /// is there an unchanged char at the given pos ?
267 bool isChanged(pos_type pos) const;
268 /// is there a change in the paragraph ?
269 bool isChanged() const;
271 /// is there an insertion at the given pos ?
272 bool isInserted(pos_type pos) const;
273 /// is there a deletion at the given pos ?
274 bool isDeleted(pos_type pos) const;
275 /// is the whole paragraph deleted ?
276 bool isDeleted(pos_type start, pos_type end) const;
278 /// will the paragraph be physically merged with the next
279 /// one if the imaginary end-of-par character is logically deleted?
280 bool isMergedOnEndOfParDeletion(bool trackChanges) const;
281 /// Return Change form of paragraph break
282 Change parEndChange() const;
284 /// set change for the entire par
285 void setChange(Change const & change);
287 /// set change at given pos
288 void setChange(pos_type pos, Change const & change);
290 /// accept changes within the given range
291 void acceptChanges(pos_type start, pos_type end);
293 /// reject changes within the given range
294 void rejectChanges(pos_type start, pos_type end);
296 /// Paragraphs can contain "manual labels", for example, Description
297 /// environment. The text for this user-editable label is stored in
298 /// the paragraph alongside the text of the rest of the paragraph
299 /// (the body). This function returns the starting position of the
300 /// body of the text in the paragraph.
301 pos_type beginOfBody() const;
302 /// recompute this value
303 void setBeginOfBody();
306 docstring expandLabel(Layout const &, BufferParams const &) const;
308 docstring const & labelString() const;
309 /// the next two functions are for the manual labels
310 docstring const getLabelWidthString() const;
311 /// Set label width string.
312 void setLabelWidthString(docstring const & s);
313 /// Actual paragraph alignment used
314 LyXAlignment getAlign(BufferParams const &) const;
315 /// Default paragraph alignment as determined by layout
316 LyXAlignment getDefaultAlign(BufferParams const &) const;
317 /// The nesting depth of a paragraph
318 depth_type getDepth() const;
319 /// The maximal possible depth of a paragraph after this one
320 depth_type getMaxDepthAfter() const;
322 void applyLayout(Layout const & new_layout);
324 /// (logically) erase the char at pos; return true if it was actually erased
325 bool eraseChar(pos_type pos, bool trackChanges);
326 /// (logically) erase the given range; return the number of chars actually erased
327 int eraseChars(pos_type start, pos_type end, bool trackChanges);
330 void resetFonts(Font const & font);
332 /** Get uninstantiated font setting. Returns the difference
333 between the characters font and the layoutfont.
334 This is what is stored in the fonttable
337 getFontSettings(BufferParams const &, pos_type pos) const;
339 Font const & getFirstFontSettings(BufferParams const &) const;
341 /** Get fully instantiated font, i.e., one that does not have any
342 attributes with values FONT_INHERIT, FONT_IGNORE or FONT_TOGGLE.
344 Font const getFont(BufferParams const &, pos_type pos,
345 Font const & outerfont) const;
346 Font const getLayoutFont(BufferParams const &,
347 Font const & outerfont) const;
348 Font const getLabelFont(BufferParams const &,
349 Font const & outerfont) const;
351 * The font returned by the above functions is the same in a
352 * span of characters. This method will return the first and
353 * the last positions in the paragraph for which that font is
354 * the same. This can be used to avoid unnecessary calls to getFont.
356 FontSpan fontSpan(pos_type pos) const;
358 char_type getChar(pos_type pos) const;
359 /// Get the char, but mirror all bracket characters if it is right-to-left
360 char_type getUChar(BufferParams const &, OutputParams const &,
362 /// pos <= size() (there is a dummy font change at the end of each par)
363 void setFont(pos_type pos, Font const & font);
365 void insert(pos_type pos, docstring const & str,
366 Font const & font, Change const & change);
369 void appendString(docstring const & s, Font const & font,
370 Change const & change);
372 void appendChar(char_type c, Font const & font, Change const & change);
374 void insertChar(pos_type pos, char_type c, bool trackChanges);
376 void insertChar(pos_type pos, char_type c,
377 Font const &, bool trackChanges);
379 void insertChar(pos_type pos, char_type c,
380 Font const &, Change const & change);
381 /// Insert \p inset at position \p pos with \p change traking status and
383 /// \return true if successful.
384 bool insertInset(pos_type pos, Inset * inset,
385 Font const & font, Change const & change);
387 Inset * getInset(pos_type pos);
389 Inset const * getInset(pos_type pos) const;
391 /// Release inset at given position.
392 /// \warning does not honour change tracking!
393 /// Therefore, it should only be used for breaking and merging
395 Inset * releaseInset(pos_type pos);
398 InsetList const & insetList() const;
400 void setInsetBuffers(Buffer &);
405 bool isHfill(pos_type pos) const;
407 /// hinted by profiler
408 bool isInset(pos_type pos) const;
410 bool isNewline(pos_type pos) const;
412 bool isEnvSeparator(pos_type pos) const;
413 /// return true if the char is a word separator
414 bool isSeparator(pos_type pos) const;
416 bool isLineSeparator(pos_type pos) const;
417 /// True if the character/inset at this point is a word separator.
418 /// Note that digits in particular are not considered as word separator.
419 bool isWordSeparator(pos_type pos, bool const ignore_deleted = false) const;
420 /// True if the element at this point is a character that is not a letter.
421 bool isChar(pos_type pos) const;
422 /// True if the element at this point is a space
423 bool isSpace(pos_type pos) const;
424 /// True if the element at this point is a hard hyphen or a apostrophe
425 /// If it is enclosed by spaces return false
426 bool isHardHyphenOrApostrophe(pos_type pos) const;
427 /// Return true if this paragraph has verbatim content that needs to be
428 /// protected by \cprotect
429 bool needsCProtection(bool const fragile = false) const;
431 /// returns true if at least one line break or line separator has been deleted
432 /// at the beginning of the paragraph (either physically or logically)
433 bool stripLeadingSpaces(bool trackChanges);
435 /// return true if we allow multiple spaces
436 bool isFreeSpacing() const;
438 /// return true if we allow this par to stay empty
439 bool allowEmpty() const;
441 ParagraphParameters & params();
443 ParagraphParameters const & params() const;
445 /// Check whether a call to fixBiblio is needed.
446 bool brokenBiblio() const;
447 /// Check if we are in a Biblio environment and insert or
448 /// delete InsetBibitems as necessary.
449 /// \retval int 1, if we had to add an inset, in which case
450 /// the cursor will need to move cursor forward; -pos, if we deleted
451 /// an inset, in which case pos is the position from which the inset
452 /// was deleted, and the cursor will need to be moved back one if it
453 /// was previously past that position. Return 0 otherwise.
454 int fixBiblio(Buffer const & buffer);
456 /// For each author, set 'used' to true if there is a change
457 /// by this author in the paragraph.
458 void checkAuthors(AuthorList const & authorList);
461 void changeCase(BufferParams const & bparams, pos_type pos,
462 pos_type & right, TextCase action);
464 /// find \param str string inside Paragraph.
465 /// \return non-zero if the specified string is at the specified
466 /// position; returned value is the actual match length in positions
467 /// \param del specifies whether deleted strings in ct mode will be considered
469 docstring const & str, ///< string to search
472 pos_type pos, ///< start from here.
473 bool del = true) const;
475 void locateWord(pos_type & from, pos_type & to,
476 word_location const loc, bool const ignore_deleted = false) const;
480 /// Spellcheck word at position \p from and fill in found misspelled word
481 /// and \p suggestions if \p do_suggestion is true.
482 /// \return result from spell checker, SpellChecker::UNKNOWN_WORD when misspelled.
483 SpellChecker::Result spellCheck(pos_type & from, pos_type & to, WordLangTuple & wl,
484 docstring_list & suggestions, bool do_suggestion = true,
485 bool check_learned = false) const;
487 /// Spell checker status at position \p pos.
488 /// If \p check_boundary is true the status of position immediately
489 /// before \p pos is tested too if it is at word boundary.
490 /// \return true if one of the tested positions is misspelled.
491 bool isMisspelled(pos_type pos, bool check_boundary = false) const;
493 /// \return the spell range (misspelled area) around position.
494 /// Range is empty if word at position is correctly spelled.
495 FontSpan const & getSpellRange(pos_type pos) const;
497 /// spell check of whole paragraph
498 /// remember results until call of requestSpellCheck()
499 void spellCheck() const;
501 /// query state of spell checker results
502 bool needsSpellCheck() const;
503 /// mark position of text manipulation to inform the spell checker
504 /// default value -1 marks the whole paragraph to be checked (again)
505 void requestSpellCheck(pos_type pos = -1);
507 /// an automatically generated identifying label for this paragraph.
508 /// presently used only in the XHTML output routines.
509 std::string magicLabel() const;
511 /// anonymizes the paragraph contents (but not the paragraphs
512 /// contained inside it. Does not handle undo.
516 /// Expand the counters for the labelstring of \c layout
517 docstring expandParagraphLabel(Layout const &, BufferParams const &,
518 bool process_appendix) const;
520 void deregisterWords();
524 void registerWords();
529 friend class Paragraph::Private;
536 #endif // PARAGRAPH_H