macros.h

// -*- mode: cpp; mode: fold -*-
// SPDX-License-Identifier: GPL-2.0+
// Description                                                          /*{{{*/
/* ######################################################################
 
   Macros Header - Various useful macro definitions
 
   This file had this historic note, but now includes further changes
   under the GPL-2.0+:
 
   This source is placed in the Public Domain, do with it what you will
   It was originally written by Brian C. White.
 
   ##################################################################### */
                                                                        /*}}}*/
// Private header
#ifndef MACROS_H
#define MACROS_H
 
#ifdef __GNUC__
#define APT_GCC_VERSION (__GNUC__ << 8 | __GNUC_MINOR__)
#else
#define APT_GCC_VERSION 0
#endif
 
#ifdef APT_COMPILING_APT
/* likely() and unlikely() can be used to mark boolean expressions
   as (not) likely true which will help the compiler to optimise */
#if APT_GCC_VERSION >= 0x0300
        #define likely(x)       __builtin_expect (!!(x), 1)
        #define unlikely(x)     __builtin_expect (!!(x), 0)
#else
        #define likely(x)       (x)
        #define unlikely(x)     (x)
#endif
#endif
 
#if APT_GCC_VERSION >= 0x0300
        // __attribute__((const)) is too dangerous for us, we end up using it wrongly
        #define APT_PURE        __attribute__((pure))
        #define APT_PRINTF(n)   __attribute__((format(printf, n, n + 1)))
        #define APT_WEAK        __attribute__((weak));
#else
        #define APT_PURE
        #define APT_PRINTF(n)
        #define APT_WEAK
#endif
 
#if APT_GCC_VERSION > 0x0302
        #define APT_NONNULL(...)        __attribute__((nonnull(__VA_ARGS__)))
#else
        #define APT_NONNULL(...)
#endif
 
#if APT_GCC_VERSION >= 0x0400
        #define APT_SENTINEL    __attribute__((sentinel))
        #define APT_PUBLIC __attribute__ ((visibility ("default")))
        #define APT_HIDDEN __attribute__ ((visibility ("hidden")))
#else
        #define APT_SENTINEL
        #define APT_PUBLIC
        #define APT_HIDDEN
#endif
 
// cold functions are unlikely() to be called
#if APT_GCC_VERSION >= 0x0403
        #define APT_COLD        __attribute__ ((__cold__))
        #define APT_HOT         __attribute__ ((__hot__))
#else
        #define APT_COLD
        #define APT_HOT
#endif
 
 
#if __GNUC__ >= 4
        #define APT_IGNORE_DEPRECATED_PUSH \
                _Pragma("GCC diagnostic push") \
                _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
        #define APT_IGNORE_DEPRECATED_POP \
                _Pragma("GCC diagnostic pop")
#else
        #define APT_IGNORE_DEPRECATED_PUSH
        #define APT_IGNORE_DEPRECATED_POP
#endif
 
// These lines are extracted by the makefiles and the buildsystem
// Increasing MAJOR or MINOR results in the need of recompiling all
// reverse-dependencies of libapt-pkg against the new SONAME.
// Non-ABI-Breaks should only increase RELEASE number.
// See also buildlib/libversion.mak
#define APT_PKG_MAJOR 7
#define APT_PKG_MINOR 0
#define APT_PKG_RELEASE 0
#define APT_PKG_ABI ((APT_PKG_MAJOR * 100) + APT_PKG_MINOR)
 
/* Should be a multiple of the common page size (4096) */
static constexpr unsigned long long APT_BUFFER_SIZE = 64 * 1024;
 
template <class F>
struct AptScopeWrapper {
   F func;
   ~AptScopeWrapper() { func(); }
};
template <class F>
AptScopeWrapper(F) -> AptScopeWrapper<F>;
#define APT_PASTE2(a, b) a##b
#define APT_PASTE(a, b) APT_PASTE2(a, b)
#define DEFER(lambda) AptScopeWrapper APT_PASTE(defer, __LINE__){lambda};
 
 
#ifndef APT_COMPILING_APT
#endif
#endif