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>
47 class ParagraphParameters;
51 /// A Paragraph holds all text, attributes and insets in a text paragraph
56 /// Note that this is 1 right now to avoid
57 /// crashes where getChar() is called wrongly
58 /// (returning 0) - if this was 0, then we'd
59 /// try getInset() and crash. We should fix
64 typedef char value_type;
66 typedef lyx::depth_type depth_type;
68 typedef std::vector<value_type> TextContainer;
73 Paragraph(Paragraph const &);
75 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 Paragraph::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(UpdatableInset * inset);
168 UpdatableInset * inInset() const;
170 InsetBase::Code ownerCode() const;
172 bool autoBreakRows() const;
174 bool forceDefaultParagraphs() const;
177 lyx::pos_type size() const { return text_.size(); }
179 bool empty() const { return text_.empty(); }
181 void setContentsFromPar(Paragraph const & par);
183 void clearContents();
186 LyXLayout_ptr const & layout() const;
188 void layout(LyXLayout_ptr const & new_layout);
190 /// This is the item depth, only used by enumerate and itemize
191 signed char itemdepth;
194 InsetBibitem * bibitem() const; // ale970302
196 /// initialise tracking for this par
197 void trackChanges(Change::Type = Change::UNCHANGED);
200 void untrackChanges();
202 /// set entire paragraph to new text for change tracking
205 /// look up change type at given pos
206 Change::Type lookupChange(lyx::pos_type pos) const;
208 /// look up change at given pos
209 Change const lookupChangeFull(lyx::pos_type pos) const;
211 /// is there a change within the given range ?
212 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
214 /// is there a non-addition in this range ?
215 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
217 /// set change at pos
218 void setChange(lyx::pos_type pos, Change::Type type);
221 void acceptChange(lyx::pos_type start, lyx::pos_type end);
224 void rejectChange(lyx::pos_type start, lyx::pos_type end);
226 /// mark whole par as erased
229 /// Paragraphs can contain "manual labels", for example, Description
230 /// environment. The text for this user-editable label is stored in
231 /// the paragraph alongside the text of the rest of the paragraph
232 /// (the body). This function returns the starting position of the
233 /// body of the text in the paragraph.
234 lyx::pos_type beginOfBody() const;
235 /// recompute this value
236 void setBeginOfBody();
239 std::string const & getLabelstring() const;
241 /// the next two functions are for the manual labels
242 std::string const getLabelWidthString() const;
244 void setLabelWidthString(std::string const & s);
246 char getAlign() const;
247 /// The nesting depth of a paragraph
248 depth_type getDepth() const;
249 /// The maximal possible depth of a paragraph after this one
250 depth_type getMaxDepthAfter() const;
252 void applyLayout(LyXLayout_ptr const & new_layout);
255 void eraseIntern(lyx::pos_type pos);
256 /// erase the char at the given position
257 bool erase(lyx::pos_type pos);
258 /// erase the given range. Returns the number of chars actually erased
259 int erase(lyx::pos_type start, lyx::pos_type end);
261 /** Get uninstantiated font setting. Returns the difference
262 between the characters font and the layoutfont.
263 This is what is stored in the fonttable
266 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
268 LyXFont const getFirstFontSettings() const;
270 /** Get fully instantiated font. If pos == -1, use the layout
271 font attached to this paragraph.
272 If pos == -2, use the label font of the layout attached here.
273 In all cases, the font is instantiated, i.e. does not have any
274 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
277 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
278 LyXFont const & outerfont) const;
279 LyXFont const getLayoutFont(BufferParams const &,
280 LyXFont const & outerfont) const;
281 LyXFont const getLabelFont(BufferParams const &,
282 LyXFont const & outerfont) const;
284 * The font returned by the above functions is the same in a
285 * span of characters. This method will return the last position
286 * in the paragraph for which that font is the same.
287 * This can be used to avoid unnecessary calls to getFont.
289 lyx::pos_type getEndPosOfFontSpan(lyx::pos_type pos) const;
291 /// this is a bottleneck.
292 value_type getChar(lyx::pos_type pos) const
294 BOOST_ASSERT(pos >= 0);
295 BOOST_ASSERT(pos < int(text_.size()));
299 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
300 /// The position must already exist.
301 void setChar(lyx::pos_type pos, value_type c);
302 /// pos <= size() (there is a dummy font change at the end of each par)
303 void setFont(lyx::pos_type pos, LyXFont const & font);
304 /// Returns the height of the highest font in range
305 LyXFont_size highestFontInRange(lyx::pos_type startpos,
306 lyx::pos_type endpos,
307 LyXFont_size def_size) const;
309 void insert(lyx::pos_type pos, std::string const & str,
310 LyXFont const & font);
312 void insertChar(lyx::pos_type pos, value_type c,
313 Change change = Change(Change::INSERTED));
315 void insertChar(lyx::pos_type pos, value_type c,
316 LyXFont const &, Change change = Change(Change::INSERTED));
318 bool checkInsertChar(LyXFont &);
320 void insertInset(lyx::pos_type pos, InsetBase * inset,
321 Change change = Change(Change::INSERTED));
323 void insertInset(lyx::pos_type pos, InsetBase * inset,
324 LyXFont const &, Change change = Change(Change::INSERTED));
326 bool insetAllowed(InsetBase_code code);
328 InsetBase * getInset(lyx::pos_type pos);
330 InsetBase const * getInset(lyx::pos_type pos) const;
333 bool isHfill(lyx::pos_type pos) const;
334 /// hinted by profiler
335 bool isInset(lyx::pos_type pos) const { return getChar(pos) == static_cast<value_type>(META_INSET); }
337 bool isNewline(lyx::pos_type pos) const;
339 bool isSeparator(lyx::pos_type pos) const;
341 bool isLineSeparator(lyx::pos_type pos) const;
342 /// True if the character/inset at this point can be part of a word
343 // Note that digits in particular are considered as letters
344 bool isLetter(lyx::pos_type pos) const;
346 /// returns -1 if inset not found
347 int getPositionOfInset(InsetBase const * inset) const;
350 int stripLeadingSpaces();
352 /// return true if we allow multiple spaces
353 bool isFreeSpacing() const;
355 /// return true if we allow this par to stay empty
356 bool allowEmpty() const;
358 unsigned char transformChar(unsigned char c, lyx::pos_type pos) const;
360 ParagraphParameters & params();
362 ParagraphParameters const & params() const;
365 Row & getRow(lyx::pos_type pos);
367 Row const & getRow(lyx::pos_type pos) const;
369 size_t pos2row(lyx::pos_type pos) const;
374 /// total height of paragraph
375 unsigned int height() const { return dim_.height(); }
376 /// total width of paragraph, may differ from workwidth
377 unsigned int width() const { return dim_.width(); }
378 unsigned int ascent() const { return dim_.ascent(); }
379 unsigned int descent() const { return dim_.descent(); }
381 RowList & rows() { return rows_; }
383 RowList const & rows() const { return rows_; }
385 // compute paragraph metrics
386 void metrics(MetricsInfo & mi, Dimension & dim, LyXText & text);
388 void draw(PainterInfo & pi, int x, int y, LyXText & text) const;
389 /// dump some information
392 /// cached dimensions of paragraph
397 mutable RowList rows_;
399 LyXLayout_ptr layout_;
400 /// keeping this here instead of in the pimpl makes LyX >10% faster
401 // for average tasks as buffer loading/switching etc.
404 lyx::pos_type begin_of_body_;
408 friend struct Paragraph::Pimpl;
415 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
417 return par.lookupChange(pos) == Change::INSERTED;
421 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
423 return par.lookupChange(pos) == Change::DELETED;
426 #endif // PARAGRAPH_H