gemba 0.1.1 → 0.2.0

data/vendor/rcheevos/include/rc_client_raintegration.h

@@ -0,0 +1,101 @@
+#ifndef RC_CLIENT_RAINTEGRATION_H
+#define RC_CLIENT_RAINTEGRATION_H
+
+#ifndef _WIN32
+ #undef RC_CLIENT_SUPPORTS_RAINTEGRATION /* Windows required for RAIntegration */
+#endif
+
+#include <stdint.h>
+
+#include "rc_export.h"
+
+RC_BEGIN_C_DECLS
+
+typedef struct rc_client_t rc_client_t; /* forward reference; in rc_client.h */
+
+/* types needed to implement raintegration */
+
+typedef struct rc_client_raintegration_menu_item_t {
+  const char* label;
+  uint32_t id;
+  uint8_t checked;
+  uint8_t enabled;
+} rc_client_raintegration_menu_item_t;
+
+typedef struct rc_client_raintegration_menu_t {
+  rc_client_raintegration_menu_item_t* items;
+  uint32_t num_items;
+} rc_client_raintegration_menu_t;
+
+enum {
+  RC_CLIENT_RAINTEGRATION_ACHIEVEMENT_STATE_NONE = 0,
+  RC_CLIENT_RAINTEGRATION_ACHIEVEMENT_STATE_PUBLISHED = 1,
+  RC_CLIENT_RAINTEGRATION_ACHIEVEMENT_STATE_LOCAL = 2,
+  RC_CLIENT_RAINTEGRATION_ACHIEVEMENT_STATE_MODIFIED = 3,
+  RC_CLIENT_RAINTEGRATION_ACHIEVEMENT_STATE_INSECURE = 4,
+};
+
+enum {
+  RC_CLIENT_RAINTEGRATION_EVENT_TYPE_NONE = 0,
+  RC_CLIENT_RAINTEGRATION_EVENT_MENUITEM_CHECKED_CHANGED = 1, /* [menu_item] checked changed */
+  RC_CLIENT_RAINTEGRATION_EVENT_HARDCORE_CHANGED = 2, /* hardcore was enabled or disabled */
+  RC_CLIENT_RAINTEGRATION_EVENT_PAUSE = 3, /* emulated system should be paused */
+  RC_CLIENT_RAINTEGRATION_EVENT_MENU_CHANGED = 4 /* one or more items were added/removed from the menu and it should be rebuilt */
+};
+
+typedef struct rc_client_raintegration_event_t {
+  uint32_t type;
+
+  const rc_client_raintegration_menu_item_t* menu_item;
+} rc_client_raintegration_event_t;
+
+typedef void (RC_CCONV *rc_client_raintegration_event_handler_t)(const rc_client_raintegration_event_t* event,
+                                                                 rc_client_t* client);
+
+typedef void (RC_CCONV *rc_client_raintegration_write_memory_func_t)(uint32_t address, uint8_t* buffer,
+                                                                     uint32_t num_bytes, rc_client_t* client);
+
+typedef void (RC_CCONV* rc_client_raintegration_get_game_name_func_t)(char* buffer, uint32_t buffer_size, rc_client_t* client);
+
+/* types needed to integrate raintegration */
+
+#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
+
+#ifndef RC_CLIENT_SUPPORTS_EXTERNAL
+ #define RC_CLIENT_SUPPORTS_EXTERNAL /* external rc_client required for RAIntegration */
+#endif
+
+#include <wtypes.h> /* HWND */
+
+#include "rc_client.h"
+
+RC_EXPORT rc_client_async_handle_t* RC_CCONV rc_client_begin_load_raintegration(rc_client_t* client,
+    const wchar_t* search_directory, HWND main_window_handle,
+    const char* client_name, const char* client_version,
+    rc_client_callback_t callback, void* callback_userdata);
+
+RC_EXPORT void RC_CCONV rc_client_unload_raintegration(rc_client_t* client);
+
+RC_EXPORT void RC_CCONV rc_client_raintegration_update_main_window_handle(rc_client_t* client, HWND main_window_handle);
+
+RC_EXPORT const rc_client_raintegration_menu_t* RC_CCONV rc_client_raintegration_get_menu(const rc_client_t* client);
+
+RC_EXPORT void RC_CCONV rc_client_raintegration_rebuild_submenu(rc_client_t* client, HMENU hMenu);
+RC_EXPORT void RC_CCONV rc_client_raintegration_update_menu_item(const rc_client_t* client, const rc_client_raintegration_menu_item_t* menu_item);
+RC_EXPORT int RC_CCONV rc_client_raintegration_activate_menu_item(const rc_client_t* client, uint32_t menu_item_id);
+
+RC_EXPORT void RC_CCONV rc_client_raintegration_set_write_memory_function(rc_client_t* client, rc_client_raintegration_write_memory_func_t handler);
+RC_EXPORT void RC_CCONV rc_client_raintegration_set_get_game_name_function(rc_client_t* client, rc_client_raintegration_get_game_name_func_t handler);
+RC_EXPORT void RC_CCONV rc_client_raintegration_set_console_id(rc_client_t* client, uint32_t console_id);
+RC_EXPORT int RC_CCONV rc_client_raintegration_has_modifications(const rc_client_t* client);
+
+RC_EXPORT void RC_CCONV rc_client_raintegration_set_event_handler(rc_client_t* client,
+    rc_client_raintegration_event_handler_t handler);
+
+RC_EXPORT int RC_CCONV rc_client_raintegration_get_achievement_state(const rc_client_t* client, uint32_t achievement_id);
+
+#endif /* RC_CLIENT_SUPPORTS_RAINTEGRATION */
+
+RC_END_C_DECLS
+
+#endif /* RC_CLIENT_RAINTEGRATION_H */

