]> git.lyx.org Git - lyx.git/blobdiff - src/Paragraph.h
Fix selection of unmarked RtL text
[lyx.git] / src / Paragraph.h
index de10791fb3b7dde756e65ad3e47713dc424f092a..31157b5ea2a38914cbd6aab5763f2397c59d12fb 100644 (file)
 #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:
@@ -71,17 +68,43 @@ public:
        {
                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
+
+       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;
+       }
 };
 
 ///
@@ -102,7 +125,8 @@ enum AsStringParameter
        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.
+       AS_STR_SKIPDELETE = 8, ///< Skip deleted text in change tracking.
+       AS_STR_PLAINTEXT = 16 ///< Don't export formatting when descending into insets.
 };
 
 
@@ -127,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;
        ///
@@ -147,26 +176,26 @@ public:
        ///             asString(AS_STR_LABEL | AS_STR_INSETS)
        ///             asString(AS_STR_INSETS)
        docstring asString(int options = AS_STR_NONE) 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;
+                          int options = AS_STR_NONE,
+                          const OutputParams *runparams = 0) 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 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;
@@ -192,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;
 
        ///
@@ -209,6 +240,8 @@ public:
        ///
        bool usePlainLayout() const;
        ///
+       bool isPassThru() const;
+       ///
        pos_type size() const;
        ///
        bool empty() const;
@@ -277,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
@@ -325,12 +358,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);
@@ -348,10 +379,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.
@@ -372,6 +399,8 @@ public:
        InsetList const & insetList() const;
        ///
        void setBuffer(Buffer &);
+       ///
+       void resetBuffer();
 
        ///
        bool isHfill(pos_type pos) const;
@@ -380,6 +409,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;
        ///
@@ -391,6 +422,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)
@@ -402,12 +436,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
@@ -415,7 +449,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.
@@ -435,7 +469,7 @@ public:
                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;
        ///
@@ -449,8 +483,14 @@ public:
                bool check_learned = false) const;
 
        /// Spell checker status at position \p pos.
-       /// \return true if pointed position is misspelled.
-       bool isMisspelled(pos_type pos) const;
+       /// 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()
@@ -466,6 +506,10 @@ public:
        /// 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 &,