#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <dttr_core.h>
#include <dttr_pcdogs.h>

Go to the source code of this file.

Data Structures
struct	DTTR_Util_PkgVisit
	Pointers last only for the visit unless PCDOGS documents a longer lifetime. More...
struct	DTTR_Util_PkgWalkOptions
	Walk options. Start from DTTR_Util_PkgWalk_DefaultOptions() for defaults. More...
struct	DTTR_Util_PkgWalkResult
	Non-fatal per-entry failures keep traversal moving. More...

Macros
#define	DTTR_UTIL_API extern
#define	DTTR_UTIL_PKG_DEFAULT_TOC_COUNT 138u
	Default TOC entry count when options provide neither entries nor a count.
#define	DTTR_UTIL_PKG_VISIT_AS(FnSuffix, Kind, Type)
	Define a typed accessor that returns visit->ptr only for the matching kind.

Typedefs
typedef enum DTTR_Util_PkgWalkDomain	DTTR_Util_PkgWalkDomain
	Bit flags for DTTR_Util_PkgWalkOptions.domains.
typedef enum DTTR_Util_PkgVisitKind	DTTR_Util_PkgVisitKind
	Values stored in DTTR_Util_PkgVisit.kind.
typedef enum DTTR_Util_PkgVisitStatus	DTTR_Util_PkgVisitStatus
	Status values reported by visits and the final walk result.
typedef enum DTTR_Util_PkgVisitAction	DTTR_Util_PkgVisitAction
	Visitor actions that steer the next walk step.
typedef struct DTTR_Util_PkgVisit	DTTR_Util_PkgVisit
typedef DTTR_Util_PkgVisitAction(*	DTTR_Util_PkgVisitor) (const DTTR_Util_PkgVisit visit, void userdata)
	Visitor called once per visit. Its return value steers traversal.
typedef bool(*	DTTR_Util_PkgLoadEntryFn) (const DTTR_Core_Context ctx, int32_t toc_index, const DTTR_PCDOGS_T_PKG_TOCEntry entry, void userdata, void out_entry, size_t out_size, DTTR_Util_PkgVisitStatus *out_status)
	Load data for a TOC entry, reporting failures through out_status.
typedef void(*	DTTR_Util_PkgFreeEntryFn) (const DTTR_Core_Context ctx, int32_t toc_index, const DTTR_PCDOGS_T_PKG_TOCEntry entry, void entry_data, void userdata)
	Release entry data produced by the matching load callback.
typedef struct DTTR_Util_PkgWalkOptions	DTTR_Util_PkgWalkOptions
	Walk options. Start from DTTR_Util_PkgWalk_DefaultOptions() for defaults.
typedef struct DTTR_Util_PkgWalkResult	DTTR_Util_PkgWalkResult
	Non-fatal per-entry failures keep traversal moving.

Enumerations
enum	DTTR_Util_PkgWalkDomain { DTTR_UTIL_PKG_DOMAIN_TOC = 1u << 0 , DTTR_UTIL_PKG_DOMAIN_ENTRY = 1u << 1 , DTTR_UTIL_PKG_DOMAIN_LEVEL = 1u << 2 , DTTR_UTIL_PKG_DOMAIN_MESH = 1u << 3 , DTTR_UTIL_PKG_DOMAIN_MATERIAL = 1u << 4 , DTTR_UTIL_PKG_DOMAIN_SCENE = 1u << 5 , DTTR_UTIL_PKG_DOMAIN_SPRITE = 1u << 6 , DTTR_UTIL_PKG_DOMAIN_COLLISION = 1u << 7 , DTTR_UTIL_PKG_DOMAIN_KNOWN_CHILDREN , DTTR_UTIL_PKG_DOMAIN_ALL_KNOWN }
	Bit flags for DTTR_Util_PkgWalkOptions.domains. More...
