]> git.lyx.org Git - lyx.git/blobdiff - src/paragraph.h
split LyXText::rowlist_ into individual Paragraph::rows_ chunks
[lyx.git] / src / paragraph.h
index 5317f010118096d93c85299593b9920a25b7453f..79ae05e6d6023488724d38a04382a581fdf0bc79 100644 (file)
@@ -9,45 +9,42 @@
 #ifndef PARAGRAPH_H
 #define PARAGRAPH_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "lyxlayout_ptr_fwd.h"
 #include "lyxfont.h" // Just for LyXFont::FONT_SIZE
 #include "InsetList.h"
 
-#include "insets/inset.h" // Just for Inset::Code
+#include "insets/inset.h" // Just for InsetOld::Code
 
 #include "support/types.h"
+#include "changes.h"
+#include "RowList.h"
 
 #include "LString.h"
 
+class Buffer;
 class BufferParams;
 class BufferView;
 class Counters;
-class InsetBibKey;
+class InsetBibitem;
 class Language;
 class LaTeXFeatures;
+class LatexRunParams;
 class ParagraphParameters;
 class TexRow;
-
-// Define this if you want to try out the new storage container for
-// paragraphs. (Lgb)
-// This is non working and far from finished.
-// #define NO_NEXT 1
+class ParagraphList;
+class UpdatableInset;
 
 /// A Paragraph holds all text, attributes and insets in a text paragraph
 class Paragraph  {
 public:
        ///
        enum META_KIND {
-               ///
-               META_HFILL = 1,
-               ///
-               META_NEWLINE,
-               ///
-               META_INSET
+               /// Note that this is 1 right now to avoid
+               /// crashes where getChar() is called wrongly
+               /// (returning 0) - if this was 0, then we'd
+               /// try getInset() and crash. We should fix
+               /// all these places.
+               META_INSET = 1
        };
        ///
        typedef char value_type;
@@ -56,13 +53,11 @@ public:
 
        ///
        Paragraph();
-#ifndef NO_NEXT
-       /// this constructor inserts the new paragraph in a list
-       explicit
-       Paragraph(Paragraph * par);
-#endif
+
        ///
-       Paragraph(Paragraph const &, bool same_ids);
+       Paragraph(Paragraph const &);
+       ///
+       void operator=(Paragraph const &);
        /// the destructor removes the new paragraph from the list
        ~Paragraph();
 
@@ -77,10 +72,10 @@ public:
        bool isMultiLingual(BufferParams const &);
 
        ///
-       string const asString(Buffer const *, bool label);
+       string const asString(Buffer const *, bool label) const;
        ///
        string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
-                             bool label);
+                             bool label) const;
 
        ///
        void write(Buffer const *, std::ostream &, BufferParams const &,
@@ -90,13 +85,8 @@ public:
 
        /// return the unique ID of this paragraph
        int id() const;
-       ///
-       void read();
-
-       ///
-       Paragraph * TeXOnePar(Buffer const *, BufferParams const &,
-                                std::ostream &, TexRow & texrow,
-                                bool moving_arg);
+       /// Set the Id of this paragraph.
+       void id(int);
 
        ///
        int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
@@ -107,38 +97,28 @@ public:
 
        ///
        bool simpleTeXOnePar(Buffer const *, BufferParams const &,
-                            std::ostream &, TexRow & texrow, bool moving_arg);
+                            LyXFont const & outerfont, std::ostream &,
+                            TexRow & texrow, LatexRunParams const &);
 
        ///
-       Paragraph * TeXEnvironment(Buffer const *, BufferParams const &,
-                                     std::ostream &, TexRow & texrow);
-       ///
-       bool hasSameLayout(Paragraph const * par) const;
+       bool hasSameLayout(Paragraph const & par) const;
 
        ///
-       void makeSameLayout(Paragraph const * par);
-
-       /// Is it the first par with same depth and layout?
-       bool isFirstInSequence() const;
+       void makeSameLayout(Paragraph const & par);
 
-       /** Check if the current paragraph is the last paragraph in a
-           proof environment */
-       int getEndLabel() const;
        ///
-       Inset * inInset() const;
+       UpdatableInset * inInset() const;
        ///
-       void setInsetOwner(Inset * i);
+       void setInsetOwner(UpdatableInset * inset);
        ///
        void deleteInsetsLyXText(BufferView *);
-       ///
-       void resizeInsetsLyXText(BufferView *);
 
        ///
        lyx::pos_type size() const;
        ///
        bool empty() const;
        ///
-       void setContentsFromPar(Paragraph * par);
+       void setContentsFromPar(Paragraph const & par);
        ///
        void clearContents();
 
@@ -154,34 +134,48 @@ public:
        char itemdepth;
 
        ///
-       InsetBibKey * bibkey;  // ale970302
+       InsetBibitem * bibitem() const;  // ale970302
 
