Mercurial > molko

annotate libmlk-rpg/mlk/rpg/save.h @ 494:35cc5d51bcb2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ui: notify -> mlk_notify
author David Demelier <markand@malikania.fr>
date Tue, 28 Feb 2023 13:32:01 +0100
parents 5729efd23286
children 6e8f6640e05b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * save.h -- save functions
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 434
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
84
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 330
diff changeset
19 #ifndef MLK_RPG_SAVE_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 330
diff changeset
20 #define MLK_RPG_SAVE_H
84
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
172
6250883b81f0 core: improve save module, closes #2507
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
22 #include <time.h>
6250883b81f0 core: improve save module, closes #2507
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
23
431
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
24 #include <mlk/core/core.h>
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 281
diff changeset
25
172
6250883b81f0 core: improve save module, closes #2507
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
26 struct save {
253
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
27 time_t created;
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
28 time_t updated;
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
29 void *handle;
172
6250883b81f0 core: improve save module, closes #2507
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
30 };
6250883b81f0 core: improve save module, closes #2507
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
31
6250883b81f0 core: improve save module, closes #2507
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
32 enum save_mode {
253
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
33 SAVE_MODE_READ,
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
34 SAVE_MODE_WRITE
172
6250883b81f0 core: improve save module, closes #2507
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
35 };
6250883b81f0 core: improve save module, closes #2507
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
36
281
87b8c7510717 rpg: implement load/save for characters
David Demelier <markand@malikania.fr>
parents: 280
diff changeset
37 struct save_stmt {
87b8c7510717 rpg: implement load/save for characters
David Demelier <markand@malikania.fr>
parents: 280
diff changeset
38 struct save *parent;
87b8c7510717 rpg: implement load/save for characters
David Demelier <markand@malikania.fr>
parents: 280
diff changeset
39 void *handle;
87b8c7510717 rpg: implement load/save for characters
David Demelier <markand@malikania.fr>
parents: 280
diff changeset
40 };
87b8c7510717 rpg: implement load/save for characters
David Demelier <markand@malikania.fr>
parents: 280
diff changeset
41
328
60a4f904da21 rpg: separate property from save
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
42 enum save_stmt_errno {
60a4f904da21 rpg: separate property from save
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
43 SAVE_STMT_DONE,
60a4f904da21 rpg: separate property from save
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
44 SAVE_STMT_ROW,
60a4f904da21 rpg: separate property from save
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
45 SAVE_STMT_ERROR
60a4f904da21 rpg: separate property from save
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
46 };
60a4f904da21 rpg: separate property from save
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
47
462
5729efd23286 core: core -> mlk_core
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
48 MLK_CORE_BEGIN_DECLS
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 281
diff changeset
49
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
50 int
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
51 save_open(struct save *, unsigned int, enum save_mode);
84
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
53 int
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
54 save_open_path(struct save *, const char *, enum save_mode);
84
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
56 int
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
57 save_ok(const struct save *);
280
11c824a82e63 core: fix save_open functions
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
58
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
59 int
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
60 save_exec(struct save *, const char *, const char *, ...);
281
87b8c7510717 rpg: implement load/save for characters
David Demelier <markand@malikania.fr>
parents: 280
diff changeset
61
84
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 void
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
63 save_finish(struct save *);
84
a6c2067709ce core: implement basic save routines, closes #2476 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
281
87b8c7510717 rpg: implement load/save for characters
David Demelier <markand@malikania.fr>
parents: 280
diff changeset
65 /* Prepared statements. */
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
66 int
329
ea4a3af71c18 rpg: change save_stmt_next API
David Demelier <markand@malikania.fr>
parents: 328
diff changeset
67 save_stmt_init(struct save_stmt *, struct save *, const char *, const char *, ...);
281
87b8c7510717 rpg: implement load/save for characters
David Demelier <markand@malikania.fr>
parents: 280
diff changeset
68
328
60a4f904da21 rpg: separate property from save
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
69 enum save_stmt_errno
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
70 save_stmt_next(struct save_stmt *, const char *, ...);
281
87b8c7510717 rpg: implement load/save for characters
David Demelier <markand@malikania.fr>
parents: 280
diff changeset
71
87b8c7510717 rpg: implement load/save for characters
David Demelier <markand@malikania.fr>
parents: 280
diff changeset
72 void
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
73 save_stmt_finish(struct save_stmt *);
281
87b8c7510717 rpg: implement load/save for characters
David Demelier <markand@malikania.fr>
parents: 280
diff changeset
74
330
e0657709fbe3 rpg: add support for basic quests
David Demelier <markand@malikania.fr>
parents: 329
diff changeset
75 /* Explicit transactions. */
e0657709fbe3 rpg: add support for basic quests
David Demelier <markand@malikania.fr>
parents: 329
diff changeset
76 int
e0657709fbe3 rpg: add support for basic quests
David Demelier <markand@malikania.fr>
parents: 329
diff changeset
77 save_tx_begin(struct save *);
e0657709fbe3 rpg: add support for basic quests
David Demelier <markand@malikania.fr>
parents: 329
diff changeset
78
e0657709fbe3 rpg: add support for basic quests
David Demelier <markand@malikania.fr>
parents: 329
diff changeset
79 void
e0657709fbe3 rpg: add support for basic quests
David Demelier <markand@malikania.fr>
parents: 329
diff changeset
80 save_tx_rollback(struct save *);
e0657709fbe3 rpg: add support for basic quests
David Demelier <markand@malikania.fr>
parents: 329
diff changeset
81
e0657709fbe3 rpg: add support for basic quests
David Demelier <markand@malikania.fr>
parents: 329
diff changeset
82 void
e0657709fbe3 rpg: add support for basic quests
David Demelier <markand@malikania.fr>
parents: 329
diff changeset
83 save_tx_commit(struct save *);
e0657709fbe3 rpg: add support for basic quests
David Demelier <markand@malikania.fr>
parents: 329
diff changeset
84
462
5729efd23286 core: core -> mlk_core
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
85 MLK_CORE_END_DECLS
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 281
diff changeset
86
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 330
diff changeset
87 #endif /* !MLK_RPG_SAVE_H */