X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FParagraph.h;h=ca88dd774e9d48e7f0472b8db35972899af5c0d0;hb=75d731c9d8eacac6382ce41ff254d015fe3c6b5c;hp=dec527cbc85590ec8963ad4d5b11057e514d81a7;hpb=694399b16c604d172a1441639e2309baf1afb7fc;p=lyx.git diff --git a/src/Paragraph.h b/src/Paragraph.h index dec527cbc8..ca88dd774e 100644 --- a/src/Paragraph.h +++ b/src/Paragraph.h @@ -16,41 +16,39 @@ #ifndef PARAGRAPH_H #define PARAGRAPH_H -#include "FontEnums.h" -#include "Layout.h" - -#include "insets/InsetCode.h" +#include "LayoutEnums.h" +#include "SpellChecker.h" #include "support/strfwd.h" #include "support/types.h" +#include +#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 Layout; class Font; -class Font_size; -class MetricsInfo; class OutputParams; -class PainterInfo; class ParagraphParameters; -class TexRow; -class Toc; +class TocBackend; class WordLangTuple; +class XMLStream; +class otexstream; + +/// Inset identifier (above 0x10ffff, for ucs-4) +char_type const META_INSET = 0x200001; class FontSpan { public: @@ -62,6 +60,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; + } }; /// @@ -81,7 +121,10 @@ 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. + AS_STR_MATHED = 32 ///< Use a format suitable for mathed (eg. for InsetRef). }; @@ -91,7 +134,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). @@ -102,9 +145,12 @@ public: ~Paragraph(); /// int id() const; + /// + 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; /// Language const * getParLanguage(BufferParams const &) const; /// @@ -114,6 +160,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 @@ -122,50 +170,57 @@ 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; - /// - 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; - /// Get the id of the paragraph, usefull for docbook + /// Get the id of the paragraph, useful for DocBook std::string getID(Buffer const & buf, 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; + pos_type firstWordDocBook(XMLStream & xs, OutputParams const & runparams) const; /// Output the first word of a paragraph, return the position where it left. - pos_type firstWordLyXHTML(odocstream & os, OutputParams const & runparams) const; - - /// Writes to stream the docbook representation - void simpleDocBookOnePar(Buffer const & buf, - odocstream &, - OutputParams const & runparams, - Font const & outerfont, - pos_type initial = 0) const; + pos_type firstWordLyXHTML(XMLStream & xs, OutputParams const & runparams) const; + + /// Outputs to stream the DocBook representation, one element per paragraph. + std::tuple, std::vector, std::vector> + simpleDocBookOnePar(Buffer const & buf, + OutputParams const & runparams, + Font const & outerfont, + pos_type initial = 0, + bool is_last_par = false, + bool ignore_fonts = false) const; + /// \return any material that has had to be deferred until after the /// paragraph has closed. docstring simpleLyXHTMLOnePar(Buffer const & buf, - odocstream &, - OutputParams const & runparams, - Font const & outerfont, - pos_type initial = 0) const; + XMLStream & xs, + OutputParams const & runparams, + Font const & outerfont, + bool start_paragraph = true, + bool close_paragraph = true, + pos_type initial = 0) const; /// bool hasSameLayout(Paragraph const & par) const; @@ -178,14 +233,16 @@ public: /// Inset const & inInset() const; /// - InsetCode ownerCode() const; - /// - bool forcePlainLayout() const; - /// bool allowParagraphCustomization() const; /// bool usePlainLayout() const; /// + bool isPassThru() const; + /// + bool parbreakIsNewline() const; + /// + bool isPartOfTextSequence() const; + /// pos_type size() const; /// bool empty() const; @@ -207,20 +264,28 @@ public: /// look up change at given pos Change const & lookupChange(pos_type pos) const; - /// is there a change within the given range ? + /// is there a change within the given range (does not + /// check contained paragraphs) bool isChanged(pos_type start, pos_type end) const; + /// Are there insets containing changes in the range? + bool hasChangedInsets(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 a change in the paragraph ? + bool isChanged() 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 isFullyDeleted(pos_type start, pos_type end) const; + 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? bool isMergedOnEndOfParDeletion(bool trackChanges) const; + /// Return Change form of paragraph break + Change parEndChange() const; /// set change for the entire par void setChange(Change const & change); @@ -229,10 +294,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 @@ -243,21 +308,18 @@ public: /// recompute this value void setBeginOfBody(); + /// + docstring expandLabel(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; + LyXAlignment getAlign(BufferParams const &) const; + /// Default paragraph alignment as determined by layout + LyXAlignment getDefaultAlign(BufferParams const &) const; /// The nesting depth of a paragraph depth_type getDepth() const; /// The maximal possible depth of a paragraph after this one @@ -282,12 +344,8 @@ public: /// 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 FONT_INHERIT, FONT_IGNORE or - FONT_TOGGLE. + /** Get fully instantiated font, i.e., one that does not have any + attributes with values FONT_INHERIT, FONT_IGNORE or FONT_TOGGLE. */ Font const getFont(BufferParams const &, pos_type pos, Font const & outerfont) const; @@ -305,12 +363,10 @@ public: /// char_type getChar(pos_type pos) const; /// Get the char, but mirror all bracket characters if it is right-to-left - char_type getUChar(BufferParams const &, pos_type pos) const; + char_type getUChar(BufferParams const &, OutputParams 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); @@ -328,10 +384,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. @@ -351,7 +403,9 @@ public: /// InsetList const & insetList() const; /// - void setBuffer(Buffer &); + void setInsetBuffers(Buffer &); + /// + void resetBuffer(); /// bool isHfill(pos_type pos) const; @@ -360,17 +414,25 @@ 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; /// bool isLineSeparator(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; + bool isWordSeparator(pos_type pos, bool const ignore_deleted = false) 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; + /// Return true if this paragraph has verbatim content that needs to be + /// protected by \cprotect + bool needsCProtection(bool const fragile = false) 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) @@ -382,12 +444,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 @@ -395,7 +457,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. @@ -406,30 +468,60 @@ 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; + word_location const loc, bool const ignore_deleted = false) const; /// void updateWords(); - /// Spellcheck word at position \p from and fill in found misspelled word. - /// \return true if pointed word is misspelled. - bool spellCheck(pos_type & from, pos_type & to, WordLangTuple & wl, - docstring_list & suggestions) const; - - /// Spellcheck word at position \p pos. - /// \return true if pointed word is misspelled. - bool isMisspelled(pos_type pos) const; + /// 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 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); + + /// an automatically generated identifying label for this paragraph. + /// presently used only in the XHTML output routines. + std::string magicLabel() const; + + /// anonymizes the paragraph contents (but not the paragraphs + /// contained inside it. Does not handle undo. + void anonymize(); private: + /// Expand the counters for the labelstring of \c layout + docstring expandParagraphLabel(Layout const &, BufferParams const &, + bool process_appendix) const; /// void deregisterWords(); ///