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.
19 #include "lyxlayout_ptr_fwd.h"
21 #include "insets/InsetCode.h"
23 #include "support/docstring.h"
24 // FIXME: would be nice to forward declare odocstream instead of
26 #include "support/docstream.h"
48 class ParagraphParameters;
54 /// Invalid font span containing no character
55 FontSpan() : first(0), last(-1) {}
56 /// Span including first and last
57 FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
60 /// Range including first and last.
65 /// A Paragraph holds all text, attributes and insets in a text paragraph
66 /// \todo FIXME: any reference to ParagraphMetrics (including inheritance)
67 /// should go in order to complete the Model/View separation of this class.
72 /// Note that this is 1 right now to avoid
73 /// crashes where getChar() is called wrongly
74 /// (returning 0) - if this was 0, then we'd
75 /// try getInset() and crash. We should fix
77 //META_INSET = 1 // as in trunk
78 META_INSET = 0x200001 // above 0x10ffff, for ucs-4
81 typedef char_type value_type;
83 typedef std::vector<value_type> TextContainer;
88 Paragraph(Paragraph const &);
90 Paragraph & operator=(Paragraph const &);
98 Language const * getParLanguage(BufferParams const &) const;
100 bool isRTL(BufferParams const &) const;
102 void changeLanguage(BufferParams const & bparams,
103 Language const * from, Language const * to);
105 bool isMultiLingual(BufferParams const &) const;
108 docstring const asString(Buffer const &, bool label) const;
110 docstring const asString(Buffer const & buffer,
116 void write(Buffer const &, std::ostream &, BufferParams const &,
117 depth_type & depth) const;
119 void validate(LaTeXFeatures &) const;
122 int startTeXParParams(BufferParams const &, odocstream &, TexRow &,
126 int endTeXParParams(BufferParams const &, odocstream &, TexRow &,
131 bool simpleTeXOnePar(Buffer const &, BufferParams const &,
132 Font const & outerfont, odocstream &,
133 TexRow & texrow, OutputParams const &) const;
135 /// Can we drop the standard paragraph wrapper?
136 bool emptyTag() const;
138 /// Get the id of the paragraph, usefull for docbook
139 std::string getID(Buffer const & buf,
140 OutputParams const & runparams) const;
142 /// Get the first word of a paragraph, return the position where it left
143 pos_type getFirstWord(Buffer const & buf,
145 OutputParams const & runparams) const;
147 /// Checks if the paragraph contains only text and no inset or font change.
148 bool onlyText(Buffer const & buf, Font const & outerfont,
149 pos_type initial) const;
151 /// Writes to stream the docbook representation
152 void simpleDocBookOnePar(Buffer const & buf,
154 OutputParams const & runparams,
155 Font const & outerfont,
156 pos_type initial = 0) const;
159 bool hasSameLayout(Paragraph const & par) const;
162 void makeSameLayout(Paragraph const & par);
165 void setInsetOwner(Inset * inset);
167 Inset * inInset() const;
169 InsetCode ownerCode() const;
171 bool forceDefaultParagraphs() const;
174 pos_type size() const { return text_.size(); }
176 bool empty() const { return text_.empty(); }
179 LayoutPtr const & layout() const;
181 void layout(LayoutPtr const & new_layout);
183 /// This is the item depth, only used by enumerate and itemize
184 signed char itemdepth;
187 InsetBibitem * bibitem() const; // ale970302
189 /// look up change at given pos
190 Change const & lookupChange(pos_type pos) const;
192 /// is there a change within the given range ?
193 bool isChanged(pos_type start, pos_type end) const;
194 /// is there an unchanged char at the given pos ?
195 bool isUnchanged(pos_type pos) const;
196 /// is there an insertion at the given pos ?
197 bool isInserted(pos_type pos) const;
198 /// is there a deletion at the given pos ?
199 bool isDeleted(pos_type pos) const;
201 /// will the paragraph be physically merged with the next
202 /// one if the imaginary end-of-par character is logically deleted?
203 bool isMergedOnEndOfParDeletion(bool trackChanges) const;
205 /// set change for the entire par
206 void setChange(Change const & change);
208 /// set change at given pos
209 void setChange(pos_type pos, Change const & change);
211 /// accept changes within the given range
212 void acceptChanges(BufferParams const & bparams, pos_type start, pos_type end);
214 /// reject changes within the given range
215 void rejectChanges(BufferParams const & bparams, pos_type start, pos_type end);
217 /// Paragraphs can contain "manual labels", for example, Description
218 /// environment. The text for this user-editable label is stored in
219 /// the paragraph alongside the text of the rest of the paragraph
220 /// (the body). This function returns the starting position of the
221 /// body of the text in the paragraph.
222 pos_type beginOfBody() const;
223 /// recompute this value
224 void setBeginOfBody();
227 docstring const & getLabelstring() const;
229 /// the next two functions are for the manual labels
230 docstring const getLabelWidthString() const;
231 /// Set label width string.
232 void setLabelWidthString(docstring const & s);
233 /// translate \p label to the paragraph language if possible.
234 docstring const translateIfPossible(docstring const & label,
235 BufferParams const & bparams) const;
236 /// Expand the counters for the labelstring of \c layout
237 docstring expandLabel(LayoutPtr const &, BufferParams const &,
238 bool process_appendix = true) const;
239 /// Actual paragraph alignment used
240 char getAlign() const;
241 /// The nesting depth of a paragraph
242 depth_type getDepth() const;
243 /// The maximal possible depth of a paragraph after this one
244 depth_type getMaxDepthAfter() const;
246 void applyLayout(LayoutPtr const & new_layout);
248 /// (logically) erase the char at pos; return true if it was actually erased
249 bool eraseChar(pos_type pos, bool trackChanges);
250 /// (logically) erase the given range; return the number of chars actually erased
251 int eraseChars(pos_type start, pos_type end, bool trackChanges);
253 /** Get uninstantiated font setting. Returns the difference
254 between the characters font and the layoutfont.
255 This is what is stored in the fonttable
258 getFontSettings(BufferParams const &, pos_type pos) const;
260 Font const getFirstFontSettings(BufferParams const &) const;
262 /** Get fully instantiated font. If pos == -1, use the layout
263 font attached to this paragraph.
264 If pos == -2, use the label font of the layout attached here.
265 In all cases, the font is instantiated, i.e. does not have any
266 attributes with values Font::INHERIT, Font::IGNORE or
269 Font const getFont(BufferParams const &, pos_type pos,
270 Font const & outerfont) const;
271 Font const getLayoutFont(BufferParams const &,
272 Font const & outerfont) const;
273 Font const getLabelFont(BufferParams const &,
274 Font const & outerfont) const;
276 * The font returned by the above functions is the same in a
277 * span of characters. This method will return the first and
278 * the last positions in the paragraph for which that font is
279 * the same. This can be used to avoid unnecessary calls to getFont.
281 FontSpan fontSpan(pos_type pos) const;
283 /// this is a bottleneck.
284 value_type getChar(pos_type pos) const { return text_[pos]; }
285 /// Get the char, but mirror all bracket characters if it is right-to-left
286 value_type getUChar(BufferParams const &, pos_type pos) const;
287 /// pos <= size() (there is a dummy font change at the end of each par)
288 void setFont(pos_type pos, Font const & font);
289 /// Returns the height of the highest font in range
290 Font_size highestFontInRange(pos_type startpos,
291 pos_type endpos, Font_size def_size) const;
293 void insert(pos_type pos, docstring const & str,
294 Font const & font, Change const & change);
296 void insertChar(pos_type pos, value_type c, bool trackChanges);
298 void insertChar(pos_type pos, value_type c,
299 Font const &, bool trackChanges);
301 void insertChar(pos_type pos, value_type c,
302 Font const &, Change const & change);
304 void insertInset(pos_type pos, Inset * inset,
305 Change const & change);
307 void insertInset(pos_type pos, Inset * inset,
308 Font const &, Change const & change);
310 bool insetAllowed(InsetCode code);
312 Inset * getInset(pos_type pos);
314 Inset const * getInset(pos_type pos) const;
316 /// Release inset at given position.
317 /// \warning does not honour change tracking!
318 /// Therefore, it should only be used for breaking and merging
320 Inset * releaseInset(pos_type pos);
323 InsetList const & insetList() const;
326 bool isHfill(pos_type pos) const;
328 /// hinted by profiler
329 bool isInset(pos_type pos) const {
330 return getChar(pos) == static_cast<value_type>(META_INSET);
333 bool isNewline(pos_type pos) const;
334 /// return true if the char is a word separator
335 bool isSeparator(pos_type pos) const { return getChar(pos) == ' '; }
337 bool isLineSeparator(pos_type pos) const;
338 /// True if the character/inset at this point can be part of a word.
339 /// Note that digits in particular are considered as letters
340 bool isLetter(pos_type pos) const;
342 /// returns -1 if inset not found
343 int getPositionOfInset(Inset const * inset) const;
345 /// returns true if at least one line break or line separator has been deleted
346 /// at the beginning of the paragraph (either physically or logically)
347 bool stripLeadingSpaces(bool trackChanges);
349 /// return true if we allow multiple spaces
350 bool isFreeSpacing() const;
352 /// return true if we allow this par to stay empty
353 bool allowEmpty() const;
355 char_type transformChar(char_type c, pos_type pos) const;
357 ParagraphParameters & params();
359 ParagraphParameters const & params() const;
361 /// Check if we are in a Biblio environment and insert or
362 /// delete InsetBibitems as necessary.
363 /// \retval int 1, if we had to add an inset, in which case
364 /// the cursor will need to move cursor forward; -pos, if we deleted
365 /// an inset, in which case pos is the position from which the inset
366 /// was deleted, and the cursor will need to be moved back one if it
367 /// was previously past that position. Return 0 otherwise.
368 int checkBiblio(bool track_changes);
370 /// For each author, set 'used' to true if there is a change
371 /// by this author in the paragraph.
372 void checkAuthors(AuthorList const & authorList);
379 * Keeping this here instead of in the pimpl makes LyX >10% faster
380 * for average tasks as buffer loading/switching etc.
384 pos_type begin_of_body_;
389 friend class Paragraph::Pimpl;
396 #endif // PARAGRAPH_H