// Copyright (c) Epic Games Tools
// Licensed under the MIT license (https://opensource.org/license/mit/)

#ifndef DWARF_DUMP_H
#define DWARF_DUMP_H

////////////////////////////////
//~ rjf: Dump Subset Types

#define DW_DumpSubset_XList \
X(DebugInfo,           debug_info,          "DEBUG INFO")\
X(DebugAbbrev,         debug_abbrev,        "DEBUG ABBREV")\
X(DebugLine,           debug_line,          "DEBUG LINE")\
X(DebugStr,            debug_str,           "DEBUG STR")\
X(DebugLoc,            debug_loc,           "DEBUG LOC")\
X(DebugRanges,         debug_ranges,        "DEBUG RANGES")\
X(DebugARanges,        debug_aranges,       "DEBUG ARANGES")\
X(DebugAddr,           debug_addr,          "DEBUG ADDR")\
X(DebugLocLists,       debug_loclists,      "DEBUG LOCLISTS")\
X(DebugRngLists,       debug_rnglists,      "DEBUG RNGLISTS")\
X(DebugPubNames,       debug_pubnames,      "DEBUG PUBNAMES")\
X(DebugPubTypes,       debug_pubtypes,      "DEBUG PUBTYPES")\
X(DebugLineStr,        debug_linestr,       "DEBUG LINESTR")\
X(DebugStrOffsets,     debug_stroff,        "DEBUG STROFF")\

typedef enum DW_DumpSubset
{
#define X(name, name_lower, title) DW_DumpSubset_##name,
  DW_DumpSubset_XList
#undef X
}
DW_DumpSubset;

typedef U32 DW_DumpSubsetFlags;
enum
{
#define X(name, name_lower, title) DW_DumpSubsetFlag_##name = (1<<DW_DumpSubset_##name),
  DW_DumpSubset_XList
#undef X
  DW_DumpSubsetFlag_All = 0xffffffffu,
};

read_only global String8 dw_name_lowercase_from_dump_subset_table[] =
{
#define X(name, name_lower, title) str8_lit_comp(#name_lower),
  DW_DumpSubset_XList
#undef X
};

read_only global String8 dw_name_title_from_dump_subset_table[] =
{
#define X(name, name_lower, title) str8_lit_comp(title),
  DW_DumpSubset_XList
#undef X
};

////////////////////////////////
//~ rjf: Stringification Helpers

internal String8 dw_string_from_reg_off(Arena *arena, Arch arch, U64 reg_idx, S64 reg_off);
internal String8List dw_string_list_from_expression  (Arena *arena, String8 raw_data, U64 cu_base, U64 address_size, Arch arch, DW_Version ver, DW_Ext ext, DW_Format format);
internal String8 dw_single_line_string_from_expression(Arena *arena, String8 raw_data, U64 cu_base, U64 address_size, Arch arch, DW_Version ver, DW_Ext ext, DW_Format format);
internal String8 dw_string_from_eh_ptr_enc            (Arena *arena, DW_EhPtrEnc enc);
internal void dw_string_from_cfi_program            (Arena *arena, String8List *out, String8 indent, String8 raw_data, DW_CIEUnpacked *cie, DW_EhPtrCtx *ptr_ctx, Arch arch, DW_Version ver, DW_Ext ext, DW_Format format);

internal void dw_print_eh_frame         (Arena *arena, String8List *out, String8 indent, String8 raw_eh_frame, Arch arch, DW_Version ver, DW_Ext ext, DW_EhPtrCtx *ptr_ctx);
internal void dw_print_debug_loc        (Arena *arena, String8List *out, String8 indent, DW_Input *input, Arch arch, ExecutableImageKind image_type, B32 relaxed);
internal void dw_print_debug_ranges     (Arena *arena, String8List *out, String8 indent, DW_Input *input, Arch arch, ExecutableImageKind image_type, B32 relaxed);
internal void dw_print_debug_aranges    (Arena *arena, String8List *out, String8 indent, DW_Input *input);
internal void dw_print_debug_addr       (Arena *arena, String8List *out, String8 indent, DW_Input *input);
internal void dw_print_debug_loclists   (Arena *arena, String8List *out, String8 indent, DW_Input *input, Rng1U64Array segment_vranges, Arch arch);
internal void dw_print_debug_rnglists   (Arena *arena, String8List *out, String8 indent, DW_Input *input, Rng1U64Array segment_vranges);
internal void dw_print_debug_pubnames   (Arena *arena, String8List *out, String8 indent, DW_Input *input);
internal void dw_print_debug_pubtypes   (Arena *arena, String8List *out, String8 indent, DW_Input *input);
internal void dw_print_debug_line_str   (Arena *arena, String8List *out, String8 indent, DW_Input *input);
internal void dw_print_debug_str_offsets(Arena *arena, String8List *out, String8 indent, DW_Input *input);

////////////////////////////////
//~ rjf: Dump Entry Point

internal String8List dw_dump_list_from_sections(Arena *arena, DW_Input *input, Arch arch, DW_DumpSubsetFlags subset_flags);

#endif // DWARF_DUMP_H