// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
- *
- * ====================================================== */
+/**
+ * \file paragraph.h
+ * Copyright 1995 Matthias Ettrich
+ * Copyright 2002 the LyX Team
+ * Read the file COPYING
+ */
#ifndef PARAGRAPH_H
#define PARAGRAPH_H
#include "LString.h"
-#include <vector>
-
+#include "lyxlayout_ptr_fwd.h"
#include "insets/inset.h" // Just for Inset::Code
-#include "layout.h"
+#include "lyxfont.h" // Just for LyXFont::FONT_SIZE
+#include "support/types.h"
class ParagraphParameters;
class BufferParams;
class TexRow;
-struct LaTeXFeatures;
+class LaTeXFeatures;
class InsetBibKey;
class BufferView;
class Language;
// After 1.2.0 is released, during 1.3.0cvs, we enable this. And after
// a while we verify that reading of 1.2.x files work perfectly we remove
// this code completely. (Lgb)
-//#define NO_PEXTRA_REALLY 1
+#define NO_PEXTRA_REALLY 1
// Define this if you want to try out the new storage container for
// paragraphs. std::container instead of obfuscated homegrown
};
///
typedef char value_type;
- /// The same as ParameterStruct::depth_type
+ /// The same as ParameterStruct::depth_type
typedef unsigned int depth_type;
- ///
- typedef std::vector<value_type> TextContainer;
- ///
- /* This should be TextContainer::size_type, but we need
- signed values for now.
- */
- typedef TextContainer::difference_type size_type;
///
Paragraph();
Language const * from, Language const * to);
///
bool isMultiLingual(BufferParams const &);
- ///
+ ///
string const asString(Buffer const *, bool label);
///
- string const asString(Buffer const *, size_type beg, size_type end,
+ string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
bool label);
-
+
///
void writeFile(Buffer const *, std::ostream &, BufferParams const &,
depth_type) const;
///
void validate(LaTeXFeatures &) const;
-
+
///
int id() const;
///
Paragraph * TeXOnePar(Buffer const *, BufferParams const &,
std::ostream &, TexRow & texrow,
bool moving_arg);
+
+ ///
+ int startTeXParParams(BufferParams const &, std::ostream &) const;
+
+ ///
+ int endTeXParParams(BufferParams const &, std::ostream &) const;
+
+
///
bool simpleTeXOnePar(Buffer const *, BufferParams const &,
std::ostream &, TexRow & texrow, bool moving_arg);
/** Check if the current paragraph is the last paragraph in a
proof environment */
- int getEndLabel(BufferParams const &) const;
+ int getEndLabel() const;
///
Inset * inInset() const;
///
void resizeInsetsLyXText(BufferView *);
///
- size_type size() const;
+ lyx::pos_type size() const;
///
void setContentsFromPar(Paragraph * par);
///
void clearContents();
///
- LyXTextClass::LayoutList::size_type layout;
+ LyXLayout_ptr const & layout() const;
+ ///
+ void layout(LyXLayout_ptr const & new_layout);
///
void setCounter(int i, int v);
///
char enumdepth;
-
+
///
char itemdepth;
- ///
- InsetBibKey * bibkey; // ale970302
+ ///
+ InsetBibKey * bibkey; // ale970302
///
void next(Paragraph *);
Paragraph * depthHook(depth_type depth);
/// for the environments
Paragraph const * depthHook(depth_type depth) const;
- ///
+ ///
Paragraph * outerHook();
- ///
+ ///
Paragraph const * outerHook() const;
///
int beginningOfMainBody() const;
///
string const & getLabelstring() const;
-
+
/// the next two functions are for the manual labels
string const getLabelWidthString() const;
///
void setLabelWidthString(string const & s);
///
- LyXTextClass::LayoutList::size_type getLayout() const;
- ///
char getAlign() const;
- ///
+ /// The nesting depth of a paragraph
depth_type getDepth() const;
+ /// The maximal possible depth of a paragraph after this one
+ depth_type getMaxDepthAfter() const;
///
- void setLayout(LyXTextClass::LayoutList::size_type new_layout);
- ///
- void setOnlyLayout(LyXTextClass::LayoutList::size_type new_layout);
+ void applyLayout(LyXLayout_ptr const & new_layout);
///
int getFirstCounter(int i) const;
///
- void erase(size_type pos);
+ void erase(lyx::pos_type pos);
/** the flag determines wether the layout should be copied
- */
- void breakParagraph(BufferParams const &, size_type pos, int flag);
+ */
+ void breakParagraph(BufferParams const &, lyx::pos_type pos, int flag);
///
- void breakParagraphConservative(BufferParams const &, size_type pos);
+ void breakParagraphConservative(BufferParams const &, lyx::pos_type pos);
/** Get unistantiated font setting. Returns the difference
between the characters font and the layoutfont.
This is what is stored in the fonttable
*/
LyXFont const
- getFontSettings(BufferParams const &, size_type pos) const;
+ getFontSettings(BufferParams const &, lyx::pos_type pos) const;
///
LyXFont const getFirstFontSettings() const;
font attached to this paragraph.
If pos == -2, use the label font of the layout attached here.
In all cases, the font is instantiated, i.e. does not have any
- attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
+ attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
LyXFont::TOGGLE.
*/
- LyXFont const getFont(BufferParams const &, size_type pos) const;
+ LyXFont const getFont(BufferParams const &, lyx::pos_type pos) const;
LyXFont const getLayoutFont(BufferParams const &) const;
LyXFont const getLabelFont(BufferParams const &) const;
///
- value_type getChar(size_type pos) const;
+ value_type getChar(lyx::pos_type pos) const;
///
- value_type getUChar(BufferParams const &, size_type pos) const;
+ value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
/// The position must already exist.
- void setChar(size_type pos, value_type c);
- ///
- void setFont(size_type pos, LyXFont const & font);
+ void setChar(lyx::pos_type pos, value_type c);
+ /// pos <= size() (there is a dummy font change at the end of each par)
+ void setFont(lyx::pos_type pos, LyXFont const & font);
/// Returns the height of the highest font in range
- LyXFont::FONT_SIZE highestFontInRange(size_type startpos,
- size_type endpos,
- LyXFont::FONT_SIZE const def_size) const;
+ LyXFont::FONT_SIZE highestFontInRange(lyx::pos_type startpos,
+ lyx::pos_type endpos,
+ LyXFont::FONT_SIZE const def_size) const;
///
- void insertChar(size_type pos, value_type c);
+ void insertChar(lyx::pos_type pos, value_type c);
///
- void insertChar(size_type pos, value_type c, LyXFont const &);
+ void insertChar(lyx::pos_type pos, value_type c, LyXFont const &);
///
bool checkInsertChar(LyXFont &);
///
- void insertInset(size_type pos, Inset * inset);
+ void insertInset(lyx::pos_type pos, Inset * inset);
///
- void insertInset(size_type pos, Inset * inset, LyXFont const &);
+ void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &);
///
bool insetAllowed(Inset::Code code);
///
- Inset * getInset(size_type pos);
+ Inset * getInset(lyx::pos_type pos);
///
- Inset const * getInset(size_type pos) const;
+ Inset const * getInset(lyx::pos_type pos) const;
/** important for cut and paste
Temporary change from BufferParams to Buffer. Will revert when we
get rid of the argument to Inset::clone(Buffer const &) */
- void copyIntoMinibuffer(Buffer const &, size_type pos) const;
+ void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
///
- void cutIntoMinibuffer(BufferParams const &, size_type pos);
+ void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
///
- bool insertFromMinibuffer(size_type pos);
+ bool insertFromMinibuffer(lyx::pos_type pos);
///
- bool isHfill(size_type pos) const;
+ bool isHfill(lyx::pos_type pos) const;
///
- bool isInset(size_type pos) const;
+ bool isInset(lyx::pos_type pos) const;
///
- bool isNewline(size_type pos) const;
+ bool isNewline(lyx::pos_type pos) const;
///
- bool isSeparator(size_type pos) const;
+ bool isSeparator(lyx::pos_type pos) const;
///
- bool isLineSeparator(size_type pos) const;
+ bool isLineSeparator(lyx::pos_type pos) const;
///
- bool isKomma(size_type pos) const;
+ bool isKomma(lyx::pos_type pos) const;
/// Used by the spellchecker
- bool isLetter(size_type pos) const;
- ///
- bool isWord(size_type pos) const;
-
- /** This one resets all layout and dtp switches but not the font
- of the single characters
- */
- void clear();
+ bool isLetter(lyx::pos_type pos) const;
+ ///
+ bool isWord(lyx::pos_type pos) const;
/** paste this paragraph with the next one
be carefull, this doesent make any check at all
- */
+ */
void pasteParagraph(BufferParams const &);
- /// used to remove the error messages
- int autoDeleteInsets();
-
/// returns -1 if inset not found
- int getPositionOfInset(Inset * inset) const;
+ int getPositionOfInset(Inset const * inset) const;
/// some good comment here John?
Paragraph * getParFromID(int id) const;
///
- int stripLeadingSpaces(LyXTextClassList::size_type tclass);
+ int stripLeadingSpaces();
#ifndef NO_PEXTRA_REALLY
- /* If I set a PExtra Indent on one paragraph of a ENV_LIST-TYPE
- I have to set it on each of it's elements */
+ /* If I set a PExtra Indent on one paragraph of a ENV_LIST-TYPE
+ I have to set it on each of it's elements */
///
- void setPExtraType(BufferParams const &, int type,
+ void setPExtraType(BufferParams const &, int type,
string const & width, string const & widthp);
///
- void unsetPExtraType(BufferParams const &);
+ void unsetPExtraType(BufferParams const &);
#endif
///
- bool linuxDocConvertChar(char c, string & sgml_string);
+ bool sgmlConvertChar(char c, string & sgml_string);
+ ///
+ bool isFreeSpacing() const;
ParagraphParameters & params();
ParagraphParameters const & params() const;
private:
-
+ ///
+ LyXLayout_ptr layout_;
+public:
+ /** Both these definitions must be made public to keep Compaq cxx 6.5
+ * happy.
+ */
///
struct InsetTable {
///
- size_type pos;
+ lyx::pos_type pos;
///
Inset * inset;
///
- InsetTable(size_type p, Inset * i) : pos(p), inset(i) {}
+ InsetTable(lyx::pos_type p, Inset * i) : pos(p), inset(i) {}
};
///
typedef std::vector<InsetTable> InsetList;
+private:
///
InsetList insetlist;
public:
///
Inset * operator*() { return it->inset; }
///
- size_type getPos() const {return it->pos; }
+ Inset * operator->() { return it->inset; }
+
+ ///
+ lyx::pos_type getPos() const { return it->pos; }
///
bool operator==(inset_iterator const & iter) const {
return it == iter.it;
};
///
friend class inset_iterator;
-
+
///
inset_iterator inset_iterator_begin();
///
inset_iterator inset_iterator_end();
- ///
- inset_iterator InsetIterator(size_type pos);
+ /// returns inset iterator of the first inset at or after pos.
+ inset_iterator InsetIterator(lyx::pos_type pos);
private:
/// if anything uses this we don't want it to.