read/coff: add helpers to unified API for accessing lower level API

gimli-rs · May 4, 2024 · e6a6044 · e6a6044
1 parent 9a7202f
commit e6a6044
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 1 deletion.
diff --git a/src/read/coff/file.rs b/src/read/coff/file.rs
@@ -63,6 +63,21 @@ impl<'data, R: ReadRef<'data>, Coff: CoffHeader> CoffFile<'data, R, Coff> {
             data,
         })
     }
+
+    /// Get the raw COFF file header.
+    pub fn coff_header(&self) -> &'data Coff {
+        self.header
+    }
+
+    /// Get the COFF section table.
+    pub fn coff_section_table(&self) -> SectionTable<'data> {
+        self.common.sections
+    }
+
+    /// Get the COFF symbol table.
+    pub fn coff_symbol_table(&self) -> &SymbolTable<'data, R, Coff> {
+        &self.common.symbols
+    }
 }
 
 impl<'data, R: ReadRef<'data>, Coff: CoffHeader> read::private::Sealed

diff --git a/src/read/coff/section.rs b/src/read/coff/section.rs
@@ -157,6 +157,16 @@ pub struct CoffSegment<
 }
 
 impl<'data, 'file, R: ReadRef<'data>, Coff: CoffHeader> CoffSegment<'data, 'file, R, Coff> {
+    /// Get the COFF file containing this segment.
+    pub fn coff_file(&self) -> &'file CoffFile<'data, R, Coff> {
+        self.file
+    }
+
+    /// Get the raw COFF section header.
+    pub fn coff_section(&self) -> &'data pe::ImageSectionHeader {
+        self.section
+    }
+
     fn bytes(&self) -> Result<&'data [u8]> {
         self.section
             .coff_data(self.file.data)
@@ -281,6 +291,21 @@ pub struct CoffSection<
 }
 
 impl<'data, 'file, R: ReadRef<'data>, Coff: CoffHeader> CoffSection<'data, 'file, R, Coff> {
+    /// Get the COFF file containing this section.
+    pub fn coff_file(&self) -> &'file CoffFile<'data, R, Coff> {
+        self.file
+    }
+
+    /// Get the raw COFF section header.
+    pub fn coff_section(&self) -> &'data pe::ImageSectionHeader {
+        self.section
+    }
+
+    /// Get the raw COFF relocations for this section.
+    pub fn coff_relocations(&self) -> Result<&'data [pe::ImageRelocation]> {
+        self.section.coff_relocations(self.file.data)
+    }
+
     fn bytes(&self) -> Result<&'data [u8]> {
         self.section
             .coff_data(self.file.data)
@@ -377,7 +402,7 @@ impl<'data, 'file, R: ReadRef<'data>, Coff: CoffHeader> ObjectSection<'data>
     }
 
     fn relocations(&self) -> CoffRelocationIterator<'data, 'file, R, Coff> {
-        let relocations = self.section.coff_relocations(self.file.data).unwrap_or(&[]);
+        let relocations = self.coff_relocations().unwrap_or(&[]);
         CoffRelocationIterator {
             file: self.file,
             iter: relocations.iter(),

diff --git a/src/read/coff/symbol.rs b/src/read/coff/symbol.rs
@@ -296,9 +296,15 @@ where
 impl<'data, 'file, R: ReadRef<'data>, Coff: CoffHeader> CoffSymbol<'data, 'file, R, Coff> {
     #[inline]
     /// Get the raw `ImageSymbol` struct.
+    #[deprecated(note = "Use `coff_symbol` instead")]
     pub fn raw_symbol(&self) -> &'data Coff::ImageSymbol {
         self.symbol
     }
+
+    /// Get the raw `ImageSymbol` struct.
+    pub fn coff_symbol(&self) -> &'data Coff::ImageSymbol {
+        self.symbol
+    }
 }
 
 impl<'data, 'file, R: ReadRef<'data>, Coff: CoffHeader> read::private::Sealed

diff --git a/src/read/pe/section.rs b/src/read/pe/section.rs
@@ -64,6 +64,22 @@ where
     section: &'data pe::ImageSectionHeader,
 }
 
+impl<'data, 'file, Pe, R> PeSegment<'data, 'file, Pe, R>
+where
+    Pe: ImageNtHeaders,
+    R: ReadRef<'data>,
+{
+    /// Get the PE file containing this segment.
+    pub fn pe_file(&self) -> &'file PeFile<'data, Pe, R> {
+        self.file
+    }
+
+    /// Get the raw PE section header.
+    pub fn pe_section(&self) -> &'data pe::ImageSectionHeader {
+        self.section
+    }
+}
+
 impl<'data, 'file, Pe, R> read::private::Sealed for PeSegment<'data, 'file, Pe, R>
 where
     Pe: ImageNtHeaders,
@@ -189,6 +205,22 @@ where
     pub(super) section: &'data pe::ImageSectionHeader,
 }
 
+impl<'data, 'file, Pe, R> PeSection<'data, 'file, Pe, R>
+where
+    Pe: ImageNtHeaders,
+    R: ReadRef<'data>,
+{
+    /// Get the PE file containing this segment.
+    pub fn pe_file(&self) -> &'file PeFile<'data, Pe, R> {
+        self.file
+    }
+
+    /// Get the raw PE section header.
+    pub fn pe_section(&self) -> &'data pe::ImageSectionHeader {
+        self.section
+    }
+}
+
 impl<'data, 'file, Pe, R> read::private::Sealed for PeSection<'data, 'file, Pe, R>
 where
     Pe: ImageNtHeaders,