Fix typo and update the changelog

lief-project · Nov 18, 2023 · df97777 · df97777
1 parent 529d5a8
commit df97777
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 38 deletions.
diff --git a/api/python/lief/__init__.pyi b/api/python/lief/__init__.pyi
@@ -31,6 +31,15 @@ class ARCHITECTURES:
     def value(self) -> int: ...
 
 class Binary(Object):
+    class FORMATS:
+        ELF: ClassVar[Binary.FORMATS] = ...
+        MACHO: ClassVar[Binary.FORMATS] = ...
+        OAT: ClassVar[Binary.FORMATS] = ...
+        PE: ClassVar[Binary.FORMATS] = ...
+        UNKNOWN: ClassVar[Binary.FORMATS] = ...
+        __name__: Any
+        def __init__(self, *args, **kwargs) -> None: ...
+
     class VA_TYPES:
         AUTO: ClassVar[Binary.VA_TYPES] = ...
         RVA: ClassVar[Binary.VA_TYPES] = ...
@@ -81,7 +90,7 @@ class Binary(Object):
     @property
     def exported_functions(self) -> list[lief.Function]: ...
     @property
-    def format(self) -> lief.EXE_FORMATS: ...
+    def format(self) -> lief.Binary.FORMATS: ...
     @property
     def has_nx(self) -> bool: ...
     @property
@@ -112,18 +121,6 @@ class ENDIANNESS:
     @property
     def value(self) -> int: ...
 
-class EXE_FORMATS:
-    ELF: ClassVar[EXE_FORMATS] = ...
-    MACHO: ClassVar[EXE_FORMATS] = ...
-    PE: ClassVar[EXE_FORMATS] = ...
-    UNKNOWN: ClassVar[EXE_FORMATS] = ...
-    __name__: Any
-    def __init__(self, *args, **kwargs) -> None: ...
-    @staticmethod
-    def from_value(arg: int, /) -> lief.EXE_FORMATS: ...
-    @property
-    def value(self) -> int: ...
-
 class Function(Symbol):
     class FLAGS:
         CONSTRUCTOR: ClassVar[Function.FLAGS] = ...

diff --git a/api/python/src/Abstract/pyBinary.cpp b/api/python/src/Abstract/pyBinary.cpp
@@ -56,7 +56,7 @@ void create<Binary>(nb::module_& m) {
 # undef ENTRY
 
 # define ENTRY(X) .value(to_string(Binary::FORMATS::X), Binary::FORMATS::X)
-  nb::enum_<Binary::FORMATS>(pybinary, "VA_TYPES")
+  nb::enum_<Binary::FORMATS>(pybinary, "FORMATS")
     ENTRY(UNKNOWN)
     ENTRY(ELF)
     ENTRY(PE)
@@ -72,7 +72,7 @@ void create<Binary>(nb::module_& m) {
   pybinary
     .def_prop_ro("format",
         &Binary::format,
-        "File format " RST_CLASS_REF(lief.EXE_FORMATS) " of the underlying binary."_doc)
+        "File format (:class:`~.FORMATS`) of the underlying binary."_doc)
 
     .def_prop_ro("is_pie",
         &Binary::is_pie,

diff --git a/doc/sphinx/api/cpp/abstract.rst b/doc/sphinx/api/cpp/abstract.rst
@@ -61,9 +61,6 @@ Function
 Enums
 *****
 
-.. doxygenenum:: LIEF::EXE_FORMATS
-   :project: lief
-
 .. doxygenenum:: LIEF::OBJECT_TYPES
    :project: lief
 

diff --git a/doc/sphinx/api/python/abstract.rst b/doc/sphinx/api/python/abstract.rst
@@ -57,15 +57,6 @@ Function
 Enums
 *****
 
-
-Executable formats
-~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: lief.EXE_FORMATS
-
-----------
-
-
 Object types
 ~~~~~~~~~~~~
 

diff --git a/doc/sphinx/changelog.rst b/doc/sphinx/changelog.rst
@@ -96,6 +96,18 @@ Changelog
 
         pe = lief.PE.parse("pe.exe", config)
 
+:Abstraction:
+
+    * `LIEF::EXE_FORMATS` is now scoped in `LIEF::Binary::FORMATS`
+    * All the `Binary` classes now implement `classof`:
+
+      .. code-block:: cpp
+
+        std::unique_ptr<LIEF::Binary> bin = LIEF::Parser::parse("...");
+        if (LIEF::PE::Binary::classof(bin.get())) {
+          auto& pe_file = static_cast<LIEF::PE::Binary&>(*bin);
+        }
+
 :General Design:
 
   * Python parser functions (like: :func:`lief.PE.parse`) now accept `os.PathLike`

diff --git a/include/LIEF/Abstract/enums.hpp b/include/LIEF/Abstract/enums.hpp
@@ -20,14 +20,6 @@
 
 namespace LIEF {
 
-//! LIEF executable format
-enum EXE_FORMATS {
-  FORMAT_UNKNOWN = 0,
-  FORMAT_ELF     = 1, /// ELF. See: LIEF::ELF
-  FORMAT_PE      = 2, /// PE. See: LIEF::PE
-  FORMAT_MACHO   = 3, /// Mach-O. See: LIEF::MachO
-};
-
 enum OBJECT_TYPES {
   TYPE_NONE       = 0,
   TYPE_EXECUTABLE = 1,

diff --git a/tests/abstract/test_abstract.py b/tests/abstract/test_abstract.py
@@ -25,13 +25,13 @@ def test_endianness():
 
 def test_format():
     binary = lief.parse(get_sample('ELF/ELF32_x86_binary_ls.bin'))
-    binary.abstract.format == lief.EXE_FORMATS.ELF
+    binary.abstract.format == lief.Binary.FORMATS.ELF
 
     binary = lief.parse(get_sample('MachO/MachO64_x86-64_binary_id.bin'))
-    binary.abstract.format == lief.EXE_FORMATS.MACHO
+    binary.abstract.format == lief.Binary.FORMATS.MACHO
 
     binary = lief.parse(get_sample('PE/PE64_x86-64_binary_ConsoleApplication1.exe'))
-    binary.abstract.format == lief.EXE_FORMATS.PE
+    binary.abstract.format == lief.Binary.FORMATS.PE
 
 def test_pie():
     binary = lief.parse(get_sample('ELF/ELF32_ARM_binary-pie_ls.bin'))