dbus/dbus-macros.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-macros.h  generic macros
   3  *
   4  * Copyright (C) 2002  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   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 #include <stddef.h>
  28
  29 #ifndef DBUS_MACROS_H
  30 #define DBUS_MACROS_H
  31
  32 #ifdef  __cplusplus
  33 #  define DBUS_BEGIN_DECLS  extern "C" {
  34 #  define DBUS_END_DECLS    }
  35 #else
  36 #  define DBUS_BEGIN_DECLS
  37 #  define DBUS_END_DECLS
  38 #endif
  39
  40 #ifndef TRUE
  41 #  define TRUE 1
  42 #endif
  43 #ifndef FALSE
  44 #  define FALSE 0
  45 #endif
  46
  47 #ifndef NULL
  48 #  ifdef __cplusplus
  49 #    define NULL        (0L)
  50 #  else /* !__cplusplus */
  51 #    define NULL        ((void*) 0)
  52 #  endif /* !__cplusplus */
  53 #endif
  54
  55 /* Normally docs are in .c files, but there isn't a .c file for this. */
  56 /**
  57  * @defgroup DBusMacros Utility macros
  58  * @ingroup  DBus
  59  * @brief #TRUE, #FALSE, #NULL, and so on
  60  *
  61  * Utility macros.
  62  *
  63  * @{
  64  */
  65
  66 /**
  67  * @def DBUS_BEGIN_DECLS
  68  *
  69  * Macro used prior to declaring functions in the D-Bus header
  70  * files. Expands to "extern "C"" when using a C++ compiler,
  71  * and expands to nothing when using a C compiler.
  72  */
  73 /**
  74  * @def DBUS_END_DECLS
  75  *
  76  * Macro used after declaring functions in the D-Bus header
  77  * files. Expands to "}" when using a C++ compiler,
  78  * and expands to nothing when using a C compiler.
  79  */
  80 /**
  81  * @def TRUE
  82  *
  83  * Expands to "1"
  84  */
  85 /**
  86  * @def FALSE
  87  *
  88  * Expands to "0"
  89  */
  90 /**
  91  * @def NULL
  92  *
  93  * A null pointer, defined appropriately for C or C++.
  94  */
  95
  96 /** @} */
  97
  98 #endif /* DBUS_MACROS_H */