api.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2025-2026 FLAK-ZOSO <mattia.marchese.2006@gmail.com>
 * SPDX-License-Identifier: GPL-3.0-only
 */
 
#pragma once
 
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct sista_Field;
typedef struct sista_Field* FieldHandler_t;
 
FieldHandler_t sista_createField(size_t, size_t);
int sista_printField(FieldHandler_t, char);
int sista_destroyField(FieldHandler_t);
 
struct sista_SwappableField;
typedef struct sista_SwappableField* SwappableFieldHandler_t;
 
SwappableFieldHandler_t sista_createSwappableField(size_t, size_t);
int sista_printSwappableField(SwappableFieldHandler_t, char);
int sista_destroySwappableField(SwappableFieldHandler_t);
 
int sista_resetAnsi();
 
int sista_printHyperlink(const char* text, const char* url);
 
enum sista_ForegroundColor {
    F_BLACK = 30,
    F_RED = 31,
    F_GREEN = 32,
    F_YELLOW = 33,
    F_BLUE = 34,
    F_MAGENTA = 35,
    F_CYAN = 36,
    F_WHITE = 37
};
enum sista_BackgroundColor {
    B_BLACK = 40,
    B_RED = 41,
    B_GREEN = 42,
    B_YELLOW = 43,
    B_BLUE = 44,
    B_MAGENTA = 45,
    B_CYAN = 46,
    B_WHITE = 47
};
enum sista_Attribute {
    A_RESET = 0,
    A_BRIGHT = 1,
    A_FAINT = 2,
    A_ITALIC = 3,
    A_UNDERLINE = 4,
    A_BLINK = 5,
    A_BLINK_FAST = 6,
    A_REVERSE = 7,
    A_HIDDEN = 8,
    A_STRIKETHROUGH = 9
};
struct sista_RGBColor {
    unsigned char red; 
    unsigned char green; 
    unsigned char blue; 
};
 
int sista_setForegroundColor(enum sista_ForegroundColor);
int sista_setBackgroundColor(enum sista_BackgroundColor);
int sista_setAttribute(enum sista_Attribute);
int sista_resetAttribute(enum sista_Attribute);
int sista_setForegroundColorRGB(const struct sista_RGBColor*);
int sista_setBackgroundColorRGB(const struct sista_RGBColor*);
 
struct sista_ANSISettings;
typedef struct sista_ANSISettings* ANSISettingsHandler_t;
 
ANSISettingsHandler_t sista_createANSISettings(enum sista_ForegroundColor,
                                               enum sista_BackgroundColor,
                                               enum sista_Attribute);
ANSISettingsHandler_t sista_createANSISettingsRGB(struct sista_RGBColor,
                                                  struct sista_RGBColor,
                                                  enum sista_Attribute);
int sista_applyANSISettings(ANSISettingsHandler_t);
int sista_destroyANSISettings(ANSISettingsHandler_t);
 
struct sista_Border;
typedef struct sista_Border* BorderHandler_t;
 
BorderHandler_t sista_createBorder(char, ANSISettingsHandler_t);
int sista_destroyBorder(BorderHandler_t);
 
int sista_printFieldWithBorder(FieldHandler_t, BorderHandler_t);
int sista_printSwappableFieldWithBorder(SwappableFieldHandler_t, BorderHandler_t);
 
struct sista_Coordinates {
    unsigned short y; 
    unsigned short x; 
};
 
struct sista_Pawn;
typedef struct sista_Pawn* PawnHandler_t;
 
enum sista_ErrorCode {
    SISTA_OK = 0,
    SISTA_ERR_NULL_FIELD = 1001,
    SISTA_ERR_NULL_SETTINGS = 1002,
    SISTA_ERR_OUT_OF_BOUNDS = 1003,
    SISTA_ERR_OCCUPIED = 1004,
    SISTA_ERR_BAD_ALLOC = 1005,
    SISTA_ERR_NULL_PAWN = 1006,
    SISTA_ERR_NULL_BORDER = 1007,
    SISTA_ERR_NULL_CURSOR = 1008,
    SISTA_ERR_NULL_COLOR = 1009,
    SISTA_ERR_NULL_STRING = 1010,
    SISTA_ERR_UNKNOWN = 1099
};
 
PawnHandler_t sista_createPawnInSwappableField(SwappableFieldHandler_t,
                                               char, ANSISettingsHandler_t,
                                               struct sista_Coordinates);
PawnHandler_t sista_createPawnInField(FieldHandler_t, char,
                                      ANSISettingsHandler_t,
                                      struct sista_Coordinates);
 
int sista_getLastErrorCode();
 
const char* sista_getLastErrorMessage();
 
int sista_movePawn(FieldHandler_t, PawnHandler_t, struct sista_Coordinates);
 
int sista_addPawnToSwap(SwappableFieldHandler_t, PawnHandler_t, struct sista_Coordinates);
int sista_applySwaps(SwappableFieldHandler_t);
 
int sista_clearScreen(int spaces);
 
enum sista_MoveCursor {
    UP = 'A',
    DOWN = 'B',
    RIGHT = 'C',
    LEFT = 'D',
    BEGINNING_OF_NEXT_LINE = 'E',
    BEGINNING_OF_PREVIOUS_LINE = 'F',
    HORIZONTAL_ABSOLUTE = 'G' 
};
 
struct sista_Cursor;
typedef struct sista_Cursor* CursorHandler_t;
 
CursorHandler_t sista_createCursor();
int sista_moveCursor(CursorHandler_t, enum sista_MoveCursor, unsigned short);
int sista_cursorGoTo(CursorHandler_t, unsigned short, unsigned short);
int sista_cursorGoToCoordinates(CursorHandler_t, struct sista_Coordinates);
int sista_destroyCursor(CursorHandler_t);
 
const char* sista_getVersion();
int sista_getVersionMajor();
int sista_getVersionMinor();
int sista_getVersionPatch();
 
#ifdef __cplusplus
}
#endif