dbus/dbus-types.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-types.h  types such as dbus_bool_t
   3  *
   4  * Copyright (C) 2002  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
  24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
  25 #endif
  26
  27 #ifndef DBUS_TYPES_H
  28 #define DBUS_TYPES_H
  29
  30 #include <stddef.h>
  31
  32 typedef unsigned int   dbus_bool_t;
  33 typedef unsigned short dbus_uint16_t;
  34 typedef short          dbus_int16_t;
  35 typedef unsigned int   dbus_uint32_t;
  36 typedef int            dbus_int32_t;
  37 typedef dbus_uint32_t  dbus_unichar_t;
  38
  39 /* Normally docs are in .c files, but there isn't a .c file for this. */
  40 /**
  41  * @defgroup DBusTypes Basic types
  42  * @ingroup  DBus
  43  * @brief dbus_bool_t, dbus_int32_t, etc.
  44  *
  45  * Typedefs for common primitive types.
  46  *
  47  * @{
  48  */
  49
  50 /**
  51  * @typedef dbus_bool_t
  52  *
  53  * A boolean, valid values are #TRUE and #FALSE.
  54  */
  55
  56 /**
  57  * @typedef dbus_uint32_t
  58  *
  59  * A 32-bit unsigned integer on all platforms.
  60  */
  61
  62 /**
  63  * @typedef dbus_int32_t
  64  *
  65  * A 32-bit signed integer on all platforms.
  66  */
  67
  68 /**
  69  * @typedef dbus_uint16_t
  70  *
  71  * A 16-bit unsigned integer on all platforms.
  72  */
  73
  74 /**
  75  * @typedef dbus_int16_t
  76  *
  77  * A 16-bit signed integer on all platforms.
  78  */
  79
  80
  81 /**
  82  * @typedef dbus_uint64_t
  83  *
  84  * A 64-bit unsigned integer on all platforms that support it.
  85  * If supported, #DBUS_HAVE_INT64 will be defined.
  86  *
  87  * C99 requires a 64-bit type and most likely all interesting
  88  * compilers support one. GLib for example flat-out requires
  89  * a 64-bit type.
  90  */
  91
  92 /**
  93  * @typedef dbus_int64_t
  94  *
  95  * A 64-bit signed integer on all platforms that support it.
  96  * If supported, #DBUS_HAVE_INT64 will be defined.
  97  *
  98  * C99 requires a 64-bit type and most likely all interesting
  99  * compilers support one. GLib for example flat-out requires
 100  * a 64-bit type.
 101  */
 102
 103 /**
 104  * @def DBUS_INT64_CONSTANT
 105  *
 106  * Declare a 64-bit signed integer constant. The macro
 107  * adds the necessary "LL" or whatever after the integer,
 108  * giving a literal such as "325145246765LL"
 109  */
 110
 111 /**
 112  * @def DBUS_UINT64_CONSTANT
 113  *
 114  * Declare a 64-bit unsigned integer constant. The macro
 115  * adds the necessary "ULL" or whatever after the integer,
 116  * giving a literal such as "325145246765ULL"
 117  */
 118
 119 /** @} */
 120
 121 #endif /* DBUS_TYPES_H */