Nebula
|
#include <win32fswrapper.h>
Internal filesystem wrapper for Win32.
All paths must be native paths (i.e. not contain Nebula assigns).
Public Types | |
typedef HANDLE | Handle |
Static Public Member Functions | |
static Handle | OpenFile (const Util::String &path, IO::Stream::AccessMode accessMode, IO::Stream::AccessPattern accessPattern, DWORD flagsAndAttributes=0) |
open a file | |
static void | CloseFile (Handle h) |
close a file | |
static void | Write (Handle h, const void *buf, IO::Stream::Size numBytes) |
write to a file | |
static IO::Stream::Size | Read (Handle h, void *buf, IO::Stream::Size numBytes) |
read from a file | |
static char * | Map (Handle h, IO::Stream::AccessMode accessMode, Handle &mappedHandle) |
map file to virtual memory | |
static void | Unmap (Handle mapHandle, char *buf) |
unmap file | |
static void | Seek (Handle h, IO::Stream::Offset offset, IO::Stream::SeekOrigin orig) |
seek in a file | |
static IO::Stream::Position | Tell (Handle h) |
get position in file | |
static void | Flush (Handle h) |
flush a file | |
static bool | Eof (Handle h) |
return true if at end-of-file | |
static IO::Stream::Size | GetFileSize (Handle h) |
get size of a file in bytes | |
static void | SetReadOnly (const Util::String &path, bool readOnly) |
set read-only status of a file | |
static bool | IsReadOnly (const Util::String &path) |
get read-only status of a file | |
static bool | IsLocked (const Util::String &path) |
get locked status of file | |
static bool | DeleteFile (const Util::String &path) |
delete a file | |
static bool | ReplaceFile (const Util::String &source, const Util::String &target) |
rename a file | |
static bool | DeleteDirectory (const Util::String &path) |
delete an empty directory | |
static bool | FileExists (const Util::String &path) |
return true if a file exists | |
static bool | DirectoryExists (const Util::String &path) |
return true if a directory exists | |
static void | SetFileWriteTime (const Util::String &path, IO::FileTime fileTime) |
set the write-access time stamp of a file | |
static IO::FileTime | GetFileWriteTime (const Util::String &path) |
get the last write-access time stamp of a file | |
static bool | CreateDirectory (const Util::String &path) |
create a directory | |
static Util::String | CreateTemporaryFilename (const Util::String &path) |
create a temporary file name | |
static Util::Array< Util::String > | ListFiles (const Util::String &dirPath, const Util::String &pattern) |
list all files in a directory | |
static Util::Array< Util::String > | ListDirectories (const Util::String &dirPath, const Util::String &pattern) |
list all subdirectories in a directory | |
static Util::String | GetUserDirectory () |
get path to the current user's home directory (for user: standard assign) | |
static Util::String | GetAppDataDirectory () |
get path to the current user's appdata directory (for appdata: standard assign) | |
static Util::String | GetTempDirectory () |
get path to the current user's temp directory (for temp: standard assign) | |
static Util::String | GetHomeDirectory () |
get path to the current application directory (for home: standard assign) | |
static Util::String | GetBinDirectory () |
get path to the current bin directory (for bin: standard assign) | |
static Util::String | GetProgramsDirectory () |
get path to the "c:/program files" directory | |
static Util::String | GetCurrentDirectory () |
get current working directory | |
static bool | IsDeviceName (const Util::String &str) |
return true when the string is a device name (e.g. "C:") | |
Static Private Member Functions | |
static void | ConvertToWidePath (const Util::String &src, ushort *dst, SizeT dstNumBytes) |
convert UTF8 path name to WideChar path name | |
|
static |
close a file
Closes a file opened by Win32FSWrapper::OpenFile().
|
staticprivate |
convert UTF8 path name to WideChar path name
|
static |
create a directory
Creates a new directory.
|
static |
create a temporary file name
|
static |
delete an empty directory
Delete an empty directory.
Returns true if the operation was successful.
|
static |
delete a file
Deletes a file.
Returns true if the operation was successful. The delete will fail if the fail doesn't exist or the file is read-only.
|
static |
return true if a directory exists
Return true if a directory exists.
|
static |
return true if at end-of-file
Returns true if current position is at end of file.
|
static |
return true if a file exists
Return true if a file exists.
|
static |
flush a file
Flush unwritten data to file.
|
static |
get path to the current user's appdata directory (for appdata: standard assign)
|
static |
get path to the current bin directory (for bin: standard assign)
This method sould return the directory where the application executable is located.
|
static |
get current working directory
|
static |
get size of a file in bytes
Returns the size of a file in bytes.
|
static |
get the last write-access time stamp of a file
Return the last write-access time to a file.
|
static |
get path to the current application directory (for home: standard assign)
This method should return the installation directory of the application.
|
static |
get path to the "c:/program files" directory
|
static |
get path to the current user's temp directory (for temp: standard assign)
|
static |
get path to the current user's home directory (for user: standard assign)
|
static |
return true when the string is a device name (e.g. "C:")
Return true if the provided string is a device name.
|
static |
get locked status of file
try to check for a lock by trying to lock the file.
inherently racey, but good enough in some situations
|
static |
get read-only status of a file
Get the read-only status of a file.
|
static |
list all subdirectories in a directory
Lists all subdirectories in a directory, filtered by a pattern.
This will not return the special directories ".." and ".".
|
static |
list all files in a directory
Lists all files in a directory, filtered by a pattern.
|
static |
map file to virtual memory
|
static |
open a file
Open a file using the function CreateFile().
Returns a handle to the file which must be passed to the other Win32FSWrapper file methods. If opening the file fails, the function will return 0. The filename must be a native win32 path (no assigns, etc...).
|
static |
read from a file
Read data from a file, returns number of bytes read.
|
static |
rename a file
|
static |
seek in a file
Seek in a file.
|
static |
set the write-access time stamp of a file
Set the write-access time stamp of a file.
|
static |
set read-only status of a file
Set the read-only status of a file.
|
static |
get position in file
Get current position in file.
|
static |
unmap file
|
static |
write to a file
Write data to a file.