data/vendor/rcheevos/include/rc_consoles.h

@@ -0,0 +1,138 @@
+#ifndef RC_CONSOLES_H
+#define RC_CONSOLES_H
+
+#include "rc_export.h"
+
+#include <stdint.h>
+
+RC_BEGIN_C_DECLS
+
+/*****************************************************************************\
+| Console identifiers                                                         |
+\*****************************************************************************/
+
+enum {
+  RC_CONSOLE_UNKNOWN = 0,
+  RC_CONSOLE_MEGA_DRIVE = 1,
+  RC_CONSOLE_NINTENDO_64 = 2,
+  RC_CONSOLE_SUPER_NINTENDO = 3,
+  RC_CONSOLE_GAMEBOY = 4,
+  RC_CONSOLE_GAMEBOY_ADVANCE = 5,
+  RC_CONSOLE_GAMEBOY_COLOR = 6,
+  RC_CONSOLE_NINTENDO = 7,
+  RC_CONSOLE_PC_ENGINE = 8,
+  RC_CONSOLE_SEGA_CD = 9,
+  RC_CONSOLE_SEGA_32X = 10,
+  RC_CONSOLE_MASTER_SYSTEM = 11,
+  RC_CONSOLE_PLAYSTATION = 12,
+  RC_CONSOLE_ATARI_LYNX = 13,
+  RC_CONSOLE_NEOGEO_POCKET = 14,
+  RC_CONSOLE_GAME_GEAR = 15,
+  RC_CONSOLE_GAMECUBE = 16,
+  RC_CONSOLE_ATARI_JAGUAR = 17,
+  RC_CONSOLE_NINTENDO_DS = 18,
+  RC_CONSOLE_WII = 19,
+  RC_CONSOLE_WII_U = 20,
+  RC_CONSOLE_PLAYSTATION_2 = 21,
+  RC_CONSOLE_XBOX = 22,
+  RC_CONSOLE_MAGNAVOX_ODYSSEY2 = 23,
+  RC_CONSOLE_POKEMON_MINI = 24,
+  RC_CONSOLE_ATARI_2600 = 25,
+  RC_CONSOLE_MS_DOS = 26,
+  RC_CONSOLE_ARCADE = 27,
+  RC_CONSOLE_VIRTUAL_BOY = 28,
+  RC_CONSOLE_MSX = 29,
+  RC_CONSOLE_COMMODORE_64 = 30,
+  RC_CONSOLE_ZX81 = 31,
+  RC_CONSOLE_ORIC = 32,
+  RC_CONSOLE_SG1000 = 33,
+  RC_CONSOLE_VIC20 = 34,
+  RC_CONSOLE_AMIGA = 35,
+  RC_CONSOLE_ATARI_ST = 36,
+  RC_CONSOLE_AMSTRAD_PC = 37,
+  RC_CONSOLE_APPLE_II = 38,
+  RC_CONSOLE_SATURN = 39,
+  RC_CONSOLE_DREAMCAST = 40,
+  RC_CONSOLE_PSP = 41,
+  RC_CONSOLE_CDI = 42,
+  RC_CONSOLE_3DO = 43,
+  RC_CONSOLE_COLECOVISION = 44,
+  RC_CONSOLE_INTELLIVISION = 45,
+  RC_CONSOLE_VECTREX = 46,
+  RC_CONSOLE_PC8800 = 47,
+  RC_CONSOLE_PC9800 = 48,
+  RC_CONSOLE_PCFX = 49,
+  RC_CONSOLE_ATARI_5200 = 50,
+  RC_CONSOLE_ATARI_7800 = 51,
+  RC_CONSOLE_X68K = 52,
+  RC_CONSOLE_WONDERSWAN = 53,
+  RC_CONSOLE_CASSETTEVISION = 54,
+  RC_CONSOLE_SUPER_CASSETTEVISION = 55,
+  RC_CONSOLE_NEO_GEO_CD = 56,
+  RC_CONSOLE_FAIRCHILD_CHANNEL_F = 57,
+  RC_CONSOLE_FM_TOWNS = 58,
+  RC_CONSOLE_ZX_SPECTRUM = 59,
+  RC_CONSOLE_GAME_AND_WATCH = 60,
+  RC_CONSOLE_NOKIA_NGAGE = 61,
+  RC_CONSOLE_NINTENDO_3DS = 62,
+  RC_CONSOLE_SUPERVISION = 63,
+  RC_CONSOLE_SHARPX1 = 64,
+  RC_CONSOLE_TIC80 = 65,
+  RC_CONSOLE_THOMSONTO8 = 66,
+  RC_CONSOLE_PC6000 = 67,
+  RC_CONSOLE_PICO = 68,
+  RC_CONSOLE_MEGADUCK = 69,
+  RC_CONSOLE_ZEEBO = 70,
+  RC_CONSOLE_ARDUBOY = 71,
+  RC_CONSOLE_WASM4 = 72,
+  RC_CONSOLE_ARCADIA_2001 = 73,
+  RC_CONSOLE_INTERTON_VC_4000 = 74,
+  RC_CONSOLE_ELEKTOR_TV_GAMES_COMPUTER = 75,
+  RC_CONSOLE_PC_ENGINE_CD = 76,
+  RC_CONSOLE_ATARI_JAGUAR_CD = 77,
+  RC_CONSOLE_NINTENDO_DSI = 78,
+  RC_CONSOLE_TI83 = 79,
+  RC_CONSOLE_UZEBOX = 80,
+  RC_CONSOLE_FAMICOM_DISK_SYSTEM = 81,
+
+  RC_CONSOLE_HUBS = 100,
+  RC_CONSOLE_EVENTS = 101,
+  RC_CONSOLE_STANDALONE = 102
+};
+
+RC_EXPORT const char* RC_CCONV rc_console_name(uint32_t console_id);
+
+/*****************************************************************************\
+| Memory mapping                                                              |
+\*****************************************************************************/
+
+enum {
+  RC_MEMORY_TYPE_SYSTEM_RAM,          /* normal system memory */
+  RC_MEMORY_TYPE_SAVE_RAM,            /* memory that persists between sessions */
+  RC_MEMORY_TYPE_VIDEO_RAM,           /* memory reserved for graphical processing */
+  RC_MEMORY_TYPE_READONLY,            /* memory that maps to read only data */
+  RC_MEMORY_TYPE_HARDWARE_CONTROLLER, /* memory for interacting with system components */
+  RC_MEMORY_TYPE_VIRTUAL_RAM,         /* secondary address space that maps to real memory in system RAM */
+  RC_MEMORY_TYPE_UNUSED               /* these addresses don't really exist */
+};
+
+typedef struct rc_memory_region_t {
+  uint32_t start_address;             /* first address of block as queried by RetroAchievements */
+  uint32_t end_address;               /* last address of block as queried by RetroAchievements */
+  uint32_t real_address;              /* real address for first address of block */
+  uint8_t type;                       /* RC_MEMORY_TYPE_ for block */
+  const char* description;            /* short description of block */
+}
+rc_memory_region_t;
+
+typedef struct rc_memory_regions_t {
+  const rc_memory_region_t* region;
+  uint32_t num_regions;
+}
+rc_memory_regions_t;
+
+RC_EXPORT const rc_memory_regions_t* RC_CCONV rc_console_memory_regions(uint32_t console_id);
+
+RC_END_C_DECLS
+
+#endif /* RC_CONSOLES_H */

