mirror of
https://github.com/qmk/qmk_firmware
synced 2024-12-22 16:36:58 +00:00
9632360caa
* Add ARRAY_SIZE and CEILING utility macros * Apply a coccinelle patch to use ARRAY_SIZE * fix up some straggling items * Fix 'make test:secure' * Enhance ARRAY_SIZE macro to reject acting on pointers The previous definition would not produce a diagnostic for ``` int *p; size_t num_elem = ARRAY_SIZE(p) ``` but the new one will. * explicitly get definition of ARRAY_SIZE * Convert to ARRAY_SIZE when const is involved The following spatch finds additional instances where the array is const and the division is by the size of the type, not the size of the first element: ``` @ rule5a using "empty.iso" @ type T; const T[] E; @@ - (sizeof(E)/sizeof(T)) + ARRAY_SIZE(E) @ rule6a using "empty.iso" @ type T; const T[] E; @@ - sizeof(E)/sizeof(T) + ARRAY_SIZE(E) ``` * New instances of ARRAY_SIZE added since initial spatch run * Use `ARRAY_SIZE` in docs (found by grep) * Manually use ARRAY_SIZE hs_set is expected to be the same size as uint16_t, though it's made of two 8-bit integers * Just like char, sizeof(uint8_t) is guaranteed to be 1 This is at least true on any plausible system where qmk is actually used. Per my understanding it's universally true, assuming that uint8_t exists: https://stackoverflow.com/questions/48655310/can-i-assume-that-sizeofuint8-t-1 * Run qmk-format on core C files touched in this branch Co-authored-by: Stefan Kerkmann <karlk90@pm.me>
49 lines
1.3 KiB
C
49 lines
1.3 KiB
C
// Copyright 2022 Stefan Kerkmann (KarlK90)
|
|
// Copyright 2011 Jun Wako <wakojun@gmail.com>
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
#pragma once
|
|
|
|
#include "bitwise.h"
|
|
|
|
// convert to string
|
|
#define STR(s) XSTR(s)
|
|
#define XSTR(s) #s
|
|
|
|
#if !defined(MIN)
|
|
# define MIN(x, y) (((x) < (y)) ? (x) : (y))
|
|
#endif
|
|
|
|
#if !defined(MAX)
|
|
# define MAX(x, y) (((x) > (y)) ? (x) : (y))
|
|
#endif
|
|
|
|
#if !defined(CEILING)
|
|
/**
|
|
* @brief Computes the rounded up result of a division of two integers at
|
|
* compile time.
|
|
*/
|
|
# define CEILING(dividend, divisor) (((dividend) + (divisor)-1) / (divisor))
|
|
#endif
|
|
|
|
#if !defined(IS_ARRAY)
|
|
/**
|
|
* @brief Returns true if the value is an array, false if it's a pointer.
|
|
*
|
|
* This macro is ill-formed for scalars, which is OK for its intended use in
|
|
* ARRAY_SIZE.
|
|
*/
|
|
# define IS_ARRAY(value) (!__builtin_types_compatible_p(typeof((value)), typeof(&(value)[0])))
|
|
#endif
|
|
|
|
#if !defined(ARRAY_SIZE)
|
|
/**
|
|
* @brief Computes the number of elements of the given array at compile time.
|
|
*
|
|
* This Macro can only be used for statically allocated arrays that have not
|
|
* been decayed into a pointer. This is detected at compile time, though the
|
|
* error message for scalar values is poor.
|
|
*/
|
|
# define ARRAY_SIZE(array) (__builtin_choose_expr(IS_ARRAY((array)), sizeof((array)) / sizeof((array)[0]), (void)0))
|
|
#endif
|