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"
19 #include "ParagraphParameters.h"
22 #include <boost/scoped_ptr.hpp>
26 struct Paragraph::Pimpl {
28 typedef std::vector<value_type> TextContainer;
31 Pimpl(Paragraph * owner);
33 Pimpl(Pimpl const &, Paragraph * owner);
35 lyx::pos_type size() const {
45 void setContentsFromPar(Paragraph const & par);
47 void trackChanges(Change::Type type = Change::UNCHANGED);
49 void untrackChanges();
50 /// set all text as new for change mode
52 /// look up change type at given pos
53 Change::Type lookupChange(lyx::pos_type pos) const;
54 /// look up change at given pos
55 Change const lookupChangeFull(lyx::pos_type pos) const;
56 /// is there a change in the given range ?
57 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
58 /// is there a non-addition in this range ?
59 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
62 void setChange(lyx::pos_type pos, Change::Type type);
68 void acceptChange(lyx::pos_type start, lyx::pos_type end);
71 void rejectChange(lyx::pos_type start, lyx::pos_type end);
73 /// are we tracking changes ?
74 bool tracking() const {
75 return changes_.get();
79 value_type getChar(lyx::pos_type pos) const;
81 void setChar(lyx::pos_type pos, value_type c);
83 void insertChar(lyx::pos_type pos, value_type c, LyXFont const & font, Change change = Change(Change::INSERTED));
85 void insertInset(lyx::pos_type pos, InsetOld * inset, LyXFont const & font, Change change = Change(Change::INSERTED));
87 void eraseIntern(lyx::pos_type pos);
88 /// erase the given position. Returns true if it was actually erased
89 bool erase(lyx::pos_type pos);
90 /// erase the given range
91 int erase(lyx::pos_type start, lyx::pos_type end);
93 UpdatableInset * inset_owner;
95 /** A font entry covers a range of positions. Notice that the
96 entries in the list are inserted in random order.
97 I don't think it's worth the effort to implement a more effective
98 datastructure, because the number of different fonts in a paragraph
100 Nevertheless, I decided to store fontlist using a sorted vector:
101 fontlist = { {pos_1,font_1} , {pos_2,font_2} , ... } where
102 pos_1 < pos_2 < ..., font_{i-1} != font_i for all i,
103 and font_i covers the chars in positions pos_{i-1}+1,...,pos_i
104 (font_1 covers the chars 0,...,pos_1) (Dekel)
108 FontTable(lyx::pos_type p, LyXFont const & f)
111 font_ = container.get(f);
114 lyx::pos_type pos() const { return pos_; }
116 void pos(lyx::pos_type p) { pos_ = p; }
118 LyXFont const & font() const { return *font_; }
120 void font(LyXFont const & f) { font_ = container.get(f);}
122 /// End position of paragraph this font attribute covers
124 /** Font. Interpretation of the font values:
125 If a value is LyXFont::INHERIT_*, it means that the font
126 attribute is inherited from either the layout of this
127 paragraph or, in the case of nested paragraphs, from the
128 layout in the environment one level up until completely
130 The values LyXFont::IGNORE_* and LyXFont::TOGGLE are NOT
131 allowed in these font tables.
133 boost::shared_ptr<LyXFont> font_;
135 static ShareContainer<LyXFont> container;
138 friend struct matchFT;
141 /// used by lower_bound and upper_bound
143 int operator()(FontTable const & a, FontTable const & b) const {
144 return a.pos() < b.pos();
149 typedef std::vector<FontTable> FontList;
154 void simpleTeXBlanks(std::ostream &, TexRow & texrow,
155 lyx::pos_type const i,
156 unsigned int & column,
157 LyXFont const & font,
158 LyXLayout const & style);
160 void simpleTeXSpecialChars(Buffer const &, BufferParams const &,
161 std::ostream &, TexRow & texrow,
162 LatexRunParams const &,
163 LyXFont & font, LyXFont & running_font,
165 LyXFont const & outerfont,
167 Change::Type & running_change,
168 LyXLayout const & style,
170 unsigned int & column, value_type const c);
173 void validate(LaTeXFeatures & features,
174 LyXLayout const & layout) const;
179 static unsigned int paragraph_id;
181 ParagraphParameters params;
184 /// match a string against a particular point in the paragraph
185 bool isTextAt(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_;