platform_detect.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UTILITY_PLATFORM_DETECT_HPP
#define M5_UTILITY_PLATFORM_DETECT_HPP
 
// Fail fast with a single clear diagnostic on toolchains that ship no C++
// standard library at all (e.g. avr-gcc for AVR cores); otherwise the first
// standard header include produces a cascade of unrelated-looking errors.
// This probes existence only — a header that exists but is unusable is a
// different problem (see M5UTILITY_HAS_USABLE_CHRONO below).
#if defined(__has_include)
#if !__has_include(<type_traits>) || !__has_include(<vector>) || !__has_include(<functional>)
#error "M5Utility requires the C++ standard library, which this toolchain (e.g. avr-gcc for AVR cores) does not provide"
#endif
#endif
 
#define M5UTILITY_TIME_SOURCE_ESP     1  
#define M5UTILITY_TIME_SOURCE_ARDUINO 2  
#define M5UTILITY_TIME_SOURCE_CHRONO  3  
 
#if !defined(M5UTILITY_TIME_SOURCE)
#if defined(ESP_PLATFORM)
// Defined by the ESP-IDF build system and by every Arduino-ESP32 core, for all
// chips — no per-target CONFIG_IDF_TARGET_* list to maintain.
#define M5UTILITY_TIME_SOURCE M5UTILITY_TIME_SOURCE_ESP
#elif defined(ARDUINO)
// Any other Arduino core: millis()/micros()/delay() are guaranteed by the Arduino API
// contract on every core (RP2040, SAMD, ...), while <thread> generally is not
// (bare-metal, no RTOS by default).
#define M5UTILITY_TIME_SOURCE M5UTILITY_TIME_SOURCE_ARDUINO
#else
// Hosted build (native tests etc.)
#define M5UTILITY_TIME_SOURCE M5UTILITY_TIME_SOURCE_CHRONO
#endif
#endif
 
#if (M5UTILITY_TIME_SOURCE < M5UTILITY_TIME_SOURCE_ESP) || (M5UTILITY_TIME_SOURCE > M5UTILITY_TIME_SOURCE_CHRONO)
#error "M5UTILITY_TIME_SOURCE must be one of M5UTILITY_TIME_SOURCE_{ESP,ARDUINO,CHRONO}"
#endif
 
#if !defined(M5UTILITY_HAS_USABLE_CHRONO)
#if defined(ARDUINO) && !defined(ESP_PLATFORM)
#define M5UTILITY_HAS_USABLE_CHRONO 0
#else
#define M5UTILITY_HAS_USABLE_CHRONO 1
#endif
#endif
 
#endif  // M5_UTILITY_PLATFORM_DETECT_HPP