4 * Copyright 1995 Matthias Ettrich
5 * Copyright 2002 the LyX Team
6 * Read the file COPYING
12 #include "lyxlayout_ptr_fwd.h"
13 #include "lyxfont.h" // Just for LyXFont::FONT_SIZE
14 #include "InsetList.h"
16 #include "insets/inset.h" // Just for Inset::Code
18 #include "support/types.h"
21 #include "ParagraphList.h"
31 class ParagraphParameters;
34 // Define this if you want to try out the new storage container for
36 // This is non working and far from finished.
39 /// A Paragraph holds all text, attributes and insets in a text paragraph
42 // Remove this whan ParagraphList transition is over. (Lgb)
43 friend class ParagraphList;
44 friend class ParagraphList::iterator;
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;
57 /// The same as ParameterStruct::depth_type
58 typedef unsigned int depth_type;
64 Paragraph(Paragraph const &, bool same_ids);
65 /// the destructor removes the new paragraph from the list
69 Language const * getParLanguage(BufferParams const &) const;
71 bool isRightToLeftPar(BufferParams const &) const;
73 void changeLanguage(BufferParams const & bparams,
74 Language const * from, Language const * to);
76 bool isMultiLingual(BufferParams const &);
79 string const asString(Buffer const *, bool label) const;
81 string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
85 void write(Buffer const *, std::ostream &, BufferParams const &,
86 depth_type & depth) const;
88 void validate(LaTeXFeatures &) const;
90 /// return the unique ID of this paragraph
94 int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
97 int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
101 bool simpleTeXOnePar(Buffer const *, BufferParams const &,
102 LyXFont const & outerfont, std::ostream &,
103 TexRow & texrow, LatexRunParams const &);
106 bool hasSameLayout(Paragraph const & par) const;
109 void makeSameLayout(Paragraph const & par);
112 Inset * inInset() const;
114 void setInsetOwner(Inset * i);
116 void deleteInsetsLyXText(BufferView *);
118 void resizeInsetsLyXText(BufferView *);
121 lyx::pos_type size() const;
125 void setContentsFromPar(Paragraph const & par);
127 void clearContents();
130 LyXLayout_ptr const & layout() const;
132 void layout(LyXLayout_ptr const & new_layout);
141 InsetBibitem * bibitem(); // ale970302
145 void next(Paragraph *);
146 /** these function are able to hide closed footnotes
150 Paragraph const * next() const;
153 void previous(Paragraph *);
155 Paragraph * previous();
157 Paragraph const * previous() const;
160 /// initialise tracking for this par
161 void trackChanges(Change::Type = Change::UNCHANGED);
164 void untrackChanges();
166 /// set entire paragraph to new text for change tracking
169 /// look up change type at given pos
170 Change::Type lookupChange(lyx::pos_type pos) const;
172 /// look up change at given pos
173 Change const lookupChangeFull(lyx::pos_type pos) const;
175 /// is there a change within the given range ?
176 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
178 /// is there a non-addition in this range ?
179 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
181 /// set change at pos
182 void setChange(lyx::pos_type pos, Change::Type type);
185 void acceptChange(lyx::pos_type start, lyx::pos_type end);
188 void rejectChange(lyx::pos_type start, lyx::pos_type end);
190 /// mark whole par as erased
193 /// Paragraphs can contain "manual labels", for example, Description environment.
194 /// The text for this user-editable label is stored in the paragraph alongside
195 /// the text of the rest of the paragraph (the body). This function returns
196 /// the starting position of the body of the text in the paragraph.
197 int beginningOfBody() const;
200 string const & getLabelstring() const;
202 /// the next two functions are for the manual labels
203 string const getLabelWidthString() const;
205 void setLabelWidthString(string const & s);
207 char getAlign() const;
208 /// The nesting depth of a paragraph
209 depth_type getDepth() const;
210 /// The maximal possible depth of a paragraph after this one
211 depth_type getMaxDepthAfter() const;
213 void applyLayout(LyXLayout_ptr const & new_layout);
216 void eraseIntern(lyx::pos_type pos);
217 /// erase the char at the given position
218 bool erase(lyx::pos_type pos);
219 /// erase the given range. Returns the number of chars actually erased
220 int erase(lyx::pos_type start, lyx::pos_type end);
222 /** Get uninstantiated font setting. Returns the difference
223 between the characters font and the layoutfont.
224 This is what is stored in the fonttable
227 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
229 LyXFont const getFirstFontSettings() const;
231 /** Get fully instantiated font. If pos == -1, use the layout
232 font attached to this paragraph.
233 If pos == -2, use the label font of the layout attached here.
234 In all cases, the font is instantiated, i.e. does not have any
235 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
238 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
239 LyXFont const & outerfont) const;
240 LyXFont const getLayoutFont(BufferParams const &,
241 LyXFont const & outerfont) const;
242 LyXFont const getLabelFont(BufferParams const &,
243 LyXFont const & outerfont) const;
245 value_type getChar(lyx::pos_type pos) const;
247 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
248 /// The position must already exist.
249 void setChar(lyx::pos_type pos, value_type c);
250 /// pos <= size() (there is a dummy font change at the end of each par)
251 void setFont(lyx::pos_type pos, LyXFont const & font);
252 /// Returns the height of the highest font in range
254 highestFontInRange(lyx::pos_type startpos,
255 lyx::pos_type endpos,
256 LyXFont::FONT_SIZE const def_size) const;
258 void insertChar(lyx::pos_type pos, value_type c);
260 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
262 bool checkInsertChar(LyXFont &);
264 void insertInset(lyx::pos_type pos, Inset * inset);
266 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
268 bool insetAllowed(Inset::Code code);
270 Inset * getInset(lyx::pos_type pos);
272 Inset const * getInset(lyx::pos_type pos) const;
273 /** important for cut and paste
274 Temporary change from BufferParams to Buffer. Will revert when we
275 get rid of the argument to Inset::clone(Buffer const &) */
276 void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
278 void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
280 bool insertFromMinibuffer(lyx::pos_type pos);
283 bool isHfill(lyx::pos_type pos) const;
285 bool isInset(lyx::pos_type pos) const;
287 bool isNewline(lyx::pos_type pos) const;
289 bool isSeparator(lyx::pos_type pos) const;
291 bool isLineSeparator(lyx::pos_type pos) const;
293 bool isKomma(lyx::pos_type pos) const;
294 /// Used by the spellchecker
295 bool isLetter(lyx::pos_type pos) const;
297 bool isWord(lyx::pos_type pos) const;
299 /// returns -1 if inset not found
300 int getPositionOfInset(Inset const * inset) const;
303 int stripLeadingSpaces();
306 bool isFreeSpacing() const;
309 ParagraphParameters & params();
311 ParagraphParameters const & params() const;
315 //Counters & counters();
318 LyXLayout_ptr layout_;
319 /// if anything uses this we don't want it to.
320 Paragraph(Paragraph const &);
325 Paragraph * previous_;
327 Paragraph * next_par_;
328 Paragraph * prev_par_;
332 friend struct Paragraph::Pimpl;
337 void operator=(Paragraph const &);
341 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
343 return par.lookupChange(pos) == Change::INSERTED;
347 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
349 return par.lookupChange(pos) == Change::DELETED;
352 #endif // PARAGRAPH_H