/* Copyright 2017 - 2026 R. Thomas
 * Copyright 2017 - 2026 Quarkslab
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef LIEF_DEX_INSTRUCTIONS_H
#define LIEF_DEX_INSTRUCTIONS_H
#include "LIEF/visibility.h"
#include <cstddef>
#include <cstdint>


namespace LIEF::DEX {

enum SWITCH_ARRAY_IDENT : uint16_t {
  IDENT_PACKED_SWITCH = 0x0100,
  IDENT_SPARSE_SWITCH = 0x0200,
  IDENT_FILL_ARRAY = 0x0300,
};

/// The Dalvik Opcodes
enum OPCODES : uint8_t {
  OP_NOP = 0x00,
  OP_MOVE = 0x01,
  OP_MOVE_FROM_16 = 0x02,
  OP_MOVE_16 = 0x03,
  OP_MOVE_WIDE = 0x04,
  OP_MOVE_WIDE_FROM_16 = 0x05,
  OP_MOVE_WIDE_16 = 0x06,
  OP_MOVE_OBJECT = 0x07,
  OP_MOVE_OBJECT_FROM_16 = 0x08,
  OP_MOVE_OBJECT_16 = 0x09,
  OP_MOVE_RESULT = 0x0a,
  OP_MOVE_RESULT_WIDE = 0x0b,
  OP_MOVE_RESULT_OBJECT = 0x0c,
  OP_MOVE_EXCEPTION = 0x0d,
  OP_RETURN_VOID = 0x0e,
  OP_RETURN = 0x0f,
  OP_RETURN_WIDE = 0x10,
  OP_RETURN_OBJECT = 0x11,
  OP_CONST_4 = 0x12,
  OP_CONST_16 = 0x13,
  OP_CONST = 0x14,
  OP_CONST_HIGH_16 = 0x15,
  OP_CONST_WIDE_16 = 0x16,
  OP_CONST_WIDE_32 = 0x17,
  OP_CONST_WIDE = 0x18,
  OP_CONST_WIDE_HIGH_16 = 0x19,
  OP_CONST_STRING = 0x1a,
  OP_CONST_STRING_JUMBO = 0x1b,
  OP_CONST_CLASS = 0x1c,
  OP_MONITOR_ENTER = 0x1d,
  OP_MONITOR_EXIT = 0x1e,
  OP_CHECK_CAST = 0x1f,
  OP_INSTANCE_OF = 0x20,
  OP_ARRAY_LENGTH = 0x21,
  OP_NEW_INSTANCE = 0x22,
  OP_NEW_ARRAY = 0x23,
  OP_FILLED_NEW_ARRAY = 0x24,
  OP_FILLED_NEW_ARRAY_RANGE = 0x25,
  OP_FILL_ARRAY_DATA = 0x26,
  OP_THROW = 0x27,
  OP_GOTO = 0x28,
  OP_GOTO_16 = 0x29,
  OP_GOTO_32 = 0x2a,
  OP_PACKED_SWITCH = 0x2b,
  OP_SPARSE_SWITCH = 0x2c,
  OP_CMPL_FLOAT = 0x2d,
  OP_CMPG_FLOAT = 0x2e,
  OP_CMPL_DOUBLE = 0x2f,
  OP_CMPG_DOUBLE = 0x30,
  OP_CMP_LONG = 0x31,
  OP_IF_EQ = 0x32,
  OP_IF_NE = 0x33,
  OP_IF_LT = 0x34,
  OP_IF_GE = 0x35,
  OP_IF_GT = 0x36,
  OP_IF_LE = 0x37,
  OP_IF_EQZ = 0x38,
  OP_IF_NEZ = 0x39,
  OP_IF_LTZ = 0x3a,
  OP_IF_GEZ = 0x3b,
  OP_IF_GTZ = 0x3c,
  OP_IF_LEZ = 0x3d,
  OP_AGET = 0x44,
  OP_AGET_WIDE = 0x45,
  OP_AGET_OBJECT = 0x46,
  OP_AGET_BOOLEAN = 0x47,
  OP_AGET_BYTE = 0x48,
  OP_AGET_CHAR = 0x49,
  OP_AGET_SHORT = 0x4a,
  OP_APUT = 0x4b,
  OP_APUT_WIDE = 0x4c,
  OP_APUT_OBJECT = 0x4d,
  OP_APUT_BOOLEAN = 0x4e,
  OP_APUT_BYTE = 0x4f,
  OP_APUT_CHAR = 0x50,
  OP_APUT_SHORT = 0x51,
  OP_IGET = 0x52,
  OP_IGET_WIDE = 0x53,
  OP_IGET_OBJECT = 0x54,
  OP_IGET_BOOLEAN = 0x55,
  OP_IGET_BYTE = 0x56,
  OP_IGET_CHAR = 0x57,
  OP_IGET_SHORT = 0x58,
  OP_IPUT = 0x59,
  OP_IPUT_WIDE = 0x5a,
  OP_IPUT_OBJECT = 0x5b,
  OP_IPUT_BOOLEAN = 0x5c,
  OP_IPUT_BYTE = 0x5d,
  OP_IPUT_CHAR = 0x5e,
  OP_IPUT_SHORT = 0x5f,
  OP_SGET = 0x60,
  OP_SGET_WIDE = 0x61,
  OP_SGET_OBJECT = 0x62,
  OP_SGET_BOOLEAN = 0x63,
  OP_SGET_BYTE = 0x64,
  OP_SGET_CHAR = 0x65,
  OP_SGET_SHORT = 0x66,
  OP_SPUT = 0x67,
  OP_SPUT_WIDE = 0x68,
  OP_SPUT_OBJECT = 0x69,
  OP_SPUT_BOOLEAN = 0x6a,
  OP_SPUT_BYTE = 0x6b,
  OP_SPUT_CHAR = 0x6c,
  OP_SPUT_SHORT = 0x6d,
  OP_INVOKE_VIRTUAL = 0x6e,
  OP_INVOKE_SUPER = 0x6f,
  OP_INVOKE_DIRECT = 0x70,
  OP_INVOKE_STATIC = 0x71,
  OP_INVOKE_INTERFACE = 0x72,
  OP_RETURN_VOID_NO_BARRIER = 0x73,
  OP_INVOKE_VIRTUAL_RANGE = 0x74,
  OP_INVOKE_SUPER_RANGE = 0x75,
  OP_INVOKE_DIRECT_RANGE = 0x76,
  OP_INVOKE_STATIC_RANGE = 0x77,
  OP_INVOKE_INTERFACE_RANGE = 0x78,
  OP_NEG_INT = 0x7b,
  OP_NOT_INT = 0x7c,
  OP_NEG_LONG = 0x7d,
  OP_NOT_LONG = 0x7e,
  OP_NEG_FLOAT = 0x7f,
  OP_NEG_DOUBLE = 0x80,
  OP_INT_TO_LONG = 0x81,
  OP_INT_TO_FLOAT = 0x82,
  OP_INT_TO_DOUBLE = 0x83,
  OP_LONG_TO_INT = 0x84,
  OP_LONG_TO_FLOAT = 0x85,
  OP_LONG_TO_DOUBLE = 0x86,
  OP_FLOAT_TO_INT = 0x87,
  OP_FLOAT_TO_LONG = 0x88,
  OP_FLOAT_TO_DOUBLE = 0x89,
  OP_DOUBLE_TO_INT = 0x8a,
  OP_DOUBLE_TO_LONG = 0x8b,
  OP_DOUBLE_TO_FLOAT = 0x8c,
  OP_INT_TO_BYTE = 0x8d,
  OP_INT_TO_CHAR = 0x8e,
  OP_INT_TO_SHORT = 0x8f,
  OP_ADD_INT = 0x90,
  OP_SUB_INT = 0x91,
  OP_MUL_INT = 0x92,
  OP_DIV_INT = 0x93,
  OP_REM_INT = 0x94,
  OP_AND_INT = 0x95,
  OP_OR_INT = 0x96,
  OP_XOR_INT = 0x97,
  OP_SHL_INT = 0x98,
  OP_SHR_INT = 0x99,
  OP_USHR_INT = 0x9a,
  OP_ADD_LONG = 0x9b,
  OP_SUB_LONG = 0x9c,
  OP_MUL_LONG = 0x9d,
  OP_DIV_LONG = 0x9e,
  OP_REM_LONG = 0x9f,
  OP_AND_LONG = 0xa0,
  OP_OR_LONG = 0xa1,
  OP_XOR_LONG = 0xa2,
  OP_SHL_LONG = 0xa3,
  OP_SHR_LONG = 0xa4,
  OP_USHR_LONG = 0xa5,
  OP_ADD_FLOAT = 0xa6,
  OP_SUB_FLOAT = 0xa7,
  OP_MUL_FLOAT = 0xa8,
  OP_DIV_FLOAT = 0xa9,
  OP_REM_FLOAT = 0xaa,
  OP_ADD_DOUBLE = 0xab,
  OP_SUB_DOUBLE = 0xac,
  OP_MUL_DOUBLE = 0xad,
  OP_DIV_DOUBLE = 0xae,
  OP_REM_DOUBLE = 0xaf,
  OP_ADD_INT_2_ADDR = 0xb0,
  OP_SUB_INT_2_ADDR = 0xb1,
  OP_MUL_INT_2_ADDR = 0xb2,
  OP_DIV_INT_2_ADDR = 0xb3,
  OP_REM_INT_2_ADDR = 0xb4,
  OP_AND_INT_2_ADDR = 0xb5,
  OP_OR_INT_2_ADDR = 0xb6,
  OP_XOR_INT_2_ADDR = 0xb7,
  OP_SHL_INT_2_ADDR = 0xb8,
  OP_SHR_INT_2_ADDR = 0xb9,
  OP_USHR_INT_2_ADDR = 0xba,
  OP_ADD_LONG_2_ADDR = 0xbb,
  OP_SUB_LONG_2_ADDR = 0xbc,
  OP_MUL_LONG_2_ADDR = 0xbd,
  OP_DIV_LONG_2_ADDR = 0xbe,
  OP_REM_LONG_2_ADDR = 0xbf,
  OP_AND_LONG_2_ADDR = 0xc0,
  OP_OR_LONG_2_ADDR = 0xc1,
  OP_XOR_LONG_2_ADDR = 0xc2,
  OP_SHL_LONG_2_ADDR = 0xc3,
  OP_SHR_LONG_2_ADDR = 0xc4,
  OP_USHR_LONG_2_ADDR = 0xc5,
  OP_ADD_FLOAT_2_ADDR = 0xc6,
  OP_SUB_FLOAT_2_ADDR = 0xc7,
  OP_MUL_FLOAT_2_ADDR = 0xc8,
  OP_DIV_FLOAT_2_ADDR = 0xc9,
  OP_REM_FLOAT_2_ADDR = 0xca,
  OP_ADD_DOUBLE_2_ADDR = 0xcb,
  OP_SUB_DOUBLE_2_ADDR = 0xcc,
  OP_MUL_DOUBLE_2_ADDR = 0xcd,
  OP_DIV_DOUBLE_2_ADDR = 0xce,
  OP_REM_DOUBLE_2_ADDR = 0xcf,
  OP_ADD_INT_LIT_16 = 0xd0,
  OP_RSUB_INT = 0xd1,
  OP_MUL_INT_LIT_16 = 0xd2,
  OP_DIV_INT_LIT_16 = 0xd3,
  OP_REM_INT_LIT_16 = 0xd4,
  OP_AND_INT_LIT_16 = 0xd5,
  OP_OR_INT_LIT_16 = 0xd6,
  OP_XOR_INT_LIT_16 = 0xd7,
  OP_ADD_INT_LIT_8 = 0xd8,
  OP_RSUB_INT_LIT_8 = 0xd9,
  OP_MUL_INT_LIT_8 = 0xda,
  OP_DIV_INT_LIT_8 = 0xdb,
  OP_REM_INT_LIT_8 = 0xdc,
  OP_AND_INT_LIT_8 = 0xdd,
  OP_OR_INT_LIT_8 = 0xde,
  OP_XOR_INT_LIT_8 = 0xdf,
  OP_SHL_INT_LIT_8 = 0xe0,
  OP_SHR_INT_LIT_8 = 0xe1,
  OP_USHR_INT_LIT_8 = 0xe2,

  // ODEX
  OP_IGET_QUICK = 0xe3,
  OP_IGET_WIDE_QUICK = 0xe4,
  OP_IGET_OBJECT_QUICK = 0xe5,
  OP_IPUT_QUICK = 0xe6,
  OP_IPUT_WIDE_QUICK = 0xe7,
  OP_IPUT_OBJECT_QUICK = 0xe8,
  OP_INVOKE_VIRTUAL_QUICK = 0xe9,
  OP_INVOKE_VIRTUAL_RANGE_QUICK = 0xea,
  OP_IPUT_BOOLEAN_QUICK = 0xeb,
  OP_IPUT_BYTE_QUICK = 0xec,
  OP_IPUT_CHAR_QUICK = 0xed,
  OP_IPUT_SHORT_QUICK = 0xee,
  OP_IGET_BOOLEAN_QUICK = 0xef,
  OP_IGET_BYTE_QUICK = 0xf0,
  OP_IGET_CHAR_QUICK = 0xf1,
  OP_IGET_SHORT_QUICK = 0xf2,

  // From DEX 38
  OP_INVOKE_POLYMORPHIC = 0xfa,
  OP_INVOKE_POLYMORPHIC_RANGE = 0xfb,
  OP_INVOKE_CUSTOM = 0xfc,
  OP_INVOKE_CUSTOM_RANGE = 0xfd,

  // From DEX 39
  OP_CONST_METHOD_HANDLE = 0xfe,
  OP_CONST_METHOD_TYPE = 0xff,
};

enum INST_FORMATS : uint8_t {
  F_00x = 0,
  F_10x,
  F_12x,
  F_11n,
  F_11x,
  F_10t,
  F_20t,
  F_20bc,
  F_22x,
  F_21t,
  F_21s,
  F_21h,
  F_21c,
  F_23x,
  F_22b,
  F_22t,
  F_22s,
  F_22c,
  F_22cs,
  F_30t,
  F_32x,
  F_31i,
  F_31t,
  F_31c,
  F_35c,
  F_35ms,
  F_35mi,
  F_3rc,
  F_3rms,
  F_3rmi,
  F_51l,

  // Since DEX 38
  F_45cc,
  F_4rcc,
};

struct packed_switch {
  uint16_t ident; // 0x0100
  uint16_t size;
  uint32_t first_key;
  // uint32_t targets[size]
};


struct sparse_switch {
  uint16_t ident; // 0x0200
  uint16_t size;
  // uint32_t targets[size]
};

struct fill_array_data {
  uint16_t ident;
  uint16_t element_width;
  uint32_t size;
  // uint8_t data[size];
};


/// Return the INST_FORMATS format associated with the given opcode
LIEF_API INST_FORMATS inst_format_from_opcode(OPCODES op);

LIEF_API size_t inst_size_from_format(INST_FORMATS fmt);
LIEF_API size_t inst_size_from_opcode(OPCODES op);

LIEF_API bool is_switch_array(const uint8_t* ptr, const uint8_t* end);

LIEF_API size_t switch_array_size(const uint8_t* ptr, const uint8_t* end);

inline bool valid_inst_size(const uint8_t* ptr, const uint8_t* end, size_t size) {
  return size != 0 && size != SIZE_MAX && (size_t)(end - ptr) >= size;
}

} // Namespace LIEF
// Namespace DEX

#endif