enum	DTTR_Util_PkgVisitKind { DTTR_UTIL_PKG_VISIT_TOC_ENTRY = 1 , DTTR_UTIL_PKG_VISIT_LOADED_ENTRY , DTTR_UTIL_PKG_VISIT_LEVEL_RUNTIME_DATA , DTTR_UTIL_PKG_VISIT_MESH_NODE , DTTR_UTIL_PKG_VISIT_SCENE_NODE , DTTR_UTIL_PKG_VISIT_SPRITE_ENTRY , DTTR_UTIL_PKG_VISIT_UNSUPPORTED }
	Values stored in DTTR_Util_PkgVisit.kind. More...
enum	DTTR_Util_PkgVisitStatus { DTTR_UTIL_PKG_STATUS_OK = 0 , DTTR_UTIL_PKG_STATUS_INVALID_ARGUMENT , DTTR_UTIL_PKG_STATUS_UNRESOLVED_SYMBOL , DTTR_UTIL_PKG_STATUS_LOAD_FAILED , DTTR_UTIL_PKG_STATUS_UNKNOWN_ENTRY_KIND , DTTR_UTIL_PKG_STATUS_DECODE_UNSUPPORTED , DTTR_UTIL_PKG_STATUS_BOUNDS_INVALID }
	Status values reported by visits and the final walk result. More...
enum	DTTR_Util_PkgVisitAction { DTTR_UTIL_PKG_VISIT_CONTINUE = 0 , DTTR_UTIL_PKG_VISIT_RECURSE , DTTR_UTIL_PKG_VISIT_LOAD_AND_RECURSE , DTTR_UTIL_PKG_VISIT_SKIP_SUBTREE , DTTR_UTIL_PKG_VISIT_STOP }
	Visitor actions that steer the next walk step. More...

Functions
DTTR_UTIL_API DTTR_Util_PkgWalkOptions	DTTR_Util_PkgWalk_DefaultOptions ()
	Return default options covering all known domains, entry loading included.
DTTR_UTIL_API DTTR_Util_PkgWalkResult	DTTR_Util_PkgWalk (const DTTR_Core_Context ctx, const DTTR_Util_PkgWalkOptions options, DTTR_Util_PkgVisitor visitor, void *userdata)
	Walk live package structures and call the visitor for each visit.
DTTR_UTIL_API const char *	DTTR_Util_PkgVisitStatusName (DTTR_Util_PkgVisitStatus status)
	Return a static log-friendly name such as ok or load failed.
	DTTR_UTIL_PKG_VISIT_AS (LevelRuntimeData, DTTR_UTIL_PKG_VISIT_LEVEL_RUNTIME_DATA, DTTR_PCDOGS_T_Level_RuntimeData) DTTR_UTIL_PKG_VISIT_AS(MaterialEntry
DTTR_PCDOGS_T_Material_Entry	DTTR_UTIL_PKG_VISIT_AS (SpriteContext, DTTR_UTIL_PKG_VISIT_SPRITE_ENTRY, DTTR_PCDOGS_T_Graphics_SpriteContext) DTTR_UTIL_PKG_VISIT_AS(CollisionShape

Variables
	DTTR_UTIL_PKG_VISIT_MATERIAL_ENTRY
DTTR_PCDOGS_T_Material_Entry	DTTR_UTIL_PKG_VISIT_COLLISION_SHAPE

Macro Definition Documentation

◆ DTTR_UTIL_API

#define DTTR_UTIL_API extern

Experimental helpers for walking live package structures during reverse-engineering work.

This header is exposed through dttr_sdk.h only when DTTR_SDK_ENABLE_UNSTABLE is set. It depends on PCDOGS layouts that are still being mapped, so source and ABI details may change without notice.

Definition at line 22 of file dttr_util_pkg.h.

◆ DTTR_UTIL_PKG_DEFAULT_TOC_COUNT

#define DTTR_UTIL_PKG_DEFAULT_TOC_COUNT 138u

Default TOC entry count when options provide neither entries nor a count.

Definition at line 30 of file dttr_util_pkg.h.

Referenced by DTTR_Util_PkgWalk_DefaultOptions(), and resolve_toc().

◆ DTTR_UTIL_PKG_VISIT_AS

#define DTTR_UTIL_PKG_VISIT_AS	(	FnSuffix,
		Kind,
		Type )

Value:

static inline const Type *DTTR_Util_PkgVisit_As##FnSuffix(                           \
    const DTTR_Util_PkgVisit *visit                                                  \
) {                                                                                  \
    return visit && visit->kind == (Kind) ? (const Type *)visit->ptr : NULL;         \
}

