include/libdispatch/base.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2009 Apple Inc. All rights reserved.
 *
 * @APPLE_APACHE_LICENSE_HEADER_START@
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * @APPLE_APACHE_LICENSE_HEADER_END@
 */

#ifndef __DISPATCH_BASE__
#define __DISPATCH_BASE__

#ifndef __DISPATCH_INDIRECT__
#error "Please #include <dispatch/dispatch.h> instead of this file directly."
#endif

#if defined(__cplusplus) && !defined(_MSC_VER)
/*
 * Dispatch objects are NOT C++ objects. Nevertheless, we can at least keep C++
 * aware of type compatibility.
 */
typedef struct dispatch_object_s {
private:
       dispatch_object_s();
       ~dispatch_object_s();
       dispatch_object_s(const dispatch_object_s &);
       void operator=(const dispatch_object_s &);
} *dispatch_object_t;
#else
# ifdef __GNUC__
typedef union {
    struct dispatch_object_s *_do;
    struct dispatch_continuation_s *_dc;
    struct dispatch_queue_s *_dq;
    struct dispatch_queue_attr_s *_dqa;
    struct dispatch_group_s *_dg;
    struct dispatch_source_s *_ds;
    struct dispatch_source_attr_s *_dsa;
    struct dispatch_semaphore_s *_dsema;
} dispatch_object_t __attribute__((transparent_union));
# else /* __GNUC__ */
// this is really really ugly but
// there is no transparent union in MSVC
struct dispatch_object_s;
typedef void* dispatch_object_t;
#endif /* __GNUC__ */
#endif

typedef void (*dispatch_function_t)(void *);

#if defined(__cplusplus) && !defined(_MSC_VER)
#define DISPATCH_DECL(name) typedef struct name##_s : public dispatch_object_s {} *name##_t
#else

#define DISPATCH_DECL(name) typedef struct name##_s *name##_t
#endif

#ifdef __GNUC__
# ifndef DISPATCH_NORETURN
#  define DISPATCH_NORETURN __attribute__((__noreturn__))
# endif
# define DISPATCH_NOTHROW __attribute__((__nothrow__))
# define DISPATCH_NONNULL1 __attribute__((__nonnull__(1)))
# define DISPATCH_NONNULL2 __attribute__((__nonnull__(2)))
# define DISPATCH_NONNULL3 __attribute__((__nonnull__(3)))
# define DISPATCH_NONNULL4 __attribute__((__nonnull__(4)))
# define DISPATCH_NONNULL5 __attribute__((__nonnull__(5)))
# define DISPATCH_NONNULL6 __attribute__((__nonnull__(6)))
# define DISPATCH_NONNULL7 __attribute__((__nonnull__(7)))
# if __clang__
// rdar://problem/6857843
#  define DISPATCH_NONNULL_ALL
# else
#  define DISPATCH_NONNULL_ALL __attribute__((__nonnull__))
# endif
# define DISPATCH_SENTINEL __attribute__((__sentinel__))
# define DISPATCH_PURE __attribute__((__pure__))
# define DISPATCH_WARN_RESULT __attribute__((__warn_unused_result__))
# define DISPATCH_MALLOC __attribute__((__malloc__))
# define DISPATCH_FORMAT(...) __attribute__((__format__(__VA_ARGS__)))
#else

# define DISPATCH_NORETURN

# define DISPATCH_NOTHROW

# define DISPATCH_NONNULL1

# define DISPATCH_NONNULL2

# define DISPATCH_NONNULL3

# define DISPATCH_NONNULL4

# define DISPATCH_NONNULL5

# define DISPATCH_NONNULL6

# define DISPATCH_NONNULL7

# define DISPATCH_NONNULL_ALL

# define DISPATCH_SENTINEL

# define DISPATCH_PURE

# define DISPATCH_WARN_RESULT

# define DISPATCH_MALLOC

# define DISPATCH_FORMAT(...)
#endif

#ifndef DISPATCH_EXPORT
# ifdef _WIN32
#  ifdef DISPATCH_MAKEDLL
#   define DISPATCH_EXPORT __declspec(dllexport)
#  else
#   define DISPATCH_EXPORT __declspec(dllimport)
#  endif
# else
#  define DISPATCH_EXPORT __attribute__((visibility("default")))
# endif
#endif

#ifndef DISPATCH_EXTERN
# ifdef _WIN32
#  define DISPATCH_EXTERN
# else
#  define DISPATCH_EXTERN extern
# endif
#endif

#ifndef DISPATCH_PTR
# ifdef _WIN32
#  define DISPATCH_PTR *
# else
#  define DISPATCH_PTR
# endif
#endif

#ifndef __OSX_AVAILABLE_STARTING
# define __OSX_AVAILABLE_STARTING(...)
#endif

#endif