NAME ^

src/packfile/pf_items.c - Fetch/store packfile data

DESCRIPTION ^

Low level packfile functions to fetch and store Parrot data, i.e. INTVAL, FLOATVAL, STRING ...

PF_fetch_<item>() functions retrieve the datatype item from the opcode stream and convert byteordering or binary format on the fly, depending on the packfile header.

PF_store_<item>() functions write the datatype item to the stream as is. These functions don't check the available size.

PF_size_<item>() functions return the store size of item in opcode_t units.

Functions ^

static void cvt_num12_num8(NOTNULL(unsigned char *dest), NOTNULL(const unsigned char *src))

convert i386 LE 12 byte long double to IEEE 754 8 byte double

static void cvt_num12_num8_be(NOTNULL(unsigned char *dest), NOTNULL(const unsigned char *src))

TODO: Not yet documented!!!

static void cvt_num12_num8_le(NOTNULL(unsigned char *dest), NOTNULL(unsigned char *src))

TODO: Not yet documented!!!

static opcode_t fetch_op_test(NOTNULL(unsigned char *b))

TODO: Not yet documented!!!

static opcode_t fetch_op_mixed_le(NOTNULL(unsigned char *b))

opcode fetch helper function

This is mostly wrong or at least untested

Fetch an opcode and convert to LE

static opcode_t fetch_op_mixed_be(NOTNULL(unsigned char *b))

Fetch an opcode and convert to BE

static opcode_t fetch_op_be_4(NOTNULL(unsigned char *b))

TODO: Not yet documented!!!

static opcode_t fetch_op_be_8(NOTNULL(unsigned char *b))

TODO: Not yet documented!!!

static opcode_t fetch_op_le_4(NOTNULL(unsigned char *b))

TODO: Not yet documented!!!

static opcode_t fetch_op_le_8(NOTNULL(unsigned char *b))

TODO: Not yet documented!!!

PARROT_WARN_UNUSED_RESULT opcode_t PF_fetch_opcode(NULLOK(PackFile *pf), NOTNULL(opcode_t **stream))

Fetch an opcode_t from the stream, converting byteorder if needed.

PARROT_WARN_UNUSED_RESULT PARROT_CANNOT_RETURN_NULL opcode_t *PF_store_opcode(NOTNULL(opcode_t *cursor), opcode_t val)

Store an opcode_t to stream as is.

PARROT_CONST_FUNCTION size_t PF_size_opcode(void)

Return size of an item in opcode_t units, which is 1 per definitionem.

PARROT_WARN_UNUSED_RESULT INTVAL PF_fetch_integer(NULLOK(PackFile *pf), NOTNULL(opcode_t **stream))

Fetch an INTVAL from the stream, converting byteorder if needed.

XXX assumes sizeof (INTVAL) == sizeof (opcode_t) - we don't have INTVAL size in the PackFile header.

PARROT_WARN_UNUSED_RESULT PARROT_CANNOT_RETURN_NULL opcode_t *PF_store_integer(NOTNULL(opcode_t *cursor), INTVAL val)

Store an INTVAL to stream as is.

PARROT_CONST_FUNCTION size_t PF_size_integer(void)

Return store size of INTVAL in opcode_t units.

PARROT_WARN_UNUSED_RESULT FLOATVAL PF_fetch_number(NULLOK(PackFile *pf), NOTNULL(opcode_t **stream))

Fetch a FLOATVAL from the stream, converting byteorder if needed. Then advance stream pointer by amount of packfile float size.

PARROT_WARN_UNUSED_RESULT PARROT_CANNOT_RETURN_NULL opcode_t *PF_store_number(NOTNULL(opcode_t *cursor), NOTNULL(const FLOATVAL *val))

Write a FLOATVAL to the opcode stream as is.

PARROT_CONST_FUNCTION size_t PF_size_number(void)

Return store size of FLOATVAL in opcode_t units.

PARROT_WARN_UNUSED_RESULT PARROT_CANNOT_RETURN_NULL STRING *PF_fetch_string(PARROT_INTERP, NULLOK(PackFile *pf), NOTNULL(opcode_t **cursor))

Fetch a STRING from bytecode and return a new STRING.

Opcode format is:

    opcode_t flags
    opcode_t encoding
    opcode_t type
    opcode_t size
    * data
PARROT_WARN_UNUSED_RESULT PARROT_CANNOT_RETURN_NULL opcode_t *PF_store_string(NOTNULL(opcode_t *cursor), NOTNULL(STRING *s))

Write a STRING to the opcode stream.

PARROT_PURE_FUNCTION size_t PF_size_string(NOTNULL(const STRING *s))

Report store size of STRING in opcode_t units.

PARROT_MALLOC PARROT_CANNOT_RETURN_NULL char *PF_fetch_cstring(NOTNULL(PackFile *pf), NOTNULL(opcode_t **cursor))

Fetch a cstring from bytecode and return an allocated copy

PARROT_WARN_UNUSED_RESULT PARROT_CANNOT_RETURN_NULL opcode_t *PF_store_cstring(NOTNULL(opcode_t *cursor), NOTNULL(const char *s))

Write a 0-terminated string to the stream.

PARROT_PURE_FUNCTION size_t PF_size_cstring(NOTNULL(const char *s))

Return store size of a C-string in opcode_t units.

void PackFile_assign_transforms(NOTNULL(PackFile *pf))

Assign transform functions to vtable.

HISTORY ^

Initial review by leo 2003.11.21

Most routines moved from src/packfile.c.

Renamed PackFile_* to PF_*

TODO ^

<PF_store_<type()>> - write an opcode_t stream to cursor in natural byte-ordering.

<PF_fetch_<type()>> - read items and possibly convert the foreign format.

<PF_size_<type()>> - return the needed size in opcode_t units.


 parrot