mod.rs

use std::io::Write;
use std::{fmt, str};

use object::read::archive::ArchiveFile;
use object::read::macho::{FatArch, FatHeader};
use object::Endianness;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct PrintOptions {
    // Selectors
    pub file: bool,
    pub segments: bool,
    pub sections: bool,
    pub symbols: bool,
    pub relocations: bool,

    // ELF specific selectors
    pub elf_dynamic: bool,
    pub elf_dynamic_symbols: bool,
    pub elf_notes: bool,
    pub elf_versions: bool,
    pub elf_attributes: bool,

    // Mach-O specific selectors
    pub macho_load_commands: bool,
    pub macho_function_starts: bool,
    pub macho_exports_trie: bool,

    // PE specific selectors
    pub pe_rich: bool,
    pub pe_base_relocs: bool,
    pub pe_imports: bool,
    pub pe_exports: bool,
    pub pe_resources: bool,

    // Modifiers
    pub string_indices: bool,
}

impl PrintOptions {
    /// Returns a new `PrintOptions` with all selectors enabled and default modifiers.
    pub fn all() -> Self {
        Self {
            file: true,
            segments: true,
            sections: true,
            symbols: true,
            relocations: true,
            elf_dynamic: true,
            elf_dynamic_symbols: true,
            elf_notes: true,
            elf_versions: true,
            elf_attributes: true,
            macho_load_commands: true,
            macho_function_starts: true,
            macho_exports_trie: true,
            pe_rich: true,
            pe_base_relocs: true,
            pe_imports: true,
            pe_exports: true,
            pe_resources: true,
            string_indices: true,
        }
    }

    /// Returns a new `PrintOptions` with all selectors disabled and default modifiers.
    pub fn none() -> Self {
        Self {
            file: false,
            segments: false,
            sections: false,
            symbols: false,
            relocations: false,
            elf_dynamic: false,
            elf_dynamic_symbols: false,
            elf_notes: false,
            elf_versions: false,
            elf_attributes: false,
            macho_load_commands: false,
            macho_function_starts: false,
            macho_exports_trie: false,
            pe_rich: false,
            pe_base_relocs: false,
            pe_imports: false,
            pe_exports: false,
            pe_resources: false,
            string_indices: true,
        }
    }
}

pub fn print(
    w: &mut dyn Write,
    e: &mut dyn Write,
    file: &[u8],
    extra_files: &[&[u8]],
    options: &PrintOptions,
) {
    let mut printer = Printer::new(w, e, options);
    print_object(&mut printer, file, extra_files);
}

struct Printer<'a> {
    w: &'a mut dyn Write,
    e: &'a mut dyn Write,
    indent: usize,
    options: &'a PrintOptions,
}

impl<'a> Printer<'a> {
    fn new(w: &'a mut dyn Write, e: &'a mut dyn Write, options: &'a PrintOptions) -> Self {
        Self {
            w,
            e,
            indent: 0,
            options,
        }
    }

    fn w(&mut self) -> &mut dyn Write {
        self.w
    }

    fn blank(&mut self) {
        writeln!(self.w).unwrap();
    }

    fn print_indent(&mut self) {
        if self.indent != 0 {
            write!(self.w, "{:-1$}", " ", self.indent * 4).unwrap();
        }
    }

    fn print_string(&mut self, s: &[u8]) {
        if let Ok(s) = str::from_utf8(s) {
            write!(self.w, "\"{}\"", s).unwrap();
        } else {
            write!(self.w, "{:X?}", s).unwrap();
        }
    }

    fn indent<F: FnOnce(&mut Self)>(&mut self, f: F) {
        self.indent += 1;
        f(self);
        self.indent -= 1;
    }

    fn group<F: FnOnce(&mut Self)>(&mut self, name: &str, f: F) {
        self.print_indent();
        writeln!(self.w, "{} {{", name).unwrap();
        self.indent(f);
        self.print_indent();
        writeln!(self.w, "}}").unwrap();
    }

    fn field_name(&mut self, name: &str) {
        self.print_indent();
        if !name.is_empty() {
            write!(self.w, "{}: ", name).unwrap();
        }
    }

    fn field<T: fmt::Display>(&mut self, name: &str, value: T) {
        self.field_name(name);
        writeln!(self.w, "{}", value).unwrap();
    }

    fn field_hex<T: fmt::UpperHex>(&mut self, name: &str, value: T) {
        self.field_name(name);
        writeln!(self.w, "0x{:X}", value).unwrap();
    }

    fn field_bytes(&mut self, name: &str, value: &[u8]) {
        self.field_name(name);
        writeln!(self.w, "{:X?}", value).unwrap();
    }

    fn field_string_option<T: fmt::UpperHex>(&mut self, name: &str, value: T, s: Option<&[u8]>) {
        if let Some(s) = s {
            self.field_name(name);
            self.print_string(s);
            if self.options.string_indices {
                write!(self.w, " (0x{:X})", value).unwrap();
            }
            writeln!(self.w).unwrap();
        } else {
            self.field_hex(name, value);
        }
    }

    fn field_string<T: fmt::UpperHex, E: fmt::Display>(
        &mut self,
        name: &str,
        value: T,
        s: Result<&[u8], E>,
    ) {
        let s = s.print_err(self);
        self.field_string_option(name, value, s);
    }

    fn field_inline_string(&mut self, name: &str, s: &[u8]) {
        self.field_name(name);
        self.print_string(s);
        writeln!(self.w).unwrap();
    }

