Platform Integration Aspects: Platform Package reference

With Embedded Wizard you develop the GUI application in the platform independent programming language Chora. Then you compile and link the generated code together with the Platform Package modules to a single binary able to run on your target system.

Depending on your individual application case, you will eventually need to take care of adaptations of the interfaces between your finished GUI application and your particular device, the operating system, the hardware or even other applications and software modules coexisting on the same system. It is thus important to know which functions and data types are provided by the Platform Package. This chapter gives you an overview of the important Platform Package functionality, in particular the functionality of the Runtime Environment and Graphics Engine:

Function

Description

EwGetAutoObject

C Platform Package function to obtain access to an autoobject.

EwNewObject

C Platform Package function to create a new instance of Chora class.

EwNewObjectIndirect

C Platform Package function to create a new instance of Chora class.

EwLockObject

C Platform Package function to protect an object from being disposed by the garbage collection.

EwUnlockObject

C Platform Package function to remove the protection of an object from being disposed by the garbage collection.

EwReclaimMemory

C Platform Package function to run the garbage collection.

EwProcessSignals

C Platform Package function to process all signals pending actually for their delivery.

EwProcessTimers

C Platform Package function to process all expired timers.

EwAnyPendingSignals

C Platform Package function to query whether there are any signals pending for the delivery.

EwNextTimerExpiration

C Platform Package function to query when the next timer expiration is expected.

EwNewPoint

C Platform Package convenience function to create an operand of type 'XPoint' (Chora type 'point').

EwNewRect

C Platform Package convenience function to create an operand of type 'XRect' (Chora type 'rect').

EwNewColor

C Platform Package convenience function to create an operand of type 'XColor' (Chora type 'color').

EwNewString

C Platform Package function to create a duplicate of a wide-character (16-bit) string.

EwNewStringAnsi

C Platform Package function to create a wide-character (16-bit) string from an ANSI (8-bit) coded source string.

EwNewStringUtf8

C Platform Package function to create a wide-character (16-bit) string from an UTF-8 coded source string.

EwNewStringChar

C Platform Package function to create a string filled with a character.

EwGetStringLength

C Platform Package function to query the length (the number of characters) of a string.

EwGetUtf8StringLength

C Platform Package function to query the length of an UTF-8 string resulting from an Embedded Wizard string.

EwCompString

C Platform Package function to compare two strings.

EwStringToAnsi

C Platform Package function to convert the wide-character (16-bit) coded string in an ANSI (8-bit) string.

EwStringToUtf8

C Platform Package function to convert a string in UTF-8 format.

EwSetLanguage

C Platform Package function to select the language in a multi-lingual localized application.

EwGetLanguage

C Platform Package function to query the actually selected language in a multi-lingual localized application.

EwSetStackAddressArea

C Platform Package function to provide information about the used CPU stack.

EwSetStyles

C Platform Package function to enable/disable styles in a multi-variant application.

EwGetStyles

C Platform Package function to query the actually enabled styles in a multi-variant application.

EwPrintProfilerStatistic

C Platform Package function to print statistic about the memory usage of the GUI application.

EwPrintPerfCounters

C Platform Package function to print collected performance counters during debugging.

EwResetPerfCounters

C Platform Package function to reset collected performance counters during debugging.

EwInitRuntimeEnvironment

C Platform Package function to initialize the Runtime Environment.

EwDoneRuntimeEnvironment

C Platform Package function to deinitialize (shutdown) the Runtime Environment.

EwInitGraphicsEngine

C Platform Package function to initialize the Graphics Engine.

EwDoneGraphicsEngine

C Platform Package function to deinitialize (shutdown) the Graphics Engine.

EwEnableGfxTaskTracing

C Platform Package function to control the internal debugging mode of the Graphics Engine.

EwInitViewport

C Platform Package function to initialize a viewport.

EwDoneViewport

C Platform Package function to deinitialize a viewport.

