pages.cpp File Reference

#include "pages.h"
#include "globals.h"
#include "preprocessor.h"
#include "table3d_visitor.h"
#include "prog_mem_support.h"

Classes
class	offset_to_table< table_t >
struct	get_table_value_visitor
struct	set_table_value_visitor
struct	page_map_t

Functions
template<class table_t >
static constexpr uint16_t	get_table_value_end (void)
template<class table_t >
static constexpr uint16_t	get_table_axisx_end (void)
template<class table_t >
static constexpr uint16_t	getTableSize (void)
static byte	get_raw_location (const entity_t &entity, uint16_t entityOffset)
static bool	set_raw_location (entity_t &entity, uint16_t entityOffset, byte value)
static byte	get_table_value (const entity_t &entity, uint16_t entityOffset)
byte	getEntityValue (const entity_t &entity, uint16_t entityOffset)
	Gets a single value from an entity, with data aligned as per the ini file.
static bool	set_table_value (entity_t &entity, uint16_t entityOffset, byte new_value)
bool	setEntityValue (entity_t &entity, uint16_t entityOffset, byte value)
	Sets a single value from a page, with data aligned as per the ini file.
template<typename table_t >
static constexpr entity_t	makeEntity (table_t *pTable)
static constexpr entity_t	makeEntity (config_page_t *pEntity, uint16_t entitySize)
static constexpr entity_t	makeEntity (uint16_t entitySize)
static page_map_t	getPageMap (uint8_t pageNumber)
static page_iterator_t	mapOffsetToEntity_P (const entity_t *pEntityMap, uint8_t mapLength, uint8_t pageNumber, uint16_t pageOffset)
	Search for the page_iterator_t that spans pageOffset.
static page_iterator_t	map_page_offset_to_entity (uint8_t pageNumber, uint16_t offset)
static void	setTableRowToEmpty (table_row_iterator row)
static void	setTableValuesToEmpty (table_value_iterator it)
static void	setTableAxisToEmpty (table_axis_iterator it)
static void	setTableToEmpty (const page_iterator_t &iter)
static void	setEntityToEmpty (page_iterator_t iter)
void	setTuneToEmpty (void)
	Fill the tune (config pages & tables) with zeroes.
uint16_t	getPageSize (byte pageNum)
static uint16_t	pageOffsetToEntityOffset (const page_iterator_t &iter, uint16_t pageOffset)
bool	setPageValue (uint8_t pageNum, uint16_t pageOffset, byte value)
	Sets a single value from a page, with data aligned as per the ini file.
byte	getPageValue (uint8_t pageNum, uint16_t pageOffset)
	Gets a single value from a page, with data aligned as per the ini file.
page_iterator_t	page_begin (uint8_t pageNum)
page_iterator_t	advance (const page_iterator_t &iter)
table_value_iterator	rows_begin (const page_iterator_t &iter)
table_axis_iterator	x_begin (const page_iterator_t &iter)
table_axis_iterator	x_rbegin (const page_iterator_t &iter)
table_axis_iterator	y_begin (const page_iterator_t &iter)

Function Documentation

advance()

page_iterator_t advance

(

const page_iterator_t &

it

)

Moves the iterator to the next sub-entity on the page

Parameters

[in]

iter

The current iterator

Here is the call graph for this function:

Here is the caller graph for this function:

get_raw_location()

static byte get_raw_location ( const entity_t &  entity, uint16_t  entityOffset  )

inlinestatic

Here is the call graph for this function:

Here is the caller graph for this function:

get_table_axisx_end()

template<class table_t >

static constexpr uint16_t get_table_axisx_end ( void  )

staticconstexpr

Here is the call graph for this function:

get_table_value()

static byte get_table_value ( const entity_t &  entity, uint16_t  entityOffset  )

inlinestatic

Here is the call graph for this function:

Here is the caller graph for this function:

get_table_value_end()

template<class table_t >

static constexpr uint16_t get_table_value_end ( void  )

staticconstexpr

getEntityValue()

byte getEntityValue	(	const entity_t &	entity,
		uint16_t	entityOffset
	)

Gets a single value from an entity, with data aligned as per the ini file.

Parameters

[in]	entity	The entity to update
[in]	entityOffset	The offset within the entity

Here is the call graph for this function:

Here is the caller graph for this function:

getPageMap()

static page_map_t getPageMap ( uint8_t  pageNumber )

static

Here is the call graph for this function:

Here is the caller graph for this function:

getPageSize()

uint16_t getPageSize

(

uint8_t

pageNum

)

Page size in bytes

Parameters

[in]

pageNum

The page number

Here is the call graph for this function:

Here is the caller graph for this function:

getPageValue()

byte getPageValue	(	uint8_t	pageNum,
		uint16_t	pageOffset
	)

Gets a single value from a page, with data aligned as per the ini file.

Parameters

