src/support/types.h

   1 // -*- C++ -*-
   2 /**
   3  * \file types.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * Provide a set of typedefs for commonly used things like sizes and
   8  * indices wile trying to stay compatible with types used
   9  * by the standard containers.
  10  *
  11  * \author André Pönitz
  12  *
  13  * Full author contact details are available in file CREDITS.
  14  */
  15
  16 #ifndef LYX_TYPES_H
  17 #define LYX_TYPES_H
  18
  19 #include <cstddef>
  20
  21 namespace lyx {
  22
  23         /*!
  24          * A type for positions used in paragraphs.
  25          * Each position is either occupied by a single character or an inset.
  26          * For insets, the placeholder META_INSET is stored in the paragraph
  27          * text, and the actual insets are maintained separately.
  28          */
  29         // FIXME: should be unsigned, but needs to be signed for a while to
  30         // hold the special value -1 that is used somewhere
  31         // Note that the signed property is also used in loops counting to zero.
  32         typedef ptrdiff_t  pos_type;
  33
  34         /*!
  35          * A type for paragraph offsets.
  36          * This is used to address paragraphs in ParagraphList, Text etc.
  37          */
  38         // FIXME: should be unsigned as well.
  39         // however, simply changing it breaks a downward loop somewhere...
  40         typedef ptrdiff_t  pit_type;
  41
  42         /// a type for the nesting depth of a paragraph
  43         typedef size_t     depth_type;
  44
  45 // set this to '0' if you want to have really safe types
  46 #if 1
  47
  48         /// a type for sizes
  49         typedef size_t     size_type;
  50
  51 #else
  52
  53         // These structs wrap simple things to make them distinguishible
  54         // to the compiler.
  55         // It's a shame that different typedefs are not "really" different
  56
  57         struct size_type {
  58                 ///
  59                 typedef size_t base_type;
  60                 ///
  61                 size_type(base_type t) { data_ = t; }
  62                 ///
  63                 operator base_type() const { return data_; }
  64                 ///
  65         private:
  66                 base_type data_;
  67         };
  68
  69 #endif
  70
  71         ///
  72         enum word_location {
  73                 /// the word around the cursor, only if the cursor is
  74                 /// not at a boundary
  75                 WHOLE_WORD_STRICT,
  76                 // the word around the cursor
  77                 WHOLE_WORD,
  78                 /// the word begining from the cursor position
  79                 PARTIAL_WORD,
  80                 /// the word around the cursor or before the cursor
  81                 PREVIOUS_WORD,
  82                 /// the next word (not yet used)
  83                 NEXT_WORD
  84         };
  85
  86         ///
  87         enum PageSides {
  88                 ///
  89                 OneSide,
  90                 ///
  91                 TwoSides
  92         };
  93
  94 } // namespace lyx
  95
  96 #endif // LYX_TYPES_H