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 "support/strfwd.h"
23 #include "support/types.h"
49 class ParagraphParameters;
56 /// Invalid font span containing no character
57 FontSpan() : first(0), last(-1) {}
58 /// Span including first and last
59 FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
62 /// Range including first and last.
65 inline bool operator<(FontSpan const & s) const
67 return first < s.first;
70 inline bool operator==(FontSpan const & s) const
72 return first == s.first && last == s.last;
75 inline bool contains(pos_type p) const
77 return first <= p && p <= last;
80 inline size_t size() const
82 return empty() ? 0 : last - first;
86 inline FontSpan intersect(FontSpan const & f) const
88 FontSpan result = FontSpan();
89 if (contains(f.first))
90 result.first = f.first;
91 else if (f.contains(first))
97 else if (f.contains(last))
102 inline bool empty() const
113 text_capitalization = 1,
120 enum AsStringParameter
122 AS_STR_NONE = 0, ///< No option, only printable characters.
123 AS_STR_LABEL = 1, ///< Prefix with paragraph label.
124 AS_STR_INSETS = 2, ///< Go into insets.
125 AS_STR_NEWLINES = 4, ///< Get also newline characters.
126 AS_STR_SKIPDELETE = 8, ///< Skip deleted text in change tracking.
127 AS_STR_PLAINTEXT = 16 ///< Don't export formatting when descending into insets.
131 /// A Paragraph holds all text, attributes and insets in a text paragraph
137 /// Copy constructor.
138 Paragraph(Paragraph const &);
139 /// Partial copy constructor.
140 /// Copy the Paragraph contents from \p beg to \p end (without end).
141 Paragraph(Paragraph const & par, pos_type beg, pos_type end);
143 Paragraph & operator=(Paragraph const &);
152 void addChangesToToc(DocIterator const & cdit, Buffer const & buf,
153 bool output_active) const;
154 /// set the buffer flag if there are changes in the paragraph
155 void addChangesToBuffer(Buffer const & buf) const;
157 bool isChangeUpdateRequired() const;
159 Language const * getParLanguage(BufferParams const &) const;
161 bool isRTL(BufferParams const &) const;
163 void changeLanguage(BufferParams const & bparams,
164 Language const * from, Language const * to);
166 bool isMultiLingual(BufferParams const &) const;
168 void getLanguages(std::set<Language const *> &) const;
170 /// Convert the paragraph to a string.
171 /// \param AsStringParameter options. This can contain any combination of
172 /// asStringParameter values. Valid examples:
173 /// asString(AS_STR_LABEL)
174 /// asString(AS_STR_LABEL | AS_STR_INSETS)
175 /// asString(AS_STR_INSETS)
176 docstring asString(int options = AS_STR_NONE) const;
178 /// Convert the paragraph to a string.
179 /// \note If options includes AS_STR_PLAINTEXT, then runparams must be != 0
180 docstring asString(pos_type beg, pos_type end,
181 int options = AS_STR_NONE,
182 const OutputParams *runparams = 0) const;
184 void forOutliner(docstring &, size_t maxlen, bool shorten = true,
185 bool label = true) const;
188 void write(std::ostream &, BufferParams const &,
189 depth_type & depth) const;
191 void validate(LaTeXFeatures &) const;
193 /// \param force means: output even if layout.inpreamble is true.
194 void latex(BufferParams const &, Font const & outerfont, otexstream &,
195 OutputParams const &, int start_pos = 0, int end_pos = -1,
196 bool force = false) const;
198 /// Can we drop the standard paragraph wrapper?
199 bool emptyTag() const;
201 /// Get the id of the paragraph, usefull for docbook
202 std::string getID(Buffer const & buf, OutputParams const & runparams) const;
204 /// Output the first word of a paragraph, return the position where it left.
205 pos_type firstWordDocBook(odocstream & os, OutputParams const & runparams) const;
207 /// Output the first word of a paragraph, return the position where it left.
208 pos_type firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams) const;
210 /// Writes to stream the docbook representation
211 void simpleDocBookOnePar(Buffer const & buf,
213 OutputParams const & runparams,
214 Font const & outerfont,
215 pos_type initial = 0) const;
216 /// \return any material that has had to be deferred until after the
217 /// paragraph has closed.
218 docstring simpleLyXHTMLOnePar(Buffer const & buf,
220 OutputParams const & runparams,
221 Font const & outerfont,
222 bool start_paragraph = true,
223 bool close_paragraph = true,
224 pos_type initial = 0) const;
227 bool hasSameLayout(Paragraph const & par) const;
230 void makeSameLayout(Paragraph const & par);
233 void setInsetOwner(Inset const * inset);
235 Inset const & inInset() const;
237 bool allowParagraphCustomization() const;
239 bool usePlainLayout() const;
241 bool isPassThru() const;
243 pos_type size() const;
248 Layout const & layout() const;
249 /// Do not pass a temporary to this!
250 void setLayout(Layout const & layout);
252 void setPlainOrDefaultLayout(DocumentClass const & tc);
254 void setDefaultLayout(DocumentClass const & tc);
256 void setPlainLayout(DocumentClass const & tc);
258 /// This is the item depth, only used by enumerate and itemize
259 signed char itemdepth;
261 /// look up change at given pos
262 Change const & lookupChange(pos_type pos) const;
264 /// is there a change within the given range ?
265 bool isChanged(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 an insertion at the given pos ?
269 bool isInserted(pos_type pos) const;
270 /// is there a deletion at the given pos ?
271 bool isDeleted(pos_type pos) const;
272 /// is the whole paragraph deleted ?
273 bool isDeleted(pos_type start, pos_type end) const;
275 /// will the paragraph be physically merged with the next
276 /// one if the imaginary end-of-par character is logically deleted?
277 bool isMergedOnEndOfParDeletion(bool trackChanges) const;
279 /// set change for the entire par
280 void setChange(Change const & change);
282 /// set change at given pos
283 void setChange(pos_type pos, Change const & change);
285 /// accept changes within the given range
286 void acceptChanges(pos_type start, pos_type end);
288 /// reject changes within the given range
289 void rejectChanges(pos_type start, pos_type end);
291 /// Paragraphs can contain "manual labels", for example, Description
292 /// environment. The text for this user-editable label is stored in
293 /// the paragraph alongside the text of the rest of the paragraph
294 /// (the body). This function returns the starting position of the
295 /// body of the text in the paragraph.
296 pos_type beginOfBody() const;
297 /// recompute this value
298 void setBeginOfBody();
301 docstring expandLabel(Layout const &, BufferParams const &) const;
303 docstring expandDocBookLabel(Layout const &, BufferParams const &) const;
305 docstring const & labelString() const;
306 /// the next two functions are for the manual labels
307 docstring const getLabelWidthString() const;
308 /// Set label width string.
309 void setLabelWidthString(docstring const & s);
310 /// Actual paragraph alignment used
311 char getAlign() const;
312 /// The nesting depth of a paragraph
313 depth_type getDepth() const;
314 /// The maximal possible depth of a paragraph after this one
315 depth_type getMaxDepthAfter() const;
317 void applyLayout(Layout const & new_layout);
319 /// (logically) erase the char at pos; return true if it was actually erased
320 bool eraseChar(pos_type pos, bool trackChanges);
321 /// (logically) erase the given range; return the number of chars actually erased
322 int eraseChars(pos_type start, pos_type end, bool trackChanges);
325 void resetFonts(Font const & font);
327 /** Get uninstantiated font setting. Returns the difference
328 between the characters font and the layoutfont.
329 This is what is stored in the fonttable
332 getFontSettings(BufferParams const &, pos_type pos) const;
334 Font const & getFirstFontSettings(BufferParams const &) const;
336 /** Get fully instantiated font. If pos == -1, use the layout
337 font attached to this paragraph.
338 If pos == -2, use the label font of the layout attached here.
339 In all cases, the font is instantiated, i.e. does not have any
340 attributes with values FONT_INHERIT, FONT_IGNORE or
343 Font const getFont(BufferParams const &, pos_type pos,
344 Font const & outerfont) const;
345 Font const getLayoutFont(BufferParams const &,
346 Font const & outerfont) const;
347 Font const getLabelFont(BufferParams const &,
348 Font const & outerfont) const;
350 * The font returned by the above functions is the same in a
351 * span of characters. This method will return the first and
352 * the last positions in the paragraph for which that font is
353 * the same. This can be used to avoid unnecessary calls to getFont.
355 FontSpan fontSpan(pos_type pos) const;
357 char_type getChar(pos_type pos) const;
358 /// Get the char, but mirror all bracket characters if it is right-to-left
359 char_type getUChar(BufferParams const &, pos_type pos) const;
360 /// pos <= size() (there is a dummy font change at the end of each par)
361 void setFont(pos_type pos, Font const & font);
363 void insert(pos_type pos, docstring const & str,
364 Font const & font, Change const & change);
367 void appendString(docstring const & s, Font const & font,
368 Change const & change);
370 void appendChar(char_type c, Font const & font, Change const & change);
372 void insertChar(pos_type pos, char_type c, bool trackChanges);
374 void insertChar(pos_type pos, char_type c,
375 Font const &, bool trackChanges);
377 void insertChar(pos_type pos, char_type c,
378 Font const &, Change const & change);
379 /// Insert \p inset at position \p pos with \p change traking status and
381 /// \return true if successful.
382 bool insertInset(pos_type pos, Inset * inset,
383 Font const & font, Change const & change);
385 Inset * getInset(pos_type pos);
387 Inset const * getInset(pos_type pos) const;
389 /// Release inset at given position.
390 /// \warning does not honour change tracking!
391 /// Therefore, it should only be used for breaking and merging
393 Inset * releaseInset(pos_type pos);
396 InsetList const & insetList() const;
398 void setBuffer(Buffer &);
403 bool isHfill(pos_type pos) const;
405 /// hinted by profiler
406 bool isInset(pos_type pos) const;
408 bool isNewline(pos_type pos) const;
410 bool isEnvSeparator(pos_type pos) const;
411 /// return true if the char is a word separator
412 bool isSeparator(pos_type pos) const;
414 bool isLineSeparator(pos_type pos) const;
415 /// True if the character/inset at this point is a word separator.
416 /// Note that digits in particular are not considered as word separator.
417 bool isWordSeparator(pos_type pos) const;
418 /// True if the element at this point is a character that is not a letter.
419 bool isChar(pos_type pos) const;
420 /// True if the element at this point is a space
421 bool isSpace(pos_type pos) const;
422 /// True if the element at this point is a hard hyphen or a apostrophe
423 /// If it is enclosed by spaces return false
424 bool isHardHyphenOrApostrophe(pos_type pos) const;
426 /// returns true if at least one line break or line separator has been deleted
427 /// at the beginning of the paragraph (either physically or logically)
428 bool stripLeadingSpaces(bool trackChanges);
430 /// return true if we allow multiple spaces
431 bool isFreeSpacing() const;
433 /// return true if we allow this par to stay empty
434 bool allowEmpty() const;
436 ParagraphParameters & params();
438 ParagraphParameters const & params() const;
440 /// Check whether a call to fixBiblio is needed.
441 bool brokenBiblio() const;
442 /// Check if we are in a Biblio environment and insert or
443 /// delete InsetBibitems as necessary.
444 /// \retval int 1, if we had to add an inset, in which case
445 /// the cursor will need to move cursor forward; -pos, if we deleted
446 /// an inset, in which case pos is the position from which the inset
447 /// was deleted, and the cursor will need to be moved back one if it
448 /// was previously past that position. Return 0 otherwise.
449 int fixBiblio(Buffer const & buffer);
451 /// For each author, set 'used' to true if there is a change
452 /// by this author in the paragraph.
453 void checkAuthors(AuthorList const & authorList);
456 void changeCase(BufferParams const & bparams, pos_type pos,
457 pos_type & right, TextCase action);
459 /// find \param str string inside Paragraph.
460 /// \return non-zero if the specified string is at the specified
461 /// position; returned value is the actual match length in positions
462 /// \param del specifies whether deleted strings in ct mode will be considered
464 docstring const & str, ///< string to search
467 pos_type pos, ///< start from here.
468 bool del = true) const;
470 void locateWord(pos_type & from, pos_type & to,
471 word_location const loc) const;
475 /// Spellcheck word at position \p from and fill in found misspelled word
476 /// and \p suggestions if \p do_suggestion is true.
477 /// \return result from spell checker, SpellChecker::UNKNOWN_WORD when misspelled.
478 SpellChecker::Result spellCheck(pos_type & from, pos_type & to, WordLangTuple & wl,
479 docstring_list & suggestions, bool do_suggestion = true,
480 bool check_learned = false) const;
482 /// Spell checker status at position \p pos.
483 /// If \p check_boundary is true the status of position immediately
484 /// before \p pos is tested too if it is at word boundary.
485 /// \return true if one of the tested positions is misspelled.
486 bool isMisspelled(pos_type pos, bool check_boundary = false) const;
488 /// \return the spell range (misspelled area) around position.
489 /// Range is empty if word at position is correctly spelled.
490 FontSpan const & getSpellRange(pos_type pos) const;
492 /// spell check of whole paragraph
493 /// remember results until call of requestSpellCheck()
494 void spellCheck() const;
496 /// query state of spell checker results
497 bool needsSpellCheck() const;
498 /// mark position of text manipulation to inform the spell checker
499 /// default value -1 marks the whole paragraph to be checked (again)
500 void requestSpellCheck(pos_type pos = -1);
502 /// an automatically generated identifying label for this paragraph.
503 /// presently used only in the XHTML output routines.
504 std::string magicLabel() const;
507 /// Expand the counters for the labelstring of \c layout
508 docstring expandParagraphLabel(Layout const &, BufferParams const &,
509 bool process_appendix) const;
511 void deregisterWords();
515 void registerWords();
520 friend class Paragraph::Private;
527 #endif // PARAGRAPH_H