[in]	pageNum	The page number to retrieve data from.
[in]	pageOffset	The address in the page that should be returned. This is as per the page definition in the ini.

Here is the call graph for this function:

Here is the caller graph for this function:

getTableSize()

template<class table_t >

static constexpr uint16_t getTableSize ( void  )

staticconstexpr

Here is the call graph for this function:

makeEntity() [1/3]

static constexpr entity_t makeEntity ( config_page_t *  pEntity, uint16_t  entitySize  )

staticconstexpr

Here is the call graph for this function:

makeEntity() [2/3]

template<typename table_t >

static constexpr entity_t makeEntity ( table_t *  pTable )

staticconstexpr

Here is the call graph for this function:

Here is the caller graph for this function:

makeEntity() [3/3]

static constexpr entity_t makeEntity ( uint16_t  entitySize )

staticconstexpr

Here is the call graph for this function:

map_page_offset_to_entity()

static page_iterator_t map_page_offset_to_entity ( uint8_t  pageNumber, uint16_t  offset  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

mapOffsetToEntity_P()

static page_iterator_t mapOffsetToEntity_P ( const entity_t *  pEntityMap, uint8_t  mapLength, uint8_t  pageNumber, uint16_t  pageOffset  )

static

Search for the page_iterator_t that spans pageOffset.

Here is the call graph for this function:

Here is the caller graph for this function:

page_begin()

page_iterator_t page_begin

(

uint8_t

pageNum

)

Initiates iteration over a pages entities. Test entity.type==End to determine the end of the page.

Parameters

[in]

pageNum

The page number to iterate over.

Here is the call graph for this function:

Here is the caller graph for this function:

pageOffsetToEntityOffset()

static uint16_t pageOffsetToEntityOffset ( const page_iterator_t &  iter, uint16_t  pageOffset  )

inlinestatic

Here is the call graph for this function:

Here is the caller graph for this function:

rows_begin()

table_value_iterator rows_begin

(

const page_iterator_t &

iter

)

Convert page iterator to table value iterator.

Here is the call graph for this function:

Here is the caller graph for this function:

set_raw_location()

static bool set_raw_location ( entity_t &  entity, uint16_t  entityOffset, byte  value  )

inlinestatic

Here is the call graph for this function:

Here is the caller graph for this function:

set_table_value()

static bool set_table_value ( entity_t &  entity, uint16_t  entityOffset, byte  new_value  )

inlinestatic

Here is the call graph for this function:

Here is the caller graph for this function:

setEntityToEmpty()

static void setEntityToEmpty ( page_iterator_t  iter )

static

Here is the call graph for this function:

Here is the caller graph for this function:

setEntityValue()

bool setEntityValue	(	entity_t &	entity,
		uint16_t	offset,
		byte	value
	)

Sets a single value from a page, with data aligned as per the ini file.

Returns

true if value set, false otherwise

Parameters

[in]	entity	The entity to update
[in]	entityOffset	The offset within the entity
[in]	value	The new value

Here is the call graph for this function:

Here is the caller graph for this function:

setPageValue()

bool setPageValue	(	uint8_t	pageNum,
		uint16_t	pageOffset,
		byte	value
	)

Sets a single value from a page, with data aligned as per the ini file.

Returns

true if value set, false otherwise

Parameters

[in]	pageNum	The page number to update.
[in]	pageOffset	The offset within the page.
[in]	value	The new value

Here is the call graph for this function:

Here is the caller graph for this function:

setTableAxisToEmpty()

static void setTableAxisToEmpty ( table_axis_iterator  it )

static

Here is the call graph for this function:

Here is the caller graph for this function:

setTableRowToEmpty()

static void setTableRowToEmpty ( table_row_iterator  row )

static

Here is the call graph for this function:

Here is the caller graph for this function:

setTableToEmpty()

static void setTableToEmpty ( const page_iterator_t &  iter )

static

Here is the call graph for this function:

Here is the caller graph for this function:

setTableValuesToEmpty()

static void setTableValuesToEmpty ( table_value_iterator  it )

static

Here is the call graph for this function:

Here is the caller graph for this function:

setTuneToEmpty()

void setTuneToEmpty

(

void

)

Fill the tune (config pages & tables) with zeroes.

Here is the call graph for this function:

Here is the caller graph for this function:

x_begin()

table_axis_iterator x_begin

(

const page_iterator_t &

iter

)

Convert page iterator to table x axis iterator.

Here is the call graph for this function:

Here is the caller graph for this function:

x_rbegin()

table_axis_iterator x_rbegin

(

const page_iterator_t &

iter

)

Convert page iterator to table x axis iterator.

Here is the call graph for this function:

Here is the caller graph for this function:

y_begin()

table_axis_iterator y_begin

(

const page_iterator_t &

iter

)

Convert page iterator to table y axis iterator.

Here is the call graph for this function:

Here is the caller graph for this function: