feat(deprecation): add lv_deprecated mactro (#10008)
Arduino Lint / lint (push) Has been cancelled
Build Examples with C++ Compiler / build-examples (push) Has been cancelled
MicroPython CI / Build esp32 port (push) Has been cancelled
MicroPython CI / Build rp2 port (push) Has been cancelled
MicroPython CI / Build stm32 port (push) Has been cancelled
MicroPython CI / Build unix port (push) Has been cancelled
C/C++ CI / Build OPTIONS_16BIT - Ubuntu (push) Has been cancelled
C/C++ CI / Build OPTIONS_24BIT - Ubuntu (push) Has been cancelled
C/C++ CI / Build OPTIONS_FULL_32BIT - Ubuntu (push) Has been cancelled
C/C++ CI / Build OPTIONS_NORMAL_8BIT - Ubuntu (push) Has been cancelled
C/C++ CI / Build OPTIONS_SDL - Ubuntu (push) Has been cancelled
C/C++ CI / Build OPTIONS_16BIT - cl - Windows (push) Has been cancelled
C/C++ CI / Build OPTIONS_16BIT - gcc - Windows (push) Has been cancelled
C/C++ CI / Build OPTIONS_24BIT - cl - Windows (push) Has been cancelled
C/C++ CI / Build OPTIONS_24BIT - gcc - Windows (push) Has been cancelled
C/C++ CI / Build OPTIONS_FULL_32BIT - cl - Windows (push) Has been cancelled
C/C++ CI / Build OPTIONS_FULL_32BIT - gcc - Windows (push) Has been cancelled
C/C++ CI / Build ESP IDF ESP32S3 (push) Has been cancelled
C/C++ CI / Run tests with 32bit build (push) Has been cancelled
C/C++ CI / Run tests with 64bit build (push) Has been cancelled
BOM Check / bom-check (push) Has been cancelled
Verify that lv_conf_internal.h matches repository state / verify-conf-internal (push) Has been cancelled
Verify GDB constants are up-to-date / verify-gdb-consts (push) Has been cancelled
Verify the widget property name / verify-property-name (push) Has been cancelled
Verify code formatting / verify-formatting (push) Has been cancelled
Compare file templates with file names / template-check (push) Has been cancelled
Test API JSON generator / Test API JSON (push) Has been cancelled
Install LVGL using CMake / build-examples (push) Has been cancelled
Check Makefile / Build using Makefile (push) Has been cancelled
Check Makefile for UEFI / Build using Makefile for UEFI (push) Has been cancelled
Emulated Performance Test / ARM Emulated Benchmark - Script Check (scripts/perf/tests/benchmark_results_comment/test.sh) (push) Has been cancelled
Emulated Performance Test / ARM Emulated Benchmark - Script Check (scripts/perf/tests/filter_docker_logs/test.sh) (push) Has been cancelled
Emulated Performance Test / ARM Emulated Benchmark - Script Check (scripts/perf/tests/serialize_results/test.sh) (push) Has been cancelled
Emulated Performance Test / ARM Emulated Benchmark 32b - lv_conf_perf32b (push) Has been cancelled
Emulated Performance Test / ARM Emulated Benchmark 64b - lv_conf_perf64b (push) Has been cancelled
Emulated Performance Test / ARM Emulated Benchmark - Save PR Number (push) Has been cancelled
Performance Tests CI / Perf Tests OPTIONS_TEST_PERF_32B - Ubuntu (push) Has been cancelled
Performance Tests CI / Perf Tests OPTIONS_TEST_PERF_64B - Ubuntu (push) Has been cancelled
Port repo release update / run-release-branch-updater (push) Has been cancelled
Verify Font License / verify-font-license (push) Has been cancelled
Verify Kconfig / verify-kconfig (push) Has been cancelled
Hardware Performance Test / Hardware Performance Benchmark (push) Has been cancelled
Hardware Performance Test / HW Benchmark - Save PR Number (push) Has been cancelled

This commit is contained in:
Akos Vandra-Meyer
2026-05-07 14:28:20 +02:00
committed by GitHub
parent b6cb3542cb
commit 963e704fb1
+57
View File
@@ -441,6 +441,63 @@ typedef struct _lv_draw_eve_unit_t lv_draw_eve_unit_t;
#define LV_ARRAYLEN(a) (sizeof(a)/sizeof((a)[0]))
#endif /*LV_ARRAYLEN*/
/**
* Mark a function as deprecated so the compiler emits a warning at every call site.
*
* Usage — functions:
* @code
* LV_DEPRECATED("Use lv_foo_new() instead")
* void lv_foo_old(void);
* @endcode
*
* Usage — macros: wrap the macro body with LV_DEPRECATED_MACRO_WARN() so the
* warning fires when the macro is expanded:
* @code
* #define MY_OLD_MACRO(x) (LV_DEPRECATED_MACRO_WARN("MY_OLD_MACRO is deprecated"), (x))
* @endcode
*/
#ifndef LV_DEPRECATED
#if defined(PYCPARSER)
#define LV_DEPRECATED(msg)
#elif defined(__GNUC__) || defined(__clang__)
#define LV_DEPRECATED(msg) __attribute__((deprecated(msg)))
#elif defined(_MSC_VER)
#define LV_DEPRECATED(msg) __declspec(deprecated(msg))
#else
#define LV_DEPRECATED(msg)
#endif
#endif /* LV_DEPRECATED not defined */
/**
* Helper used inside deprecated macro bodies to emit a compiler warning at the
* expansion site in user code.
*
* Works by declaring a local typedef tagged as deprecated and immediately using
* it, which triggers the warning without any runtime overhead.
*
* Example:
* @code
* #define MY_OLD_MACRO(x) \
* do { LV_DEPRECATED_MACRO_WARN("MY_OLD_MACRO is deprecated, use MY_NEW_MACRO"); \
* (x); } while(0)
* @endcode
*/
#if defined(PYCPARSER)
#define LV_DEPRECATED_MACRO_WARN(msg) ((void)0)
#elif defined(__GNUC__) || defined(__clang__)
#define LV_DEPRECATED_MACRO_WARN(msg) \
do { \
typedef int __attribute__((deprecated(msg))) __lv_deprecated_t; \
__lv_deprecated_t __lv_deprecated_dummy; \
(void)__lv_deprecated_dummy; \
} while(0)
#else
/* Fallback: no warning, but the macro still compiles */
#define LV_DEPRECATED_MACRO_WARN(msg) ((void)0)
#endif
#ifdef __cplusplus
} /*extern "C"*/
#endif