Upgrade iteration protocol

staticfloat · staticfloat · commit 5943278055c9 · 2018-08-08T09:21:33.000+01:00
diff --git a/src/Abstract/DynamicLink.jl b/src/Abstract/DynamicLink.jl
@@ -1,6 +1,6 @@
 # Export DynamicLinks API
 export DynamicLinks,
-       getindex, endof, length, start, next, done, eltype,
+       getindex, endof, length, iterate, lastindex, eltype,
        handle, header
        
 # Export Dynamic Link API
@@ -11,6 +11,8 @@ export DynamicLink,
 export RPath,
        handle, rpaths, canonical_rpaths, find_library
        
+# Import iteration protocol
+import Base: iterate, length, lastindex
 
 """
     DynamicLinks
@@ -24,23 +26,18 @@ given below, with methods that subclasses must implement marked in emphasis:
 
 ### Iteration
   - *getindex()*
-  - *endof()*
-  - length()
-  - start()
-  - next()
-  - done()
+  - *lastindex()*
+  - iterate()
   - eltype()
 
 ### Misc.
   - *handle()*
 """
 abstract type DynamicLinks{H <: ObjectHandle} end
 
-@mustimplement endof(dls::DynamicLinks)
-start(dls::DynamicLinks) = 1
-done(dls::DynamicLinks, idx) = idx > length(dls)
-next(dls::DynamicLinks, idx) = (dls[idx], idx+1)
-length(dls::DynamicLinks) = endof(dls)
+@mustimplement lastindex(dls::DynamicLinks)
+iterate(dls::DynamicLinks, idx=1) = idx > length(dls) ? nothing : (dls[idx], idx+1)
+length(dls::DynamicLinks) = lastindex(dls)
 eltype(::Type{D}) where {D <: DynamicLinks} = DynamicLink
 @mustimplement getindex(dls::DynamicLinks, idx)
 
@@ -83,6 +80,8 @@ marked in emphasis:
   - *rpaths()*
   - canonical_rpaths()
   - find_library()
+  - lastindex()
+  - iterate()
 """
 abstract type RPath{H <: ObjectHandle} end
 
@@ -107,11 +106,9 @@ Return the list of paths that will be searched for shared libraries.
 """
 @mustimplement rpaths(rpath::RPath)
 
-endof(rpath::RPath) = lastindex(rpaths(rpath))
-start(rpath::RPath) = 1
-done(rpath::RPath, idx) = idx > length(rpath)
-next(rpath::RPath, idx) = (rpath[idx], idx+1)
-length(rpath::RPath) = endof(rpath)
+lastindex(rpath::RPath) = lastindex(rpaths(rpath))
+iterate(rpaht::RPath, idx=1) = idx > length(rpath) ? nothing : (rpath[idx], idx+1)
+length(rpath::RPath) = lastindex(rpath)
 eltype(::Type{D}) where {D <: RPath} = String
 getindex(rpath::RPath, idx) = rpaths(rpath)[idx]
 
diff --git a/src/Abstract/Section.jl b/src/Abstract/Section.jl
@@ -1,6 +1,6 @@
 # Export Sections API
 export Sections,
-       getindex, endof, length, start, next, done, eltype,
+       getindex, endof, length, lastindex, iterate, eltype,
        find, findfirst,
        handle, header, format_string
 
@@ -14,8 +14,8 @@ export SectionRef,
        read, seekstart, seek, eof, section_number
 
 # Import Base methods for extension
