jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added section on Iterators.

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@5103 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Dave Beazley 2003-09-12 17:47:13 +00:00
commit 52bf310b69
1 changed files with 39 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

66
SWIG/Doc/Manual/Extending.html
View file

@ -1054,20 +1054,6 @@ reference count on the corresponding object (if any). Returns 1
if an object was removed, 0 otherwise.
</blockquote>
<p>
<b><tt>String *Firstkey(Hash *h)</tt></b>
<blockquote>
Returns the first hash table key or NULL if the hash is empty. Used
for iteration.
</blockquote>
<p>
<b><tt>String *Nextkey(Hash *h)</tt></b>
<blockquote>
Returns the next hash table key or NULL if the end of the hash has been
reached. Used for iteration.
</blockquote>
<p>
<b><tt>List *Keys(Hash *h)</tt></b>
<blockquote>
@ -1128,19 +1114,6 @@ To delete the last item in the list, use the special value <tt>DOH_END</tt>
for <tt>n</tt>.
</blockquote>
<p>
<b><tt>Object *Firstitem(List *x)</tt></b>
<blockquote>
Returns the first item in <tt>x</tt> or NULL if the list is empty.
</blockquote>
<p>
<b><tt>Object *Nextitem(List *x)</tt></b>
<blockquote>
Returns the next item in <tt>x</tt> or NULL if the end of the list has been
reached. Used for iteration.
</blockquote>
<p>
<b><tt>void Append(List *x, Object_or_char *t)</tt></b>
<blockquote>
@ -1202,6 +1175,45 @@ objects and report errors.
Gets the line number associated with <tt>x</tt>.
</blockquote>
<H3>Iterating over Lists and Hashes</h3>
To iterate over the elements of a list or a hash table, the following functions are used:
<p>
<b><tt>Iterator First(Object *x)</tt></b>
<blockquote>
Returns an iterator object that points to the first item in a list or hash table. The
<tt>item</tt> attribute of the Iterator object is a pointer to the item. For hash tables, the <tt>key</tt> attribute
of the Iterator object additionally points to the corresponding Hash table key. The <tt>item</tt> and <tt>key</tt> attributes
are NULL if the object contains no items or if there are no more items.
</blockquote>
<p>
<b><tt>Iterator Next(Iterator i)</tt></b>
<blockquote>
Returns an iterator that points to the next item in a list or hash table.
</blockquote>
Here are two examples of iteration:
<blockquote>
<pre>
List *l = (some list);
Iterator i;
for (i = First(l); i.item; i = Next(i)) {
Printf(stdout,"%s\n", i.item);
}
Hash *h = (some hash);
Iterator j;
for (j = First(j); j.item; j= Next(j)) {
Printf(stdout,"%s : %s\n", j.key, j.item);
}
</pre>
</blockquote>
<a name="n19"></a><H3>23.5.5 I/O</H3>