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
97 int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
100 int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
104 bool simpleTeXOnePar(Buffer const *, BufferParams const &,
105 LyXFont const & outerfont, std::ostream &,
106 TexRow & texrow, bool moving_arg);
109 bool hasSameLayout(Paragraph const & par) const;
112 void makeSameLayout(Paragraph const & par);
115 Inset * inInset() const;
117 void setInsetOwner(Inset * i);
119 void deleteInsetsLyXText(BufferView *);
121 void resizeInsetsLyXText(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(); // ale970302
148 void next(Paragraph *);
149 /** these function are able to hide closed footnotes
153 Paragraph const * next() const;
156 void previous(Paragraph *);
158 Paragraph * previous();
160 Paragraph const * previous() const;
163 /// initialise tracking for this par
164 void trackChanges(Change::Type = Change::UNCHANGED);
167 void untrackChanges();
169 /// set entire paragraph to new text for change tracking
172 /// look up change type at given pos
173 Change::Type lookupChange(lyx::pos_type pos) const;
175 /// look up change at given pos
176 Change const lookupChangeFull(lyx::pos_type pos) const;
178 /// is there a change within the given range ?
179 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
181 /// is there a non-addition in this range ?
182 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
184 /// set change at pos
185 void setChange(lyx::pos_type pos, Change::Type type);
188 void acceptChange(lyx::pos_type start, lyx::pos_type end);
191 void rejectChange(lyx::pos_type start, lyx::pos_type end);
193 /// mark whole par as erased
196 /// Paragraphs can contain "manual labels", for example, Description environment.
197 /// The text for this user-editable label is stored in the paragraph alongside
198 /// the text of the rest of the paragraph (the body). This function returns
199 /// the starting position of the body of the text in the paragraph.
200 int beginningOfBody() const;
203 string const & getLabelstring() const;
205 /// the next two functions are for the manual labels
206 string const getLabelWidthString() const;
208 void setLabelWidthString(string const & s);
210 char getAlign() const;
211 /// The nesting depth of a paragraph
212 depth_type getDepth() const;
213 /// The maximal possible depth of a paragraph after this one
214 depth_type getMaxDepthAfter() const;
216 void applyLayout(LyXLayout_ptr const & new_layout);
219 void eraseIntern(lyx::pos_type pos);
220 /// erase the char at the given position
221 bool erase(lyx::pos_type pos);
222 /// erase the given range. Returns the number of chars actually erased
223 int erase(lyx::pos_type start, lyx::pos_type end);
225 /** Get uninstantiated font setting. Returns the difference
226 between the characters font and the layoutfont.
227 This is what is stored in the fonttable
230 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
232 LyXFont const getFirstFontSettings() const;
234 /** Get fully instantiated font. If pos == -1, use the layout
235 font attached to this paragraph.
236 If pos == -2, use the label font of the layout attached here.
237 In all cases, the font is instantiated, i.e. does not have any
238 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
241 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
242 LyXFont const & outerfont) const;
243 LyXFont const getLayoutFont(BufferParams const &,
244 LyXFont const & outerfont) const;
245 LyXFont const getLabelFont(BufferParams const &,
246 LyXFont const & outerfont) const;
248 value_type getChar(lyx::pos_type pos) const;
250 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
251 /// The position must already exist.
252 void setChar(lyx::pos_type pos, value_type c);
253 /// pos <= size() (there is a dummy font change at the end of each par)
254 void setFont(lyx::pos_type pos, LyXFont const & font);
255 /// Returns the height of the highest font in range
257 highestFontInRange(lyx::pos_type startpos,
258 lyx::pos_type endpos,
259 LyXFont::FONT_SIZE const def_size) const;
261 void insertChar(lyx::pos_type pos, value_type c);
263 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
265 bool checkInsertChar(LyXFont &);
267 void insertInset(lyx::pos_type pos, Inset * inset);
269 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
271 bool insetAllowed(Inset::Code code);
273 Inset * getInset(lyx::pos_type pos);
275 Inset const * getInset(lyx::pos_type pos) const;
276 /** important for cut and paste
277 Temporary change from BufferParams to Buffer. Will revert when we
278 get rid of the argument to Inset::clone(Buffer const &) */
279 void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
281 void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
283 bool insertFromMinibuffer(lyx::pos_type pos);
286 bool isHfill(lyx::pos_type pos) const;
288 bool isInset(lyx::pos_type pos) const;
290 bool isNewline(lyx::pos_type pos) const;
292 bool isSeparator(lyx::pos_type pos) const;
294 bool isLineSeparator(lyx::pos_type pos) const;
296 bool isKomma(lyx::pos_type pos) const;
297 /// Used by the spellchecker
298 bool isLetter(lyx::pos_type pos) const;
300 bool isWord(lyx::pos_type pos) const;
302 /// returns -1 if inset not found
303 int getPositionOfInset(Inset const * inset) const;
306 int stripLeadingSpaces();
309 bool isFreeSpacing() const;
312 ParagraphParameters & params();
314 ParagraphParameters const & params() const;
318 //Counters & counters();
321 LyXLayout_ptr layout_;
322 /// if anything uses this we don't want it to.
323 Paragraph(Paragraph const &);
328 Paragraph * previous_;
330 Paragraph * next_par_;
331 Paragraph * prev_par_;
335 friend struct Paragraph::Pimpl;
340 void operator=(Paragraph const &);
344 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
346 return par.lookupChange(pos) == Change::INSERTED;
350 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
352 return par.lookupChange(pos) == Change::DELETED;
355 #endif // PARAGRAPH_H