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         // Specifically, TexRow::getDocIteratorsFromEntries uses negative pos
  32         // the way Python does: counting from the end. So maybe this should just
  33         // be signed.
  34         // Note that the signed property is also used in loops counting to zero.
  35         typedef ptrdiff_t  pos_type;
  36
  37         /*!
  38          * A type for paragraph offsets.
  39          * This is used to address paragraphs in ParagraphList, Text etc.
  40          */
  41         // FIXME: should be unsigned as well.
  42         // however, simply changing it breaks a downward loop somewhere...
  43         typedef ptrdiff_t  pit_type;
  44
  45         /// a type for the nesting depth of a paragraph
  46         typedef size_t     depth_type;
  47
  48 // set this to '0' if you want to have really safe types
  49 #if 1
  50
  51         /// a type for sizes
  52         typedef size_t     size_type;
  53
  54 #else
  55
  56         // These structs wrap simple things to make them distinguishible
  57         // to the compiler.
  58         // It's a shame that different typedefs are not "really" different
  59
  60         struct size_type {
  61                 ///
  62                 typedef size_t base_type;
  63                 ///
  64                 size_type(base_type t) { data_ = t; }
  65                 ///
  66                 operator base_type() const { return data_; }
  67                 ///
  68         private:
  69                 base_type data_;
  70         };
  71
  72 #endif
  73
  74         ///
  75         enum word_location {
  76                 /// the word around the cursor, only if the cursor is
  77                 /// not at a boundary
  78                 WHOLE_WORD_STRICT,
  79                 // the word around the cursor
  80                 WHOLE_WORD,
  81                 /// the word beginning from the cursor position
  82                 PARTIAL_WORD,
  83                 /// the word around the cursor or before the cursor
  84                 PREVIOUS_WORD,
  85                 /// the next word (not yet used)
  86                 NEXT_WORD
  87         };
  88
  89         ///
  90         enum PageSides {
  91                 ///
  92                 OneSide,
  93                 ///
  94                 TwoSides
  95         };
  96
  97 } // namespace lyx
  98
  99 #endif // LYX_TYPES_H