-import Base: read, seek, seekstart, eof, start, length, done, next, endof,
-             eltype, find, findfirst
+import Base: read, seek, seekstart, eof, length, eltype, find,
+             findfirst, iterate, lastindex
 
 """
     Sections
@@ -32,11 +32,9 @@ in emphasis:
 
 ### Iteration
   - getindex()
-  - *endof()*
+  - *lastindex()*
   - length()
-  - start()
-  - next()
-  - done()
+  - iterate()
   - eltype()
 
 ### Search
@@ -49,11 +47,9 @@ in emphasis:
 abstract type Sections{H<:ObjectHandle} end
 
 # Fairly simple iteration interface specification
-@mustimplement endof(sections::Sections)
-start(sections::Sections) = 1
-done(sections::Sections, idx) = idx > length(sections)
-next(sections::Sections, idx) = (sections[idx], idx+1)
-length(sections::Sections) = endof(sections)
+@mustimplement lastindex(sections::Sections)
+length(sections::Sections) = lastindex(sections)
+iterate(sections::Sections, idx=1) = idx > length(sections) ? nothing : (sections[idx], idx+1)
 eltype(::Type{S}) where {S <: Sections} = SectionRef
 
 function getindex(sections::Sections, idx)
@@ -228,7 +224,6 @@ underlying `Section` API calls for ease of use.
   - seek()
   - eof()
 
-
 ### Format-specific properties:
   - section_name()
   - *section_number()*
diff --git a/src/Abstract/Segment.jl b/src/Abstract/Segment.jl
@@ -8,8 +8,7 @@ export Segment, deref, segment_name, segment_offset, segment_file_size,
 export SegmentRef, segment_number
 
 # Import Base stuff for extension
-import Base: getindex, endof, length, start, next, done, eltype, find,
-             findfirst
+import Base: getindex, length, eltype, find, findfirst, iterate, lastindex
 
 """
     Segments
@@ -26,11 +25,9 @@ in emphasis:
 
 ### Iteration
   - *getindex()*
-  - *endof()*
+  - *lastindex()*
   - length()
-  - start()
-  - next()
-  - done()
+  - iterate()
   - eltype()
 
 ### Search
@@ -43,11 +40,9 @@ in emphasis:
 abstract type Segments{H<:ObjectHandle} end
 
 # Fairly simple iteration interface specification
-@mustimplement endof(segs::Segments)
-start(segs::Segments) = 1
-done(segs::Segments, idx) = idx > length(segs)
-next(segs::Segments, idx) = (segs[idx], idx+1)
-length(segs::Segments) = endof(segs)
+@mustimplement lastindex(segs::Segments)
+length(segs::Segments) = lastindex(segs)
+iterate(segs::Segments, idx=1) = idx > length(segs) ? nothing : (segs[idx], idx+1)
 eltype(::Type{S}) where {S <: Segments} = SegmentRef
 
 function getindex(segs::Segments, idx)
diff --git a/src/Abstract/Symbol.jl b/src/Abstract/Symbol.jl
@@ -4,7 +4,7 @@
 
 # Export Symbols API
 export Symbols,
-       getindex, endof, length, start, next, done, eltype,
+       getindex, endof, length, iterate, lastindex, eltype,
        handle, header
        
 # Export SymtabEntry API
@@ -15,6 +15,8 @@ export SymtabEntry,
 export SymbolRef,
        symbol_number
 
