112 lines
3.0 KiB
C
112 lines
3.0 KiB
C
/*
|
|
* Brickworks
|
|
*
|
|
* Copyright (C) 2022 Orastron Srl unipersonale
|
|
*
|
|
* Brickworks 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, version 3 of the License.
|
|
*
|
|
* Brickworks 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 Brickworks. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* File author: Stefano D'Angelo
|
|
*/
|
|
|
|
/*!
|
|
* module_type {{{ foundation }}}
|
|
* version {{{ 0.4.0 }}}
|
|
* requires {{{ bw_config }}}
|
|
* description {{{
|
|
* A common header to make sure that a bunch of basic definitions are
|
|
* available and consistent for all Brickworks modules.
|
|
* }}}
|
|
* changelog {{{
|
|
* <ul>
|
|
* <li>Version <strong>0.4.0</strong>:
|
|
* <ul>
|
|
* <li>Added `BW_SIZE_T`.</li>
|
|
* </ul>
|
|
* </li>
|
|
* <li>Version <strong>0.2.0</strong>:
|
|
* <ul>
|
|
* <li>Removed `BW_MALLOC`, `BW_REALLOC`, and `BW_FREE`.</li>
|
|
* <li>Added `BW_RESTRICT`.</li>
|
|
* </ul>
|
|
* </li>
|
|
* <li>Version <strong>0.1.0</strong>:
|
|
* <ul>
|
|
* <li>First release.</li>
|
|
* </ul>
|
|
* </li>
|
|
* </ul>
|
|
* }}}
|
|
*/
|
|
|
|
#ifndef _BW_COMMON_H
|
|
#define _BW_COMMON_H
|
|
|
|
/*! api {{{
|
|
* #### bw_config
|
|
* At its very beginning, this header `#include`s `<bw_config.h>`, which is
|
|
* a file you can use to supply custom `#include`s and `#define`s that
|
|
* override defaults (see [bw_config](bw_config)).
|
|
*
|
|
* Alternatively, your compiler probably allows you to specify definitions on
|
|
* the command line.
|
|
* >>> */
|
|
#include <bw_config.h>
|
|
/*! ...
|
|
*
|
|
* #### NULL and BW_SIZE_T
|
|
* If `NULL` or `BW_SIZE_T` are not defined, then `stddef.h` is `#include`d.
|
|
*
|
|
* If `BW_SIZE_T` is not defined, the it is defined as `size_t`.
|
|
* >>> */
|
|
#if !defined(NULL) || !defined(BW_SIZE_T)
|
|
# include <stddef.h>
|
|
# if !defined(BW_SIZE_T)
|
|
# define BW_SIZE_T size_t
|
|
# endif
|
|
#endif
|
|
/*! ...
|
|
*
|
|
* #### Exact-width integer types
|
|
* If <code class="hljs">(u)int{8,16,32,64}_t</code>,
|
|
* `INT{8,16,32,64}_{MIN,MAX}`, and `UINT{8,16,32,64}_MAX` are not defined,
|
|
* then `stdint.h` is `#include`d (actually, only testing against
|
|
* `INT32_MAX` but expecting the others to be finally defined).
|
|
* >>> */
|
|
#ifndef INT32_MAX
|
|
# include <stdint.h>
|
|
#endif
|
|
/*! ...
|
|
*
|
|
* #### INFINITY
|
|
* If `INFINITY` is not defined, then `math.h` is `#include`d.
|
|
* >>> */
|
|
#ifndef INFINITY
|
|
# include <math.h>
|
|
#endif
|
|
/*! ...
|
|
*
|
|
* #### BW_RESTRICT
|
|
* If `BW_RESTRICT` is not defined, then it is defined as `restrict` if C99
|
|
* is supported.
|
|
* >>> */
|
|
#ifndef BW_RESTRICT
|
|
# if defined(__STDC__) && (__STDC_VERSION__ >= 199901L)
|
|
# define BW_RESTRICT restrict
|
|
# else
|
|
# define BW_RESTRICT
|
|
# endif
|
|
#endif
|
|
/*! ... }}} */
|
|
|
|
#endif
|