summaryrefslogtreecommitdiffstats
path: root/src/libknot/attribute.h
blob: ce464fc2dc34b3faba2aaceeb4b46970c4407bb3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/*  Copyright (C) 2024 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

/*!
 * \file
 *
 * \brief Function and variable attributes.
 *
 * \addtogroup libknot
 * @{
 */

#pragma once

/*! \brief Library visibility macros. */
#define _public_ __attribute__((visibility("default")))
#define _hidden_ __attribute__((visibility("hidden")))

#define _unused_ __attribute__((unused))

#define _cleanup_(var) __attribute__((cleanup(var)))

/*! \brief GNU C function attributes. */
#if __GNUC__ >= 3
#define _pure_         __attribute__ ((pure))
#define _const_        __attribute__ ((const))
#define _noreturn_     __attribute__ ((noreturn))
#define _malloc_       __attribute__ ((malloc))
#define _mustcheck_    __attribute__ ((warn_unused_result))
#define _nonnull_(...) __attribute__ ((nonnull(__VA_ARGS__)))
#else
#define _pure_
#define _const_
#define _noreturn_
#define _malloc_
#define _mustcheck_
#define _nonnull_
#endif

/*! @} */