X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FParagraph.h;h=641cf27a59be7a4217626739083146ca92dd4362;hb=3d4076b598deb18660e50ec9c327efc3b15f15d0;hp=81a77288a8073a1ab0f163fd4b10c459f1edc43f;hpb=a5263e0f927034885870a65053ef3908d1c6f885;p=lyx.git diff --git a/src/Paragraph.h b/src/Paragraph.h index 81a77288a8..641cf27a59 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. */ @@ -17,15 +17,14 @@ #define PARAGRAPH_H #include "FontEnums.h" -#include "LayoutPtr.h" +#include "SpellChecker.h" #include "insets/InsetCode.h" #include "support/strfwd.h" #include "support/types.h" -// FIXME: would be nice to forward declare odocstream instead of -// including this: -#include "support/docstream.h" + +#include namespace lyx { @@ -34,12 +33,18 @@ 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 Layout; class Font; class Font_size; class MetricsInfo; @@ -47,7 +52,10 @@ class OutputParams; class PainterInfo; class ParagraphParameters; class TexRow; - +class Toc; +class WordLangTuple; +class XHTMLStream; +class otexstream; class FontSpan { public: @@ -59,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; + } }; /// @@ -72,21 +122,40 @@ 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. + AS_STR_SKIPDELETE = 8 ///< Skip deleted text in change tracking. +}; + + /// 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, + bool output_active) const; /// Language const * getParLanguage(BufferParams const &) const; /// @@ -96,37 +165,49 @@ 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 + /// 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 asString(pos_type beg, pos_type end, + int options = AS_STR_NONE) const; /// - docstring const asString(Buffer const & buffer, - pos_type beg, - pos_type end, - bool label) 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 const & runparams) const; /// - void write(Buffer const &, std::ostream &, BufferParams const &, - depth_type & depth) 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; + /// \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; /// 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; + + /// 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, @@ -134,6 +215,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; @@ -142,23 +230,30 @@ 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 allowParagraphCustomization() const; /// - bool forceDefaultParagraphs() const; - + bool usePlainLayout() const; + /// + bool isPassThru() 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 setPlainOrDefaultLayout(DocumentClass const & tc); /// - void layout(LayoutPtr const & new_layout); + void setDefaultLayout(DocumentClass const & tc); + /// + void setPlainLayout(DocumentClass const & tc); /// This is the item depth, only used by enumerate and itemize signed char itemdepth; @@ -169,11 +264,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? @@ -186,10 +283,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 @@ -201,18 +298,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(LayoutPtr const &, BufferParams const &, - bool process_appendix = true) const; /// Actual paragraph alignment used char getAlign() const; /// The nesting depth of a paragraph @@ -220,7 +314,7 @@ 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); @@ -234,10 +328,10 @@ public: 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. @@ -285,14 +379,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); /// @@ -306,6 +401,8 @@ public: /// InsetList const & insetList() const; + /// + void setBuffer(Buffer &); /// bool isHfill(pos_type pos) const; @@ -318,9 +415,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) @@ -338,6 +442,8 @@ public: /// 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 @@ -345,7 +451,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(bool track_changes); + int fixBiblio(Buffer const & buffer); /// For each author, set 'used' to true if there is a change /// by this author in the paragraph. @@ -353,19 +459,67 @@ public: /// 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 + /// \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; + /// + 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(); + /// + void registerWords(); + /// Pimpl away stuff class Private; ///