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 &,
107 bool hasSameLayout(Paragraph const & par) const;
110 void makeSameLayout(Paragraph const & par);
113 Inset * inInset() const;
115 void setInsetOwner(Inset * i);
117 void deleteInsetsLyXText(BufferView *);
119 void resizeInsetsLyXText(BufferView *);
122 lyx::pos_type size() const;
126 void setContentsFromPar(Paragraph const & par);
128 void clearContents();
131 LyXLayout_ptr const & layout() const;
133 void layout(LyXLayout_ptr const & new_layout);
142 InsetBibitem * bibitem(); // ale970302
146 void next(Paragraph *);
147 /** these function are able to hide closed footnotes
151 Paragraph const * next() const;
154 void previous(Paragraph *);
156 Paragraph * previous();
158 Paragraph const * previous() const;
161 /// initialise tracking for this par
162 void trackChanges(Change::Type = Change::UNCHANGED);
165 void untrackChanges();
167 /// set entire paragraph to new text for change tracking
170 /// look up change type at given pos
171 Change::Type lookupChange(lyx::pos_type pos) const;
173 /// look up change at given pos
174 Change const lookupChangeFull(lyx::pos_type pos) const;
176 /// is there a change within the given range ?
177 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
179 /// is there a non-addition in this range ?
180 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
182 /// set change at pos
183 void setChange(lyx::pos_type pos, Change::Type type);
186 void acceptChange(lyx::pos_type start, lyx::pos_type end);
189 void rejectChange(lyx::pos_type start, lyx::pos_type end);
191 /// mark whole par as erased
194 /// Paragraphs can contain "manual labels", for example, Description environment.
195 /// The text for this user-editable label is stored in the paragraph alongside
196 /// the text of the rest of the paragraph (the body). This function returns
197 /// the starting position of the body of the text in the paragraph.
198 int beginningOfBody() const;
201 string const & getLabelstring() const;
203 /// the next two functions are for the manual labels
204 string const getLabelWidthString() const;
206 void setLabelWidthString(string const & s);
208 char getAlign() const;
209 /// The nesting depth of a paragraph
210 depth_type getDepth() const;
211 /// The maximal possible depth of a paragraph after this one
212 depth_type getMaxDepthAfter() const;
214 void applyLayout(LyXLayout_ptr const & new_layout);
217 void eraseIntern(lyx::pos_type pos);
218 /// erase the char at the given position
219 bool erase(lyx::pos_type pos);
220 /// erase the given range. Returns the number of chars actually erased
221 int erase(lyx::pos_type start, lyx::pos_type end);
223 /** Get uninstantiated font setting. Returns the difference
224 between the characters font and the layoutfont.
225 This is what is stored in the fonttable
228 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
230 LyXFont const getFirstFontSettings() const;
232 /** Get fully instantiated font. If pos == -1, use the layout
233 font attached to this paragraph.
234 If pos == -2, use the label font of the layout attached here.
235 In all cases, the font is instantiated, i.e. does not have any
236 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
239 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
240 LyXFont const & outerfont) const;
241 LyXFont const getLayoutFont(BufferParams const &,
242 LyXFont const & outerfont) const;
243 LyXFont const getLabelFont(BufferParams const &,
244 LyXFont const & outerfont) 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;
338 void operator=(Paragraph const &);
342 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
344 return par.lookupChange(pos) == Change::INSERTED;
348 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
350 return par.lookupChange(pos) == Change::DELETED;
353 #endif // PARAGRAPH_H