include/fribidi/fribidi-common.h

0001 /* FriBidi
0002  * fribidi-common.h - common include for library headers
0003  *
0004  * Author:
0005  *   Behdad Esfahbod, 2004
0006  *
0007  * Copyright (C) 2004 Sharif FarsiWeb, Inc.
0008  *
0009  * This library is free software; you can redistribute it and/or
0010  * modify it under the terms of the GNU Lesser General Public
0011  * License as published by the Free Software Foundation; either
0012  * version 2.1 of the License, or (at your option) any later version.
0013  *
0014  * This library is distributed in the hope that it will be useful,
0015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0017  * Lesser General Public License for more details.
0018  *
0019  * You should have received a copy of the GNU Lesser General Public License
0020  * along with this library, in a file named COPYING; if not, write to the
0021  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0022  * Boston, MA 02110-1301, USA
0023  *
0024  * For licensing issues, contact <fribidi.license@gmail.com>.
0025  */
0026 #ifndef _FRIBIDI_COMMON_H
0027 #define _FRIBIDI_COMMON_H
0028
0029 #ifdef DONT_HAVE_FRIBIDI_CONFIG_H
0030 # define FRIBIDI "fribidi"
0031 # define FRIBIDI_NAME "fribidi"
0032 # define FRIBIDI_VERSION "unknown"
0033 # define FRIBIDI_BUGREPORT "unknown"
0034 # define FRIBIDI_INTERFACE_VERSION_STRING "unknown"
0035 #else /* !DONT_HAVE_FRIBIDI_CONFIG_H */
0036 # include "fribidi-config.h"
0037 #endif /* !DONT_HAVE_FRIBIDI_CONFIG_H */
0038
0039 #ifdef HAVE_FRIBIDI_CUSTOM_H
0040 # include <fribidi-custom.h>
0041 #endif /* HAVE_FRIBIDI_CUSTOM_H */
0042
0043
0044 /* FRIBIDI_ENTRY is a macro used to declare library entry points. */
0045 #ifndef FRIBIDI_LIB_STATIC
0046 # ifndef FRIBIDI_ENTRY
0047 #  ifdef _WIN32
0048 #   ifdef FRIBIDI_BUILD
0049 #     define FRIBIDI_ENTRY __declspec(dllexport)
0050 #   else
0051 #     define FRIBIDI_ENTRY __declspec(dllimport)
0052 #   endif
0053 #  elif (defined(__SUNPRO_C)  || defined(__SUNPRO_CC))
0054 #   define FRIBIDI_ENTRY __global
0055 #  else
0056 #   if (defined(__GNUC__) && __GNUC__ >= 4) || defined(__ICC)
0057 #     define FRIBIDI_ENTRY __attribute__ ((visibility("default")))
0058 #   else
0059 #    define FRIBIDI_ENTRY
0060 #   endif
0061 #  endif
0062 # endif
0063 #else
0064 # ifndef FRIBIDI_ENTRY
0065 #   define FRIBIDI_ENTRY
0066 # endif
0067 #endif
0068
0069 #define FRIBIDI_EXTERN extern
0070
0071 #ifdef __ICC
0072 #define FRIBIDI_BEGIN_IGNORE_DEPRECATIONS               \
0073   _Pragma ("warning (push)")                            \
0074   _Pragma ("warning (disable:1478)")
0075 #define FRIBIDI_END_IGNORE_DEPRECATIONS         \
0076   _Pragma ("warning (pop)")
0077 #elif    __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
0078 #define FRIBIDI_BEGIN_IGNORE_DEPRECATIONS       \
0079   _Pragma ("GCC diagnostic push")           \
0080   _Pragma ("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
0081 #define FRIBIDI_END_IGNORE_DEPRECATIONS         \
0082   _Pragma ("GCC diagnostic pop")
0083 #elif defined (_MSC_VER) && (_MSC_VER >= 1500)
0084 #define FRIBIDI_BEGIN_IGNORE_DEPRECATIONS       \
0085   __pragma (warning (push))                             \
0086   __pragma (warning (disable : 4996))
0087 #define FRIBIDI_END_IGNORE_DEPRECATIONS         \
0088   __pragma (warning (pop))
0089 #elif defined (__clang__)
0090 #define FRIBIDI_BEGIN_IGNORE_DEPRECATIONS               \
0091   _Pragma("clang diagnostic push")                      \
0092   _Pragma("clang diagnostic ignored \"-Wdeprecated-declarations\"")
0093 #define FRIBIDI_END_IGNORE_DEPRECATIONS \
0094   _Pragma("clang diagnostic pop")
0095 #else
0096 #define FRIBIDI_BEGIN_IGNORE_DEPRECATIONS
0097 #define FRIBIDI_END_IGNORE_DEPRECATIONS
0098 #endif
0099
0100 #if (defined(__GNUC__) && (__GNUC__ > 2)) && ! defined(_WIN32)
0101 # define FRIBIDI_GNUC_WARN_UNUSED __attribute__((__warn_unused_result__))
0102 # define FRIBIDI_GNUC_MALLOC      __attribute__((__malloc__))
0103 # define FRIBIDI_GNUC_HIDDEN      __attribute__((__visibility__ ("hidden")))
0104 # define FRIBIDI_GNUC_CONST       __attribute__((__const__))
0105 # define FRIBIDI_GNUC_DEPRECATED  __attribute__((__unused__))
0106 #else /* __GNUC__ */
0107 # define FRIBIDI_GNUC_WARN_UNUSED
0108 # define FRIBIDI_GNUC_MALLOC
0109 # define FRIBIDI_GNUC_HIDDEN
0110 # define FRIBIDI_GNUC_CONST
0111 # define FRIBIDI_GNUC_DEPRECATED
0112 #endif  /* __GNUC__ */
0113
0114 /* FRIBIDI_BEGIN_DECLS should be used at the beginning of your declarations,
0115  * so that C++ compilers don't mangle their names.  Use FRIBIDI_END_DECLS at
0116  * the end of C declarations. */
0117 #ifndef FRIBIDI_BEGIN_DECLS
0118 # ifdef __cplusplus
0119 #  define FRIBIDI_BEGIN_DECLS extern "C" {
0120 #  define FRIBIDI_END_DECLS }
0121 # else /* !__cplusplus */
0122 #  define FRIBIDI_BEGIN_DECLS   /* empty */
0123 #  define FRIBIDI_END_DECLS /* empty */
0124 # endif /* !__cplusplus */
0125 #endif /* !FRIBIDI_BEGIN_DECLS */
0126
0127
0128
0129
0130 /* fribidi_debug_status - get current debug state
0131  *
0132  */
0133 FRIBIDI_ENTRY int fribidi_debug_status (
0134   void
0135 );
0136
0137 /* fribidi_set_debug - set debug state
0138  *
0139  */
0140 FRIBIDI_ENTRY int
0141 fribidi_set_debug (
0142   int state     /* new state to set */
0143 );
0144
0145
0146
0147
0148
0149
0150
0151
0152
0153
0154
0155 #endif /* !_FRIBIDI_COMMON_H */
0156 /* Editor directions:
0157  * vim:textwidth=78:tabstop=8:shiftwidth=2:autoindent:cindent
0158  */