Andrew Kesterson
c5a7b6053d
The version was written down twice and agreed with itself by luck. AKGL_VERSION was hand-maintained in include/akgl/game.h, and nothing connected it to the build, which had no version at all: - project() declared no VERSION, so the @PROJECT_VERSION@ substitution in akgl.pc.in expanded to nothing and every installed akgl.pc shipped an empty Version field. pkg-config --modversion returned "" and --atleast-version could not work at all. - libakgl.so had no VERSION or SOVERSION, so there was no soname and no symlink chain. A stale libakgl could be paired with new headers silently, which is the failure libakerror added its own soname to prevent. - MY_LIBRARY_VERSION at CMakeLists.txt:288 was never set anywhere. It built main_lib_dest as "lib/akgl-", and main_lib_dest was then never read. Dead line, removed. project(akgl VERSION 0.1.0) is now the only place the number appears. It drives the generated include/akgl/version.h, the shared library VERSION and SOVERSION, and the Version field in akgl.pc. Held at 0.1.0 to match the constant it replaces, so akgl_game_load_versioncmp still compares savegames against the same value. include/akgl/version.h is generated by configure_file from version.h.in and publishes AKGL_VERSION, AKGL_VERSION_MAJOR/MINOR/PATCH and AKGL_VERSION_AT_LEAST(major, minor, patch). That macro is the point: libakstdlib could not write that test against libakerror, which publishes no version macro, and had to feature-test on AKERR_FIRST_CONSUMER_STATUS instead. game.h now includes the generated header rather than defining the version itself, so consumers see AKGL_VERSION exactly where they saw it before. While the major version is 0 the soname carries major.minor, giving libakgl.so.0.1. A plain SOVERSION 0 would assert that 0.1.0 and 0.2.0 are ABI-interchangeable, and they are not -- the preceding commit alone added akgl_error_init. At 1.0.0 the soname becomes the major alone, matching libakerror. akgl_version() in src/version.c reports the version of the libakgl that is actually linked, where AKGL_VERSION reports what the caller compiled against. Comparing the two is the only way to catch a stale shared library on the loader path; the macro alone cannot see it. It returns a string rather than an akerr_ErrorContext * because it cannot fail, for the same reason akerr_name_for_status does. Add tests/version.c: the string and the numeric components must describe one version, the linked library must agree with the headers, and AKGL_VERSION_AT_LEAST must order correctly at the major, minor and patch boundaries. Verified out of band that bumping project() to 1.2.3 moves version.h, akgl.pc and the soname together, and that an install produces the libakgl.so -> .so.0.1 -> .so.0.1.0 chain with SONAME libakgl.so.0.1. Also ignore include/akgl/version.h. include/ precedes the build tree on the include path, so a stray copy there would shadow the generated one and pin every consumer to whatever version it was generated at. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
146 lines
4.7 KiB
C
146 lines
4.7 KiB
C
/**
|
|
* @file game.h
|
|
* @brief Declares the public game API.
|
|
*/
|
|
|
|
#ifndef _AKGL_GAME_H_
|
|
#define _AKGL_GAME_H_
|
|
|
|
#include <stdint.h>
|
|
#include <SDL3_mixer/SDL_mixer.h>
|
|
#include "types.h"
|
|
#include "tilemap.h"
|
|
#include "renderer.h"
|
|
#include "physics.h"
|
|
// AKGL_VERSION used to be defined here by hand, which is how akgl.pc came to
|
|
// ship an empty Version field: nothing tied the two together.
|
|
#include <akgl/version.h>
|
|
|
|
#define AKGL_GAME_AUDIO_TRACK_BGM 1
|
|
#define AKGL_GAME_AUDIO_MAX_TRACKS 64
|
|
|
|
#define AKGL_TIME_ONESEC_NS 1000000000
|
|
#define AKGL_TIME_ONESEC_MS 1000000
|
|
|
|
/* ==================== GAME STATE VARIABLES =================== */
|
|
|
|
/** @brief Describes a renderable frame. */
|
|
typedef struct {
|
|
float32_t w;
|
|
float32_t h;
|
|
SDL_Texture *texture;
|
|
} akgl_Frame;
|
|
|
|
/** @brief Stores application-defined game-state flags. */
|
|
typedef struct {
|
|
int32_t flags;
|
|
} akgl_GameState;
|
|
|
|
/** @brief Stores game metadata, timing, synchronization, and FPS accounting. */
|
|
typedef struct {
|
|
char libversion[32];
|
|
char version[32];
|
|
char name[256];
|
|
char uri[256];
|
|
akgl_GameState state;
|
|
SDL_Mutex *statelock;
|
|
int16_t fps;
|
|
SDL_Time gameStartTime;
|
|
SDL_Time lastIterTime;
|
|
SDL_Time lastFPSTime;
|
|
int16_t framesSinceUpdate;
|
|
void (*lowfpsfunc)(void);
|
|
} akgl_Game;
|
|
|
|
/** @brief SDL window used by the active renderer. */
|
|
extern SDL_Window *window;
|
|
/** @brief Loaded background-music resource. */
|
|
extern MIX_Audio *bgm;
|
|
/** @brief Mixer used for game audio playback. */
|
|
extern MIX_Mixer *akgl_mixer;
|
|
/** @brief Process-wide audio-track table. */
|
|
extern MIX_Track *akgl_tracks[AKGL_GAME_AUDIO_MAX_TRACKS];
|
|
/** @brief Storage for the default camera. */
|
|
extern SDL_FRect _akgl_camera;
|
|
/** @brief Process-wide game metadata and timing state. */
|
|
extern akgl_Game game;
|
|
/** @brief Storage for the default renderer. */
|
|
extern akgl_RenderBackend _akgl_renderer;
|
|
/** @brief Storage for the default physics backend. */
|
|
extern akgl_PhysicsBackend _akgl_physics;
|
|
/** @brief Storage for the default tilemap. */
|
|
extern akgl_Tilemap _akgl_gamemap;
|
|
|
|
/** @brief Currently active tilemap. */
|
|
extern akgl_Tilemap *gamemap;
|
|
/** @brief Currently active renderer. */
|
|
extern akgl_RenderBackend *renderer;
|
|
/** @brief Currently active physics backend. */
|
|
extern akgl_PhysicsBackend *physics;
|
|
/** @brief Currently active camera. */
|
|
extern SDL_FRect *camera;
|
|
|
|
#define AKGL_BITMASK_HAS(x, y) (x & y) == y
|
|
#define AKGL_BITMASK_HASNOT(x, y) (x & y) != y
|
|
#define AKGL_BITMASK_ADD(x, y) x |= y
|
|
#define AKGL_BITMASK_DEL(x, y) x &= ~(y)
|
|
#define AKGL_BITMASK_CLEAR(x) x = 0;
|
|
|
|
/**
|
|
* @brief Game init.
|
|
* @return `NULL` on success, otherwise an error context owned by the caller.
|
|
* @throws AKERR_NULLPOINTER When the corresponding validation or operation fails.
|
|
* @throws AKGL_ERR_SDL When the corresponding validation or operation fails.
|
|
*/
|
|
akerr_ErrorContext AKERR_NOIGNORE *akgl_game_init();
|
|
/**
|
|
* @brief Game init screen.
|
|
* @return `NULL` on success, otherwise an error context owned by the caller.
|
|
* @throws AKERR_* Propagates an error reported by a delegated operation.
|
|
*/
|
|
akerr_ErrorContext AKERR_NOIGNORE *akgl_game_init_screen();
|
|
/**
|
|
* @brief Game updatefps.
|
|
*/
|
|
void akgl_game_updateFPS();
|
|
/**
|
|
* @brief Game save.
|
|
* @param fpath Path to the input or output file.
|
|
* @return `NULL` on success, otherwise an error context owned by the caller.
|
|
* @throws AKERR_NULLPOINTER When the corresponding validation or operation fails.
|
|
*/
|
|
akerr_ErrorContext AKERR_NOIGNORE *akgl_game_save(char *fpath);
|
|
/**
|
|
* @brief Game load.
|
|
* @param fpath Path to the input or output file.
|
|
* @return `NULL` on success, otherwise an error context owned by the caller.
|
|
* @throws AKERR_API When the corresponding validation or operation fails.
|
|
* @throws AKERR_NULLPOINTER When the corresponding validation or operation fails.
|
|
*/
|
|
akerr_ErrorContext AKERR_NOIGNORE *akgl_game_load(char *fpath);
|
|
/**
|
|
* @brief Game lowfps.
|
|
*/
|
|
void akgl_game_lowfps(void);
|
|
/**
|
|
* @brief Game state lock.
|
|
* @return `NULL` on success, otherwise an error context owned by the caller.
|
|
* @throws AKGL_ERR_SDL When the corresponding validation or operation fails.
|
|
*/
|
|
akerr_ErrorContext AKERR_NOIGNORE *akgl_game_state_lock(void);
|
|
/**
|
|
* @brief Game state unlock.
|
|
* @return `NULL` on success, otherwise an error context owned by the caller.
|
|
* @throws AKERR_* Propagates an error reported by a delegated operation.
|
|
*/
|
|
akerr_ErrorContext AKERR_NOIGNORE *akgl_game_state_unlock(void);
|
|
/**
|
|
* @brief Game update.
|
|
* @param opflags Optional iterator operation flags; `NULL` selects defaults.
|
|
* @return `NULL` on success, otherwise an error context owned by the caller.
|
|
* @throws AKERR_* Propagates an error reported by a delegated operation.
|
|
*/
|
|
akerr_ErrorContext AKERR_NOIGNORE *akgl_game_update(akgl_Iterator *opflags);
|
|
|
|
#endif //_AKGL_GAME_H_
|