3 * \file paragraph_pimpl.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * Full author contact details are available in file CREDITS.
15 #ifndef PARAGRAPH_PIMPL_H
16 #define PARAGRAPH_PIMPL_H
18 #include "paragraph.h"
22 #include "ParagraphParameters.h"
24 #include <boost/scoped_ptr.hpp>
32 class Paragraph::Pimpl {
35 Pimpl(Paragraph * owner);
36 /// "Copy constructor"
37 Pimpl(Pimpl const &, Paragraph * owner);
39 void setContentsFromPar(Paragraph const & par);
44 /// look up change at given pos
45 Change const lookupChange(pos_type pos) const;
46 /// is there a change within the given range ?
47 bool isChanged(pos_type start, pos_type end) const;
48 /// set change for the entire par
49 void setChange(Change const & change);
50 /// set change at given pos
51 void setChange(pos_type pos, Change const & change);
52 /// accept changes within the given range
53 void acceptChanges(pos_type start, pos_type end);
55 void rejectChange(pos_type start, pos_type end);
58 value_type getChar(pos_type pos) const;
60 void insertChar(pos_type pos, value_type c, Change const & change);
62 void insertInset(pos_type pos, InsetBase * inset, Change const & change);
63 /// (logically) erase the char at pos; return true if it was actually erased
64 bool eraseChar(pos_type pos, bool trackChanges);
65 /// (logically) erase the given range; return the number of chars actually erased
66 int eraseChars(pos_type start, pos_type end, bool trackChanges);
68 InsetBase * inset_owner;
70 /** A font entry covers a range of positions. Notice that the
71 entries in the list are inserted in random order.
72 I don't think it's worth the effort to implement a more effective
73 datastructure, because the number of different fonts in a paragraph
75 Nevertheless, I decided to store fontlist using a sorted vector:
76 fontlist = { {pos_1,font_1} , {pos_2,font_2} , ... } where
77 pos_1 < pos_2 < ..., font_{i-1} != font_i for all i,
78 and font_i covers the chars in positions pos_{i-1}+1,...,pos_i
79 (font_1 covers the chars 0,...,pos_1) (Dekel)
84 FontTable(pos_type p, LyXFont const & f)
88 pos_type pos() const { return pos_; }
90 void pos(pos_type p) { pos_ = p; }
92 LyXFont const & font() const { return font_; }
94 void font(LyXFont const & f) { font_ = f;}
96 /// End position of paragraph this font attribute covers
98 /** Font. Interpretation of the font values:
99 If a value is LyXFont::INHERIT_*, it means that the font
100 attribute is inherited from either the layout of this
101 paragraph or, in the case of nested paragraphs, from the
102 layout in the environment one level up until completely
104 The values LyXFont::IGNORE_* and LyXFont::TOGGLE are NOT
105 allowed in these font tables.
110 friend class matchFT;
114 /// used by lower_bound and upper_bound
115 int operator()(FontTable const & a, FontTable const & b) const {
116 return a.pos() < b.pos();
121 typedef std::vector<FontTable> FontList;
126 void simpleTeXBlanks(odocstream &, TexRow & texrow,
128 unsigned int & column,
129 LyXFont const & font,
130 LyXLayout const & style);
132 void simpleTeXSpecialChars(Buffer const &, BufferParams const &,
133 odocstream &, TexRow & texrow,
134 OutputParams const &,
135 LyXFont & font, LyXFont & running_font,
137 LyXFont const & outerfont,
139 Change::Type & running_change,
140 LyXLayout const & style,
142 unsigned int & column, value_type const c);
145 void validate(LaTeXFeatures & features,
146 LyXLayout const & layout) const;
151 static unsigned int paragraph_id;
153 ParagraphParameters params;
157 pos_type size() const { return owner_->size(); }
158 /// match a string against a particular point in the paragraph
159 bool isTextAt(std::string const & str, pos_type pos) const;
161 /// for recording and looking up changes