    fn field_enum<T: Eq + fmt::UpperHex>(&mut self, name: &str, value: T, flags: &[Flag<T>]) {
        for flag in flags {
            if value == flag.value {
                self.field_name(name);
                writeln!(self.w, "{} (0x{:X})", flag.name, value).unwrap();
                return;
            }
        }
        self.field_hex(name, value);
    }

    fn field_enum_display<T: Eq + fmt::Display>(
        &mut self,
        name: &str,
        value: T,
        flags: &[Flag<T>],
    ) {
        for flag in flags {
            if value == flag.value {
                self.field_name(name);
                writeln!(self.w, "{} ({})", flag.name, value).unwrap();
                return;
            }
        }
        self.field(name, value);
    }

    fn field_enums<T: Eq + fmt::UpperHex>(&mut self, name: &str, value: T, enums: &[&[Flag<T>]]) {
        for flags in enums {
            for flag in *flags {
                if value == flag.value {
                    self.field_name(name);
                    writeln!(self.w, "{} (0x{:X})", flag.name, value).unwrap();
                    return;
                }
            }
        }
        self.field_hex(name, value);
    }

    fn flags<T: Into<u64>, U: Copy + Into<u64>>(&mut self, value: T, mask: U, flags: &[Flag<U>]) {
        let value = value.into();
        let mask = mask.into();
        self.indent(|p| {
            if mask != 0 {
                for flag in flags {
                    if value & mask == flag.value.into() {
                        p.print_indent();
                        writeln!(p.w, "{} (0x{:X})", flag.name, flag.value.into()).unwrap();
                        return;
                    }
                }
                p.print_indent();
                writeln!(p.w, "<unknown> (0x{:X})", value & mask).unwrap();
            } else {
                for flag in flags {
                    if value & flag.value.into() == flag.value.into() {
                        p.print_indent();
                        writeln!(p.w, "{} (0x{:X})", flag.name, flag.value.into()).unwrap();
                    }
                }
                // TODO: display unknown flags (need to display all flags at once for this)
            }
        });
    }
}

struct Flag<T> {
    value: T,
    name: &'static str,
}

macro_rules! flags {
    ($($name:ident),+ $(,)?) => ( [ $(Flag { value: $name, name: stringify!($name), }),+ ] )
}

fn print_object(p: &mut Printer<'_>, data: &[u8], extra_files: &[&[u8]]) {
    let kind = match object::FileKind::parse(data) {
        Ok(file) => file,
        Err(err) => {
            println!("Failed to parse file: {}", err);
            return;
        }
    };
    match kind {
        object::FileKind::Archive => print_archive(p, data),
        object::FileKind::Coff => pe::print_coff(p, data),
        object::FileKind::CoffBig => pe::print_coff_big(p, data),
        object::FileKind::CoffImport => pe::print_coff_import(p, data),
        object::FileKind::DyldCache => macho::print_dyld_cache(p, data, extra_files),
        object::FileKind::Elf32 => elf::print_elf32(p, data),
        object::FileKind::Elf64 => elf::print_elf64(p, data),
        object::FileKind::MachO32 => macho::print_macho32(p, data, 0, None),
        object::FileKind::MachO64 => macho::print_macho64(p, data, 0, None),
        object::FileKind::MachOFat32 => macho::print_macho_fat32(p, data),
        object::FileKind::MachOFat64 => macho::print_macho_fat64(p, data),
        object::FileKind::Pe32 => pe::print_pe32(p, data),
        object::FileKind::Pe64 => pe::print_pe64(p, data),
        object::FileKind::Xcoff32 => xcoff::print_xcoff32(p, data),
        object::FileKind::Xcoff64 => xcoff::print_xcoff64(p, data),
        // TODO
        _ => {}
    }
}

fn print_archive(p: &mut Printer<'_>, data: &[u8]) {
    if let Some(archive) = ArchiveFile::parse(data).print_err(p) {
        write!(p.w(), "Format: Archive ({:?})", archive.kind()).unwrap();
        if archive.is_thin() {
            write!(p.w(), " (thin)").unwrap();
        }
        p.blank();
        for member in archive.members() {
            if let Some(member) = member.print_err(p) {
                p.blank();
                p.field_inline_string("Member", member.name());
                if member.is_thin() {
                    p.field("Size", member.size());
                } else if let Some(data) = member.data(data).print_err(p) {
                    print_object(p, data, &[]);
                }
            }
        }
        if let Some(symbols) = archive.symbols().print_err(p).flatten() {
            p.blank();
            for symbol in symbols {
                if let Some(symbol) = symbol.print_err(p) {
                    p.group("Symbol", |p| {
                        p.field_inline_string("Name", symbol.name());
                        let offset = symbol.offset();
                        if let Some(member) = archive.member(offset).print_err(p) {
                            p.field_inline_string("Member", member.name());
                        }
                    });
                }
            }
        }
    }
}

trait PrintErr<T> {
    fn print_err(self, p: &mut Printer<'_>) -> Option<T>;
}

impl<T, E: fmt::Display> PrintErr<T> for Result<T, E> {
    fn print_err(self, p: &mut Printer<'_>) -> Option<T> {
        match self {
            Ok(val) => Some(val),
            Err(err) => {
                writeln!(p.e, "Error: {}", err).unwrap();
                None
            }
        }
    }
}

mod elf;
mod macho;
mod pe;
mod xcoff;