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"
29 class ParagraphParameters;
32 // Define this if you want to try out the new storage container for
34 // This is non working and far from finished.
37 /// A Paragraph holds all text, attributes and insets in a text paragraph
50 typedef char value_type;
51 /// The same as ParameterStruct::depth_type
52 typedef unsigned int depth_type;
57 /// this constructor inserts the new paragraph in a list
59 Paragraph(Paragraph * par);
62 Paragraph(Paragraph const &, bool same_ids);
63 /// the destructor removes the new paragraph from the list
67 Language const * getParLanguage(BufferParams const &) const;
69 bool isRightToLeftPar(BufferParams const &) const;
71 void changeLanguage(BufferParams const & bparams,
72 Language const * from, Language const * to);
74 bool isMultiLingual(BufferParams const &);
77 string const asString(Buffer const *, bool label) const;
79 string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
83 void write(Buffer const *, std::ostream &, BufferParams const &,
84 depth_type & depth) const;
86 void validate(LaTeXFeatures &) const;
88 /// return the unique ID of this paragraph
94 Paragraph * TeXOnePar(Buffer const *, BufferParams const &,
95 std::ostream &, TexRow & texrow,
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 Paragraph * TeXEnvironment(Buffer const *, BufferParams const &,
111 std::ostream &, TexRow & texrow);
113 bool hasSameLayout(Paragraph const * par) const;
116 void makeSameLayout(Paragraph const * par);
118 /// Is it the first par with same depth and layout?
119 bool isFirstInSequence() const;
121 /** Check if the current paragraph is the last paragraph in a
123 int getEndLabel() const;
125 Inset * inInset() const;
127 void setInsetOwner(Inset * i);
129 void deleteInsetsLyXText(BufferView *);
131 void resizeInsetsLyXText(BufferView *);
134 lyx::pos_type size() const;
138 void setContentsFromPar(Paragraph * par);
140 void clearContents();
143 LyXLayout_ptr const & layout() const;
145 void layout(LyXLayout_ptr const & new_layout);
154 InsetBibitem * bibitem(); // ale970302
158 void next(Paragraph *);
159 /** these function are able to hide closed footnotes
163 Paragraph const * next() 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;
187 void acceptChange(lyx::pos_type start, lyx::pos_type end);
190 void rejectChange(lyx::pos_type start, lyx::pos_type end);
192 /// mark whole par as erased
196 void previous(Paragraph *);
198 Paragraph * previous();
200 Paragraph const * previous() const;
202 /// for the environments
203 Paragraph * depthHook(depth_type depth);
204 /// for the environments
205 Paragraph const * depthHook(depth_type depth) const;
207 Paragraph * outerHook();
209 Paragraph const * outerHook() const;
211 int beginningOfMainBody() const;
213 string const & getLabelstring() const;
215 /// the next two functions are for the manual labels
216 string const getLabelWidthString() const;
218 void setLabelWidthString(string const & s);
220 char getAlign() const;
221 /// The nesting depth of a paragraph
222 depth_type getDepth() const;
223 /// The maximal possible depth of a paragraph after this one
224 depth_type getMaxDepthAfter() const;
226 void applyLayout(LyXLayout_ptr const & new_layout);
228 /// erase the char at the given position
229 void erase(lyx::pos_type pos);
230 /// erase the given range. Returns true if actually erased.
231 bool erase(lyx::pos_type start, lyx::pos_type end);
233 /** Get uninstantiated font setting. Returns the difference
234 between the characters font and the layoutfont.
235 This is what is stored in the fonttable
238 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
240 LyXFont const getFirstFontSettings() const;
242 /** Get fully instantiated font. If pos == -1, use the layout
243 font attached to this paragraph.
244 If pos == -2, use the label font of the layout attached here.
245 In all cases, the font is instantiated, i.e. does not have any
246 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
249 LyXFont const getFont(BufferParams const &, lyx::pos_type pos) const;
250 LyXFont const getLayoutFont(BufferParams const &) const;
251 LyXFont const getLabelFont(BufferParams const &) const;
253 value_type getChar(lyx::pos_type pos) const;
255 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
256 /// The position must already exist.
257 void setChar(lyx::pos_type pos, value_type c);
258 /// pos <= size() (there is a dummy font change at the end of each par)
259 void setFont(lyx::pos_type pos, LyXFont const & font);
260 /// Returns the height of the highest font in range
262 highestFontInRange(lyx::pos_type startpos,
263 lyx::pos_type endpos,
264 LyXFont::FONT_SIZE const def_size) const;
266 void insertChar(lyx::pos_type pos, value_type c);
268 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
270 bool checkInsertChar(LyXFont &);
272 void insertInset(lyx::pos_type pos, Inset * inset);
274 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
276 bool insetAllowed(Inset::Code code);
278 Inset * getInset(lyx::pos_type pos);
280 Inset const * getInset(lyx::pos_type pos) const;
281 /** important for cut and paste
282 Temporary change from BufferParams to Buffer. Will revert when we
283 get rid of the argument to Inset::clone(Buffer const &) */
284 void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
286 void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
288 bool insertFromMinibuffer(lyx::pos_type pos);
291 bool isHfill(lyx::pos_type pos) const;
293 bool isInset(lyx::pos_type pos) const;
295 bool isNewline(lyx::pos_type pos) const;
297 bool isSeparator(lyx::pos_type pos) const;
299 bool isLineSeparator(lyx::pos_type pos) const;
301 bool isKomma(lyx::pos_type pos) const;
302 /// Used by the spellchecker
303 bool isLetter(lyx::pos_type pos) const;
305 bool isWord(lyx::pos_type pos) const;
307 /// returns -1 if inset not found
308 int getPositionOfInset(Inset const * inset) const;
311 int stripLeadingSpaces();
314 bool isFreeSpacing() const;
317 ParagraphParameters & params();
319 ParagraphParameters const & params() const;
323 //Counters & counters();
325 friend void breakParagraph(BufferParams const & bparams,
326 Paragraph * par, lyx::pos_type pos, int flag);
330 LyXLayout_ptr layout_;
331 /// if anything uses this we don't want it to.
332 Paragraph(Paragraph const &);
337 Paragraph * previous_;
341 friend struct Paragraph::Pimpl;
347 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
349 return par.lookupChange(pos) == Change::INSERTED;
353 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
355 return par.lookupChange(pos) == Change::DELETED;
358 #endif // PARAGRAPH_H