X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FParagraph.h;h=f5d6a23b26f9b18f20f47542ab3a6c2cdf870c62;hb=612109bb6e5e61ba3c3693696f329eac3a288b5b;hp=8c3a8f9c70bcbcb1f937a023897551b331d93641;hpb=86618e2650b6b76ca2619ee84b93b4b70e4c24d4;p=lyx.git diff --git a/src/Paragraph.h b/src/Paragraph.h index 8c3a8f9c70..f5d6a23b26 100644 --- a/src/Paragraph.h +++ b/src/Paragraph.h @@ -17,13 +17,15 @@ #define PARAGRAPH_H #include "FontEnums.h" -#include "Layout.h" +#include "SpellChecker.h" #include "insets/InsetCode.h" #include "support/strfwd.h" #include "support/types.h" +#include + namespace lyx { class AuthorList; @@ -34,6 +36,7 @@ class Counters; class Cursor; class CursorSlice; class DocIterator; +class docstring_list; class DocumentClass; class Inset; class InsetBibitem; @@ -41,6 +44,7 @@ class LaTeXFeatures; class Inset_code; class InsetList; class Language; +class Layout; class Font; class Font_size; class MetricsInfo; @@ -49,6 +53,9 @@ class PainterInfo; class ParagraphParameters; class TexRow; class Toc; +class WordLangTuple; +class XHTMLStream; +class otexstream; class FontSpan { public: @@ -60,6 +67,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 inside(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 (inside(f.first)) + result.first = f.first; + else if (f.inside(first)) + result.first = first; + else + return result; + if (inside(f.last)) + result.last = f.last; + else if (f.inside(last)) + result.last = last; + return result; + } + + inline bool empty() const + { + return first > last; + } }; /// @@ -79,7 +128,8 @@ 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. }; @@ -89,7 +139,7 @@ class Paragraph public: /// Paragraph(); - /// + /// Copy constructor. Paragraph(Paragraph const &); /// Partial copy constructor. /// Copy the Paragraph contents from \p beg to \p end (without end). @@ -100,6 +150,8 @@ public: ~Paragraph(); /// int id() const; + /// + void setId(int id); /// void addChangesToToc(DocIterator const & cdit, Buffer const & buf) const; @@ -112,6 +164,8 @@ public: Language const * from, Language const * to); /// bool isMultiLingual(BufferParams const &) const; + /// + void getLanguages(std::set &) const; /// Convert the paragraph to a string. /// \param AsStringParameter options. This can contain any combination of @@ -123,6 +177,12 @@ public: /// docstring asString(pos_type beg, pos_type end, int options = AS_STR_NONE) const; + /// + void forToc(docstring &, size_t maxlen) 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(std::ostream &, BufferParams const &, @@ -130,10 +190,10 @@ public: /// void validate(LaTeXFeatures &) const; - /// - bool latex(BufferParams const &, Font const & outerfont, odocstream &, - TexRow & texrow, OutputParams const &, - int start_pos = 0, int end_pos = -1) const; + /// \param force means: output even if layout.inpreamble is true. + 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; @@ -141,8 +201,11 @@ public: /// Get the id of the paragraph, usefull for docbook 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 firstWord(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; + + /// 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, @@ -150,6 +213,13 @@ public: OutputParams const & runparams, 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; /// bool hasSameLayout(Paragraph const & par) const; @@ -162,14 +232,12 @@ public: /// Inset const & inInset() const; /// - InsetCode ownerCode() const; - /// - bool forcePlainLayout() const; - /// bool allowParagraphCustomization() const; /// bool usePlainLayout() const; /// + bool isPassThru() const; + /// pos_type size() const; /// bool empty() const; @@ -194,11 +262,13 @@ public: /// 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; + bool isChanged(pos_type pos) const; /// is there an insertion at the given pos ? bool isInserted(pos_type pos) const; /// is there a deletion at the given pos ? 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 +281,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 @@ -225,19 +295,16 @@ public: /// recompute this value void setBeginOfBody(); + /// + 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(Layout const &, BufferParams const &, - bool process_appendix = true) const; /// Actual paragraph alignment used char getAlign() const; /// The nesting depth of a paragraph @@ -346,13 +413,16 @@ public: 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; + /// 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; + /// 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) @@ -388,23 +458,61 @@ 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 updateWords(CursorSlice const & sl); + 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 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, + 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 true if both positions are inside the same + /// spell range - i.e. the same word. + /// use it for positions inside misspelled range only. + bool isSameSpellRange(pos_type pos1, pos_type pos2) 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); + + /// 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; /// void deregisterWords(); /// - void collectWords(CursorSlice const & sl); + void collectWords(); /// void registerWords();