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);
115 /// Is it the first par with same depth and layout?
116 bool isFirstInSequence() const;
118 /** Check if the current paragraph is the last paragraph in a
120 int getEndLabel() const;
122 Inset * inInset() const;
124 void setInsetOwner(Inset * i);
126 void deleteInsetsLyXText(BufferView *);
128 void resizeInsetsLyXText(BufferView *);
131 lyx::pos_type size() const;
135 void setContentsFromPar(Paragraph * par);
137 void clearContents();
140 LyXLayout_ptr const & layout() const;
142 void layout(LyXLayout_ptr const & new_layout);
151 InsetBibitem * bibitem(); // ale970302
155 void next(Paragraph *);
156 /** these function are able to hide closed footnotes
160 Paragraph const * next() const;
163 void previous(Paragraph *);
165 Paragraph * previous();
167 Paragraph const * previous() const;
170 /// initialise tracking for this par
171 void trackChanges(Change::Type = Change::UNCHANGED);
174 void untrackChanges();
176 /// set entire paragraph to new text for change tracking
179 /// look up change type at given pos
180 Change::Type lookupChange(lyx::pos_type pos) const;
182 /// look up change at given pos
183 Change const lookupChangeFull(lyx::pos_type pos) const;
185 /// is there a change within the given range ?
186 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
188 /// is there a non-addition in this range ?
189 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
191 /// set change at pos
192 void setChange(lyx::pos_type pos, Change::Type type);
195 void acceptChange(lyx::pos_type start, lyx::pos_type end);
198 void rejectChange(lyx::pos_type start, lyx::pos_type end);
200 /// mark whole par as erased
203 /// for the environments
204 Paragraph * depthHook(depth_type depth);
205 /// for the environments
206 Paragraph const * depthHook(depth_type depth) const;
208 Paragraph * outerHook();
210 Paragraph const * outerHook() const;
212 /// Paragraphs can contain "manual labels", for example, Description environment.
213 /// The text for this user-editable label is stored in the paragraph alongside
214 /// the text of the rest of the paragraph (the body). This function returns
215 /// the starting position of the body of the text in the paragraph.
216 int beginningOfBody() const;
219 string const & getLabelstring() const;
221 /// the next two functions are for the manual labels
222 string const getLabelWidthString() const;
224 void setLabelWidthString(string const & s);
226 char getAlign() const;
227 /// The nesting depth of a paragraph
228 depth_type getDepth() const;
229 /// The maximal possible depth of a paragraph after this one
230 depth_type getMaxDepthAfter() const;
232 void applyLayout(LyXLayout_ptr const & new_layout);
235 void eraseIntern(lyx::pos_type pos);
236 /// erase the char at the given position
237 void erase(lyx::pos_type pos);
238 /// erase the given range. Returns true if actually erased.
239 bool erase(lyx::pos_type start, lyx::pos_type end);
241 /** Get uninstantiated font setting. Returns the difference
242 between the characters font and the layoutfont.
243 This is what is stored in the fonttable
246 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
248 LyXFont const getFirstFontSettings() const;
250 /** Get fully instantiated font. If pos == -1, use the layout
251 font attached to this paragraph.
252 If pos == -2, use the label font of the layout attached here.
253 In all cases, the font is instantiated, i.e. does not have any
254 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
257 LyXFont const getFont(BufferParams const &, lyx::pos_type pos) const;
258 LyXFont const getLayoutFont(BufferParams const &) const;
259 LyXFont const getLabelFont(BufferParams const &) const;
261 value_type getChar(lyx::pos_type pos) const;
263 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
264 /// The position must already exist.
265 void setChar(lyx::pos_type pos, value_type c);
266 /// pos <= size() (there is a dummy font change at the end of each par)
267 void setFont(lyx::pos_type pos, LyXFont const & font);
268 /// Returns the height of the highest font in range
270 highestFontInRange(lyx::pos_type startpos,
271 lyx::pos_type endpos,
272 LyXFont::FONT_SIZE const def_size) const;
274 void insertChar(lyx::pos_type pos, value_type c);
276 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
278 bool checkInsertChar(LyXFont &);
280 void insertInset(lyx::pos_type pos, Inset * inset);
282 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
284 bool insetAllowed(Inset::Code code);
286 Inset * getInset(lyx::pos_type pos);
288 Inset const * getInset(lyx::pos_type pos) const;
289 /** important for cut and paste
290 Temporary change from BufferParams to Buffer. Will revert when we
291 get rid of the argument to Inset::clone(Buffer const &) */
292 void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
294 void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
296 bool insertFromMinibuffer(lyx::pos_type pos);
299 bool isHfill(lyx::pos_type pos) const;
301 bool isInset(lyx::pos_type pos) const;
303 bool isNewline(lyx::pos_type pos) const;
305 bool isSeparator(lyx::pos_type pos) const;
307 bool isLineSeparator(lyx::pos_type pos) const;
309 bool isKomma(lyx::pos_type pos) const;
310 /// Used by the spellchecker
311 bool isLetter(lyx::pos_type pos) const;
313 bool isWord(lyx::pos_type pos) const;
315 /// returns -1 if inset not found
316 int getPositionOfInset(Inset const * inset) const;
319 int stripLeadingSpaces();
322 bool isFreeSpacing() const;
325 ParagraphParameters & params();
327 ParagraphParameters const & params() const;
331 //Counters & counters();
334 LyXLayout_ptr layout_;
335 /// if anything uses this we don't want it to.
336 Paragraph(Paragraph const &);
341 Paragraph * previous_;
343 Paragraph * next_par_;
344 Paragraph * prev_par_;
348 friend struct Paragraph::Pimpl;
354 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
356 return par.lookupChange(pos) == Change::INSERTED;
360 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
362 return par.lookupChange(pos) == Change::DELETED;
365 #endif // PARAGRAPH_H