]> git.lyx.org Git - lyx.git/blobdiff - src/support/types.h
Make tab movement visible (#10733)
[lyx.git] / src / support / types.h
index c7711d87b82a4dc15631091747c042ffd51aecd6..fc443dcf533e4b4443a153ae47d7ee6bfdb408eb 100644 (file)
@@ -8,34 +8,45 @@
  * indices wile trying to stay compatible with types used
  * by the standard containers.
  *
- * \author André Pönitz
+ * \author André Pönitz
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef LYX_TYPES_H
 #define LYX_TYPES_H
 
-// this probably could be improved by using <cstddef>...
-#include <vector>
+#include <cstddef>
 
-namespace lyx
-{
-       /// a type for positions used in paragraphs
-       // needs to be signed for a while to hold the special value -1 that is
-       // used there...
-       typedef std::vector<char>::difference_type   pos_type;
+namespace lyx {
 
+       /*!
+        * A type for positions used in paragraphs.
+        * Each position is either occupied by a single character or an inset.
+        * For insets, the placeholder META_INSET is stored in the paragraph
+        * text, and the actual insets are maintained separately.
+        */
+       // FIXME: should be unsigned, but needs to be signed for a while to
+       // hold the special value -1 that is used somewhere
+       // Note that the signed property is also used in loops counting to zero.
+       typedef ptrdiff_t  pos_type;
+
+       /*!
+        * A type for paragraph offsets.
+        * This is used to address paragraphs in ParagraphList, Text etc.
+        */
+       // FIXME: should be unsigned as well.
+       // however, simply changing it breaks a downward loop somewhere...
+       typedef ptrdiff_t  pit_type;
+
+       /// a type for the nesting depth of a paragraph
+       typedef size_t     depth_type;
 
 // set this to '0' if you want to have really safe types
 #if 1
 
        /// a type for sizes
-       typedef std::vector<char>::size_type         size_type;
-
-       /// a type used for numbering text classes
-       // used to be LyXTextClassList::size_type
-       typedef std::vector<char>::size_type         textclass_type;
+       typedef size_t     size_type;
 
 #else
 
@@ -45,35 +56,22 @@ namespace lyx
 
        struct size_type {
                ///
-               typedef std::vector<char>::size_type  base_type;
+               typedef size_t base_type;
                ///
                size_type(base_type t) { data_ = t; }
                ///
                operator base_type() const { return data_; }
                ///
-               private:
+       private:
                base_type data_;
        };
 
-       struct textclass_type {
-               ///
-               typedef std::vector<char>::size_type  base_type;
-               ///
-               textclass_type(base_type t) { data_ = t; }
-               ///
-               operator base_type() const { return data_; }
-               ///
-               private:
-               base_type data_;
-       };
-
-
 #endif
 
        ///
        enum word_location {
-               // the word around the cursor, only if the cursor is
-               //not at a boundary
+               /// the word around the cursor, only if the cursor is
+               //not at a boundary
                WHOLE_WORD_STRICT,
                // the word around the cursor
                WHOLE_WORD,
@@ -85,6 +83,14 @@ namespace lyx
                NEXT_WORD
        };
 
-}
+       ///
+       enum PageSides {
+               ///
+               OneSide,
+               ///
+               TwoSides
+       };
+
+} // namespace lyx
 
 #endif // LYX_TYPES_H