data/vendor/rcheevos/include/rc_error.h

@@ -0,0 +1,59 @@
+#ifndef RC_ERROR_H
+#define RC_ERROR_H
+
+#include "rc_export.h"
+
+RC_BEGIN_C_DECLS
+
+/*****************************************************************************\
+| Return values                                                               |
+\*****************************************************************************/
+
+enum {
+  RC_OK = 0,
+  RC_INVALID_FUNC_OPERAND = -1,
+  RC_INVALID_MEMORY_OPERAND = -2,
+  RC_INVALID_CONST_OPERAND = -3,
+  RC_INVALID_FP_OPERAND = -4,
+  RC_INVALID_CONDITION_TYPE = -5,
+  RC_INVALID_OPERATOR = -6,
+  RC_INVALID_REQUIRED_HITS = -7,
+  RC_DUPLICATED_START = -8,
+  RC_DUPLICATED_CANCEL = -9,
+  RC_DUPLICATED_SUBMIT = -10,
+  RC_DUPLICATED_VALUE = -11,
+  RC_DUPLICATED_PROGRESS = -12,
+  RC_MISSING_START = -13,
+  RC_MISSING_CANCEL = -14,
+  RC_MISSING_SUBMIT = -15,
+  RC_MISSING_VALUE = -16,
+  RC_INVALID_LBOARD_FIELD = -17,
+  RC_MISSING_DISPLAY_STRING = -18,
+  RC_OUT_OF_MEMORY = -19,
+  RC_INVALID_VALUE_FLAG = -20,
+  RC_MISSING_VALUE_MEASURED = -21,
+  RC_MULTIPLE_MEASURED = -22,
+  RC_INVALID_MEASURED_TARGET = -23,
+  RC_INVALID_COMPARISON = -24,
+  RC_INVALID_STATE = -25,
+  RC_INVALID_JSON = -26,
+  RC_API_FAILURE = -27,
+  RC_LOGIN_REQUIRED = -28,
+  RC_NO_GAME_LOADED = -29,
+  RC_HARDCORE_DISABLED = -30,
+  RC_ABORTED = -31,
+  RC_NO_RESPONSE = -32,
+  RC_ACCESS_DENIED = -33,
+  RC_INVALID_CREDENTIALS = -34,
+  RC_EXPIRED_TOKEN = -35,
+  RC_INSUFFICIENT_BUFFER = -36,
+  RC_INVALID_VARIABLE_NAME = -37,
+  RC_UNKNOWN_VARIABLE_NAME = -38,
+  RC_NOT_FOUND = -39
+};
+
+RC_EXPORT const char* RC_CCONV rc_error_str(int ret);
+
+RC_END_C_DECLS
+
+#endif /* RC_ERROR_H */

