e_engine.h

#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>

/**
 * A return type for C.
 *
 * Contains a `return_code` which indicates any errors
 * and an `output` indicating the output of the method
 */
typedef struct C_Return {
  uint32_t return_code;
  char *output;
} C_Return;

/**
 * Encodes a string to jaartal
 *
 * ## Parameters
 * - input: the string to be encoded
 * - jaar: the jaar it has to be encoded with
 *
 * ## Returns
 * - A C_Return struct containing:
 *     - c_int: the return code (0 if no errors occur,
 * other variables if there was an error)
 *     - c_char: the encoded string
 *
 * ## Errors
 * Error codes:<br/>
 * 1: Couldn't convert CString to Rust str
 *
 * ## Freeing memory
 * For Swift, it is important to call `jaar_free` after this function is called to free memory.
 * Disregarding to do this will cause a memory leak.
 */
struct C_Return encode_jaar(const char *input, const char *jaar);

/**
 * Reverses each word in a string.
 *
 * ## Parameters
 * - input: the string to be encoded
 *
 * ## Returns
 * - A string where all the words of the `input`have been reversed
 *
 * ## Freeing memory
 * `omkeren_free`
 */
char *encode_omkeren(const char *input);

/**
 * Has to be called after `encode_jaar` to the free memory
 *
 * Disregarding to do this will cause a **memory leak**.
 *
 * Not applicable for Java.
 */
void jaar_free(struct C_Return cret);

/**
 * Has to be called after `encode_omkeren` to the free memory.<br/>
 * Disregarding to do this will cause a **memory leak**.
 */
void omkeren_free(char *s);