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
43 // Remove this whan ParagraphList transition is over. (Lgb)
44 friend class ParagraphList;
45 friend class ParagraphList::iterator;
49 /// Note that this is 1 right now to avoid
50 /// crashes where getChar() is called wrongly
51 /// (returning 0) - if this was 0, then we'd
52 /// try getInset() and crash. We should fix
57 typedef char value_type;
58 /// The same as ParameterStruct::depth_type
59 typedef unsigned int depth_type;
65 Paragraph(Paragraph const &, bool same_ids);
66 /// the destructor removes the new paragraph from the list
70 Language const * getParLanguage(BufferParams const &) const;
72 bool isRightToLeftPar(BufferParams const &) const;
74 void changeLanguage(BufferParams const & bparams,
75 Language const * from, Language const * to);
77 bool isMultiLingual(BufferParams const &);
80 string const asString(Buffer const *, bool label) const;
82 string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
86 void write(Buffer const *, std::ostream &, BufferParams const &,
87 depth_type & depth) const;
89 void validate(LaTeXFeatures &) const;
91 /// return the unique ID of this paragraph
95 int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
98 int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
102 bool simpleTeXOnePar(Buffer const *, BufferParams const &,
103 LyXFont const & outerfont, std::ostream &,
104 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
144 /// initialise tracking for this par
145 void trackChanges(Change::Type = Change::UNCHANGED);
148 void untrackChanges();
150 /// set entire paragraph to new text for change tracking
153 /// look up change type at given pos
154 Change::Type lookupChange(lyx::pos_type pos) const;
156 /// look up change at given pos
157 Change const lookupChangeFull(lyx::pos_type pos) const;
159 /// is there a change within the given range ?
160 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
162 /// is there a non-addition in this range ?
163 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
165 /// set change at pos
166 void setChange(lyx::pos_type pos, Change::Type type);
169 void acceptChange(lyx::pos_type start, lyx::pos_type end);
172 void rejectChange(lyx::pos_type start, lyx::pos_type end);
174 /// mark whole par as erased
177 /// Paragraphs can contain "manual labels", for example, Description environment.
178 /// The text for this user-editable label is stored in the paragraph alongside
179 /// the text of the rest of the paragraph (the body). This function returns
180 /// the starting position of the body of the text in the paragraph.
181 int beginningOfBody() const;
184 string const & getLabelstring() const;
186 /// the next two functions are for the manual labels
187 string const getLabelWidthString() const;
189 void setLabelWidthString(string const & s);
191 char getAlign() const;
192 /// The nesting depth of a paragraph
193 depth_type getDepth() const;
194 /// The maximal possible depth of a paragraph after this one
195 depth_type getMaxDepthAfter() const;
197 void applyLayout(LyXLayout_ptr const & new_layout);
200 void eraseIntern(lyx::pos_type pos);
201 /// erase the char at the given position
202 bool erase(lyx::pos_type pos);
203 /// erase the given range. Returns the number of chars actually erased
204 int erase(lyx::pos_type start, lyx::pos_type end);
206 /** Get uninstantiated font setting. Returns the difference
207 between the characters font and the layoutfont.
208 This is what is stored in the fonttable
211 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
213 LyXFont const getFirstFontSettings() const;
215 /** Get fully instantiated font. If pos == -1, use the layout
216 font attached to this paragraph.
217 If pos == -2, use the label font of the layout attached here.
218 In all cases, the font is instantiated, i.e. does not have any
219 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
222 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
223 LyXFont const & outerfont) const;
224 LyXFont const getLayoutFont(BufferParams const &,
225 LyXFont const & outerfont) const;
226 LyXFont const getLabelFont(BufferParams const &,
227 LyXFont const & outerfont) const;
229 value_type getChar(lyx::pos_type pos) const;
231 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
232 /// The position must already exist.
233 void setChar(lyx::pos_type pos, value_type c);
234 /// pos <= size() (there is a dummy font change at the end of each par)
235 void setFont(lyx::pos_type pos, LyXFont const & font);
236 /// Returns the height of the highest font in range
238 highestFontInRange(lyx::pos_type startpos,
239 lyx::pos_type endpos,
240 LyXFont::FONT_SIZE const def_size) const;
242 void insertChar(lyx::pos_type pos, value_type c);
244 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
246 bool checkInsertChar(LyXFont &);
248 void insertInset(lyx::pos_type pos, Inset * inset);
250 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
252 bool insetAllowed(Inset::Code code);
254 Inset * getInset(lyx::pos_type pos);
256 Inset const * getInset(lyx::pos_type pos) const;
257 /** important for cut and paste
258 Temporary change from BufferParams to Buffer. Will revert when we
259 get rid of the argument to Inset::clone(Buffer const &) */
260 void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
262 void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
264 bool insertFromMinibuffer(lyx::pos_type pos);
267 bool isHfill(lyx::pos_type pos) const;
269 bool isInset(lyx::pos_type pos) const;
271 bool isNewline(lyx::pos_type pos) const;
273 bool isSeparator(lyx::pos_type pos) const;
275 bool isLineSeparator(lyx::pos_type pos) const;
277 bool isKomma(lyx::pos_type pos) const;
278 /// Used by the spellchecker
279 bool isLetter(lyx::pos_type pos) const;
281 bool isWord(lyx::pos_type pos) const;
283 /// returns -1 if inset not found
284 int getPositionOfInset(Inset const * inset) const;
287 int stripLeadingSpaces();
290 bool isFreeSpacing() const;
293 ParagraphParameters & params();
295 ParagraphParameters const & params() const;
299 //Counters & counters();
302 LyXLayout_ptr layout_;
303 /// if anything uses this we don't want it to.
304 Paragraph(Paragraph const &);
306 Paragraph * next_par_;
307 Paragraph * prev_par_;
311 friend struct Paragraph::Pimpl;
316 void operator=(Paragraph const &);
320 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
322 return par.lookupChange(pos) == Change::INSERTED;
326 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
328 return par.lookupChange(pos) == Change::DELETED;
331 #endif // PARAGRAPH_H