]> git.lyx.org Git - lyx.git/blobdiff - src/paragraph.h
namespace grfx -> lyx::graphics
[lyx.git] / src / paragraph.h
index 75e8097f32932419ae7eb55dcfffff8e2d8e2bb5..5c9ba843c3858caae9f60fad1929e90adcdea7cd 100644 (file)
 
 #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;
@@ -53,13 +52,11 @@ public:
 
        ///
        Paragraph();
-#ifndef NO_NEXT
-       /// this constructor inserts the new paragraph in a list
-       explicit
-       Paragraph(Paragraph * par);
-#endif
+
+       ///
+       Paragraph(Paragraph const &);
        ///
-       Paragraph(Paragraph const &, bool same_ids);
+       void operator=(Paragraph const &);
        /// the destructor removes the new paragraph from the list
        ~Paragraph();
 
@@ -87,13 +84,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;
@@ -104,27 +96,19 @@ 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 *);
        ///
@@ -135,7 +119,7 @@ public:
        ///
        bool empty() const;
        ///
-       void setContentsFromPar(Paragraph * par);
+       void setContentsFromPar(Paragraph const & par);
        ///
        void clearContents();
 
@@ -151,64 +135,48 @@ public:
        char itemdepth;
 
        ///
-       InsetBibKey * bibkey();  // ale970302
-
-#ifndef NO_NEXT
-       ///
-       void next(Paragraph *);
-       /** these function are able to hide closed footnotes
-        */
-       Paragraph * next();
-       ///
-       Paragraph const * next() const;
+       InsetBibitem * bibitem() const;  // ale970302
 
        /// 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();
-       ///
-       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;
+
+       /// 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;
+
        ///
        string const & getLabelstring() const;
 
@@ -224,12 +192,14 @@ public:
        depth_type getMaxDepthAfter() const;
        ///
        void applyLayout(LyXLayout_ptr const & new_layout);
+
+       /// definite erase
+       void eraseIntern(lyx::pos_type pos);
        /// erase the char at the given position
-       void erase(lyx::pos_type pos);
-       /// erase the given range. Returns true if actually erased.
-       bool erase(lyx::pos_type start, lyx::pos_type end);
+       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
@@ -246,9 +216,12 @@ 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;
        ///
        value_type getChar(lyx::pos_type pos) const;
        ///
@@ -310,49 +283,44 @@ public:
        ///
        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();
 
-       friend void breakParagraph(BufferParams const & bparams,
-                    Paragraph * par, lyx::pos_type pos, int flag);
 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_;
+
 };
 
-inline bool isInsertedText(Paragraph const * par, lyx::pos_type pos)
+
+inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
 {
-       return par->lookupChange(pos) == Change::INSERTED;
+       return par.lookupChange(pos) == Change::INSERTED;
 }
-inline bool isDeletedText(Paragraph const * par, lyx::pos_type pos)
+
+
+inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
 {
-       return par->lookupChange(pos) == Change::DELETED;
+       return par.lookupChange(pos) == Change::DELETED;
 }
+
+
+bool operator==(Paragraph const & lhs, Paragraph const & rhs);
+
 #endif // PARAGRAPH_H