Array.hpp

Go to the documentation of this file.

/****
 * Array.hpp - Defines the Array class and associated macros
 *
 * 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: 2018 - Mikee47 <mike@sillyhouse.net>
 *
 ****/
 
#pragma once
 
#include "Object.hpp"
#include "ArrayPrinter.hpp"
 
#define DECLARE_FSTR_ARRAY(name, ElementType) DECLARE_FSTR_OBJECT(name, FSTR::Array<ElementType>)
 
#define DEFINE_FSTR_ARRAY(name, ElementType, ...)                                                                      \
    static DEFINE_FSTR_ARRAY_DATA(FSTR_DATA_NAME(name), ElementType, __VA_ARGS__);                                     \
    DEFINE_FSTR_REF(name)
 
#define DEFINE_FSTR_ARRAY_LOCAL(name, ElementType, ...)                                                                \
    static DEFINE_FSTR_ARRAY_DATA(FSTR_DATA_NAME(name), ElementType, __VA_ARGS__);                                     \
    DEFINE_FSTR_REF_LOCAL(name)
 
#define DEFINE_FSTR_ARRAY_DATA(name, ElementType, ...)                                                                 \
    DEFINE_FSTR_ARRAY_DATA_SIZED(name, ElementType, FSTR_VA_NARGS(ElementType, __VA_ARGS__), __VA_ARGS__)
 
#define DEFINE_FSTR_ARRAY_DATA_SIZED(name, ElementType, size, ...)                                                     \
    constexpr const struct {                                                                                           \
        FSTR::Array<ElementType> object;                                                                               \
        ElementType data[size];                                                                                        \
    } FSTR_PACKED name PROGMEM = {{sizeof(ElementType) * size}, {__VA_ARGS__}};                                        \
    FSTR_CHECK_STRUCT(name);
 
#define LOAD_FSTR_ARRAY(name, array)                                                                                   \
    decltype((array)[0]) name[(array).size()] FSTR_ALIGNED;                                                            \
    memcpy_aligned(name, (array).data(), (array).size());
 
#define FSTR_ARRAY_ARRAY(name, ElementType, ...)                                                                       \
    static DEFINE_FSTR_ARRAY_DATA(FSTR_DATA_NAME(name), ElementType, __VA_ARGS__);                                     \
    LOAD_FSTR_ARRAY(name, FSTR_DATA_NAME(name).object)
 
#define IMPORT_FSTR_ARRAY(name, ElementType, file) IMPORT_FSTR_OBJECT(name, FSTR::Array<ElementType>, file)
 
#define IMPORT_FSTR_ARRAY_LOCAL(name, ElementType, file) IMPORT_FSTR_OBJECT_LOCAL(name, FSTR::Array<ElementType>, file)
 
namespace FSTR
{
template <typename ElementType> class Array : public Object<Array<ElementType>, ElementType>
{
public:
    static_assert(!std::is_pointer<ElementType>::value, "Pointer types not supported by Array - use Vector");
 
    /* Arduino Print support */
 
    ArrayPrinter<Array> printer() const
    {
        return ArrayPrinter<Array>(*this);
    }
 
    size_t printTo(Print& p) const
    {
        return printer().printTo(p);
    }
} FSTR_PACKED;
 
} // namespace FSTR