lief 1.0.0

use lief_ffi as ffi;

use super::commands::Segment;
use super::commands::dylib::Dylib;
use super::symbol::Symbol;
use std::{fmt, marker::PhantomData};

use crate::common::{FromFFI, into_optional};

#[derive(Debug)]
/// This enum exposes all the different types of binding operations that
/// we can find in a Mach-O binary. [`BindingInfo::Dyld`] exposes the bindings info
/// wrapped in the `LC_DYLD_INFO` command while [`BindingInfo::Chained`] exposes the new
/// chained bindings implemented in the `DYLD_CHAINED_FIXUPS` command.
pub enum BindingInfo<'a> {
    /// Bindings defined in `LC_DYLD_INFO` command
    Dyld(Dyld<'a>),
    /// Bindings defined in `DYLD_CHAINED_FIXUPS` command
    Chained(Chained<'a>),
    /// Bindings infered from the indirect symbol table
    Indirect(Indirect<'a>),
    /// Fallback item
    Generic(Generic<'a>),
}

/// Generic trait shared by all [`BindingInfo`] items
pub trait AsGeneric {
    #[doc(hidden)]
    fn as_generic(&self) -> &ffi::MachO_BindingInfo;

    /// Library associated with the binding (if any)
    fn library(&self) -> Option<Dylib<'_>> {
        into_optional(self.as_generic().library())
    }

    /// Symbol associated with the binding (if any)
    fn symbol(&self) -> Option<Symbol<'_>> {
        into_optional(self.as_generic().symbol())
    }

    /// Segment associated with the binding (if any)
    fn segment(&self) -> Option<Segment<'_>> {
        into_optional(self.as_generic().segment())
    }

    /// Address of the binding
    fn address(&self) -> u64 {
        self.as_generic().address()
    }

    /// Value added to the segment's virtual address when bound
    fn addend(&self) -> i64 {
        self.as_generic().addend()
    }

    fn library_ordinal(&self) -> i32 {
        self.as_generic().library_ordinal()
    }
}

impl AsGeneric for BindingInfo<'_> {
    #[doc(hidden)]
    fn as_generic(&self) -> &ffi::MachO_BindingInfo {
        match &self {
            BindingInfo::Dyld(info) => info.as_generic(),
            BindingInfo::Chained(info) => info.as_generic(),
            BindingInfo::Indirect(info) => info.as_generic(),
            BindingInfo::Generic(info) => info.as_generic(),
        }
    }
}

impl std::fmt::Debug for &dyn AsGeneric {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("AsGeneric")
            .field("address", &self.address())
            .field("addend", &self.addend())
            .field("library_ordinal", &self.library_ordinal())
            .finish()
    }
}

impl<'a> FromFFI<ffi::MachO_BindingInfo> for BindingInfo<'a> {
    fn from_ffi(ffi_entry: cxx::UniquePtr<ffi::MachO_BindingInfo>) -> Self {
        unsafe {
            let cmd_ref = ffi_entry.as_ref().unwrap();

            if ffi::MachO_ChainedBindingInfo::classof(cmd_ref) {
                let raw = {
                    type From = cxx::UniquePtr<ffi::MachO_BindingInfo>;
                    type To = cxx::UniquePtr<ffi::MachO_ChainedBindingInfo>;
                    std::mem::transmute::<From, To>(ffi_entry)
                };
                BindingInfo::Chained(Chained::from_ffi(raw))
            } else if ffi::MachO_DyldBindingInfo::classof(cmd_ref) {
                let raw = {
                    type From = cxx::UniquePtr<ffi::MachO_BindingInfo>;
                    type To = cxx::UniquePtr<ffi::MachO_DyldBindingInfo>;
                    std::mem::transmute::<From, To>(ffi_entry)
                };
                BindingInfo::Dyld(Dyld::from_ffi(raw))
            } else if ffi::MachO_IndirectBindingInfo::classof(cmd_ref) {
                let raw = {
                    type From = cxx::UniquePtr<ffi::MachO_BindingInfo>;
                    type To = cxx::UniquePtr<ffi::MachO_IndirectBindingInfo>;
                    std::mem::transmute::<From, To>(ffi_entry)
                };
                BindingInfo::Indirect(Indirect::from_ffi(raw))
            } else {
                BindingInfo::Generic(Generic::from_ffi(ffi_entry))
            }
        }
    }
}

pub struct Generic<'a> {
    ptr: cxx::UniquePtr<ffi::MachO_BindingInfo>,
    _owner: PhantomData<&'a ()>,
}

impl fmt::Debug for Generic<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let base = self as &dyn AsGeneric;
        f.debug_struct("Generic").field("base", &base).finish()
    }
}

impl<'a> FromFFI<ffi::MachO_BindingInfo> for Generic<'a> {
    fn from_ffi(ptr: cxx::UniquePtr<ffi::MachO_BindingInfo>) -> Self {
        Self {
            ptr,
            _owner: PhantomData,
        }
    }
}

impl AsGeneric for Generic<'_> {
    fn as_generic(&self) -> &ffi::MachO_BindingInfo {
        self.ptr.as_ref().unwrap()
    }
}

/// This structure represents a binding operation coming from binding bytecode
/// of `LC_DYLD_INFO`
pub struct Dyld<'a> {
    ptr: cxx::UniquePtr<ffi::MachO_DyldBindingInfo>,
    _owner: PhantomData<&'a ()>,
}

#[allow(non_camel_case_types)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum BINDING_CLASS {
    WEAK,
    LAZY,
    STANDARD,
    THREADED,
    UNKNOWN(u64),
}

