NAME

pf/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

opcode_t PF_fetch_opcode(struct PackFile *pf, opcode_t **stream)

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

opcode_t *PF_store_opcode(opcode_t *cursor, opcode_t val)

Store an opcode_t to stream as is.

size_t PF_size_opcode(void)

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

INTVAL PF_fetch_integer(struct PackFile *pf, 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.

opcode_t *PF_store_integer(opcode_t *cursor, INTVAL val)

Store an INTVAL to stream as is.

size_t PF_size_integer(void)

Return store size of INTVAL in opcode_t units.

FLOATVAL PF_fetch_number(struct PackFile *pf, opcode_t **stream)

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

opcode_t *PF_store_number(opcode_t *cursor, FLOATVAL *val)

Write a FLOATVAL to the opcode stream as is.

size_t PF_size_number(void)

Return store size of FLOATVAL in opcode_t units.

STRING *PF_fetch_string(Parrot_Interp interp, struct PackFile *pf, 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

opcode_t *PF_store_string(opcode_t *cursor, STRING *s)

Write a STRING to the opcode stream.

size_t PF_size_string(STRING *s)

Report store size of STRING in opcode_t units.

char *PF_fetch_cstring(struct PackFile *pf, opcode_t **cursor)

Fetch a cstring from bytecode and return an allocated copy

opcode_t *PF_store_cstring(opcode_t *cursor, const char *s)

Write a 0-terminate string to the stream.

size_t PF_size_cstring(const char *s)

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

void PackFile_assign_transforms(struct 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.