zeldon
/
htop
mirror of https://github.com/xzeldon/htop.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
htop/Macros.h

69 lines
2.1 KiB
C
Raw Normal View History

Consolidate repeated macro definitions into one header The MIN, MAX, CLAMP, MINIMUM, and MAXIMUM macros appear throughout the codebase with many re-definitions. Make a single copy of each in a common header file, and use the BSD variants of MINIMUM/MAXIMUM due to conflicts in the system <sys/param.h> headers.
2020-09-09 06:56:04 +00:00
#ifndef HEADER_Macros
#define HEADER_Macros
Make all required includes explicit Information as seen by IWYU 0.12 + clang 9 on Linux
2020-09-19 11:55:23 +00:00
#include <assert.h> // IWYU pragma: keep
Consolidate repeated macro definitions into one header The MIN, MAX, CLAMP, MINIMUM, and MAXIMUM macros appear throughout the codebase with many re-definitions. Make a single copy of each in a common header file, and use the BSD variants of MINIMUM/MAXIMUM due to conflicts in the system <sys/param.h> headers.
2020-09-09 06:56:04 +00:00
#ifndef MINIMUM
Introduce spaceship comparison for Processes If currently two unsigned values are compared via `a - b`, in the case b is actually bigger than a, the result will not be an negative number (as -1 is expected) but a huge positive number as the subtraction is an unsigned subtraction. Avoid over-/underflow affected operations; use comparisons. Modern compilers will generate sane code, like: xor eax, eax cmp rdi, rsi seta al sbb eax, 0 ret
2020-11-04 16:46:24 +00:00
#define MINIMUM(a, b) ((a) < (b) ? (a) : (b))
Consolidate repeated macro definitions into one header The MIN, MAX, CLAMP, MINIMUM, and MAXIMUM macros appear throughout the codebase with many re-definitions. Make a single copy of each in a common header file, and use the BSD variants of MINIMUM/MAXIMUM due to conflicts in the system <sys/param.h> headers.
2020-09-09 06:56:04 +00:00
#endif
#ifndef MAXIMUM
Introduce spaceship comparison for Processes If currently two unsigned values are compared via `a - b`, in the case b is actually bigger than a, the result will not be an negative number (as -1 is expected) but a huge positive number as the subtraction is an unsigned subtraction. Avoid over-/underflow affected operations; use comparisons. Modern compilers will generate sane code, like: xor eax, eax cmp rdi, rsi seta al sbb eax, 0 ret
2020-11-04 16:46:24 +00:00
#define MAXIMUM(a, b) ((a) > (b) ? (a) : (b))
Consolidate repeated macro definitions into one header The MIN, MAX, CLAMP, MINIMUM, and MAXIMUM macros appear throughout the codebase with many re-definitions. Make a single copy of each in a common header file, and use the BSD variants of MINIMUM/MAXIMUM due to conflicts in the system <sys/param.h> headers.
2020-09-09 06:56:04 +00:00
#endif
#ifndef CLAMP
Introduce spaceship comparison for Processes If currently two unsigned values are compared via `a - b`, in the case b is actually bigger than a, the result will not be an negative number (as -1 is expected) but a huge positive number as the subtraction is an unsigned subtraction. Avoid over-/underflow affected operations; use comparisons. Modern compilers will generate sane code, like: xor eax, eax cmp rdi, rsi seta al sbb eax, 0 ret
2020-11-04 16:46:24 +00:00
#define CLAMP(x, low, high) (assert((low) <= (high)), ((x) > (high)) ? (high) : MAXIMUM(x, low))
Consolidate repeated macro definitions into one header The MIN, MAX, CLAMP, MINIMUM, and MAXIMUM macros appear throughout the codebase with many re-definitions. Make a single copy of each in a common header file, and use the BSD variants of MINIMUM/MAXIMUM due to conflicts in the system <sys/param.h> headers.
2020-09-09 06:56:04 +00:00
#endif
Introduce ARRAYSIZE
2020-09-28 19:14:50 +00:00
#ifndef ARRAYSIZE
Introduce spaceship comparison for Processes If currently two unsigned values are compared via `a - b`, in the case b is actually bigger than a, the result will not be an negative number (as -1 is expected) but a huge positive number as the subtraction is an unsigned subtraction. Avoid over-/underflow affected operations; use comparisons. Modern compilers will generate sane code, like: xor eax, eax cmp rdi, rsi seta al sbb eax, 0 ret
2020-11-04 16:46:24 +00:00
#define ARRAYSIZE(x) (sizeof(x) / sizeof((x)[0]))
#endif
#ifndef SPACESHIP_NUMBER
#define SPACESHIP_NUMBER(a, b) (((a) > (b)) - ((a) < (b)))
#endif
#ifndef SPACESHIP_NULLSTR
#define SPACESHIP_NULLSTR(a, b) strcmp((a) ? (a) : "", (b) ? (b) : "")
Introduce ARRAYSIZE
2020-09-28 19:14:50 +00:00
#endif
Refactor __attribute__ usage Use internal macros for compatibility with non GNUC compilers.
2020-09-09 19:35:15 +00:00
#ifdef __GNUC__ // defined by GCC and Clang
#define ATTR_FORMAT(type, index, check) __attribute__((format (type, index, check)))
#define ATTR_NONNULL __attribute__((nonnull))
#define ATTR_NORETURN __attribute__((noreturn))
#define ATTR_UNUSED __attribute__((unused))
Add compiler hints on memory allocating utility functions
2020-11-20 16:04:19 +00:00
#define ATTR_ALLOC_SIZE1(a) __attribute__((alloc_size (a)))
#define ATTR_ALLOC_SIZE2(a, b) __attribute__((alloc_size (a, b)))
#define ATTR_MALLOC __attribute__((malloc))
Refactor __attribute__ usage Use internal macros for compatibility with non GNUC compilers.
2020-09-09 19:35:15 +00:00
#else /* __GNUC__ */
#define ATTR_FORMAT(type, index, check)
#define ATTR_NONNULL
#define ATTR_NORETURN
#define ATTR_UNUSED
Add compiler hints on memory allocating utility functions
2020-11-20 16:04:19 +00:00
#define ATTR_ALLOC_SIZE1(a)
#define ATTR_ALLOC_SIZE2(a, b)
#define ATTR_MALLOC
Refactor __attribute__ usage Use internal macros for compatibility with non GNUC compilers.
2020-09-09 19:35:15 +00:00
#endif /* __GNUC__ */
Enable -Wcast-qual compiler warning
2020-10-04 12:30:35 +00:00
// ignore casts discarding const specifier, e.g.
// const char [] -> char * / void *
// const char *[2]' -> char *const *
Use `#if defined()` syntax when `#elif defined()` is present This prefers the `#if defined()` syntax over the `#ifdef` variant whenever there's also a `#elif defined()` clause, thus making the multiple branching structure more obvious and the overall use more consistent.
2021-03-20 10:21:20 +00:00
#if defined(__clang__)
Enable -Wcast-qual compiler warning
2020-10-04 12:30:35 +00:00
#define IGNORE_WCASTQUAL_BEGIN _Pragma("clang diagnostic push") \
_Pragma("clang diagnostic ignored \"-Wcast-qual\"")
#define IGNORE_WCASTQUAL_END _Pragma("clang diagnostic pop")
#elif defined(__GNUC__)
#define IGNORE_WCASTQUAL_BEGIN _Pragma("GCC diagnostic push") \
_Pragma("GCC diagnostic ignored \"-Wcast-qual\"")
#define IGNORE_WCASTQUAL_END _Pragma("GCC diagnostic pop")
#else
#define IGNORE_WCASTQUAL_BEGIN
#define IGNORE_WCASTQUAL_END
#endif
Consolidate repeated macro definitions into one header The MIN, MAX, CLAMP, MINIMUM, and MAXIMUM macros appear throughout the codebase with many re-definitions. Make a single copy of each in a common header file, and use the BSD variants of MINIMUM/MAXIMUM due to conflicts in the system <sys/param.h> headers.
2020-09-09 06:56:04 +00:00
#endif