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"
29 #include <boost/assert.hpp>
48 class ParagraphParameters;
52 /// A Paragraph holds all text, attributes and insets in a text paragraph
57 /// Note that this is 1 right now to avoid
58 /// crashes where getChar() is called wrongly
59 /// (returning 0) - if this was 0, then we'd
60 /// try getInset() and crash. We should fix
65 typedef char value_type;
67 typedef lyx::depth_type depth_type;
69 typedef std::vector<value_type> TextContainer;
74 Paragraph(Paragraph const &);
76 Paragraph & operator=(Paragraph const &);
84 Language const * getParLanguage(BufferParams const &) const;
86 bool isRightToLeftPar(BufferParams const &) const;
88 void changeLanguage(BufferParams const & bparams,
89 Language const * from, Language const * to);
91 bool isMultiLingual(BufferParams const &) const;
94 std::string const asString(Buffer const &,
95 OutputParams const & runparams,
98 std::string const asString(Buffer const &, bool label) const;
100 std::string const Paragraph::asString(Buffer const & buffer,
105 std::string const asString(Buffer const &,
106 OutputParams const & runparams,
112 void write(Buffer const &, std::ostream &, BufferParams const &,
113 depth_type & depth) const;
115 void validate(LaTeXFeatures &) const;
118 int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
121 int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
125 bool simpleTeXOnePar(Buffer const &, BufferParams const &,
126 LyXFont const & outerfont, std::ostream &,
127 TexRow & texrow, OutputParams const &) const;
129 /// Writes to stream the content of the paragraph for linuxdoc
130 void simpleLinuxDocOnePar(Buffer const & buf,
132 LyXFont const & outerfont,
133 OutputParams const & runparams,
134 lyx::depth_type depth) const;
136 /// Can we drop the standard paragraph wrapper?
137 bool emptyTag() const;
139 /// Get the id of the paragraph, usefull for docbook and linuxdoc
140 std::string getID(Buffer const & buf,
141 OutputParams const & runparams) const;
143 // Get the first word of a paragraph, return the position where it left
144 lyx::pos_type getFirstWord(Buffer const & buf,
146 OutputParams const & runparams) const;
148 /// Checks if the paragraph contains only text and no inset or font change.
149 bool onlyText(Buffer const & buf, LyXFont const & outerfont,
150 lyx::pos_type initial) const;
152 /// Writes to stream the docbook representation
153 void simpleDocBookOnePar(Buffer const & buf,
155 OutputParams const & runparams,
156 LyXFont const & outerfont,
157 lyx::pos_type initial = 0) const;
160 bool hasSameLayout(Paragraph const & par) const;
163 void makeSameLayout(Paragraph const & par);
166 void setInsetOwner(InsetBase * inset);
168 InsetBase * inInset() const;
170 InsetBase::Code ownerCode() const;
172 bool forceDefaultParagraphs() const;
175 lyx::pos_type size() const { return text_.size(); }
177 bool empty() const { return text_.empty(); }
179 void setContentsFromPar(Paragraph const & par);
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 /// initialise tracking for this par
195 void trackChanges(Change::Type = Change::UNCHANGED);
198 void untrackChanges();
200 /// set entire paragraph to new text for change tracking
203 /// look up change type at given pos
204 Change::Type lookupChange(lyx::pos_type pos) const;
206 /// look up change at given pos
207 Change const lookupChangeFull(lyx::pos_type pos) const;
209 /// is there a change within the given range ?
210 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
212 /// is there a non-addition in this range ?
213 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
215 /// set change at pos
216 void setChange(lyx::pos_type pos, Change::Type type);
219 void acceptChange(lyx::pos_type start, lyx::pos_type end);
222 void rejectChange(lyx::pos_type start, lyx::pos_type end);
224 /// mark whole par as erased
227 /// Paragraphs can contain "manual labels", for example, Description
228 /// environment. The text for this user-editable label is stored in
229 /// the paragraph alongside the text of the rest of the paragraph
230 /// (the body). This function returns the starting position of the
231 /// body of the text in the paragraph.
232 lyx::pos_type beginOfBody() const;
233 /// recompute this value
234 void setBeginOfBody();
237 std::string const & getLabelstring() const;
239 /// the next two functions are for the manual labels
240 std::string const getLabelWidthString() const;
242 void setLabelWidthString(std::string const & s);
244 char getAlign() const;
245 /// The nesting depth of a paragraph
246 depth_type getDepth() const;
247 /// The maximal possible depth of a paragraph after this one
248 depth_type getMaxDepthAfter() const;
250 void applyLayout(LyXLayout_ptr const & new_layout);
253 void eraseIntern(lyx::pos_type pos);
254 /// erase the char at the given position
255 bool erase(lyx::pos_type pos);
256 /// erase the given range. Returns the number of chars actually erased
257 int erase(lyx::pos_type start, lyx::pos_type end);
259 /** Get uninstantiated font setting. Returns the difference
260 between the characters font and the layoutfont.
261 This is what is stored in the fonttable
264 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
266 LyXFont const getFirstFontSettings() const;
268 /** Get fully instantiated font. If pos == -1, use the layout
269 font attached to this paragraph.
270 If pos == -2, use the label font of the layout attached here.
271 In all cases, the font is instantiated, i.e. does not have any
272 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
275 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
276 LyXFont const & outerfont) const;
277 LyXFont const getLayoutFont(BufferParams const &,
278 LyXFont const & outerfont) const;
279 LyXFont const getLabelFont(BufferParams const &,
280 LyXFont const & outerfont) const;
282 * The font returned by the above functions is the same in a
283 * span of characters. This method will return the first and
284 * the last last positions in the paragraph for which that
285 * font is the same. This can be used to avoid unnecessary
288 std::pair<lyx::pos_type, lyx::pos_type> getFontSpan(lyx::pos_type pos) const;
290 /// this is a bottleneck.
291 value_type getChar(lyx::pos_type pos) const
293 BOOST_ASSERT(pos >= 0);
294 BOOST_ASSERT(pos < int(text_.size()));
297 /// Get the char, but mirror all bracket characters if it is right-to-left
298 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
299 /// The position must already exist.
300 void setChar(lyx::pos_type pos, value_type c);
301 /// pos <= size() (there is a dummy font change at the end of each par)
302 void setFont(lyx::pos_type pos, LyXFont const & font);
303 /// Returns the height of the highest font in range
304 LyXFont_size highestFontInRange(lyx::pos_type startpos,
305 lyx::pos_type endpos,
306 LyXFont_size def_size) const;
308 void insert(lyx::pos_type pos, std::string const & str,
309 LyXFont const & font);
311 void insertChar(lyx::pos_type pos, value_type c,
312 Change change = Change(Change::INSERTED));
314 void insertChar(lyx::pos_type pos, value_type c,
315 LyXFont const &, Change change = Change(Change::INSERTED));
317 bool checkInsertChar(LyXFont &);
319 void insertInset(lyx::pos_type pos, InsetBase * inset,
320 Change change = Change(Change::INSERTED));
322 void insertInset(lyx::pos_type pos, InsetBase * inset,
323 LyXFont const &, Change change = Change(Change::INSERTED));
325 bool insetAllowed(InsetBase_code code);
327 InsetBase * getInset(lyx::pos_type pos);
329 InsetBase const * getInset(lyx::pos_type pos) const;
335 bool isHfill(lyx::pos_type pos) const;
336 /// hinted by profiler
337 bool isInset(lyx::pos_type pos) const { return getChar(pos) == static_cast<value_type>(META_INSET); }
339 bool isNewline(lyx::pos_type pos) const;
341 bool isSeparator(lyx::pos_type pos) const;
343 bool isLineSeparator(lyx::pos_type pos) const;
344 /// True if the character/inset at this point can be part of a word
345 // Note that digits in particular are considered as letters
346 bool isLetter(lyx::pos_type pos) const;
348 /// returns -1 if inset not found
349 int getPositionOfInset(InsetBase const * inset) const;
351 /// Returns the number of line breaks and white-space stripped at the start
352 int stripLeadingSpaces();
354 /// return true if we allow multiple spaces
355 bool isFreeSpacing() const;
357 /// return true if we allow this par to stay empty
358 bool allowEmpty() const;
360 unsigned char transformChar(unsigned char c, lyx::pos_type pos) const;
362 ParagraphParameters & params();
364 ParagraphParameters const & params() const;
367 Row & getRow(lyx::pos_type pos);
369 Row const & getRow(lyx::pos_type pos) const;
371 size_t pos2row(lyx::pos_type pos) const;
373 /// total height of paragraph
374 unsigned int height() const { return dim_.height(); }
375 /// total width of paragraph, may differ from workwidth
376 unsigned int width() const { return dim_.width(); }
377 unsigned int ascent() const { return dim_.ascent(); }
378 unsigned int descent() const { return dim_.descent(); }
379 /// LyXText updates the rows using this access point
380 RowList & rows() { return rows_; }
381 /// The painter and others use this
382 RowList const & rows() const { return rows_; }
384 /// LyXText::redoParagraph updates this
385 Dimension & dim() { return dim_; }
387 /// dump some information to lyxerr
390 /// cached dimensions of paragraph
394 mutable RowList rows_;
396 LyXLayout_ptr layout_;
398 * Keeping this here instead of in the pimpl makes LyX >10% faster
399 * for average tasks as buffer loading/switching etc.
403 lyx::pos_type begin_of_body_;
407 friend class Paragraph::Pimpl;
413 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
415 return par.lookupChange(pos) == Change::INSERTED;
419 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
421 return par.lookupChange(pos) == Change::DELETED;
424 #endif // PARAGRAPH_H