juce::littlefoot::Program Struct Reference

A reference to a block of memory which contains a complete program. More...

Public Member Functions
	Program (const void *data, uint32 totalMemorySize) noexcept
uint16	getStoredChecksum () const noexcept
uint16	calculateChecksum () const noexcept
bool	checksumMatches () const noexcept
uint32	getProgramSize () const noexcept
uint32	getNumFunctions () const noexcept
FunctionID	getFunctionID (uint32 functionIndex) const noexcept
const uint8 *	getFunctionStartAddress (uint32 functionIndex) const noexcept
const uint8 *	getFunctionEndAddress (uint32 functionIndex) const noexcept
uint16	getNumGlobals () const noexcept
	Returns the number of global variables the program uses. More...
uint16	getHeapSizeBytes () const noexcept
	Returns the number of bytes of heap space the program needs. More...

Static Public Member Functions
static float	intToFloat (int32 value) noexcept
static int32	floatToInt (float value) noexcept
static int16	readInt16 (const uint8 *d) noexcept
static int32	readInt32 (const uint8 *d) noexcept
static void	writeInt16 (uint8 *d, int16 v) noexcept
static void	writeInt32 (uint8 *d, int32 v) noexcept

Public Attributes
const uint8 *	programStart = 0
const uint32	maxProgramSize

Static Public Attributes
static constexpr uint32	programHeaderSize = 10

Detailed Description

A reference to a block of memory which contains a complete program.

Data format: 2 bytes - program checksum 2 bytes - program size 2 bytes - num functions 2 bytes - num globals 2 bytes - amount of heap space needed (bytes) 2 bytes - ID of function 1 2 bytes - byte offset of function 1 code 2 bytes - ID of function 2 2 bytes - byte offset of function 2 code etc.. ...function code...

Constructor & Destructor Documentation

Program()

juce::littlefoot::Program::Program ( const void *  data, uint32  totalMemorySize  )

noexcept

Member Function Documentation

getStoredChecksum()

uint16 juce::littlefoot::Program::getStoredChecksum ( ) const

noexcept

calculateChecksum()

uint16 juce::littlefoot::Program::calculateChecksum ( ) const

noexcept

checksumMatches()

bool juce::littlefoot::Program::checksumMatches ( ) const

noexcept

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::isProgramLoaded().

getProgramSize()

uint32 juce::littlefoot::Program::getProgramSize ( ) const

noexcept

getNumFunctions()

uint32 juce::littlefoot::Program::getNumFunctions ( ) const

noexcept

getFunctionID()

FunctionID juce::littlefoot::Program::getFunctionID ( uint32  functionIndex ) const

noexcept

getFunctionStartAddress()

const uint8* juce::littlefoot::Program::getFunctionStartAddress ( uint32  functionIndex ) const

noexcept

getFunctionEndAddress()

const uint8* juce::littlefoot::Program::getFunctionEndAddress ( uint32  functionIndex ) const

noexcept

getNumGlobals()

uint16 juce::littlefoot::Program::getNumGlobals ( ) const

noexcept

Returns the number of global variables the program uses.

getHeapSizeBytes()

uint16 juce::littlefoot::Program::getHeapSizeBytes ( ) const

noexcept

Returns the number of bytes of heap space the program needs.

intToFloat()

static float juce::littlefoot::Program::intToFloat ( int32  value )

staticnoexcept

floatToInt()

static int32 juce::littlefoot::Program::floatToInt ( float  value )

staticnoexcept

readInt16()

static int16 juce::littlefoot::Program::readInt16 ( const uint8 *  d )

staticnoexcept

readInt32()

static int32 juce::littlefoot::Program::readInt32 ( const uint8 *  d )

staticnoexcept

writeInt16()

static void juce::littlefoot::Program::writeInt16 ( uint8 *  d, int16  v  )

staticnoexcept

writeInt32()

static void juce::littlefoot::Program::writeInt32 ( uint8 *  d, int32  v  )

staticnoexcept

Member Data Documentation

programHeaderSize

constexpr uint32 juce::littlefoot::Program::programHeaderSize = 10

static

programStart

const uint8* juce::littlefoot::Program::programStart = 0

maxProgramSize

const uint32 juce::littlefoot::Program::maxProgramSize

---

The documentation for this struct was generated from the following file:

• juce_blocks_basics.h