NAME

src/pmc/stringiterator.pmc - StringIterator PMC

DESCRIPTION

Implementation of Iterator for String PMC to treat a string as array as in C but honoring the encoding.

SYNOPSIS

Methods

void init_pmc()

Initialize StringIterator.

void mark()

Marks the current idx/key and the aggregate as live.

PMC *clone()

INTVAL get_bool()

Returns true if there is more elements to iterate over.

INTVAL elements()

Returns the number of remaining elements in the string.

void set_integer_native(INTVAL value)

Reset the Iterator. value must be one of

 ITERATE_FROM_START        ... Iterate from start
 ITERATE_FROM_END          ... Iterate from end

PMC *get_pmc()

Returns this Iterator's string.

STRING *shift_pmc()

Shift next character from string as PMC.

STRING *shift_string()

Shift next character from string.

INTVAL shift_integer()

Shift next character code from string.

STRING *pop_pmc()

Shift "next" character from string for reverse iterator as PMC.

STRING *pop_string()

Shift "next" character from string for reverse iterator.

INTVAL pop_integer()

Shift "next" character code from string for reverse iterator.

INTVAL get_integer_keyed_int(INTVAL idx)

Get integer value of current position plus idx.

STRING *get_string_keyed_int(INTVAL idx)

Get string value of current position plus idx.