data/vendor/rcheevos/include/rc_export.h

@@ -0,0 +1,100 @@
+#ifndef RC_EXPORT_H
+#define RC_EXPORT_H
+
+/* These macros control how callbacks and public functions are defined */
+
+/* RC_SHARED should be defined when building rcheevos as a shared library (e.g. dll/dylib/so). External code should not define this macro. */
+/* RC_STATIC should be defined when building rcheevos as a static library. External code should also define this macro. */
+/* RC_IMPORT should be defined for external code using rcheevos as a shared library. */
+
+/* For compatibility, if none of these three macros are defined, then the build is assumed to be RC_STATIC */
+
+#if !defined(RC_SHARED) && !defined(RC_STATIC) && !defined(RC_IMPORT)
+  #define RC_STATIC
+#endif
+
+#if (defined(RC_SHARED) && defined(RC_STATIC)) || (defined(RC_SHARED) && defined(RC_IMPORT)) || (defined(RC_STATIC) && defined(RC_IMPORT))
+  #error RC_SHARED, RC_STATIC, and RC_IMPORT are mutually exclusive
+#endif
+
+/* RC_BEGIN_C_DECLS and RC_END_C_DECLS should be used for all headers, to enforce C linkage and the C calling convention */
+/* RC_BEGIN_C_DECLS should be placed after #include's and before header declarations */
+/* RC_END_C_DECLS should be placed after header declarations */
+
+/* example usage
+ *
+ * #ifndef RC_HEADER_H
+ * #define RC_HEADER_H
+ *
+ * #include <stdint.h>
+ *
+ * RC_BEGIN_C_DECLS
+ *
+ * uint8_t rc_function(void);
+ *
+ * RC_END_C_DECLS
+ *
+ * #endif
+ */
+
+#if defined(__cplusplus) && !defined(CXX_BUILD)
+  #define RC_BEGIN_C_DECLS extern "C" {
+  #define RC_END_C_DECLS }
+#else
+  #define RC_BEGIN_C_DECLS
+  #define RC_END_C_DECLS
+#endif
+
+/* RC_CCONV should be used for public functions and callbacks, to enforce the cdecl calling convention, if applicable */
+/* RC_CCONV should be placed after the return type, and between the ( and * for callbacks */
+
+/* example usage */
+/* void RC_CCONV rc_function(void) */
+/* void (RC_CCONV *rc_callback)(void) */
+
+#if defined(_WIN32)
+  /* Windows compilers will ignore __cdecl when not applicable */
+  #define RC_CCONV __cdecl
+#elif defined(__GNUC__) && defined(__i386__)
+  /* GNU C compilers will warn if cdecl is defined on an unsupported platform */
+  #define RC_CCONV __attribute__((cdecl))
+#else
+  #define RC_CCONV
+#endif
+
+/* RC_EXPORT should be used for public functions */
+/* RC_EXPORT will provide necessary hints for shared library usage, if applicable */
+/* RC_EXPORT should be placed before the return type */
+
+/* example usage */
+/* RC_EXPORT void rc_function(void) */
+
+#ifdef RC_SHARED
+  #if defined(_WIN32)
+    #define RC_EXPORT __declspec(dllexport)
+  #elif defined(__GNUC__) && __GNUC__ >= 4
+    #define RC_EXPORT __attribute__((visibility("default")))
+  #else
+    #define RC_EXPORT
+  #endif
+#endif
+
+#ifdef RC_IMPORT
+  #if defined(_WIN32)
+    #define RC_EXPORT __declspec(dllimport)
+  #elif defined(__GNUC__) && __GNUC__ >= 4
+    #define RC_EXPORT __attribute__((visibility("default")))
+  #else
+    #define RC_EXPORT
+  #endif
+#endif
+
+#ifdef RC_STATIC
+  #if defined(__GNUC__) && __GNUC__ >= 4
+    #define RC_EXPORT __attribute__((visibility("default")))
+  #else
+    #define RC_EXPORT
+  #endif
+#endif
+
+#endif /* RC_EXPORT_H */

