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"
51 class ParagraphParameters;
59 /// Invalid font span containing no character
60 FontSpan() : first(0), last(-1) {}
61 /// Span including first and last
62 FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
65 /// Range including first and last.
68 inline bool operator<(FontSpan const & s) const
70 return first < s.first;
73 inline bool operator==(FontSpan const & s) const
75 return first == s.first && last == s.last;
78 inline bool contains(pos_type p) const
80 return first <= p && p <= last;
83 inline size_t size() const
85 return empty() ? 0 : last - first;
89 inline FontSpan intersect(FontSpan const & f) const
91 FontSpan result = FontSpan();
92 if (contains(f.first))
93 result.first = f.first;
94 else if (f.contains(first))
100 else if (f.contains(last))
105 inline bool empty() const
116 text_capitalization = 1,
123 enum AsStringParameter
125 AS_STR_NONE = 0, ///< No option, only printable characters.
126 AS_STR_LABEL = 1, ///< Prefix with paragraph label.
127 AS_STR_INSETS = 2, ///< Go into insets.
128 AS_STR_NEWLINES = 4, ///< Get also newline characters.
129 AS_STR_SKIPDELETE = 8, ///< Skip deleted text in change tracking.
130 AS_STR_PLAINTEXT = 16 ///< Don't export formatting when descending into insets.
134 /// A Paragraph holds all text, attributes and insets in a text paragraph
140 /// Copy constructor.
141 Paragraph(Paragraph const &);
142 /// Partial copy constructor.
143 /// Copy the Paragraph contents from \p beg to \p end (without end).
144 Paragraph(Paragraph const & par, pos_type beg, pos_type end);
146 Paragraph & operator=(Paragraph const &);
155 void addChangesToToc(DocIterator const & cdit, Buffer const & buf,
156 bool output_active) const;
157 /// set the buffer flag if there are changes in the paragraph
158 void addChangesToBuffer(Buffer const & buf) const;
160 bool isChangeUpdateRequired() const;
162 Language const * getParLanguage(BufferParams const &) const;
164 bool isRTL(BufferParams const &) const;
166 void changeLanguage(BufferParams const & bparams,
167 Language const * from, Language const * to);
169 bool isMultiLingual(BufferParams const &) const;
171 void getLanguages(std::set<Language const *> &) const;
173 /// Convert the paragraph to a string.
174 /// \param AsStringParameter options. This can contain any combination of
175 /// asStringParameter values. Valid examples:
176 /// asString(AS_STR_LABEL)
177 /// asString(AS_STR_LABEL | AS_STR_INSETS)
178 /// asString(AS_STR_INSETS)
179 docstring asString(int options = AS_STR_NONE) const;
181 /// Convert the paragraph to a string.
182 /// \note If options includes AS_STR_PLAINTEXT, then runparams must be != 0
183 docstring asString(pos_type beg, pos_type end,
184 int options = AS_STR_NONE,
185 const OutputParams *runparams = 0) const;
187 void forOutliner(docstring &, size_t const maxlen,
188 bool const shorten = true) const;
191 void write(std::ostream &, BufferParams const &,
192 depth_type & depth) const;
194 void validate(LaTeXFeatures &) const;
196 /// \param force means: output even if layout.inpreamble is true.
197 void latex(BufferParams const &, Font const & outerfont, otexstream &,
198 OutputParams const &, int start_pos = 0, int end_pos = -1,
199 bool force = false) const;
201 /// Can we drop the standard paragraph wrapper?
202 bool emptyTag() const;
204 /// Get the id of the paragraph, usefull for docbook
205 std::string getID(Buffer const & buf, OutputParams const & runparams) const;
207 /// Output the first word of a paragraph, return the position where it left.
208 pos_type firstWordDocBook(odocstream & os, OutputParams const & runparams) const;
210 /// Output the first word of a paragraph, return the position where it left.
211 pos_type firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams) const;
213 /// Writes to stream the docbook representation
214 void simpleDocBookOnePar(Buffer const & buf,
216 OutputParams const & runparams,
217 Font const & outerfont,
218 pos_type initial = 0) const;
219 /// \return any material that has had to be deferred until after the
220 /// paragraph has closed.
221 docstring simpleLyXHTMLOnePar(Buffer const & buf,
223 OutputParams const & runparams,
224 Font const & outerfont,
225 bool start_paragraph = true,
226 bool close_paragraph = true,
227 pos_type initial = 0) const;
230 bool hasSameLayout(Paragraph const & par) const;
233 void makeSameLayout(Paragraph const & par);
236 void setInsetOwner(Inset const * inset);
238 Inset const & inInset() const;
240 bool allowParagraphCustomization() const;
242 bool usePlainLayout() const;
244 bool isPassThru() const;
246 pos_type size() const;
251 Layout const & layout() const;
252 /// Do not pass a temporary to this!
253 void setLayout(Layout const & layout);
255 void setPlainOrDefaultLayout(DocumentClass const & tc);
257 void setDefaultLayout(DocumentClass const & tc);
259 void setPlainLayout(DocumentClass const & tc);
261 /// This is the item depth, only used by enumerate and itemize
262 signed char itemdepth;
264 /// look up change at given pos
265 Change const & lookupChange(pos_type pos) const;
267 /// is there a change within the given range ?
268 bool isChanged(pos_type start, pos_type end) const;
269 /// is there an unchanged char at the given pos ?
270 bool isChanged(pos_type pos) 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;
282 /// set change for the entire par
283 void setChange(Change const & change);
285 /// set change at given pos
286 void setChange(pos_type pos, Change const & change);
288 /// accept changes within the given range
289 void acceptChanges(pos_type start, pos_type end);
291 /// reject changes within the given range
292 void rejectChanges(pos_type start, pos_type end);
294 /// Paragraphs can contain "manual labels", for example, Description
295 /// environment. The text for this user-editable label is stored in
296 /// the paragraph alongside the text of the rest of the paragraph
297 /// (the body). This function returns the starting position of the
298 /// body of the text in the paragraph.
299 pos_type beginOfBody() const;
300 /// recompute this value
301 void setBeginOfBody();
304 docstring expandLabel(Layout const &, BufferParams const &) const;
306 docstring expandDocBookLabel(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 char getAlign() const;
315 /// The nesting depth of a paragraph
316 depth_type getDepth() const;
317 /// The maximal possible depth of a paragraph after this one
318 depth_type getMaxDepthAfter() const;
320 void applyLayout(Layout const & new_layout);
322 /// (logically) erase the char at pos; return true if it was actually erased
323 bool eraseChar(pos_type pos, bool trackChanges);
324 /// (logically) erase the given range; return the number of chars actually erased
325 int eraseChars(pos_type start, pos_type end, bool trackChanges);
328 void resetFonts(Font const & font);
330 /** Get uninstantiated font setting. Returns the difference
331 between the characters font and the layoutfont.
332 This is what is stored in the fonttable
335 getFontSettings(BufferParams const &, pos_type pos) const;
337 Font const & getFirstFontSettings(BufferParams const &) const;
339 /** Get fully instantiated font. If pos == -1, use the layout
340 font attached to this paragraph.
341 If pos == -2, use the label font of the layout attached here.
342 In all cases, the font is instantiated, i.e. does not have any
343 attributes with values FONT_INHERIT, FONT_IGNORE or
346 Font const getFont(BufferParams const &, pos_type pos,
347 Font const & outerfont) const;
348 Font const getLayoutFont(BufferParams const &,
349 Font const & outerfont) const;
350 Font const getLabelFont(BufferParams const &,
351 Font const & outerfont) const;
353 * The font returned by the above functions is the same in a
354 * span of characters. This method will return the first and
355 * the last positions in the paragraph for which that font is
356 * the same. This can be used to avoid unnecessary calls to getFont.
358 FontSpan fontSpan(pos_type pos) const;
360 char_type getChar(pos_type pos) const;
361 /// Get the char, but mirror all bracket characters if it is right-to-left
362 char_type getUChar(BufferParams const &, pos_type pos) const;
363 /// pos <= size() (there is a dummy font change at the end of each par)
364 void setFont(pos_type pos, Font const & font);
365 /// Returns the height of the highest font in range
366 FontSize highestFontInRange(pos_type startpos,
367 pos_type endpos, FontSize def_size) const;
369 void insert(pos_type pos, docstring const & str,
370 Font const & font, Change const & change);
373 void appendString(docstring const & s, Font const & font,
374 Change const & change);
376 void appendChar(char_type c, Font const & font, Change const & change);
378 void insertChar(pos_type pos, char_type c, bool trackChanges);
380 void insertChar(pos_type pos, char_type c,
381 Font const &, bool trackChanges);
383 void insertChar(pos_type pos, char_type c,
384 Font const &, Change const & change);
385 /// Insert \p inset at position \p pos with \p change traking status and
387 /// \return true if successful.
388 bool insertInset(pos_type pos, Inset * inset,
389 Font const & font, Change const & change);
391 Inset * getInset(pos_type pos);
393 Inset const * getInset(pos_type pos) const;
395 /// Release inset at given position.
396 /// \warning does not honour change tracking!
397 /// Therefore, it should only be used for breaking and merging
399 Inset * releaseInset(pos_type pos);
402 InsetList const & insetList() const;
404 void setBuffer(Buffer &);
407 bool isHfill(pos_type pos) const;
409 /// hinted by profiler
410 bool isInset(pos_type pos) const;
412 bool isNewline(pos_type pos) const;
414 bool isEnvSeparator(pos_type pos) const;
415 /// return true if the char is a word separator
416 bool isSeparator(pos_type pos) const;
418 bool isLineSeparator(pos_type pos) const;
419 /// True if the character/inset at this point is a word separator.
420 /// Note that digits in particular are not considered as word separator.
421 bool isWordSeparator(pos_type pos) const;
422 /// True if the element at this point is a character that is not a letter.
423 bool isChar(pos_type pos) const;
424 /// True if the element at this point is a space
425 bool isSpace(pos_type pos) const;
426 /// True if the element at this point is a hard hyphen or a apostrophe
427 /// If it is enclosed by spaces return false
428 bool isHardHyphenOrApostrophe(pos_type pos) const;
430 /// returns true if at least one line break or line separator has been deleted
431 /// at the beginning of the paragraph (either physically or logically)
432 bool stripLeadingSpaces(bool trackChanges);
434 /// return true if we allow multiple spaces
435 bool isFreeSpacing() const;
437 /// return true if we allow this par to stay empty
438 bool allowEmpty() const;
440 ParagraphParameters & params();
442 ParagraphParameters const & params() const;
444 /// Check whether a call to fixBiblio is needed.
445 bool brokenBiblio() const;
446 /// Check if we are in a Biblio environment and insert or
447 /// delete InsetBibitems as necessary.
448 /// \retval int 1, if we had to add an inset, in which case
449 /// the cursor will need to move cursor forward; -pos, if we deleted
450 /// an inset, in which case pos is the position from which the inset
451 /// was deleted, and the cursor will need to be moved back one if it
452 /// was previously past that position. Return 0 otherwise.
453 int fixBiblio(Buffer const & buffer);
455 /// For each author, set 'used' to true if there is a change
456 /// by this author in the paragraph.
457 void checkAuthors(AuthorList const & authorList);
460 void changeCase(BufferParams const & bparams, pos_type pos,
461 pos_type & right, TextCase action);
463 /// find \param str string inside Paragraph.
464 /// \return non-zero if the specified string is at the specified
465 /// position; returned value is the actual match length in positions
466 /// \param del specifies whether deleted strings in ct mode will be considered
468 docstring const & str, ///< string to search
471 pos_type pos, ///< start from here.
472 bool del = true) const;
474 void locateWord(pos_type & from, pos_type & to,
475 word_location const loc) const;
479 /// Spellcheck word at position \p from and fill in found misspelled word
480 /// and \p suggestions if \p do_suggestion is true.
481 /// \return result from spell checker, SpellChecker::UNKNOWN_WORD when misspelled.
482 SpellChecker::Result spellCheck(pos_type & from, pos_type & to, WordLangTuple & wl,
483 docstring_list & suggestions, bool do_suggestion = true,
484 bool check_learned = false) const;
486 /// Spell checker status at position \p pos.
487 /// If \p check_boundary is true the status of position immediately
488 /// before \p pos is tested too if it is at word boundary.
489 /// \return true if one of the tested positions is misspelled.
490 bool isMisspelled(pos_type pos, bool check_boundary = false) const;
492 /// \return the spell range (misspelled area) around position.
493 /// Range is empty if word at position is correctly spelled.
494 FontSpan const & getSpellRange(pos_type pos) const;
496 /// spell check of whole paragraph
497 /// remember results until call of requestSpellCheck()
498 void spellCheck() const;
500 /// query state of spell checker results
501 bool needsSpellCheck() const;
502 /// mark position of text manipulation to inform the spell checker
503 /// default value -1 marks the whole paragraph to be checked (again)
504 void requestSpellCheck(pos_type pos = -1);
506 /// an automatically generated identifying label for this paragraph.
507 /// presently used only in the XHTML output routines.
508 std::string magicLabel() const;
511 /// Expand the counters for the labelstring of \c layout
512 docstring expandParagraphLabel(Layout const &, BufferParams const &,
513 bool process_appendix) const;
515 void deregisterWords();
519 void registerWords();
524 friend class Paragraph::Private;
531 #endif // PARAGRAPH_H