Mercurial > hg > dmlib
annotate dmres.h @ 359:59045853853d
Make resource management re-entrant.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Tue, 16 Oct 2012 21:25:46 +0300 |
| parents | 4a672d96978f |
| children | 3d9c044ec08d |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 * DMLib | |
| 3 * -- Resource management | |
| 4 * Programmed and designed by Matti 'ccr' Hamalainen | |
| 5 * (C) Copyright 2011-2012 Tecnic Software productions (TNSP) | |
| 6 */ | |
| 7 #ifndef DMRES_H | |
| 8 #define DMRES_H | |
| 9 | |
| 10 #include "dmlib.h" | |
| 11 | |
|
124
d5cfd29c87c4
Rename some conditional compilation directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
114
diff
changeset
|
12 #ifdef DM_USE_PACKFS |
| 0 | 13 #include <zlib.h> |
| 14 #include "dmpack.h" | |
| 15 #endif | |
| 16 | |
| 17 #ifdef __cplusplus | |
| 18 extern "C" { | |
| 19 #endif | |
| 20 | |
| 21 | |
| 22 /* Constants | |
| 23 */ | |
| 24 enum | |
| 25 { | |
| 26 DMPRUNE_ATIME = 0x0001, | |
| 27 DMPRUNE_MTIME = 0x0002, | |
| 28 }; | |
| 29 | |
| 30 enum | |
| 31 { | |
| 32 DRF_USE_PACK = 0x0001, | |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
33 DRF_PRELOAD_ALL = 0x0002, |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
34 DRF_PRELOAD_RES = 0x0004, |
| 0 | 35 }; |
| 36 | |
| 37 enum | |
| 38 { | |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
39 DMF_PRELOAD_RAW = 0x0001, // Preload raw data |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
40 DMF_PRELOAD_RES = 0x0002, // Perform resource preloading (not |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
41 DMF_PERSIST = 0x0004, // Persist loaded resource (only freed at shutdown/explicit prune) |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
42 DMF_STREAM = 0x0008, // This resource is streamed (UNSUPPORTED FOR NOW) |
|
4
e0fc7863d024
Mask out bits from resFlags that should not be there after initialization.
Matti Hamalainen <ccr@tnsp.org>
parents:
0
diff
changeset
|
43 DMF_MASK = 0x0fff, |
| 0 | 44 |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
45 DMF_LOADED_RAW = 0x1000, // Raw data has been loaded |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
46 DMF_LOADED_RES = 0x2000, // Resource has been loaded |
| 0 | 47 }; |
| 48 | |
| 49 | |
| 50 /* Typedefs and structures | |
| 51 */ | |
|
359
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
52 struct DMResourceLib; |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
53 struct DMResourceDataOps; |
| 0 | 54 struct DMResourceOps; |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
55 struct DMResource; |
| 0 | 56 |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
57 typedef struct DMResource |
| 0 | 58 { |
| 59 // Timestamps (in seconds from time()) | |
| 60 int mtime, // When resource was loaded | |
| 61 atime; // Last accessed (dmres_ref()/unref) | |
| 62 int refcount; // Reference count | |
| 63 | |
| 64 int flags; // Resource flags (DMF_*) | |
| 65 char *filename; | |
| 66 | |
| 67 size_t dataSize; // Size of data | |
| 68 off_t dataOffset; // Current offset in data | |
| 69 Uint8 *data; // Pointer to data | |
| 70 | |
| 71 int error; // Error code | |
| 72 | |
| 73 struct DMResourceOps *fops; // Pointer to file handling functions struct | |
|
359
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
74 struct DMResourceLib *lib; |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
75 struct DMResource *next, *prev; |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
76 |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
77 void *rdata; |
|
103
d97accc86365
Add variable rdataSize to DMResource.
Matti Hamalainen <ccr@tnsp.org>
parents:
74
diff
changeset
|
78 size_t rdataSize; |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
79 struct DMResourceDataOps *rops; |
| 0 | 80 |
| 81 FILE * fh; | |
| 82 } DMResource; | |
| 83 | |
| 84 | |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
85 typedef struct DMResourceDataOps |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
86 { |
|
105
d5d27f262227
Beging merging of dmsimple2-fork into the main "engine".
Matti Hamalainen <ccr@tnsp.org>
parents:
103
diff
changeset
|
87 BOOL (*probe)(DMResource *res, const char *fext); |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
88 int (*load)(DMResource *res); |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
89 void (*free)(DMResource *res); |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
90 } DMResourceDataOps; |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
91 |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
92 |
|
359
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
93 typedef struct DMResourceLib |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
94 { |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
95 int flags; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
96 char *resPath; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
97 |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
98 DMResource *resources, *preload; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
99 DMMutex *mutex; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
100 |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
101 #ifdef DM_USE_PACKFS |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
102 char *packFilename; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
103 DMPackFile *packFile; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
104 #endif |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
105 } DMResourceLib; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
106 |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
107 |
| 0 | 108 typedef struct DMResourceOps |
| 109 { | |
| 110 int (*ferror)(DMResource *); | |
| 111 int (*fseek)(DMResource *, const off_t, const int); | |
| 112 off_t (*fsize)(DMResource *); | |
| 113 off_t (*ftell)(DMResource *); | |
| 114 BOOL (*feof)(DMResource *); | |
| 115 int (*fgetc)(DMResource *); | |
|
59
c560703e85ed
Add resource writing functions (only work for stdio backend)
Matti Hamalainen <ccr@tnsp.org>
parents:
26
diff
changeset
|
116 int (*fputc)(int, DMResource *); |
| 0 | 117 size_t (*fread)(void *, const size_t, const size_t, DMResource *); |
|
59
c560703e85ed
Add resource writing functions (only work for stdio backend)
Matti Hamalainen <ccr@tnsp.org>
parents:
26
diff
changeset
|
118 size_t (*fwrite)(void *, const size_t, const size_t, DMResource *); |
| 0 | 119 |
| 120 int (*fopen)(DMResource *); | |
| 121 void (*fclose)(DMResource *); | |
| 122 int (*preload)(DMResource *); | |
| 123 } DMResourceOps; | |
| 124 | |
| 125 | |
| 126 /* Functions | |
| 127 */ | |
|
359
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
128 int dmres_init(DMResourceLib **lib, const char *filename, const char *path, const int flags, int (*classifier)(DMResource *)); |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
129 int dmres_close(DMResourceLib *lib); |
| 0 | 130 |
|
359
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
131 void dmres_prune(DMResourceLib *lib, int agems, int flags); |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
132 int dmres_preload(DMResourceLib *lib, BOOL start, int *loaded, int *total); |
| 0 | 133 |
|
114
e9de22e5a6d5
Add functions for converting resource flags to symbolic string form and back.
Matti Hamalainen <ccr@tnsp.org>
parents:
107
diff
changeset
|
134 void dmres_flags_to_symbolic(char *str, size_t size, int flags); |
|
e9de22e5a6d5
Add functions for converting resource flags to symbolic string form and back.
Matti Hamalainen <ccr@tnsp.org>
parents:
107
diff
changeset
|
135 int dmres_symbolic_to_flags(const char *str); |
|
359
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
136 int dmres_load_resfile(DMResourceLib *lib, const char *filename); |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
137 int dmres_write_resfile(DMResourceLib *lib, const char *filename); |
| 0 | 138 |
|
359
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
139 DMResource * dmres_new(DMResourceLib *lib, const char *filename, int flags, size_t size); |
|
208
c6b4fa03744c
Make some functions static, some public in the header.
Matti Hamalainen <ccr@tnsp.org>
parents:
124
diff
changeset
|
140 void dmres_free(DMResource *node); |
|
359
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
141 void dmres_insert(DMResourceLib *lib, DMResource * node); |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
142 void dmres_delete(DMResourceLib *lib, DMResource * node); |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
143 DMResource * dmres_find(DMResourceLib *lib, const char *filename); |
| 0 | 144 int dmres_ref(DMResource *); |
| 145 int dmres_unref(DMResource *); | |
| 146 | |
| 147 | |
| 148 // Opening and closing resources | |
|
359
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
149 DMResource * dmf_open(DMResourceLib *lib, const char *); |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
150 DMResource * dmf_create_memio(DMResourceLib *lib, const char *, Uint8 *buf, size_t len); |
|
124
d5cfd29c87c4
Rename some conditional compilation directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
114
diff
changeset
|
151 #ifdef DM_USE_STDIO |
|
74
23ac82365a65
Add file mode to dmf_create_stdio().
Matti Hamalainen <ccr@tnsp.org>
parents:
59
diff
changeset
|
152 DMResource * dmf_create_stdio(const char *filename, const char *mode); |
| 0 | 153 DMResource * dmf_create_stdio_stream(FILE *); |
| 154 #endif | |
| 155 void dmf_close(DMResource *); | |
| 156 | |
| 157 | |
| 158 // Basic resource access functions | |
| 159 int dmferror(DMResource *); | |
| 160 int dmfseek(DMResource *, const off_t, const int); | |
| 161 off_t dmfsize(DMResource *); | |
| 162 off_t dmftell(DMResource *); | |
| 163 BOOL dmfeof(DMResource *); | |
| 164 int dmfgetc(DMResource *); | |
|
59
c560703e85ed
Add resource writing functions (only work for stdio backend)
Matti Hamalainen <ccr@tnsp.org>
parents:
26
diff
changeset
|
165 int dmfputc(int, DMResource *); |
| 0 | 166 size_t dmfread(void *, const size_t, const size_t, DMResource *); |
|
59
c560703e85ed
Add resource writing functions (only work for stdio backend)
Matti Hamalainen <ccr@tnsp.org>
parents:
26
diff
changeset
|
167 size_t dmfwrite(void *, const size_t, const size_t, DMResource *); |
| 235 | 168 char * dmfgets(char *s, int size, DMResource * f); |
| 0 | 169 |
| 170 | |
| 171 // Specialized functions for endianess based reading etc | |
| 172 int dmf_read_str(DMResource *, Uint8 *, size_t); | |
| 173 BOOL dmf_read_be16(DMResource *, Uint16 *); | |
| 174 BOOL dmf_read_be32(DMResource *, Uint32 *); | |
| 175 BOOL dmf_read_le16(DMResource *, Uint16 *); | |
| 176 BOOL dmf_read_le32(DMResource *, Uint32 *); | |
| 177 | |
| 178 #ifdef DM_HAVE_64BIT | |
| 179 BOOL dmf_read_be64(DMResource *, Uint64 *); | |
| 180 BOOL dmf_read_le64(DMResource *, Uint64 *); | |
| 181 #endif | |
| 182 | |
| 183 | |
| 184 #ifdef __cplusplus | |
| 185 } | |
| 186 #endif | |
| 187 | |
| 188 #endif // DMRES_H |