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"
48 class ParagraphParameters
;
54 /// Invalid font span containing no character
55 FontSpan() : first(0), last(-1) {}
56 /// Span including first and last
57 FontSpan(pos_type f
, pos_type l
) : first(f
), last(l
) {}
60 /// Range including first and last.
69 text_capitalization
= 1,
75 /// A Paragraph holds all text, attributes and insets in a text paragraph
82 Paragraph(Paragraph
const &);
84 Paragraph
& operator=(Paragraph
const &);
91 Language
const * getParLanguage(BufferParams
const &) const;
93 bool isRTL(BufferParams
const &) const;
95 void changeLanguage(BufferParams
const & bparams
,
96 Language
const * from
, Language
const * to
);
98 bool isMultiLingual(BufferParams
const &) const;
100 /// Convert the paragraph to a string.
101 /// Used for building the table of contents
102 docstring
asString(bool label
) const;
104 docstring
asString(pos_type beg
, pos_type end
, bool label
) const;
107 void write(std::ostream
&, BufferParams
const &,
108 depth_type
& depth
) const;
110 void validate(LaTeXFeatures
&) const;
113 bool latex(BufferParams
const &, Font
const & outerfont
, odocstream
&,
114 TexRow
& texrow
, OutputParams
const &) const;
116 /// Can we drop the standard paragraph wrapper?
117 bool emptyTag() const;
119 /// Get the id of the paragraph, usefull for docbook
120 std::string
getID(Buffer
const & buf
, OutputParams
const & runparams
) const;
122 /// Get the first word of a paragraph, return the position where it left
123 pos_type
firstWord(odocstream
& os
, OutputParams
const & runparams
) const;
125 /// Writes to stream the docbook representation
126 void simpleDocBookOnePar(Buffer
const & buf
,
128 OutputParams
const & runparams
,
129 Font
const & outerfont
,
130 pos_type initial
= 0) const;
133 bool hasSameLayout(Paragraph
const & par
) const;
136 void makeSameLayout(Paragraph
const & par
);
139 void setInsetOwner(Inset
* inset
);
141 Inset
* inInset() const;
143 InsetCode
ownerCode() const;
145 bool forceEmptyLayout() const;
147 bool allowParagraphCustomization() const;
149 bool useEmptyLayout() const;
151 pos_type
size() const;
156 Layout
const & layout() const;
157 /// Do not pass a temporary to this!
158 void setLayout(Layout
const & layout
);
160 void setEmptyOrDefaultLayout(DocumentClass
const & tc
);
162 /// This is the item depth, only used by enumerate and itemize
163 signed char itemdepth
;
165 /// look up change at given pos
166 Change
const & lookupChange(pos_type pos
) const;
168 /// is there a change within the given range ?
169 bool isChanged(pos_type start
, pos_type end
) const;
170 /// is there an unchanged char at the given pos ?
171 bool isUnchanged(pos_type pos
) const;
172 /// is there an insertion at the given pos ?
173 bool isInserted(pos_type pos
) const;
174 /// is there a deletion at the given pos ?
175 bool isDeleted(pos_type pos
) const;
177 /// will the paragraph be physically merged with the next
178 /// one if the imaginary end-of-par character is logically deleted?
179 bool isMergedOnEndOfParDeletion(bool trackChanges
) const;
181 /// set change for the entire par
182 void setChange(Change
const & change
);
184 /// set change at given pos
185 void setChange(pos_type pos
, Change
const & change
);
187 /// accept changes within the given range
188 void acceptChanges(BufferParams
const & bparams
, pos_type start
, pos_type end
);
190 /// reject changes within the given range
191 void rejectChanges(BufferParams
const & bparams
, pos_type start
, pos_type end
);
193 /// Paragraphs can contain "manual labels", for example, Description
194 /// environment. The text for this user-editable label is stored in
195 /// the paragraph alongside the text of the rest of the paragraph
196 /// (the body). This function returns the starting position of the
197 /// body of the text in the paragraph.
198 pos_type
beginOfBody() const;
199 /// recompute this value
200 void setBeginOfBody();
203 docstring
const & labelString() const;
205 /// the next two functions are for the manual labels
206 docstring
const getLabelWidthString() const;
207 /// Set label width string.
208 void setLabelWidthString(docstring
const & s
);
209 /// translate \p label to the paragraph language if possible.
210 docstring
const translateIfPossible(docstring
const & label
,
211 BufferParams
const & bparams
) const;
212 /// Expand the counters for the labelstring of \c layout
213 docstring
expandLabel(Layout
const &, BufferParams
const &,
214 bool process_appendix
= true) const;
215 /// Actual paragraph alignment used
216 char getAlign() const;
217 /// The nesting depth of a paragraph
218 depth_type
getDepth() const;
219 /// The maximal possible depth of a paragraph after this one
220 depth_type
getMaxDepthAfter() const;
222 void applyLayout(Layout
const & new_layout
);
224 /// (logically) erase the char at pos; return true if it was actually erased
225 bool eraseChar(pos_type pos
, bool trackChanges
);
226 /// (logically) erase the given range; return the number of chars actually erased
227 int eraseChars(pos_type start
, pos_type end
, bool trackChanges
);
230 void resetFonts(Font
const & font
);
232 /** Get uninstantiated font setting. Returns the difference
233 between the characters font and the layoutfont.
234 This is what is stored in the fonttable
237 getFontSettings(BufferParams
const &, pos_type pos
) const;
239 Font
const getFirstFontSettings(BufferParams
const &) const;
241 /** Get fully instantiated font. If pos == -1, use the layout
242 font attached to this paragraph.
243 If pos == -2, use the label font of the layout attached here.
244 In all cases, the font is instantiated, i.e. does not have any
245 attributes with values FONT_INHERIT, FONT_IGNORE or
248 Font
const getFont(BufferParams
const &, pos_type pos
,
249 Font
const & outerfont
) const;
250 Font
const getLayoutFont(BufferParams
const &,
251 Font
const & outerfont
) const;
252 Font
const getLabelFont(BufferParams
const &,
253 Font
const & outerfont
) const;
255 * The font returned by the above functions is the same in a
256 * span of characters. This method will return the first and
257 * the last positions in the paragraph for which that font is
258 * the same. This can be used to avoid unnecessary calls to getFont.
260 FontSpan
fontSpan(pos_type pos
) const;
262 char_type
getChar(pos_type pos
) const;
263 /// Get the char, but mirror all bracket characters if it is right-to-left
264 char_type
getUChar(BufferParams
const &, pos_type pos
) const;
265 /// pos <= size() (there is a dummy font change at the end of each par)
266 void setFont(pos_type pos
, Font
const & font
);
267 /// Returns the height of the highest font in range
268 FontSize
highestFontInRange(pos_type startpos
,
269 pos_type endpos
, FontSize def_size
) const;
271 void insert(pos_type pos
, docstring
const & str
,
272 Font
const & font
, Change
const & change
);
275 void appendString(docstring
const & s
, Font
const & font
,
276 Change
const & change
);
278 void appendChar(char_type c
, Font
const & font
, Change
const & change
);
280 void insertChar(pos_type pos
, char_type c
, bool trackChanges
);
282 void insertChar(pos_type pos
, char_type c
,
283 Font
const &, bool trackChanges
);
285 void insertChar(pos_type pos
, char_type c
,
286 Font
const &, Change
const & change
);
288 void insertInset(pos_type pos
, Inset
* inset
,
289 Change
const & change
);
291 void insertInset(pos_type pos
, Inset
* inset
,
292 Font
const &, Change
const & change
);
294 bool insetAllowed(InsetCode code
);
296 Inset
* getInset(pos_type pos
);
298 Inset
const * getInset(pos_type pos
) const;
300 /// Release inset at given position.
301 /// \warning does not honour change tracking!
302 /// Therefore, it should only be used for breaking and merging
304 Inset
* releaseInset(pos_type pos
);
307 InsetList
const & insetList() const;
310 bool isHfill(pos_type pos
) const;
312 /// hinted by profiler
313 bool isInset(pos_type pos
) const;
315 bool isNewline(pos_type pos
) const;
316 /// return true if the char is a word separator
317 bool isSeparator(pos_type pos
) const;
319 bool isLineSeparator(pos_type pos
) const;
320 /// True if the character/inset at this point can be part of a word.
321 /// Note that digits in particular are considered as letters
322 bool isLetter(pos_type pos
) const;
324 /// returns true if at least one line break or line separator has been deleted
325 /// at the beginning of the paragraph (either physically or logically)
326 bool stripLeadingSpaces(bool trackChanges
);
328 /// return true if we allow multiple spaces
329 bool isFreeSpacing() const;
331 /// return true if we allow this par to stay empty
332 bool allowEmpty() const;
334 char_type
transformChar(char_type c
, pos_type pos
) const;
336 ParagraphParameters
& params();
338 ParagraphParameters
const & params() const;
340 /// Check if we are in a Biblio environment and insert or
341 /// delete InsetBibitems as necessary.
342 /// \retval int 1, if we had to add an inset, in which case
343 /// the cursor will need to move cursor forward; -pos, if we deleted
344 /// an inset, in which case pos is the position from which the inset
345 /// was deleted, and the cursor will need to be moved back one if it
346 /// was previously past that position. Return 0 otherwise.
347 int checkBiblio(Buffer
const & buffer
);
349 /// For each author, set 'used' to true if there is a change
350 /// by this author in the paragraph.
351 void checkAuthors(AuthorList
const & authorList
);
354 void changeCase(BufferParams
const & bparams
, pos_type pos
,
355 pos_type
& right
, TextCase action
);
357 /// find \param str string inside Paragraph.
358 /// \return true if the specified string is at the specified position
359 /// \param del specifies whether deleted strings in ct mode will be considered
361 docstring
const & str
, ///< string to search
364 pos_type pos
, ///< start from here.
365 bool del
= true) const;
368 void updateWords(CursorSlice
const & sl
);
372 void deregisterWords();
374 void collectWords(CursorSlice
const & sl
);
376 void registerWords();
381 friend class Paragraph::Private
;
388 #endif // PARAGRAPH_H