* add PreBabelPreamble to Language definition (fixes #4786).

[lyx.git] / src / Paragraph.h

diff --git a/src/Paragraph.h b/src/Paragraph.h
index 426783afd35562d877f1c0223c55a244950700c1..2c2e77246fc1c951d03da27171da2be5bad06b94 100644 (file)
--- 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 <set>
+
 namespace lyx {
 
 class AuthorList;
@@ -42,6 +44,7 @@ class LaTeXFeatures;
 class Inset_code;
 class InsetList;
 class Language;
+class Layout;
 class Font;
 class Font_size;
 class MetricsInfo;
@@ -51,6 +54,7 @@ class ParagraphParameters;
 class TexRow;
 class Toc;
 class WordLangTuple;
+class XHTMLStream;
 
 class FontSpan {
 public:
@@ -62,6 +66,22 @@ 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;
+       }
+
 };
 
 ///
@@ -81,7 +101,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.
 };
 
 
@@ -91,7 +112,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,6 +123,8 @@ public:
        ~Paragraph();
        ///
        int id() const;
+       ///
+       void setId(int id);
 
        ///
        void addChangesToToc(DocIterator const & cdit, Buffer const & buf) const;
@@ -114,6 +137,8 @@ public:
                            Language const * from, Language const * to);
        ///
        bool isMultiLingual(BufferParams const &) const;
+       ///
+       void getLanguages(std::set<Language const *> &) const;
 
        /// Convert the paragraph to a string.
        /// \param AsStringParameter options. This can contain any combination of
@@ -136,10 +161,10 @@ public:
        ///
        void validate(LaTeXFeatures &) const;
 
-       ///
-       bool latex(BufferParams const &, Font const & outerfont, odocstream &,
+       /// \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) const;
+                  int start_pos = 0, int end_pos = -1, bool force = false) const;
 
        /// Can we drop the standard paragraph wrapper?
        bool emptyTag() const;
@@ -151,7 +176,7 @@ public:
        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(odocstream & os, OutputParams const & runparams) const;
+       pos_type firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams) const;
 
        /// Writes to stream the docbook representation
        void simpleDocBookOnePar(Buffer const & buf,
@@ -162,7 +187,7 @@ public:
        /// \return any material that has had to be deferred until after the
        /// paragraph has closed.
        docstring simpleLyXHTMLOnePar(Buffer const & buf,
-                                odocstream &,
+                                XHTMLStream & xs,
                                 OutputParams const & runparams,
                                 Font const & outerfont,
                                 pos_type initial = 0) const;
@@ -178,10 +203,6 @@ public:
        ///
        Inset const & inInset() const;
        ///
-       InsetCode ownerCode() const;
-       ///
-       bool forcePlainLayout() const;
-       ///
        bool allowParagraphCustomization() const;
        ///
        bool usePlainLayout() const;
@@ -243,16 +264,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);
-       /// 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
@@ -419,15 +440,33 @@ public:
 
        /// Spellcheck word at position \p from and fill in found misspelled word
        /// and \p suggestions if \p do_suggestion is true.
-       /// \return true if pointed word is misspelled.
-       bool spellCheck(pos_type & from, pos_type & to, WordLangTuple & wl,
-               docstring_list & suggestions, bool do_suggestion =  true) const;
+       /// \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;
 
-       /// Spellcheck word at position \p pos.
-       /// \return true if pointed word is misspelled.
+       /// Spell checker status at position \p pos.
+       /// \return true if pointed position is misspelled.
        bool isMisspelled(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;
+
 private:
+       /// Expand the counters for the labelstring of \c layout
+       docstring expandParagraphLabel(Layout const &, BufferParams const &,
+               bool process_appendix) const;
        ///
        void deregisterWords();
        ///