JUCE  v5.4.1-191-g0ab5e696f
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | Static Private Member Functions | List of all members
littlefoot::Program Struct Reference

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

#include <juce_LittleFootRunner.h>

Collaboration diagram for littlefoot::Program:
Collaboration graph
[legend]

Public Member Functions

 Program (const void *data, uint32 totalMemorySize) noexcept
 
uint16 calculateChecksum () const noexcept
 
bool checksumMatches () const noexcept
 
void dumpAllFunctions (juce::OutputStream &out) const
 Calls dumpFunctionDisassembly() for all functions. More...
 
void dumpFunctionDisassembly (juce::OutputStream &out, uint32 functionIndex) const
 Prints the assembly code for a given function. More...
 
const uint8 * getFunctionEndAddress (uint32 functionIndex) const noexcept
 
FunctionID getFunctionID (uint32 functionIndex) const noexcept
 
const uint8 * getFunctionStartAddress (uint32 functionIndex) const noexcept
 
uint16 getHeapSizeBytes () const noexcept
 Returns the number of bytes of heap space the program needs. More...
 
uint32 getNumFunctions () const noexcept
 
uint16 getNumGlobals () const noexcept
 Returns the number of global variables the program uses. More...
 
juce::String getOpDisassembly (const uint8 *&prog) const
 
uint32 getProgramSize () const noexcept
 
uint16 getStoredChecksum () const noexcept
 
uint32 getTotalSpaceNeeded () const noexcept
 

Static Public Member Functions

static int32 floatToInt (float value) noexcept
 
static uint8 getNumExtraBytesForOpcode (OpCode op) noexcept
 For a given op code, this returns the number of program bytes that follow it. More...
 
static float intToFloat (int32 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 uint32 maxProgramSize
 
const uint8 * programStart = nullptr
 

Static Public Attributes

static constexpr uint32 programHeaderSize = 10
 

Private Member Functions

const uint8 * getFunctionEntry (uint32 index) const noexcept
 

Static Private Member Functions

static void copyFloatMem (void *dest, const void *src) noexcept
 

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...

{Blocks}

Constructor & Destructor Documentation

◆ Program()

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

References jassert.

Member Function Documentation

◆ calculateChecksum()

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

◆ checksumMatches()

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

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::isProgramLoaded(), and littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::reinitialiseProgramLayoutIfProgramHasChanged().

◆ copyFloatMem()

static void littlefoot::Program::copyFloatMem ( void *  dest,
const void *  src 
)
inlinestaticprivatenoexcept

◆ dumpAllFunctions()

void littlefoot::Program::dumpAllFunctions ( juce::OutputStream &  out) const
inline

Calls dumpFunctionDisassembly() for all functions.

References DBG.

Referenced by littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::reinitialiseProgramLayoutIfProgramHasChanged().

◆ dumpFunctionDisassembly()

void littlefoot::Program::dumpFunctionDisassembly ( juce::OutputStream &  out,
uint32  functionIndex 
) const
inline

Prints the assembly code for a given function.

References int(), juce::newLine, and juce::String::toHexString().

◆ floatToInt()

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

Referenced by littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::binaryOp(), littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::int32ToFloat(), and littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::pushArguments().

◆ getFunctionEndAddress()

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

◆ getFunctionEntry()

const uint8* littlefoot::Program::getFunctionEntry ( uint32  index) const
inlineprivatenoexcept

◆ getFunctionID()

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

◆ getFunctionStartAddress()

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

◆ getHeapSizeBytes()

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

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

Referenced by littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::reinitialiseProgramLayoutIfProgramHasChanged().

◆ getNumExtraBytesForOpcode()

static uint8 littlefoot::Program::getNumExtraBytesForOpcode ( OpCode  op)
inlinestaticnoexcept

For a given op code, this returns the number of program bytes that follow it.

References jassertfalse, littlefoot::LITTLEFOOT_OP, LITTLEFOOT_OP_INT16, LITTLEFOOT_OP_INT32, LITTLEFOOT_OP_INT8, and LITTLEFOOT_OPCODES.

◆ getNumFunctions()

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

◆ getNumGlobals()

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

Returns the number of global variables the program uses.

Referenced by littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::reinitialiseProgramLayoutIfProgramHasChanged().

◆ getOpDisassembly()

juce::String littlefoot::Program::getOpDisassembly ( const uint8 *&  prog) const
inline

References littlefoot::LITTLEFOOT_OP, LITTLEFOOT_OP_INT16, LITTLEFOOT_OP_INT32, LITTLEFOOT_OP_INT8, LITTLEFOOT_OPCODES, juce::String::paddedLeft(), and juce::String::toHexString().

Referenced by littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::dumpDebugTrace().

◆ getProgramSize()

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

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::isProgramLoaded(), and littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::reinitialiseProgramLayoutIfProgramHasChanged().

◆ getStoredChecksum()

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

◆ getTotalSpaceNeeded()

uint32 littlefoot::Program::getTotalSpaceNeeded ( ) const
inlinenoexcept

◆ intToFloat()

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

Referenced by littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::binaryOp(), littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::floatToInt32(), littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::testGE_float(), littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::testGT_float(), littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::testLE_float(), littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::testLT_float(), littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::testNZ_float(), and littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::testZE_float().

◆ readInt16()

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

Referenced by littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::readProgram16().

◆ readInt32()

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

Referenced by littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::getHeapInt(), and littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::FunctionExecutionContext::readProgram32().

◆ writeInt16()

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

◆ writeInt32()

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

Referenced by littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::setHeapInt().

Member Data Documentation

◆ maxProgramSize

const uint32 littlefoot::Program::maxProgramSize

◆ programHeaderSize

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

◆ programStart

const uint8* littlefoot::Program::programStart = nullptr
The documentation for this struct was generated from the following file: