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 LyXFont const & outerfont, std::ostream &,
108 TexRow & texrow, bool moving_arg);
111 bool hasSameLayout(Paragraph const * par) const;
114 void makeSameLayout(Paragraph const * par);
117 Inset * inInset() const;
119 void setInsetOwner(Inset * i);
121 void deleteInsetsLyXText(BufferView *);
123 void resizeInsetsLyXText(BufferView *);
126 lyx::pos_type size() const;
130 void setContentsFromPar(Paragraph * par);
132 void clearContents();
135 LyXLayout_ptr const & layout() const;
137 void layout(LyXLayout_ptr const & new_layout);
146 InsetBibitem * bibitem(); // ale970302
150 void next(Paragraph *);
151 /** these function are able to hide closed footnotes
155 Paragraph const * next() const;
158 void previous(Paragraph *);
160 Paragraph * previous();
162 Paragraph const * previous() const;
165 /// initialise tracking for this par
166 void trackChanges(Change::Type = Change::UNCHANGED);
169 void untrackChanges();
171 /// set entire paragraph to new text for change tracking
174 /// look up change type at given pos
175 Change::Type lookupChange(lyx::pos_type pos) const;
177 /// look up change at given pos
178 Change const lookupChangeFull(lyx::pos_type pos) const;
180 /// is there a change within the given range ?
181 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
183 /// is there a non-addition in this range ?
184 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
186 /// set change at pos
187 void setChange(lyx::pos_type pos, Change::Type type);
190 void acceptChange(lyx::pos_type start, lyx::pos_type end);
193 void rejectChange(lyx::pos_type start, lyx::pos_type end);
195 /// mark whole par as erased
198 /// Paragraphs can contain "manual labels", for example, Description environment.
199 /// The text for this user-editable label is stored in the paragraph alongside
200 /// the text of the rest of the paragraph (the body). This function returns
201 /// the starting position of the body of the text in the paragraph.
202 int beginningOfBody() const;
205 string const & getLabelstring() const;
207 /// the next two functions are for the manual labels
208 string const getLabelWidthString() const;
210 void setLabelWidthString(string const & s);
212 char getAlign() const;
213 /// The nesting depth of a paragraph
214 depth_type getDepth() const;
215 /// The maximal possible depth of a paragraph after this one
216 depth_type getMaxDepthAfter() const;
218 void applyLayout(LyXLayout_ptr const & new_layout);
221 void eraseIntern(lyx::pos_type pos);
222 /// erase the char at the given position
223 void erase(lyx::pos_type pos);
224 /// erase the given range. Returns true if actually erased.
225 bool erase(lyx::pos_type start, lyx::pos_type end);
227 /** Get uninstantiated font setting. Returns the difference
228 between the characters font and the layoutfont.
229 This is what is stored in the fonttable
232 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
234 LyXFont const getFirstFontSettings() const;
236 /** Get fully instantiated font. If pos == -1, use the layout
237 font attached to this paragraph.
238 If pos == -2, use the label font of the layout attached here.
239 In all cases, the font is instantiated, i.e. does not have any
240 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
243 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
244 LyXFont const & outerfont) const;
245 LyXFont const getLayoutFont(BufferParams const &,
246 LyXFont const & outerfont) const;
247 LyXFont const getLabelFont(BufferParams const &,
248 LyXFont const & outerfont) const;
250 value_type getChar(lyx::pos_type pos) const;
252 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
253 /// The position must already exist.
254 void setChar(lyx::pos_type pos, value_type c);
255 /// pos <= size() (there is a dummy font change at the end of each par)
256 void setFont(lyx::pos_type pos, LyXFont const & font);
257 /// Returns the height of the highest font in range
259 highestFontInRange(lyx::pos_type startpos,
260 lyx::pos_type endpos,
261 LyXFont::FONT_SIZE const def_size) const;
263 void insertChar(lyx::pos_type pos, value_type c);
265 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
267 bool checkInsertChar(LyXFont &);
269 void insertInset(lyx::pos_type pos, Inset * inset);
271 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
273 bool insetAllowed(Inset::Code code);
275 Inset * getInset(lyx::pos_type pos);
277 Inset const * getInset(lyx::pos_type pos) const;
278 /** important for cut and paste
279 Temporary change from BufferParams to Buffer. Will revert when we
280 get rid of the argument to Inset::clone(Buffer const &) */
281 void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
283 void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
285 bool insertFromMinibuffer(lyx::pos_type pos);
288 bool isHfill(lyx::pos_type pos) const;
290 bool isInset(lyx::pos_type pos) const;
292 bool isNewline(lyx::pos_type pos) const;
294 bool isSeparator(lyx::pos_type pos) const;
296 bool isLineSeparator(lyx::pos_type pos) const;
298 bool isKomma(lyx::pos_type pos) const;
299 /// Used by the spellchecker
300 bool isLetter(lyx::pos_type pos) const;
302 bool isWord(lyx::pos_type pos) const;
304 /// returns -1 if inset not found
305 int getPositionOfInset(Inset const * inset) const;
308 int stripLeadingSpaces();
311 bool isFreeSpacing() const;
314 ParagraphParameters & params();
316 ParagraphParameters const & params() const;
320 //Counters & counters();
323 LyXLayout_ptr layout_;
324 /// if anything uses this we don't want it to.
325 Paragraph(Paragraph const &);
330 Paragraph * previous_;
332 Paragraph * next_par_;
333 Paragraph * prev_par_;
337 friend struct Paragraph::Pimpl;
343 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
345 return par.lookupChange(pos) == Change::INSERTED;
349 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
351 return par.lookupChange(pos) == Change::DELETED;
354 #endif // PARAGRAPH_H