[svn:parrot] r38012 - branches/packfile_revamp/docs/pdds

[bacek at svn.parrot.org]

Author: bacek
Date: Fri Apr 10 05:31:07 2009
New Revision: 38012
URL: https://trac.parrot.org/parrot/changeset/38012

Log:
Remove int-based accessors from PackfileDirectory. Add get_iter method.

Modified:
   branches/packfile_revamp/docs/pdds/pdd13_bytecode.pod

Modified: branches/packfile_revamp/docs/pdds/pdd13_bytecode.pod
==============================================================================
--- branches/packfile_revamp/docs/pdds/pdd13_bytecode.pod	Fri Apr 10 05:30:48 2009	(r38011)
+++ branches/packfile_revamp/docs/pdds/pdd13_bytecode.pod	Fri Apr 10 05:31:07 2009	(r38012)
@@ -875,10 +875,8 @@
 
 =head4 PackfileDirectory.pmc (isa PackfileSegment)
 
-This PMC represents a directory segment. Essentially it is an array of
-PackfileSegment PMCs. When indexed using an integer key, it gets the segment
-at that position in the segments table. When indexed using a string key, it
-looks for a segment of that name. It implements the following methods:
+This PMC represents a directory segment. Essentially it is an hash of
+PackfileSegment PMCs. It implements the following methods:
 
 =over 4
 
@@ -886,16 +884,6 @@
 
 Gets the number of segments listed in the directory.
 
-=item * C<get_pmc_keyed_int> (v-table)
-
-Gets a PackfileSegment PMC or an appropriate subclass of it representing the
-segment at the specified index in the directory segment.
-
-=item * C<get_string_keyed_int> (v-table)
-
-Gets a string containing the name of the segment at the specified index in the
-directory segment.
-
 =item * C<get_pmc_keyed_str> (v-table)
 
 Searches the directory for a segment with the given name and, if one exists,
@@ -914,6 +902,10 @@
 specified by the key.  This is the only way to remove a segment from the
 directory.
 
+=item * C<get_iter> (v-table)
+
+Returns iterator for existing keys.
+
 =back
 
 =head4 RawSegment.pmc (isa PackfileSegment)