feat: reduce boilerplate logic for importing modules

Signed-off-by: Michael Pollind <[email protected]>

Author: pollend

source/client/cl_vid.c

@@ -317,6 +317,7 @@ static bool VID_LoadRefresh( const char *name )
 
 	VID_UnloadRefresh();
 
+	import.fs = &default_fs_imports_s;
 	import.Com_Error = &Com_Error;
 	import.Com_Printf = &Com_Printf;
 	import.Com_DPrintf = &Com_DPrintf;

source/qcommon/common.c

@@ -229,6 +229,7 @@ void Com_Printf( const char *format, ... )
 	va_start( argptr, format );
 	Q_vsnprintfz( msg, sizeof( msg ), format, argptr );
 	va_end( argptr );
+	printf("%s", msg);
 
 	QMutex_Lock( com_print_mutex );
 
@@ -308,6 +309,7 @@ void Com_Error( com_error_code_t code, const char *format, ... )
 	Q_vsnprintfz( msg, sizeof_msg, format, argptr );
 	va_end( argptr );
 
+	printf("%s", msg);
 	if( code == ERR_DROP )
 	{
 		Com_Printf( "********************\nERROR: %s\n********************\n", msg );

source/qcommon/fs.h

@@ -0,0 +1,60 @@
+#ifndef R_FS_H
+#define R_FS_H
+
+#include "../gameshared/q_arch.h"
+
+#define DECLARE_TYPEDEF_METHOD( ret, name, ... ) \
+	typedef ret(*name##Fn )( __VA_ARGS__ ); \
+	ret name (__VA_ARGS__);  
+
+// file loading
+DECLARE_TYPEDEF_METHOD( int, FS_FOpenFile, const char *filename, int *filenum, int mode );
+DECLARE_TYPEDEF_METHOD( int, FS_FOpenBaseFile, const char *filename, int *filenum, int mode );
+DECLARE_TYPEDEF_METHOD( int, FS_FOpenAbsoluteFile, const char *filename, int *filenum, int mode );
+DECLARE_TYPEDEF_METHOD( void, FS_FCloseFile, int file );
+
+DECLARE_TYPEDEF_METHOD( int, FS_LoadFileExt, const char *path, int flags, void **buffer, void *stack, size_t stackSize, const char *filename, int fileline );
+DECLARE_TYPEDEF_METHOD( int, FS_LoadBaseFileExt, const char *path, int flags, void **buffer, void *stack, size_t stackSize, const char *filename, int fileline );
+DECLARE_TYPEDEF_METHOD( void, FS_FreeFile, void *buffer );
+DECLARE_TYPEDEF_METHOD( void, FS_FreeBaseFile, void *buffer );
+#define FS_LoadFile(path,buffer,stack,stacksize) FS_LoadFileExt(path,0,buffer,stack,stacksize,__FILE__,__LINE__)
+#define FS_LoadBaseFile(path,buffer,stack,stacksize) FS_LoadBaseFileExt(path,0,buffer,stack,stacksize,__FILE__,__LINE__)
+#define FS_LoadCacheFile(path,buffer,stack,stacksize) FS_LoadFileExt(path,FS_CACHE,buffer,stack,stacksize,__FILE__,__LINE__)
+
+struct fs_import_s {
+	FS_LoadFileExtFn FS_LoadFileExt;
+	FS_LoadBaseFileExtFn FS_LoadBaseFileExt;
+	FS_FreeFileFn FS_FreeFile;
+	FS_FreeBaseFileFn FS_FreeBaseFile;
+	FS_FOpenFileFn FS_FOpenFile;
+	FS_FOpenBaseFileFn FS_FOpenBaseFile;
+	FS_FOpenAbsoluteFileFn FS_FOpenAbsoluteFile;
+	FS_FCloseFileFn FS_FCloseFile;
+};
+static const struct fs_import_s default_fs_imports_s = { 
+	.FS_FreeFile = FS_FreeFile,
+	.FS_LoadFileExt = FS_LoadFileExt,
+	.FS_LoadBaseFileExt = FS_LoadBaseFileExt,
+	.FS_FreeBaseFile = FS_FreeBaseFile,
+	.FS_FOpenFile = FS_FOpenFile,
+	.FS_FOpenBaseFile = FS_FOpenBaseFile,
+	.FS_FOpenAbsoluteFile = FS_FOpenAbsoluteFile,
+	.FS_FCloseFile = FS_FCloseFile,
+};
+
+#if FS_DEFINE_INTERFACE_IMPL
+extern struct fs_import_s fs_import;
+struct fs_import_s fs_import;
+int FS_LoadFileExt(const char *path, int flags, void **buffer, void *stack, size_t stackSize, const char *filename, int fileline ) {return fs_import.FS_LoadFileExt(path, flags, buffer, stack, stackSize, filename, fileline);}
+int FS_LoadBaseFileExt(const char *path, int flags, void **buffer, void *stack, size_t stackSize, const char *filename, int fileline ) {return fs_import.FS_LoadBaseFileExt(path, flags, buffer, stack, stackSize, filename, fileline );}
+void FS_FreeFile(void *buffer ) {return fs_import.FS_FreeFile(buffer);}
+void FS_FreeBaseFile(void *buffer ) {return fs_import.FS_FreeFile(buffer);}
+int FS_FOpenFile(const char *filename, int *filenum, int mode ) { return fs_import.FS_FOpenFile(filename, filenum, mode);}
+int FS_FOpenBaseFile(const char *filename, int *filenum, int mode ) { return fs_import.FS_FOpenBaseFile(filename, filenum, mode);} 
+int FS_FOpenAbsoluteFile(const char *filename, int *filenum, int mode) { return fs_import.FS_FOpenAbsoluteFile(filename, filenum, mode);}
+void FS_FCloseFile(int file ) { fs_import.FS_FCloseFile(file); }
+#endif
+
+#endif
+
+#undef DECLARE_TYPEDEF_METHOD

source/qcommon/qcommon.h

@@ -715,12 +715,14 @@ const char *FS_AbsoluteNameForFile( const char *filename );
 const char *FS_AbsoluteNameForBaseFile( const char *filename );
 void	    FS_AddExtraPK3Directory( const char *path );
 
+
+#include "fs.h"
 // // game and base files
 // file streaming
-int	    FS_FOpenFile( const char *filename, int *filenum, int mode );
-int	    FS_FOpenBaseFile( const char *filename, int *filenum, int mode );
-int		FS_FOpenAbsoluteFile( const char *filename, int *filenum, int mode );
-void	FS_FCloseFile( int file );
+//int	    FS_FOpenFile( const char *filename, int *filenum, int mode );
+//int	    FS_FOpenBaseFile( const char *filename, int *filenum, int mode );
+//int		FS_FOpenAbsoluteFile( const char *filename, int *filenum, int mode );
+//void	FS_FCloseFile( int file );
 
 int	    FS_Read( void *buffer, size_t len, int file );
 int	    FS_Print( int file, const char *msg );
@@ -734,13 +736,13 @@ bool	FS_IsUrl( const char *url );
 int		FS_FileNo( int file, size_t *offset );
 
 // file loading
-int	    FS_LoadFileExt( const char *path, int flags, void **buffer, void *stack, size_t stackSize, const char *filename, int fileline );
-int	    FS_LoadBaseFileExt( const char *path, int flags, void **buffer, void *stack, size_t stackSize, const char *filename, int fileline );
-void	FS_FreeFile( void *buffer );
-void	FS_FreeBaseFile( void *buffer );
-#define FS_LoadFile(path,buffer,stack,stacksize) FS_LoadFileExt(path,0,buffer,stack,stacksize,__FILE__,__LINE__)
-#define FS_LoadBaseFile(path,buffer,stack,stacksize) FS_LoadBaseFileExt(path,0,buffer,stack,stacksize,__FILE__,__LINE__)
-#define FS_LoadCacheFile(path,buffer,stack,stacksize) FS_LoadFileExt(path,FS_CACHE,buffer,stack,stacksize,__FILE__,__LINE__)
+//int	    FS_LoadFileExt( const char *path, int flags, void **buffer, void *stack, size_t stackSize, const char *filename, int fileline );
+//int	    FS_LoadBaseFileExt( const char *path, int flags, void **buffer, void *stack, size_t stackSize, const char *filename, int fileline );
+//void	FS_FreeFile( void *buffer );
+//void	FS_FreeBaseFile( void *buffer );
+//#define FS_LoadFile(path,buffer,stack,stacksize) FS_LoadFileExt(path,0,buffer,stack,stacksize,__FILE__,__LINE__)
+//#define FS_LoadBaseFile(path,buffer,stack,stacksize) FS_LoadBaseFileExt(path,0,buffer,stack,stacksize,__FILE__,__LINE__)
+//#define FS_LoadCacheFile(path,buffer,stack,stacksize) FS_LoadFileExt(path,FS_CACHE,buffer,stack,stacksize,__FILE__,__LINE__)
 
 /**
 * Maps an existing file on disk for reading. 

source/ref_base/r_public.h

@@ -123,9 +123,14 @@ typedef struct
 	void ( *BufPipe_WriteCmd )( qbufPipe_t *queue, const void *cmd, unsigned cmd_size );
 	int ( *BufPipe_ReadCmds )( qbufPipe_t *queue, unsigned (**cmdHandlers)( const void * ) );
 	void ( *BufPipe_Wait )( qbufPipe_t *queue, int (*read)( qbufPipe_t *, unsigned( ** )(const void *), bool ), 
-		unsigned (**cmdHandlers)( const void * ), unsigned timeout_msec );
+	unsigned (**cmdHandlers)( const void * ), unsigned timeout_msec );
+	
+	struct fs_import_s* fs;
+
 } ref_import_t;
 
+
+
 typedef struct
 {
 	// if API is different, the dll cannot be used

source/ref_gl/r_local.h

@@ -29,6 +29,8 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #include "../qcommon/bsp.h"
 #include "../qcommon/patch.h"
 
+#include "../qcommon/fs.h"
+
 typedef struct { char *name; void **funcPointer; } dllfunc_t;
 
 typedef struct mempool_s mempool_t;

source/ref_gl/r_main.c

@@ -1722,7 +1722,7 @@ int R_LoadFile_( const char *path, int flags, void **buffer, const char *filenam
 	buf = NULL; // quiet compiler warning
 
 	// look for it in the filesystem or pack files
-	len = ri.FS_FOpenFile( path, &fhandle, FS_READ|flags );
+	len = FS_FOpenFile( path, &fhandle, FS_READ|flags );
 
 	if( !fhandle )
 	{
@@ -1733,7 +1733,7 @@ int R_LoadFile_( const char *path, int flags, void **buffer, const char *filenam
 
 	if( !buffer )
 	{
-		ri.FS_FCloseFile( fhandle );
+		FS_FCloseFile( fhandle );
 		return len;
 	}
 
@@ -1742,7 +1742,7 @@ int R_LoadFile_( const char *path, int flags, void **buffer, const char *filenam
 	*buffer = buf;
 
 	ri.FS_Read( buf, len, fhandle );
-	ri.FS_FCloseFile( fhandle );
+	FS_FCloseFile( fhandle );
 
 	return len;
 }

source/ref_gl/r_public.c

@@ -18,12 +18,17 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 */
 
+#define FS_DEFINE_INTERFACE_IMPL 1
+#include "../qcommon/fs.h"
+
 // r_public.c
 #include "r_local.h"
 #include "r_frontend.h"
 
+
 ref_import_t ri;
 
+
 /*
 * GetRefAPIVersion
 */
@@ -45,6 +50,7 @@ extern "C"
 QF_DLL_EXPORT ref_export_t *GetRefAPI( ref_import_t *import )
 {
 	static ref_export_t globals;
+	fs_import = *import->fs;
 
 	ri = *import;