diff options
author | Danny Holman <dholman@gymli.org> | 2025-03-20 14:15:38 -0500 |
---|---|---|
committer | Danny Holman <dholman@gymli.org> | 2025-03-20 14:18:49 -0500 |
commit | adaecb65eaa1abf437a24c93a08b2b7c2266c5dc (patch) | |
tree | 8b70c3f85648a12c6e6b7308489033653235aa64 /include/rune | |
parent | 7281fe8fdbb64a83bc0f569ef01db33a1f26ac98 (diff) |
core: refactor core API to be in proper style
Bring the rest of the core API to be in line with the project coding
style. This commit also makes the coding style change formal by updating
the coding style document in the documentation.
Signed-off-by: Danny Holman <dholman@gymli.org>
Diffstat (limited to 'include/rune')
-rw-r--r-- | include/rune/core/mod.h | 4 | ||||
-rw-r--r-- | include/rune/core/thread.h | 8 | ||||
-rw-r--r-- | include/rune/util/list.h | 18 |
3 files changed, 15 insertions, 15 deletions
diff --git a/include/rune/core/mod.h b/include/rune/core/mod.h index f0940ce..32d1465 100644 --- a/include/rune/core/mod.h +++ b/include/rune/core/mod.h @@ -53,13 +53,13 @@ typedef void (*mod_func)(void); /** * Class-like definition for in-game mod */ -struct mod { +typedef struct mod { const char *name; ///< Name of the mod mod_func init_func; ///< Mod initialization function, called by rune_init_mods mod_func exit_func; ///< Mod exit function, called by rune_close_mods mod_func update_func; ///< Mod update function, called at every frame struct list_head list; ///< Linked list of all mod structs, used internally -}; +} mod_t; /** * \brief Load all the mods from the mod folder, mods must be either DLLs on Windows, diff --git a/include/rune/core/thread.h b/include/rune/core/thread.h index 976b7d3..a397b0c 100644 --- a/include/rune/core/thread.h +++ b/include/rune/core/thread.h @@ -28,21 +28,21 @@ /** * Platform-agnostic thread handle */ -struct thread { +typedef struct thread { int ID; ///< In-engine thread ID int detached; ///< 1 if thread has been detached, 0 otherwise void *thread_handle; ///< System-defined thread handle, usually a pthread_t struct list_head list; ///< Linked list of all threads, used internally -}; +} thread_t; /** * Platform-agnostic mutex handle */ -struct mutex { +typedef struct mutex { int ID; ///< In-engine mutex ID void *mutex_handle; ///< System-defined mutex handle, usually a pthread_mutex_t struct list_head list; ///< Linked list of all mutexes, used internally -}; +} mutex_t; /** * \brief Initializes the engine's thread API, must be called before using any diff --git a/include/rune/util/list.h b/include/rune/util/list.h index 556e085..c011cb3 100644 --- a/include/rune/util/list.h +++ b/include/rune/util/list.h @@ -27,18 +27,18 @@ /** * Linux-kernel combatible linked list implementation */ -struct list_head { +typedef struct list_head { struct list_head *next; ///< Next list element struct list_head *prev; ///< Previous list element -}; +} list_head_t; /** * \brief Add element to the end of a list - * \param[in] new Pointer to struct list_head, part of another struct + * \param[in] new Pointer to list_head_t, part of another struct * \param[in] head Start point of the list to be added to */ -static inline void list_add(struct list_head *new, struct list_head *head) { - struct list_head *temp = head; +static inline void list_add(list_head_t *new, list_head_t *head) { + list_head_t *temp = head; while (temp->next != NULL) temp = temp->next; @@ -49,11 +49,11 @@ static inline void list_add(struct list_head *new, struct list_head *head) { /** * \brief Remove element from a list - * \param[in] item Pointer to struct list_head, part of another struct + * \param[in] item Pointer to list_head_t, part of another struct */ -static inline void list_del(struct list_head *item) { - struct list_head *next = item->next; - struct list_head *prev = item->prev; +static inline void list_del(list_head_t *item) { + list_head_t *next = item->next; + list_head_t *prev = item->prev; if (next != NULL) next->prev = prev; if (prev != NULL) |