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
42 /// Note that this is 1 right now to avoid
43 /// crashes where getChar() is called wrongly
44 /// (returning 0) - if this was 0, then we'd
45 /// try getInset() and crash. We should fix
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 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 std::ostream &, TexRow & texrow, bool moving_arg);
105 bool hasSameLayout(Paragraph const * par) const;
108 void makeSameLayout(Paragraph const * par);
110 /// Is it the first par with same depth and layout?
111 bool isFirstInSequence() const;
113 /** Check if the current paragraph is the last paragraph in a
115 int getEndLabel() const;
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 /// for the environments
199 Paragraph * depthHook(depth_type depth);
200 /// for the environments
201 Paragraph const * depthHook(depth_type depth) const;
203 Paragraph * outerHook();
205 Paragraph const * outerHook() const;
207 /// Paragraphs can contain "manual labels", for example, Description environment.
208 /// The text for this user-editable label is stored in the paragraph alongside
209 /// the text of the rest of the paragraph (the body). This function returns
210 /// the starting position of the body of the text in the paragraph.
211 int beginningOfBody() const;
214 string const & getLabelstring() const;
216 /// the next two functions are for the manual labels
217 string const getLabelWidthString() const;
219 void setLabelWidthString(string const & s);
221 char getAlign() const;
222 /// The nesting depth of a paragraph
223 depth_type getDepth() const;
224 /// The maximal possible depth of a paragraph after this one
225 depth_type getMaxDepthAfter() const;
227 void applyLayout(LyXLayout_ptr const & new_layout);
230 void eraseIntern(lyx::pos_type pos);
231 /// erase the char at the given position
232 void erase(lyx::pos_type pos);
233 /// erase the given range. Returns true if actually erased.
234 bool erase(lyx::pos_type start, lyx::pos_type end);
236 /** Get uninstantiated font setting. Returns the difference
237 between the characters font and the layoutfont.
238 This is what is stored in the fonttable
241 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
243 LyXFont const getFirstFontSettings() const;
245 /** Get fully instantiated font. If pos == -1, use the layout
246 font attached to this paragraph.
247 If pos == -2, use the label font of the layout attached here.
248 In all cases, the font is instantiated, i.e. does not have any
249 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
252 LyXFont const getFont(BufferParams const &, lyx::pos_type pos) const;
253 LyXFont const getLayoutFont(BufferParams const &) const;
254 LyXFont const getLabelFont(BufferParams const &) const;
256 value_type getChar(lyx::pos_type pos) const;
258 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
259 /// The position must already exist.
260 void setChar(lyx::pos_type pos, value_type c);
261 /// pos <= size() (there is a dummy font change at the end of each par)
262 void setFont(lyx::pos_type pos, LyXFont const & font);
263 /// Returns the height of the highest font in range
265 highestFontInRange(lyx::pos_type startpos,
266 lyx::pos_type endpos,
267 LyXFont::FONT_SIZE const def_size) const;
269 void insertChar(lyx::pos_type pos, value_type c);
271 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
273 bool checkInsertChar(LyXFont &);
275 void insertInset(lyx::pos_type pos, Inset * inset);
277 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
279 bool insetAllowed(Inset::Code code);
281 Inset * getInset(lyx::pos_type pos);
283 Inset const * getInset(lyx::pos_type pos) const;
284 /** important for cut and paste
285 Temporary change from BufferParams to Buffer. Will revert when we
286 get rid of the argument to Inset::clone(Buffer const &) */
287 void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
289 void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
291 bool insertFromMinibuffer(lyx::pos_type pos);
294 bool isHfill(lyx::pos_type pos) const;
296 bool isInset(lyx::pos_type pos) const;
298 bool isNewline(lyx::pos_type pos) const;
300 bool isSeparator(lyx::pos_type pos) const;
302 bool isLineSeparator(lyx::pos_type pos) const;
304 bool isKomma(lyx::pos_type pos) const;
305 /// Used by the spellchecker
306 bool isLetter(lyx::pos_type pos) const;
308 bool isWord(lyx::pos_type pos) const;
310 /// returns -1 if inset not found
311 int getPositionOfInset(Inset const * inset) const;
314 int stripLeadingSpaces();
317 bool isFreeSpacing() const;
320 ParagraphParameters & params();
322 ParagraphParameters const & params() const;
326 //Counters & counters();
329 LyXLayout_ptr layout_;
330 /// if anything uses this we don't want it to.
331 Paragraph(Paragraph const &);
336 Paragraph * previous_;
340 friend struct Paragraph::Pimpl;
346 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
348 return par.lookupChange(pos) == Change::INSERTED;
352 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
354 return par.lookupChange(pos) == Change::DELETED;
357 #endif // PARAGRAPH_H