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 &,
136 int start_pos = -1, int end_pos = -1) const;
138 /// Can we drop the standard paragraph wrapper?
139 bool emptyTag() const;
141 /// Get the id of the paragraph, usefull for docbook
142 std::string getID(Buffer const & buf, OutputParams const & runparams) const;
144 /// Get the first word of a paragraph, return the position where it left
145 pos_type firstWord(odocstream & os, OutputParams const & runparams) const;
147 /// Writes to stream the docbook representation
148 void simpleDocBookOnePar(Buffer const & buf,
150 OutputParams const & runparams,
151 Font const & outerfont,
152 pos_type initial = 0) const;
155 bool hasSameLayout(Paragraph const & par) const;
158 void makeSameLayout(Paragraph const & par);
161 void setInsetOwner(Inset const * inset);
163 Inset const & inInset() const;
165 InsetCode ownerCode() const;
167 bool forcePlainLayout() const;
169 bool allowParagraphCustomization() const;
171 bool usePlainLayout() const;
173 pos_type size() const;
178 Layout const & layout() const;
179 /// Do not pass a temporary to this!
180 void setLayout(Layout const & layout);
182 void setPlainOrDefaultLayout(DocumentClass const & tc);
184 void setDefaultLayout(DocumentClass const & tc);
186 void setPlainLayout(DocumentClass const & tc);
188 /// This is the item depth, only used by enumerate and itemize
189 signed char itemdepth;
191 /// look up change at given pos
192 Change const & lookupChange(pos_type pos) const;
194 /// is there a change within the given range ?
195 bool isChanged(pos_type start, pos_type end) const;
196 /// is there an unchanged char at the given pos ?
197 bool isUnchanged(pos_type pos) const;
198 /// is there an insertion at the given pos ?
199 bool isInserted(pos_type pos) const;
200 /// is there a deletion at the given pos ?
201 bool isDeleted(pos_type pos) const;
203 /// will the paragraph be physically merged with the next
204 /// one if the imaginary end-of-par character is logically deleted?
205 bool isMergedOnEndOfParDeletion(bool trackChanges) const;
207 /// set change for the entire par
208 void setChange(Change const & change);
210 /// set change at given pos
211 void setChange(pos_type pos, Change const & change);
213 /// accept changes within the given range
214 void acceptChanges(BufferParams const & bparams, pos_type start, pos_type end);
216 /// reject changes within the given range
217 void rejectChanges(BufferParams const & bparams, pos_type start, pos_type end);
219 /// Paragraphs can contain "manual labels", for example, Description
220 /// environment. The text for this user-editable label is stored in
221 /// the paragraph alongside the text of the rest of the paragraph
222 /// (the body). This function returns the starting position of the
223 /// body of the text in the paragraph.
224 pos_type beginOfBody() const;
225 /// recompute this value
226 void setBeginOfBody();
229 docstring const & labelString() const;
231 /// the next two functions are for the manual labels
232 docstring const getLabelWidthString() const;
233 /// Set label width string.
234 void setLabelWidthString(docstring const & s);
235 /// translate \p label to the paragraph language if possible.
236 docstring const translateIfPossible(docstring const & label,
237 BufferParams const & bparams) const;
238 /// Expand the counters for the labelstring of \c layout
239 docstring expandLabel(Layout const &, BufferParams const &,
240 bool process_appendix = true) const;
241 /// Actual paragraph alignment used
242 char getAlign() const;
243 /// The nesting depth of a paragraph
244 depth_type getDepth() const;
245 /// The maximal possible depth of a paragraph after this one
246 depth_type getMaxDepthAfter() const;
248 void applyLayout(Layout const & new_layout);
250 /// (logically) erase the char at pos; return true if it was actually erased
251 bool eraseChar(pos_type pos, bool trackChanges);
252 /// (logically) erase the given range; return the number of chars actually erased
253 int eraseChars(pos_type start, pos_type end, bool trackChanges);
256 void resetFonts(Font const & font);
258 /** Get uninstantiated font setting. Returns the difference
259 between the characters font and the layoutfont.
260 This is what is stored in the fonttable
263 getFontSettings(BufferParams const &, pos_type pos) const;
265 Font const & getFirstFontSettings(BufferParams const &) const;
267 /** Get fully instantiated font. If pos == -1, use the layout
268 font attached to this paragraph.
269 If pos == -2, use the label font of the layout attached here.
270 In all cases, the font is instantiated, i.e. does not have any
271 attributes with values FONT_INHERIT, FONT_IGNORE or
274 Font const getFont(BufferParams const &, pos_type pos,
275 Font const & outerfont) const;
276 Font const getLayoutFont(BufferParams const &,
277 Font const & outerfont) const;
278 Font const getLabelFont(BufferParams const &,
279 Font const & outerfont) const;
281 * The font returned by the above functions is the same in a
282 * span of characters. This method will return the first and
283 * the last positions in the paragraph for which that font is
284 * the same. This can be used to avoid unnecessary calls to getFont.
286 FontSpan fontSpan(pos_type pos) const;
288 char_type getChar(pos_type pos) const;
289 /// Get the char, but mirror all bracket characters if it is right-to-left
290 char_type getUChar(BufferParams const &, pos_type pos) const;
291 /// pos <= size() (there is a dummy font change at the end of each par)
292 void setFont(pos_type pos, Font const & font);
293 /// Returns the height of the highest font in range
294 FontSize highestFontInRange(pos_type startpos,
295 pos_type endpos, FontSize def_size) const;
297 void insert(pos_type pos, docstring const & str,
298 Font const & font, Change const & change);
301 void appendString(docstring const & s, Font const & font,
302 Change const & change);
304 void appendChar(char_type c, Font const & font, Change const & change);
306 void insertChar(pos_type pos, char_type c, bool trackChanges);
308 void insertChar(pos_type pos, char_type c,
309 Font const &, bool trackChanges);
311 void insertChar(pos_type pos, char_type c,
312 Font const &, Change const & change);
313 /// Insert \p inset at position \p pos with \p change traking status.
314 /// \return true if successful.
315 bool insertInset(pos_type pos, Inset * inset,
316 Change const & change);
317 /// Insert \p inset at position \p pos with \p change traking status and
319 /// \return true if successful.
320 bool insertInset(pos_type pos, Inset * inset,
321 Font const & font, Change const & change);
323 Inset * getInset(pos_type pos);
325 Inset const * getInset(pos_type pos) const;
327 /// Release inset at given position.
328 /// \warning does not honour change tracking!
329 /// Therefore, it should only be used for breaking and merging
331 Inset * releaseInset(pos_type pos);
334 InsetList const & insetList() const;
336 void setBuffer(Buffer &);
339 bool isHfill(pos_type pos) const;
341 /// hinted by profiler
342 bool isInset(pos_type pos) const;
344 bool isNewline(pos_type pos) const;
345 /// return true if the char is a word separator
346 bool isSeparator(pos_type pos) const;
348 bool isLineSeparator(pos_type pos) const;
349 /// True if the character/inset at this point can be part of a word.
350 /// Note that digits in particular are considered as letters
351 bool isLetter(pos_type pos) const;
352 /// True if the element at this point is a character that is not a letter.
353 bool isChar(pos_type pos) const;
354 /// True if the element at this point is a space
355 bool isSpace(pos_type pos) const;
357 /// returns true if at least one line break or line separator has been deleted
358 /// at the beginning of the paragraph (either physically or logically)
359 bool stripLeadingSpaces(bool trackChanges);
361 /// return true if we allow multiple spaces
362 bool isFreeSpacing() const;
364 /// return true if we allow this par to stay empty
365 bool allowEmpty() const;
367 char_type transformChar(char_type c, pos_type pos) const;
369 ParagraphParameters & params();
371 ParagraphParameters const & params() const;
373 /// Check if we are in a Biblio environment and insert or
374 /// delete InsetBibitems as necessary.
375 /// \retval int 1, if we had to add an inset, in which case
376 /// the cursor will need to move cursor forward; -pos, if we deleted
377 /// an inset, in which case pos is the position from which the inset
378 /// was deleted, and the cursor will need to be moved back one if it
379 /// was previously past that position. Return 0 otherwise.
380 int checkBiblio(Buffer const & buffer);
382 /// For each author, set 'used' to true if there is a change
383 /// by this author in the paragraph.
384 void checkAuthors(AuthorList const & authorList);
387 void changeCase(BufferParams const & bparams, pos_type pos,
388 pos_type & right, TextCase action);
390 /// find \param str string inside Paragraph.
391 /// \return true if the specified string is at the specified position
392 /// \param del specifies whether deleted strings in ct mode will be considered
394 docstring const & str, ///< string to search
397 pos_type pos, ///< start from here.
398 bool del = true) const;
401 void updateWords(CursorSlice const & sl);
405 void deregisterWords();
407 void collectWords(CursorSlice const & sl);
409 void registerWords();
414 friend class Paragraph::Private;
421 #endif // PARAGRAPH_H