X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FParagraph.h;h=6fdb27017765955175ae263450220195b476fe07;hb=2f271f61bcd514da3ab5b44d2b7bf61e12ac0c44;hp=9de84bf057361b1fdfc5964afb08a18ddc2cc429;hpb=5ddc612b735317d5b22553a63aad7879503e3950;p=lyx.git diff --git a/src/Paragraph.h b/src/Paragraph.h index 9de84bf057..6fdb270177 100644 --- a/src/Paragraph.h +++ b/src/Paragraph.h @@ -17,14 +17,12 @@ #define PARAGRAPH_H #include "FontEnums.h" -#include "LayoutPtr.h" +#include "Layout.h" #include "insets/InsetCode.h" -#include "support/docstring.h" -// FIXME: would be nice to forward declare odocstream instead of -// including this: -#include "support/docstream.h" +#include "support/strfwd.h" +#include "support/types.h" namespace lyx { @@ -33,6 +31,9 @@ class Buffer; class BufferParams; class Change; class Counters; +class Cursor; +class CursorSlice; +class DocumentClass; class Inset; class InsetBibitem; class LaTeXFeatures; @@ -71,6 +72,15 @@ enum TextCase { }; +/// +enum AsStringParameter +{ + AS_STR_NONE = 0, ///< No option, only printable characters. + AS_STR_LABEL = 1, ///< Prefix with paragraph label. + AS_STR_INSETS = 2 ///< Go into insets. +}; + + /// A Paragraph holds all text, attributes and insets in a text paragraph class Paragraph { @@ -79,6 +89,9 @@ public: Paragraph(); /// Paragraph(Paragraph const &); + /// Partial copy constructor. + /// Copy the Paragraph contents from \p beg to \p end (without end). + Paragraph(Paragraph const & par, pos_type beg, pos_type end); /// Paragraph & operator=(Paragraph const &); /// @@ -96,36 +109,35 @@ public: /// bool isMultiLingual(BufferParams const &) const; + /// Convert the paragraph to a string. + /// \param AsStringParameter options. This can contain any combination of + /// asStringParameter values. Valid examples: + /// asString(AS_STR_LABEL) + /// asString(AS_STR_LABEL | AS_STR_INSETS) + /// asString(AS_STR_INSETS) + docstring asString(int options = AS_STR_NONE) const; /// - docstring const asString(Buffer const &, bool label) const; - /// - docstring const asString(Buffer const & buffer, - pos_type beg, - pos_type end, - bool label) const; + docstring asString(pos_type beg, pos_type end, + int options = AS_STR_NONE) const; /// - void write(Buffer const &, std::ostream &, BufferParams const &, + void write(std::ostream &, BufferParams const &, depth_type & depth) const; /// void validate(LaTeXFeatures &) const; /// - bool latex(Buffer const &, BufferParams const &, - Font const & outerfont, odocstream &, - TexRow & texrow, OutputParams const &) const; + bool latex(BufferParams const &, Font const & outerfont, odocstream &, + TexRow & texrow, OutputParams const &) const; /// Can we drop the standard paragraph wrapper? bool emptyTag() const; /// Get the id of the paragraph, usefull for docbook - std::string getID(Buffer const & buf, - OutputParams const & runparams) const; + std::string getID(Buffer const & buf, OutputParams const & runparams) const; /// Get the first word of a paragraph, return the position where it left - pos_type getFirstWord(Buffer const & buf, - odocstream & os, - OutputParams const & runparams) const; + pos_type firstWord(odocstream & os, OutputParams const & runparams) const; /// Writes to stream the docbook representation void simpleDocBookOnePar(Buffer const & buf, @@ -141,23 +153,28 @@ public: void makeSameLayout(Paragraph const & par); /// - void setInsetOwner(Inset * inset); + void setInsetOwner(Inset const * inset); /// - Inset * inInset() const; + Inset const & inInset() const; /// InsetCode ownerCode() const; /// - bool forceDefaultParagraphs() const; - + bool forcePlainLayout() const; + /// + bool allowParagraphCustomization() const; + /// + bool usePlainLayout() const; /// pos_type size() const; /// bool empty() const; /// - LayoutPtr const & layout() const; + Layout const & layout() const; + /// Do not pass a temporary to this! + void setLayout(Layout const & layout); /// - void layout(LayoutPtr const & new_layout); + void setPlainOrDefaultLayout(DocumentClass const & tc); /// This is the item depth, only used by enumerate and itemize signed char itemdepth; @@ -200,7 +217,7 @@ public: void setBeginOfBody(); /// - docstring const & getLabelstring() const; + docstring const & labelString() const; /// the next two functions are for the manual labels docstring const getLabelWidthString() const; @@ -210,7 +227,7 @@ public: docstring const translateIfPossible(docstring const & label, BufferParams const & bparams) const; /// Expand the counters for the labelstring of \c layout - docstring expandLabel(LayoutPtr const &, BufferParams const &, + docstring expandLabel(Layout const &, BufferParams const &, bool process_appendix = true) const; /// Actual paragraph alignment used char getAlign() const; @@ -219,7 +236,7 @@ public: /// The maximal possible depth of a paragraph after this one depth_type getMaxDepthAfter() const; /// - void applyLayout(LayoutPtr const & new_layout); + void applyLayout(Layout const & new_layout); /// (logically) erase the char at pos; return true if it was actually erased bool eraseChar(pos_type pos, bool trackChanges); @@ -291,8 +308,6 @@ public: void insertInset(pos_type pos, Inset * inset, Font const &, Change const & change); /// - bool insetAllowed(InsetCode code); - /// Inset * getInset(pos_type pos); /// Inset const * getInset(pos_type pos) const; @@ -305,6 +320,8 @@ public: /// InsetList const & insetList() const; + /// + void setBuffer(Buffer &); /// bool isHfill(pos_type pos) const; @@ -320,6 +337,10 @@ public: /// 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(pos_type pos) const; + /// True if the element at this point is a character that is not a letter. + bool isChar(pos_type pos) const; + /// True if the element at this point is a space + bool isSpace(pos_type pos) const; /// returns true if at least one line break or line separator has been deleted /// at the beginning of the paragraph (either physically or logically) @@ -344,7 +365,7 @@ public: /// an inset, in which case pos is the position from which the inset /// was deleted, and the cursor will need to be moved back one if it /// was previously past that position. Return 0 otherwise. - int checkBiblio(bool track_changes); + int checkBiblio(Buffer const & buffer); /// For each author, set 'used' to true if there is a change /// by this author in the paragraph. @@ -352,7 +373,7 @@ public: /// void changeCase(BufferParams const & bparams, pos_type pos, - pos_type right, TextCase action); + pos_type & right, TextCase action); /// find \param str string inside Paragraph. /// \return true if the specified string is at the specified position @@ -363,8 +384,18 @@ public: bool mw, ///< pos_type pos, ///< start from here. bool del = true) const; + + /// + void updateWords(CursorSlice const & sl); private: + /// + void deregisterWords(); + /// + void collectWords(CursorSlice const & sl); + /// + void registerWords(); + /// Pimpl away stuff class Private; ///