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;
86 Paragraph(Paragraph const &);
88 Paragraph & operator=(Paragraph const &);
95 Language const * getParLanguage(BufferParams const &) const;
97 bool isRTL(BufferParams const &) const;
99 void changeLanguage(BufferParams const & bparams,
100 Language const * from, Language const * to);
102 bool isMultiLingual(BufferParams const &) const;
105 docstring const asString(Buffer const &, bool label) const;
107 docstring const asString(Buffer const & buffer,
113 void write(Buffer const &, std::ostream &, BufferParams const &,
114 depth_type & depth) const;
116 void validate(LaTeXFeatures &) const;
119 bool latex(Buffer const &, BufferParams const &,
120 Font const & outerfont, odocstream &,
121 TexRow & texrow, OutputParams const &) const;
123 /// Can we drop the standard paragraph wrapper?
124 bool emptyTag() const;
126 /// Get the id of the paragraph, usefull for docbook
127 std::string getID(Buffer const & buf,
128 OutputParams const & runparams) const;
130 /// Get the first word of a paragraph, return the position where it left
131 pos_type getFirstWord(Buffer const & buf,
133 OutputParams const & runparams) const;
135 /// Checks if the paragraph contains only text and no inset or font change.
136 bool onlyText(Buffer const & buf, Font const & outerfont,
137 pos_type initial) const;
139 /// Writes to stream the docbook representation
140 void simpleDocBookOnePar(Buffer const & buf,
142 OutputParams const & runparams,
143 Font const & outerfont,
144 pos_type initial = 0) const;
147 bool hasSameLayout(Paragraph const & par) const;
150 void makeSameLayout(Paragraph const & par);
153 void setInsetOwner(Inset * inset);
155 Inset * inInset() const;
157 InsetCode ownerCode() const;
159 bool forceDefaultParagraphs() const;
162 pos_type size() const { return text_.size(); }
164 bool empty() const { return text_.empty(); }
167 LayoutPtr const & layout() const;
169 void layout(LayoutPtr const & new_layout);
171 /// This is the item depth, only used by enumerate and itemize
172 signed char itemdepth;
175 InsetBibitem * bibitem() const; // ale970302
177 /// look up change at given pos
178 Change const & lookupChange(pos_type pos) const;
180 /// is there a change within the given range ?
181 bool isChanged(pos_type start, pos_type end) const;
182 /// is there an unchanged char at the given pos ?
183 bool isUnchanged(pos_type pos) const;
184 /// is there an insertion at the given pos ?
185 bool isInserted(pos_type pos) const;
186 /// is there a deletion at the given pos ?
187 bool isDeleted(pos_type pos) const;
189 /// will the paragraph be physically merged with the next
190 /// one if the imaginary end-of-par character is logically deleted?
191 bool isMergedOnEndOfParDeletion(bool trackChanges) const;
193 /// set change for the entire par
194 void setChange(Change const & change);
196 /// set change at given pos
197 void setChange(pos_type pos, Change const & change);
199 /// accept changes within the given range
200 void acceptChanges(BufferParams const & bparams, pos_type start, pos_type end);
202 /// reject changes within the given range
203 void rejectChanges(BufferParams const & bparams, pos_type start, pos_type end);
205 /// Paragraphs can contain "manual labels", for example, Description
206 /// environment. The text for this user-editable label is stored in
207 /// the paragraph alongside the text of the rest of the paragraph
208 /// (the body). This function returns the starting position of the
209 /// body of the text in the paragraph.
210 pos_type beginOfBody() const;
211 /// recompute this value
212 void setBeginOfBody();
215 docstring const & getLabelstring() const;
217 /// the next two functions are for the manual labels
218 docstring const getLabelWidthString() const;
219 /// Set label width string.
220 void setLabelWidthString(docstring const & s);
221 /// translate \p label to the paragraph language if possible.
222 docstring const translateIfPossible(docstring const & label,
223 BufferParams const & bparams) const;
224 /// Expand the counters for the labelstring of \c layout
225 docstring expandLabel(LayoutPtr const &, BufferParams const &,
226 bool process_appendix = true) const;
227 /// Actual paragraph alignment used
228 char getAlign() const;
229 /// The nesting depth of a paragraph
230 depth_type getDepth() const;
231 /// The maximal possible depth of a paragraph after this one
232 depth_type getMaxDepthAfter() const;
234 void applyLayout(LayoutPtr const & new_layout);
236 /// (logically) erase the char at pos; return true if it was actually erased
237 bool eraseChar(pos_type pos, bool trackChanges);
238 /// (logically) erase the given range; return the number of chars actually erased
239 int eraseChars(pos_type start, pos_type end, bool trackChanges);
241 /** Get uninstantiated font setting. Returns the difference
242 between the characters font and the layoutfont.
243 This is what is stored in the fonttable
246 getFontSettings(BufferParams const &, pos_type pos) const;
248 Font const getFirstFontSettings(BufferParams const &) const;
250 /** Get fully instantiated font. If pos == -1, use the layout
251 font attached to this paragraph.
252 If pos == -2, use the label font of the layout attached here.
253 In all cases, the font is instantiated, i.e. does not have any
254 attributes with values Font::INHERIT, Font::IGNORE or
257 Font const getFont(BufferParams const &, pos_type pos,
258 Font const & outerfont) const;
259 Font const getLayoutFont(BufferParams const &,
260 Font const & outerfont) const;
261 Font const getLabelFont(BufferParams const &,
262 Font const & outerfont) const;
264 * The font returned by the above functions is the same in a
265 * span of characters. This method will return the first and
266 * the last positions in the paragraph for which that font is
267 * the same. This can be used to avoid unnecessary calls to getFont.
269 FontSpan fontSpan(pos_type pos) const;
271 /// this is a bottleneck.
272 value_type getChar(pos_type pos) const { return text_[pos]; }
273 /// Get the char, but mirror all bracket characters if it is right-to-left
274 value_type getUChar(BufferParams const &, pos_type pos) const;
275 /// pos <= size() (there is a dummy font change at the end of each par)
276 void setFont(pos_type pos, Font const & font);
277 /// Returns the height of the highest font in range
278 Font_size highestFontInRange(pos_type startpos,
279 pos_type endpos, Font_size def_size) const;
281 void insert(pos_type pos, docstring const & str,
282 Font const & font, Change const & change);
285 void appendString(docstring const & s, Font const & font,
286 Change const & change);
288 void appendChar(value_type c, Font const & font, Change const & change);
290 void insertChar(pos_type pos, value_type c, bool trackChanges);
292 void insertChar(pos_type pos, value_type c,
293 Font const &, bool trackChanges);
295 void insertChar(pos_type pos, value_type c,
296 Font const &, Change const & change);
298 void insertInset(pos_type pos, Inset * inset,
299 Change const & change);
301 void insertInset(pos_type pos, Inset * inset,
302 Font const &, Change const & change);
304 bool insetAllowed(InsetCode code);
306 Inset * getInset(pos_type pos);
308 Inset const * getInset(pos_type pos) const;
310 /// Release inset at given position.
311 /// \warning does not honour change tracking!
312 /// Therefore, it should only be used for breaking and merging
314 Inset * releaseInset(pos_type pos);
317 InsetList const & insetList() const;
320 bool isHfill(pos_type pos) const;
322 /// hinted by profiler
323 bool isInset(pos_type pos) const {
324 return getChar(pos) == static_cast<value_type>(META_INSET);
327 bool isNewline(pos_type pos) const;
328 /// return true if the char is a word separator
329 bool isSeparator(pos_type pos) const { return getChar(pos) == ' '; }
331 bool isLineSeparator(pos_type pos) const;
332 /// True if the character/inset at this point can be part of a word.
333 /// Note that digits in particular are considered as letters
334 bool isLetter(pos_type pos) const;
336 /// returns true if at least one line break or line separator has been deleted
337 /// at the beginning of the paragraph (either physically or logically)
338 bool stripLeadingSpaces(bool trackChanges);
340 /// return true if we allow multiple spaces
341 bool isFreeSpacing() const;
343 /// return true if we allow this par to stay empty
344 bool allowEmpty() const;
346 char_type transformChar(char_type c, pos_type pos) const;
348 ParagraphParameters & params();
350 ParagraphParameters const & params() const;
352 /// Check if we are in a Biblio environment and insert or
353 /// delete InsetBibitems as necessary.
354 /// \retval int 1, if we had to add an inset, in which case
355 /// the cursor will need to move cursor forward; -pos, if we deleted
356 /// an inset, in which case pos is the position from which the inset
357 /// was deleted, and the cursor will need to be moved back one if it
358 /// was previously past that position. Return 0 otherwise.
359 int checkBiblio(bool track_changes);
361 /// For each author, set 'used' to true if there is a change
362 /// by this author in the paragraph.
363 void checkAuthors(AuthorList const & authorList);
365 /// return the number of InsetOptArg in a paragraph
366 int numberOfOptArgs() const;
370 * Keeping this here instead of in the pimpl makes LyX >10% faster
371 * for average tasks as buffer loading/switching etc.
373 typedef std::vector<value_type> TextContainer;
380 friend class Paragraph::Private;
387 #endif // PARAGRAPH_H