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
73 Language const * getParLanguage(BufferParams const &) const;
75 bool isRightToLeftPar(BufferParams const &) const;
77 void changeLanguage(BufferParams const & bparams,
78 Language const * from, Language const * to);
80 bool isMultiLingual(BufferParams const &);
83 std::string const asString(Buffer const &, bool label) const;
85 std::string const asString(Buffer const &, lyx::pos_type beg, lyx::pos_type end,
89 void write(Buffer const &, std::ostream &, BufferParams const &,
90 depth_type & depth) const;
92 void validate(LaTeXFeatures &) const;
94 /// return the unique ID of this paragraph
96 /// Set the Id of this paragraph.
100 int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
103 int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
107 bool simpleTeXOnePar(Buffer const &, BufferParams const &,
108 LyXFont const & outerfont, std::ostream &,
109 TexRow & texrow, LatexRunParams const &);
112 bool hasSameLayout(Paragraph const & par) const;
115 void makeSameLayout(Paragraph const & par);
118 UpdatableInset * inInset() const;
120 void setInsetOwner(UpdatableInset * inset);
122 void deleteInsetsLyXText(BufferView *);
125 lyx::pos_type size() const { return text_.size(); }
127 bool empty() const { return text_.empty(); }
129 void setContentsFromPar(Paragraph const & par);
131 void clearContents();
134 LyXLayout_ptr const & layout() const;
136 void layout(LyXLayout_ptr const & new_layout);
138 /// This is the item depth, only used by enumerate and itemize
139 signed char itemdepth;
142 InsetBibitem * bibitem() const; // ale970302
144 /// initialise tracking for this par
145 void trackChanges(Change::Type = Change::UNCHANGED);
148 void untrackChanges();
150 /// set entire paragraph to new text for change tracking
153 /// look up change type at given pos
154 Change::Type lookupChange(lyx::pos_type pos) const;
156 /// look up change at given pos
157 Change const lookupChangeFull(lyx::pos_type pos) const;
159 /// is there a change within the given range ?
160 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
162 /// is there a non-addition in this range ?
163 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
165 /// set change at pos
166 void setChange(lyx::pos_type pos, Change::Type type);
169 void acceptChange(lyx::pos_type start, lyx::pos_type end);
172 void rejectChange(lyx::pos_type start, lyx::pos_type end);
174 /// mark whole par as erased
177 /// Paragraphs can contain "manual labels", for example, Description
178 /// environment. The text for this user-editable label is stored in
179 /// the paragraph alongside the text of the rest of the paragraph
180 /// (the body). This function returns the starting position of the
181 /// body of the text in the paragraph.
182 int beginningOfBody() const;
185 std::string const & getLabelstring() const;
187 /// the next two functions are for the manual labels
188 std::string const getLabelWidthString() const;
190 void setLabelWidthString(std::string const & s);
192 char getAlign() const;
193 /// The nesting depth of a paragraph
194 depth_type getDepth() const;
195 /// The maximal possible depth of a paragraph after this one
196 depth_type getMaxDepthAfter() const;
198 void applyLayout(LyXLayout_ptr const & new_layout);
201 void eraseIntern(lyx::pos_type pos);
202 /// erase the char at the given position
203 bool erase(lyx::pos_type pos);
204 /// erase the given range. Returns the number of chars actually erased
205 int erase(lyx::pos_type start, lyx::pos_type end);
207 /** Get uninstantiated font setting. Returns the difference
208 between the characters font and the layoutfont.
209 This is what is stored in the fonttable
212 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
214 LyXFont const getFirstFontSettings() const;
216 /** Get fully instantiated font. If pos == -1, use the layout
217 font attached to this paragraph.
218 If pos == -2, use the label font of the layout attached here.
219 In all cases, the font is instantiated, i.e. does not have any
220 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
223 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
224 LyXFont const & outerfont) const;
225 LyXFont const getLayoutFont(BufferParams const &,
226 LyXFont const & outerfont) const;
227 LyXFont const getLabelFont(BufferParams const &,
228 LyXFont const & outerfont) const;
230 * The font returned by the above functions is the same in a
231 * span of characters. This method will return the last position
232 * in the paragraph for which that font is the same.
233 * This can be used to avoid unnecessary calls to getFont.
235 lyx::pos_type getEndPosOfFontSpan(lyx::pos_type pos) const;
237 value_type getChar(lyx::pos_type pos) const;
239 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
240 /// The position must already exist.
241 void setChar(lyx::pos_type pos, value_type c);
242 /// pos <= size() (there is a dummy font change at the end of each par)
243 void setFont(lyx::pos_type pos, LyXFont const & font);
244 /// Returns the height of the highest font in range
245 LyXFont_size highestFontInRange(lyx::pos_type startpos,
246 lyx::pos_type endpos,
247 LyXFont_size def_size) const;
249 void insertChar(lyx::pos_type pos, value_type c);
251 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
253 bool checkInsertChar(LyXFont &);
255 void insertInset(lyx::pos_type pos, InsetOld * inset);
257 void insertInset(lyx::pos_type pos, InsetOld * inset, LyXFont const &, Change change = Change(Change::INSERTED));
259 bool insetAllowed(InsetOld_code code);
261 InsetOld * getInset(lyx::pos_type pos);
263 InsetOld const * getInset(lyx::pos_type pos) const;
266 bool isHfill(lyx::pos_type pos) const;
268 bool isInset(lyx::pos_type pos) const;
270 bool isNewline(lyx::pos_type pos) const;
272 bool isSeparator(lyx::pos_type pos) const;
274 bool isLineSeparator(lyx::pos_type pos) const;
276 bool isKomma(lyx::pos_type pos) const;
277 /// Used by the spellchecker
278 bool isLetter(lyx::pos_type pos) const;
280 bool isWord(lyx::pos_type pos) const;
282 /// returns -1 if inset not found
283 int getPositionOfInset(InsetOld const * inset) const;
286 int stripLeadingSpaces();
288 /// return true if we allow multiple spaces
289 bool isFreeSpacing() const;
291 /// return true if we allow this par to stay empty
292 bool allowEmpty() const;
295 ParagraphParameters & params();
297 ParagraphParameters const & params() const;
302 mutable RowList rows;
303 /// last draw y position (baseline of top row)
308 LyXLayout_ptr layout_;
309 /// keeping this here instead of in the pimpl makes LyX >10% faster
310 // for average tasks as buffer loading/switching etc.
315 friend struct Paragraph::Pimpl;
322 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
324 return par.lookupChange(pos) == Change::INSERTED;
328 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
330 return par.lookupChange(pos) == Change::DELETED;
333 #endif // PARAGRAPH_H