Define a typed accessor that returns visit->ptr only for the matching kind.

Definition at line 167 of file dttr_util_pkg.h.

Referenced by DTTR_UTIL_PKG_VISIT_AS(), and DTTR_UTIL_PKG_VISIT_AS().

Typedef Documentation

◆ DTTR_Util_PkgFreeEntryFn

typedef void(* DTTR_Util_PkgFreeEntryFn) (const DTTR_Core_Context *ctx, int32_t toc_index, const DTTR_PCDOGS_T_PKG_TOCEntry *entry, void *entry_data, void *userdata)

Release entry data produced by the matching load callback.

Definition at line 105 of file dttr_util_pkg.h.

◆ DTTR_Util_PkgLoadEntryFn

typedef bool(* DTTR_Util_PkgLoadEntryFn) (const DTTR_Core_Context *ctx, int32_t toc_index, const DTTR_PCDOGS_T_PKG_TOCEntry *entry, void *userdata, void **out_entry, size_t *out_size, DTTR_Util_PkgVisitStatus *out_status)

Load data for a TOC entry, reporting failures through out_status.

Definition at line 94 of file dttr_util_pkg.h.

◆ DTTR_Util_PkgVisit

typedef struct DTTR_Util_PkgVisit DTTR_Util_PkgVisit

Definition at line 85 of file dttr_util_pkg.h.

◆ DTTR_Util_PkgVisitAction

typedef enum DTTR_Util_PkgVisitAction DTTR_Util_PkgVisitAction

Visitor actions that steer the next walk step.

◆ DTTR_Util_PkgVisitKind

typedef enum DTTR_Util_PkgVisitKind DTTR_Util_PkgVisitKind

Values stored in DTTR_Util_PkgVisit.kind.

◆ DTTR_Util_PkgVisitor

typedef DTTR_Util_PkgVisitAction(* DTTR_Util_PkgVisitor) (const DTTR_Util_PkgVisit *visit, void *userdata)

Visitor called once per visit. Its return value steers traversal.

Definition at line 88 of file dttr_util_pkg.h.

◆ DTTR_Util_PkgVisitStatus

typedef enum DTTR_Util_PkgVisitStatus DTTR_Util_PkgVisitStatus

Status values reported by visits and the final walk result.

◆ DTTR_Util_PkgWalkDomain

typedef enum DTTR_Util_PkgWalkDomain DTTR_Util_PkgWalkDomain

Bit flags for DTTR_Util_PkgWalkOptions.domains.

◆ DTTR_Util_PkgWalkOptions

typedef struct DTTR_Util_PkgWalkOptions DTTR_Util_PkgWalkOptions

Walk options. Start from DTTR_Util_PkgWalk_DefaultOptions() for defaults.

◆ DTTR_Util_PkgWalkResult

typedef struct DTTR_Util_PkgWalkResult DTTR_Util_PkgWalkResult

Non-fatal per-entry failures keep traversal moving.

Enumeration Type Documentation

◆ DTTR_Util_PkgVisitAction

enum DTTR_Util_PkgVisitAction

Visitor actions that steer the next walk step.

Enumerator
DTTR_UTIL_PKG_VISIT_CONTINUE
DTTR_UTIL_PKG_VISIT_RECURSE
DTTR_UTIL_PKG_VISIT_LOAD_AND_RECURSE
DTTR_UTIL_PKG_VISIT_SKIP_SUBTREE
DTTR_UTIL_PKG_VISIT_STOP

Definition at line 77 of file dttr_util_pkg.h.

◆ DTTR_Util_PkgVisitKind

enum DTTR_Util_PkgVisitKind

Values stored in DTTR_Util_PkgVisit.kind.

Enumerator
DTTR_UTIL_PKG_VISIT_TOC_ENTRY
DTTR_UTIL_PKG_VISIT_LOADED_ENTRY
DTTR_UTIL_PKG_VISIT_LEVEL_RUNTIME_DATA
DTTR_UTIL_PKG_VISIT_MESH_NODE
DTTR_UTIL_PKG_VISIT_SCENE_NODE
DTTR_UTIL_PKG_VISIT_SPRITE_ENTRY
DTTR_UTIL_PKG_VISIT_UNSUPPORTED