-#ifndef NO_NEXT
-       ///
-       void next(Paragraph *);
-       /** these function are able to hide closed footnotes
-        */
-       Paragraph * next();
-       ///
-       Paragraph const * next() const;
+       /// initialise tracking for this par
+       void trackChanges(Change::Type = Change::UNCHANGED);
+
+       /// stop tracking
+       void untrackChanges();
+
+       /// set entire paragraph to new text for change tracking
+       void cleanChanges();
+
+       /// look up change type at given pos
+       Change::Type lookupChange(lyx::pos_type pos) const;
+
+       /// look up change at given pos
+       Change const lookupChangeFull(lyx::pos_type pos) const;
+
+       /// is there a change within the given range ?
+       bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
+
+       /// is there a non-addition in this range ?
+       bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
+
+       /// set change at pos
+       void setChange(lyx::pos_type pos, Change::Type type);
+
+       /// accept change
+       void acceptChange(lyx::pos_type start, lyx::pos_type end);
+
+       /// reject change
+       void rejectChange(lyx::pos_type start, lyx::pos_type end);
+
+       /// mark whole par as erased
+       void markErased();
+
+       /// Paragraphs can contain "manual labels", for example, Description
+       /// environment. The text for this user-editable label is stored in
+       /// 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;
 
-       ///
-       void previous(Paragraph *);
-       ///
-       Paragraph * previous();
-       ///
-       Paragraph const * previous() const;
-#endif
-       /// for the environments
-       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;
 
@@ -197,9 +191,15 @@ public:
        depth_type getMaxDepthAfter() const;
        ///
        void applyLayout(LyXLayout_ptr const & new_layout);
-       ///
-       void erase(lyx::pos_type pos);
-       /** Get unistantiated font setting. Returns the difference
+
+       /// definite erase
+       void eraseIntern(lyx::pos_type pos);
+       /// erase the char at the given position
+       bool erase(lyx::pos_type pos);
+       /// erase the given range. Returns the number of chars actually erased
+       int erase(lyx::pos_type start, lyx::pos_type end);
+
+       /** Get uninstantiated font setting. Returns the difference
            between the characters font and the layoutfont.
            This is what is stored in the fonttable
        */
@@ -215,9 +215,19 @@ public:
            attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
            LyXFont::TOGGLE.
        */
-       LyXFont const getFont(BufferParams const &, lyx::pos_type pos) const;
-       LyXFont const getLayoutFont(BufferParams const &) const;
-       LyXFont const getLabelFont(BufferParams const &) const;
+       LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
+                             LyXFont const & outerfont) const;
+       LyXFont const getLayoutFont(BufferParams const &,
+                                   LyXFont const & outerfont) const;
+       LyXFont const getLabelFont(BufferParams const &,
+                                  LyXFont const & outerfont) const;
+       /**
+        * The font returned by the above functions is the same in a
+        * span of characters. This method will return the last position
+        * in the paragraph for which that font is the same.
+        * This can be used to avoid unnecessary calls to getFont.
+        */
+       lyx::pos_type getEndPosOfFontSpan(lyx::pos_type pos) const;
        ///
        value_type getChar(lyx::pos_type pos) const;
        ///
@@ -234,27 +244,19 @@ public:
        ///
        void insertChar(lyx::pos_type pos, value_type c);
        ///
-       void insertChar(lyx::pos_type pos, value_type c, LyXFont const &);
+       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, Inset * inset);
+       void insertInset(lyx::pos_type pos, InsetOld * inset);
        ///
-       void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &);
+       void insertInset(lyx::pos_type pos, InsetOld * inset, LyXFont const &, Change change = Change(Change::INSERTED));
        ///
-       bool insetAllowed(Inset::Code code);
+       bool insetAllowed(InsetOld::Code code);
        ///
-       Inset * getInset(lyx::pos_type pos);
+       InsetOld * getInset(lyx::pos_type pos);
        ///
-       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 &, lyx::pos_type pos) const;
-       ///
-       void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
-       ///
-       bool insertFromMinibuffer(lyx::pos_type pos);
+       InsetOld const * getInset(lyx::pos_type pos) const;
 
        ///
        bool isHfill(lyx::pos_type pos) const;
@@ -274,42 +276,49 @@ public:
        bool isWord(lyx::pos_type pos) const;
 
        /// returns -1 if inset not found
-       int getPositionOfInset(Inset const * inset) const;
-
-       /// some good comment here John?
-       Paragraph * getParFromID(int id) const;
+       int getPositionOfInset(InsetOld const * inset) const;
 
        ///
        int stripLeadingSpaces();
 
-       ///
+       /// return true if we allow multiple spaces
        bool isFreeSpacing() const;
 
+       /// return true if we allow this par to stay empty
+       bool allowEmpty() const;
+
        ///
        ParagraphParameters & params();
        ///
        ParagraphParameters const & params() const;
        ///
        InsetList insetlist;
+
        ///
-       //Counters & counters();
+       mutable RowList rows;
 
 private:
        ///
        LyXLayout_ptr layout_;
-       /// if anything uses this we don't want it to.
-       Paragraph(Paragraph const &);
-#ifndef NO_NEXT
-       ///
-       Paragraph * next_;
-       ///
-       Paragraph * previous_;
-#endif
+
        struct Pimpl;
        ///
        friend struct Paragraph::Pimpl;
        ///
        Pimpl * pimpl_;
+
 };
 
-#endif
+
+inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
+{
+       return par.lookupChange(pos) == Change::INSERTED;
+}
+
+
+inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
+{
+       return par.lookupChange(pos) == Change::DELETED;
+}
+
+#endif // PARAGRAPH_H