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"
22 #include "insets/InsetCode.h"
24 #include "support/strfwd.h"
25 #include "support/types.h"
49 class ParagraphParameters;
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.
70 text_capitalization = 1,
77 enum AsStringParameter
79 AS_STR_NONE = 0, ///< No option, only printable characters.
80 AS_STR_LABEL = 1, ///< Prefix with paragraph label.
81 AS_STR_INSETS = 2, ///< Go into insets.
82 AS_STR_NEWLINES = 4 ///< Get also newline characters.
86 /// A Paragraph holds all text, attributes and insets in a text paragraph
93 Paragraph(Paragraph const &);
94 /// Partial copy constructor.
95 /// Copy the Paragraph contents from \p beg to \p end (without end).
96 Paragraph(Paragraph const & par, pos_type beg, pos_type end);
98 Paragraph & operator=(Paragraph const &);
105 void addChangesToToc(DocIterator const & cdit, Buffer const & buf) const;
107 Language const * getParLanguage(BufferParams const &) const;
109 bool isRTL(BufferParams const &) const;
111 void changeLanguage(BufferParams const & bparams,
112 Language const * from, Language const * to);
114 bool isMultiLingual(BufferParams const &) const;
116 /// Convert the paragraph to a string.
117 /// \param AsStringParameter options. This can contain any combination of
118 /// asStringParameter values. Valid examples:
119 /// asString(AS_STR_LABEL)
120 /// asString(AS_STR_LABEL | AS_STR_INSETS)
121 /// asString(AS_STR_INSETS)
122 docstring asString(int options = AS_STR_NONE) const;
124 docstring asString(pos_type beg, pos_type end,
125 int options = AS_STR_NONE) const;
127 /// Extract only the explicitly visible text (without any formatting),
128 /// descending into insets
129 docstring stringify(pos_type beg, pos_type end, int options, OutputParams & runparams) const;
132 void write(std::ostream &, BufferParams const &,
133 depth_type & depth) const;
135 void validate(LaTeXFeatures &) const;
138 bool latex(BufferParams const &, Font const & outerfont, odocstream &,
139 TexRow & texrow, OutputParams const &,
140 int start_pos = 0, int end_pos = -1) const;
142 /// Can we drop the standard paragraph wrapper?
143 bool emptyTag() const;
145 /// Get the id of the paragraph, usefull for docbook
146 std::string getID(Buffer const & buf, OutputParams const & runparams) const;
148 /// Output the first word of a paragraph, return the position where it left.
149 pos_type firstWordDocBook(odocstream & os, OutputParams const & runparams) const;
151 /// Output the first word of a paragraph, return the position where it left.
152 pos_type firstWordLyXHTML(odocstream & os, OutputParams const & runparams) const;
154 /// Writes to stream the docbook representation
155 void simpleDocBookOnePar(Buffer const & buf,
157 OutputParams const & runparams,
158 Font const & outerfont,
159 pos_type initial = 0) const;
160 /// \return any material that has had to be deferred until after the
161 /// paragraph has closed.
162 docstring simpleLyXHTMLOnePar(Buffer const & buf,
164 OutputParams const & runparams,
165 Font const & outerfont,
166 pos_type initial = 0) const;
169 bool hasSameLayout(Paragraph const & par) const;
172 void makeSameLayout(Paragraph const & par);
175 void setInsetOwner(Inset const * inset);
177 Inset const & inInset() const;
179 InsetCode ownerCode() const;
181 bool forcePlainLayout() const;
183 bool allowParagraphCustomization() const;
185 bool usePlainLayout() const;
187 pos_type size() const;
192 Layout const & layout() const;
193 /// Do not pass a temporary to this!
194 void setLayout(Layout const & layout);
196 void setPlainOrDefaultLayout(DocumentClass const & tc);
198 void setDefaultLayout(DocumentClass const & tc);
200 void setPlainLayout(DocumentClass const & tc);
202 /// This is the item depth, only used by enumerate and itemize
203 signed char itemdepth;
205 /// look up change at given pos
206 Change const & lookupChange(pos_type pos) const;
208 /// is there a change within the given range ?
209 bool isChanged(pos_type start, pos_type end) const;
210 /// is there an unchanged char at the given pos ?
211 bool isUnchanged(pos_type pos) const;
212 /// is there an insertion at the given pos ?
213 bool isInserted(pos_type pos) const;
214 /// is there a deletion at the given pos ?
215 bool isDeleted(pos_type pos) const;
216 /// is the whole paragraph deleted ?
217 bool isFullyDeleted(pos_type start, pos_type end) const;
219 /// will the paragraph be physically merged with the next
220 /// one if the imaginary end-of-par character is logically deleted?
221 bool isMergedOnEndOfParDeletion(bool trackChanges) const;
223 /// set change for the entire par
224 void setChange(Change const & change);
226 /// set change at given pos
227 void setChange(pos_type pos, Change const & change);
229 /// accept changes within the given range
230 void acceptChanges(BufferParams const & bparams, pos_type start, pos_type end);
232 /// reject changes within the given range
233 void rejectChanges(BufferParams const & bparams, pos_type start, pos_type end);
235 /// Paragraphs can contain "manual labels", for example, Description
236 /// environment. The text for this user-editable label is stored in
237 /// the paragraph alongside the text of the rest of the paragraph
238 /// (the body). This function returns the starting position of the
239 /// body of the text in the paragraph.
240 pos_type beginOfBody() const;
241 /// recompute this value
242 void setBeginOfBody();
245 docstring const & labelString() const;
247 /// the next two functions are for the manual labels
248 docstring const getLabelWidthString() const;
249 /// Set label width string.
250 void setLabelWidthString(docstring const & s);
251 /// translate \p label to the paragraph language if possible.
252 docstring const translateIfPossible(docstring const & label,
253 BufferParams const & bparams) const;
254 /// Expand the counters for the labelstring of \c layout
255 docstring expandLabel(Layout const &, BufferParams const &,
256 bool process_appendix = true) const;
257 /// Actual paragraph alignment used
258 char getAlign() const;
259 /// The nesting depth of a paragraph
260 depth_type getDepth() const;
261 /// The maximal possible depth of a paragraph after this one
262 depth_type getMaxDepthAfter() const;
264 void applyLayout(Layout const & new_layout);
266 /// (logically) erase the char at pos; return true if it was actually erased
267 bool eraseChar(pos_type pos, bool trackChanges);
268 /// (logically) erase the given range; return the number of chars actually erased
269 int eraseChars(pos_type start, pos_type end, bool trackChanges);
272 void resetFonts(Font const & font);
274 /** Get uninstantiated font setting. Returns the difference
275 between the characters font and the layoutfont.
276 This is what is stored in the fonttable
279 getFontSettings(BufferParams const &, pos_type pos) const;
281 Font const & getFirstFontSettings(BufferParams const &) const;
283 /** Get fully instantiated font. If pos == -1, use the layout
284 font attached to this paragraph.
285 If pos == -2, use the label font of the layout attached here.
286 In all cases, the font is instantiated, i.e. does not have any
287 attributes with values FONT_INHERIT, FONT_IGNORE or
290 Font const getFont(BufferParams const &, pos_type pos,
291 Font const & outerfont) const;
292 Font const getLayoutFont(BufferParams const &,
293 Font const & outerfont) const;
294 Font const getLabelFont(BufferParams const &,
295 Font const & outerfont) const;
297 * The font returned by the above functions is the same in a
298 * span of characters. This method will return the first and
299 * the last positions in the paragraph for which that font is
300 * the same. This can be used to avoid unnecessary calls to getFont.
302 FontSpan fontSpan(pos_type pos) const;
304 char_type getChar(pos_type pos) const;
305 /// Get the char, but mirror all bracket characters if it is right-to-left
306 char_type getUChar(BufferParams const &, pos_type pos) const;
307 /// pos <= size() (there is a dummy font change at the end of each par)
308 void setFont(pos_type pos, Font const & font);
309 /// Returns the height of the highest font in range
310 FontSize highestFontInRange(pos_type startpos,
311 pos_type endpos, FontSize def_size) const;
313 void insert(pos_type pos, docstring const & str,
314 Font const & font, Change const & change);
317 void appendString(docstring const & s, Font const & font,
318 Change const & change);
320 void appendChar(char_type c, Font const & font, Change const & change);
322 void insertChar(pos_type pos, char_type c, bool trackChanges);
324 void insertChar(pos_type pos, char_type c,
325 Font const &, bool trackChanges);
327 void insertChar(pos_type pos, char_type c,
328 Font const &, Change const & change);
329 /// Insert \p inset at position \p pos with \p change traking status.
330 /// \return true if successful.
331 bool insertInset(pos_type pos, Inset * inset,
332 Change const & change);
333 /// Insert \p inset at position \p pos with \p change traking status and
335 /// \return true if successful.
336 bool insertInset(pos_type pos, Inset * inset,
337 Font const & font, Change const & change);
339 Inset * getInset(pos_type pos);
341 Inset const * getInset(pos_type pos) const;
343 /// Release inset at given position.
344 /// \warning does not honour change tracking!
345 /// Therefore, it should only be used for breaking and merging
347 Inset * releaseInset(pos_type pos);
350 InsetList const & insetList() const;
352 void setBuffer(Buffer &);
355 bool isHfill(pos_type pos) const;
357 /// hinted by profiler
358 bool isInset(pos_type pos) const;
360 bool isNewline(pos_type pos) const;
361 /// return true if the char is a word separator
362 bool isSeparator(pos_type pos) const;
364 bool isLineSeparator(pos_type pos) const;
365 /// True if the character/inset at this point can be part of a word.
366 /// Note that digits in particular are considered as letters
367 bool isLetter(pos_type pos) const;
368 /// True if the element at this point is a character that is not a letter.
369 bool isChar(pos_type pos) const;
370 /// True if the element at this point is a space
371 bool isSpace(pos_type pos) const;
373 /// returns true if at least one line break or line separator has been deleted
374 /// at the beginning of the paragraph (either physically or logically)
375 bool stripLeadingSpaces(bool trackChanges);
377 /// return true if we allow multiple spaces
378 bool isFreeSpacing() const;
380 /// return true if we allow this par to stay empty
381 bool allowEmpty() const;
383 char_type transformChar(char_type c, pos_type pos) const;
385 ParagraphParameters & params();
387 ParagraphParameters const & params() const;
389 /// Check if we are in a Biblio environment and insert or
390 /// delete InsetBibitems as necessary.
391 /// \retval int 1, if we had to add an inset, in which case
392 /// the cursor will need to move cursor forward; -pos, if we deleted
393 /// an inset, in which case pos is the position from which the inset
394 /// was deleted, and the cursor will need to be moved back one if it
395 /// was previously past that position. Return 0 otherwise.
396 int checkBiblio(Buffer const & buffer);
398 /// For each author, set 'used' to true if there is a change
399 /// by this author in the paragraph.
400 void checkAuthors(AuthorList const & authorList);
403 void changeCase(BufferParams const & bparams, pos_type pos,
404 pos_type & right, TextCase action);
406 /// find \param str string inside Paragraph.
407 /// \return true if the specified string is at the specified position
408 /// \param del specifies whether deleted strings in ct mode will be considered
410 docstring const & str, ///< string to search
413 pos_type pos, ///< start from here.
414 bool del = true) const;
416 void locateWord(pos_type & from, pos_type & to,
417 word_location const loc) const;
420 /// Spellcheck word at position \p pos.
421 /// \return true if pointed word is misspelled.
422 bool isMisspelled(pos_type pos) const;
426 void deregisterWords();
430 void registerWords();
435 friend class Paragraph::Private;
442 #endif // PARAGRAPH_H