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"
30 class ParagraphParameters;
33 // Define this if you want to try out the new storage container for
35 // This is non working and far from finished.
38 /// A Paragraph holds all text, attributes and insets in a text paragraph
41 // Remove this whan ParagraphList transition is over. (Lgb)
42 friend class ParagraphList;
43 friend class ParagraphList::iterator;
47 /// Note that this is 1 right now to avoid
48 /// crashes where getChar() is called wrongly
49 /// (returning 0) - if this was 0, then we'd
50 /// try getInset() and crash. We should fix
55 typedef char value_type;
56 /// The same as ParameterStruct::depth_type
57 typedef unsigned int depth_type;
62 /// this constructor inserts the new paragraph in a list
64 Paragraph(Paragraph * par);
67 Paragraph(Paragraph const &, bool same_ids);
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
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 std::ostream &, TexRow & texrow, bool moving_arg);
110 bool hasSameLayout(Paragraph const * par) const;
113 void makeSameLayout(Paragraph const * par);
116 Inset * inInset() const;
118 void setInsetOwner(Inset * i);
120 void deleteInsetsLyXText(BufferView *);
122 void resizeInsetsLyXText(BufferView *);
125 lyx::pos_type size() const;
129 void setContentsFromPar(Paragraph * par);
131 void clearContents();
134 LyXLayout_ptr const & layout() const;
136 void layout(LyXLayout_ptr const & new_layout);
145 InsetBibitem * bibitem(); // ale970302
149 void next(Paragraph *);
150 /** these function are able to hide closed footnotes
154 Paragraph const * next() const;
157 void previous(Paragraph *);
159 Paragraph * previous();
161 Paragraph const * previous() const;
164 /// initialise tracking for this par
165 void trackChanges(Change::Type = Change::UNCHANGED);
168 void untrackChanges();
170 /// set entire paragraph to new text for change tracking
173 /// look up change type at given pos
174 Change::Type lookupChange(lyx::pos_type pos) const;
176 /// look up change at given pos
177 Change const lookupChangeFull(lyx::pos_type pos) const;
179 /// is there a change within the given range ?
180 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
182 /// is there a non-addition in this range ?
183 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
185 /// set change at pos
186 void setChange(lyx::pos_type pos, Change::Type type);
189 void acceptChange(lyx::pos_type start, lyx::pos_type end);
192 void rejectChange(lyx::pos_type start, lyx::pos_type end);
194 /// mark whole par as erased
197 /// Paragraphs can contain "manual labels", for example, Description environment.
198 /// The text for this user-editable label is stored in the paragraph alongside
199 /// the text of the rest of the paragraph (the body). This function returns
200 /// the starting position of the body of the text in the paragraph.
201 int beginningOfBody() const;
204 string const & getLabelstring() const;
206 /// the next two functions are for the manual labels
207 string const getLabelWidthString() const;
209 void setLabelWidthString(string const & s);
211 char getAlign() const;
212 /// The nesting depth of a paragraph
213 depth_type getDepth() const;
214 /// The maximal possible depth of a paragraph after this one
215 depth_type getMaxDepthAfter() const;
217 void applyLayout(LyXLayout_ptr const & new_layout);
220 void eraseIntern(lyx::pos_type pos);
221 /// erase the char at the given position
222 void erase(lyx::pos_type pos);
223 /// erase the given range. Returns true if actually erased.
224 bool erase(lyx::pos_type start, lyx::pos_type end);
226 /** Get uninstantiated font setting. Returns the difference
227 between the characters font and the layoutfont.
228 This is what is stored in the fonttable
231 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
233 LyXFont const getFirstFontSettings() const;
235 /** Get fully instantiated font. If pos == -1, use the layout
236 font attached to this paragraph.
237 If pos == -2, use the label font of the layout attached here.
238 In all cases, the font is instantiated, i.e. does not have any
239 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
242 LyXFont const getFont(BufferParams const &, lyx::pos_type pos) const;
243 LyXFont const getLayoutFont(BufferParams const &) const;
244 LyXFont const getLabelFont(BufferParams const &) const;
246 value_type getChar(lyx::pos_type pos) const;
248 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
249 /// The position must already exist.
250 void setChar(lyx::pos_type pos, value_type c);
251 /// pos <= size() (there is a dummy font change at the end of each par)
252 void setFont(lyx::pos_type pos, LyXFont const & font);
253 /// Returns the height of the highest font in range
255 highestFontInRange(lyx::pos_type startpos,
256 lyx::pos_type endpos,
257 LyXFont::FONT_SIZE const def_size) const;
259 void insertChar(lyx::pos_type pos, value_type c);
261 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
263 bool checkInsertChar(LyXFont &);
265 void insertInset(lyx::pos_type pos, Inset * inset);
267 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
269 bool insetAllowed(Inset::Code code);
271 Inset * getInset(lyx::pos_type pos);
273 Inset const * getInset(lyx::pos_type pos) const;
274 /** important for cut and paste
275 Temporary change from BufferParams to Buffer. Will revert when we
276 get rid of the argument to Inset::clone(Buffer const &) */
277 void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
279 void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
281 bool insertFromMinibuffer(lyx::pos_type pos);
284 bool isHfill(lyx::pos_type pos) const;
286 bool isInset(lyx::pos_type pos) const;
288 bool isNewline(lyx::pos_type pos) const;
290 bool isSeparator(lyx::pos_type pos) const;
292 bool isLineSeparator(lyx::pos_type pos) const;
294 bool isKomma(lyx::pos_type pos) const;
295 /// Used by the spellchecker
296 bool isLetter(lyx::pos_type pos) const;
298 bool isWord(lyx::pos_type pos) const;
300 /// returns -1 if inset not found
301 int getPositionOfInset(Inset const * inset) const;
304 int stripLeadingSpaces();
307 bool isFreeSpacing() const;
310 ParagraphParameters & params();
312 ParagraphParameters const & params() const;
316 //Counters & counters();
319 LyXLayout_ptr layout_;
320 /// if anything uses this we don't want it to.
321 Paragraph(Paragraph const &);
326 Paragraph * previous_;
328 Paragraph * next_par_;
329 Paragraph * prev_par_;
333 friend struct Paragraph::Pimpl;
339 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
341 return par.lookupChange(pos) == Change::INSERTED;
345 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
347 return par.lookupChange(pos) == Change::DELETED;
350 #endif // PARAGRAPH_H