core.h

Go to the documentation of this file.

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license in the file COPYING
 * or http://www.opensource.org/licenses/CDDL-1.0.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file COPYING.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2023 Saso Kiselkov. All rights reserved.
 */
#ifndef _ACFUTILS_CORE_H_
#define _ACFUTILS_CORE_H_
 
#include <stdlib.h>
 
#include "libconfig.h"
 
#ifdef  __cplusplus
extern "C" {
#endif
 
#if __STDC_VERSION__ >= 202311L
 
#define UNUSED_ATTR     [[maybe_unused]]
#define WARN_UNUSED_RES_ATTR    [[nodiscard]]
#define DEPRECATED_ATTR     [[deprecated]]
 
#elif   defined(__GNUC__) || defined(__clang__)
 
#define UNUSED_ATTR     __attribute__((unused))
#define WARN_UNUSED_RES_ATTR    __attribute__((warn_unused_result))
#define DEPRECATED_ATTR     __attribute__((deprecated))
 
#if IBM && defined(__GNUC__) && __GNUC__ < 11
#define PACKED_ATTR     __attribute__((__packed__, gcc_struct))
#else
#define PACKED_ATTR     __attribute__((__packed__))
#endif
 
#else   // !defined(__GNUC__) && !defined(__clang__)
 
#define UNUSED_ATTR
#define WARN_UNUSED_RES_ATTR
#define PACKED_ATTR
#define DEPRECATED_ATTR
 
#endif  // !defined(__GNUC__) && !defined(__clang__)
 
#ifndef UNUSED
#define UNUSED(x)   (void)(x)
#endif
 
#define LACF_UNUSED(x)  (void)(x)
 
#if __STDC_VERSION__ >= 202311L
#define NODISCARD       [[nodiscard]]
#define NODISCARD_R(reason) [[nodiscard(reason)]]
#else   // !(__STDC_VERSION__ >= 202311L)
#define NODISCARD       WARN_UNUSED_RES_ATTR
#define NODISCARD_R(reason) WARN_UNUSED_RES_ATTR
#endif  // !(__STDC_VERSION__ >= 202311L)
 
#define ACFSYM(__sym__) __libacfutils_ ## __sym__
 
#if IBM && (!defined(__MINGW32__) || defined(ACFUTILS_DLL))
#define API_EXPORT  __declspec(dllexport)
#ifdef  ACFUTILS_BUILD
#define API_EXPORT_DATA __declspec(dllexport) extern
#else
#define API_EXPORT_DATA __declspec(dllimport) extern
#endif
#else   /* !IBM || (defined(__MINGW32__) && !defined(ACFUTILS_DLL)) */
#define API_EXPORT
#define API_EXPORT_DATA extern
#endif  /* !IBM || (defined(__MINGW32__) && !defined(ACFUTILS_DLL)) */
 
#ifdef  __cplusplus
# ifndef    restrict
#  if       defined(_MSC_VER)
#   define  restrict    __restrict
#  else
#   define  restrict    __restrict__
#  endif
# endif     /* !defined(restrict) */
#elif   __STDC_VERSION__ < 199901L
# ifndef    restrict
#  if   defined(__GNUC__) || defined(__clang__) || defined(_MSC_VER)
#   define  restrict    __restrict
#  else
#   define  restrict
#  endif
# endif     /* !defined(restrict) */
# ifndef    inline
#  if       defined(_MSC_VER)
#   define  inline  __inline
#  else
#   define  inline
#  endif
# endif     /* !defined(inline) */
#endif  /* __STDC_VERSION__ < 199901L */
 
API_EXPORT_DATA const char *libacfutils_version;
 
API_EXPORT void *lacf_malloc(size_t n);
#define LACF_DESTROY(ptr) \
    do { \
        if ((ptr) != NULL) { \
            lacf_free((ptr)); \
            (ptr) = NULL; \
        } \
    } while (0)
API_EXPORT void lacf_free(void *buf);
 
/*
 * Simple shorthand for calculating number of elements in an array at
 * compile time. Useful for arrays with flexible sizing.
 */
#define ARRAY_NUM_ELEM(_array) (sizeof (_array) / sizeof (*(_array)))
 
#ifdef  __cplusplus
}
#endif
 
#endif  /* _ACFUTILS_CORE_H_ */