janwas
c4654fd8fa
debug: cleanup ogl_tex, tex: use full-width types to avoid truncation warnings wdbg_sym.cpp: skip __suppress and __profile symbols; add additional hex display for floats; cleanup wdll_ver.cpp: cppdoc+cleanup (remove non-reentrant C interface, replace with std::string) sysdep: add cppdoc everything else: flag parameters are now consistently size_t instead of int (avoids warnings, allows slightly better code on x64) This was SVN commit r6392.
68 lines
2.3 KiB
C
68 lines
2.3 KiB
C
/**
|
|
* =========================================================================
|
|
* File : file_system_util.h
|
|
* Project : 0 A.D.
|
|
* Description : helper functions for directory access
|
|
* =========================================================================
|
|
*/
|
|
|
|
// license: GPL; see lib/license.txt
|
|
|
|
#ifndef INCLUDED_FILE_SYSTEM_UTIL
|
|
#define INCLUDED_FILE_SYSTEM_UTIL
|
|
|
|
#include "lib/file/vfs/vfs.h"
|
|
|
|
extern void fs_SortFiles(FileInfos& files);
|
|
extern void fs_SortDirectories(DirectoryNames& directories);
|
|
|
|
extern LibError fs_GetPathnames(const PIVFS& fs, const VfsPath& path, const char* filter, VfsPaths& pathnames);
|
|
|
|
|
|
/**
|
|
* called for files in a directory.
|
|
*
|
|
* @param pathname full pathname (since FileInfo only gives the name).
|
|
* @param fileInfo file information
|
|
* @param cbData user-specified context
|
|
* @return INFO::CB_CONTINUE on success; any other value will immediately
|
|
* be returned to the caller (no more calls will be forthcoming).
|
|
*
|
|
* CAVEAT: pathname and fileInfo are only valid until the function
|
|
* returns!
|
|
**/
|
|
typedef LibError (*FileCallback)(const VfsPath& pathname, const FileInfo& fileInfo, const uintptr_t cbData);
|
|
|
|
enum DirFlags
|
|
{
|
|
DIR_RECURSIVE = 1
|
|
};
|
|
|
|
/**
|
|
* call back for each file in a directory tree
|
|
*
|
|
* @param cb see DirCallback
|
|
* @param pattern that file names must match. '*' and '&' wildcards
|
|
* are allowed. 0 matches everything.
|
|
* @param flags see DirFlags
|
|
* @param LibError
|
|
**/
|
|
extern LibError fs_ForEachFile(const PIVFS& fs, const VfsPath& path, FileCallback cb, uintptr_t cbData, const char* pattern = 0, size_t flags = 0);
|
|
|
|
|
|
/**
|
|
* determine the next available pathname with a given format.
|
|
* this is useful when creating new files without overwriting the previous
|
|
* ones (screenshots are a good example).
|
|
*
|
|
* @param pathnameFormat format string for the pathname; must contain one
|
|
* format specifier for a size_t.
|
|
* example: "screenshots/screenshot%04d.png"
|
|
* @param nextNumber in: the first number to try; out: the next number.
|
|
* if 0, numbers corresponding to existing files are skipped.
|
|
* @param nextPathname receives the output.
|
|
**/
|
|
extern void fs_NextNumberedFilename(const PIVFS& fs, const VfsPath& pathnameFormat, size_t& nextNumber, VfsPath& nextPathname);
|
|
|
|
#endif // #ifndef INCLUDED_FILE_SYSTEM_UTIL
|