data/vendor/rcheevos/include/rc_hash.h

@@ -0,0 +1,200 @@
+#ifndef RC_HASH_H
+#define RC_HASH_H
+
+#include <stddef.h>
+#include <stdio.h>
+#include <stdint.h>
+
+#include "rc_consoles.h"
+
+RC_BEGIN_C_DECLS
+
+  struct rc_hash_iterator;
+
+  /* ===================================================== */
+
+  typedef void (RC_CCONV *rc_hash_message_callback_deprecated)(const char*);
+
+  /* specifies a function to call when an error occurs to display the error message */
+  /* [deprecated] set callbacks in rc_hash_iterator_t */
+  RC_EXPORT void RC_CCONV rc_hash_init_error_message_callback(rc_hash_message_callback_deprecated callback);
+
+  /* specifies a function to call for verbose logging */
+  /* [deprecated] set callbacks in rc_hash_iterator_t */
+  RC_EXPORT void rc_hash_init_verbose_message_callback(rc_hash_message_callback_deprecated callback);
+
+  /* ===================================================== */
+
+  /* opens a file */
+  typedef void* (RC_CCONV *rc_hash_filereader_open_file_handler)(const char* path_utf8);
+
+  /* moves the file pointer - standard fseek parameters */
+  typedef void (RC_CCONV *rc_hash_filereader_seek_handler)(void* file_handle, int64_t offset, int origin);
+
+  /* locates the file pointer */
+  typedef int64_t (RC_CCONV *rc_hash_filereader_tell_handler)(void* file_handle);
+
+  /* reads the specified number of bytes from the file starting at the read pointer.
+   * returns the number of bytes actually read.
+   */
+  typedef size_t (RC_CCONV *rc_hash_filereader_read_handler)(void* file_handle, void* buffer, size_t requested_bytes);
+
+  /* closes the file */
+  typedef void (RC_CCONV *rc_hash_filereader_close_file_handler)(void* file_handle);
+
+  typedef struct rc_hash_filereader
+  {
+    rc_hash_filereader_open_file_handler      open;
+    rc_hash_filereader_seek_handler           seek;
+    rc_hash_filereader_tell_handler           tell;
+    rc_hash_filereader_read_handler           read;
+    rc_hash_filereader_close_file_handler     close;
+  } rc_hash_filereader_t;
+
+  /* [deprecated] set callbacks in rc_hash_iterator_t */
+  RC_EXPORT void RC_CCONV rc_hash_init_custom_filereader(struct rc_hash_filereader* reader);
+
+  /* ===================================================== */
+
+#ifndef RC_HASH_NO_DISC
+
+  #define RC_HASH_CDTRACK_FIRST_DATA ((uint32_t)-1) /* the first data track (skip audio tracks) */
+  #define RC_HASH_CDTRACK_LAST ((uint32_t)-2) /* the last data/audio track */
+  #define RC_HASH_CDTRACK_LARGEST ((uint32_t)-3) /* the largest data/audio track */
+  #define RC_HASH_CDTRACK_FIRST_OF_SECOND_SESSION ((uint32_t)-4) /* the first data/audio track of the second session */
+
+  /* opens a track from the specified file. see the RC_HASH_CDTRACK_ defines for special tracks.
+   * returns a handle to be passed to the other functions, or NULL if the track could not be opened.
+   */
+  typedef void* (RC_CCONV *rc_hash_cdreader_open_track_handler)(const char* path, uint32_t track);
+  typedef void* (RC_CCONV* rc_hash_cdreader_open_track_iterator_handler)(const char* path, uint32_t track, const struct rc_hash_iterator* iterator);
+
+  /* attempts to read the specified number of bytes from the file starting at the specified absolute sector.
+   * returns the number of bytes actually read.
+   */
+  typedef size_t (RC_CCONV *rc_hash_cdreader_read_sector_handler)(void* track_handle, uint32_t sector, void* buffer, size_t requested_bytes);
+
+  /* closes the track handle */
+  typedef void (RC_CCONV *rc_hash_cdreader_close_track_handler)(void* track_handle);
+
+  /* gets the absolute sector index for the first sector of a track */
+  typedef uint32_t(RC_CCONV *rc_hash_cdreader_first_track_sector_handler)(void* track_handle);
+
+  typedef struct rc_hash_cdreader
+  {
+    rc_hash_cdreader_open_track_handler              open_track;
+    rc_hash_cdreader_read_sector_handler             read_sector;
+    rc_hash_cdreader_close_track_handler             close_track;
+    rc_hash_cdreader_first_track_sector_handler      first_track_sector;
+    rc_hash_cdreader_open_track_iterator_handler     open_track_iterator;
+  } rc_hash_cdreader_t;
+
+  RC_EXPORT void RC_CCONV rc_hash_get_default_cdreader(struct rc_hash_cdreader* cdreader);
+  /* [deprecated] don't set callbacks in rc_hash_iterator_t */
+  RC_EXPORT void RC_CCONV rc_hash_init_default_cdreader(void);
+  /* [deprecated] set callbacks in rc_hash_iterator_t */
+  RC_EXPORT void RC_CCONV rc_hash_init_custom_cdreader(struct rc_hash_cdreader* reader);
+
+#endif /* RC_HASH_NO_DISC */
+
+#ifndef RC_HASH_NO_ENCRYPTED
+
+  /* specifies a function called to obtain a 3DS CIA decryption normal key.
+   * this key would be derived from slot0x3DKeyX and the common key specified by the passed index.
+   * the normal key should be written in big endian format
+   * returns non-zero on success, or zero on failure.
+   */
+  typedef int (RC_CCONV *rc_hash_3ds_get_cia_normal_key_func)(uint8_t common_key_index, uint8_t out_normal_key[16]);
+  /* [deprecated] set callbacks in rc_hash_iterator_t */
+  RC_EXPORT void RC_CCONV rc_hash_init_3ds_get_cia_normal_key_func(rc_hash_3ds_get_cia_normal_key_func func);
+
+  /* specifies a function called to obtain 3DS NCCH decryption normal keys.
+   * the primary key will always use slot0x2CKeyX and the passed primary KeyY.
+   * the secondary key will use the KeyX slot passed
+   * the secondary KeyY will be identical to the primary keyY if the passed program id is NULL
+   * if the program id is not null, then the secondary KeyY will be obtained with "seed crypto"
+   * with "seed crypto" the 8 byte program id can be used to obtain a 16 byte "seed" within the seeddb.bin firmware file
+   * the primary KeyY then the seed will then be hashed with SHA256, and the upper 16 bytes of the digest will be the secondary KeyY used
+   * the normal keys should be written in big endian format
+   * returns non-zero on success, or zero on failure.
+   */
+  typedef int (RC_CCONV *rc_hash_3ds_get_ncch_normal_keys_func)(uint8_t primary_key_y[16], uint8_t secondary_key_x_slot, uint8_t* optional_program_id,
+                                                                uint8_t out_primary_key[16], uint8_t out_secondary_key[16]);
+  /* [deprecated] set callbacks in rc_hash_iterator_t */
+  RC_EXPORT void RC_CCONV rc_hash_init_3ds_get_ncch_normal_keys_func(rc_hash_3ds_get_ncch_normal_keys_func func);
+
+#endif /* RC_HASH_NO_ENCRYPTED */
+
+/* ===================================================== */
+
+typedef void (RC_CCONV* rc_hash_message_callback_func)(const char*, const struct rc_hash_iterator* iterator);
+
+typedef struct rc_hash_callbacks {
+  rc_hash_message_callback_func verbose_message;
+  rc_hash_message_callback_func error_message;
+
+  rc_hash_filereader_t filereader;
+#ifndef RC_HASH_NO_DISC
+  rc_hash_cdreader_t cdreader;
+#endif
+
+#ifndef RC_HASH_NO_ENCRYPTED
+  struct rc_hash_encryption_callbacks {
+    rc_hash_3ds_get_cia_normal_key_func get_3ds_cia_normal_key;
+    rc_hash_3ds_get_ncch_normal_keys_func get_3ds_ncch_normal_keys;
+  } encryption;
+#endif
+} rc_hash_callbacks_t;
+
+/* data for rc_hash_iterate
+ */
+typedef struct rc_hash_iterator {
+  const uint8_t* buffer;
+  size_t buffer_size;
+  uint8_t consoles[12];
+  int index;
+  const char* path;
+  void* userdata;
+
+  rc_hash_callbacks_t callbacks;
+} rc_hash_iterator_t;
+
+/* initializes a rc_hash_iterator
+ * - path must be provided
+ * - if buffer and buffer_size are provided, path may be a filename (i.e. for something extracted from a zip file)
+ */
+RC_EXPORT void RC_CCONV rc_hash_initialize_iterator(rc_hash_iterator_t* iterator, const char* path, const uint8_t* buffer, size_t buffer_size);
+
+/* releases resources associated to a rc_hash_iterator
+ */
+RC_EXPORT void RC_CCONV rc_hash_destroy_iterator(rc_hash_iterator_t* iterator);
+
+/* generates the next hash for the data in the rc_hash_iterator.
+ * returns non-zero if a hash was generated, or zero if no more hashes can be generated for the data.
+ */
+RC_EXPORT int RC_CCONV rc_hash_iterate(char hash[33], rc_hash_iterator_t* iterator);
+
+/* generates a hash for the data in the rc_hash_iterator.
+ * returns non-zero if a hash was generated.
+ */
+RC_EXPORT int RC_CCONV rc_hash_generate(char hash[33], uint32_t console_id, const rc_hash_iterator_t* iterator);
+
+/* ===================================================== */
+
+/* generates a hash from a block of memory.
+ * returns non-zero on success, or zero on failure.
+ */
+/* [deprecated] use rc_hash_generate instead */
+RC_EXPORT int RC_CCONV rc_hash_generate_from_buffer(char hash[33], uint32_t console_id, const uint8_t* buffer, size_t buffer_size);
+
+/* generates a hash from a file.
+ * returns non-zero on success, or zero on failure.
+ */
+/* [deprecated] use rc_hash_generate instead */
+RC_EXPORT int RC_CCONV rc_hash_generate_from_file(char hash[33], uint32_t console_id, const char* path);
+
+/* ===================================================== */
+
+RC_END_C_DECLS
+
+#endif /* RC_HASH_H */