+# Import iteration protocol
+import Base: length, iterate, lastindex
 
 """
     Symbols
@@ -31,11 +33,9 @@ in emphasis:
 
 ### Iteration
   - getindex()
-  - *endof()*
+  - *lastindex()*
   - length()
-  - start()
-  - next()
-  - done()
+  - iterate()
   - eltype()
 
 ### Misc.
@@ -44,11 +44,9 @@ in emphasis:
 abstract type Symbols{H<:ObjectHandle} end
 
 # Fairly simple iteration interface specification
-@mustimplement endof(syms::Symbols)
-start(syms::Symbols) = 1
-done(syms::Symbols, idx) = idx > length(syms)
-next(syms::Symbols, idx) = (syms[idx], idx+1)
-length(syms::Symbols) = endof(syms)
+@mustimplement lastindex(syms::Symbols)
+length(syms::Symbols) = lastindex(syms)
+iterate(syms::Symbols, idx=1) = idx > length(syms) ? nothing : (syms[idx], idx+1)
 eltype(::Type{S}) where {S <: Symbols} = SymbolRef
 
 function getindex(syms::Symbols{H}, idx) where {H <: ObjectHandle}
diff --git a/src/COFF/COFF.jl b/src/COFF/COFF.jl
@@ -6,12 +6,12 @@ using StructIO
 using ObjectFile
 import ObjectFile: DynamicLink, DynamicLinks, RPath, ObjectHandle, Section, Sections, SectionRef,
                    Segment, Segments, SegmentRef, StrTab, Symbols, SymtabEntry, SymbolRef,
-                   getindex, endof, length, start, next, done, eltype, handle, header, path,
+                   getindex, endof, length, lastindex, iterate, eltype, handle, header, path,
                    rpaths, canonical_rpaths, find_library, readmeta, seek, seekstart, skip,
                    iostream, position, read, readuntil, eof, endianness, is64bit, isrelocatable,
                    isexecutable, islibrary, isdynamic, mangle_section_name, mangle_symbol_name,
                    format_string, section_header_offset, section_header_size, section_header_type,
-                   segment_header_offset, segment_header_size, segment_header_type,
+                   segment_header_offset, segment_header_size, segment_header_type, start,
                    symtab_entry_offset, symtab_entry_size, symtab_entry_type, find_libraries,
                    find, findfirst, deref, contents, section_name, section_size,
                    section_offset, section_address, section_number, segment_name, segment_offset,
diff --git a/src/COFF/COFFDynamicLink.jl b/src/COFF/COFFDynamicLink.jl
@@ -49,7 +49,7 @@ end
 DynamicLinks(oh::COFFHandle) = COFFDynamicLinks(oh)
 
 handle(dls::COFFDynamicLinks) = dls.handle
-endof(dls::COFFDynamicLinks) = lastindex(dls.links)
+lastindex(dls::COFFDynamicLinks) = lastindex(dls.links)
 getindex(dls::COFFDynamicLinks, idx) = getindex(dls.links, idx)
 
 
diff --git a/src/COFF/COFFSection.jl b/src/COFF/COFFSection.jl
@@ -12,7 +12,7 @@ Sections(oh::COFFHandle) = COFFSections(oh)
 
 # Implement Sections API
 handle(sections::COFFSections) = sections.handle
-endof(sections::COFFSections) = num_sections(header(handle(sections)))
+lastindex(sections::COFFSections) = num_sections(header(handle(sections)))
 
 
 """
diff --git a/src/COFF/COFFSymbol.jl b/src/COFF/COFFSymbol.jl
@@ -54,7 +54,7 @@ handle(syms::COFFSymbols) = syms.handle
 #     next_idx = idx + deref(syms[idx]).NumberOfAuxSymbols + 1
 #     return (syms[idx], next_idx)
 # end
-endof(syms::COFFSymbols) = num_symbols(header(handle(syms)))
+lastindex(syms::COFFSymbols) = num_symbols(header(handle(syms)))
 
 # We override `iteratorsize` so that list comprehensions and collect() calls on
 # our Symbols don't have a bunch of #undef entries at the end of the array
diff --git a/src/ELF/ELF.jl b/src/ELF/ELF.jl
@@ -6,12 +6,12 @@ using StructIO
 using ObjectFile
 import ObjectFile: DynamicLink, DynamicLinks, RPath, ObjectHandle, Section, Sections, SectionRef,
                    Segment, Segments, SegmentRef, StrTab, Symbols, SymtabEntry, SymbolRef,
-                   getindex, endof, length, start, next, done, eltype, handle, header, path,
+                   getindex, endof, length, iterate, lastindex, eltype, handle, header, path,
                    rpaths, canonical_rpaths, find_library, readmeta, seek, seekstart, skip,
                    iostream, position, read, readuntil, eof, endianness, is64bit, isrelocatable,
                    isexecutable, islibrary, isdynamic, mangle_section_name, mangle_symbol_name,
                    format_string, section_header_offset, section_header_size, section_header_type,
-                   segment_header_offset, segment_header_size, segment_header_type,
+                   segment_header_offset, segment_header_size, segment_header_type, start,
                    symtab_entry_offset, symtab_entry_size, symtab_entry_type, find_libraries,
                    find, findfirst, deref, contents, section_name, section_size,
                    section_offset, section_address, section_number, segment_name, segment_offset,