Definition at line 53 of file dttr_util_pkg.h.

◆ DTTR_Util_PkgVisitStatus

enum DTTR_Util_PkgVisitStatus

Status values reported by visits and the final walk result.

Enumerator
DTTR_UTIL_PKG_STATUS_OK
DTTR_UTIL_PKG_STATUS_INVALID_ARGUMENT
DTTR_UTIL_PKG_STATUS_UNRESOLVED_SYMBOL
DTTR_UTIL_PKG_STATUS_LOAD_FAILED
DTTR_UTIL_PKG_STATUS_UNKNOWN_ENTRY_KIND
DTTR_UTIL_PKG_STATUS_DECODE_UNSUPPORTED
DTTR_UTIL_PKG_STATUS_BOUNDS_INVALID

Definition at line 66 of file dttr_util_pkg.h.

◆ DTTR_Util_PkgWalkDomain

enum DTTR_Util_PkgWalkDomain

Bit flags for DTTR_Util_PkgWalkOptions.domains.

Enumerator
DTTR_UTIL_PKG_DOMAIN_TOC
DTTR_UTIL_PKG_DOMAIN_ENTRY
DTTR_UTIL_PKG_DOMAIN_LEVEL
DTTR_UTIL_PKG_DOMAIN_MESH
DTTR_UTIL_PKG_DOMAIN_MATERIAL
DTTR_UTIL_PKG_DOMAIN_SCENE
DTTR_UTIL_PKG_DOMAIN_SPRITE
DTTR_UTIL_PKG_DOMAIN_COLLISION
DTTR_UTIL_PKG_DOMAIN_KNOWN_CHILDREN
DTTR_UTIL_PKG_DOMAIN_ALL_KNOWN

Definition at line 33 of file dttr_util_pkg.h.

Function Documentation

◆ DTTR_UTIL_PKG_VISIT_AS() [1/2]

DTTR_UTIL_PKG_VISIT_AS	(	LevelRuntimeData	,
		DTTR_UTIL_PKG_VISIT_LEVEL_RUNTIME_DATA	,
		DTTR_PCDOGS_T_Level_RuntimeData	)

References DTTR_UTIL_PKG_VISIT_AS, DTTR_UTIL_PKG_VISIT_LEVEL_RUNTIME_DATA, and DTTR_UTIL_PKG_VISIT_MESH_NODE.

◆ DTTR_UTIL_PKG_VISIT_AS() [2/2]

DTTR_PCDOGS_T_Material_Entry DTTR_UTIL_PKG_VISIT_AS	(	SpriteContext	,
		DTTR_UTIL_PKG_VISIT_SPRITE_ENTRY	,
		DTTR_PCDOGS_T_Graphics_SpriteContext	)

References DTTR_UTIL_PKG_VISIT_AS, and DTTR_UTIL_PKG_VISIT_SPRITE_ENTRY.

◆ DTTR_Util_PkgVisitStatusName()

DTTR_UTIL_API const char * DTTR_Util_PkgVisitStatusName ( DTTR_Util_PkgVisitStatus status )

Return a static log-friendly name such as ok or load failed.

Definition at line 28 of file util_pkg_walk.c.

References DTTR_UTIL_PKG_STATUS_BOUNDS_INVALID, DTTR_UTIL_PKG_STATUS_DECODE_UNSUPPORTED, DTTR_UTIL_PKG_STATUS_INVALID_ARGUMENT, DTTR_UTIL_PKG_STATUS_LOAD_FAILED, DTTR_UTIL_PKG_STATUS_OK, DTTR_UTIL_PKG_STATUS_UNKNOWN_ENTRY_KIND, and DTTR_UTIL_PKG_STATUS_UNRESOLVED_SYMBOL.

◆ DTTR_Util_PkgWalk()

