Mercurial > molko

comparison libmlk-core/core/sys.h @ 253:c4da052c0def

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: goodbye doxygen
author David Demelier <markand@malikania.fr>
date Thu, 03 Dec 2020 09:06:52 +0100
parents 71b3b7036de7
children d987a5fc4a3e
comparison
equal deleted inserted replaced
252:95c2c4a72410 253:c4da052c0def
17 */ 17 */
18 18
19 #ifndef MOLKO_CORE_SYS_H 19 #ifndef MOLKO_CORE_SYS_H
20 #define MOLKO_CORE_SYS_H 20 #define MOLKO_CORE_SYS_H
21 21
22 /**
23 * \file sys.h
24 * \brief System routines.
25 * \ingroup basics
26 */
27
28 #include <stdarg.h> 22 #include <stdarg.h>
29 #include <stdbool.h> 23 #include <stdbool.h>
30 24
31 /**
32 * \brief Kind of special directories.
33 */
34 enum sys_dir { 25 enum sys_dir {
35 SYS_DIR_BIN, /*!< Path to binaries. */ 26 SYS_DIR_BIN,
36 SYS_DIR_DATA, /*!< Directory containing data. */ 27 SYS_DIR_DATA,
37 SYS_DIR_LOCALE, /*!< Path to NLS catalogs. */ 28 SYS_DIR_LOCALE,
38 SYS_DIR_SAVE, /*!< User directory for save databases. */ 29 SYS_DIR_SAVE,
39 }; 30 };
40 31
41 /**
42 * Initialize the system.
43 *
44 * This function is automatically called from \ref core_init and thus not
45 * necessary from user.
46 *
47 * \pre organization != NULL
48 * \pre name != NULL
49 * \param organization the name of the organization
50 * \param name the game name
51 * \return False on error.
52 */
53 bool 32 bool
54 sys_init(const char *organization, const char *name); 33 sys_init(const char *organization, const char *name);
55 34
56 /**
57 * Get a system or user directory preferred for this platform.
58 *
59 * \pre kind must be valid
60 * \param kind kind of special directory
61 * \return A non-NULL pointer to a static storage path.
62 */
63 const char * 35 const char *
64 sys_dir(enum sys_dir kind); 36 sys_dir(enum sys_dir kind);
65 37
66 /**
67 * Close the system.
68 *
69 * This function is automatically called from \ref core_finish and thus not
70 * necessary from user.
71 */
72 void 38 void
73 sys_finish(void); 39 sys_finish(void);
74 40
75 #endif /* !MOLKO_CORE_SYS_H */ 41 #endif /* !MOLKO_CORE_SYS_H */