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>
29 struct Paragraph::Pimpl {
31 Pimpl(Paragraph * owner);
32 /// "Copy constructor"
33 Pimpl(Pimpl const &, Paragraph * owner);
35 void setContentsFromPar(Paragraph const & par);
41 void trackChanges(Change::Type type = Change::UNCHANGED);
43 void untrackChanges();
44 /// set all text as new for change mode
46 /// look up change type at given pos
47 Change::Type lookupChange(lyx::pos_type pos) const;
48 /// look up change at given pos
49 Change const lookupChangeFull(lyx::pos_type pos) const;
50 /// is there a change in the given range ?
51 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
52 /// is there a non-addition in this range ?
53 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
55 void setChange(lyx::pos_type pos, Change::Type type);
59 void acceptChange(lyx::pos_type start, lyx::pos_type end);
61 void rejectChange(lyx::pos_type start, lyx::pos_type end);
62 /// are we tracking changes ?
63 bool tracking() const { return changes_.get(); }
66 value_type getChar(lyx::pos_type pos) const;
68 void setChar(lyx::pos_type pos, value_type c);
70 void insertChar(lyx::pos_type pos, value_type c, Change change);
72 void insertInset(lyx::pos_type pos, InsetBase * inset, Change change);
74 void eraseIntern(lyx::pos_type pos);
75 /// erase the given position. Returns true if it was actually erased
76 bool erase(lyx::pos_type pos);
77 /// erase the given range
78 int erase(lyx::pos_type start, lyx::pos_type end);
80 UpdatableInset * inset_owner;
82 /** A font entry covers a range of positions. Notice that the
83 entries in the list are inserted in random order.
84 I don't think it's worth the effort to implement a more effective
85 datastructure, because the number of different fonts in a paragraph
87 Nevertheless, I decided to store fontlist using a sorted vector:
88 fontlist = { {pos_1,font_1} , {pos_2,font_2} , ... } where
89 pos_1 < pos_2 < ..., font_{i-1} != font_i for all i,
90 and font_i covers the chars in positions pos_{i-1}+1,...,pos_i
91 (font_1 covers the chars 0,...,pos_1) (Dekel)
95 FontTable(lyx::pos_type p, LyXFont const & f)
99 font_ = container.get(f);
103 lyx::pos_type pos() const { return pos_; }
105 void pos(lyx::pos_type p) { pos_ = p; }
107 LyXFont const & font() const { return font_; }
110 void font(LyXFont const & f) { font_ = container.get(f);}
113 void font(LyXFont const & f) { font_ = f;}
116 /// End position of paragraph this font attribute covers
118 /** Font. Interpretation of the font values:
119 If a value is LyXFont::INHERIT_*, it means that the font
120 attribute is inherited from either the layout of this
121 paragraph or, in the case of nested paragraphs, from the
122 layout in the environment one level up until completely
124 The values LyXFont::IGNORE_* and LyXFont::TOGGLE are NOT
125 allowed in these font tables.
128 boost::shared_ptr<LyXFont> font_;
130 static ShareContainer<LyXFont> container;
136 friend struct matchFT;
139 /// used by lower_bound and upper_bound
141 int operator()(FontTable const & a, FontTable const & b) const {
142 return a.pos() < b.pos();
147 typedef std::vector<FontTable> FontList;
152 void simpleTeXBlanks(std::ostream &, TexRow & texrow,
153 lyx::pos_type const i,
154 unsigned int & column,
155 LyXFont const & font,
156 LyXLayout const & style);
158 void simpleTeXSpecialChars(Buffer const &, BufferParams const &,
159 std::ostream &, TexRow & texrow,
160 OutputParams const &,
161 LyXFont & font, LyXFont & running_font,
163 LyXFont const & outerfont,
165 Change::Type & running_change,
166 LyXLayout const & style,
168 unsigned int & column, value_type const c);
171 void validate(LaTeXFeatures & features,
172 LyXLayout const & layout) const;
177 static unsigned int paragraph_id;
179 ParagraphParameters params;
183 lyx::pos_type size() const { return owner_->size(); }
184 /// match a string against a particular point in the paragraph
185 bool isTextAt(std::string const & str, lyx::pos_type pos) const;
187 /// for recording and looking up changes in revision tracking mode
188 boost::scoped_ptr<Changes> changes_;