3 * \file paragraph_pimpl.h
4 * Copyright 1995-2003 the LyX Team
5 * Read the file COPYING
8 #ifndef PARAGRAPH_PIMPL_H
9 #define PARAGRAPH_PIMPL_H
11 #include "paragraph.h"
12 #include "ParagraphParameters.h"
16 #include <boost/scoped_ptr.hpp>
20 struct Paragraph::Pimpl {
22 typedef std::vector<value_type> TextContainer;
25 Pimpl(Paragraph * owner);
27 Pimpl(Pimpl const &, Paragraph * owner);
29 lyx::pos_type size() const {
39 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;
56 void setChange(lyx::pos_type pos, Change::Type type);
62 void acceptChange(lyx::pos_type start, lyx::pos_type end);
65 void rejectChange(lyx::pos_type start, lyx::pos_type end);
67 /// are we tracking changes ?
68 bool tracking() const {
69 return changes_.get();
73 value_type getChar(lyx::pos_type pos) const;
75 void setChar(lyx::pos_type pos, value_type c);
77 void insertChar(lyx::pos_type pos, value_type c, LyXFont const & font, Change change = Change(Change::INSERTED));
79 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const & font, Change change = Change(Change::INSERTED));
81 void eraseIntern(lyx::pos_type pos);
82 /// erase the given position. Returns true if it was actually erased
83 bool erase(lyx::pos_type pos);
84 /// erase the given range
85 int erase(lyx::pos_type start, lyx::pos_type end);
87 UpdatableInset * inset_owner;
89 /** A font entry covers a range of positions. Notice that the
90 entries in the list are inserted in random order.
91 I don't think it's worth the effort to implement a more effective
92 datastructure, because the number of different fonts in a paragraph
94 Nevertheless, I decided to store fontlist using a sorted vector:
95 fontlist = { {pos_1,font_1} , {pos_2,font_2} , ... } where
96 pos_1 < pos_2 < ..., font_{i-1} != font_i for all i,
97 and font_i covers the chars in positions pos_{i-1}+1,...,pos_i
98 (font_1 covers the chars 0,...,pos_1) (Dekel)
102 FontTable(lyx::pos_type p, LyXFont const & f)
105 font_ = container.get(f);
108 lyx::pos_type pos() const { return pos_; }
110 void pos(lyx::pos_type p) { pos_ = p; }
112 LyXFont const & font() const { return *font_; }
114 void font(LyXFont const & f) { font_ = container.get(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.
127 boost::shared_ptr<LyXFont> font_;
129 static ShareContainer<LyXFont> container;
132 friend struct matchFT;
135 /// used by lower_bound and upper_bound
137 int operator()(FontTable const & a, FontTable const & b) const {
138 return a.pos() < b.pos();
143 typedef std::vector<FontTable> FontList;
148 void simpleTeXBlanks(std::ostream &, TexRow & texrow,
149 lyx::pos_type const i,
150 unsigned int & column,
151 LyXFont const & font,
152 LyXLayout const & style);
154 void simpleTeXSpecialChars(Buffer const *, BufferParams const &,
155 std::ostream &, TexRow & texrow,
156 LatexRunParams const &,
157 LyXFont & font, LyXFont & running_font,
159 LyXFont const & outerfont,
161 Change::Type & running_change,
162 LyXLayout const & style,
164 unsigned int & column, value_type const c);
167 void validate(LaTeXFeatures & features,
168 LyXLayout const & layout) const;
173 static unsigned int paragraph_id;
175 ParagraphParameters params;
178 /// match a string against a particular point in the paragraph
179 bool isTextAt(string const & str, lyx::pos_type pos) const;
181 /// for recording and looking up changes in revision tracking mode
182 boost::scoped_ptr<Changes> changes_;