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 * ====================================================== */
21 #include "insets/inset.h" // Just for Inset::Code
22 #include "lyxfont.h" // Just for LyXFont::FONT_SIZE
23 #include "support/types.h"
25 class ParagraphParameters;
33 // After 1.2.0 is released, during 1.3.0cvs, we enable this. And after
34 // a while we verify that reading of 1.2.x files work perfectly we remove
35 // this code completely. (Lgb)
36 //#define NO_PEXTRA_REALLY 1
38 // Define this if you want to try out the new storage container for
39 // paragraphs. std::container instead of obfuscated homegrown
41 // This is non working and far from finished.
44 /// A Paragraph holds all text, attributes and insets in a text paragraph
47 #ifndef NO_PEXTRA_REALLY
60 enum MINIPAGE_ALIGNMENT {
64 MINIPAGE_ALIGN_MIDDLE,
79 typedef char value_type;
80 /// The same as ParameterStruct::depth_type
81 typedef unsigned int depth_type;
85 /// this constructor inserts the new paragraph in a list
87 Paragraph(Paragraph * par);
89 Paragraph(Paragraph const &, bool same_ids);
90 /// the destructor removes the new paragraph from the list
94 Language const * getParLanguage(BufferParams const &) const;
96 bool isRightToLeftPar(BufferParams const &) const;
98 void changeLanguage(BufferParams const & bparams,
99 Language const * from, Language const * to);
101 bool isMultiLingual(BufferParams const &);
104 string const asString(Buffer const *, bool label);
106 string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
110 void writeFile(Buffer const *, std::ostream &, BufferParams const &,
113 void validate(LaTeXFeatures &) const;
123 Paragraph * TeXOnePar(Buffer const *, BufferParams const &,
124 std::ostream &, TexRow & texrow,
128 int startTeXParParams(BufferParams const &, std::ostream &) const;
131 int endTeXParParams(BufferParams const &, std::ostream &) const;
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 lyx::pos_type size() const;
165 void setContentsFromPar(Paragraph * par);
167 void clearContents();
170 string const & layout() const;
172 void layout(string const & new_layout);
175 void setCounter(int i, int v);
177 int getCounter(int i) const;
179 void incCounter(int i);
188 InsetBibKey * bibkey; // ale970302
191 void next(Paragraph *);
192 /** these function are able to hide closed footnotes
196 Paragraph const * next() const;
199 void previous(Paragraph *);
201 Paragraph * previous();
203 Paragraph const * previous() const;
205 /// for the environments
206 Paragraph * depthHook(depth_type depth);
207 /// for the environments
208 Paragraph const * depthHook(depth_type depth) const;
210 Paragraph * outerHook();
212 Paragraph const * outerHook() const;
214 int beginningOfMainBody() const;
216 string const & getLabelstring() const;
218 /// the next two functions are for the manual labels
219 string const getLabelWidthString() const;
221 void setLabelWidthString(string const & s);
223 char getAlign() const;
224 /// The nesting depth of a paragraph
225 depth_type getDepth() const;
226 /// The maximal possible depth of a paragraph after this one
227 depth_type getMaxDepthAfter(Buffer const *) const;
229 void applyLayout(string const & new_layout);
231 int getFirstCounter(int i) const;
233 void erase(lyx::pos_type pos);
234 /** the flag determines wether the layout should be copied
236 void breakParagraph(BufferParams const &, lyx::pos_type pos, int flag);
238 void breakParagraphConservative(BufferParams const &, lyx::pos_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 &, lyx::pos_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 &, lyx::pos_type pos) const;
256 LyXFont const getLayoutFont(BufferParams const &) const;
257 LyXFont const getLabelFont(BufferParams const &) const;
259 value_type getChar(lyx::pos_type pos) const;
261 value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
262 /// The position must already exist.
263 void setChar(lyx::pos_type pos, value_type c);
265 void setFont(lyx::pos_type pos, LyXFont const & font);
266 /// Returns the height of the highest font in range
267 LyXFont::FONT_SIZE highestFontInRange(lyx::pos_type startpos,
268 lyx::pos_type endpos,
269 LyXFont::FONT_SIZE const def_size) const;
271 void insertChar(lyx::pos_type pos, value_type c);
273 void insertChar(lyx::pos_type pos, value_type c, LyXFont const &);
275 bool checkInsertChar(LyXFont &);
277 void insertInset(lyx::pos_type pos, Inset * inset);
279 void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &);
281 bool insetAllowed(Inset::Code code);
283 Inset * getInset(lyx::pos_type pos);
285 Inset const * getInset(lyx::pos_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 &, lyx::pos_type pos) const;
291 void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
293 bool insertFromMinibuffer(lyx::pos_type pos);
296 bool isHfill(lyx::pos_type pos) const;
298 bool isInset(lyx::pos_type pos) const;
300 bool isNewline(lyx::pos_type pos) const;
302 bool isSeparator(lyx::pos_type pos) const;
304 bool isLineSeparator(lyx::pos_type pos) const;
306 bool isKomma(lyx::pos_type pos) const;
307 /// Used by the spellchecker
308 bool isLetter(lyx::pos_type pos) const;
310 bool isWord(lyx::pos_type pos) const;
312 /** paste this paragraph with the next one
313 be carefull, this doesent make any check at all
315 void pasteParagraph(BufferParams const &);
317 /// returns -1 if inset not found
318 int getPositionOfInset(Inset const * inset) const;
320 /// some good comment here John?
321 Paragraph * getParFromID(int id) const;
324 int stripLeadingSpaces(lyx::textclass_type tclass);
326 #ifndef NO_PEXTRA_REALLY
327 /* If I set a PExtra Indent on one paragraph of a ENV_LIST-TYPE
328 I have to set it on each of it's elements */
330 void setPExtraType(BufferParams const &, int type,
331 string const & width, string const & widthp);
333 void unsetPExtraType(BufferParams const &);
336 bool sgmlConvertChar(char c, string & sgml_string);
338 bool isFreeSpacing() const;
340 ParagraphParameters & params();
341 ParagraphParameters const & params() const;
352 InsetTable(lyx::pos_type p, Inset * i) : pos(p), inset(i) {}
356 typedef std::vector<InsetTable> InsetList;
361 class inset_iterator {
366 inset_iterator(InsetList::iterator const & iter);
368 inset_iterator & operator++() {
373 Inset * operator*() { return it->inset; }
375 Inset * operator->() { return it->inset; }
378 lyx::pos_type getPos() const { return it->pos; }
380 bool operator==(inset_iterator const & iter) const {
381 return it == iter.it;
384 bool operator!=(inset_iterator const & iter) const {
385 return it != iter.it;
389 InsetList::iterator it;
392 friend class inset_iterator;
395 inset_iterator inset_iterator_begin();
397 inset_iterator inset_iterator_end();
399 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;