Mercurial > hg > dmlib
annotate src/dmres.h @ 1040:ebabf5aefb76
Work on resource handling.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Sun, 01 Mar 2015 17:17:36 +0200 |
| parents | 1a0a327d8fed |
| children | b6c5e0c62588 |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 * DMLib | |
| 3 * -- Resource management | |
| 4 * Programmed and designed by Matti 'ccr' Hamalainen | |
| 863 | 5 * (C) Copyright 2011-2015 Tecnic Software productions (TNSP) |
| 0 | 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 "dmpack.h" |
| 14 #endif | |
| 15 | |
| 16 #ifdef __cplusplus | |
| 17 extern "C" { | |
| 18 #endif | |
| 19 | |
| 1036 | 20 #ifdef HAVE_FSEEK64 |
| 21 # define DM_FSEEK64 fseek64 | |
| 22 # define DM_FTELL64 ftell64 | |
| 23 #else | |
| 24 # define DM_FSEEK64 fseeko | |
| 25 # define DM_FTELL64 ftello | |
| 26 #endif | |
| 27 | |
| 0 | 28 |
| 29 /* Constants | |
| 30 */ | |
| 31 enum | |
| 32 { | |
| 33 DMPRUNE_ATIME = 0x0001, | |
| 34 DMPRUNE_MTIME = 0x0002, | |
| 35 }; | |
| 36 | |
| 37 enum | |
| 38 { | |
| 39 DRF_USE_PACK = 0x0001, | |
|
613
15cd5b8a29b2
Add DRF_USE_STDIO flag for resources.
Matti Hamalainen <ccr@tnsp.org>
parents:
602
diff
changeset
|
40 DRF_USE_STDIO = 0x0002, |
|
721
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
41 DRF_PRELOAD_RAW = 0x0004, |
|
613
15cd5b8a29b2
Add DRF_USE_STDIO flag for resources.
Matti Hamalainen <ccr@tnsp.org>
parents:
602
diff
changeset
|
42 DRF_PRELOAD_RES = 0x0008, |
| 0 | 43 }; |
| 44 | |
| 45 enum | |
| 46 { | |
|
1040
ebabf5aefb76
Work on resource handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
1036
diff
changeset
|
47 DMF_PERSIST = 0x0001, // Persist loaded RAW resource |
|
ebabf5aefb76
Work on resource handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
1036
diff
changeset
|
48 DMF_COMPRESSED = 0x0002, // Resource is compressed in PACK file, otherwise raw |
|
ebabf5aefb76
Work on resource handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
1036
diff
changeset
|
49 DMF_TEMPORARY = 0x0004, |
|
ebabf5aefb76
Work on resource handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
1036
diff
changeset
|
50 DMF_PACK_MASK = 0x00ff, // Mask for flags that may be specified in PACK |
|
ebabf5aefb76
Work on resource handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
1036
diff
changeset
|
51 |
|
ebabf5aefb76
Work on resource handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
1036
diff
changeset
|
52 DMF_UNALLOCATED = 0x1000, // The raw data is not allocated, so do not free it |
|
ebabf5aefb76
Work on resource handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
1036
diff
changeset
|
53 DMF_LOADED_RAW = 0x2000, // Raw data has been loaded |
|
ebabf5aefb76
Work on resource handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
1036
diff
changeset
|
54 DMF_LOADED_RES = 0x4000, // Resource has been loaded |
| 0 | 55 }; |
| 56 | |
| 57 | |
| 58 /* Typedefs and structures | |
| 59 */ | |
|
359
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
60 struct DMResourceLib; |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
61 struct DMResourceDataOps; |
| 0 | 62 struct DMResourceOps; |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
63 struct DMResource; |
| 0 | 64 |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
65 typedef struct DMResource |
| 0 | 66 { |
| 67 // Timestamps (in seconds from time()) | |
| 68 int mtime, // When resource was loaded | |
|
721
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
69 atime; // Last accessed (dmResourceRef()/unref) |
| 0 | 70 int refcount; // Reference count |
| 71 | |
| 72 int flags; // Resource flags (DMF_*) | |
| 73 char *filename; | |
| 74 | |
|
721
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
75 // Raw data (or mem data) |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
76 size_t rawSize; // Size of data |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
77 off_t rawOffset; // Current offset in data |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
78 Uint8 *rawData; // Pointer to data |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
79 |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
80 // Decoded resource data |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
81 void *resData; |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
82 size_t resSize; |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
83 struct DMResourceDataOps *rops; |
| 0 | 84 |
| 85 int error; // Error code | |
| 86 | |
|
721
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
87 #ifdef DM_USE_STDIO |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
88 FILE * fh; // File handle for stdio |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
89 #endif |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
90 |
|
721
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
91 struct DMResourceOps *fops; // Pointer to file handling functions struct |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
92 struct DMResourceLib *lib; // Pointer to the resource library |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
93 struct DMResource *next, *prev; |
| 0 | 94 } DMResource; |
| 95 | |
| 96 | |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
97 typedef struct DMResourceDataOps |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
98 { |
|
105
d5d27f262227
Beging merging of dmsimple2-fork into the main "engine".
Matti Hamalainen <ccr@tnsp.org>
parents:
103
diff
changeset
|
99 BOOL (*probe)(DMResource *res, const char *fext); |
|
26
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
100 int (*load)(DMResource *res); |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
101 void (*free)(DMResource *res); |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
102 } DMResourceDataOps; |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
103 |
|
2f463a59d732
Implement rudimentary resource system.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
104 |
|
359
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
105 typedef struct 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 int flags; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
108 char *resPath; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
109 |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
110 DMResource *resources, *preload; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
111 DMMutex *mutex; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
112 |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
113 #ifdef DM_USE_PACKFS |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
114 char *packFilename; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
115 DMPackFile *packFile; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
116 #endif |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
117 } DMResourceLib; |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
118 |
|
59045853853d
Make resource management re-entrant.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
119 |
| 0 | 120 typedef struct DMResourceOps |
| 121 { | |
|
728
867fc7f205a8
More work on resource handling cleanup.
Matti Hamalainen <ccr@tnsp.org>
parents:
722
diff
changeset
|
122 char *name; |
| 732 | 123 |
| 124 int (*freset)(DMResource *); | |
| 0 | 125 int (*ferror)(DMResource *); |
| 1036 | 126 int (*fseek)(DMResource *, const Sint64, const int); |
| 0 | 127 off_t (*fsize)(DMResource *); |
| 1036 | 128 Sint64 (*ftell)(DMResource *); |
| 0 | 129 BOOL (*feof)(DMResource *); |
| 130 int (*fgetc)(DMResource *); | |
|
59
c560703e85ed
Add resource writing functions (only work for stdio backend)
Matti Hamalainen <ccr@tnsp.org>
parents:
26
diff
changeset
|
131 int (*fputc)(int, DMResource *); |
| 0 | 132 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
|
133 size_t (*fwrite)(void *, const size_t, const size_t, DMResource *); |
| 0 | 134 |
| 135 int (*fopen)(DMResource *); | |
| 136 void (*fclose)(DMResource *); | |
| 137 int (*preload)(DMResource *); | |
| 138 } DMResourceOps; | |
| 139 | |
| 140 | |
| 141 /* Functions | |
| 142 */ | |
|
721
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
143 int dmResourcesInit(DMResourceLib **lib, const char *filename, const char *path, const int flags, int (*classifier)(DMResource *)); |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
144 int dmResourcesClose(DMResourceLib *lib); |
| 0 | 145 |
|
721
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
146 void dmResourcesPrune(DMResourceLib *lib, const int agems, int const flags); |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
147 int dmResourcesPreload(DMResourceLib *lib, BOOL start, int *loaded, int *total); |
| 0 | 148 |
|
1040
ebabf5aefb76
Work on resource handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
1036
diff
changeset
|
149 DMResource * dmResourceNew(DMResourceLib *lib, const char *filename, const size_t size, const int flags); |
|
721
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
150 void dmResourceFree(DMResource *node); |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
151 void dmResourceInsert(DMResourceLib *lib, DMResource * node); |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
152 void dmResourceDelete(DMResourceLib *lib, DMResource * node); |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
153 DMResource * dmResourceFind(DMResourceLib *lib, const char *filename); |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
154 int dmResourceRef(DMResource *); |
|
bb14d7907eb2
Rename many pack & resource handling functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
155 int dmResourceUnref(DMResource *); |
| 0 | 156 |
| 157 | |
| 158 // Opening and closing resources | |
|
730
3d813c81f33c
More work on resources API.
Matti Hamalainen <ccr@tnsp.org>
parents:
728
diff
changeset
|
159 int dmf_open(DMResourceLib *lib, const char *, DMResource **handle); |
| 914 | 160 void dmf_close(DMResource *); |
| 161 | |
|
730
3d813c81f33c
More work on resources API.
Matti Hamalainen <ccr@tnsp.org>
parents:
728
diff
changeset
|
162 int dmf_create_memio(DMResourceLib *lib, const char *, Uint8 *buf, size_t len, DMResource **phandle); |
|
124
d5cfd29c87c4
Rename some conditional compilation directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
114
diff
changeset
|
163 #ifdef DM_USE_STDIO |
|
730
3d813c81f33c
More work on resources API.
Matti Hamalainen <ccr@tnsp.org>
parents:
728
diff
changeset
|
164 int dmf_create_stdio(const char *filename, const char *mode, DMResource **phandle); |
|
3d813c81f33c
More work on resources API.
Matti Hamalainen <ccr@tnsp.org>
parents:
728
diff
changeset
|
165 int dmf_create_stdio_stream(FILE *, DMResource **phandle); |
| 0 | 166 #endif |
| 167 | |
| 168 | |
| 169 // Basic resource access functions | |
| 732 | 170 int dmfreset(DMResource *); |
| 0 | 171 int dmferror(DMResource *); |
| 1036 | 172 int dmfseek(DMResource *, Sint64, const int); |
| 0 | 173 off_t dmfsize(DMResource *); |
| 1036 | 174 Sint64 dmftell(DMResource *); |
| 0 | 175 BOOL dmfeof(DMResource *); |
| 176 int dmfgetc(DMResource *); | |
|
59
c560703e85ed
Add resource writing functions (only work for stdio backend)
Matti Hamalainen <ccr@tnsp.org>
parents:
26
diff
changeset
|
177 int dmfputc(int, DMResource *); |
| 0 | 178 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
|
179 size_t dmfwrite(void *, const size_t, const size_t, DMResource *); |
| 235 | 180 char * dmfgets(char *s, int size, DMResource * f); |
| 0 | 181 |
| 182 | |
|
437
3d9c044ec08d
Add dmf_{write,read}_byte() convenience functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
359
diff
changeset
|
183 // Helper functions for endianess based reading etc |
|
553
b60220fd1669
s/Uint8/void/ in dmf_{read,write}_str().
Matti Hamalainen <ccr@tnsp.org>
parents:
437
diff
changeset
|
184 int dmf_read_str(DMResource *, void *, size_t); |
|
437
3d9c044ec08d
Add dmf_{write,read}_byte() convenience functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
359
diff
changeset
|
185 BOOL dmf_read_byte(DMResource *, Uint8 *); |
|
3d9c044ec08d
Add dmf_{write,read}_byte() convenience functions.
Matti Hamalainen <ccr@tnsp.org>
parents:
359
diff
changeset
|
186 |
| 0 | 187 BOOL dmf_read_be16(DMResource *, Uint16 *); |
| 188 BOOL dmf_read_be32(DMResource *, Uint32 *); | |
|
872
b01d04e44b6f
Assume we always have 64bit type.
Matti Hamalainen <ccr@tnsp.org>
parents:
863
diff
changeset
|
189 BOOL dmf_read_be64(DMResource *, Uint64 *); |
|
b01d04e44b6f
Assume we always have 64bit type.
Matti Hamalainen <ccr@tnsp.org>
parents:
863
diff
changeset
|
190 |
| 0 | 191 BOOL dmf_read_le16(DMResource *, Uint16 *); |
| 192 BOOL dmf_read_le32(DMResource *, Uint32 *); | |
| 193 BOOL dmf_read_le64(DMResource *, Uint64 *); | |
| 194 | |
| 195 | |
| 196 #ifdef __cplusplus | |
| 197 } | |
| 198 #endif | |
| 199 | |
| 200 #endif // DMRES_H |