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);
42 void trackChanges(Change::Type type = Change::UNCHANGED);
44 void untrackChanges();
45 /// set all text as new for change mode
46 void cleanChanges(Paragraph::ChangeTracking ct = Paragraph::trackingUnknown);
47 /// look up change at given pos
48 Change const lookupChange(lyx::pos_type pos) const;
49 /// is there a change within the given range ?
50 bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
51 /// is there a non-addition in this range ?
52 bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
53 /// set change type at given pos
54 void setChangeType(lyx::pos_type pos, Change::Type type);
55 /// set change at given pos
56 void setChange(lyx::pos_type pos, Change change);
58 void markErased(bool);
60 void acceptChange(lyx::pos_type start, lyx::pos_type end);
62 void rejectChange(lyx::pos_type start, lyx::pos_type end);
63 /// are we tracking changes ?
64 bool tracking() const { return changes_.get(); }
67 value_type getChar(lyx::pos_type pos) const;
69 void setChar(lyx::pos_type pos, value_type c);
71 void insertChar(lyx::pos_type pos, value_type c, Change change);
73 void insertInset(lyx::pos_type pos, InsetBase * inset, Change change);
75 void eraseIntern(lyx::pos_type pos);
76 /// erase the given position. Returns true if it was actually erased
77 bool erase(lyx::pos_type pos);
78 /// erase the given range
79 int erase(lyx::pos_type start, lyx::pos_type end);
81 InsetBase * inset_owner;
83 /** A font entry covers a range of positions. Notice that the
84 entries in the list are inserted in random order.
85 I don't think it's worth the effort to implement a more effective
86 datastructure, because the number of different fonts in a paragraph
88 Nevertheless, I decided to store fontlist using a sorted vector:
89 fontlist = { {pos_1,font_1} , {pos_2,font_2} , ... } where
90 pos_1 < pos_2 < ..., font_{i-1} != font_i for all i,
91 and font_i covers the chars in positions pos_{i-1}+1,...,pos_i
92 (font_1 covers the chars 0,...,pos_1) (Dekel)
97 FontTable(lyx::pos_type p, LyXFont const & f)
101 lyx::pos_type pos() const { return pos_; }
103 void pos(lyx::pos_type p) { pos_ = p; }
105 LyXFont const & font() const { return font_; }
107 void font(LyXFont const & f) { font_ = f;}
109 /// End position of paragraph this font attribute covers
111 /** Font. Interpretation of the font values:
112 If a value is LyXFont::INHERIT_*, it means that the font
113 attribute is inherited from either the layout of this
114 paragraph or, in the case of nested paragraphs, from the
115 layout in the environment one level up until completely
117 The values LyXFont::IGNORE_* and LyXFont::TOGGLE are NOT
118 allowed in these font tables.
123 friend class matchFT;
127 /// used by lower_bound and upper_bound
128 int operator()(FontTable const & a, FontTable const & b) const {
129 return a.pos() < b.pos();
134 typedef std::vector<FontTable> FontList;
139 void simpleTeXBlanks(std::ostream &, TexRow & texrow,
140 lyx::pos_type const i,
141 unsigned int & column,
142 LyXFont const & font,
143 LyXLayout const & style);
145 void simpleTeXSpecialChars(Buffer const &, BufferParams const &,
146 std::ostream &, TexRow & texrow,
147 OutputParams const &,
148 LyXFont & font, LyXFont & running_font,
150 LyXFont const & outerfont,
152 Change::Type & running_change,
153 LyXLayout const & style,
155 unsigned int & column, value_type const c);
158 void validate(LaTeXFeatures & features,
159 LyXLayout const & layout) const;
164 static unsigned int paragraph_id;
166 ParagraphParameters params;
170 lyx::pos_type size() const { return owner_->size(); }
171 /// match a string against a particular point in the paragraph
172 bool isTextAt(std::string const & str, lyx::pos_type pos) const;
174 /// for recording and looking up changes in revision tracking mode
175 boost::scoped_ptr<Changes> changes_;