]> git.lyx.org Git - lyx.git/blobdiff - src/paragraph.h
* Replace all use of 'slashify_path' with 'internal_path'.
[lyx.git] / src / paragraph.h
index 6d92ad9c524a47e7a8f12994506e1551821b11ac..26d11218283e4f9d982921cec162fb9a093141c7 100644 (file)
 #define PARAGRAPH_H
 
 #include "changes.h"
+#include "dimension.h"
 #include "InsetList.h"
 #include "lyxlayout_ptr_fwd.h"
 #include "RowList_fwd.h"
 
+#include "insets/insetbase.h" // only for InsetBase::Code
+
 #include "support/types.h"
 
+#include <boost/assert.hpp>
+
 #include <string>
 
 class Buffer;
 class BufferParams;
 class BufferView;
 class Counters;
+class InsetBase;
 class InsetBibitem;
-class InsetOld_code;
-class Language;
 class LaTeXFeatures;
-class OutputParams;
+class InsetBase_code;
+class Language;
 class LyXFont;
 class LyXFont_size;
+class MetricsInfo;
+class OutputParams;
+class PainterInfo;
 class ParagraphParameters;
 class TexRow;
 class UpdatableInset;
@@ -44,7 +52,7 @@ class UpdatableInset;
 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
@@ -61,17 +69,17 @@ public:
 
        ///
        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;
        ///
@@ -80,7 +88,7 @@ public:
        void changeLanguage(BufferParams const & bparams,
                            Language const * from, Language const * to);
        ///
-       bool isMultiLingual(BufferParams const &);
+       bool isMultiLingual(BufferParams const &) const;
 
        ///
        std::string const asString(Buffer const &,
@@ -116,22 +124,37 @@ public:
        ///
        bool simpleTeXOnePar(Buffer const &, BufferParams const &,
                             LyXFont const & outerfont, std::ostream &,
-                            TexRow & texrow, OutputParams 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 &,
-                                LyXFont const & outerfont,
-                                int & desc_on,
                                 OutputParams const & runparams,
-                                lyx::depth_type depth) const;
+                                LyXFont const & outerfont,
+                                lyx::pos_type initial = 0) const;
 
        ///
        bool hasSameLayout(Paragraph const & par) const;
@@ -139,10 +162,14 @@ public:
        ///
        void makeSameLayout(Paragraph const & par);
 
+       ///
+       void setInsetOwner(UpdatableInset * inset);
        ///
        UpdatableInset * inInset() const;
        ///
-       void setInsetOwner(UpdatableInset * inset);
+       InsetBase::Code ownerCode() const;
+       ///
+       bool forceDefaultParagraphs() const;
 
        ///
        lyx::pos_type size() const { return text_.size(); }
@@ -202,7 +229,7 @@ public:
        /// 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 beginOfBody() const;
+       lyx::pos_type beginOfBody() const;
        /// recompute this value
        void setBeginOfBody();
 
@@ -259,7 +286,13 @@ public:
         */
        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.
@@ -274,41 +307,42 @@ public:
        void insert(lyx::pos_type pos, std::string const & str,
                    LyXFont const & font);
        ///
-       void insertChar(lyx::pos_type pos, value_type c);
+       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));
+       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();
@@ -326,28 +360,46 @@ public:
        ParagraphParameters const & params() const;
 
        ///
-       RowList::iterator getRow(lyx::pos_type pos);
+       Row & getRow(lyx::pos_type pos);
+       ///
+       Row const & getRow(lyx::pos_type pos) const;
+       ///
+       size_t pos2row(lyx::pos_type pos) const;
 
        ///
        InsetList insetlist;
 
-       ///
-       mutable RowList rows;
-       /// last draw y position (baseline of top row)
-       int y;
        /// total height of paragraph
-       unsigned int height;
+       unsigned int height() const { return dim_.height(); }
        /// total width of paragraph, may differ from workwidth
-       unsigned int width;
+       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_; }
+       ///
+       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
-       int begin_of_body_;
+       lyx::pos_type begin_of_body_;
 
        struct Pimpl;
        ///