yaze/incl/yaze.h

#ifndef YAZE_H
#define YAZE_H

#ifdef __cplusplus
extern "C" {
#endif

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

#include "zelda.h"

typedef struct yaze_editor_context {
  zelda3_rom* rom;
  const char* error_message;
} yaze_editor_context;

typedef enum yaze_status {
  YAZE_UNKNOWN = -1,
  YAZE_OK = 0,
  YAZE_ERROR = 1,
} yaze_status;

int yaze_app_main(int argc, char** argv);
void yaze_check_version(const char* version);

yaze_status yaze_init(yaze_editor_context*, char* rom_filename);
yaze_status yaze_shutdown(yaze_editor_context*);

typedef struct yaze_bitmap {
  int width;
  int height;
  uint8_t bpp;
  uint8_t* data;
} yaze_bitmap;

yaze_bitmap yaze_load_bitmap(const char* filename);

/**
 * @brief Primitive of 16-bit RGB SNES color.
 */
typedef struct snes_color {
  uint16_t red;   /**< Red component of the color. */
  uint16_t blue;  /**< Blue component of the color. */
  uint16_t green; /**< Green component of the color. */
} snes_color;

/**
 * @brief Primitive of a SNES color palette.
 */
typedef struct snes_palette {
  unsigned int id;    /**< ID of the palette. */
  unsigned int size;  /**< Size of the palette. */
  snes_color* colors; /**< Pointer to the colors in the palette. */
} snes_palette;

typedef struct snes_tile8 {
  uint32_t id;
  uint32_t palette_id;
  uint8_t data[64];
} snes_tile8;

typedef struct snes_tile_info {
  uint16_t id;
  uint8_t palette;
  bool priority;
  bool vertical_mirror;
  bool horizontal_mirror;
} snes_tile_info;

typedef struct snes_tile16 {
  snes_tile_info tiles[4];
} snes_tile16;

typedef struct snes_tile32 {
  uint16_t t0;
  uint16_t t1;
  uint16_t t2;
  uint16_t t3;
} snes_tile32;

/**
 * @brief Get a color from a palette set.
 *
 * @details This function gets a color from a palette set and returns it as a
 * snes_color object.
 *
 * @param rom The ROM to get the color from.
 * @param palette_set The palette set to get the color from.
 * @param palette The palette to get the color from.
 * @param color The color to get from the palette.
 * @return The color from the palette set.
 */
snes_color yaze_get_color_from_paletteset(const zelda3_rom* rom,
                                          int palette_set, int palette,
                                          int color);

/**
 * @brief Load the overworld from the ROM.
 *
 * @param rom The ROM to load the overworld from.
 * @return The status of the operation. If the operation is successful, the
 * overworld object will be populated with the overworld from the ROM.
 */
zelda3_overworld* yaze_load_overworld(const zelda3_rom* rom);

/**
 * @brief Load all rooms from the ROM.
 *
 * @details This function loads all rooms from the ROM and returns them as an
 * array of rooms.
 *
 * @param rom The ROM to load rooms from.
 * @return The status of the operation. If the operation is successful, the
 * rooms array will be populated with the rooms from the ROM.
 */
zelda3_dungeon_room* yaze_load_all_rooms(const zelda3_rom* rom);

/**
 * @brief Load all messages from the ROM.
 *
 * @details This function loads all messages from the ROM and returns them as an
 * array of messages.
 *
 * @param rom The ROM to load messages from.
 * @param messages Pointer to an array of messages.
 * @return The status of the operation. If the operation is successful, the
 * messages array will be populated with the messages from the ROM.
 */
yaze_status yaze_load_messages(zelda3_rom* rom, zelda3_message** messages);

/**
 * @brief Function pointer to initialize the extension.
 *
 * @param context The editor context.
 */
typedef void (*yaze_initialize_func)(yaze_editor_context* context);
typedef void (*yaze_cleanup_func)(void);

/**
 * @brief Extension interface for Yaze.
 *
 * @details Yaze extensions can be written in C or Python.
 */
typedef struct yaze_extension {
  const char* name;
  const char* version;

  /**
   * @brief Function to initialize the extension.
   *
   * @details This function is called when the extension is loaded. It can be
   * used to set up any resources or state needed by the extension.
   */
  yaze_initialize_func initialize;

  /**
   * @brief Function to clean up the extension.
   *
   * @details This function is called when the extension is unloaded. It can be
   * used to clean up any resources or state used by the extension.
   */
  yaze_cleanup_func cleanup;
} yaze_extension;

#ifdef __cplusplus
}
#endif

#endif  // YAZE_H