EwConfigViewport

C Platform Package function to change the configuration of a viewport.

EwBeginUpdate

C Platform Package function to initiate a screen update cycle for a given viewport.

EwBeginUpdateArea

C Platform Package function to initiate a partial screen update cycle for a given viewport.

EwEndUpdate

C Platform Package function to finalize the screen update cycle for the given viewport.

EwCreateBitmap

C Platform Package function to create a new bitmap.

EwFreeBitmap

C Platform Package function to free all resources occupied by a bitmap.

EwModifyBitmapPalette

C Platform Package function to change color values within the palette of an Index8 bitmap.

EwLockBitmap

C Platform Package function to lock and direct access the pixel memory of a bitmap.

EwUnlockBitmap

C Platform Package function to unlock a bitmap.

EwIndexToColor

C Platform Package function to query color values from the global CLUT.

EwColorToIndex

C Platform Package function to determine an entry within the global CLUT corresponding to a color value.

EwAllocUserColor

C Platform Package function to store user defined colors within empty area in the global CLUT.

EwFreeUserColor

C Platform Package function to remove a user defined color entry from the global CLUT.

EwSetUserColor

C Platform Package function to change color values within the global CLUT.

EwFindUserColor

C Platform Package function to search the global CLUT for a color value.

EwAlloc

C Platform Package function to reserve a memory block from the memory heap used by Embedded Wizard.

EwFree

C Platform Package function to free a memory block reserved on Embedded Wizard own memory heap.

EwPrint

C Platform Package function to print outputs on the device console.

EwInitHeap

C Platform Package function to initialize the Embedded Wizard own memory manager.

EwDoneHeap

C Platform Package function to shutdown the Embedded Wizard own memory manager.

EwAddHeapMemoryPool

C Platform Package function to initialize the Embedded Wizard own memory manager.

EwVerifyHeap

C Platform Package function to check the coherence of Embedded wizard own memory manager.

EwGetHeapInfo

C Platform Package function to get the state of Embedded Wizard own memory manager.

EwDumpHeap

C Platform Package function to dump the state of Embedded Wizard own memory manager.

EwRegisterFlashAreaReader

C Platform Package function to register an interface to access external Flash memory.

EwSetBlobData

C Platform Package function to access constants and resources stored in Blob files.

EwInitInvocations

C Platform Package function to initialize a queue used to store invocations scheduled in context of Embedded Wizard application's main loop.

EwDoneInvocations

C Platform Package function to deinitialize (shutdown) the invocations queue inside the Runtime Environment.

EwInvoke

C Platform Package function to schedule the execution of a user defined function in context of Embedded Wizard application's main loop.

EwInvokeCopy

C Platform Package function to schedule the execution of a user defined function in context of Embedded Wizard application's main loop.

_NewObject

WebGL JavaScript Platform Package function to create a new instance of Chora class.

_LockObject

WebGL JavaScript Platform Package function to protect an object from being disposed by the garbage collection.

_UnlockObject

WebGL JavaScript Platform Package function to remove the protection of an object from being disposed by the garbage collection.

_RequestUpdate

WebGL JavaScript Platform Package function to request an update for the current application instance..

_GetAutoObject

WebGL JavaScript Platform Package function to obtain access to an autoobject.

Type definition

Description

Basic data types

C Platform Package basic type definitions.

XPoint

C Platform Package type definition for the Chora 'point' data type.

XRect

C Platform Package type definition for the Chora 'rect' data type.

XColor

C Platform Package type definition for the Chora 'color' data type.

XBitmap

C Platform Package type definition to describe the attributes of a bitmap.

XBitmapLock

C Platform Package type definition to provide access to the pixel memory of a locked bitmap.

XViewportProc

C Platform Package type definition of a user defined viewport callback function.

XInvokeProc

C Platform Package type definition of a user defined function to be invoked in context of Embedded Wizard application's main loop.