Add keys() API to collections for usage with things like findfirst()

Author: staticfloat

src/Abstract/DynamicLink.jl

@@ -1,6 +1,6 @@
 # Export DynamicLinks API
 export DynamicLinks,
-       getindex, length, iterate, lastindex, eltype,
+       getindex, length, iterate, keys, lastindex, eltype,
        handle, header
 
 # Export Dynamic Link API
@@ -12,7 +12,7 @@ export RPath,
        handle, rpaths, canonical_rpaths, find_library
 
 # Import iteration protocol
-import Base: iterate, length, lastindex
+import Base: iterate, keys, length, lastindex
 
 """
     DynamicLinks
@@ -28,6 +28,7 @@ given below, with methods that subclasses must implement marked in emphasis:
   - *getindex()*
   - *lastindex()*
   - iterate()
+  - keys()
   - eltype()
 
 ### Misc.
@@ -36,6 +37,7 @@ given below, with methods that subclasses must implement marked in emphasis:
 abstract type DynamicLinks{H <: ObjectHandle} end
 
 @mustimplement lastindex(dls::DynamicLinks)
+keys(dls::DynamicLinks) = 1:length(dls)
 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
@@ -107,6 +109,7 @@ Return the list of paths that will be searched for shared libraries.
 @mustimplement rpaths(rpath::RPath)
 
 lastindex(rpath::RPath) = lastindex(rpaths(rpath))
+keys(rpath::RPath) = 1:length(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

src/Abstract/Section.jl

@@ -1,6 +1,6 @@
 # Export Sections API
 export Sections,
-       getindex, length, lastindex, iterate, eltype,
+       getindex, length, lastindex, iterate, keys, eltype,
        findall, findfirst,
        handle, header, format_string
 
@@ -15,7 +15,7 @@ export SectionRef,
 
 # Import Base methods for extension
 import Base: read, seek, seekstart, eof, length, eltype, findall,
-             findfirst, iterate, lastindex
+             findfirst, iterate, keys, lastindex
 
 """
     Sections
@@ -35,6 +35,7 @@ in emphasis:
   - *lastindex()*
   - length()
   - iterate()
+  - keys()
   - eltype()
 
 ### Search
@@ -49,6 +50,7 @@ abstract type Sections{H<:ObjectHandle} end
 # Fairly simple iteration interface specification
 @mustimplement lastindex(sections::Sections)
 length(sections::Sections) = lastindex(sections)
+keys(sections::Sections) = 1:length(sections)
 iterate(sections::Sections, idx=1) = idx > length(sections) ? nothing : (sections[idx], idx+1)
 eltype(::Type{S}) where {S <: Sections} = SectionRef
 

src/Abstract/Segment.jl

@@ -8,7 +8,7 @@ export Segment, deref, segment_name, segment_offset, segment_file_size,
 export SegmentRef, segment_number
 
 # Import Base stuff for extension
-import Base: getindex, length, eltype, findfirst, findall, iterate, lastindex
+import Base: getindex, length, eltype, findfirst, findall, iterate, keys, lastindex
 
 """
     Segments
@@ -28,6 +28,7 @@ in emphasis:
   - *lastindex()*
   - length()
   - iterate()
+  - keys()
   - eltype()
 
 ### Search
@@ -42,6 +43,7 @@ abstract type Segments{H<:ObjectHandle} end
 # Fairly simple iteration interface specification
 @mustimplement lastindex(segs::Segments)
 length(segs::Segments) = lastindex(segs)
+keys(segs::Segments) = 1:length(segs)
 iterate(segs::Segments, idx=1) = idx > length(segs) ? nothing : (segs[idx], idx+1)
 eltype(::Type{S}) where {S <: Segments} = SegmentRef
 

src/COFF/COFF.jl

@@ -6,7 +6,7 @@ using StructIO
 using ObjectFile
 import ObjectFile: DynamicLink, DynamicLinks, RPath, ObjectHandle, Section, Sections, SectionRef,
                    Segment, Segments, SegmentRef, StrTab, Symbols, SymtabEntry, SymbolRef,
-                   getindex, length, lastindex, iterate, eltype, handle, header, path,
+                   getindex, length, lastindex, iterate, keys, 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,

src/ELF/ELFRelocation.jl

@@ -53,6 +53,7 @@ function getindex{T}(s::Relocations{T},n)
     RelocationRef{T}(s.sec.handle,unpack(s.sec.handle, T))
 end
 
+keys(s::Relocations) = 1:length(s)
 iterate(s::Relocations, idx=1) = idx > length(s) ? nothing : (s[idx], idx+1)
 
 # Utilities for extracting information from relocation entries

src/MachO/MachO.jl

@@ -6,7 +6,7 @@ using StructIO
 using ObjectFile
 import ObjectFile: DynamicLink, DynamicLinks, RPath, ObjectHandle, Section, Sections, SectionRef,
                    Segment, Segments, SegmentRef, StrTab, Symbols, SymtabEntry, SymbolRef,
-                   getindex, length, iterate, lastindex, eltype, handle, header, path,
+                   getindex, length, iterate, keys, 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,

src/MachO/MachOLoadCmd.jl

@@ -54,6 +54,7 @@ Allows iteration over the LoadCmds within a Mach-O file.
   - getindex()
   - lastindex()
   - iterate()
+  - keys()
   - length()
   - eltype()
 
@@ -144,6 +145,7 @@ handle(lcs::MachOLoadCmds) = lcs.handle
 header(lcs::MachOLoadCmds) = header(handle(lcs))
 
 # Iteration
+keys(lcs::MachOLoadCmds) = 1:length(lcs)
 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)