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