dexparser 0.6.2

use super::{Uleb128, Sleb128};

// raw type for the first pass over the dex file
#[derive(Debug, PartialEq)]
pub struct RawDexFile {
    // Docs: header_item
    pub header: RawHeader,
    // Docs: string_id_item
    pub string_id_items: Vec<u32>,
    // Docs: type_id_item
    pub type_id_items: Vec<u32>,
    // Docs: proto_id_item
    pub proto_id_items: Vec<RawPrototype>,
    // Docs: field_id_item
    pub field_id_items: Vec<RawField>,
    // Docs: method_id_item
    pub method_id_items: Vec<RawMethod>,
    // Docs: class_def_item
    pub class_def_items: Vec<RawClassDefinition>,
    // Docs: call_site_item
    // new in version 038
    pub call_site_idxs: Option<Vec<u32>>,
    // Docs: method_handle_item
    pub method_handle_idxs: Option<Vec<RawMethodHandleItem>>,
    // Docs: data
    pub data: Vec<u8>,
    // Docs: link_data
    pub link_data: Option<Vec<u8>>
}

#[derive(Debug, PartialEq)]
pub struct RawHeader {
    // DEX file version
    pub version: i32,
    // adler32 checksum of the rest of the file (everything except the magic, version, and this)
    pub checksum: u32,
    // SHA-1 hash of the rest of the file
    pub signature: [u8; 20],
    // Size of the entire file in bytes
    pub file_size: u32,
    // Size of the header in bytes
    pub header_size: u32,
    // Tag indicating little-endian or big-endian
    pub endian_tag: u32,
    // Size of the link section (or 0 if not linked)
    pub link_size: u32,
    // Offset into the link section (or 0 if not linked)
    pub link_off: u32,
    // Offset from the start of the file to the map item
    pub map_off: u32,
    // Number of string IDs
    pub string_ids_size: u32,
    // Offset string IDs begin at
    pub string_ids_off: u32,
    // Number of type IDs
    pub type_ids_size: u32,
    // Offset type IDs begin at
    pub type_ids_off: u32,
    // Number of prototypes
    pub proto_ids_size: u32,
    // Offset prototypes begin at
    pub proto_ids_off: u32,
    // Number of field identifiers
    pub field_ids_size: u32,
    // Offset field identifiers begin at
    pub field_ids_off: u32,
    // Number of method identifiers
    pub method_ids_size: u32,
    // Offset method identifiers begin at
    pub method_ids_off: u32,
    // Number of class defintions
    pub class_defs_size: u32,
    // Offset class definitions begin at
    pub class_defs_off: u32,
    // Size of the 'data' blob in bytes
    pub data_size: u32,
    // Offset the 'data' blob begins at
    pub data_off: u32
}

#[derive(Debug, PartialEq)]
pub struct RawClassDataItem {
    pub static_fields_size: Uleb128,
    pub instance_fields_size: Uleb128,
    pub direct_methods_size: Uleb128,
    pub virtual_methods_size: Uleb128,
    pub static_fields: Vec<RawEncodedField>,
    pub instance_fields: Vec<RawEncodedField>,
    pub direct_methods: Vec<RawEncodedMethod>,
    pub virtual_methods: Vec<RawEncodedMethod>
}

#[derive(Debug, PartialEq)]
pub struct RawEncodedField {
    pub field_idx_diff: Uleb128,
    pub access_flags: Uleb128
}

#[derive(Debug, PartialEq)]
pub struct RawEncodedMethod {
    pub method_idx_diff: Uleb128,
    pub access_flags: Uleb128,
    pub code_off: Uleb128
}

#[derive(Debug, PartialEq)]
pub struct RawAnnotations {
    pub class_annotations_off: u32,
    pub fld_annot: Option<Vec<RawFieldAnnotation>>,
    pub mtd_annot: Option<Vec<RawMethodAnnotation>>,
    pub prm_annot: Option<Vec<RawParameterAnnotation>>
}

#[derive(Debug, PartialEq)]
pub struct RawFieldAnnotation {
    pub field_idx: u32,
    pub annotations_offset: u32
}

#[derive(Debug, PartialEq)]
pub struct RawMethodAnnotation {
    pub method_idx: u32,
    pub annotations_offset: u32
}

#[derive(Debug, PartialEq)]
pub struct RawParameterAnnotation {
    pub method_idx: u32,
    pub annotations_offset: u32
}

// Docs: type_list
#[derive(Debug, PartialEq)]
pub struct RawTypeList {
    // Size of the following list
    pub size: u32,
    // List of indexes into type_id list
    // Docs: type_item
    pub list: Vec<u16>
}

// Docs: annotation_set_item
#[derive(Debug, PartialEq)]
pub struct RawAnnotationSetItem {
    // Size of the following list
    pub size: u32,
    // List of offsets to annotations
    // Docs: annotation_off_item
    pub entries: Vec<u32>
}

// Docs: annotation_set_ref_list
#[derive(Debug, PartialEq)]
pub struct RawAnnotationSetRefList {
    // Size of the following list
    pub size: u32,
    // List of offsets to annotation items
    // Docs: annotation_set_ref_item
    pub entries: Vec<u32>
}

