X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FParagraph.h;h=30c033b4875be3516646fe6dac79048e8be69c04;hb=a8cd9a4b8fd325b00c75f601c66c6d618ba276db;hp=c345a5bb6f2459a51846c704b290bac51807693f;hpb=32871c1284f15265f652ff01c438e539a7c8181f;p=lyx.git diff --git a/src/Paragraph.h b/src/Paragraph.h index c345a5bb6f..30c033b487 100644 --- a/src/Paragraph.h +++ b/src/Paragraph.h @@ -16,28 +16,29 @@ #ifndef PARAGRAPH_H #define PARAGRAPH_H -#include "Changes.h" -#include "Dimension.h" -#include "InsetList.h" -#include "lyxlayout_ptr_fwd.h" -#include "RowList_fwd.h" +#include "FontEnums.h" +#include "LayoutPtr.h" -#include "insets/Inset.h" // only for Inset::Code +#include "insets/InsetCode.h" +#include "support/strfwd.h" +#include "support/types.h" namespace lyx { - +class AuthorList; class Buffer; class BufferParams; +class Change; class Counters; class Inset; class InsetBibitem; class LaTeXFeatures; class Inset_code; +class InsetList; class Language; -class LyXFont; -class LyXFont_size; +class Font; +class Font_size; class MetricsInfo; class OutputParams; class PainterInfo; @@ -57,27 +58,21 @@ public: pos_type first, last; }; - -/// 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 { -public: +/// +enum TextCase { /// - 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 - /// try getInset() and crash. We should fix - /// all these places. - //META_INSET = 1 // as in trunk - META_INSET = 0x200001 // above 0x10ffff, for ucs-4 - }; + text_lowercase = 0, /// - typedef char_type value_type; + text_capitalization = 1, /// - typedef std::vector TextContainer; + text_uppercase = 2 +}; + +/// A Paragraph holds all text, attributes and insets in a text paragraph +class Paragraph +{ +public: /// Paragraph(); /// @@ -89,11 +84,10 @@ public: /// int id() const; - /// Language const * getParLanguage(BufferParams const &) const; /// - bool isRightToLeftPar(BufferParams const &) const; + bool isRTL(BufferParams const &) const; /// void changeLanguage(BufferParams const & bparams, Language const * from, Language const * to); @@ -115,17 +109,8 @@ public: void validate(LaTeXFeatures &) const; /// - int startTeXParParams(BufferParams const &, odocstream &, TexRow &, - bool) const; - - /// - int endTeXParParams(BufferParams const &, odocstream &, TexRow &, - bool) const; - - - /// - bool simpleTeXOnePar(Buffer const &, BufferParams const &, - LyXFont const & outerfont, odocstream &, + bool latex(Buffer const &, BufferParams const &, + Font const & outerfont, odocstream &, TexRow & texrow, OutputParams const &) const; /// Can we drop the standard paragraph wrapper? @@ -140,15 +125,11 @@ public: odocstream & 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, - pos_type initial) const; - /// Writes to stream the docbook representation void simpleDocBookOnePar(Buffer const & buf, odocstream &, OutputParams const & runparams, - LyXFont const & outerfont, + Font const & outerfont, pos_type initial = 0) const; /// @@ -162,43 +143,34 @@ public: /// Inset * inInset() const; /// - Inset::Code ownerCode() const; + InsetCode ownerCode() const; /// bool forceDefaultParagraphs() const; /// - pos_type size() const { return text_.size(); } + pos_type size() const; /// - bool empty() const { return text_.empty(); } + bool empty() const; /// - LyXLayout_ptr const & layout() const; + LayoutPtr const & layout() const; /// - void layout(LyXLayout_ptr const & new_layout); + void layout(LayoutPtr const & new_layout); /// 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; /// is there a change within the given range ? bool isChanged(pos_type start, pos_type end) const; /// is there an unchanged char at the given pos ? - bool isUnchanged(pos_type pos) const { - return lookupChange(pos).type == Change::UNCHANGED; - } + bool isUnchanged(pos_type pos) const; /// is there an insertion at the given pos ? - bool isInserted(pos_type pos) const { - return lookupChange(pos).type == Change::INSERTED; - } + bool isInserted(pos_type pos) const; /// is there a deletion at the given pos ? - bool isDeleted(pos_type pos) const { - return lookupChange(pos).type == Change::DELETED; - } + bool isDeleted(pos_type pos) const; /// will the paragraph be physically merged with the next /// one if the imaginary end-of-par character is logically deleted? @@ -236,7 +208,7 @@ public: docstring const translateIfPossible(docstring const & label, BufferParams const & bparams) const; /// Expand the counters for the labelstring of \c layout - docstring expandLabel(LyXLayout_ptr const &, BufferParams const &, + docstring expandLabel(LayoutPtr const &, BufferParams const &, bool process_appendix = true) const; /// Actual paragraph alignment used char getAlign() const; @@ -245,35 +217,38 @@ public: /// The maximal possible depth of a paragraph after this one depth_type getMaxDepthAfter() const; /// - void applyLayout(LyXLayout_ptr const & new_layout); + void applyLayout(LayoutPtr 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 */ - LyXFont const + Font const getFontSettings(BufferParams const &, pos_type pos) const; /// - LyXFont 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 LyXFont::INHERIT, LyXFont::IGNORE or - LyXFont::TOGGLE. + attributes with values FONT_INHERIT, FONT_IGNORE or + FONT_TOGGLE. */ - LyXFont const getFont(BufferParams const &, 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; + Font const getFont(BufferParams const &, pos_type pos, + Font const & outerfont) const; + Font const getLayoutFont(BufferParams const &, + Font const & outerfont) const; + Font const getLabelFont(BufferParams const &, + Font const & outerfont) const; /** * The font returned by the above functions is the same in a * span of characters. This method will return the first and @@ -282,66 +257,69 @@ public: */ FontSpan fontSpan(pos_type pos) const; /// - /// this is a bottleneck. - value_type getChar(pos_type pos) const { return text_[pos]; } + char_type getChar(pos_type pos) const; /// Get the char, but mirror all bracket characters if it is right-to-left - value_type getUChar(BufferParams const &, pos_type pos) const; + char_type getUChar(BufferParams const &, pos_type pos) const; /// pos <= size() (there is a dummy font change at the end of each par) - void setFont(pos_type pos, LyXFont const & font); + void setFont(pos_type pos, Font const & font); /// Returns the height of the highest font in range - LyXFont_size highestFontInRange(pos_type startpos, - pos_type endpos, LyXFont_size def_size) const; + FontSize highestFontInRange(pos_type startpos, + pos_type endpos, FontSize def_size) const; /// void insert(pos_type pos, docstring const & str, - LyXFont const & font, Change const & change); + Font const & font, Change const & change); + + /// + void appendString(docstring const & s, Font const & font, + Change const & change); /// - void insertChar(pos_type pos, value_type c, bool trackChanges); + void appendChar(char_type c, Font const & font, Change const & change); /// - void insertChar(pos_type pos, value_type c, - LyXFont const &, bool trackChanges); + void insertChar(pos_type pos, char_type c, bool trackChanges); /// - void insertChar(pos_type pos, value_type c, - LyXFont const &, Change const & change); + void insertChar(pos_type pos, char_type c, + Font const &, bool trackChanges); + /// + void insertChar(pos_type pos, char_type c, + Font const &, Change const & change); /// void insertInset(pos_type pos, Inset * inset, - Change const & change); + Change const & change); /// void insertInset(pos_type pos, Inset * inset, - LyXFont const &, Change const & change); + Font const &, Change const & change); /// - bool insetAllowed(Inset_code code); + bool insetAllowed(InsetCode code); /// - Inset * getInset(pos_type pos) { - return insetlist.get(pos); - } + Inset * getInset(pos_type pos); /// - Inset const * getInset(pos_type pos) const { - return insetlist.get(pos); - } + Inset const * getInset(pos_type pos) const; + + /// Release inset at given position. + /// \warning does not honour change tracking! + /// Therefore, it should only be used for breaking and merging + /// paragraphs + Inset * releaseInset(pos_type pos); /// - bool isHfill(pos_type pos) const { - return isInset(pos) - && getInset(pos)->lyxCode() == Inset::HFILL_CODE; - } + InsetList const & insetList() const; + + /// + bool isHfill(pos_type pos) const; + /// hinted by profiler - bool isInset(pos_type pos) const { - return getChar(pos) == static_cast(META_INSET); - } + bool isInset(pos_type pos) const; /// bool isNewline(pos_type pos) const; /// return true if the char is a word separator - bool isSeparator(pos_type pos) const { return getChar(pos) == ' '; } + bool isSeparator(pos_type pos) const; /// bool isLineSeparator(pos_type pos) const; /// 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; - /// returns -1 if inset not found - int getPositionOfInset(Inset const * inset) const; - - /// returns true if at least one line break or line separator has been deleted + /// returns true if at least one line break or line separator has been deleted /// at the beginning of the paragraph (either physically or logically) bool stripLeadingSpaces(bool trackChanges); @@ -356,35 +334,50 @@ public: ParagraphParameters & params(); /// ParagraphParameters const & params() const; - /// - bool hfillExpansion(Row const & row, pos_type pos) const; - /// Check if we are in a Biblio environment. - /// \retval true if the cursor needs to be moved right. - bool checkBiblio(bool track_changes); - -public: - /// - InsetList insetlist; + /// Check if we are in a Biblio environment and insert or + /// delete InsetBibitems as necessary. + /// \retval int 1, if we had to add an inset, in which case + /// the cursor will need to move cursor forward; -pos, if we deleted + /// 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); + + /// To resolve macros properly the paragraphs are numbered. + /// Every macro definition is stored with its paragraph number + /// as well. Only those macros with a smaller number become + /// visible in a paragraph (plus those in the same paragraph, but + /// in an earlier inset. + unsigned int macrocontextPosition() const; + /// + void setMacrocontextPosition(unsigned int pos); + + /// For each author, set 'used' to true if there is a change + /// by this author in the paragraph. + void checkAuthors(AuthorList const & authorList); + + /// + void changeCase(BufferParams const & bparams, pos_type pos, + 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; private: - - /// - 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 - pos_type begin_of_body_; - /// Pimpl away stuff - class Pimpl; + class Private; /// - friend class Paragraph::Pimpl; + friend class Paragraph::Private; /// - Pimpl * pimpl_; + Private * d; }; } // namespace lyx