Vectors

Collaboration diagram for Vectors:

Macros
#define	DECLARE_FSTR_VECTOR(name, ObjectType)   DECLARE_FSTR_OBJECT(name, FSTR::Vector<ObjectType>)
	Declare a global Vector& reference. More...
#define	DEFINE_FSTR_VECTOR(name, ObjectType, ...)
	Define a Vector Object with global reference. More...
#define	DEFINE_FSTR_VECTOR_LOCAL(name, ObjectType, ...)
	Like DEFINE_FSTR_VECTOR except reference is declared static constexpr. More...
#define	DEFINE_FSTR_VECTOR_SIZED(name, ObjectType, size, ...)
	Define a Vector Object with global reference, specifying the number of elements. More...
#define	DEFINE_FSTR_VECTOR_SIZED_LOCAL(name, ObjectType, size, ...)
	Like DEFINE_FSTR_VECTOR_SIZED except reference is declared static constexpr. More...
#define	DEFINE_FSTR_VECTOR_DATA(name, ObjectType, ...)    DEFINE_FSTR_VECTOR_DATA_SIZED(name, ObjectType, FSTR_VA_NARGS(ObjectType*, __VA_ARGS__), __VA_ARGS__)
	Define a Vector data structure. More...
#define	DEFINE_FSTR_VECTOR_DATA_SIZED(name, ObjectType, size, ...)
	Define a Vector data structure and specify the number of elements. More...

Detailed Description

Macro Definition Documentation

DECLARE_FSTR_VECTOR

#define DECLARE_FSTR_VECTOR	(		name,
			ObjectType
	)		DECLARE_FSTR_OBJECT(name, FSTR::Vector<ObjectType>)

Declare a global Vector& reference.

Parameters

name
ObjectType

Note

Use DEFINE_VECTOR to instantiate the global Object

DEFINE_FSTR_VECTOR

#define DEFINE_FSTR_VECTOR	(		name,
			ObjectType,
			...
	)

Value:

    static DEFINE_FSTR_VECTOR_DATA(FSTR_DATA_NAME(name), ObjectType, __VA_ARGS__);                                     \
    DEFINE_FSTR_REF(name)

Define a Vector Object with global reference.

Parameters

name	Name of Vector& reference to define
ObjectType
...	List of ObjectType* pointers

Note

Size will be calculated

DEFINE_FSTR_VECTOR_DATA

#define DEFINE_FSTR_VECTOR_DATA	(		name,
			ObjectType,
			...
	)		DEFINE_FSTR_VECTOR_DATA_SIZED(name, ObjectType, FSTR_VA_NARGS(ObjectType*, __VA_ARGS__), __VA_ARGS__)

Define a Vector data structure.

Parameters

name	Name of data structure
ObjectType
...	List of ObjectType* pointers

Note

Size will be calculated

DEFINE_FSTR_VECTOR_DATA_SIZED

#define DEFINE_FSTR_VECTOR_DATA_SIZED	(		name,
			ObjectType,
			size,
			...
	)

Value:

    constexpr const struct {                                                                                           \
        FSTR::Vector<ObjectType> object;                                                                               \
        const ObjectType* data[size];                                                                                  \
    } FSTR_PACKED name PROGMEM = {{sizeof(ObjectType*) * size}, {__VA_ARGS__}};                                        \
    FSTR_CHECK_STRUCT(name);

Define a Vector data structure and specify the number of elements.

Parameters

name	Name of data structure
ObjectType
size	Number of elements
...	List of ObjectType* pointers

Note

Use in situations where the array size cannot be automatically calculated

DEFINE_FSTR_VECTOR_LOCAL

#define DEFINE_FSTR_VECTOR_LOCAL	(		name,
			ObjectType,
			...
	)

Value:

    static DEFINE_FSTR_VECTOR_DATA(FSTR_DATA_NAME(name), ObjectType, __VA_ARGS__);                                     \
    DEFINE_FSTR_REF_LOCAL(name)

Like DEFINE_FSTR_VECTOR except reference is declared static constexpr.

DEFINE_FSTR_VECTOR_SIZED

#define DEFINE_FSTR_VECTOR_SIZED	(		name,
			ObjectType,
			size,
			...
	)

Value:

    static DEFINE_FSTR_VECTOR_DATA_SIZED(FSTR_DATA_NAME(name), ObjectType, size, __VA_ARGS__);                         \
    DEFINE_FSTR_REF(name)

Define a Vector Object with global reference, specifying the number of elements.

Parameters

name	Name of Vector& reference to define
ObjectType
size	Number of elements
...	List of ObjectType* pointers

Note

Use in situations where the array size cannot be automatically calculated

DEFINE_FSTR_VECTOR_SIZED_LOCAL

#define DEFINE_FSTR_VECTOR_SIZED_LOCAL	(		name,
			ObjectType,
			size,
			...
	)

Value:

    static DEFINE_FSTR_VECTOR_DATA_SIZED(FSTR_DATA_NAME(name), ObjectType, size, __VA_ARGS__);                         \
    DEFINE_FSTR_REF_LOCAL(name)

Like DEFINE_FSTR_VECTOR_SIZED except reference is declared static constexpr.