forked from 0ad/0ad
64 lines
1.8 KiB
C++
64 lines
1.8 KiB
C++
/**
|
|
* =========================================================================
|
|
* File : path.h
|
|
* Project : 0 A.D.
|
|
* Description : helper functions for VFS paths.
|
|
* =========================================================================
|
|
*/
|
|
|
|
// license: GPL; see lib/license.txt
|
|
|
|
#ifndef INCLUDED_PATH
|
|
#define INCLUDED_PATH
|
|
|
|
|
|
namespace ERR
|
|
{
|
|
const LibError ROOT_DIR_ALREADY_SET = -110200;
|
|
}
|
|
|
|
|
|
#define VFS_PATH_IS_DIR(path) (*path == '\0' || path[strlen(path)-1] == '/')
|
|
|
|
struct NextNumberedFilenameInfo
|
|
{
|
|
int next_num;
|
|
};
|
|
|
|
// fill V_next_fn (which must be big enough for PATH_MAX chars) with
|
|
// the next numbered filename according to the pattern defined by V_fn_fmt.
|
|
// <nfi> must be initially zeroed (e.g. by defining as static) and passed
|
|
// each time.
|
|
// if <use_vfs> (default), the paths are treated as VFS paths; otherwise,
|
|
// file.cpp's functions are used. this is necessary because one of
|
|
// our callers needs a filename for VFS archive files.
|
|
//
|
|
// this function is useful when creating new files which are not to
|
|
// overwrite the previous ones, e.g. screenshots.
|
|
// example for V_fn_fmt: "screenshots/screenshot%04d.png".
|
|
extern void next_numbered_filename(const char* V_fn_fmt,
|
|
NextNumberedFilenameInfo* nfi, char* V_next_fn, bool use_vfs = true);
|
|
|
|
|
|
extern bool path_is_atom_fn(const char* fn);
|
|
|
|
extern const char* file_get_random_name();
|
|
|
|
|
|
/**
|
|
* reset root directory that was previously established via file_set_root_dir.
|
|
*
|
|
* this function avoids the security complaint that would be raised if
|
|
* file_set_root_dir is called twice; it is provided for the
|
|
* legitimate application of a self-test setUp()/tearDown().
|
|
**/
|
|
extern void path_reset_root_dir();
|
|
|
|
// note: other functions are declared directly in the public file.h header.
|
|
|
|
|
|
extern void path_init();
|
|
extern void path_shutdown();
|
|
|
|
#endif // #ifndef INCLUDED_PATH
|