nsz Git - libfirm/blob - include/libfirm/begin.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Should be included in all public firm headers at the beginning
  23  * @author      Matthias Braun
  24  * @version     $Id$
  25  */
  26 #ifndef FIRM_BEGIN_H
  27 #define FIRM_BEGIN_H
  28
  29 /**
  30  * @def FIRM_API
  31  * Declaration specifier which marks a function/variable as being publicly
  32  * visible outside the firm library/dll
  33  */
  34 #ifdef FIRM_DLL
  35         #ifdef FIRM_BUILD
  36                 #ifdef _WIN32
  37                         #define FIRM_API extern __declspec(dllexport)
  38                 #else
  39                         #define FIRM_API extern __attribute__((visibility("default")))
  40                 #endif
  41         #else
  42                 #ifdef _WIN32
  43                         #define FIRM_API extern __declspec(dllimport)
  44                 #else
  45                         #define FIRM_API extern
  46                 #endif
  47         #endif
  48 #else
  49         #define  FIRM_API extern
  50 #endif
  51
  52 #ifdef __cplusplus
  53 # define FIRM_NOTHROW throw ()
  54 #else
  55 # define FIRM_NOTHROW
  56 #endif
  57
  58 /**
  59  * @def FIRM_PRINTF
  60  * Attribute with marks a function to have a printf style format
  61  * string and variadic argument.
  62  */
  63 #if defined(__GNUC__)
  64 # define FIRM_PRINTF(a,b) __attribute__((__format__(__printf__, a, b)))
  65 #else
  66 # define FIRM_PRINTF(a,b)
  67 #endif
  68
  69 #endif
  70
  71 /* mark declarations as C function (note that we always need this,
  72  * so don't put it in the include guard) */
  73 #ifdef __cplusplus
  74 extern "C" {
  75 #endif