X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FParagraph.h;h=b50cfacc8870793b8c03b348ee4bf78775579148;hb=f3711d8a651445a61e1a759ac7493a9c5c7800e2;hp=c345a5bb6f2459a51846c704b290bac51807693f;hpb=32871c1284f15265f652ff01c438e539a7c8181f;p=lyx.git diff --git a/src/Paragraph.h b/src/Paragraph.h index c345a5bb6f..b50cfacc88 100644 --- a/src/Paragraph.h +++ b/src/Paragraph.h @@ -5,10 +5,10 @@ * Licence details can be found in the file COPYING. * * \author Asger Alstrup - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author John Levon - * \author André Pönitz - * \author Jürgen Vigna + * \author André Pönitz + * \author Jürgen Vigna * * Full author contact details are available in file CREDITS. */ @@ -16,34 +16,44 @@ #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 "insets/Inset.h" // only for Inset::Code +#include "insets/InsetCode.h" +#include "support/strfwd.h" +#include "support/types.h" -namespace lyx { +#include +namespace lyx { +class AuthorList; class Buffer; class BufferParams; +class Change; class Counters; +class Cursor; +class CursorSlice; +class DocIterator; +class docstring_list; +class DocumentClass; class Inset; class InsetBibitem; class LaTeXFeatures; class Inset_code; +class InsetList; class Language; -class LyXFont; -class LyXFont_size; +class Layout; +class Font; +class Font_size; class MetricsInfo; class OutputParams; class PainterInfo; class ParagraphParameters; class TexRow; - +class Toc; +class WordLangTuple; +class XHTMLStream; class FontSpan { public: @@ -57,98 +67,111 @@ 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 +}; + +/// +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 +class Paragraph +{ +public: /// Paragraph(); - /// + /// Copy constructor. 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 &); /// ~Paragraph(); /// int id() const; - + /// + void setId(int id); + /// + void addChangesToToc(DocIterator const & cdit, Buffer const & buf) 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); /// bool isMultiLingual(BufferParams const &) const; - /// - docstring const asString(Buffer const &, bool label) const; + void getLanguages(std::set &) 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 & buffer, - pos_type beg, - pos_type end, - bool label) const; + docstring asString(pos_type beg, pos_type end, + int options = AS_STR_NONE) const; + + /// Extract only the explicitly visible text (without any formatting), + /// descending into insets + docstring stringify(pos_type beg, pos_type end, int options, OutputParams & runparams) const; /// - void write(Buffer const &, std::ostream &, BufferParams const &, + void write(std::ostream &, BufferParams const &, depth_type & depth) const; /// 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 &, - TexRow & texrow, OutputParams const &) const; + bool latex(BufferParams const &, Font const & outerfont, odocstream &, + TexRow & texrow, OutputParams const &, + int start_pos = 0, int end_pos = -1) 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; + /// Output the first word of a paragraph, return the position where it left. + pos_type firstWordDocBook(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; + /// Output the first word of a paragraph, return the position where it left. + pos_type firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams) 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; + /// \return any material that has had to be deferred until after the + /// paragraph has closed. + docstring simpleLyXHTMLOnePar(Buffer const & buf, + XHTMLStream & xs, + OutputParams const & runparams, + Font const & outerfont, pos_type initial = 0) const; /// @@ -158,47 +181,45 @@ public: void makeSameLayout(Paragraph const & par); /// - void setInsetOwner(Inset * inset); + void setInsetOwner(Inset const * inset); /// - Inset * inInset() const; + Inset const & inInset() const; /// - Inset::Code ownerCode() const; + bool allowParagraphCustomization() const; /// - bool forceDefaultParagraphs() const; - + bool usePlainLayout() 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; + Layout const & layout() const; + /// Do not pass a temporary to this! + void setLayout(Layout const & layout); /// - void layout(LyXLayout_ptr const & new_layout); + void setPlainOrDefaultLayout(DocumentClass const & tc); + /// + void setDefaultLayout(DocumentClass const & tc); + /// + void setPlainLayout(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; /// 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 isChanged(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; + /// is the whole paragraph deleted ? + bool isDeleted(pos_type start, pos_type end) const; /// will the paragraph be physically merged with the next /// one if the imaginary end-of-par character is logically deleted? @@ -211,10 +232,10 @@ public: void setChange(pos_type pos, Change const & change); /// accept changes within the given range - void acceptChanges(BufferParams const & bparams, pos_type start, pos_type end); + void acceptChanges(pos_type start, pos_type end); /// reject changes within the given range - void rejectChanges(BufferParams const & bparams, pos_type start, pos_type end); + void rejectChanges(pos_type start, pos_type end); /// Paragraphs can contain "manual labels", for example, Description /// environment. The text for this user-editable label is stored in @@ -226,18 +247,15 @@ public: void setBeginOfBody(); /// - docstring const & getLabelstring() const; - + docstring expandLabel(Layout const &, BufferParams const &) const; + /// + docstring expandDocBookLabel(Layout const &, BufferParams const &) const; + /// + docstring const & labelString() const; /// the next two functions are for the manual labels docstring const getLabelWidthString() const; /// Set label width string. void setLabelWidthString(docstring const & s); - /// translate \p label to the paragraph language if possible. - 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 &, - bool process_appendix = true) const; /// Actual paragraph alignment used char getAlign() const; /// The nesting depth of a paragraph @@ -245,35 +263,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(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 */ - 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 +303,76 @@ 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 insertChar(pos_type pos, value_type c, bool trackChanges); + void appendString(docstring const & s, Font const & font, + Change const & change); /// - void insertChar(pos_type pos, value_type c, - LyXFont const &, bool trackChanges); + void appendChar(char_type c, Font const & font, Change const & change); /// - void insertChar(pos_type pos, value_type c, - LyXFont const &, Change const & change); + void insertChar(pos_type pos, char_type c, bool trackChanges); /// - void insertInset(pos_type pos, Inset * inset, - Change const & change); + void insertChar(pos_type pos, char_type c, + Font const &, bool trackChanges); /// - void insertInset(pos_type pos, Inset * inset, - LyXFont const &, Change const & change); + void insertChar(pos_type pos, char_type c, + Font const &, Change const & change); + /// 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); + /// 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); /// - bool insetAllowed(Inset_code code); + Inset * getInset(pos_type 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); + /// - Inset * getInset(pos_type pos) { - return insetlist.get(pos); - } + InsetList const & insetList() const; /// - Inset const * getInset(pos_type pos) const { - return insetlist.get(pos); - } + void setBuffer(Buffer &); /// - bool isHfill(pos_type pos) const { - return isInset(pos) - && getInset(pos)->lyxCode() == Inset::HFILL_CODE; - } + 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 + /// True if the character/inset at this point is a word separator. + /// Note that digits in particular are not considered as word separator. + bool isWordSeparator(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) bool stripLeadingSpaces(bool trackChanges); @@ -356,35 +387,69 @@ 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(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); + + /// + 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; + + void locateWord(pos_type & from, pos_type & to, + word_location const loc) const; + /// + void updateWords(); + + /// Spellcheck word at position \p from and fill in found misspelled word + /// and \p suggestions if \p do_suggestion is true. + /// \return true if pointed word is misspelled. + bool spellCheck(pos_type & from, pos_type & to, WordLangTuple & wl, + docstring_list & suggestions, bool do_suggestion = true) const; + + /// Spellcheck word at position \p pos. + /// \return true if pointed word is misspelled. + bool isMisspelled(pos_type pos) const; + /// an automatically generated identifying label for this paragraph. + /// presently used only in the XHTML output routines. + std::string magicLabel() const; private: - + /// Expand the counters for the labelstring of \c layout + docstring expandParagraphLabel(Layout const &, BufferParams const &, + bool process_appendix) const; /// - 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_; + void deregisterWords(); + /// + void collectWords(); + /// + void registerWords(); /// Pimpl away stuff - class Pimpl; + class Private; /// - friend class Paragraph::Pimpl; + friend class Paragraph::Private; /// - Pimpl * pimpl_; + Private * d; }; } // namespace lyx