DTTR_UTIL_API DTTR_Util_PkgWalkResult DTTR_Util_PkgWalk	(	const DTTR_Core_Context *	ctx,
		const DTTR_Util_PkgWalkOptions *	options,
		DTTR_Util_PkgVisitor	visitor,
		void *	userdata )

Walk live package structures and call the visitor for each visit.

Definition at line 258 of file util_pkg_walk.c.

References ctx, default_free_entry(), default_load_entry(), DTTR_Util_PkgWalkOptions::domains, DTTR_UTIL_PKG_DOMAIN_TOC, DTTR_UTIL_PKG_STATUS_INVALID_ARGUMENT, DTTR_UTIL_PKG_STATUS_LOAD_FAILED, DTTR_UTIL_PKG_STATUS_OK, DTTR_UTIL_PKG_STATUS_UNRESOLVED_SYMBOL, DTTR_UTIL_PKG_VISIT_LOADED_ENTRY, DTTR_UTIL_PKG_VISIT_SKIP_SUBTREE, DTTR_UTIL_PKG_VISIT_STOP, DTTR_UTIL_PKG_VISIT_TOC_ENTRY, DTTR_UTIL_PKG_VISIT_UNSUPPORTED, DTTR_Util_PkgWalk_DefaultOptions(), emit_decode_boundary(), emit_visit(), DTTR_Util_PkgWalkOptions::free_entry, DTTR_Util_PkgWalkOptions::io_userdata, DTTR_Util_PkgWalkOptions::load_entry, DTTR_Util_PkgWalkResult::loaded_count, make_result(), make_visit(), DTTR_Util_PkgWalkOptions::max_depth, NULL, resolve_toc(), should_load(), should_recurse(), and DTTR_Util_PkgWalkResult::stopped.

◆ DTTR_Util_PkgWalk_DefaultOptions()

DTTR_UTIL_API DTTR_Util_PkgWalkOptions DTTR_Util_PkgWalk_DefaultOptions ( )

Return default options covering all known domains, entry loading included.

Definition at line 18 of file util_pkg_walk.c.

References DTTR_UTIL_PKG_DEFAULT_TOC_COUNT, and DTTR_UTIL_PKG_DOMAIN_ALL_KNOWN.

Referenced by DTTR_Util_PkgWalk().

Variable Documentation

◆ DTTR_UTIL_PKG_VISIT_COLLISION_SHAPE

DTTR_UTIL_PKG_VISIT_COLLISION_SHAPE

Definition at line 195 of file dttr_util_pkg.h.

◆ DTTR_UTIL_PKG_VISIT_MATERIAL_ENTRY

DTTR_UTIL_PKG_VISIT_MATERIAL_ENTRY

Definition at line 184 of file dttr_util_pkg.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ DTTR_UTIL_API

◆ DTTR_UTIL_PKG_DEFAULT_TOC_COUNT

◆ DTTR_UTIL_PKG_VISIT_AS

Typedef Documentation

◆ DTTR_Util_PkgFreeEntryFn

◆ DTTR_Util_PkgLoadEntryFn

◆ DTTR_Util_PkgVisit

◆ DTTR_Util_PkgVisitAction

◆ DTTR_Util_PkgVisitKind

◆ DTTR_Util_PkgVisitor

◆ DTTR_Util_PkgVisitStatus

◆ DTTR_Util_PkgWalkDomain

◆ DTTR_Util_PkgWalkOptions

◆ DTTR_Util_PkgWalkResult

Enumeration Type Documentation

◆ DTTR_Util_PkgVisitAction

◆ DTTR_Util_PkgVisitKind

◆ DTTR_Util_PkgVisitStatus

◆ DTTR_Util_PkgWalkDomain

Function Documentation

◆ DTTR_UTIL_PKG_VISIT_AS() [1/2]

◆ DTTR_UTIL_PKG_VISIT_AS() [2/2]

◆ DTTR_Util_PkgVisitStatusName()

◆ DTTR_Util_PkgWalk()

◆ DTTR_Util_PkgWalk_DefaultOptions()

Variable Documentation

◆ DTTR_UTIL_PKG_VISIT_COLLISION_SHAPE

◆ DTTR_UTIL_PKG_VISIT_MATERIAL_ENTRY