diff --git a/src/ELF/ELFDynamicLink.jl b/src/ELF/ELFDynamicLink.jl
@@ -45,7 +45,7 @@ function DynamicLinks(oh::ELFHandle)
 end
 Section(dls::ELFDynamicLinks) = dls.section_ref
 handle(dls::ELFDynamicLinks) = handle(Section(dls))
-endof(dls::ELFDynamicLinks) = lastindex(dls.links)
+lastindex(dls::ELFDynamicLinks) = lastindex(dls.links)
 getindex(dls::ELFDynamicLinks, idx) = getindex(dls.links, idx)
 
 """
diff --git a/src/ELF/ELFRelocation.jl b/src/ELF/ELFRelocation.jl
@@ -43,7 +43,7 @@ deref(x::RelocationRef) = x.reloc
 
 entrysize{T}(s::Relocations{T}) = sizeof(T)
 endof{T}(s::Relocations{T}) = div(s.sec.header.sh_size,entrysize(s))
-length(r::Relocations) = endof(r)
+length(r::Relocations) = lastindex(r)
 function getindex{T}(s::Relocations{T},n)
     if n < 1 || n > length(s)
         throw(BoundsError())
@@ -53,10 +53,7 @@ function getindex{T}(s::Relocations{T},n)
     RelocationRef{T}(s.sec.handle,unpack(s.sec.handle, T))
 end
 
-
-start(s::Relocations) = 1
-done(s::Relocations,n) = n > length(s)
-next(s::Relocations,n) = (x=s[n];(x,n+1))
+iterate(s::Relocations, idx=1) = idx > length(s) ? nothing : (s[idx], idx+1)
 
 # Utilities for extracting information from relocation entries
 r_sym(rel::Union{ELF32.Rel,ELF32.Rela}) = rel.r_info >> 8
diff --git a/src/ELF/ELFSection.jl b/src/ELF/ELFSection.jl
@@ -17,7 +17,7 @@ Sections(oh::ELFHandle) = ELFSections(oh)
 
 # Implement Sections API
 handle(sections::ELFSections) = sections.handle
-endof(sections::ELFSections) = header(handle(sections)).e_shnum
+lastindex(sections::ELFSections) = header(handle(sections)).e_shnum
 
 
 """
diff --git a/src/ELF/ELFSegment.jl b/src/ELF/ELFSegment.jl
@@ -13,11 +13,9 @@ Segments(oh::ELFHandle) = ELFSegments(oh)
 handle(segs::ELFSegments) = segs.handle
 
 # Iteration
-start(segs::ELFSegments) = 1
-endof(segs::ELFSegments) = header(handle(segs)).e_phnum
-done(segs::ELFSegments, idx) = idx > length(segs)
-next(segs::ELFSegments, idx) = (segs[idx], idx+1)
-length(segs::ELFSegments) = endof(segs)
+iterate(segs::ELFSegments, idx=1) = idx > length(segs) ? nothing : (segs[idx], idx+1)
+lastindex(segs::ELFSegments) = header(handle(segs)).e_phnum
+length(segs::ELFSegments) = lastindex(segs)
 eltype(::Type{S}) where {S <: ELFSegments} = ELFSegmentRef
 
 function getindex(segs::ELFSegments{H}, idx) where {H <: ELFHandle}
diff --git a/src/ELF/ELFSymbol.jl b/src/ELF/ELFSymbol.jl
@@ -44,7 +44,7 @@ Section(syms::ELFSymbols) = syms.section_ref
 handle(syms::ELFSymbols) = handle(Section(syms))
 symtab_entry_type(syms::ELFSymbols) = symtab_entry_type(handle(syms))
 
-function endof(syms::ELFSymbols{H}) where {H <: ELFHandle}
+function lastindex(syms::ELFSymbols{H}) where {H <: ELFHandle}
     sect_size = section_size(Section(syms))
     sym_size = sizeof(symtab_entry_type(syms))
     return div(sect_size, sym_size)
