quakeforge/ruamoko/include/qfile.h
Bill Currie 6d5e8922a5 [qfcc] Add a handle type for engine resources
I never liked the various hacks I had come up with for representing
resource handles in Ruamoko. Structs with an int were awkward to test,
pointers and ints could be modified, etc etc. The new @handle keyword (@
used to keep handle free for use) works just like struct, union and
enum in syntax, but creates an opaque type suitable for a 32-bit handle.
The backing type is a function so v6 progs can use it without (all the
necessary opcodes exist) and no modifications were needed for
type-checking in binary expressions, but only assignment and comparisons
are supported, and (of course) nil. Tested using cbuf_t and QFile: seems
to work as desired.

I had considered 64-bit handles, but really, if more than 4G resource
objects are needed, I'm not sure QF can handle the game. However, that
limit is per resource manager, not total.
2023-05-25 10:41:28 +09:00

24 lines
832 B
C

#ifndef __ruamoko_qfile_h
#define __ruamoko_qfile_h
typedef @handle _qfile_t QFile;
@extern int Qrename (string old, string new);
@extern int Qremove (string path);
@extern QFile Qopen (string path, string mode);
@extern void Qclose (QFile file);
@extern string Qgetline (QFile file);
@extern string Qreadstring (QFile file, int len);
@extern int Qread (QFile file, void *buf, int count);
@extern int Qwrite (QFile file, void *buf, int count);
@extern int Qputs (QFile file, string str);
//@extern int Qgets (QFile file, void *buf, int count);
@extern int Qgetc (QFile file);
@extern int Qputc (QFile file, int c);
@extern int Qseek (QFile file, int offset, int whence);
@extern int Qtell (QFile file);
@extern int Qflush (QFile file);
@extern int Qeof (QFile file);
@extern int Qfilesize (QFile file);
#endif//__ruamoko_qfile_h