4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup
8 * \author Lars Gullik Bjønnes
10 * \author André Pönitz
11 * \author Jürgen Vigna
13 * Full author contact details are available in file CREDITS.
20 #include "dimension.h"
21 #include "InsetList.h"
22 #include "lyxlayout_ptr_fwd.h"
23 #include "RowList_fwd.h"
25 #include "insets/insetbase.h" // only for InsetBase::Code
44 class ParagraphParameters;
50 /// Invalid font span containing no character
51 FontSpan() : first(0), last(-1) {}
52 /// Span including first and last
53 FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
56 /// Range including first and last.
61 /// A Paragraph holds all text, attributes and insets in a text paragraph
62 /// \todo FIXME: any reference to ParagraphMetrics (including inheritance)
63 /// should go in order to complete the Model/View separation of this class.
68 /// Note that this is 1 right now to avoid
69 /// crashes where getChar() is called wrongly
70 /// (returning 0) - if this was 0, then we'd
71 /// try getInset() and crash. We should fix
73 //META_INSET = 1 // as in trunk
74 META_INSET = 0x200001 // above 0x10ffff, for ucs-4
77 typedef char_type value_type;
79 typedef std::vector<value_type> TextContainer;
84 Paragraph(Paragraph const &);
86 Paragraph & operator=(Paragraph const &);
94 Language const * getParLanguage(BufferParams const &) const;
96 bool isRightToLeftPar(BufferParams const &) const;
98 void changeLanguage(BufferParams const & bparams,
99 Language const * from, Language const * to);
101 bool isMultiLingual(BufferParams const &) const;
104 docstring const asString(Buffer const &,
105 OutputParams const & runparams,
108 docstring const asString(Buffer const &, bool label) const;
110 docstring const asString(Buffer const & buffer,
115 docstring const asString(Buffer const &,
116 OutputParams const & runparams,
122 void write(Buffer const &, std::ostream &, BufferParams const &,
123 depth_type & depth) const;
125 void validate(LaTeXFeatures &) const;
128 int startTeXParParams(BufferParams const &, odocstream &, bool) const;
131 int endTeXParParams(BufferParams const &, odocstream &, bool) const;
135 bool simpleTeXOnePar(Buffer const &, BufferParams const &,
136 LyXFont const & outerfont, odocstream &,
137 TexRow & texrow, OutputParams const &) const;
139 /// Can we drop the standard paragraph wrapper?
140 bool emptyTag() const;
142 /// Get the id of the paragraph, usefull for docbook
143 std::string getID(Buffer const & buf,
144 OutputParams const & runparams) const;
146 /// Get the first word of a paragraph, return the position where it left
147 pos_type getFirstWord(Buffer const & buf,
149 OutputParams const & runparams) const;
151 /// Checks if the paragraph contains only text and no inset or font change.
152 bool onlyText(Buffer const & buf, LyXFont const & outerfont,
153 pos_type initial) const;
155 /// Writes to stream the docbook representation
156 void simpleDocBookOnePar(Buffer const & buf,
158 OutputParams const & runparams,
159 LyXFont const & outerfont,
160 pos_type initial = 0) const;
163 bool hasSameLayout(Paragraph const & par) const;
166 void makeSameLayout(Paragraph const & par);
169 void setInsetOwner(InsetBase * inset);
171 InsetBase * inInset() const;
173 InsetBase::Code ownerCode() const;
175 bool forceDefaultParagraphs() const;
178 pos_type size() const { return text_.size(); }
180 bool empty() const { return text_.empty(); }
182 void clearContents();
185 LyXLayout_ptr const & layout() const;
187 void layout(LyXLayout_ptr const & new_layout);
189 /// This is the item depth, only used by enumerate and itemize
190 signed char itemdepth;
193 InsetBibitem * bibitem() const; // ale970302
195 /// look up change at given pos
196 Change const & lookupChange(pos_type pos) const;
198 /// is there a change within the given range ?
199 bool isChanged(pos_type start, pos_type end) const;
200 /// is there an unchanged char at the given pos ?
201 bool isUnchanged(pos_type pos) const {
202 return lookupChange(pos).type == Change::UNCHANGED;
204 /// is there an insertion at the given pos ?
205 bool isInserted(pos_type pos) const {
206 return lookupChange(pos).type == Change::INSERTED;
208 /// is there a deletion at the given pos ?
209 bool isDeleted(pos_type pos) const {
210 return lookupChange(pos).type == Change::DELETED;
213 /// will the paragraph be physically merged with the next
214 /// one if the imaginary end-of-par character is logically deleted?
215 bool isMergedOnEndOfParDeletion(bool trackChanges) const;
217 /// set change for the entire par
218 void setChange(Change const & change);
220 /// set change at given pos
221 void setChange(pos_type pos, Change const & change);
223 /// accept changes within the given range
224 void acceptChanges(pos_type start, pos_type end);
226 /// reject changes within the given range
227 void rejectChanges(pos_type start, pos_type end);
229 /// Paragraphs can contain "manual labels", for example, Description
230 /// environment. The text for this user-editable label is stored in
231 /// the paragraph alongside the text of the rest of the paragraph
232 /// (the body). This function returns the starting position of the
233 /// body of the text in the paragraph.
234 pos_type beginOfBody() const;
235 /// recompute this value
236 void setBeginOfBody();
239 docstring const & getLabelstring() const;
241 /// the next two functions are for the manual labels
242 docstring const getLabelWidthString() const;
243 /// Set label width string.
244 void setLabelWidthString(docstring const & s);
245 /// translate \p label to the paragraph language if possible.
246 docstring const translateIfPossible(docstring const & label,
247 BufferParams const & bparams) const;
248 /// Expand the counters for the labelstring of \c layout
249 docstring expandLabel(LyXLayout_ptr const &, BufferParams const &,
250 bool process_appendix = true) const;
251 /// Actual paragraph alignment used
252 char getAlign() const;
253 /// The nesting depth of a paragraph
254 depth_type getDepth() const;
255 /// The maximal possible depth of a paragraph after this one
256 depth_type getMaxDepthAfter() const;
258 void applyLayout(LyXLayout_ptr const & new_layout);
260 /// (logically) erase the char at pos; return true if it was actually erased
261 bool eraseChar(pos_type pos, bool trackChanges);
262 /// (logically) erase the given range; return the number of chars actually erased
263 int eraseChars(pos_type start, pos_type end, bool trackChanges);
265 /** Get uninstantiated font setting. Returns the difference
266 between the characters font and the layoutfont.
267 This is what is stored in the fonttable
270 getFontSettings(BufferParams const &, pos_type pos) const;
272 LyXFont const getFirstFontSettings(BufferParams const &) const;
274 /** Get fully instantiated font. If pos == -1, use the layout
275 font attached to this paragraph.
276 If pos == -2, use the label font of the layout attached here.
277 In all cases, the font is instantiated, i.e. does not have any
278 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
281 LyXFont const getFont(BufferParams const &, pos_type pos,
282 LyXFont const & outerfont) const;
283 LyXFont const getLayoutFont(BufferParams const &,
284 LyXFont const & outerfont) const;
285 LyXFont const getLabelFont(BufferParams const &,
286 LyXFont const & outerfont) const;
288 * The font returned by the above functions is the same in a
289 * span of characters. This method will return the first and
290 * the last positions in the paragraph for which that font is
291 * the same. This can be used to avoid unnecessary calls to getFont.
293 FontSpan fontSpan(pos_type pos) const;
295 /// this is a bottleneck.
296 value_type getChar(pos_type pos) const { return text_[pos]; }
297 /// Get the char, but mirror all bracket characters if it is right-to-left
298 value_type getUChar(BufferParams const &, pos_type pos) const;
299 /// pos <= size() (there is a dummy font change at the end of each par)
300 void setFont(pos_type pos, LyXFont const & font);
301 /// Returns the height of the highest font in range
302 LyXFont_size highestFontInRange(pos_type startpos,
303 pos_type endpos, LyXFont_size def_size) const;
305 void insert(pos_type pos, docstring const & str,
306 LyXFont const & font, Change const & change);
308 void insertChar(pos_type pos, value_type c, bool trackChanges);
310 void insertChar(pos_type pos, value_type c,
311 LyXFont const &, bool trackChanges);
313 void insertChar(pos_type pos, value_type c,
314 LyXFont const &, Change const & change);
316 void insertInset(pos_type pos, InsetBase * inset,
317 Change const & change);
319 void insertInset(pos_type pos, InsetBase * inset,
320 LyXFont const &, Change const & change);
322 bool insetAllowed(InsetBase_code code);
324 InsetBase * getInset(pos_type pos) {
325 return insetlist.get(pos);
328 InsetBase const * getInset(pos_type pos) const {
329 return insetlist.get(pos);
333 bool isHfill(pos_type pos) const {
335 && getInset(pos)->lyxCode() == InsetBase::HFILL_CODE;
337 /// hinted by profiler
338 bool isInset(pos_type pos) const {
339 return getChar(pos) == static_cast<value_type>(META_INSET);
342 bool isNewline(pos_type pos) const;
343 /// return true if the char is a word separator
344 bool isSeparator(pos_type pos) const { return getChar(pos) == ' '; }
346 bool isLineSeparator(pos_type pos) const;
347 /// True if the character/inset at this point can be part of a word.
348 /// Note that digits in particular are considered as letters
349 bool isLetter(pos_type pos) const;
351 /// returns -1 if inset not found
352 int getPositionOfInset(InsetBase const * inset) const;
354 /// Returns the number of line breaks and white-space stripped at the start
355 int stripLeadingSpaces(bool trackChanges);
357 /// return true if we allow multiple spaces
358 bool isFreeSpacing() const;
360 /// return true if we allow this par to stay empty
361 bool allowEmpty() const;
363 char_type transformChar(char_type c, pos_type pos) const;
365 ParagraphParameters & params();
367 ParagraphParameters const & params() const;
369 bool hfillExpansion(Row const & row, pos_type pos) const;
371 /// Check if we are in a Biblio environment.
372 /// \retval true if the cursor needs to be moved right.
373 bool checkBiblio(bool track_changes);
382 LyXLayout_ptr layout_;
384 * Keeping this here instead of in the pimpl makes LyX >10% faster
385 * for average tasks as buffer loading/switching etc.
389 pos_type begin_of_body_;
394 friend class Paragraph::Pimpl;
401 #endif // PARAGRAPH_H