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.
20 #include "dimension.h"
21 #include "InsetList.h"
22 #include "lyxlayout_ptr_fwd.h"
23 #include "RowList_fwd.h"
25 #include "insets/insetbase.h" // only for InsetBase::Code
45 class ParagraphParameters;
51 /// Invalid font span containing no character
52 FontSpan() : first(0), last(-1) {}
53 /// Span including first and last
54 FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
57 /// Range including first and last.
62 /// A Paragraph holds all text, attributes and insets in a text paragraph
67 /// Note that this is 1 right now to avoid
68 /// crashes where getChar() is called wrongly
69 /// (returning 0) - if this was 0, then we'd
70 /// try getInset() and crash. We should fix
72 //META_INSET = 1 // as in trunk
73 META_INSET = 0x200001 // above 0x10ffff, for ucs-4
76 typedef char_type value_type;
78 typedef std::vector<value_type> TextContainer;
83 Paragraph(Paragraph const &);
85 Paragraph & operator=(Paragraph const &);
93 Language const * getParLanguage(BufferParams const &) const;
95 bool isRightToLeftPar(BufferParams const &) const;
97 void changeLanguage(BufferParams const & bparams,
98 Language const * from, Language const * to);
100 bool isMultiLingual(BufferParams const &) const;
103 docstring const asString(Buffer const &,
104 OutputParams const & runparams,
107 docstring const asString(Buffer const &, bool label) const;
109 docstring const asString(Buffer const & buffer,
114 docstring const asString(Buffer const &,
115 OutputParams const & runparams,
121 void write(Buffer const &, std::ostream &, BufferParams const &,
122 depth_type & depth) const;
124 void validate(LaTeXFeatures &) const;
127 int startTeXParParams(BufferParams const &, odocstream &, bool) const;
130 int endTeXParParams(BufferParams const &, odocstream &, bool) const;
134 bool simpleTeXOnePar(Buffer const &, BufferParams const &,
135 LyXFont const & outerfont, odocstream &,
136 TexRow & texrow, OutputParams const &) 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,
143 OutputParams const & runparams) const;
145 // Get the first word of a paragraph, return the position where it left
146 pos_type getFirstWord(Buffer const & buf,
148 OutputParams const & runparams) const;
150 /// Checks if the paragraph contains only text and no inset or font change.
151 bool onlyText(Buffer const & buf, LyXFont const & outerfont,
152 pos_type initial) const;
154 /// Writes to stream the docbook representation
155 void simpleDocBookOnePar(Buffer const & buf,
157 OutputParams const & runparams,
158 LyXFont const & outerfont,
159 pos_type initial = 0) const;
162 bool hasSameLayout(Paragraph const & par) const;
165 void makeSameLayout(Paragraph const & par);
168 void setInsetOwner(InsetBase * inset);
170 InsetBase * inInset() const;
172 InsetBase::Code ownerCode() const;
174 bool forceDefaultParagraphs() const;
177 pos_type size() const { return text_.size(); }
179 bool empty() const { return text_.empty(); }
181 void clearContents();
184 LyXLayout_ptr const & layout() const;
186 void layout(LyXLayout_ptr const & new_layout);
188 /// This is the item depth, only used by enumerate and itemize
189 signed char itemdepth;
192 InsetBibitem * bibitem() const; // ale970302
194 /// look up change at given pos
195 Change const lookupChange(pos_type pos) const;
197 /// is there a change within the given range ?
198 bool isChanged(pos_type start, pos_type end) const;
199 /// is there an unchanged char at the given pos ?
200 bool isUnchanged(pos_type pos) const {
201 return lookupChange(pos).type == Change::UNCHANGED;
203 /// is there an insertion at the given pos ?
204 bool isInserted(pos_type pos) const {
205 return lookupChange(pos).type == Change::INSERTED;
207 /// is there a deletion at the given pos ?
208 bool isDeleted(pos_type pos) const {
209 return lookupChange(pos).type == Change::DELETED;
212 /// will the paragraph be physically merged with the next
213 /// one if the imaginary end-of-par character is logically deleted?
214 bool isMergedOnEndOfParDeletion(bool trackChanges) const;
216 /// set change for the entire par
217 void setChange(Change const & change);
219 /// set change at given pos
220 void setChange(pos_type pos, Change const & change);
222 /// accept changes within the given range
223 void acceptChanges(pos_type start, pos_type end);
225 /// reject changes within the given range
226 void rejectChanges(pos_type start, pos_type end);
228 /// Paragraphs can contain "manual labels", for example, Description
229 /// environment. The text for this user-editable label is stored in
230 /// the paragraph alongside the text of the rest of the paragraph
231 /// (the body). This function returns the starting position of the
232 /// body of the text in the paragraph.
233 pos_type beginOfBody() const;
234 /// recompute this value
235 void setBeginOfBody();
238 docstring const & getLabelstring() const;
240 /// the next two functions are for the manual labels
241 docstring const getLabelWidthString() const;
243 void setLabelWidthString(docstring const & s);
245 char getAlign() const;
246 /// The nesting depth of a paragraph
247 depth_type getDepth() const;
248 /// The maximal possible depth of a paragraph after this one
249 depth_type getMaxDepthAfter() const;
251 void applyLayout(LyXLayout_ptr const & new_layout);
253 /// (logically) erase the char at pos; return true if it was actually erased
254 bool eraseChar(pos_type pos, bool trackChanges);
255 /// (logically) erase the given range; return the number of chars actually erased
256 int eraseChars(pos_type start, pos_type end, bool trackChanges);
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 LyXFont 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 LyXFont::INHERIT, LyXFont::IGNORE or
274 LyXFont const getFont(BufferParams const &, pos_type pos,
275 LyXFont const & outerfont) const;
276 LyXFont const getLayoutFont(BufferParams const &,
277 LyXFont const & outerfont) const;
278 LyXFont const getLabelFont(BufferParams const &,
279 LyXFont 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
287 FontSpan fontSpan(pos_type pos) const;
289 /// this is a bottleneck.
290 value_type getChar(pos_type pos) const { return text_[pos]; }
291 /// Get the char, but mirror all bracket characters if it is right-to-left
292 value_type getUChar(BufferParams const &, pos_type pos) const;
293 /// pos <= size() (there is a dummy font change at the end of each par)
294 void setFont(pos_type pos, LyXFont const & font);
295 /// Returns the height of the highest font in range
296 LyXFont_size highestFontInRange(pos_type startpos,
297 pos_type endpos, LyXFont_size def_size) const;
299 void insert(pos_type pos, docstring const & str,
300 LyXFont const & font, Change const & change);
302 void insertChar(pos_type pos, value_type c, bool trackChanges);
304 void insertChar(pos_type pos, value_type c,
305 LyXFont const &, bool trackChanges);
307 void insertChar(pos_type pos, value_type c,
308 LyXFont const &, Change const & change);
310 void insertInset(pos_type pos, InsetBase * inset,
311 Change const & change);
313 void insertInset(pos_type pos, InsetBase * inset,
314 LyXFont const &, Change const & change);
316 bool insetAllowed(InsetBase_code code);
318 InsetBase * getInset(pos_type pos) {
319 return insetlist.get(pos);
322 InsetBase const * getInset(pos_type pos) const {
323 return insetlist.get(pos);
327 bool isHfill(pos_type pos) const {
329 && getInset(pos)->lyxCode() == InsetBase::HFILL_CODE;
331 /// hinted by profiler
332 bool isInset(pos_type pos) const {
333 return getChar(pos) == static_cast<value_type>(META_INSET);
336 bool isNewline(pos_type pos) const;
337 /// return true if the char is a word separator
338 bool isSeparator(pos_type pos) const { return getChar(pos) == ' '; }
340 bool isLineSeparator(pos_type pos) const;
341 /// True if the character/inset at this point can be part of a word
342 // Note that digits in particular are considered as letters
343 bool isLetter(pos_type pos) const;
345 /// returns -1 if inset not found
346 int getPositionOfInset(InsetBase const * inset) const;
348 /// Returns the number of line breaks and white-space stripped at the start
349 int stripLeadingSpaces();
351 /// return true if we allow multiple spaces
352 bool isFreeSpacing() const;
354 /// return true if we allow this par to stay empty
355 bool allowEmpty() const;
357 char_type transformChar(char_type c, pos_type pos) const;
359 ParagraphParameters & params();
361 ParagraphParameters const & params() const;
364 Row & getRow(pos_type pos, bool boundary);
366 Row const & getRow(pos_type pos, bool boundary) const;
368 size_t pos2row(pos_type pos) const;
370 /// total height of paragraph
371 unsigned int height() const { return dim_.height(); }
372 /// total width of paragraph, may differ from workwidth
373 unsigned int width() const { return dim_.width(); }
374 /// ascend of paragraph above baseline
375 unsigned int ascent() const { return dim_.ascent(); }
376 /// descend of paragraph below baseline
377 unsigned int descent() const { return dim_.descent(); }
378 /// LyXText updates the rows using this access point
379 RowList & rows() { return rows_; }
380 /// The painter and others use this
381 RowList const & rows() const { return rows_; }
383 RowSignature & rowSignature() const { return rowSignature_; }
385 bool hfillExpansion(Row const & row, pos_type pos) const;
387 /// LyXText::redoParagraph updates this
388 Dimension & dim() { return dim_; }
390 /// dump some information to lyxerr
398 /// cached dimensions of paragraph
402 mutable RowList rows_;
404 mutable RowSignature rowSignature_;
407 LyXLayout_ptr layout_;
409 * Keeping this here instead of in the pimpl makes LyX >10% faster
410 * for average tasks as buffer loading/switching etc.
414 pos_type begin_of_body_;
419 friend class Paragraph::Pimpl;
427 #endif // PARAGRAPH_H