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 "InsetList.h"
21 #include "lyxlayout_ptr_fwd.h"
22 #include "RowList_fwd.h"
24 #include "support/types.h"
39 class ParagraphParameters;
43 /// A Paragraph holds all text, attributes and insets in a text paragraph
48 /// Note that this is 1 right now to avoid
49 /// crashes where getChar() is called wrongly
50 /// (returning 0) - if this was 0, then we'd
51 /// try getInset() and crash. We should fix
56 typedef char value_type;
58 typedef lyx::depth_type depth_type;
60 typedef std::vector<value_type> TextContainer;
66 Paragraph(Paragraph const &);
68 void operator=(Paragraph const &);
69 /// the destructor removes the new paragraph from the list
76 Language const * getParLanguage(BufferParams const &) const;
78 bool isRightToLeftPar(BufferParams const &) const;
80 void changeLanguage(BufferParams const & bparams,
81 Language const * from, Language const * to);
83 bool isMultiLingual(BufferParams const &);
86 std::string const asString(Buffer const &,
87 OutputParams const & runparams,
90 std::string const asString(Buffer const &, bool label) const;
92 std::string const Paragraph::asString(Buffer const & buffer,
97 std::string const asString(Buffer const &,
98 OutputParams const & runparams,
104 void write(Buffer const &, std::ostream &, BufferParams const &,
105 depth_type & depth) const;
107 void validate(LaTeXFeatures &) const;
110 int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
113 int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
117 bool simpleTeXOnePar(Buffer const &, BufferParams const &,
118 LyXFont const & outerfont, std::ostream &,
119 TexRow & texrow, OutputParams const &);
122 void simpleLinuxDocOnePar(Buffer const & buf,
124 LyXFont const & outerfont,
125 OutputParams const & runparams,
126 lyx::depth_type depth) const;
129 void simpleDocBookOnePar(Buffer const & buf,
131 LyXFont const & outerfont,
132 OutputParams const & runparams,
133 lyx::depth_type depth,
137 bool hasSameLayout(Paragraph const & par) const;
140 void makeSameLayout(Paragraph const & par);
143 UpdatableInset * inInset() const;
145 void setInsetOwner(UpdatableInset * inset);
148 lyx::pos_type size() const { return text_.size(); }
150 bool empty() const { return text_.empty(); }
152 void setContentsFromPar(Paragraph const & par);
154 void clearContents();
157 LyXLayout_ptr const & layout() const;
159 void layout(LyXLayout_ptr const & new_layout);
161 /// This is the item depth, only used by enumerate and itemize
162 signed char itemdepth;
165 InsetBibitem * bibitem() const; // ale970302
167 /// initialise tracking for this par
168 void trackChanges(Change::Type = Change::UNCHANGED);
171 void untrackChanges();
173 /// set entire paragraph to new text for change tracking
176 /// look up change type at given pos
177 Change::Type lookupChange(lyx::pos_type pos) const;
179 /// look up change at given pos
180 Change const lookupChangeFull(lyx::pos_type pos) const;
182 /// is there a change within the given range ?
183 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
185 /// is there a non-addition in this range ?
186 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
188 /// set change at pos
189 void setChange(lyx::pos_type pos, Change::Type type);
192 void acceptChange(lyx::pos_type start, lyx::pos_type end);
195 void rejectChange(lyx::pos_type start, lyx::pos_type end);
197 /// mark whole par as erased
200 /// Paragraphs can contain "manual labels", for example, Description
201 /// environment. The text for this user-editable label is stored in
202 /// the paragraph alongside the text of the rest of the paragraph
203 /// (the body). This function returns the starting position of the
204 /// body of the text in the paragraph.
205 int beginOfBody() const;
206 /// recompute this value
207 void setBeginOfBody();
210 std::string const & getLabelstring() const;
212 /// the next two functions are for the manual labels
213 std::string const getLabelWidthString() const;
215 void setLabelWidthString(std::string const & s);
217 char getAlign() const;
218 /// The nesting depth of a paragraph
219 depth_type getDepth() const;
220 /// The maximal possible depth of a paragraph after this one
221 depth_type getMaxDepthAfter() const;
223 void applyLayout(LyXLayout_ptr const & new_layout);
226 void eraseIntern(lyx::pos_type pos);
227 /// erase the char at the given position
228 bool erase(lyx::pos_type pos);
229 /// erase the given range. Returns the number of chars actually erased
230 int erase(lyx::pos_type start, lyx::pos_type end);
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 &, lyx::pos_type pos) const;
239 LyXFont const getFirstFontSettings() 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 LyXFont::INHERIT, LyXFont::IGNORE or
248 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
249 LyXFont const & outerfont) const;
250 LyXFont const getLayoutFont(BufferParams const &,
251 LyXFont const & outerfont) const;
252 LyXFont const getLabelFont(BufferParams const &,
253 LyXFont 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 last position
257 * in the paragraph for which that font is the same.
258 * This can be used to avoid unnecessary calls to getFont.
260 lyx::pos_type getEndPosOfFontSpan(lyx::pos_type pos) const;
262 value_type getChar(lyx::pos_type pos) const;
264 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
265 /// The position must already exist.
266 void setChar(lyx::pos_type pos, value_type c);
267 /// pos <= size() (there is a dummy font change at the end of each par)
268 void setFont(lyx::pos_type pos, LyXFont const & font);
269 /// Returns the height of the highest font in range
270 LyXFont_size highestFontInRange(lyx::pos_type startpos,
271 lyx::pos_type endpos,
272 LyXFont_size def_size) const;
274 void insert(lyx::pos_type pos, std::string const & str,
275 LyXFont const & font);
277 void insertChar(lyx::pos_type pos, value_type c);
279 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
281 bool checkInsertChar(LyXFont &);
283 void insertInset(lyx::pos_type pos, InsetOld * inset);
285 void insertInset(lyx::pos_type pos, InsetOld * inset, LyXFont const &, Change change = Change(Change::INSERTED));
287 bool insetAllowed(InsetOld_code code);
289 InsetOld * getInset(lyx::pos_type pos);
291 InsetOld const * getInset(lyx::pos_type pos) const;
294 bool isHfill(lyx::pos_type pos) const;
296 bool isInset(lyx::pos_type pos) const;
298 bool isNewline(lyx::pos_type pos) const;
300 bool isSeparator(lyx::pos_type pos) const;
302 bool isLineSeparator(lyx::pos_type pos) const;
304 bool isKomma(lyx::pos_type pos) const;
305 /// Used by the spellchecker
306 bool isLetter(lyx::pos_type pos) const;
308 bool isWord(lyx::pos_type pos) const;
310 /// returns -1 if inset not found
311 int getPositionOfInset(InsetOld const * inset) const;
314 int stripLeadingSpaces();
316 /// return true if we allow multiple spaces
317 bool isFreeSpacing() const;
319 /// return true if we allow this par to stay empty
320 bool allowEmpty() const;
322 unsigned char transformChar(unsigned char c, lyx::pos_type pos) const;
324 ParagraphParameters & params();
326 ParagraphParameters const & params() const;
329 RowList::iterator getRow(lyx::pos_type pos);
335 mutable RowList rows;
336 /// last draw y position (baseline of top row)
338 /// total height of paragraph
340 /// total width of paragraph, may differ from workwidth
345 LyXLayout_ptr layout_;
346 /// keeping this here instead of in the pimpl makes LyX >10% faster
347 // for average tasks as buffer loading/switching etc.
354 friend struct Paragraph::Pimpl;
361 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
363 return par.lookupChange(pos) == Change::INSERTED;
367 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
369 return par.lookupChange(pos) == Change::DELETED;
372 #endif // PARAGRAPH_H