X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FParagraph.h;h=d462f4c41356cfdbeb18468a744abfbeb8e8b062;hb=7b652117d6c956edd17f84d7d22a96419e7eccdc;hp=26389c6ced7e99529523c63b3b83c38c31ca5607;hpb=e4f2484cb5899da6d98e0be6db465ca011989e04;p=lyx.git diff --git a/src/Paragraph.h b/src/Paragraph.h index 26389c6ced..d462f4c413 100644 --- a/src/Paragraph.h +++ b/src/Paragraph.h @@ -17,10 +17,9 @@ #define PARAGRAPH_H #include "FontEnums.h" +#include "LayoutEnums.h" #include "SpellChecker.h" -#include "insets/InsetCode.h" - #include "support/strfwd.h" #include "support/types.h" @@ -41,20 +40,18 @@ class DocumentClass; class Inset; class InsetBibitem; class LaTeXFeatures; -class Inset_code; class InsetList; class Language; class Layout; class Font; -class Font_size; class MetricsInfo; class OutputParams; class PainterInfo; class ParagraphParameters; -class TexRow; -class Toc; +class TocBackend; class WordLangTuple; class XHTMLStream; +class otexstream; class FontSpan { public: @@ -66,6 +63,48 @@ public: public: /// Range including first and last. pos_type first, last; + + inline bool operator<(FontSpan const & s) const + { + return first < s.first; + } + + inline bool operator==(FontSpan const & s) const + { + return first == s.first && last == s.last; + } + + inline bool contains(pos_type p) const + { + return first <= p && p <= last; + } + + inline size_t size() const + { + return empty() ? 0 : last - first; + } + + + inline FontSpan intersect(FontSpan const & f) const + { + FontSpan result = FontSpan(); + if (contains(f.first)) + result.first = f.first; + else if (f.contains(first)) + result.first = first; + else + return result; + if (contains(f.last)) + result.last = f.last; + else if (f.contains(last)) + result.last = last; + return result; + } + + inline bool empty() const + { + return first > last; + } }; /// @@ -85,7 +124,9 @@ 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. + AS_STR_NEWLINES = 4, ///< Get also newline characters. + AS_STR_SKIPDELETE = 8, ///< Skip deleted text in change tracking. + AS_STR_PLAINTEXT = 16 ///< Don't export formatting when descending into insets. }; @@ -110,7 +151,12 @@ public: void setId(int id); /// - void addChangesToToc(DocIterator const & cdit, Buffer const & buf) const; + void addChangesToToc(DocIterator const & cdit, Buffer const & buf, + bool output_active, TocBackend & backend) const; + /// set the buffer flag if there are changes in the paragraph + void addChangesToBuffer(Buffer const & buf) const; + /// + bool isChangeUpdateRequired() const; /// Language const * getParLanguage(BufferParams const &) const; /// @@ -130,24 +176,26 @@ public: /// asString(AS_STR_LABEL | AS_STR_INSETS) /// asString(AS_STR_INSETS) docstring asString(int options = AS_STR_NONE) 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; + /// Convert the paragraph to a string. + /// \note If options includes AS_STR_PLAINTEXT, then runparams must be != 0 + docstring asString(pos_type beg, pos_type end, + int options = AS_STR_NONE, + const OutputParams *runparams = 0) const; + /// + void forOutliner(docstring &, size_t maxlen, bool shorten = true, + bool label = true) const; /// void write(std::ostream &, BufferParams const &, - depth_type & depth) const; + depth_type & depth) const; /// void validate(LaTeXFeatures &) const; /// \param force means: output even if layout.inpreamble is true. - void latex(BufferParams const &, Font const & outerfont, odocstream &, - TexRow & texrow, OutputParams const &, - int start_pos = 0, int end_pos = -1, bool force = false) const; + void latex(BufferParams const &, Font const & outerfont, otexstream &, + OutputParams const &, int start_pos = 0, int end_pos = -1, + bool force = false) const; /// Can we drop the standard paragraph wrapper? bool emptyTag() const; @@ -173,6 +221,8 @@ public: XHTMLStream & xs, OutputParams const & runparams, Font const & outerfont, + bool start_paragraph = true, + bool close_paragraph = true, pos_type initial = 0) const; /// @@ -190,6 +240,8 @@ public: /// bool usePlainLayout() const; /// + bool isPassThru() const; + /// pos_type size() const; /// bool empty() const; @@ -258,7 +310,7 @@ public: /// Set label width string. void setLabelWidthString(docstring const & s); /// Actual paragraph alignment used - char getAlign() const; + LyXAlignment getAlign() const; /// The nesting depth of a paragraph depth_type getDepth() const; /// The maximal possible depth of a paragraph after this one @@ -309,9 +361,6 @@ public: 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, Font const & font); - /// Returns the height of the highest font in range - 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); @@ -329,10 +378,6 @@ public: /// 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. @@ -353,6 +398,8 @@ public: InsetList const & insetList() const; /// void setBuffer(Buffer &); + /// + void resetBuffer(); /// bool isHfill(pos_type pos) const; @@ -361,6 +408,8 @@ public: bool isInset(pos_type pos) const; /// bool isNewline(pos_type pos) const; + /// + bool isEnvSeparator(pos_type pos) const; /// return true if the char is a word separator bool isSeparator(pos_type pos) const; /// @@ -372,6 +421,9 @@ public: bool isChar(pos_type pos) const; /// True if the element at this point is a space bool isSpace(pos_type pos) const; + /// True if the element at this point is a hard hyphen or a apostrophe + /// If it is enclosed by spaces return false + bool isHardHyphenOrApostrophe(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) @@ -383,12 +435,12 @@ public: /// return true if we allow this par to stay empty bool allowEmpty() const; /// - char_type transformChar(char_type c, pos_type pos) const; - /// ParagraphParameters & params(); /// ParagraphParameters const & params() const; + /// Check whether a call to fixBiblio is needed. + bool brokenBiblio() const; /// 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 @@ -396,7 +448,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(Buffer const & buffer); + int fixBiblio(Buffer const & buffer); /// For each author, set 'used' to true if there is a change /// by this author in the paragraph. @@ -407,15 +459,16 @@ public: pos_type & right, TextCase action); /// find \param str string inside Paragraph. - /// \return true if the specified string is at the specified position + /// \return non-zero if the specified string is at the specified + /// position; returned value is the actual match length in positions /// \param del specifies whether deleted strings in ct mode will be considered - bool find( + int 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; /// @@ -425,11 +478,29 @@ public: /// and \p suggestions if \p do_suggestion is true. /// \return result from spell checker, SpellChecker::UNKNOWN_WORD when misspelled. SpellChecker::Result spellCheck(pos_type & from, pos_type & to, WordLangTuple & wl, - docstring_list & suggestions, bool do_suggestion = true) const; + docstring_list & suggestions, bool do_suggestion = true, + bool check_learned = false) const; + + /// Spell checker status at position \p pos. + /// If \p check_boundary is true the status of position immediately + /// before \p pos is tested too if it is at word boundary. + /// \return true if one of the tested positions is misspelled. + bool isMisspelled(pos_type pos, bool check_boundary = false) const; + + /// \return the spell range (misspelled area) around position. + /// Range is empty if word at position is correctly spelled. + FontSpan const & getSpellRange(pos_type pos) const; + + /// spell check of whole paragraph + /// remember results until call of requestSpellCheck() + void spellCheck() const; + + /// query state of spell checker results + bool needsSpellCheck() const; + /// mark position of text manipulation to inform the spell checker + /// default value -1 marks the whole paragraph to be checked (again) + void requestSpellCheck(pos_type pos = -1); - /// 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;