X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FParagraph.h;h=9d7e5f1d4c86063c990994a60f3c2c87302bdbd1;hb=96007ce5ac7944bbb30366e21730979498ef296c;hp=e264bb273715b25d07d97dfc5acd41c04805ea66;hpb=1297114b73505c3d58eeb77254b2c5119887f3a8;p=lyx.git diff --git a/src/Paragraph.h b/src/Paragraph.h index e264bb2737..9d7e5f1d4c 100644 --- a/src/Paragraph.h +++ b/src/Paragraph.h @@ -16,14 +16,13 @@ #ifndef PARAGRAPH_H #define PARAGRAPH_H -#include "LayoutPtr.h" +#include "FontEnums.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 { @@ -32,6 +31,10 @@ class Buffer; class BufferParams; class Change; class Counters; +class Cursor; +class CursorSlice; +class DocIterator; +class DocumentClass; class Inset; class InsetBibitem; class LaTeXFeatures; @@ -45,7 +48,7 @@ class OutputParams; class PainterInfo; class ParagraphParameters; class TexRow; - +class Toc; class FontSpan { public: @@ -70,15 +73,27 @@ 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. + AS_STR_NEWLINES = 4 ///< Get also newline characters. +}; + + /// A Paragraph holds all text, attributes and insets in a text paragraph -/// \todo FIXME: any reference to ParagraphMetrics (including inheritance) -/// should go in order to complete the Model/View separation of this class. -class Paragraph { +class Paragraph +{ 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 &); /// @@ -86,6 +101,8 @@ public: /// int id() const; + /// + void addChangesToToc(DocIterator const & cdit, Buffer const & buf) const; /// Language const * getParLanguage(BufferParams const &) const; /// @@ -96,40 +113,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; - - /// Checks if the paragraph contains only text and no inset or font change. - bool onlyText(Buffer const & buf, Font const & outerfont, - pos_type initial) const; + pos_type firstWord(odocstream & os, OutputParams const & runparams) const; /// Writes to stream the docbook representation void simpleDocBookOnePar(Buffer const & buf, @@ -145,30 +157,32 @@ 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; - /// - InsetBibitem * bibitem() const; // ale970302 - /// look up change at given pos Change const & lookupChange(pos_type pos) const; @@ -207,7 +221,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; @@ -217,7 +231,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; @@ -226,28 +240,31 @@ 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); /// (logically) erase the given range; return the number of chars actually erased int eraseChars(pos_type start, pos_type end, bool trackChanges); + /// + void resetFonts(Font const & font); + /** Get uninstantiated font setting. Returns the difference between the characters font and the layoutfont. This is what is stored in the fonttable */ - Font const + Font const & getFontSettings(BufferParams const &, pos_type pos) const; /// - Font const getFirstFontSettings(BufferParams const &) const; + Font const & getFirstFontSettings(BufferParams const &) const; /** Get fully instantiated font. If pos == -1, use the layout font attached to this paragraph. If pos == -2, use the label font of the layout attached here. In all cases, the font is instantiated, i.e. does not have any - attributes with values Font::INHERIT, Font::IGNORE or - Font::TOGGLE. + attributes with values FONT_INHERIT, FONT_IGNORE or + FONT_TOGGLE. */ Font const getFont(BufferParams const &, pos_type pos, Font const & outerfont) const; @@ -269,8 +286,8 @@ public: /// pos <= size() (there is a dummy font change at the end of each par) void setFont(pos_type pos, Font const & font); /// Returns the height of the highest font in range - Font_size highestFontInRange(pos_type startpos, - pos_type endpos, Font_size def_size) const; + FontSize highestFontInRange(pos_type startpos, + pos_type endpos, FontSize def_size) const; /// void insert(pos_type pos, docstring const & str, Font const & font, Change const & change); @@ -288,14 +305,15 @@ public: /// void insertChar(pos_type pos, char_type c, Font const &, Change const & change); - /// - void insertInset(pos_type pos, Inset * inset, + /// Insert \p inset at position \p pos with \p change traking status. + /// \return true if successful. + bool insertInset(pos_type pos, Inset * inset, Change const & change); - /// - void insertInset(pos_type pos, Inset * inset, - Font const &, Change const & change); - /// - bool insetAllowed(InsetCode code); + /// Insert \p inset at position \p pos with \p change traking status and + /// \p font. + /// \return true if successful. + bool insertInset(pos_type pos, Inset * inset, + Font const & font, Change const & change); /// Inset * getInset(pos_type pos); /// @@ -309,6 +327,8 @@ public: /// InsetList const & insetList() const; + /// + void setBuffer(Buffer &); /// bool isHfill(pos_type pos) const; @@ -324,6 +344,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) @@ -348,20 +372,37 @@ 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. void checkAuthors(AuthorList const & authorList); - /// return the number of InsetOptArg in a paragraph - int numberOfOptArgs() const; - /// 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 + /// \param del specifies whether deleted strings in ct mode will be considered + bool find( + docstring const & str, ///< string to search + bool cs, ///< + 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; ///