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;
57 /// Invalid font span containing no character
58 FontSpan() : first(0), last(-1) {}
59 /// Span including first and last
60 FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
63 /// Range including first and last.
66 inline bool operator<(FontSpan const & s) const
68 return first < s.first;
71 inline bool operator==(FontSpan const & s) const
73 return first == s.first && last == s.last;
76 inline bool contains(pos_type p) const
78 return first <= p && p <= last;
81 inline size_t size() const
83 return empty() ? 0 : last - first;
87 inline FontSpan intersect(FontSpan const & f) const
89 FontSpan result = FontSpan();
90 if (contains(f.first))
91 result.first = f.first;
92 else if (f.contains(first))
98 else if (f.contains(last))
103 inline bool empty() const
114 text_capitalization = 1,
121 enum AsStringParameter
123 AS_STR_NONE = 0, ///< No option, only printable characters.
124 AS_STR_LABEL = 1, ///< Prefix with paragraph label.
125 AS_STR_INSETS = 2, ///< Go into insets.
126 AS_STR_NEWLINES = 4, ///< Get also newline characters.
127 AS_STR_SKIPDELETE = 8, ///< Skip deleted text in change tracking.
128 AS_STR_PLAINTEXT = 16 ///< Don't export formatting when descending into insets.
132 /// A Paragraph holds all text, attributes and insets in a text paragraph
138 /// Copy constructor.
139 Paragraph(Paragraph const &);
140 /// Partial copy constructor.
141 /// Copy the Paragraph contents from \p beg to \p end (without end).
142 Paragraph(Paragraph const & par, pos_type beg, pos_type end);
144 Paragraph & operator=(Paragraph const &);
153 void addChangesToToc(DocIterator const & cdit, Buffer const & buf,
154 bool output_active, TocBackend & backend) const;
155 /// set the buffer flag if there are changes in the paragraph
156 void addChangesToBuffer(Buffer const & buf) const;
158 bool isChangeUpdateRequired() const;
160 Language const * getParLanguage(BufferParams const &) const;
162 bool isRTL(BufferParams const &) const;
164 void changeLanguage(BufferParams const & bparams,
165 Language const * from, Language const * to);
167 bool isMultiLingual(BufferParams const &) const;
169 void getLanguages(std::set<Language const *> &) const;
171 /// Convert the paragraph to a string.
172 /// \param AsStringParameter options. This can contain any combination of
173 /// asStringParameter values. Valid examples:
174 /// asString(AS_STR_LABEL)
175 /// asString(AS_STR_LABEL | AS_STR_INSETS)
176 /// asString(AS_STR_INSETS)
177 docstring asString(int options = AS_STR_NONE) const;
179 /// Convert the paragraph to a string.
180 /// \note If options includes AS_STR_PLAINTEXT, then runparams must be != 0
181 docstring asString(pos_type beg, pos_type end,
182 int options = AS_STR_NONE,
183 const OutputParams *runparams = 0) const;
185 void forOutliner(docstring &, size_t maxlen, bool shorten = true,
186 bool label = true) const;
189 void write(std::ostream &, BufferParams const &,
190 depth_type & depth) const;
192 void validate(LaTeXFeatures &) const;
194 /// \param force means: output even if layout.inpreamble is true.
195 void latex(BufferParams const &, Font const & outerfont, otexstream &,
196 OutputParams const &, int start_pos = 0, int end_pos = -1,
197 bool force = false) const;
199 /// Can we drop the standard paragraph wrapper?
200 bool emptyTag() const;
202 /// Get the id of the paragraph, usefull for docbook
203 std::string getID(Buffer const & buf, OutputParams const & runparams) const;
205 /// Output the first word of a paragraph, return the position where it left.
206 pos_type firstWordDocBook(odocstream & os, OutputParams const & runparams) const;
208 /// Output the first word of a paragraph, return the position where it left.
209 pos_type firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams) const;
211 /// Writes to stream the docbook representation
212 void simpleDocBookOnePar(Buffer const & buf,
214 OutputParams const & runparams,
215 Font const & outerfont,
216 pos_type initial = 0) const;
217 /// \return any material that has had to be deferred until after the
218 /// paragraph has closed.
219 docstring simpleLyXHTMLOnePar(Buffer const & buf,
221 OutputParams const & runparams,
222 Font const & outerfont,
223 bool start_paragraph = true,
224 bool close_paragraph = true,
225 pos_type initial = 0) const;
228 bool hasSameLayout(Paragraph const & par) const;
231 void makeSameLayout(Paragraph const & par);
234 void setInsetOwner(Inset const * inset);
236 Inset const & inInset() const;
238 bool allowParagraphCustomization() const;
240 bool usePlainLayout() const;
242 bool isPassThru() const;
244 pos_type size() const;
249 Layout const & layout() const;
250 /// Do not pass a temporary to this!
251 void setLayout(Layout const & layout);
253 void setPlainOrDefaultLayout(DocumentClass const & tc);
255 void setDefaultLayout(DocumentClass const & tc);
257 void setPlainLayout(DocumentClass const & tc);
259 /// This is the item depth, only used by enumerate and itemize
260 signed char itemdepth;
262 /// look up change at given pos
263 Change const & lookupChange(pos_type pos) const;
265 /// is there a change within the given range ?
266 bool isChanged(pos_type start, pos_type end) const;
267 /// is there an unchanged char at the given pos ?
268 bool isChanged(pos_type pos) const;
269 /// is there an insertion at the given pos ?
270 bool isInserted(pos_type pos) const;
271 /// is there a deletion at the given pos ?
272 bool isDeleted(pos_type pos) const;
273 /// is the whole paragraph deleted ?
274 bool isDeleted(pos_type start, pos_type end) const;
276 /// will the paragraph be physically merged with the next
277 /// one if the imaginary end-of-par character is logically deleted?
278 bool isMergedOnEndOfParDeletion(bool trackChanges) const;
280 /// set change for the entire par
281 void setChange(Change const & change);
283 /// set change at given pos
284 void setChange(pos_type pos, Change const & change);
286 /// accept changes within the given range
287 void acceptChanges(pos_type start, pos_type end);
289 /// reject changes within the given range
290 void rejectChanges(pos_type start, pos_type end);
292 /// Paragraphs can contain "manual labels", for example, Description
293 /// environment. The text for this user-editable label is stored in
294 /// the paragraph alongside the text of the rest of the paragraph
295 /// (the body). This function returns the starting position of the
296 /// body of the text in the paragraph.
297 pos_type beginOfBody() const;
298 /// recompute this value
299 void setBeginOfBody();
302 docstring expandLabel(Layout const &, BufferParams const &) const;
304 docstring expandDocBookLabel(Layout const &, BufferParams const &) const;
306 docstring const & labelString() const;
307 /// the next two functions are for the manual labels
308 docstring const getLabelWidthString() const;
309 /// Set label width string.
310 void setLabelWidthString(docstring const & s);
311 /// Actual paragraph alignment used
312 char getAlign() const;
313 /// The nesting depth of a paragraph
314 depth_type getDepth() const;
315 /// The maximal possible depth of a paragraph after this one
316 depth_type getMaxDepthAfter() const;
318 void applyLayout(Layout const & new_layout);
320 /// (logically) erase the char at pos; return true if it was actually erased
321 bool eraseChar(pos_type pos, bool trackChanges);
322 /// (logically) erase the given range; return the number of chars actually erased
323 int eraseChars(pos_type start, pos_type end, bool trackChanges);
326 void resetFonts(Font const & font);
328 /** Get uninstantiated font setting. Returns the difference
329 between the characters font and the layoutfont.
330 This is what is stored in the fonttable
333 getFontSettings(BufferParams const &, pos_type pos) const;
335 Font const & getFirstFontSettings(BufferParams const &) const;
337 /** Get fully instantiated font. If pos == -1, use the layout
338 font attached to this paragraph.
339 If pos == -2, use the label font of the layout attached here.
340 In all cases, the font is instantiated, i.e. does not have any
341 attributes with values FONT_INHERIT, FONT_IGNORE or
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 &, pos_type pos) const;
361 /// pos <= size() (there is a dummy font change at the end of each par)
362 void setFont(pos_type pos, Font const & font);
364 void insert(pos_type pos, docstring const & str,
365 Font const & font, Change const & change);
368 void appendString(docstring const & s, Font const & font,
369 Change const & change);
371 void appendChar(char_type c, Font const & font, Change const & change);
373 void insertChar(pos_type pos, char_type c, bool trackChanges);
375 void insertChar(pos_type pos, char_type c,
376 Font const &, bool trackChanges);
378 void insertChar(pos_type pos, char_type c,
379 Font const &, Change const & change);
380 /// Insert \p inset at position \p pos with \p change traking status and
382 /// \return true if successful.
383 bool insertInset(pos_type pos, Inset * inset,
384 Font const & font, Change const & change);
386 Inset * getInset(pos_type pos);
388 Inset const * getInset(pos_type pos) const;
390 /// Release inset at given position.
391 /// \warning does not honour change tracking!
392 /// Therefore, it should only be used for breaking and merging
394 Inset * releaseInset(pos_type pos);
397 InsetList const & insetList() const;
399 void setBuffer(Buffer &);
404 bool isHfill(pos_type pos) const;
406 /// hinted by profiler
407 bool isInset(pos_type pos) const;
409 bool isNewline(pos_type pos) const;
411 bool isEnvSeparator(pos_type pos) const;
412 /// return true if the char is a word separator
413 bool isSeparator(pos_type pos) const;
415 bool isLineSeparator(pos_type pos) const;
416 /// True if the character/inset at this point is a word separator.
417 /// Note that digits in particular are not considered as word separator.
418 bool isWordSeparator(pos_type pos) const;
419 /// True if the element at this point is a character that is not a letter.
420 bool isChar(pos_type pos) const;
421 /// True if the element at this point is a space
422 bool isSpace(pos_type pos) const;
423 /// True if the element at this point is a hard hyphen or a apostrophe
424 /// If it is enclosed by spaces return false
425 bool isHardHyphenOrApostrophe(pos_type pos) const;
427 /// returns true if at least one line break or line separator has been deleted
428 /// at the beginning of the paragraph (either physically or logically)
429 bool stripLeadingSpaces(bool trackChanges);
431 /// return true if we allow multiple spaces
432 bool isFreeSpacing() const;
434 /// return true if we allow this par to stay empty
435 bool allowEmpty() const;
437 ParagraphParameters & params();
439 ParagraphParameters const & params() const;
441 /// Check whether a call to fixBiblio is needed.
442 bool brokenBiblio() const;
443 /// Check if we are in a Biblio environment and insert or
444 /// delete InsetBibitems as necessary.
445 /// \retval int 1, if we had to add an inset, in which case
446 /// the cursor will need to move cursor forward; -pos, if we deleted
447 /// an inset, in which case pos is the position from which the inset
448 /// was deleted, and the cursor will need to be moved back one if it
449 /// was previously past that position. Return 0 otherwise.
450 int fixBiblio(Buffer const & buffer);
452 /// For each author, set 'used' to true if there is a change
453 /// by this author in the paragraph.
454 void checkAuthors(AuthorList const & authorList);
457 void changeCase(BufferParams const & bparams, pos_type pos,
458 pos_type & right, TextCase action);
460 /// find \param str string inside Paragraph.
461 /// \return non-zero if the specified string is at the specified
462 /// position; returned value is the actual match length in positions
463 /// \param del specifies whether deleted strings in ct mode will be considered
465 docstring const & str, ///< string to search
468 pos_type pos, ///< start from here.
469 bool del = true) const;
471 void locateWord(pos_type & from, pos_type & to,
472 word_location const loc) const;
476 /// Spellcheck word at position \p from and fill in found misspelled word
477 /// and \p suggestions if \p do_suggestion is true.
478 /// \return result from spell checker, SpellChecker::UNKNOWN_WORD when misspelled.
479 SpellChecker::Result spellCheck(pos_type & from, pos_type & to, WordLangTuple & wl,
480 docstring_list & suggestions, bool do_suggestion = true,
481 bool check_learned = false) const;
483 /// Spell checker status at position \p pos.
484 /// If \p check_boundary is true the status of position immediately
485 /// before \p pos is tested too if it is at word boundary.
486 /// \return true if one of the tested positions is misspelled.
487 bool isMisspelled(pos_type pos, bool check_boundary = false) const;
489 /// \return the spell range (misspelled area) around position.
490 /// Range is empty if word at position is correctly spelled.
491 FontSpan const & getSpellRange(pos_type pos) const;
493 /// spell check of whole paragraph
494 /// remember results until call of requestSpellCheck()
495 void spellCheck() const;
497 /// query state of spell checker results
498 bool needsSpellCheck() const;
499 /// mark position of text manipulation to inform the spell checker
500 /// default value -1 marks the whole paragraph to be checked (again)
501 void requestSpellCheck(pos_type pos = -1);
503 /// an automatically generated identifying label for this paragraph.
504 /// presently used only in the XHTML output routines.
505 std::string magicLabel() const;
508 /// Expand the counters for the labelstring of \c layout
509 docstring expandParagraphLabel(Layout const &, BufferParams const &,
510 bool process_appendix) const;
512 void deregisterWords();
516 void registerWords();
521 friend class Paragraph::Private;
528 #endif // PARAGRAPH_H