libGimbal 0.1.0
C17-Based Extended Standard Library and Cross-Language Runtime Framework
Loading...
Searching...
No Matches
gimbal_core.h
Go to the documentation of this file.
1/*! \file
2 * \brief Core module-wide include
3 * \ingroup core
4 *
5 * \author Falco Girgis
6 */
7
8#ifndef GIMBAL_CORE_H
9#define GIMBAL_CORE_H
10
11#include "core/gimbal_ctx.h"
12#include "core/gimbal_decls.h"
13#include "core/gimbal_result.h"
14#include "core/gimbal_stack_frame.h"
15#include "core/gimbal_thd.h"
16#include "core/gimbal_typedefs.h"
17#include "core/gimbal_app.h"
18#include "core/gimbal_module.h"
19#include "core/gimbal_logger.h"
20#include "core/gimbal_exception.h"
21#include "core/gimbal_error.h"
22
23/*! \defgroup core Core
24 \brief Core framework module
25
26 The core module provides:
27 - platform-specific macros and utilities
28 - error and exception handling
29 - debug and verification utilities
30 - structured logging with filtering
31 - object-oriented threading and concurrency model
32
33 Typically this is pulled in by just using `#include <gimbal/core.h>`.
34
35 The following table provides an index of some of the core APIs:
36
37 |Type | Purpose |
38 |------------|--------------------------|
39 |GblException|Unified error handling |
40 |GblLogger |Generic logging mechanism |
41 |GblThread |Low-level concurrency |
42 |GblModule |Module system |
43 |GblApp |Main application object |
44*/
45
46#endif // GIMBAL_CORE_H