#ifndef INK_API_H
#define INK_API_H

/**
 * @defgroup ink_api API
 *
 * This module documents the exported functions that form the public API
 * of libink.
 *
 * @{
 */

#ifdef __cplusplus
extern "C" {
#endif

#if defined(_WIN32) || defined(__CYGWIN__)
#ifdef BUILDING_INKLIB
#define INK_API __declspec(dllexport)
#else
#define INK_API __declspec(dllimport)
#endif
#else
#if defined(__GNUC__) || defined(__clang__)
#define INK_API __attribute__((visibility("default")))
#else
#define INK_API
#endif
#endif

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

/**
 * @struct ink_story
 *
 * @brief Opaque type representing a story context.
 *
 * This forward declaration hides the internal structure of an `ink_story`.
 * Clients of the API should manipulate `ink_story` objects only through the
 * provided functions.
 */
typedef struct ink_story ink_story;

struct ink_story_options {
    const uint8_t *filename;
    size_t filename_length;
    const uint8_t *source_bytes;
    size_t source_length;
    int flags;
};

enum ink_flags {
    INK_F_RESERVED_1  = (1 << 0),
    INK_F_RESERVED_2  = (1 << 1),
    INK_F_RESERVED_3  = (1 << 2),
    INK_F_RESERVED_4  = (1 << 3),
    INK_F_USE_COLOR   = (1 << 4),
    INK_F_DUMP_AST    = (1 << 5),
    INK_F_DUMP_IR     = (1 << 6),
    INK_F_DUMP_CODE   = (1 << 7),
    INK_F_RESERVED_9  = (1 << 8),
    INK_F_RESERVED_10 = (1 << 9),
    INK_F_RESERVED_11 = (1 << 10),
    INK_F_RESERVED_12 = (1 << 11),
    INK_F_RESERVED_13 = (1 << 12),
    INK_F_RESERVED_14 = (1 << 13),
    INK_F_RESERVED_15 = (1 << 14),
    INK_F_RESERVED_16 = (1 << 15),
};

/**
 * Load an Ink story with extended options.
 *
 * @returns an opaque pointer on success or null on failure.
 */
INK_API struct ink_story *ink_load_story_options(const struct ink_load_options *options);

/**
 * Close a story context.
 */
INK_API void ink_close(struct ink_story *story);


/**
 * Determine if the story can continue.
 *
 * @returns a boolean value, indicating if the story can continue.
 */
INK_API bool ink_story_can_continue(struct ink_story *story);

/**
 * Advance the story and output content, if available.
 *
 * @returns a non-zero value on error.
 */
INK_API int ink_story_continue(struct ink_story *story, uint8_t **line,
                               size_t *linelen);

INK_API int ink_story_choice_next(struct ink_story *story, uint8_t **line,
                                  size_t *linelen);

/**
 * Select a choice by its index.
 *
 * @returns a non-zero value on error.
 */
INK_API int ink_story_choose(struct ink_story *story, size_t index);

#ifdef __cplusplus
}
#endif

#endif