2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2001 The LyX Team.
10 * ====================================================== */
23 #include "insets/inset.h" // Just for Inset::Code
26 class ParagraphParameters;
34 // After 1.2.0 is released, during 1.3.0cvs, we enable this. And after
35 // a while we verify that reading of 1.2.x files work perfectly we remove
36 // this code completely. (Lgb)
37 //#define NO_PEXTRA_REALLY 1
39 // Define this if you want to try out the new storage container for
40 // paragraphs. std::container instead of obfuscated homegrown
42 // This is non working and far from finished.
45 /// A Paragraph holds all text, attributes and insets in a text paragraph
48 #ifndef NO_PEXTRA_REALLY
61 enum MINIPAGE_ALIGNMENT {
65 MINIPAGE_ALIGN_MIDDLE,
80 typedef char value_type;
81 /// The same as ParameterStruct::depth_type
82 typedef unsigned int depth_type;
84 typedef std::vector<value_type> TextContainer;
86 /* This should be TextContainer::size_type, but we need
87 signed values for now.
89 typedef TextContainer::difference_type size_type;
93 /// this constructor inserts the new paragraph in a list
95 Paragraph(Paragraph * par);
97 Paragraph(Paragraph const &, bool same_ids);
98 /// the destructor removes the new paragraph from the list
102 Language const * getParLanguage(BufferParams const &) const;
104 bool isRightToLeftPar(BufferParams const &) const;
106 void changeLanguage(BufferParams const & bparams,
107 Language const * from, Language const * to);
109 bool isMultiLingual(BufferParams const &);
112 string const asString(Buffer const *, bool label);
114 string const asString(Buffer const *, size_type beg, size_type end,
118 void writeFile(Buffer const *, std::ostream &, BufferParams const &,
121 void validate(LaTeXFeatures &) const;
131 Paragraph * TeXOnePar(Buffer const *, BufferParams const &,
132 std::ostream &, TexRow & texrow,
135 bool simpleTeXOnePar(Buffer const *, BufferParams const &,
136 std::ostream &, TexRow & texrow, bool moving_arg);
139 Paragraph * TeXEnvironment(Buffer const *, BufferParams const &,
140 std::ostream &, TexRow & texrow);
142 bool hasSameLayout(Paragraph const * par) const;
145 void makeSameLayout(Paragraph const * par);
147 /// Is it the first par with same depth and layout?
148 bool isFirstInSequence() const;
150 /** Check if the current paragraph is the last paragraph in a
152 int getEndLabel(BufferParams const &) const;
154 Inset * inInset() const;
156 void setInsetOwner(Inset * i);
158 void deleteInsetsLyXText(BufferView *);
160 void resizeInsetsLyXText(BufferView *);
163 size_type size() const;
165 void setContentsFromPar(Paragraph * par);
167 void clearContents();
170 LyXTextClass::LayoutList::size_type layout;
173 void setCounter(int i, int v);
175 int getCounter(int i) const;
177 void incCounter(int i);
186 InsetBibKey * bibkey; // ale970302
189 void next(Paragraph *);
190 /** these function are able to hide closed footnotes
194 Paragraph const * next() const;
197 void previous(Paragraph *);
199 Paragraph * previous();
201 Paragraph const * previous() const;
203 /// for the environments
204 Paragraph * depthHook(depth_type depth);
205 /// for the environments
206 Paragraph const * depthHook(depth_type depth) const;
208 Paragraph * outerHook();
210 Paragraph const * outerHook() const;
212 int beginningOfMainBody() const;
214 string const & getLabelstring() const;
216 /// the next two functions are for the manual labels
217 string const getLabelWidthString() const;
219 void setLabelWidthString(string const & s);
221 LyXTextClass::LayoutList::size_type getLayout() const;
223 char getAlign() const;
225 depth_type getDepth() const;
227 void setLayout(LyXTextClass::LayoutList::size_type new_layout);
229 void setOnlyLayout(LyXTextClass::LayoutList::size_type new_layout);
231 int getFirstCounter(int i) const;
233 void erase(size_type pos);
234 /** the flag determines wether the layout should be copied
236 void breakParagraph(BufferParams const &, size_type pos, int flag);
238 void breakParagraphConservative(BufferParams const &, size_type pos);
239 /** Get unistantiated font setting. Returns the difference
240 between the characters font and the layoutfont.
241 This is what is stored in the fonttable
244 getFontSettings(BufferParams const &, size_type pos) const;
246 LyXFont const getFirstFontSettings() const;
248 /** Get fully instantiated font. If pos == -1, use the layout
249 font attached to this paragraph.
250 If pos == -2, use the label font of the layout attached here.
251 In all cases, the font is instantiated, i.e. does not have any
252 attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
255 LyXFont const getFont(BufferParams const &, size_type pos) const;
256 LyXFont const getLayoutFont(BufferParams const &) const;
257 LyXFont const getLabelFont(BufferParams const &) const;
259 value_type getChar(size_type pos) const;
261 value_type getUChar(BufferParams const &, size_type pos) const;
262 /// The position must already exist.
263 void setChar(size_type pos, value_type c);
265 void setFont(size_type pos, LyXFont const & font);
266 /// Returns the height of the highest font in range
267 LyXFont::FONT_SIZE highestFontInRange(size_type startpos,
269 LyXFont::FONT_SIZE const def_size) const;
271 void insertChar(size_type pos, value_type c);
273 void insertChar(size_type pos, value_type c, LyXFont const &);
275 bool checkInsertChar(LyXFont &);
277 void insertInset(size_type pos, Inset * inset);
279 void insertInset(size_type pos, Inset * inset, LyXFont const &);
281 bool insetAllowed(Inset::Code code);
283 Inset * getInset(size_type pos);
285 Inset const * getInset(size_type pos) const;
286 /** important for cut and paste
287 Temporary change from BufferParams to Buffer. Will revert when we
288 get rid of the argument to Inset::clone(Buffer const &) */
289 void copyIntoMinibuffer(Buffer const &, size_type pos) const;
291 void cutIntoMinibuffer(BufferParams const &, size_type pos);
293 bool insertFromMinibuffer(size_type pos);
296 bool isHfill(size_type pos) const;
298 bool isInset(size_type pos) const;
300 bool isNewline(size_type pos) const;
302 bool isSeparator(size_type pos) const;
304 bool isLineSeparator(size_type pos) const;
306 bool isKomma(size_type pos) const;
307 /// Used by the spellchecker
308 bool isLetter(size_type pos) const;
310 bool isWord(size_type pos) const;
312 /** This one resets all layout and dtp switches but not the font
313 of the single characters
317 /** paste this paragraph with the next one
318 be carefull, this doesent make any check at all
320 void pasteParagraph(BufferParams const &);
322 /// used to remove the error messages
323 int autoDeleteInsets();
325 /// returns -1 if inset not found
326 int getPositionOfInset(Inset * inset) const;
328 /// some good comment here John?
329 Paragraph * getParFromID(int id) const;
332 int stripLeadingSpaces(LyXTextClassList::size_type tclass);
334 #ifndef NO_PEXTRA_REALLY
335 /* If I set a PExtra Indent on one paragraph of a ENV_LIST-TYPE
336 I have to set it on each of it's elements */
338 void setPExtraType(BufferParams const &, int type,
339 string const & width, string const & widthp);
341 void unsetPExtraType(BufferParams const &);
344 bool sgmlConvertChar(char c, string & sgml_string);
346 ParagraphParameters & params();
347 ParagraphParameters const & params() const;
357 InsetTable(size_type p, Inset * i) : pos(p), inset(i) {}
361 typedef std::vector<InsetTable> InsetList;
366 class inset_iterator {
371 inset_iterator(InsetList::iterator const & iter);
373 inset_iterator & operator++() {
378 Inset * operator*() { return it->inset; }
380 size_type getPos() const {return it->pos; }
382 bool operator==(inset_iterator const & iter) const {
383 return it == iter.it;
386 bool operator!=(inset_iterator const & iter) const {
387 return it != iter.it;
391 InsetList::iterator it;
394 friend class inset_iterator;
397 inset_iterator inset_iterator_begin();
399 inset_iterator inset_iterator_end();
401 inset_iterator InsetIterator(size_type pos);
404 /// if anything uses this we don't want it to.
405 Paragraph(Paragraph const &);
409 Paragraph * previous_;
413 friend struct Paragraph::Pimpl;
419 inline bool isMetaInset(Paragraph const * par, Paragraph::size_type const pos)
421 return par->getChar(pos) == Paragraph::META_INSET;