<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Parrot - StringIterator PMC</title> <link rel="stylesheet" type="text/css" href="../../../resources/parrot.css" media="all"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> </head> <body> <div id="wrapper"> <div id="header"> <a href="http://www.parrot.org"> <img border=0 src="../../../resources/parrot_logo.png" id="logo" alt="parrot"> </a> </div> <!-- "header" --> <div id="divider"></div> <div id="mainbody"> <div id="breadcrumb"> <a href="../../../html/index.html">Home</a> » <a href="../../../html/pmc.html">PMCs</a> » StringIterator PMC </div> <h1><a name="NAME" >NAME</a></h1> <p>src/pmc/stringiterator.pmc - StringIterator PMC</p> <h1><a name="DESCRIPTION" >DESCRIPTION</a></h1> <p>Implementation of Iterator for String PMC.</p> <h1><a name="SYNOPSIS" >SYNOPSIS</a></h1> <h1><a name="Methods" >Methods</a></h1> <dl> <dt><a name="void_init_pmc()" ><b><code>void init_pmc()</b></code></a></dt> Initialize StringIterator. <dt><a name="void_mark()" ><b><code>void mark()</b></code></a></dt> Marks the current idx/key and the aggregate as live. <dt><a name="PMC_*clone()" ><b><code>PMC *clone()</b></code></a></dt> <dt><a name="INTVAL_get_bool()" ><b><code>INTVAL get_bool()</b></code></a></dt> Returns true if there is more elements to iterate over. <dt><a name="INTVAL_elements()" ><b><code>INTVAL elements()</b></code></a></dt> Returns the number of remaining elements in the <code>string</code>. <dt><a name="void_set_integer_native(INTVAL_value)" ><b><code>void set_integer_native(INTVAL value)</b></code></a></dt> Reset the Iterator. <code>value</code> must be one of <pre> ITERATE_FROM_START ... Iterate from start ITERATE_FROM_END ... Iterate from end</pre> <dt><a name="PMC_*get_pmc()" ><b><code>PMC *get_pmc()</b></code></a></dt> Returns this Iterator's string. <dt><a name="STRING_*shift_pmc()" ><b><code>STRING *shift_pmc()</b></code></a></dt> Shift next character from <code>string</code> as PMC. <dt><a name="STRING_*shift_string()" ><b><code>STRING *shift_string()</b></code></a></dt> Shift next character from <code>string</code>. <dt><a name="INTVAL_shift_integer()" ><b><code>INTVAL shift_integer()</b></code></a></dt> Shift next character code from <code>string</code>. <dt><a name="STRING_*pop_pmc()" ><b><code>STRING *pop_pmc()</b></code></a></dt> Shift "next" character from <code>string</code> for reverse iterator as PMC. <dt><a name="STRING_*pop_string()" ><b><code>STRING *pop_string()</b></code></a></dt> Shift "next" character from <code>string</code> for reverse iterator. <dt><a name="INTVAL_pop_integer()" ><b><code>INTVAL pop_integer()</b></code></a></dt> Shift "next" character code from <code>string</code> for reverse iterator. <dt><a name="INTVAL_get_integer_keyed_int(INTVAL_idx)" ><b><code>INTVAL get_integer_keyed_int(INTVAL idx)</b></code></a></dt> Get integer value of current position plus idx. <dt><a name="STRING_*get_string_keyed_int(INTVAL_idx)" ><b><code>STRING *get_string_keyed_int(INTVAL idx)</b></code></a></dt> Get string value of current position plus idx.</dl> </div> <!-- "mainbody" --> <div id="divider"></div> <div id="footer"> Copyright © 2002-2011, Parrot Foundation. </div> </div> <!-- "wrapper" --> </body> </html>