diff --git a/src/MachO/MachO.jl b/src/MachO/MachO.jl
@@ -6,12 +6,12 @@ using StructIO
 using ObjectFile
 import ObjectFile: DynamicLink, DynamicLinks, RPath, ObjectHandle, Section, Sections, SectionRef,
                    Segment, Segments, SegmentRef, StrTab, Symbols, SymtabEntry, SymbolRef,
-                   getindex, endof, length, start, next, done, eltype, handle, header, path,
+                   getindex, endof, length, iterate, lastindex, eltype, handle, header, path,
                    rpaths, canonical_rpaths, find_library, readmeta, seek, seekstart, skip,
                    iostream, position, read, readuntil, eof, endianness, is64bit, isrelocatable,
                    isexecutable, islibrary, isdynamic, mangle_section_name, mangle_symbol_name,
                    format_string, section_header_offset, section_header_size, section_header_type,
-                   segment_header_offset, segment_header_size, segment_header_type,
+                   segment_header_offset, segment_header_size, segment_header_type, start,
                    symtab_entry_offset, symtab_entry_size, symtab_entry_type, find_libraries,
                    find, findfirst, deref, contents, section_name, section_size,
                    section_offset, section_address, section_number, segment_name, segment_offset,
diff --git a/src/MachO/MachODynamicLink.jl b/src/MachO/MachODynamicLink.jl
@@ -14,7 +14,7 @@ MachODynamicLinks(oh::MachOHandle) = MachODynamicLinks(MachOLoadCmds(oh))
 DynamicLinks(oh::MachOHandle) = MachODynamicLinks(oh)
 DynamicLinks(lcs::MachOLoadCmds) = MachODynamicLinks(lcs)
 
-endof(dls::MachODynamicLinks) = lastindex(dls.cmds)
+lastindex(dls::MachODynamicLinks) = lastindex(dls.cmds)
 function getindex(dls::MachODynamicLinks, idx)
     return MachODynamicLink(dls, dls.cmds[idx])
 end
diff --git a/src/MachO/MachOLoadCmd.jl b/src/MachO/MachOLoadCmd.jl
@@ -52,11 +52,9 @@ Allows iteration over the LoadCmds within a Mach-O file.
 
 ### Iteration
   - getindex()
-  - endof()
+  - lastindex()
+  - iterate()
   - length()
-  - start()
-  - next()
-  - done()
   - eltype()
 
 ### Access
@@ -146,10 +144,8 @@ handle(lcs::MachOLoadCmds) = lcs.handle
 header(lcs::MachOLoadCmds) = header(handle(lcs))
 
 # Iteration
-start(lcs::MachOLoadCmds) = start(lcs.cmds)
-endof(lcs::MachOLoadCmds) = endof(lcs.cmds)
-done(lcs::MachOLoadCmds, idx) = done(lcs.cmds, idx)
-next(lcs::MachOLoadCmds, idx) = (lcs[idx], idx+1)
+iterate(lcs::MachOLoadCmds, idx=1) = idx > length(lcs) ? nothing : (lcs.cmds[idx], idx+1)
+lastindex(lcs::MachOLoadCmds) = lastindex(lcs.cmds)
 length(lcs::MachOLoadCmds) = length(lcs.cmds)
 eltype(::Type{S}) where {S <: MachOLoadCmds} = MachOLoadCmdRef
 function getindex(l::MachOLoadCmds, idx)
diff --git a/src/MachO/MachOSection.jl b/src/MachO/MachOSection.jl
@@ -97,7 +97,7 @@ function MachOSections(segs::MachOSegments)
 end
 
 handle(sections::MachOSections) = sections.handle
-endof(sections::MachOSections) = lastindex(sections.sections)
+lastindex(sections::MachOSections) = lastindex(sections.sections)
 getindex(sections::MachOSections, idx) = getindex(sections.sections, idx)
 
 Sections(segs::MachOSegments) = MachOSections(segs)
diff --git a/src/MachO/MachOSegment.jl b/src/MachO/MachOSegment.jl
diff --git a/src/MachO/MachOSymbol.jl b/src/MachO/MachOSymbol.jl
