Mercurial > molko

annotate libmlk-core/mlk/core/sys.h @ 540:876eee0eb0ad

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: doxygenize sys
author David Demelier <markand@malikania.fr>
date Sun, 05 Mar 2023 12:50:11 +0100
parents 6e8f6640e05b
children 4349b591c3ac
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * sys.h -- system routines
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
23
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
19 #ifndef MLK_CORE_SYS_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
20 #define MLK_CORE_SYS_H
23
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
540
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
22 /**
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
23 * \file mlk/core/sys.h
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
24 * \brief System routines
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
25 */
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
26
32
91bc2329ab0c core: implement data directory access, closes #2454 @1h
David Demelier <markand@malikania.fr>
parents: 31
diff changeset
27 #include <stdarg.h>
23
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
540
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
29 /**
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
30 * \enum mlk_sys_dir
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
31 * \brief Special directory constants
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
32 */
471
3761e33d429e core: sys -> mlk_sys
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
33 enum mlk_sys_dir {
540
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
34 /**
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
35 * Path to the preferred save directory.
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
36 */
471
3761e33d429e core: sys -> mlk_sys
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
37 MLK_SYS_DIR_SAVE
241
76afe639fd72 misc: add support for NLS, closes #22510 @4h
David Demelier <markand@malikania.fr>
parents: 226
diff changeset
38 };
76afe639fd72 misc: add support for NLS, closes #22510 @4h
David Demelier <markand@malikania.fr>
parents: 226
diff changeset
39
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 471
diff changeset
40 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 471
diff changeset
41 extern "C" {
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 471
diff changeset
42 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 255
diff changeset
43
540
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
44 /**
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
45 * Initialize system, takes same arguments as ::mlk_core_init.
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
46 *
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
47 * \note This function is already called by ::mlk_core_init and usually not
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
48 * required by the user.
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
49 */
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
50 int
540
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
51 mlk_sys_init(const char *organization, const char *name);
32
91bc2329ab0c core: implement data directory access, closes #2454 @1h
David Demelier <markand@malikania.fr>
parents: 31
diff changeset
52
540
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
53 /**
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
54 * Obtain a path for the given special directory.
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
55 *
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
56 * \param directory directory type
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
57 * \return a path to a thread-local static array
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
58 */
32
91bc2329ab0c core: implement data directory access, closes #2454 @1h
David Demelier <markand@malikania.fr>
parents: 31
diff changeset
59 const char *
540
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
60 mlk_sys_dir(enum mlk_sys_dir directory);
84
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
61
540
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
62 /**
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
63 * Try to create a directory recursively specified by the path.
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
64 *
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
65 * \pre path != NULL
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
66 * \param path the path to the directory
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
67 * \return 0 on success or an error code on failure
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
68 */
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
69 int
540
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
70 mlk_sys_mkdir(const char *path);
255
d987a5fc4a3e core: add sys_mkdir function
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
71
540
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
72 /**
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
73 * Cleanup system resources.
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
74 *
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
75 * \note This function is already called by ::mlk_core_finish and usually not
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
76 * required by the user.
876eee0eb0ad core: doxygenize sys
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
77 */
23
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 void
471
3761e33d429e core: sys -> mlk_sys
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
79 mlk_sys_finish(void);
23
bc9637a2601b core: add basic system routines
David Demelier <markand@malikania.fr>
parents:
diff changeset
80
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 471
diff changeset
81 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 471
diff changeset
82 }
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 471
diff changeset
83 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 255
diff changeset
84
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
85 #endif /* !MLK_CORE_SYS_H */