4 * Copyright 1995 Matthias Ettrich
5 * Copyright 2002 the LyX Team
6 * Read the file COPYING
18 #include "lyxlayout_ptr_fwd.h"
19 #include "insets/inset.h" // Just for Inset::Code
20 #include "lyxfont.h" // Just for LyXFont::FONT_SIZE
21 #include "support/types.h"
24 class ParagraphParameters;
32 // After 1.2.0 is released, during 1.3.0cvs, we enable this. And after
33 // a while we verify that reading of 1.2.x files work perfectly we remove
34 // this code completely. (Lgb)
35 #define NO_PEXTRA_REALLY 1
37 // Define this if you want to try out the new storage container for
38 // paragraphs. std::container instead of obfuscated homegrown
40 // This is non working and far from finished.
43 /// A Paragraph holds all text, attributes and insets in a text paragraph
46 #ifndef NO_PEXTRA_REALLY
59 enum MINIPAGE_ALIGNMENT {
63 MINIPAGE_ALIGN_MIDDLE,
78 typedef char value_type;
79 /// The same as ParameterStruct::depth_type
80 typedef unsigned int depth_type;
84 /// this constructor inserts the new paragraph in a list
86 Paragraph(Paragraph * par);
88 Paragraph(Paragraph const &, bool same_ids);
89 /// the destructor removes the new paragraph from the list
93 Language const * getParLanguage(BufferParams const &) const;
95 bool isRightToLeftPar(BufferParams const &) const;
97 void changeLanguage(BufferParams const & bparams,
98 Language const * from, Language const * to);
100 bool isMultiLingual(BufferParams const &);
103 string const asString(Buffer const *, bool label);
105 string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
109 void writeFile(Buffer const *, std::ostream &, BufferParams const &,
112 void validate(LaTeXFeatures &) const;
122 Paragraph * TeXOnePar(Buffer const *, BufferParams const &,
123 std::ostream &, TexRow & texrow,
127 int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
130 int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
134 bool simpleTeXOnePar(Buffer const *, BufferParams const &,
135 std::ostream &, TexRow & texrow, bool moving_arg);
138 Paragraph * TeXEnvironment(Buffer const *, BufferParams const &,
139 std::ostream &, TexRow & texrow);
141 bool hasSameLayout(Paragraph const * par) const;
144 void makeSameLayout(Paragraph const * par);
146 /// Is it the first par with same depth and layout?
147 bool isFirstInSequence() const;
149 /** Check if the current paragraph is the last paragraph in a
151 int getEndLabel() const;
153 Inset * inInset() const;
155 void setInsetOwner(Inset * i);
157 void deleteInsetsLyXText(BufferView *);
159 void resizeInsetsLyXText(BufferView *);
162 lyx::pos_type size() const;
164 void setContentsFromPar(Paragraph * par);
166 void clearContents();
169 LyXLayout_ptr const & layout() const;
171 void layout(LyXLayout_ptr const & new_layout);
180 InsetBibKey * bibkey; // ale970302
183 void next(Paragraph *);
184 /** these function are able to hide closed footnotes
188 Paragraph const * next() const;
191 void previous(Paragraph *);
193 Paragraph * previous();
195 Paragraph const * previous() const;
197 /// for the environments
198 Paragraph * depthHook(depth_type depth);
199 /// for the environments
200 Paragraph const * depthHook(depth_type depth) const;
202 Paragraph * outerHook();
204 Paragraph const * outerHook() const;
206 int beginningOfMainBody() const;
208 string const & getLabelstring() const;
210 /// the next two functions are for the manual labels
211 string const getLabelWidthString() const;
213 void setLabelWidthString(string const & s);
215 char getAlign() const;
216 /// The nesting depth of a paragraph
217 depth_type getDepth() const;
218 /// The maximal possible depth of a paragraph after this one
219 depth_type getMaxDepthAfter() const;
221 void applyLayout(LyXLayout_ptr const & new_layout);
223 int getFirstCounter(int i) const;
225 void erase(lyx::pos_type pos);
226 /** the flag determines wether the layout should be copied
228 void breakParagraph(BufferParams const &, lyx::pos_type pos, int flag);
230 void breakParagraphConservative(BufferParams const &, lyx::pos_type pos);
231 /** Get unistantiated font setting. Returns the difference
232 between the characters font and the layoutfont.
233 This is what is stored in the fonttable
236 getFontSettings(BufferParams const &, lyx::pos_type pos) const;
238 LyXFont const getFirstFontSettings() const;
240 /** Get fully instantiated font. If pos == -1, use the layout
241 font attached to this paragraph.
242 If pos == -2, use the label font of the layout attached here.
243 In all cases, the font is instantiated, i.e. does not have any
244 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
247 LyXFont const getFont(BufferParams const &, lyx::pos_type pos) const;
248 LyXFont const getLayoutFont(BufferParams const &) const;
249 LyXFont const getLabelFont(BufferParams const &) const;
251 value_type getChar(lyx::pos_type pos) const;
253 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
254 /// The position must already exist.
255 void setChar(lyx::pos_type pos, value_type c);
256 /// pos <= size() (there is a dummy font change at the end of each par)
257 void setFont(lyx::pos_type pos, LyXFont const & font);
258 /// Returns the height of the highest font in range
259 LyXFont::FONT_SIZE highestFontInRange(lyx::pos_type startpos,
260 lyx::pos_type endpos,
261 LyXFont::FONT_SIZE const def_size) const;
263 void insertChar(lyx::pos_type pos, value_type c);
265 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &);
267 bool checkInsertChar(LyXFont &);
269 void insertInset(lyx::pos_type pos, Inset * inset);
271 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &);
273 bool insetAllowed(Inset::Code code);
275 Inset * getInset(lyx::pos_type pos);
277 Inset const * getInset(lyx::pos_type pos) const;
278 /** important for cut and paste
279 Temporary change from BufferParams to Buffer. Will revert when we
280 get rid of the argument to Inset::clone(Buffer const &) */
281 void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
283 void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
285 bool insertFromMinibuffer(lyx::pos_type pos);
288 bool isHfill(lyx::pos_type pos) const;
290 bool isInset(lyx::pos_type pos) const;
292 bool isNewline(lyx::pos_type pos) const;
294 bool isSeparator(lyx::pos_type pos) const;
296 bool isLineSeparator(lyx::pos_type pos) const;
298 bool isKomma(lyx::pos_type pos) const;
299 /// Used by the spellchecker
300 bool isLetter(lyx::pos_type pos) const;
302 bool isWord(lyx::pos_type pos) const;
304 /** paste this paragraph with the next one
305 be carefull, this doesent make any check at all
307 void pasteParagraph(BufferParams const &);
309 /// returns -1 if inset not found
310 int getPositionOfInset(Inset const * inset) const;
312 /// some good comment here John?
313 Paragraph * getParFromID(int id) const;
316 int stripLeadingSpaces();
318 #ifndef NO_PEXTRA_REALLY
319 /* If I set a PExtra Indent on one paragraph of a ENV_LIST-TYPE
320 I have to set it on each of it's elements */
322 void setPExtraType(BufferParams const &, int type,
323 string const & width, string const & widthp);
325 void unsetPExtraType(BufferParams const &);
328 bool sgmlConvertChar(char c, string & sgml_string);
330 bool isFreeSpacing() const;
332 ParagraphParameters & params();
333 ParagraphParameters const & params() const;
336 LyXLayout_ptr layout_;
338 /** Both these definitions must be made public to keep Compaq cxx 6.5
348 InsetTable(lyx::pos_type p, Inset * i) : pos(p), inset(i) {}
352 typedef std::vector<InsetTable> InsetList;
358 class inset_iterator {
363 inset_iterator(InsetList::iterator const & iter);
365 inset_iterator & operator++() {
370 Inset * operator*() { return it->inset; }
372 Inset * operator->() { return it->inset; }
375 lyx::pos_type getPos() const { return it->pos; }
377 bool operator==(inset_iterator const & iter) const {
378 return it == iter.it;
381 bool operator!=(inset_iterator const & iter) const {
382 return it != iter.it;
386 InsetList::iterator it;
389 friend class inset_iterator;
392 inset_iterator inset_iterator_begin();
394 inset_iterator inset_iterator_end();
395 /// returns inset iterator of the first inset at or after pos.
396 inset_iterator InsetIterator(lyx::pos_type pos);
402 /// if anything uses this we don't want it to.
403 Paragraph(Paragraph const &);
407 Paragraph * previous_;
411 friend struct Paragraph::Pimpl;