mirror of
https://gitea.wildfiregames.com/0ad/0ad
synced 2026-07-04 05:55:47 -07:00
43137fef3f
Differential Revision: https://code.wildfiregames.com/D716
Refs 09e974e1cb
Reviewed By: bb
Change in agreement with leper.
This was SVN commit r19899.
75 lines
2.8 KiB
C++
75 lines
2.8 KiB
C++
/* Copyright (C) 2013 Wildfire Games.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included
|
|
* in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
/*
|
|
* look up directories/files by traversing path components.
|
|
*/
|
|
|
|
#ifndef INCLUDED_VFS_LOOKUP
|
|
#define INCLUDED_VFS_LOOKUP
|
|
|
|
#include "lib/file/vfs/vfs_path.h"
|
|
|
|
class VfsFile;
|
|
class VfsDirectory;
|
|
|
|
// note: VfsDirectory pointers are non-const because they may be
|
|
// populated during the lookup.
|
|
|
|
enum VfsLookupFlags
|
|
{
|
|
// add (if they do not already exist) subdirectory components
|
|
// encountered in the path[name].
|
|
VFS_LOOKUP_ADD = 1,
|
|
|
|
// if VFS directories encountered are not already associated
|
|
// with a real directory, do so (creating the directories
|
|
// if they do not already exist).
|
|
VFS_LOOKUP_CREATE = 2,
|
|
|
|
// don't populate the directories encountered. this makes sense
|
|
// when adding files from an archive, which would otherwise
|
|
// cause nearly every directory to be populated.
|
|
VFS_LOOKUP_SKIP_POPULATE = 4,
|
|
|
|
// even create directories if they are already present, this is
|
|
// useful to write new files to the directory that was attached
|
|
// last, if the directory wasn't mounted with VFS_MOUNT_REPLACEABLE
|
|
VFS_LOOKUP_CREATE_ALWAYS = 8
|
|
};
|
|
|
|
/**
|
|
* Resolve a pathname.
|
|
*
|
|
* @param pathname
|
|
* @param startDirectory VfsStartDirectory.
|
|
* @param directory is set to the last directory component that is encountered.
|
|
* @param pfile File is set to 0 if there is no name component, otherwise the
|
|
* corresponding file.
|
|
* @param flags @see VfsLookupFlags.
|
|
* @return Status (INFO::OK if all components in pathname exist).
|
|
*
|
|
* to allow noiseless file-existence queries, this does not raise warnings.
|
|
**/
|
|
extern Status vfs_Lookup(const VfsPath& pathname, VfsDirectory* startDirectory, VfsDirectory*& directory, VfsFile** pfile, size_t flags = 0);
|
|
|
|
#endif // #ifndef INCLUDED_VFS_LOOKUP
|