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.
19 #include "lyxlayout_ptr_fwd.h"
20 #include "lyxfont.h" // Just for LyXFont::FONT_SIZE
21 #include "InsetList.h"
23 #include "insets/inset.h" // Just for InsetOld::Code
25 #include "support/types.h"
39 class ParagraphParameters;
44 /// A Paragraph holds all text, attributes and insets in a text paragraph
49 /// Note that this is 1 right now to avoid
50 /// crashes where getChar() is called wrongly
51 /// (returning 0) - if this was 0, then we'd
52 /// try getInset() and crash. We should fix
57 typedef char value_type;
58 /// The same as ParameterStruct::depth_type
59 typedef unsigned int depth_type;
65 Paragraph(Paragraph const &);
67 void operator=(Paragraph const &);
68 /// the destructor removes the new paragraph from the list
72 Language const * getParLanguage(BufferParams const &) const;
74 bool isRightToLeftPar(BufferParams const &) const;
76 void changeLanguage(BufferParams const & bparams,
77 Language const * from, Language const * to);
79 bool isMultiLingual(BufferParams const &);
82 string const asString(Buffer const &, bool label) const;
84 string const asString(Buffer const &, lyx::pos_type beg, lyx::pos_type end,
88 void write(Buffer const &, std::ostream &, BufferParams const &,
89 depth_type & depth) const;
91 void validate(LaTeXFeatures &) const;
93 /// return the unique ID of this paragraph
95 /// Set the Id of this paragraph.
99 int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
102 int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
106 bool simpleTeXOnePar(Buffer const &, BufferParams const &,
107 LyXFont const & outerfont, std::ostream &,
108 TexRow & texrow, LatexRunParams const &);
111 bool hasSameLayout(Paragraph const & par) const;
114 void makeSameLayout(Paragraph const & par);
117 UpdatableInset * inInset() const;
119 void setInsetOwner(UpdatableInset * inset);
121 void deleteInsetsLyXText(BufferView *);
124 lyx::pos_type size() const;
128 void setContentsFromPar(Paragraph const & par);
130 void clearContents();
133 LyXLayout_ptr const & layout() const;
135 void layout(LyXLayout_ptr const & new_layout);
144 InsetBibitem * bibitem() const; // ale970302
146 /// initialise tracking for this par
147 void trackChanges(Change::Type = Change::UNCHANGED);
150 void untrackChanges();
152 /// set entire paragraph to new text for change tracking
155 /// look up change type at given pos
156 Change::Type lookupChange(lyx::pos_type pos) const;
158 /// look up change at given pos
159 Change const lookupChangeFull(lyx::pos_type pos) const;
161 /// is there a change within the given range ?
162 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
164 /// is there a non-addition in this range ?
165 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
167 /// set change at pos
168 void setChange(lyx::pos_type pos, Change::Type type);
171 void acceptChange(lyx::pos_type start, lyx::pos_type end);
174 void rejectChange(lyx::pos_type start, lyx::pos_type end);
176 /// mark whole par as erased
179 /// Paragraphs can contain "manual labels", for example, Description
180 /// environment. The text for this user-editable label is stored in
181 /// the paragraph alongside the text of the rest of the paragraph
182 /// (the body). This function returns the starting position of the
183 /// body of the text in the paragraph.
184 int beginningOfBody() const;
187 string const & getLabelstring() const;
189 /// the next two functions are for the manual labels
190 string const getLabelWidthString() const;
192 void setLabelWidthString(string const & s);
194 char getAlign() const;
195 /// The nesting depth of a paragraph
196 depth_type getDepth() const;
197 /// The maximal possible depth of a paragraph after this one
198 depth_type getMaxDepthAfter() const;
200 void applyLayout(LyXLayout_ptr const & new_layout);
203 void eraseIntern(lyx::pos_type pos);
204 /// erase the char at the given position
205 bool erase(lyx::pos_type pos);
206 /// erase the given range. Returns the number of chars actually erased
207 int erase(lyx::pos_type start, lyx::pos_type end);
209 /** Get uninstantiated font setting. Returns the difference
210 between the characters font and the layoutfont.
211 This is what is stored in the fonttable
214 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
216 LyXFont const getFirstFontSettings() const;
218 /** Get fully instantiated font. If pos == -1, use the layout
219 font attached to this paragraph.
220 If pos == -2, use the label font of the layout attached here.
221 In all cases, the font is instantiated, i.e. does not have any
222 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
225 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
226 LyXFont const & outerfont) const;
227 LyXFont const getLayoutFont(BufferParams const &,
228 LyXFont const & outerfont) const;
229 LyXFont const getLabelFont(BufferParams const &,
230 LyXFont const & outerfont) const;
232 * The font returned by the above functions is the same in a
233 * span of characters. This method will return the last position
234 * in the paragraph for which that font is the same.
235 * This can be used to avoid unnecessary calls to getFont.
237 lyx::pos_type getEndPosOfFontSpan(lyx::pos_type pos) const;
239 value_type getChar(lyx::pos_type pos) const;
241 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
242 /// The position must already exist.
243 void setChar(lyx::pos_type pos, value_type c);
244 /// pos <= size() (there is a dummy font change at the end of each par)
245 void setFont(lyx::pos_type pos, LyXFont const & font);
246 /// Returns the height of the highest font in range
248 highestFontInRange(lyx::pos_type startpos,
249 lyx::pos_type endpos,
250 LyXFont::FONT_SIZE const def_size) const;
252 void insertChar(lyx::pos_type pos, value_type c);
254 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
256 bool checkInsertChar(LyXFont &);
258 void insertInset(lyx::pos_type pos, InsetOld * inset);
260 void insertInset(lyx::pos_type pos, InsetOld * inset, LyXFont const &, Change change = Change(Change::INSERTED));
262 bool insetAllowed(InsetOld::Code code);
264 InsetOld * getInset(lyx::pos_type pos);
266 InsetOld const * getInset(lyx::pos_type pos) const;
269 bool isHfill(lyx::pos_type pos) const;
271 bool isInset(lyx::pos_type pos) const;
273 bool isNewline(lyx::pos_type pos) const;
275 bool isSeparator(lyx::pos_type pos) const;
277 bool isLineSeparator(lyx::pos_type pos) const;
279 bool isKomma(lyx::pos_type pos) const;
280 /// Used by the spellchecker
281 bool isLetter(lyx::pos_type pos) const;
283 bool isWord(lyx::pos_type pos) const;
285 /// returns -1 if inset not found
286 int getPositionOfInset(InsetOld const * inset) const;
289 int stripLeadingSpaces();
291 /// return true if we allow multiple spaces
292 bool isFreeSpacing() const;
294 /// return true if we allow this par to stay empty
295 bool allowEmpty() const;
298 ParagraphParameters & params();
300 ParagraphParameters const & params() const;
305 mutable RowList rows;
306 /// last draw y position (baseline of top row)
311 LyXLayout_ptr layout_;
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