-/*\r
-Copyright (C) 1999-2007 id Software, Inc. and contributors.\r
-For a list of contributors, see the accompanying CONTRIBUTORS file.\r
-\r
-This file is part of GtkRadiant.\r
-\r
-GtkRadiant is free software; you can redistribute it and/or modify\r
-it under the terms of the GNU General Public License as published by\r
-the Free Software Foundation; either version 2 of the License, or\r
-(at your option) any later version.\r
-\r
-GtkRadiant is distributed in the hope that it will be useful,\r
-but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
-GNU General Public License for more details.\r
-\r
-You should have received a copy of the GNU General Public License\r
-along with GtkRadiant; if not, write to the Free Software\r
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\r
-*/\r
-\r
-#ifndef _IFILESYSTEM_H_\r
-#define _IFILESYSTEM_H_\r
-\r
-//\r
-// Plugin interface for the virtual filesystem used by Radiant\r
-//\r
-\r
-// NOTE: If you want to write a VFS plugin then you must export\r
-// "QERPlug_ListInterfaces" and "QERPlug_RequestInterface"\r
-// (see qerplugin.h for more information)\r
-\r
-#ifdef _WIN32\r
-#define VFS_NATIVESEPARATOR '\\'\r
-#else\r
-#define VFS_NATIVESEPARATOR '/'\r
-#endif\r
-\r
-#define VFS_MAJOR "VFS"\r
-\r
-// return the file system supported by the plugin, for example: "quake1" or "quake3"\r
-//typedef const char* (WINAPI* PFN_VFSGETFORMAT) ();\r
-// add all files from a directory to the vfs\r
-typedef void (* PFN_VFSINITDIRECTORY) (const char *path);\r
-// free all resources used by the plugin\r
-typedef void (* PFN_VFSSHUTDOWN) ();\r
-// free memory allocated by VFS for this pointer\r
-typedef void (* PFN_VFSFREEFILE) (void *p);\r
-// return a GSList with all the directories under basedir \r
-typedef GSList* (* PFN_VFSGETDIRLIST) (const char *basedir);\r
-// return a GSList with all the files under basedir (extension can be NULL)\r
-typedef GSList* (* PFN_VFSGETFILELIST) (const char *basedir, const char *extension);\r
-// free a dirlist or filelist returned from one of the above functions\r
-typedef void (* PFN_VFSCLEARFILEDIRLIST) (GSList **lst);\r
-#define VFS_SEARCH_PAK 0x1\r
-#define VFS_SEARCH_DIR 0x2\r
-/*!\r
-\brief return the number of files with the exact name described in filename\r
-there can be several hits for a given file, or this can be used to check for existence\r
-\param flags is optional and can be used with VFS_SEARCH_* bits, if flag is 0, everything is searched, else only the specified bits\r
-paks are searched first, then search directories\r
-*/\r
-typedef int (* PFN_VFSGETFILECOUNT) (const char *filename, int flags);\r
-/*!\r
-\brief load file, allocate buffer\r
-\return -1 if fails or the size of the buffer allocated\r
-\param index is used to load the i-th file in the search directories (see vfsGetFileCount)\r
-this will scan in the search directories first, then it will search in the pak files\r
-WARNING: the allocated buffer must be freed with a g_free call\r
-NOTE TTimo: the g_free release is utter horror\r
- see http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=491\r
-*/\r
-typedef int (* PFN_VFSLOADFILE) (const char *filename, void **buffer, int index);\r
-// load a file from it's full path into the buffer, returns the file size or -1\r
-// the allocated buffer must be freed with a g_free call\r
-typedef int (* PFN_VFSLOADFULLPATHFILE) (const char *filename, void **buffer);\r
-// takes an absolute file path, returns a shortened relative file path if the absolute path matches a valid basedir or NULL if an error occured\r
-typedef char* (* PFN_VFSEXTRACTRELATIVEPATH) (const char *in);\r
-/*!\r
-\return the full path (in a static buff) to a file given it's relative path (NULL if not found)\r
-\param index if several files are matching (as returned in a call to vfsGetFileCount), get the index-th file\r
-\param flag 0 or a combination of VFS_SEARCH_PAK or VFS_SEARCH_DIR\r
-HYDRA:\r
- this now searches VFS/PAK files in addition to the filesystem\r
- if FLAG is 0 then ONLY dirs are searched.\r
- PAK's are searched before DIRs to mimic engine behaviour\r
- index is ignored when searching PAK files.\r
- when searching VFS, files are searched case insensitive.\r
-\r
-WARNING: if you use index from vfsGetFileCount, it works only with a vfsGetFileCount for the search directories only (not the pak files)\r
-FIXME TTimo our VFS names are case insensitive.\r
- this function is not able to build the full path from case-insensitive name\r
- ( this is http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=130 )\r
-*/\r
-typedef char* (* PFN_VFSGETFULLPATH) (const char *in, int index, int flag);\r
-/*!\r
-these return a static char*, doesn't need to be freed or anything\r
-get the base path to use when raising file dialogs\r
-we manually add "maps/" or "sounds/" or "mapobjects/models/" etc.\r
-FIXME: I'm not sure this is used / relevant anymore\r
-*/\r
-typedef const char* (* PFN_VFSBASEPROMPTPATH) ();\r
-\r
-// VFS API\r
-struct _QERFileSystemTable\r
-{\r
- int m_nSize;\r
- PFN_VFSINITDIRECTORY m_pfnInitDirectory;\r
- PFN_VFSSHUTDOWN m_pfnShutdown;\r
- PFN_VFSFREEFILE m_pfnFreeFile;\r
- PFN_VFSGETDIRLIST m_pfnGetDirList;\r
- PFN_VFSGETFILELIST m_pfnGetFileList;\r
- PFN_VFSCLEARFILEDIRLIST m_pfnClearFileDirList;\r
- PFN_VFSGETFILECOUNT m_pfnGetFileCount;\r
- PFN_VFSLOADFILE m_pfnLoadFile;\r
- PFN_VFSLOADFULLPATHFILE m_pfnLoadFullPathFile;\r
- PFN_VFSEXTRACTRELATIVEPATH m_pfnExtractRelativePath;\r
- PFN_VFSGETFULLPATH m_pfnGetFullPath;\r
- PFN_VFSBASEPROMPTPATH m_pfnBasePromptPath;\r
-};\r
-\r
-#ifdef USE_VFSTABLE_DEFINE\r
-#ifndef __VFSTABLENAME\r
-#define __VFSTABLENAME g_FileSystemTable\r
-#endif\r
-#define vfsInitDirectory __VFSTABLENAME.m_pfnInitDirectory\r
-#define vfsShutdown __VFSTABLENAME.m_pfnShutdown\r
-#define vfsFreeFile __VFSTABLENAME.m_pfnFreeFile\r
-#define vfsGetDirList __VFSTABLENAME.m_pfnGetDirList\r
-#define vfsGetFileList __VFSTABLENAME.m_pfnGetFileList\r
-#define vfsClearFileDirList __VFSTABLENAME.m_pfnClearFileDirList\r
-#define vfsGetFileCount __VFSTABLENAME.m_pfnGetFileCount\r
-#define vfsLoadFile __VFSTABLENAME.m_pfnLoadFile\r
-#define vfsLoadFullPathFile __VFSTABLENAME.m_pfnLoadFullPathFile\r
-#define vfsExtractRelativePath __VFSTABLENAME.m_pfnExtractRelativePath\r
-#define vfsGetFullPath __VFSTABLENAME.m_pfnGetFullPath\r
-#define vfsBasePromptPath __VFSTABLENAME.m_pfnBasePromptPath\r
-#endif\r
-\r
-#endif // _IFILESYSTEM_H_\r
+/*
+Copyright (C) 1999-2007 id Software, Inc. and contributors.
+For a list of contributors, see the accompanying CONTRIBUTORS file.
+
+This file is part of GtkRadiant.
+
+GtkRadiant is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+GtkRadiant is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GtkRadiant; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#ifndef _IFILESYSTEM_H_
+#define _IFILESYSTEM_H_
+
+//
+// Plugin interface for the virtual filesystem used by Radiant
+//
+
+// NOTE: If you want to write a VFS plugin then you must export
+// "QERPlug_ListInterfaces" and "QERPlug_RequestInterface"
+// (see qerplugin.h for more information)
+
+#ifdef _WIN32
+#define VFS_NATIVESEPARATOR '\\'
+#else
+#define VFS_NATIVESEPARATOR '/'
+#endif
+
+#define VFS_MAJOR "VFS"
+
+// return the file system supported by the plugin, for example: "quake1" or "quake3"
+//typedef const char* (WINAPI* PFN_VFSGETFORMAT) ();
+// add all files from a directory to the vfs
+typedef void (* PFN_VFSINITDIRECTORY) (const char *path);
+// free all resources used by the plugin
+typedef void (* PFN_VFSSHUTDOWN) ();
+// free memory allocated by VFS for this pointer
+typedef void (* PFN_VFSFREEFILE) (void *p);
+// return a GSList with all the directories under basedir
+typedef GSList* (* PFN_VFSGETDIRLIST) (const char *basedir);
+// return a GSList with all the files under basedir (extension can be NULL)
+typedef GSList* (* PFN_VFSGETFILELIST) (const char *basedir, const char *extension);
+// free a dirlist or filelist returned from one of the above functions
+typedef void (* PFN_VFSCLEARFILEDIRLIST) (GSList **lst);
+#define VFS_SEARCH_PAK 0x1
+#define VFS_SEARCH_DIR 0x2
+/*!
+\brief return the number of files with the exact name described in filename
+there can be several hits for a given file, or this can be used to check for existence
+\param flags is optional and can be used with VFS_SEARCH_* bits, if flag is 0, everything is searched, else only the specified bits
+paks are searched first, then search directories
+*/
+typedef int (* PFN_VFSGETFILECOUNT) (const char *filename, int flags);
+/*!
+\brief load file, allocate buffer
+\return -1 if fails or the size of the buffer allocated
+\param index is used to load the i-th file in the search directories (see vfsGetFileCount)
+this will scan in the search directories first, then it will search in the pak files
+WARNING: the allocated buffer must be freed with a g_free call
+NOTE TTimo: the g_free release is utter horror
+ see http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=491
+*/
+typedef int (* PFN_VFSLOADFILE) (const char *filename, void **buffer, int index);
+// load a file from it's full path into the buffer, returns the file size or -1
+// the allocated buffer must be freed with a g_free call
+typedef int (* PFN_VFSLOADFULLPATHFILE) (const char *filename, void **buffer);
+// takes an absolute file path, returns a shortened relative file path if the absolute path matches a valid basedir or NULL if an error occured
+typedef char* (* PFN_VFSEXTRACTRELATIVEPATH) (const char *in);
+/*!
+\return the full path (in a static buff) to a file given it's relative path (NULL if not found)
+\param index if several files are matching (as returned in a call to vfsGetFileCount), get the index-th file
+\param flag 0 or a combination of VFS_SEARCH_PAK or VFS_SEARCH_DIR
+HYDRA:
+ this now searches VFS/PAK files in addition to the filesystem
+ if FLAG is 0 then ONLY dirs are searched.
+ PAK's are searched before DIRs to mimic engine behaviour
+ index is ignored when searching PAK files.
+ when searching VFS, files are searched case insensitive.
+
+WARNING: if you use index from vfsGetFileCount, it works only with a vfsGetFileCount for the search directories only (not the pak files)
+FIXME TTimo our VFS names are case insensitive.
+ this function is not able to build the full path from case-insensitive name
+ ( this is http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=130 )
+*/
+typedef char* (* PFN_VFSGETFULLPATH) (const char *in, int index, int flag);
+/*!
+these return a static char*, doesn't need to be freed or anything
+get the base path to use when raising file dialogs
+we manually add "maps/" or "sounds/" or "mapobjects/models/" etc.
+FIXME: I'm not sure this is used / relevant anymore
+*/
+typedef const char* (* PFN_VFSBASEPROMPTPATH) ();
+
+// VFS API
+struct _QERFileSystemTable
+{
+ int m_nSize;
+ PFN_VFSINITDIRECTORY m_pfnInitDirectory;
+ PFN_VFSSHUTDOWN m_pfnShutdown;
+ PFN_VFSFREEFILE m_pfnFreeFile;
+ PFN_VFSGETDIRLIST m_pfnGetDirList;
+ PFN_VFSGETFILELIST m_pfnGetFileList;
+ PFN_VFSCLEARFILEDIRLIST m_pfnClearFileDirList;
+ PFN_VFSGETFILECOUNT m_pfnGetFileCount;
+ PFN_VFSLOADFILE m_pfnLoadFile;
+ PFN_VFSLOADFULLPATHFILE m_pfnLoadFullPathFile;
+ PFN_VFSEXTRACTRELATIVEPATH m_pfnExtractRelativePath;
+ PFN_VFSGETFULLPATH m_pfnGetFullPath;
+ PFN_VFSBASEPROMPTPATH m_pfnBasePromptPath;
+};
+
+#ifdef USE_VFSTABLE_DEFINE
+#ifndef __VFSTABLENAME
+#define __VFSTABLENAME g_FileSystemTable
+#endif
+#define vfsInitDirectory __VFSTABLENAME.m_pfnInitDirectory
+#define vfsShutdown __VFSTABLENAME.m_pfnShutdown
+#define vfsFreeFile __VFSTABLENAME.m_pfnFreeFile
+#define vfsGetDirList __VFSTABLENAME.m_pfnGetDirList
+#define vfsGetFileList __VFSTABLENAME.m_pfnGetFileList
+#define vfsClearFileDirList __VFSTABLENAME.m_pfnClearFileDirList
+#define vfsGetFileCount __VFSTABLENAME.m_pfnGetFileCount
+#define vfsLoadFile __VFSTABLENAME.m_pfnLoadFile
+#define vfsLoadFullPathFile __VFSTABLENAME.m_pfnLoadFullPathFile
+#define vfsExtractRelativePath __VFSTABLENAME.m_pfnExtractRelativePath
+#define vfsGetFullPath __VFSTABLENAME.m_pfnGetFullPath
+#define vfsBasePromptPath __VFSTABLENAME.m_pfnBasePromptPath
+#endif
+
+#endif // _IFILESYSTEM_H_
projects / xonotic / netradiant.git / blobdiff