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"
23 #include <boost/optional.hpp>
33 class ParagraphParameters;
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;
58 Paragraph(Paragraph const &);
60 //void operator=(Paragraph const &);
61 /// the destructor removes the new paragraph from the list
65 Language const * getParLanguage(BufferParams const &) const;
67 bool isRightToLeftPar(BufferParams const &) const;
69 void changeLanguage(BufferParams const & bparams,
70 Language const * from, Language const * to);
72 bool isMultiLingual(BufferParams const &);
75 string const asString(Buffer const *, bool label) const;
77 string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
81 void write(Buffer const *, std::ostream &, BufferParams const &,
82 depth_type & depth) const;
84 void validate(LaTeXFeatures &) const;
86 /// return the unique ID of this paragraph
88 /// Set the Id of this paragraph.
92 int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
95 int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
99 bool simpleTeXOnePar(Buffer const *, BufferParams const &,
100 LyXFont const & outerfont, std::ostream &,
101 TexRow & texrow, LatexRunParams const &);
104 bool hasSameLayout(Paragraph const & par) const;
107 void makeSameLayout(Paragraph const & par);
110 Inset * inInset() const;
112 void setInsetOwner(Inset * i);
114 void deleteInsetsLyXText(BufferView *);
116 void resizeInsetsLyXText(BufferView *);
119 lyx::pos_type size() const;
123 void setContentsFromPar(Paragraph const & par);
125 void clearContents();
128 LyXLayout_ptr const & layout() const;
130 void layout(LyXLayout_ptr const & new_layout);
139 InsetBibitem * bibitem() const; // ale970302
141 /// initialise tracking for this par
142 void trackChanges(Change::Type = Change::UNCHANGED);
145 void untrackChanges();
147 /// set entire paragraph to new text for change tracking
150 /// look up change type at given pos
151 Change::Type lookupChange(lyx::pos_type pos) const;
153 /// look up change at given pos
154 Change const lookupChangeFull(lyx::pos_type pos) const;
156 /// is there a change within the given range ?
157 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
159 /// is there a non-addition in this range ?
160 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
162 /// set change at pos
163 void setChange(lyx::pos_type pos, Change::Type type);
166 void acceptChange(lyx::pos_type start, lyx::pos_type end);
169 void rejectChange(lyx::pos_type start, lyx::pos_type end);
171 /// mark whole par as erased
174 /// Paragraphs can contain "manual labels", for example, Description
175 /// environment. The text for this user-editable label is stored in
176 /// the paragraph alongside the text of the rest of the paragraph
177 /// (the body). This function returns the starting position of the
178 /// body of the text in the paragraph.
179 int beginningOfBody() const;
182 string const & getLabelstring() const;
184 /// the next two functions are for the manual labels
185 string const getLabelWidthString() const;
187 void setLabelWidthString(string const & s);
189 char getAlign() const;
190 /// The nesting depth of a paragraph
191 depth_type getDepth() const;
192 /// The maximal possible depth of a paragraph after this one
193 depth_type getMaxDepthAfter() const;
195 void applyLayout(LyXLayout_ptr const & new_layout);
198 void eraseIntern(lyx::pos_type pos);
199 /// erase the char at the given position
200 bool erase(lyx::pos_type pos);
201 /// erase the given range. Returns the number of chars actually erased
202 int erase(lyx::pos_type start, lyx::pos_type end);
204 /** Get uninstantiated font setting. Returns the difference
205 between the characters font and the layoutfont.
206 This is what is stored in the fonttable
209 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
211 LyXFont const getFirstFontSettings() const;
213 /** Get fully instantiated font. If pos == -1, use the layout
214 font attached to this paragraph.
215 If pos == -2, use the label font of the layout attached here.
216 In all cases, the font is instantiated, i.e. does not have any
217 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
220 LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
221 LyXFont const & outerfont) const;
222 LyXFont const getLayoutFont(BufferParams const &,
223 LyXFont const & outerfont) const;
224 LyXFont const getLabelFont(BufferParams const &,
225 LyXFont const & outerfont) const;
227 value_type getChar(lyx::pos_type pos) const;
229 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
230 /// The position must already exist.
231 void setChar(lyx::pos_type pos, value_type c);
232 /// pos <= size() (there is a dummy font change at the end of each par)
233 void setFont(lyx::pos_type pos, LyXFont const & font);
234 /// Returns the height of the highest font in range
236 highestFontInRange(lyx::pos_type startpos,
237 lyx::pos_type endpos,
238 LyXFont::FONT_SIZE const def_size) const;
240 void insertChar(lyx::pos_type pos, value_type c);
242 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
244 bool checkInsertChar(LyXFont &);
246 void insertInset(lyx::pos_type pos, Inset * inset);
248 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
250 bool insetAllowed(Inset::Code code);
252 Inset * getInset(lyx::pos_type pos);
254 Inset const * getInset(lyx::pos_type pos) const;
255 /** important for cut and paste
256 Temporary change from BufferParams to Buffer. Will revert when we
257 get rid of the argument to Inset::clone(Buffer const &) */
258 void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
260 void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
262 bool insertFromMinibuffer(lyx::pos_type pos);
265 bool isHfill(lyx::pos_type pos) const;
267 bool isInset(lyx::pos_type pos) const;
269 bool isNewline(lyx::pos_type pos) const;
271 bool isSeparator(lyx::pos_type pos) const;
273 bool isLineSeparator(lyx::pos_type pos) const;
275 bool isKomma(lyx::pos_type pos) const;
276 /// Used by the spellchecker
277 bool isLetter(lyx::pos_type pos) const;
279 bool isWord(lyx::pos_type pos) const;
281 /// returns -1 if inset not found
282 int getPositionOfInset(Inset const * inset) const;
285 int stripLeadingSpaces();
288 bool isFreeSpacing() const;
291 ParagraphParameters & params();
293 ParagraphParameters const & params() const;
297 void owningBuffer(Buffer const & b) {
302 LyXLayout_ptr layout_;
304 boost::optional<Buffer const *> buffer_;
308 friend struct Paragraph::Pimpl;
315 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
317 return par.lookupChange(pos) == Change::INSERTED;
321 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
323 return par.lookupChange(pos) == Change::DELETED;
327 bool operator==(Paragraph const & lhs, Paragraph const & rhs);
329 #endif // PARAGRAPH_H