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
27 #include "support/types.h"
46 class ParagraphParameters;
50 /// A Paragraph holds all text, attributes and insets in a text paragraph
55 /// Note that this is 1 right now to avoid
56 /// crashes where getChar() is called wrongly
57 /// (returning 0) - if this was 0, then we'd
58 /// try getInset() and crash. We should fix
63 typedef char value_type;
65 typedef lyx::depth_type depth_type;
67 typedef std::vector<value_type> TextContainer;
72 Paragraph(Paragraph const &);
74 Paragraph & operator=(Paragraph const &);
82 Language const * getParLanguage(BufferParams const &) const;
84 bool isRightToLeftPar(BufferParams const &) const;
86 void changeLanguage(BufferParams const & bparams,
87 Language const * from, Language const * to);
89 bool isMultiLingual(BufferParams const &) const;
92 std::string const asString(Buffer const &,
93 OutputParams const & runparams,
96 std::string const asString(Buffer const &, bool label) const;
98 std::string const Paragraph::asString(Buffer const & buffer,
103 std::string const asString(Buffer const &,
104 OutputParams const & runparams,
110 void write(Buffer const &, std::ostream &, BufferParams const &,
111 depth_type & depth) const;
113 void validate(LaTeXFeatures &) const;
116 int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
119 int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
123 bool simpleTeXOnePar(Buffer const &, BufferParams const &,
124 LyXFont const & outerfont, std::ostream &,
125 TexRow & texrow, OutputParams const &) const;
127 /// Writes to stream the content of the paragraph for linuxdoc
128 void simpleLinuxDocOnePar(Buffer const & buf,
130 LyXFont const & outerfont,
131 OutputParams const & runparams,
132 lyx::depth_type depth) const;
134 /// Can we drop the standard paragraph wrapper?
135 bool emptyTag() const;
137 /// Get the id of the paragraph, usefull for docbook and linuxdoc
138 std::string getID(Buffer const & buf,
139 OutputParams const & runparams) const;
141 // Get the first word of a paragraph, return the position where it left
142 lyx::pos_type getFirstWord(Buffer const & buf,
144 OutputParams const & runparams) const;
146 /// Checks if the paragraph contains only text and no inset or font change.
147 bool onlyText(Buffer const & buf, LyXFont const & outerfont,
148 lyx::pos_type initial) const;
150 /// Writes to stream the docbook representation
151 void simpleDocBookOnePar(Buffer const & buf,
153 OutputParams const & runparams,
154 LyXFont const & outerfont,
155 lyx::pos_type initial = 0) const;
158 bool hasSameLayout(Paragraph const & par) const;
161 void makeSameLayout(Paragraph const & par);
164 void setInsetOwner(InsetBase * inset);
166 InsetBase * inInset() const;
168 InsetBase::Code ownerCode() const;
170 bool forceDefaultParagraphs() const;
173 lyx::pos_type size() const { return text_.size(); }
175 bool empty() const { return text_.empty(); }
177 void setContentsFromPar(Paragraph const & par);
179 void clearContents();
182 LyXLayout_ptr const & layout() const;
184 void layout(LyXLayout_ptr const & new_layout);
186 /// This is the item depth, only used by enumerate and itemize
187 signed char itemdepth;
190 InsetBibitem * bibitem() const; // ale970302
192 /// initialise tracking for this par
193 void trackChanges(Change::Type = Change::UNCHANGED);
196 void untrackChanges();
198 /// set entire paragraph to new text for change tracking
201 /// look up change type at given pos
202 Change::Type lookupChange(lyx::pos_type pos) const;
204 /// look up change at given pos
205 Change const lookupChangeFull(lyx::pos_type pos) const;
207 /// is there a change within the given range ?
208 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
210 /// is there a non-addition in this range ?
211 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
213 /// set change at pos
214 void setChange(lyx::pos_type pos, Change::Type type);
217 void acceptChange(lyx::pos_type start, lyx::pos_type end);
220 void rejectChange(lyx::pos_type start, lyx::pos_type end);
222 /// mark whole par as erased
225 /// Paragraphs can contain "manual labels", for example, Description
226 /// environment. The text for this user-editable label is stored in
227 /// the paragraph alongside the text of the rest of the paragraph
228 /// (the body). This function returns the starting position of the
229 /// body of the text in the paragraph.
230 lyx::pos_type beginOfBody() const;
231 /// recompute this value
232 void setBeginOfBody();
235 std::string const & getLabelstring() const;
237 /// the next two functions are for the manual labels
238 std::string const getLabelWidthString() const;
240 void setLabelWidthString(std::string const & s);
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(LyXLayout_ptr const & new_layout);
251 void eraseIntern(lyx::pos_type pos);
252 /// erase the char at the given position
253 bool erase(lyx::pos_type pos);
254 /// erase the given range. Returns the number of chars actually erased
255 int erase(lyx::pos_type start, lyx::pos_type end);
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 &, lyx::pos_type pos) const;
264 LyXFont const getFirstFontSettings() 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 LyXFont::INHERIT, LyXFont::IGNORE or
273 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
274 LyXFont const & outerfont) const;
275 LyXFont const getLayoutFont(BufferParams const &,
276 LyXFont const & outerfont) const;
277 LyXFont const getLabelFont(BufferParams const &,
278 LyXFont 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 last positions in the paragraph for which that
283 * font is the same. This can be used to avoid unnecessary
286 std::pair<lyx::pos_type, lyx::pos_type> getFontSpan(lyx::pos_type pos) const;
288 /// this is a bottleneck.
289 value_type getChar(lyx::pos_type pos) const { return text_[pos]; }
290 /// Get the char, but mirror all bracket characters if it is right-to-left
291 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
292 /// The position must already exist.
293 void setChar(lyx::pos_type pos, value_type c);
294 /// pos <= size() (there is a dummy font change at the end of each par)
295 void setFont(lyx::pos_type pos, LyXFont const & font);
296 /// Returns the height of the highest font in range
297 LyXFont_size highestFontInRange(lyx::pos_type startpos,
298 lyx::pos_type endpos,
299 LyXFont_size def_size) const;
301 void insert(lyx::pos_type pos, std::string const & str,
302 LyXFont const & font);
304 void insertChar(lyx::pos_type pos, value_type c,
305 Change change = Change::INSERTED);
307 void insertChar(lyx::pos_type pos, value_type c,
308 LyXFont const &, Change change = Change::INSERTED);
310 void insertInset(lyx::pos_type pos, InsetBase * inset,
311 Change change = Change::INSERTED);
313 void insertInset(lyx::pos_type pos, InsetBase * inset,
314 LyXFont const &, Change change = Change::INSERTED);
316 bool insetAllowed(InsetBase_code code);
318 InsetBase * getInset(lyx::pos_type pos);
320 InsetBase const * getInset(lyx::pos_type pos) const;
326 bool isHfill(lyx::pos_type pos) const;
327 /// hinted by profiler
328 bool isInset(lyx::pos_type pos) const {
329 return getChar(pos) == static_cast<value_type>(META_INSET);
332 bool isNewline(lyx::pos_type pos) const;
334 bool isSeparator(lyx::pos_type pos) const;
336 bool isLineSeparator(lyx::pos_type pos) const;
337 /// True if the character/inset at this point can be part of a word
338 // Note that digits in particular are considered as letters
339 bool isLetter(lyx::pos_type pos) const;
341 /// returns -1 if inset not found
342 int getPositionOfInset(InsetBase const * inset) const;
344 /// Returns the number of line breaks and white-space stripped at the start
345 int stripLeadingSpaces();
347 /// return true if we allow multiple spaces
348 bool isFreeSpacing() const;
350 /// return true if we allow this par to stay empty
351 bool allowEmpty() const;
353 unsigned char transformChar(unsigned char c, lyx::pos_type pos) const;
355 ParagraphParameters & params();
357 ParagraphParameters const & params() const;
360 Row & getRow(lyx::pos_type pos);
362 Row const & getRow(lyx::pos_type pos) const;
364 size_t pos2row(lyx::pos_type pos) const;
366 /// total height of paragraph
367 unsigned int height() const { return dim_.height(); }
368 /// total width of paragraph, may differ from workwidth
369 unsigned int width() const { return dim_.width(); }
370 /// ascend of paragraph above baseline
371 unsigned int ascent() const { return dim_.ascent(); }
372 /// descend of paragraph below baseline
373 unsigned int descent() const { return dim_.descent(); }
374 /// LyXText updates the rows using this access point
375 RowList & rows() { return rows_; }
376 /// The painter and others use this
377 RowList const & rows() const { return rows_; }
379 /// LyXText::redoParagraph updates this
380 Dimension & dim() { return dim_; }
382 /// dump some information to lyxerr
385 /// cached dimensions of paragraph
389 mutable RowList rows_;
391 LyXLayout_ptr layout_;
393 * Keeping this here instead of in the pimpl makes LyX >10% faster
394 * for average tasks as buffer loading/switching etc.
398 lyx::pos_type begin_of_body_;
402 friend class Paragraph::Pimpl;
408 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
410 return par.lookupChange(pos) == Change::INSERTED;
414 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
416 return par.lookupChange(pos) == Change::DELETED;
419 #endif // PARAGRAPH_H