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;
128 void write(std::ostream &, BufferParams const &,
129 depth_type & depth) const;
131 void validate(LaTeXFeatures &) const;
134 bool latex(BufferParams const &, Font const & outerfont, odocstream &,
135 TexRow & texrow, OutputParams const &) const;
137 /// Can we drop the standard paragraph wrapper?
138 bool emptyTag() const;
140 /// Get the id of the paragraph, usefull for docbook
141 std::string getID(Buffer const & buf, OutputParams const & runparams) const;
143 /// Get the first word of a paragraph, return the position where it left
144 pos_type firstWord(odocstream & os, OutputParams const & runparams) const;
146 /// Writes to stream the docbook representation
147 void simpleDocBookOnePar(Buffer const & buf,
149 OutputParams const & runparams,
150 Font const & outerfont,
151 pos_type initial = 0) const;
154 bool hasSameLayout(Paragraph const & par) const;
157 void makeSameLayout(Paragraph const & par);
160 void setInsetOwner(Inset const * inset);
162 Inset const & inInset() const;
164 InsetCode ownerCode() const;
166 bool forcePlainLayout() const;
168 bool allowParagraphCustomization() const;
170 bool usePlainLayout() const;
172 pos_type size() const;
177 Layout const & layout() const;
178 /// Do not pass a temporary to this!
179 void setLayout(Layout const & layout);
181 void setPlainOrDefaultLayout(DocumentClass const & tc);
183 void setDefaultLayout(DocumentClass const & tc);
185 void setPlainLayout(DocumentClass const & tc);
187 /// This is the item depth, only used by enumerate and itemize
188 signed char itemdepth;
190 /// look up change at given pos
191 Change const & lookupChange(pos_type pos) const;
193 /// is there a change within the given range ?
194 bool isChanged(pos_type start, pos_type end) const;
195 /// is there an unchanged char at the given pos ?
196 bool isUnchanged(pos_type pos) const;
197 /// is there an insertion at the given pos ?
198 bool isInserted(pos_type pos) const;
199 /// is there a deletion at the given pos ?
200 bool isDeleted(pos_type pos) const;
202 /// will the paragraph be physically merged with the next
203 /// one if the imaginary end-of-par character is logically deleted?
204 bool isMergedOnEndOfParDeletion(bool trackChanges) const;
206 /// set change for the entire par
207 void setChange(Change const & change);
209 /// set change at given pos
210 void setChange(pos_type pos, Change const & change);
212 /// accept changes within the given range
213 void acceptChanges(BufferParams const & bparams, pos_type start, pos_type end);
215 /// reject changes within the given range
216 void rejectChanges(BufferParams const & bparams, pos_type start, pos_type end);
218 /// Paragraphs can contain "manual labels", for example, Description
219 /// environment. The text for this user-editable label is stored in
220 /// the paragraph alongside the text of the rest of the paragraph
221 /// (the body). This function returns the starting position of the
222 /// body of the text in the paragraph.
223 pos_type beginOfBody() const;
224 /// recompute this value
225 void setBeginOfBody();
228 docstring const & labelString() const;
230 /// the next two functions are for the manual labels
231 docstring const getLabelWidthString() const;
232 /// Set label width string.
233 void setLabelWidthString(docstring const & s);
234 /// translate \p label to the paragraph language if possible.
235 docstring const translateIfPossible(docstring const & label,
236 BufferParams const & bparams) const;
237 /// Expand the counters for the labelstring of \c layout
238 docstring expandLabel(Layout const &, BufferParams const &,
239 bool process_appendix = true) const;
240 /// Actual paragraph alignment used
241 char getAlign() const;
242 /// The nesting depth of a paragraph
243 depth_type getDepth() const;
244 /// The maximal possible depth of a paragraph after this one
245 depth_type getMaxDepthAfter() const;
247 void applyLayout(Layout const & new_layout);
249 /// (logically) erase the char at pos; return true if it was actually erased
250 bool eraseChar(pos_type pos, bool trackChanges);
251 /// (logically) erase the given range; return the number of chars actually erased
252 int eraseChars(pos_type start, pos_type end, bool trackChanges);
255 void resetFonts(Font const & font);
257 /** Get uninstantiated font setting. Returns the difference
258 between the characters font and the layoutfont.
259 This is what is stored in the fonttable
262 getFontSettings(BufferParams const &, pos_type pos) const;
264 Font const & getFirstFontSettings(BufferParams const &) const;
266 /** Get fully instantiated font. If pos == -1, use the layout
267 font attached to this paragraph.
268 If pos == -2, use the label font of the layout attached here.
269 In all cases, the font is instantiated, i.e. does not have any
270 attributes with values FONT_INHERIT, FONT_IGNORE or
273 Font const getFont(BufferParams const &, pos_type pos,
274 Font const & outerfont) const;
275 Font const getLayoutFont(BufferParams const &,
276 Font const & outerfont) const;
277 Font const getLabelFont(BufferParams const &,
278 Font const & outerfont) const;
280 * The font returned by the above functions is the same in a
281 * span of characters. This method will return the first and
282 * the last positions in the paragraph for which that font is
283 * the same. This can be used to avoid unnecessary calls to getFont.
285 FontSpan fontSpan(pos_type pos) const;
287 char_type getChar(pos_type pos) const;
288 /// Get the char, but mirror all bracket characters if it is right-to-left
289 char_type getUChar(BufferParams const &, pos_type pos) const;
290 /// pos <= size() (there is a dummy font change at the end of each par)
291 void setFont(pos_type pos, Font const & font);
292 /// Returns the height of the highest font in range
293 FontSize highestFontInRange(pos_type startpos,
294 pos_type endpos, FontSize def_size) const;
296 void insert(pos_type pos, docstring const & str,
297 Font const & font, Change const & change);
300 void appendString(docstring const & s, Font const & font,
301 Change const & change);
303 void appendChar(char_type c, Font const & font, Change const & change);
305 void insertChar(pos_type pos, char_type c, bool trackChanges);
307 void insertChar(pos_type pos, char_type c,
308 Font const &, bool trackChanges);
310 void insertChar(pos_type pos, char_type c,
311 Font const &, Change const & change);
312 /// Insert \p inset at position \p pos with \p change traking status.
313 /// \return true if successful.
314 bool insertInset(pos_type pos, Inset * inset,
315 Change const & change);
316 /// Insert \p inset at position \p pos with \p change traking status and
318 /// \return true if successful.
319 bool insertInset(pos_type pos, Inset * inset,
320 Font const & font, Change const & change);
322 Inset * getInset(pos_type pos);
324 Inset const * getInset(pos_type pos) const;
326 /// Release inset at given position.
327 /// \warning does not honour change tracking!
328 /// Therefore, it should only be used for breaking and merging
330 Inset * releaseInset(pos_type pos);
333 InsetList const & insetList() const;
335 void setBuffer(Buffer &);
338 bool isHfill(pos_type pos) const;
340 /// hinted by profiler
341 bool isInset(pos_type pos) const;
343 bool isNewline(pos_type pos) const;
344 /// return true if the char is a word separator
345 bool isSeparator(pos_type pos) const;
347 bool isLineSeparator(pos_type pos) const;
348 /// True if the character/inset at this point can be part of a word.
349 /// Note that digits in particular are considered as letters
350 bool isLetter(pos_type pos) const;
351 /// True if the element at this point is a character that is not a letter.
352 bool isChar(pos_type pos) const;
353 /// True if the element at this point is a space
354 bool isSpace(pos_type pos) const;
356 /// returns true if at least one line break or line separator has been deleted
357 /// at the beginning of the paragraph (either physically or logically)
358 bool stripLeadingSpaces(bool trackChanges);
360 /// return true if we allow multiple spaces
361 bool isFreeSpacing() const;
363 /// return true if we allow this par to stay empty
364 bool allowEmpty() const;
366 char_type transformChar(char_type c, pos_type pos) const;
368 ParagraphParameters & params();
370 ParagraphParameters const & params() const;
372 /// Check if we are in a Biblio environment and insert or
373 /// delete InsetBibitems as necessary.
374 /// \retval int 1, if we had to add an inset, in which case
375 /// the cursor will need to move cursor forward; -pos, if we deleted
376 /// an inset, in which case pos is the position from which the inset
377 /// was deleted, and the cursor will need to be moved back one if it
378 /// was previously past that position. Return 0 otherwise.
379 int checkBiblio(Buffer const & buffer);
381 /// For each author, set 'used' to true if there is a change
382 /// by this author in the paragraph.
383 void checkAuthors(AuthorList const & authorList);
386 void changeCase(BufferParams const & bparams, pos_type pos,
387 pos_type & right, TextCase action);
389 /// find \param str string inside Paragraph.
390 /// \return true if the specified string is at the specified position
391 /// \param del specifies whether deleted strings in ct mode will be considered
393 docstring const & str, ///< string to search
396 pos_type pos, ///< start from here.
397 bool del = true) const;
400 void updateWords(CursorSlice const & sl);
404 void deregisterWords();
406 void collectWords(CursorSlice const & sl);
408 void registerWords();
413 friend class Paragraph::Private;
420 #endif // PARAGRAPH_H