impl BINDING_CLASS {
    pub fn from_value(value: u64) -> Self {
        match value {
            0x00000001 => BINDING_CLASS::WEAK,
            0x00000002 => BINDING_CLASS::LAZY,
            0x00000003 => BINDING_CLASS::STANDARD,
            0x00000064 => BINDING_CLASS::THREADED,
            _ => BINDING_CLASS::UNKNOWN(value),
        }
    }
}

#[allow(non_camel_case_types)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum BIND_TYPES {
    POINTER,
    TEXT_ABSOLUTE32,
    TEXT_PCREL32,
    UNKNOWN(u64),
}

impl BIND_TYPES {
    pub fn from_value(value: u64) -> Self {
        match value {
            0x00000001 => BIND_TYPES::POINTER,
            0x00000002 => BIND_TYPES::TEXT_ABSOLUTE32,
            0x00000003 => BIND_TYPES::TEXT_PCREL32,
            _ => BIND_TYPES::UNKNOWN(value),
        }
    }
}

impl Dyld<'_> {
    /// Class of the binding (weak, lazy, ...)
    pub fn binding_class(&self) -> BINDING_CLASS {
        BINDING_CLASS::from_value(self.ptr.binding_class())
    }

    /// Type of the binding. Most of the times it should be [`BIND_TYPES::POINTER`]
    pub fn binding_type(&self) -> BIND_TYPES {
        BIND_TYPES::from_value(self.ptr.binding_type())
    }

    pub fn is_non_weak_definition(&self) -> bool {
        self.ptr.is_non_weak_definition()
    }

    pub fn original_offset(&self) -> u64 {
        self.ptr.original_offset()
    }
}

impl fmt::Debug for Dyld<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let base = self as &dyn AsGeneric;
        f.debug_struct("Dyld")
            .field("base", &base)
            .field("binding_class", &self.binding_class())
            .field("binding_type", &self.binding_type())
            .field("is_non_weak_definition", &self.is_non_weak_definition())
            .field("original_offset", &self.original_offset())
            .finish()
    }
}

impl FromFFI<ffi::MachO_DyldBindingInfo> for Dyld<'_> {
    fn from_ffi(ptr: cxx::UniquePtr<ffi::MachO_DyldBindingInfo>) -> Self {
        Self {
            ptr,
            _owner: PhantomData,
        }
    }
}

impl AsGeneric for Dyld<'_> {
    fn as_generic(&self) -> &ffi::MachO_BindingInfo {
        self.ptr.as_ref().unwrap().as_ref()
    }
}
/// This structure represents a binding operation coming from chained binding command:
/// `LC_DYLD_CHAINED_FIXUPS`
pub struct Chained<'a> {
    ptr: cxx::UniquePtr<ffi::MachO_ChainedBindingInfo>,
    _owner: PhantomData<&'a ()>,
}

#[allow(non_camel_case_types)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum CHAINED_FORMAT {
    IMPORT,
    IMPORT_ADDEND,
    IMPORT_ADDEND64,
    UNKNOWN(u32),
}

impl CHAINED_FORMAT {
    pub fn from_value(value: u32) -> Self {
        match value {
            0x00000001 => CHAINED_FORMAT::IMPORT,
            0x00000002 => CHAINED_FORMAT::IMPORT_ADDEND,
            0x00000003 => CHAINED_FORMAT::IMPORT_ADDEND64,
            _ => CHAINED_FORMAT::UNKNOWN(value),
        }
    }
}

impl Chained<'_> {
    /// Format of the imports
    pub fn format(&self) -> CHAINED_FORMAT {
        CHAINED_FORMAT::from_value(self.ptr.format())
    }

    /// Format of the pointer
    pub fn ptr_format(&self) -> u32 {
        self.ptr.ptr_format()
    }

    /// Original offset in the chain of this binding
    pub fn offset(&self) -> u32 {
        self.ptr.offset()
    }

    /// Sign-extended addend for this chained binding
    pub fn sign_extended_addend(&self) -> u64 {
        self.ptr.sign_extended_addend()
    }
}

impl fmt::Debug for Chained<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let base = self as &dyn AsGeneric;
        f.debug_struct("Chained")
            .field("base", &base)
            .field("format", &self.format())
            .field("ptr_format", &self.ptr_format())
            .field("offset", &self.offset())
            .finish()
    }
}

impl FromFFI<ffi::MachO_ChainedBindingInfo> for Chained<'_> {
    fn from_ffi(ptr: cxx::UniquePtr<ffi::MachO_ChainedBindingInfo>) -> Self {
        Self {
            ptr,
            _owner: PhantomData,
        }
    }
}

impl AsGeneric for Chained<'_> {
    fn as_generic(&self) -> &ffi::MachO_BindingInfo {
        self.ptr.as_ref().unwrap().as_ref()
    }
}

/// This structure represents a binding operation coming from the indirect symbol table
pub struct Indirect<'a> {
    ptr: cxx::UniquePtr<ffi::MachO_IndirectBindingInfo>,
    _owner: PhantomData<&'a ()>,
}

impl fmt::Debug for Indirect<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let base = self as &dyn AsGeneric;
        f.debug_struct("Indirect").field("base", &base).finish()
    }
}

impl FromFFI<ffi::MachO_IndirectBindingInfo> for Indirect<'_> {
    fn from_ffi(ptr: cxx::UniquePtr<ffi::MachO_IndirectBindingInfo>) -> Self {
        Self {
            ptr,
            _owner: PhantomData,
        }
    }
}

impl AsGeneric for Indirect<'_> {
    fn as_generic(&self) -> &ffi::MachO_BindingInfo {
        self.ptr.as_ref().unwrap().as_ref()
    }
}