7.10 The C structure

7.10.6 The C.Diagnostic structure

This structure contains a general collection of tools to help provide diagnostic services for C specific parts of the FI such as c_objects. It is not envisaged that these would be used to provide functionality within applications, but this is of course not prohibited.

These tools are provided here on the understanding that this part of the interface may be changed arbitrarily, In particular, there is no guarantee to preserve any functionality in future versions. However, such interfaces are not changed without there being just cause.

store

Type abbreviation

Specification:: type store
Description:
: Equivalent to Store.store.

c_type

Type abbreviation

Specification:: type c_type
Description:
: Equivalent to Type.c_type.

c_object

Type abbreviation

Specification:: type c_object
Description:
: Equivalent to Value.c_object.

cTypeInfo

Function

Signature:: val cTypeInfo : c_type -> string
Description:
: This provides a string describing the given c_type value.

viewObject

Function

Signature:: val viewObject : c_object -> string
Description:
: This provides a string describing the given c_object.

dispObject

Function

Signature:: val dispObject : c_object -> c_object
Description:
: Outputs the string produced by viewObject, above, on the standard output stream and returns the c_object.

objectInfo

Function

Signature:: val objectInfo : c_object -> { store : store, status : string, currency : string, mode : string, langtype : string, size : int, base : address option, offset : int }
Description:
: This provides a structured, diagnostic view of the internals of a c_object. This can be used by programmers to construct additional diagnostic tools.

objectData

Function

Signature:: val objectData : c_object -> int list
Description:
: This function presents the data associated with an object in the form of a list of integers.

objectDataHex

Function

Signature:: val objectDataHex : c_object -> string
Description:
: This function presents the data associated with an object in the form of string of hexadecimal digits.

objectDataAscii

Function

Signature:: val objectDataAscii : c_object -> string
Description:
: This function presents the data associated with an object in the form of an ASCII string.