// Docs: method_id_item
#[derive(Debug, PartialEq)]
pub struct RawMethod {
    // Index in the classes list
    pub class_idx: u16,
    // Index in the prototypes list
    pub proto_idx: u16,
    // Index in the string data list
    pub name_idx: u32
}

// Docs: string_data_item
#[derive(Debug, PartialEq)]
pub struct RawStringData {
    pub utf16_size: u32,
    pub data: String
}

// Docs: class_def_item
#[derive(Debug, PartialEq)]
pub struct RawClassDefinition {
    pub class_idx: u32,
    pub access_flags: u32,
    pub superclass_idx: u32,
    pub interfaces_off: u32,
    pub source_file_idx: u32,
    pub annotations_off: u32,
    pub class_data_off: u32,
    pub static_values_off: u32
}

#[derive(Debug, PartialEq)]
pub struct RawField {
    pub class_idx: u16,
    pub type_idx: u16,
    pub name_idx: u32
}

// Docs: proto_id_item
#[derive(Debug, PartialEq)]
pub struct RawPrototype {
    // Index into the string IDs list for the descriptor string of this prototype
    pub shorty_idx: u32,
    // Index into the type_ids list for the return type of this prototype
    pub return_type_idx: u32,
    // Offset from start of file into data section containing parameters
    pub parameters_off: u32
}

// Docs: map_list
#[derive(Debug, PartialEq)]
pub struct RawMapList {
    pub size: u32,
    pub list: Vec<RawMapListItem>
}

// Docs: map_list_item
#[derive(Debug, PartialEq)]
pub struct RawMapListItem {
    pub type_: MapListItemType,
    pub unused: u16,
    pub size: u32,
    pub offset: u32
}

// Docs: method_handle_item
#[derive(Debug, PartialEq)]
pub struct RawMethodHandleItem {
    // method handle type (see reference for "Method Handle Type Codes")
    pub type_: u16,
    // unused value
    pub unused_1: u16,
    // ID for the field or method (depending on which one it is)
    pub field_or_method_id: u16,
    // another unused value
    pub unused_2: u16
}

// Docs: code_item
#[derive(Debug, PartialEq)]
pub struct RawCodeItem {
    // number of registers used by this code
    pub registers_size: u16,
    // number of words of incoming arguments
    pub ins_size: u16,
    // number of words of outgoing argument space
    pub outs_size: u16,
    pub tries_size: u16,
    pub debug_info_off: u32,
    pub insns_size: u32,
    pub insns: Vec<u16>,
    pub padding: Option<u16>,
    pub tries: Option<Vec<RawTryItem>>
    // missing the handler here: need to break up processing to handle handler_off for try_item's
}

// Docs: try_item
#[derive(Debug, PartialEq)]
pub struct RawTryItem {
    // start address of the block of code covered by this entry
    // a count of 16-bit code units to the start of the first covered instruction
    pub start_addr: u32,
    // number of 16-bit code units covered by this entry
    pub insn_count: u16,
    // offset to the individual handler within the encoded_catch_handler_list block for the associated code_item
    pub handler_off: u16
}

// Docs: encoded_catch_handler_list
#[derive(Debug, PartialEq)]
pub struct RawEncodedCatchHandlerList {
    // size of the list
    pub size: Uleb128,
    // list of encoded_catch_handlers
    pub list: Vec<RawEncodedCatchHandler>
}

// Docs: encoded_catch_handler
#[derive(Debug, PartialEq)]
pub struct RawEncodedCatchHandler {
    // Size of the handlers list
    pub size: Sleb128,
    pub handlers: Vec<RawEncodedTypeAddrPair>,
    // bytecode
    // only present if size is non-positive
    pub catch_all_addr: Option<Uleb128>
}

// Docs: encoded_type_addr_pair
#[derive(Debug, PartialEq)]
pub struct RawEncodedTypeAddrPair {
    // index into type_ids list for the type of exception to catch
    pub type_idx: Uleb128,
    // bytecode address of associated exception handler
    pub addr: Uleb128
}

// Docs: debug_info_item
#[derive(Debug, PartialEq)]
pub struct RawDebugInfoItem {
    pub line_start: Uleb128,
    pub parameters_size: Uleb128,
    pub parameter_names: Vec<Sleb128>,
    pub bytecode: Vec<u8>
}

//noinspection RsEnumVariantNaming
#[allow(non_camel_case_types)]
#[derive(Debug, PartialEq)]
pub enum MapListItemType {
    HEADER_ITEM,
    STRING_ID_ITEM,
    TYPE_ID_ITEM,
    PROTO_ID_ITEM,
    FIELD_ID_ITEM,
    METHOD_ID_ITEM,
    CLASS_DEF_ITEM,
    CALL_SITE_ID_ITEM,
    METHOD_HANDLE_ITEM,
    MAP_LIST,
    TYPE_LIST,
    ANNOTATION_SET_REF_LIST,
    ANNOTATION_SET_ITEM,
    CLASS_DATA_ITEM,
    CODE_ITEM,
    STRING_DATA_ITEM,
    DEBUG_INFO_ITEM,
    ANNOTATION_ITEM,
    ENCODED_ARRAY_ITEM,
    ANNOTATIONS_DIRECTORY_ITEM
}