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 class Paragraph::Pimpl {
32 Pimpl(Paragraph * owner);
33 /// "Copy constructor"
34 Pimpl(Pimpl const &, Paragraph * owner);
36 void setContentsFromPar(Paragraph const & par);
41 /// look up change at given pos
42 Change const lookupChange(lyx::pos_type pos) const;
43 /// is there a change within the given range ?
44 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
45 /// set change for the entire par
46 void setChange(Change const & change);
47 /// set change at given pos
48 void setChange(lyx::pos_type pos, Change const & change);
50 void acceptChange(lyx::pos_type start, lyx::pos_type end);
52 void rejectChange(lyx::pos_type start, lyx::pos_type end);
53 /// are we tracking changes ?
54 bool tracking() const { return changes_.get(); }
57 value_type getChar(lyx::pos_type pos) const;
59 void setChar(lyx::pos_type pos, value_type c);
61 void insertChar(lyx::pos_type pos, value_type c, Change const & change);
63 void insertInset(lyx::pos_type pos, InsetBase * inset, Change const & change);
65 void erase(lyx::pos_type pos);
66 /// erase the given position. Returns true if it was actually erased
67 bool erase(lyx::pos_type pos, bool trackChanges);
68 /// erase the given range
69 int erase(lyx::pos_type start, lyx::pos_type end, bool trackChanges);
71 InsetBase * inset_owner;
73 /** A font entry covers a range of positions. Notice that the
74 entries in the list are inserted in random order.
75 I don't think it's worth the effort to implement a more effective
76 datastructure, because the number of different fonts in a paragraph
78 Nevertheless, I decided to store fontlist using a sorted vector:
79 fontlist = { {pos_1,font_1} , {pos_2,font_2} , ... } where
80 pos_1 < pos_2 < ..., font_{i-1} != font_i for all i,
81 and font_i covers the chars in positions pos_{i-1}+1,...,pos_i
82 (font_1 covers the chars 0,...,pos_1) (Dekel)
87 FontTable(lyx::pos_type p, LyXFont const & f)
91 lyx::pos_type pos() const { return pos_; }
93 void pos(lyx::pos_type p) { pos_ = p; }
95 LyXFont const & font() const { return font_; }
97 void font(LyXFont const & f) { font_ = f;}
99 /// End position of paragraph this font attribute covers
101 /** Font. Interpretation of the font values:
102 If a value is LyXFont::INHERIT_*, it means that the font
103 attribute is inherited from either the layout of this
104 paragraph or, in the case of nested paragraphs, from the
105 layout in the environment one level up until completely
107 The values LyXFont::IGNORE_* and LyXFont::TOGGLE are NOT
108 allowed in these font tables.
113 friend class matchFT;
117 /// used by lower_bound and upper_bound
118 int operator()(FontTable const & a, FontTable const & b) const {
119 return a.pos() < b.pos();
124 typedef std::vector<FontTable> FontList;
129 void simpleTeXBlanks(lyx::odocstream &, TexRow & texrow,
130 lyx::pos_type const i,
131 unsigned int & column,
132 LyXFont const & font,
133 LyXLayout const & style);
135 void simpleTeXSpecialChars(Buffer const &, BufferParams const &,
136 lyx::odocstream &, TexRow & texrow,
137 OutputParams const &,
138 LyXFont & font, LyXFont & running_font,
140 LyXFont const & outerfont,
142 Change::Type & running_change,
143 LyXLayout const & style,
145 unsigned int & column, value_type const c);
148 void validate(LaTeXFeatures & features,
149 LyXLayout const & layout) const;
154 static unsigned int paragraph_id;
156 ParagraphParameters params;
160 lyx::pos_type size() const { return owner_->size(); }
161 /// match a string against a particular point in the paragraph
162 bool isTextAt(std::string const & str, lyx::pos_type pos) const;
164 /// for recording and looking up changes in revision tracking mode
165 boost::scoped_ptr<Changes> changes_;