Utility.hpp

Go to the documentation of this file.

/****
 * Utility.hpp - Definitions, common macros and utility functions
 *
 * Copyright 2019 mikee47 <mike@sillyhouse.net>
 *
 * This file is part of the FlashString Library
 *
 * This library 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 or later.
 *
 * This library 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 this library.
 * If not, see <https://www.gnu.org/licenses/>.
 *
 * @author: Nov 2019 - Mikee47 <mike@sillyhouse.net>
 *
 ****/
 
#pragma once
 
#include "config.hpp"
 
#define DECL(t) argument_type<void(t)>::type
template <typename T> struct argument_type;
template <typename T, typename U> struct argument_type<T(U)> {
    typedef U type;
};
 
// clang-format off
#define STR(x) XSTR(x)
#define XSTR(x) #x
#ifdef __WIN32
#define IMPORT_FSTR_DATA_SECTION(name)                         \
    ".section .rodata\n"                                       \
    ".def " STR(name) "; .scl 2; .type 32; .endef\n"
#elif defined(__APPLE__)
#define IMPORT_FSTR_DATA_SECTION(name)                         \
    ".const_data\n"                                            \
    ".globl " STR(name) "\n"
#elif defined(__arm__)
#define IMPORT_FSTR_DATA_SECTION(name)                         \
    ".section " ICACHE_RODATA_SECTION "." STR(name) "\n"       \
    ".type " STR(name) ", %object\n"
#else
#define IMPORT_FSTR_DATA_SECTION(name)                         \
    ".section " ICACHE_RODATA_SECTION "." STR(name) "\n"       \
    ".type " STR(name) ", @object\n"
#endif
 
#define IMPORT_FSTR_DATA(name, file)                           \
    __asm__(IMPORT_FSTR_DATA_SECTION(name)                     \
            ".align 4\n"                                       \
            STR(name) ":\n"                                    \
            ".long " STR(name) "_end - " STR(name) " - 4\n"    \
            ".incbin \"" file "\"\n"                           \
            STR(name) "_end:\n");
// clang-format on
 
#define DECLARE_FSTR_IMPORT(ObjectType, name) extern const ObjectType name __asm__(STR(name));
 
namespace FSTR
{
template <typename T> FSTR_INLINE typename std::enable_if<sizeof(T) == 1, T>::type readValue(const T* ptr)
{
    return static_cast<T>(pgm_read_byte(ptr));
}
 
template <typename T> FSTR_INLINE typename std::enable_if<sizeof(T) == 2, T>::type readValue(const T* ptr)
{
    return static_cast<T>(pgm_read_word(ptr));
}
 
template <typename T> FSTR_ALIGN32 FSTR_INLINE typename std::enable_if<sizeof(T) == 4, T>::type readValue(const T* ptr)
{
    union {
        uint32_t u32;
        T value;
    } tmp;
    tmp.u32 = pgm_read_dword(ptr);
    return tmp.value;
}
 
template <typename T>
FSTR_INLINE typename std::enable_if<(sizeof(T) > 4) && IS_ALIGNED(sizeof(T)), T>::type readValue(const T* ptr)
{
    T value;
    memcpy_aligned(&value, ptr, sizeof(T));
    return value;
}
 
} // namespace FSTR