#ifndef PARAGRAPH_H
#define PARAGRAPH_H
-#include "lyxlayout_ptr_fwd.h"
-#include "lyxfont.h" // Just for LyXFont::FONT_SIZE
+#include "changes.h"
+#include "dimension.h"
#include "InsetList.h"
+#include "lyxlayout_ptr_fwd.h"
+#include "RowList_fwd.h"
-#include "insets/inset.h" // Just for InsetOld::Code
+#include "insets/insetbase.h" // only for InsetBase::Code
#include "support/types.h"
-#include "changes.h"
-#include "RowList.h"
-#include "support/std_string.h"
+#include <boost/assert.hpp>
+
+#include <string>
class Buffer;
class BufferParams;
class BufferView;
class Counters;
+class InsetBase;
class InsetBibitem;
-class Language;
class LaTeXFeatures;
-class LatexRunParams;
+class InsetBase_code;
+class Language;
+class LyXFont;
+class LyXFont_size;
+class MetricsInfo;
+class OutputParams;
+class PainterInfo;
class ParagraphParameters;
class TexRow;
-class ParagraphList;
class UpdatableInset;
/// A Paragraph holds all text, attributes and insets in a text paragraph
class Paragraph {
public:
///
- enum META_KIND {
+ enum {
/// Note that this is 1 right now to avoid
/// crashes where getChar() is called wrongly
/// (returning 0) - if this was 0, then we'd
};
///
typedef char value_type;
- /// The same as ParameterStruct::depth_type
- typedef unsigned int depth_type;
+ ///
+ typedef lyx::depth_type depth_type;
+ ///
+ typedef std::vector<value_type> TextContainer;
///
Paragraph();
-
///
Paragraph(Paragraph const &);
///
- void operator=(Paragraph const &);
- /// the destructor removes the new paragraph from the list
+ Paragraph & operator=(Paragraph const &);
+ ///
~Paragraph();
+ ///
+ int id() const;
+
+
///
Language const * getParLanguage(BufferParams const &) const;
///
void changeLanguage(BufferParams const & bparams,
Language const * from, Language const * to);
///
- bool isMultiLingual(BufferParams const &);
+ bool isMultiLingual(BufferParams const &) const;
///
- string const asString(Buffer const &, bool label) const;
+ std::string const asString(Buffer const &,
+ OutputParams const & runparams,
+ bool label) const;
///
- string const asString(Buffer const &, lyx::pos_type beg, lyx::pos_type end,
- bool label) const;
+ std::string const asString(Buffer const &, bool label) const;
+ ///
+ std::string const Paragraph::asString(Buffer const & buffer,
+ lyx::pos_type beg,
+ lyx::pos_type end,
+ bool label) const;
+ ///
+ std::string const asString(Buffer const &,
+ OutputParams const & runparams,
+ lyx::pos_type beg,
+ lyx::pos_type end,
+ bool label) const;
///
void write(Buffer const &, std::ostream &, BufferParams const &,
- depth_type & depth) const;
+ depth_type & depth) const;
///
void validate(LaTeXFeatures &) const;
- /// return the unique ID of this paragraph
- int id() const;
- /// Set the Id of this paragraph.
- void id(int);
-
///
int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
///
bool simpleTeXOnePar(Buffer const &, BufferParams const &,
LyXFont const & outerfont, std::ostream &,
- TexRow & texrow, LatexRunParams const &);
+ TexRow & texrow, OutputParams const &) const;
+
+ /// Writes to stream the content of the paragraph for linuxdoc
+ void simpleLinuxDocOnePar(Buffer const & buf,
+ std::ostream & os,
+ LyXFont const & outerfont,
+ OutputParams const & runparams,
+ lyx::depth_type depth) const;
+
+ /// Can we drop the standard paragraph wrapper?
+ bool Paragraph::emptyTag() const;
+
+ /// Get the id of the paragraph, usefull for docbook and linuxdoc
+ std::string getID(Buffer const & buf,
+ OutputParams const & runparams) const;
+
+ // Get the first word of a paragraph, return the position where it left
+ lyx::pos_type getFirstWord(Buffer const & buf,
+ std::ostream & os,
+ OutputParams const & runparams) const;
+
+ /// Checks if the paragraph contains only text and no inset or font change.
+ bool onlyText(Buffer const & buf, LyXFont const & outerfont,
+ lyx::pos_type initial) const;
+
+ /// Writes to stream the docbook representation
+ void simpleDocBookOnePar(Buffer const & buf,
+ std::ostream &,
+ OutputParams const & runparams,
+ LyXFont const & outerfont,
+ lyx::pos_type initial = 0) const;
///
bool hasSameLayout(Paragraph const & par) const;
///
void makeSameLayout(Paragraph const & par);
+ ///
+ void setInsetOwner(UpdatableInset * inset);
///
UpdatableInset * inInset() const;
///
- void setInsetOwner(UpdatableInset * inset);
+ InsetBase::Code ownerCode() const;
+ ///
+ bool autoBreakRows() const;
///
- void deleteInsetsLyXText(BufferView *);
+ bool forceDefaultParagraphs() const;
///
- lyx::pos_type size() const;
+ lyx::pos_type size() const { return text_.size(); }
///
- bool empty() const;
+ bool empty() const { return text_.empty(); }
///
void setContentsFromPar(Paragraph const & par);
///
///
void layout(LyXLayout_ptr const & new_layout);
- ///
- char enumdepth;
-
- ///
- char itemdepth;
+ /// This is the item depth, only used by enumerate and itemize
+ signed char itemdepth;
///
InsetBibitem * bibitem() const; // ale970302
/// the paragraph alongside the text of the rest of the paragraph
/// (the body). This function returns the starting position of the
/// body of the text in the paragraph.
- int beginningOfBody() const;
+ lyx::pos_type beginOfBody() const;
+ /// recompute this value
+ void setBeginOfBody();
///
- string const & getLabelstring() const;
+ std::string const & getLabelstring() const;
/// the next two functions are for the manual labels
- string const getLabelWidthString() const;
+ std::string const getLabelWidthString() const;
///
- void setLabelWidthString(string const & s);
+ void setLabelWidthString(std::string const & s);
///
char getAlign() const;
/// The nesting depth of a paragraph
*/
lyx::pos_type getEndPosOfFontSpan(lyx::pos_type pos) const;
///
- value_type getChar(lyx::pos_type pos) const;
+ /// this is a bottleneck.
+ value_type getChar(lyx::pos_type pos) const
+ {
+ BOOST_ASSERT(pos >= 0);
+ BOOST_ASSERT(pos < int(text_.size()));
+ return text_[pos];
+ }
///
value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
/// The position must already exist.
/// 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(lyx::pos_type startpos,
- lyx::pos_type endpos,
- LyXFont::FONT_SIZE const def_size) const;
+ LyXFont_size highestFontInRange(lyx::pos_type startpos,
+ lyx::pos_type endpos,
+ LyXFont_size def_size) const;
///
- void insertChar(lyx::pos_type pos, value_type c);
+ void insert(lyx::pos_type pos, std::string const & str,
+ LyXFont const & font);
///
- void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
+ void insertChar(lyx::pos_type pos, value_type c,
+ Change change = Change(Change::INSERTED));
+ ///
+ void insertChar(lyx::pos_type pos, value_type c,
+ LyXFont const &, Change change = Change(Change::INSERTED));
///
bool checkInsertChar(LyXFont &);
///
- void insertInset(lyx::pos_type pos, InsetOld * inset);
+ void insertInset(lyx::pos_type pos, InsetBase * inset,
+ Change change = Change(Change::INSERTED));
///
- void insertInset(lyx::pos_type pos, InsetOld * inset, LyXFont const &, Change change = Change(Change::INSERTED));
+ void insertInset(lyx::pos_type pos, InsetBase * inset,
+ LyXFont const &, Change change = Change(Change::INSERTED));
///
- bool insetAllowed(InsetOld::Code code);
+ bool insetAllowed(InsetBase_code code);
///
- InsetOld * getInset(lyx::pos_type pos);
+ InsetBase * getInset(lyx::pos_type pos);
///
- InsetOld const * getInset(lyx::pos_type pos) const;
+ InsetBase const * getInset(lyx::pos_type pos) const;
///
bool isHfill(lyx::pos_type pos) const;
- ///
- bool isInset(lyx::pos_type pos) const;
+ /// hinted by profiler
+ bool isInset(lyx::pos_type pos) const { return getChar(pos) == static_cast<value_type>(META_INSET); }
///
bool isNewline(lyx::pos_type pos) const;
///
bool isSeparator(lyx::pos_type pos) const;
///
bool isLineSeparator(lyx::pos_type pos) const;
- ///
- bool isKomma(lyx::pos_type pos) const;
- /// Used by the spellchecker
+ /// True if the character/inset at this point can be part of a word
+ // Note that digits in particular are considered as letters
bool isLetter(lyx::pos_type pos) const;
- ///
- bool isWord(lyx::pos_type pos) const;
/// returns -1 if inset not found
- int getPositionOfInset(InsetOld const * inset) const;
+ int getPositionOfInset(InsetBase const * inset) const;
///
int stripLeadingSpaces();
/// return true if we allow this par to stay empty
bool allowEmpty() const;
-
+ ////
+ unsigned char transformChar(unsigned char c, lyx::pos_type pos) const;
///
ParagraphParameters & params();
///
ParagraphParameters const & params() const;
+
+ ///
+ Row & getRow(lyx::pos_type pos);
+ ///
+ Row const & getRow(lyx::pos_type pos) const;
+ ///
+ size_t pos2row(lyx::pos_type pos) const;
+
///
InsetList insetlist;
+ /// total height of paragraph
+ unsigned int height() const { return dim_.height(); }
+ /// total width of paragraph, may differ from workwidth
+ unsigned int width() const { return dim_.width(); }
+ unsigned int ascent() const { return dim_.ascent(); }
+ unsigned int descent() const { return dim_.descent(); }
+ ///
+ RowList & rows() { return rows_; }
///
- mutable RowList rows;
- /// last draw y position (baseline of top row)
- int y;
+ RowList const & rows() const { return rows_; }
+
+ // compute paragraph metrics
+ void metrics(MetricsInfo & mi, Dimension & dim, LyXText & text);
+ // draw paragraph
+ void draw(PainterInfo & pi, int x, int y, LyXText & text) const;
+ /// dump some information
+ void dump() const;
+
+ /// cached dimensions of paragraph
+ Dimension dim_;
private:
+ ///
+ mutable RowList rows_;
///
LyXLayout_ptr layout_;
+ /// keeping this here instead of in the pimpl makes LyX >10% faster
+ // for average tasks as buffer loading/switching etc.
+ TextContainer text_;
+ /// end of label
+ lyx::pos_type begin_of_body_;
struct Pimpl;
///