mirrors/phobos
1
0
Fork 0
mirror of https://github.com/dlang/phobos.git synced 2025-04-29 14:40:30 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
phobos/std/file.d
Jonathan M Davis 11f2899ab5 Various adjustments to the documentation in std.datetime and std.file. 
This should fix the current ddoc build errors or Windows.
2011-01-22 09:48:29 +00:00

3479 lines
96 KiB
D
Raw Blame History

// Written in the D programming language.
/**
Utilities for manipulating files and scanning directories. Functions
in this module handle files as a unit, e.g., read or write one _file
at a time. For opening files and manipulating them via handles refer
to module $(D $(LINK2 std_stdio.html,std.stdio)).
Macros:
WIKI = Phobos/StdFile
Copyright: Copyright Digital Mars 2007 - 2009.
License: $(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0).
Authors: $(WEB digitalmars.com, Walter Bright),
$(WEB erdani.org, Andrei Alexandrescu),
Jonathan M Davis
*/
module std.file;
import core.memory;
import core.stdc.stdio, core.stdc.stdlib, core.stdc.string,
core.stdc.errno, std.algorithm, std.array, std.conv,
std.datetime, std.exception, std.format, std.path, std.process,
std.range, std.regexp, std.stdio, std.string, std.traits, std.typecons,
std.typetuple, std.utf;
version (Win32)
{
import core.sys.windows.windows, std.windows.charset,
std.windows.syserror, std.__fileinit : useWfuncs;
/*
* Since Win 9x does not support the "W" API's, first convert
* to wchar, then convert to multibyte using the current code
* page.
* (Thanks to yaneurao for this)
*/
version(Windows) alias std.windows.charset.toMBSz toMBSz;
}
version (Posix)
{
import core.sys.posix.dirent, core.sys.posix.fcntl, core.sys.posix.sys.stat,
core.sys.posix.sys.time, core.sys.posix.unistd, core.sys.posix.utime;
}
version (unittest)
{
import core.thread : Thread;
private string deleteme()
{
static _deleteme = "deleteme.dmd.unittest";
static _first = true;
if(_first)
{
version(Windows)
_deleteme = std.path.join(std.process.getenv("TEMP"), _deleteme);
else
_deleteme = "/tmp/" ~ _deleteme;
_first = false;
}
return _deleteme;
}
}
// @@@@ TEMPORARY - THIS SHOULD BE IN THE CORE @@@
// {{{
version (Posix)
{
version (OSX)
{
struct struct_stat64 // distinguish it from the stat() function
{
uint st_dev; /// device
ushort st_mode;
ushort st_nlink; /// link count
ulong st_ino; /// file serial number
uint st_uid; /// user ID of file's owner
uint st_gid; /// user ID of group's owner
uint st_rdev; /// if device then device number
int st_atime;
uint st_atimensec;
int st_mtime;
uint st_mtimensec;
int st_ctime;
uint st_ctimensec;
int st_birthtime;
uint st_birthtimensec;
ulong st_size;
long st_blocks; /// number of allocated 512 byte blocks
int st_blksize; /// optimal I/O block size
ulong st_ino64;
uint st_flags;
uint st_gen;
int st_lspare; /* RESERVED: DO NOT USE! */
long st_qspare[2]; /* RESERVED: DO NOT USE! */
}
extern(C) int fstat64(int, struct_stat64*);
extern(C) int stat64(in char*, struct_stat64*);
}
else version (FreeBSD)
{
alias core.sys.posix.sys.stat.stat_t struct_stat64;
alias core.sys.posix.sys.stat.fstat fstat64;
alias core.sys.posix.sys.stat.stat stat64;
}
else
{
struct struct_stat64 // distinguish it from the stat() function
{
ulong st_dev; /// device
uint __pad1;
uint st_ino; /// file serial number
uint st_mode; /// file mode
uint st_nlink; /// link count
uint st_uid; /// user ID of file's owner
uint st_gid; /// user ID of group's owner
ulong st_rdev; /// if device then device number
uint __pad2;
align(4) ulong st_size;
int st_blksize; /// optimal I/O block size
ulong st_blocks; /// number of allocated 512 byte blocks
int st_atime;
uint st_atimensec;
int st_mtime;
uint st_mtimensec;
int st_ctime;
uint st_ctimensec;
ulong st_ino64;
}
extern(C) int fstat64(int, struct_stat64*);
extern(C) int stat64(in char*, struct_stat64*);
extern(C) int lstat64(in char*, struct_stat64*);
}
}
// }}}
/++
Exception thrown for file I/O errors.
+/
class FileException : Exception
{
/++
OS error code.
+/
immutable uint errno;
/++
Constructor which takes an error message.
Params:
name = Name of file for which the error occurred.
msg = Message describing the error.
file = The file where the error occurred.
line = The line where the error occurred.
+/
this(in char[] name, in char[] msg, string file = __FILE__, size_t line = __LINE__)
{
if(msg.empty)
super(name.idup, file, line);
else
super(text(name, ": ", msg), file, line);
errno = 0;
}
/++
Constructor which takes the error number ($(LUCKY GetLastError)
in Windows, $(D_PARAM getErrno) in Posix).
Params:
name = Name of file for which the error occurred.
msg = Message describing the error.
file = The file where the error occurred.
line = The line where the error occurred.
+/
version(Windows) this(in char[] name,
uint errno = GetLastError,
string file = __FILE__,
size_t line = __LINE__)
{
this(name, sysErrorString(errno), file, line);
this.errno = errno;
}
/++
Constructor which takes the error number ($(LUCKY GetLastError)
in Windows, $(D_PARAM getErrno) in Posix).
Params:
name = Name of file for which the error occurred.
msg = Message describing the error.
file = The file where the error occurred.
line = The line where the error occurred.
+/
version(Posix) this(in char[] name,
uint errno = .getErrno,
string file = __FILE__,
size_t line = __LINE__)
{
auto s = strerror(errno);
this(name, to!string(s), file, line);
this.errno = errno;
}
}
private T cenforce(T)(T condition, lazy const(char)[] name, string file = __FILE__, size_t line = __LINE__)
{
if (!condition)
{
throw new FileException(name, "", file, line);
}
return condition;
}
/* **********************************
* Basic File operations.
*/
/********************************************
Read entire contents of file $(D name) and returns it as an untyped
array. If the file size is larger than $(D upTo), only $(D upTo)
bytes are read.
Example:
----
import std.file, std.stdio;
void main()
{
auto bytes = cast(ubyte[]) read("filename", 5);
if (bytes.length == 5)
writefln("The fifth byte of the file is 0x%x", bytes[4]);
}
----
Returns: Untyped array of bytes _read.
Throws: $(D FileException) on error.
*/
version(Windows) void[] read(in char[] name, size_t upTo = size_t.max)
{
alias TypeTuple!(GENERIC_READ,
FILE_SHARE_READ, (SECURITY_ATTRIBUTES*).init, OPEN_EXISTING,
FILE_ATTRIBUTE_NORMAL | FILE_FLAG_SEQUENTIAL_SCAN,
HANDLE.init)
defaults;
auto h = useWfuncs
? CreateFileW(std.utf.toUTF16z(name), defaults)
: CreateFileA(toMBSz(name), defaults);
cenforce(h != INVALID_HANDLE_VALUE, name);
scope(exit) cenforce(CloseHandle(h), name);
auto size = GetFileSize(h, null);
cenforce(size != INVALID_FILE_SIZE, name);
size = min(upTo, size);
auto buf = GC.malloc(size, GC.BlkAttr.NO_SCAN)[0 .. size];
scope(failure) delete buf;
DWORD numread = void;
cenforce(ReadFile(h,buf.ptr, size, &numread, null) == 1
&& numread == size, name);
return buf[0 .. size];
}
version(Posix) void[] read(in char[] name, in size_t upTo = size_t.max)
{
// A few internal configuration parameters {
enum size_t
minInitialAlloc = 1024 * 4,
maxInitialAlloc = size_t.max / 2,
sizeIncrement = 1024 * 16,
maxSlackMemoryAllowed = 1024;
// }
immutable fd = core.sys.posix.fcntl.open(toStringz(name),
core.sys.posix.fcntl.O_RDONLY);
cenforce(fd != -1, name);
scope(exit) core.sys.posix.unistd.close(fd);
struct_stat64 statbuf = void;
cenforce(fstat64(fd, &statbuf) == 0, name);
//cenforce(core.sys.posix.sys.stat.fstat(fd, &statbuf) == 0, name);
immutable initialAlloc = to!size_t(statbuf.st_size
? min(statbuf.st_size + 1, maxInitialAlloc)
: minInitialAlloc);
auto result = GC.malloc(initialAlloc, GC.BlkAttr.NO_SCAN)
[0 .. initialAlloc];
scope(failure) delete result;
size_t size = 0;
for (;;)
{
immutable actual = core.sys.posix.unistd.read(fd, result.ptr + size,
min(result.length, upTo) - size);
cenforce(actual != -1, name);
if (actual == 0) break;
size += actual;
if (size < result.length) continue;
immutable newAlloc = size + sizeIncrement;
result = GC.realloc(result.ptr, newAlloc, GC.BlkAttr.NO_SCAN)
[0 .. newAlloc];
}
return result.length - size >= maxSlackMemoryAllowed
? GC.realloc(result.ptr, size, GC.BlkAttr.NO_SCAN)[0 .. size]
: result[0 .. size];
}
unittest
{
write(deleteme, "1234");
scope(exit) { assert(exists(deleteme)); remove(deleteme); }
assert(read(deleteme, 2) == "12");
assert(read(deleteme) == "1234");
}
version (linux) unittest
{
// A file with "zero" length that doesn't have 0 length at all
auto s = std.file.readText("/proc/sys/kernel/osrelease");
assert(s.length > 0);
//writefln("'%s'", s);
}
/********************************************
Read and validates (using $(XREF utf, validate)) a text file. $(D S)
can be a type of array of characters of any width and constancy. No
width conversion is performed; if the width of the characters in file
$(D name) is different from the width of elements of $(D S),
validation will fail.
Returns: Array of characters read.
Throws: $(D FileException) on file error, $(D UtfException) on UTF
decoding error.
Example:
----
enforce(system("echo abc>deleteme") == 0);
scope(exit) remove("deleteme");
enforce(chomp(readText("deleteme")) == "abc");
----
*/
S readText(S = string)(in char[] name)
{
auto result = cast(S) read(name);
std.utf.validate(result);
return result;
}
unittest
{
write(deleteme, "abc\n");
scope(exit) { assert(exists(deleteme)); remove(deleteme); }
enforce(chomp(readText(deleteme)) == "abc");
}
/*********************************************
Write $(D buffer) to file $(D name).
Throws: $(D FileException) on error.
Example:
----
import std.file;
void main()
{
int[] a = [ 0, 1, 1, 2, 3, 5, 8 ];
write("filename", a);
assert(cast(int[]) read("filename") == a);
}
----
*/
version(Windows) void write(in char[] name, const void[] buffer)
{
alias TypeTuple!(GENERIC_WRITE, 0, null, CREATE_ALWAYS,
FILE_ATTRIBUTE_NORMAL | FILE_FLAG_SEQUENTIAL_SCAN,
HANDLE.init)
defaults;
auto h = useWfuncs
? CreateFileW(std.utf.toUTF16z(name), defaults)
: CreateFileA(toMBSz(name), defaults);
cenforce(h != INVALID_HANDLE_VALUE, name);
scope(exit) cenforce(CloseHandle(h), name);
DWORD numwritten;
cenforce(WriteFile(h, buffer.ptr, buffer.length, &numwritten, null) == 1
&& buffer.length == numwritten,
name);
}
version(Posix) void write(in char[] name, in void[] buffer)
{
return writeImpl(name, buffer, O_CREAT | O_WRONLY | O_TRUNC);
}
/*********************************************
Appends $(D buffer) to file $(D name).
Throws: $(D FileException) on error.
Example:
----
import std.file;
void main()
{
int[] a = [ 0, 1, 1, 2, 3, 5, 8 ];
write("filename", a);
int[] b = [ 13, 21 ];
append("filename", b);
assert(cast(int[]) read("filename") == a ~ b);
}
----
*/
version(Windows) void append(in char[] name, in void[] buffer)
{
alias TypeTuple!(GENERIC_WRITE,0,null,OPEN_ALWAYS,
FILE_ATTRIBUTE_NORMAL | FILE_FLAG_SEQUENTIAL_SCAN,HANDLE.init)
defaults;
auto h = useWfuncs
? CreateFileW(std.utf.toUTF16z(name), defaults)
: CreateFileA(toMBSz(name), defaults);
cenforce(h != INVALID_HANDLE_VALUE, name);
scope(exit) cenforce(CloseHandle(h), name);
DWORD numwritten;
cenforce(SetFilePointer(h, 0, null, FILE_END) != INVALID_SET_FILE_POINTER
&& WriteFile(h,buffer.ptr,buffer.length,&numwritten,null) == 1
&& buffer.length == numwritten,
name);
}
version(Posix) void append(in char[] name, in void[] buffer)
{
return writeImpl(name, buffer, O_APPEND | O_WRONLY | O_CREAT);
}
// Posix implementation helper for write and append
version(Posix) private void writeImpl(in char[] name,
in void[] buffer, in uint mode)
{
immutable fd = core.sys.posix.fcntl.open(toStringz(name),
mode, octal!666);
cenforce(fd != -1, name);
{
scope(failure) core.sys.posix.unistd.close(fd);
immutable size = buffer.length;
cenforce(
core.sys.posix.unistd.write(fd, buffer.ptr, size) == size,
name);
}
cenforce(core.sys.posix.unistd.close(fd) == 0, name);
}
/***************************************************
* Rename file $(D from) to $(D to).
* Throws: $(D FileException) on error.
*/
version(Windows) void rename(in char[] from, in char[] to)
{
enforce(useWfuncs
? MoveFileW(std.utf.toUTF16z(from), std.utf.toUTF16z(to))
: MoveFileA(toMBSz(from), toMBSz(to)),
new FileException(
text("Attempting to rename file ", from, " to ",
to)));
}
version(Posix) void rename(in char[] from, in char[] to)
{
cenforce(std.c.stdio.rename(toStringz(from), toStringz(to)) == 0, to);
}
/***************************************************
Delete file $(D name).
Throws: $(D FileException) on error.
*/
version(Windows) void remove(in char[] name)
{
cenforce(useWfuncs
? DeleteFileW(std.utf.toUTF16z(name))
: DeleteFileA(toMBSz(name)),
name);
}
version(Posix) void remove(in char[] name)
{
cenforce(std.c.stdio.remove(toStringz(name)) == 0, name);
}
/***************************************************
Get size of file $(D name) in bytes.
Throws: $(D FileException) on error (e.g., file not found).
*/
version(Windows) ulong getSize(in char[] name)
{
HANDLE findhndl = void;
uint resulth = void;
uint resultl = void;
const (char)[] file = name[];
//FindFirstFileX can't handle file names which end in a backslash.
if(file.endsWith(sep))
file.popBackN(sep.length);
if (useWfuncs)
{
WIN32_FIND_DATAW filefindbuf;
findhndl = FindFirstFileW(std.utf.toUTF16z(file), &filefindbuf);
resulth = filefindbuf.nFileSizeHigh;
resultl = filefindbuf.nFileSizeLow;
}
else
{
WIN32_FIND_DATA filefindbuf;
findhndl = FindFirstFileA(toMBSz(file), &filefindbuf);
resulth = filefindbuf.nFileSizeHigh;
resultl = filefindbuf.nFileSizeLow;
}
cenforce(findhndl != cast(HANDLE)-1 && FindClose(findhndl), file);
return (cast(ulong) resulth << 32) + resultl;
}
version(Posix) ulong getSize(in char[] name)
{
struct_stat64 statbuf = void;
cenforce(stat64(toStringz(name), &statbuf) == 0, name);
return statbuf.st_size;
}
unittest
{
// create a file of size 1
write(deleteme, "a");
scope(exit) { assert(exists(deleteme)); remove(deleteme); }
assert(getSize(deleteme) == 1);
// create a file of size 3
write(deleteme, "abc");
assert(getSize(deleteme) == 3);
}
/*************************
* $(RED Scheduled for deprecation. Please use getTimesWin (for Windows)
* or getTimesPosix (for Posix) instead.)
*/
version(D_Ddoc)
{
void getTimes(in char[] name,
out d_time ftc,
out d_time fta,
out d_time ftm);
}
else version(Windows)
{
void getTimes(C)(in C[] name,
out d_time ftc,
out d_time fta,
out d_time ftm)
if(is(Unqual!C == char))
{
pragma(msg, "std.file.getTimes has been scheduled for deprecation. " ~
"Please use getTimesWin (for Windows) or getTimesPosix (for Posix) "
"instead.");
HANDLE findhndl = void;
if (useWfuncs)
{
WIN32_FIND_DATAW filefindbuf;
findhndl = FindFirstFileW(std.utf.toUTF16z(name), &filefindbuf);
ftc = FILETIME2d_time(&filefindbuf.ftCreationTime);
fta = FILETIME2d_time(&filefindbuf.ftLastAccessTime);
ftm = FILETIME2d_time(&filefindbuf.ftLastWriteTime);
}
else
{
WIN32_FIND_DATA filefindbuf;
findhndl = FindFirstFileA(toMBSz(name), &filefindbuf);
ftc = FILETIME2d_time(&filefindbuf.ftCreationTime);
fta = FILETIME2d_time(&filefindbuf.ftLastAccessTime);
ftm = FILETIME2d_time(&filefindbuf.ftLastWriteTime);
}
if (findhndl == cast(HANDLE)-1)
{
throw new FileException(name.idup);
}
FindClose(findhndl);
}
}
else version(Posix)
{
void getTimes(C)(in C[] name, out d_time ftc, out d_time fta, out d_time ftm)
if(is(Unqual!C == char))
{
pragma(msg, "std.file.getTimes has been scheduled for deprecation. " ~
"Please use getTimesWin (for Windows) or getTimesPosix (for Posix) "
"instead.");
struct_stat64 statbuf = void;
cenforce(stat64(toStringz(name), &statbuf) == 0, name);
ftc = cast(d_time) statbuf.st_ctime * ticksPerSecond;
fta = cast(d_time) statbuf.st_atime * ticksPerSecond;
ftm = cast(d_time) statbuf.st_mtime * ticksPerSecond;
}
}
else
static assert(0, "Unsupported/Unknown OS");
version(D_Ddoc)
{
/++
$(BLUE This function is Windows-Only.)
Get creation/access/modified times of file $(D name).
Note that the Windows and Posix versions of getTimesX differ
because Posix has no file creation time whereas Windows
has no file status changed time.
Params:
name = File name to get times for.
fileCreationTime = Time the file was created.
fileAccessTime = Time the file was last accessed.
fileModificationTime = Time the file was last modified.
Throws:
$(D FileException) on error.
+/
void getTimesWin(in char[] name,
out SysTime fileCreationTime,
out SysTime fileAccessTime,
out SysTime fileModificationTime);
/++
$(BLUE This function is Posix-Only.)
Get file status change time, acces time, and modification times
of file $(D name).
Note that the Windows and Posix versions of getTimesX differ
because Posix has no file creation time whereas Windows
has no file status changed time.
Params:
name = File name to get times for.
fileStatusChangeTime = Time the file's status was last changed.
fileAccessTime = Time the file was last accessed.
fileModificationTime = Time the file was last modified.
Throws:
$(D FileException) on error.
+/
version(Posix) void getTimesPosix(in char[] name,
out SysTime fileStatusChangeTime,
out SysTime fileAccessTime,
out SysTime fileModificationTime);
}
else version(Windows)
{
void getTimesWin(in char[] name,
out SysTime fileCreationTime,
out SysTime fileAccessTime,
out SysTime fileModificationTime)
{
HANDLE findhndl = void;
if (useWfuncs)
{
WIN32_FIND_DATAW filefindbuf;
findhndl = FindFirstFileW(std.utf.toUTF16z(name), &filefindbuf);
fileCreationTime = std.datetime.FILETIMEToSysTime(&filefindbuf.ftCreationTime);
fileAccessTime = std.datetime.FILETIMEToSysTime(&filefindbuf.ftLastAccessTime);
fileModificationTime = std.datetime.FILETIMEToSysTime(&filefindbuf.ftLastWriteTime);
}
else
{
WIN32_FIND_DATA filefindbuf;
findhndl = FindFirstFileA(toMBSz(name), &filefindbuf);
fileCreationTime = std.datetime.FILETIMEToSysTime(&filefindbuf.ftCreationTime);
fileAccessTime = std.datetime.FILETIMEToSysTime(&filefindbuf.ftLastAccessTime);
fileModificationTime = std.datetime.FILETIMEToSysTime(&filefindbuf.ftLastWriteTime);
}
if(findhndl == cast(HANDLE)-1)
{
throw new FileException(name.idup);
}
FindClose(findhndl);
}
unittest
{
version(Windows)
{
auto currTime = Clock.currTime();
write(deleteme, "a");
scope(exit) { assert(exists(deleteme)); remove(deleteme); }
SysTime creationTime1 = void;
SysTime accessTime1 = void;
SysTime modificationTime1 = void;
getTimesWin(deleteme, creationTime1, accessTime1, modificationTime1);
enum leeway = dur!"seconds"(2);
{
auto diffc = creationTime1 - currTime;
auto diffa = accessTime1 - currTime;
auto diffm = modificationTime1 - currTime;
assert(abs(diffc) <= leeway);
assert(abs(diffa) <= leeway);
assert(abs(diffm) <= leeway);
}
Thread.sleep(dur!"seconds"(1));
currTime = Clock.currTime();
write(deleteme, "b");
SysTime creationTime2 = void;
SysTime accessTime2 = void;
SysTime modificationTime2 = void;
getTimesWin(deleteme, creationTime2, accessTime2, modificationTime2);
{
auto diffa = accessTime2 - currTime;
auto diffm = modificationTime2 - currTime;
assert(abs(diffa) <= leeway);
assert(abs(diffm) <= leeway);
}
assert(creationTime1 <= creationTime2);
assert(accessTime1 <= accessTime2);
assert(modificationTime1 <= modificationTime2);
}
}
}
else version(Posix)
{
void getTimesPosix(in char[] name,
out SysTime fileStatusChangeTime,
out SysTime fileAccessTime,
out SysTime fileModificationTime)
{
struct_stat64 statbuf = void;
cenforce(stat64(toStringz(name), &statbuf) == 0, name);
fileStatusChangeTime = SysTime(unixTimeToStdTime(statbuf.st_ctime));
fileAccessTime = SysTime(unixTimeToStdTime(statbuf.st_atime));
fileModificationTime = SysTime(unixTimeToStdTime(statbuf.st_mtime));
}
unittest
{
auto currTime = Clock.currTime();
write(deleteme, "a");
scope(exit) { assert(exists(deleteme)); remove(deleteme); }
SysTime statusChangedTime1 = void;
SysTime accessTime1 = void;
SysTime modificationTime1 = void;
getTimesPosix(deleteme, statusChangedTime1, accessTime1, modificationTime1);
enum leeway = dur!"seconds"(2);
{
auto diffc = statusChangedTime1 - currTime;
auto diffa = accessTime1 - currTime;
auto diffm = modificationTime1 - currTime;
assert(abs(diffc) <= leeway);
assert(abs(diffa) <= leeway);
assert(abs(diffm) <= leeway);
}
Thread.sleep(dur!"seconds"(1));
currTime = Clock.currTime();
write(deleteme, "b");
SysTime statusChangedTime2 = void;
SysTime accessTime2 = void;
SysTime modificationTime2 = void;
getTimesPosix(deleteme, statusChangedTime2, accessTime2, modificationTime2);
{
auto diffc = statusChangedTime2 - currTime;
auto diffa = accessTime2 - currTime;
auto diffm = modificationTime2 - currTime;
assert(abs(diffc) <= leeway);
assert(abs(diffa) <= leeway);
assert(abs(diffm) <= leeway);
}
assert(statusChangedTime1 <= statusChangedTime2);
assert(accessTime1 <= accessTime2);
assert(modificationTime1 <= modificationTime2);
}
}
else
static assert(0, "Unsupported/Unknown OS");
version(D_Ddoc)
{
/++
$(RED Scheduled for deprecation. Please use
$(XREF file,timeLastModified) instead.)
+/
d_time lastModified(in char[] name);
}
else
{
d_time lastModified(C)(in C[] name)
if(is(Unqual!C == char))
{
pragma(msg, "std.file.lastModified has been scheduled for deprecation. " ~
"Please use timeLastModified instead.");
version(Windows)
{
d_time dummy = void, ftm = void;
getTimes(name, dummy, dummy, ftm);
return ftm;
}
else version(Posix)
{
struct_stat64 statbuf = void;
cenforce(stat64(toStringz(name), &statbuf) == 0, name);
return cast(d_time) statbuf.st_mtime * ticksPerSecond;
}
else
static assert(0, "Unsupported/Unknown OS");
}
}
version(D_Ddoc)
{
/++
$(RED Scheduled for deprecation. Please use timeLastModified instead.)
+/
d_time lastModified(in char[] name, d_time returnIfMissing);
}
else version(Windows)
{
d_time lastModified(C)(in C[] name, d_time returnIfMissing)
if(is(Unqual!C == char))
{
pragma(msg, "std.file.lastModified has been scheduled for deprecation. " ~
"Please use timeLastModified instead.");
version(Windows)
{
if (!exists(name)) return returnIfMissing;
d_time dummy = void, ftm = void;
getTimes(name, dummy, dummy, ftm);
return ftm;
}
else version(Posix)
{
struct_stat64 statbuf = void;
return stat64(toStringz(name), &statbuf) != 0
? returnIfMissing
: cast(d_time) statbuf.st_mtime * ticksPerSecond;
}
else
static assert(0, "Unsupported/Unknown OS");
}
}
unittest
{
//std.process.system("echo a>deleteme") == 0 || assert(false);
if (exists(deleteme)) remove(deleteme);
write(deleteme, "a\n");
scope(exit) { assert(exists(deleteme)); remove(deleteme); }
// assert(lastModified("deleteme") >
// lastModified("this file does not exist", d_time.min));
//assert(lastModified("deleteme") > lastModified(__FILE__));
}
/++
Returns the time that the given file was last modified.
Throws:
$(D FileException) if the given file does not exist.
+/
SysTime timeLastModified(in char[] name)
{
version(Windows)
{
SysTime dummy = void;
SysTime ftm = void;
getTimesWin(name, dummy, dummy, ftm);
return ftm;
}
else version(Posix)
{
struct_stat64 statbuf = void;
cenforce(stat64(toStringz(name), &statbuf) == 0, name);
return SysTime(unixTimeToStdTime(statbuf.st_mtime));
}
else
static assert(0, "Unsupported/Unknown OS");
}
/++
Returns the time that the given file was last modified. If the
file does not exist, returns $(D returnIfMissing).
A frequent usage pattern occurs in build automation tools such as
$(WEB gnu.org/software/make, make) or $(WEB
en.wikipedia.org/wiki/Apache_Ant, ant). To check whether file $(D
target) must be rebuilt from file $(D source) (i.e., $(D target) is
older than $(D source) or does not exist), use the comparison
below. The code throws a $(D FileException) if $(D source) does not
exist (as it should). On the other hand, the $(D SysTime.min) default
makes a non-existing $(D target) seem infinitely old so the test
correctly prompts building it.
Params:
name = The name of the file to get the modification time for.
returnIfMissing = The time to return if the given file does not exist.
Examples:
--------------------
if(timeLastModified(source) >= timeLastModified(target, SysTime.min))
{
// must (re)build
}
else
{
// target is up-to-date
}
--------------------
+/
SysTime timeLastModified(in char[] name, SysTime returnIfMissing)
{
version(Windows)
{
if(!exists(name))
return returnIfMissing;
SysTime dummy = void;
SysTime ftm = void;
getTimesWin(name, dummy, dummy, ftm);
return ftm;
}
else version(Posix)
{
struct_stat64 statbuf = void;
return stat64(toStringz(name), &statbuf) != 0 ?
returnIfMissing :
SysTime(unixTimeToStdTime(statbuf.st_mtime));
}
else
static assert(0, "Unsupported/Unknown OS");
}
unittest
{
//std.process.system("echo a > deleteme") == 0 || assert(false);
if(exists(deleteme))
remove(deleteme);
write(deleteme, "a\n");
scope(exit)
{
assert(exists(deleteme));
remove(deleteme);
}
// assert(lastModified("deleteme") >
// lastModified("this file does not exist", SysTime.min));
//assert(lastModified("deleteme") > lastModified(__FILE__));
}
/++
Returns whether the given file (or directory) exists.
+/
@property bool exists(in char[] name)
{
version(Windows)
{
auto result = useWfuncs
// http://msdn.microsoft.com/library/default.asp?url=/library/en-us/
// fileio/base/getfileattributes.asp
? GetFileAttributesW(std.utf.toUTF16z(name))
: GetFileAttributesA(toMBSz(name));
return result != 0xFFFFFFFF;
}
else version(Posix)
{
return access(toStringz(name), 0) == 0;
}
else
static assert(0, "Unsupported/Unknown OS");
}
unittest
{
assert(exists("."));
assert(!exists("this file does not exist"));
write(deleteme, "a\n");
scope(exit) { assert(exists(deleteme)); remove(deleteme); }
assert(exists(deleteme));
}
/++
Returns the attributes of the given file.
Note that the file attributes on Windows and Posix systems are
completely different. On Windows, they're what is returned by $(WEB
msdn.microsoft.com/en-us/library/aa364944(v=vs.85).aspx,
GetFileAttributes), whereas on Posix systems, they're the $(LUCKY
st_mode) value which is part of the $(D stat struct) gotten by
calling the $(WEB en.wikipedia.org/wiki/Stat_%28Unix%29, $(D stat))
function.
On Posix systems, if the given file is a symbolic link, then
attributes are the attributes of the file pointed to by the symbolic
link.
Params:
name = The file to get the attributes of.
+/
uint getAttributes(in char[] name)
{
version(Windows)
{
auto result = useWfuncs ?
GetFileAttributesW(std.utf.toUTF16z(name)) :
GetFileAttributesA(toMBSz(name));
enforce(result != uint.max, new FileException(name.idup));
return result;
}
else version(Posix)
{
struct_stat64 statbuf = void;
cenforce(stat64(toStringz(name), &statbuf) == 0, name);
return statbuf.st_mode;
}
else
static assert(0, "Unsupported/Unknown OS");
}
version(D_Ddoc)
{
/++
If the given file is a symbolic link, then this returns the attributes of the
symbolic link itself rather than file that it points to. If the given file
is $(I not) a symbolic link, then this function returns the same result
as getAttributes.
On Windows, getLinkAttributes is identical to getAttributes. It exists on
Windows so that you don't have to special-case code for Windows when dealing
with symbolic links.
Params:
name = The file to get the symbolic link attributes of.
Throws:
FileException on error.
+/
uint getLinkAttributes(in char[] name);
}
else
{
uint getLinkAttributes(in char[] name)
{
version(Windows)
{
return getAttributes(name);
}
else version(OSX)
{
struct_stat64 lstatbuf = void;
cenforce(stat64(toStringz(name), &lstatbuf) == 0, name);
return lstatbuf.st_mode;
}
else version(Posix)
{
struct_stat64 lstatbuf = void;
cenforce(lstat64(toStringz(name), &lstatbuf) == 0, name);
return lstatbuf.st_mode;
}
else
static assert(0, "Unsupported/Unknown OS");
}
}
/++
Returns whether the given file is a directory.
Params:
name = The path to the file.
Throws:
FileException if the given file does not exist.
Examples:
--------------------
assert(!"/etc/fonts/fonts.conf".isDir);
assert("/usr/share/include".isDir);
--------------------
+/
@property bool isDir(in char[] name)
{
version(Windows)
{
return (getAttributes(name) & FILE_ATTRIBUTE_DIRECTORY) != 0;
}
else version(Posix)
{
return (getAttributes(name) & S_IFMT) == S_IFDIR;
}
else
static assert(0, "Unsupported/Unknown OS");
}
unittest
{
version(Windows)
{
if("C:\\Program Files\\".exists)
assert("C:\\Program Files\\".isDir);
if("C:\\Windows\\system.ini".exists)
assert(!"C:\\Windows\\system.ini".isDir);
}
else version(Posix)
{
if("/usr/include".exists)
assert("/usr/include".isDir);
if("/usr/include/assert.h".exists)
assert(!"/usr/include/assert.h".isDir);
}
else
static assert(0, "Unsupported/Unknown OS");
}
/++
Returns whether the given file attributes are for a directory.
Params:
attributes = The file attributes.
Examples:
--------------------
assert(!getAttributes("/etc/fonts/fonts.conf").isDir);
assert(!getLinkAttributes("/etc/fonts/fonts.conf").isDir);
--------------------
+/
@property bool isDir(uint attributes) nothrow
{
version(Windows)
{
return (attributes & FILE_ATTRIBUTE_DIRECTORY) != 0;
}
else version(Posix)
{
return (attributes & S_IFMT) == S_IFDIR;
}
else
static assert(0, "Unsupported/Unknown OS");
}
unittest
{
version(Windows)
{
if("C:\\Program Files\\".exists)
{
assert(isDir(getAttributes("C:\\Program Files\\")));
assert(isDir(getLinkAttributes("C:\\Program Files\\")));
}
if("C:\\Windows\\system.ini".exists)
{
assert(!isDir(getAttributes("C:\\Windows\\system.ini")));
assert(!isDir(getLinkAttributes("C:\\Windows\\system.ini")));
}
}
else version(Posix)
{
if("/usr/include".exists)
{
assert(isDir(getAttributes("/usr/include")));
assert(isDir(getLinkAttributes("/usr/include")));
}
if("/usr/include/assert.h".exists)
{
assert(!isDir(getAttributes("/usr/include/assert.h")));
assert(!isDir(getLinkAttributes("/usr/include/assert.h")));
}
}
else
static assert(0, "Unsupported/Unknown OS");
}
/++
$(RED Scheduled for deprecation. Please use isDir instead.)
+/
alias isDir isdir;
/++
Returns whether the given file (or directory) is a file.
On Windows, if a file is not a directory, then it's a file. So,
either isFile or isDir will return true for any given file.
On Posix systems, if isFile is true, that indicates that the file is
a regular file (e.g. not a block not device). So, on Posix systems,
it's possible for both isFile and isDir to be false for a particular
file (in which case, it's a special file). You can use getAttributes
to get the attributes to figure out what type of special it is, or
you can use dirEntry to get at its statBuf, which is the result from
stat. In either case, see the stat man page for more details.
Params:
name = The path to the file.
Throws:
FileException if the given file does not exist.
Examples:
--------------------
assert("/etc/fonts/fonts.conf".isFile);
assert(!"/usr/share/include".isFile);
--------------------
+/
@property bool isFile(in char[] name)
{
version(Windows)
{
return !name.isDir;
}
else version(Posix)
{
return (getAttributes(name) & S_IFMT) == S_IFREG;
}
else
static assert(0, "Unsupported/Unknown OS");
}
unittest
{
version(Windows)
{
if("C:\\Program Files\\".exists)
assert(!"C:\\Program Files\\".isFile);
if("C:\\Windows\\system.ini".exists)
assert("C:\\Windows\\system.ini".isFile);
}
else version(Posix)
{
if("/usr/include".exists)
assert(!"/usr/include".isFile);
if("/usr/include/assert.h".exists)
assert("/usr/include/assert.h".isFile);
}
else
static assert(0, "Unsupported/Unknown OS");
}
/++
Returns whether the given file attributes are for a file.
On Windows, if a file is not a directory, it's a file. So,
either isFile or isDir will return true for any given file.
On Posix systems, if isFile is true, that indicates that the file is
a regular file (e.g. not a block not device). So, on Posix systems,
it's possible for both isFile and isDir to be false for a particular
file (in which case, it's a special file). If a file is a special
file, you can use the attributes to check what type of special
file it is (see the stat man page for more information).
Params:
attributes = The file attributes.
Examples:
--------------------
assert(getAttributes("/etc/fonts/fonts.conf").isFile);
assert(getLinkAttributes("/etc/fonts/fonts.conf").isFile);
--------------------
+/
@property bool isFile(uint attributes) nothrow
{
version(Windows)
{
return (attributes & FILE_ATTRIBUTE_DIRECTORY) == 0;
}
else version(Posix)
{
return (attributes & S_IFMT) == S_IFREG;
}
else
static assert(0, "Unsupported/Unknown OS");
}
unittest
{
version(Windows)
{
if("C:\\Program Files\\".exists)
{
assert(!isFile(getAttributes("C:\\Program Files\\")));
assert(!isFile(getLinkAttributes("C:\\Program Files\\")));
}
if("C:\\Windows\\system.ini".exists)
{
assert(isFile(getAttributes("C:\\Windows\\system.ini")));
assert(isFile(getLinkAttributes("C:\\Windows\\system.ini")));
}
}
else version(Posix)
{
if("/usr/include".exists)
{
assert(!isFile(getAttributes("/usr/include")));
assert(!isFile(getLinkAttributes("/usr/include")));
}
if("/usr/include/assert.h".exists)
{
assert(isFile(getAttributes("/usr/include/assert.h")));
assert(isFile(getLinkAttributes("/usr/include/assert.h")));
}
}
else
static assert(0, "Unsupported/Unknown OS");
}
/++
$(RED Scheduled for deprecation. Please use isFile instead.)
Same is isFile.
+/
alias isFile isfile;
/++
Returns whether the given file is a symbolic link.
Always return false on Windows. It exists on Windows so that you don't
have to special-case code for Windows when dealing with symbolic links.
Params:
name = The path to the file.
Throws:
FileException if the given file does not exist.
+/
@property bool isSymLink(in char[] name)
{
version(Windows)
{
return false;
}
else version(Posix)
{
return (getLinkAttributes(name) & S_IFMT) == S_IFLNK;
}
else
static assert(0, "Unsupported/Unknown OS");
}
unittest
{
version(Windows)
{
if("C:\\Program Files\\".exists)
assert(!"C:\\Program Files\\".isSymLink);
enum fakeSymFile = "C:\\Windows\\system.ini";
if(fakeSymFile.exists)
{
assert(!fakeSymFile.isSymLink);
assert(!fakeSymFile.isSymLink);
assert(!isSymLink(getAttributes(fakeSymFile)));
assert(!isSymLink(getLinkAttributes(fakeSymFile)));
assert(isFile(getAttributes(fakeSymFile)));
assert(isFile(getLinkAttributes(fakeSymFile)));
assert(!isDir(getAttributes(fakeSymFile)));
assert(!isDir(getLinkAttributes(fakeSymFile)));
assert(getAttributes(fakeSymFile) == getLinkAttributes(fakeSymFile));
}
}
else version(OSX)
{
}
else version(Posix)
{
if("/usr/include".exists)
{
assert(!"/usr/include".isSymLink);
immutable symfile = deleteme ~ "_slink\0";
scope(exit) if(symfile.exists) symfile.remove();
core.sys.posix.unistd.symlink("/usr/include", symfile.ptr);
assert(symfile.isSymLink);
assert(!isSymLink(getAttributes(symfile)));
assert(isSymLink(getLinkAttributes(symfile)));
assert(isDir(getAttributes(symfile)));
assert(!isDir(getLinkAttributes(symfile)));
assert(!isFile(getAttributes(symfile)));
assert(!isFile(getLinkAttributes(symfile)));
}
if("/usr/include/assert.h".exists)
{
assert(!"/usr/include/assert.h".isSymLink);
immutable symfile = deleteme ~ "_slink\0";
scope(exit) if(symfile.exists) symfile.remove();
core.sys.posix.unistd.symlink("/usr/include/assert.h", symfile.ptr);
assert(symfile.isSymLink);
assert(!isSymLink(getAttributes(symfile)));
assert(isSymLink(getLinkAttributes(symfile)));
assert(!isDir(getAttributes(symfile)));
assert(!isDir(getLinkAttributes(symfile)));
assert(isFile(getAttributes(symfile)));
assert(!isFile(getLinkAttributes(symfile)));
}
}
else
static assert(0, "Unsupported/Unknown OS");
}
/++
Returns whether the given file attributes are for a symbolic link.
Always return false on Windows. It exists on Windows so that you don't
have to special-case code for Windows when dealing with symbolic links.
Params:
attributes = The file attributes.
Examples:
--------------------
core.sys.posix.unistd.symlink("/etc/fonts/fonts.conf", "/tmp/alink");
assert(!getAttributes("/tmp/alink").isSymLink);
assert(getLinkAttributes("/tmp/alink").isSymLink);
--------------------
+/
@property bool isSymLink(uint attributes) nothrow
{
version(Windows)
{
return false;
}
else version(Posix)
{
return (attributes & S_IFMT) == S_IFLNK;
}
else
static assert(0, "Unsupported/Unknown OS");
}
/****************************************************
* Change directory to $(D pathname).
* Throws: $(D FileException) on error.
*/
version(Windows) void chdir(in char[] pathname)
{
enforce(useWfuncs
? SetCurrentDirectoryW(std.utf.toUTF16z(pathname))
: SetCurrentDirectoryA(toMBSz(pathname)),
new FileException(pathname.idup));
}
version(Posix) void chdir(in char[] pathname)
{
cenforce(core.sys.posix.unistd.chdir(toStringz(pathname)) == 0,
pathname);
}
/****************************************************
Make directory $(D pathname).
Throws: $(D FileException) on error.
*/
version(Windows) void mkdir(in char[] pathname)
{
enforce(useWfuncs
? CreateDirectoryW(std.utf.toUTF16z(pathname), null)
: CreateDirectoryA(toMBSz(pathname), null),
new FileException(pathname.idup));
}
version(Posix) void mkdir(in char[] pathname)
{
cenforce(core.sys.posix.sys.stat.mkdir(toStringz(pathname), 0777) == 0,
pathname);
}
/****************************************************
* Make directory and all parent directories as needed.
*/
void mkdirRecurse(in char[] pathname)
{
const left = dirname(pathname);
if (!exists(left))
{
version (Windows)
{ /* Prevent infinite recursion if left is "d:\" and
* drive d does not exist.
*/
if (left.length >= 3 && left[$ - 2] == ':')
throw new FileException(left.idup);
}
mkdirRecurse(left);
}
if (!basename(pathname).empty)
{
mkdir(pathname);
}
}
unittest
{
// bug3570
{
immutable basepath = deleteme ~ "_dir";
version (Windows)
{
immutable path = basepath ~ `\fake\here\`;
}
else version (Posix)
{
immutable path = basepath ~ `/fake/here/`;
}
mkdirRecurse(path);
assert(basepath.exists && basepath.isDir);
scope(exit) rmdirRecurse(basepath);
assert(path.exists && path.isDir);
}
}
/****************************************************
Remove directory $(D pathname).
Throws: $(D FileException) on error.
*/
version(Windows) void rmdir(in char[] pathname)
{
cenforce(useWfuncs
? RemoveDirectoryW(std.utf.toUTF16z(pathname))
: RemoveDirectoryA(toMBSz(pathname)),
pathname);
}
version(Posix) void rmdir(in char[] pathname)
{
cenforce(core.sys.posix.unistd.rmdir(toStringz(pathname)) == 0,
pathname);
}
/****************************************************
* Get current directory.
* Throws: $(D FileException) on error.
*/
version(Windows) string getcwd()
{
// A bit odd API: calling GetCurrentDirectory(0, null) returns
// length including the \0, whereas calling with non-zero
// params returns length excluding the \0.
if (useWfuncs)
{
auto dir =
new wchar[enforce(GetCurrentDirectoryW(0, null), "getcwd")];
dir = dir[0 .. GetCurrentDirectoryW(dir.length, dir.ptr)];
cenforce(dir.length, "getcwd");
return to!string(dir);
}
else
{
auto dir =
new char[enforce(GetCurrentDirectoryA(0, null), "getcwd")];
dir = dir[0 .. GetCurrentDirectoryA(dir.length, dir.ptr)];
cenforce(dir.length, "getcwd");
return assumeUnique(dir);
}
}
version(Posix) string getcwd()
{
auto p = cenforce(core.sys.posix.unistd.getcwd(null, 0),
"cannot get cwd");
scope(exit) std.c.stdlib.free(p);
return p[0 .. std.c.string.strlen(p)].idup;
}
unittest
{
auto s = getcwd();
assert(s.length);
}
version(D_Ddoc)
{
/++
Info on a file, similar to what you'd get from stat on a Posix system.
A DirEntry is obtained by using the functions dirEntry (to get the DirEntry
for a specific file) or dirEntries (to get a DirEntry for each file/directory
in a particular directory).
+/
struct DirEntry
{
void _init(T...)(T);
public:
/++
Returns the path to the file represented by this DirEntry.
Examples:
--------------------
auto de1 = dirEntry("/etc/fonts/fonts.conf");
assert(de1.name == "/etc/fonts/fonts.conf");
auto de2 = dirEntry("/usr/share/include");
assert(de2.name == "/usr/share/include");
--------------------
+/
@property string name() const;
/++
Returns whether the file represented by this DirEntry is a directory.
Examples:
--------------------
auto de1 = dirEntry("/etc/fonts/fonts.conf");
assert(!de1.isDir);
auto de2 = dirEntry("/usr/share/include");
assert(de2.isDir);
--------------------
+/
@property bool isDir();
/++
$(RED Scheduled for deprecation. Please use isDir instead.)
Same as isdir.
+/
alias isDir isdir;
/++
Returns whether the file represented by this DirEntry is a file.
On Windows, if a file is not a directory, then it's a file. So,
either isFile or isDir will return true.
On Posix systems, if isFile is true, that indicates that the file is
a regular file (e.g. not a block not device). So, on Posix systems,
it's possible for both isFile and isDir to be false for a particular
file (in which case, it's a special file). You can use attributes
or statBuf to get more information about a special file (see the
stat man page for more details).
Examples:
--------------------
auto de1 = dirEntry("/etc/fonts/fonts.conf");
assert(de1.isFile);
auto de2 = dirEntry("/usr/share/include");
assert(!de2.isFile);
--------------------
+/
@property bool isFile();
/++
$(RED Scheduled for deprecation. Please use isFile instead.)
Same as isfile.
+/
alias isFile isfile;
/++
Returns whether the file represented by this DirEntry is a symbol link.
Always return false on Windows. It exists on Windows so that you don't
have to special-case code for Windows when dealing with symbolic links.
+/
@property bool isSymLink();
/++
Returns the size of the the file represented by this DirEntry in bytes.
+/
@property ulong size();
/++
$(RED Scheduled for deprecation. Please use timeCreated instead.)
Returns the creation time of the file represented by this DirEntry.
$(RED Note that this property has existed for both Windows and Posix systems
but that it is $(I incorrect) on Posix systems. Posix systems do not have
access to the creation time of a file. On Posix systems this property
has incorrectly been the time that the file's status status last changed.
If you want that value, use timeStatusChanged.)
+/
@property d_time creationTime() const;
/++
$(BLUE This function is Windows-Only.)
Returns the creation time of the file represented by this DirEntry.
+/
@property SysTime timeCreated() const;
/++
$(BLUE This function is Posix-Only.)
Returns the last time that the status of file represented by this DirEntry
was changed (i.e. owner, group, link count, mode, etc.).
+/
@property SysTime timeStatusChanged();
/++
$(RED Scheduled for deprecation. Please use timeLastAccessed instead.)
Returns the time that the file represented by this DirEntry was last accessed.
Note that many file systems do not update the access time for files (generally
for performance reasons), so there's a good chance that lastAccessTime will
return the same value as lastWriteTime.
+/
@property d_time lastAccessTime();
/++
Returns the time that the file represented by this DirEntry was last accessed.
Note that many file systems do not update the access time for files (generally
for performance reasons), so there's a good chance that timeLastAccessed will
return the same value as timeLastModified.
+/
@property SysTime timeLastAccessed();
/++
$(RED Scheduled for deprecation. Please use timeLastAccessed instead.)
Returns the time that the file represented by this DirEntry was last modified.
+/
@property d_time lastWriteTime();
/++
Returns the time that the file represented by this DirEntry was last modified.
+/
@property SysTime timeLastModified();
/++
Returns the attributes of the file represented by this DirEntry.
Note that the file attributes on Windows and Posix systems are completely
different. On, Windows, they're what is returned by GetFileAttributes
<a href="http://msdn.microsoft.com/en-us/library/aa364944(v=vs.85).aspx">GetFileAttributes</a>.
Whereas, an Posix systems, they're the st_mode value which is part of the
stat struct gotten by calling stat.
On Posix systems, if the file represented by this DirEntry is a symbolic link,
then attributes are the attributes of the file pointed to by the symbolic link.
+/
@property uint attributes();
/++
On Posix systems, if the file represented by this DirEntry is a symbolic link,
then linkAttributes are the attributes of the symbolic link itself. Otherwise,
linkAttributes is identical to attributes.
On Windows, linkAttributes is identical to attributes. It exists on
Windows so that you don't have to special-case code for Windows when dealing
with symbolic links.
+/
@property uint linkAttributes();
version(Windows) alias void* struct_stat64;
/++
$(BLUE This function is Posix-Only.)
The stat struct gotten from calling stat.
+/
@property struct_stat64 statBuf();
}
}
else version(Windows)
{
struct DirEntry
{
public:
void init(C)(in C[] path)
if(is(Unqual!C == char))
{
pragma(msg, "std.file.DirEntry.init has been scheduled for deprecation. " ~
"It was not documented before, and you shouldn't need it. " ~
"Just use std.file.dirEntry to get a DirEntry for an arbitrary file.");
_init(path);
}
void init(C)(in C[] path, in WIN32_FIND_DATA* fd)
if(is(Unqual!C == char))
{
pragma(msg, "std.file.DirEntry.init has been scheduled for deprecation. " ~
"It was not documented before, and you shouldn't need it. " ~
"Just use std.file.dirEntry to get a DirEntry for an arbitrary file.");
_init(path, fd);
}
void init(C)(in C[] path, in WIN32_FIND_DATAW* fd)
if(is(Unqual!C == char))
{
pragma(msg, "std.file.DirEntry.init has been scheduled for deprecation. " ~
"It was not documented before, and you shouldn't need it. " ~
"Just use std.file.dirEntry to get a DirEntry for an arbitrary file.");
_init(path, fd);
}
@property string name() const
{
return _name;
}
@property bool isDir() const
{
return (attributes & FILE_ATTRIBUTE_DIRECTORY) != 0;
}
alias isDir isdir;
@property bool isFile() const
{
//Are there no options in Windows other than directory and file?
//If there are, then this probably isn't the best way to determine
//whether this DirEntry is a file or not.
return !isDir;
}
alias isFile isfile;
@property bool isSymLink() const
{
return false;
}
@property ulong size() const
{
return _size;
}
@property d_time creationTime() const
{
return sysTimeToDTime(_timeCreated);
}
@property SysTime timeCreated() const
{
return cast(SysTime)_timeCreated;
}
@property d_time lastAccessTime() const
{
return sysTimeToDTime(_timeLastAccessed);
}
@property SysTime timeLastAccessed() const
{
return cast(SysTime)_timeLastAccessed;
}
@property d_time lastWriteTime() const
{
return sysTimeToDTime(_timeLastModified);
}
@property SysTime timeLastModified() const
{
return cast(SysTime)_timeLastModified;
}
@property uint attributes() const
{
return _attributes;
}
@property uint linkAttributes() const
{
return _attributes;
}
private:
void _init(in char[] path)
{
HANDLE findhndl = void;
uint resulth = void;
uint resultl = void;
_name = path.idup;
//FindFirstFileX can't handle file names which end in a backslash.
if(_name.endsWith(sep))
_name.popBackN(sep.length);
if(useWfuncs)
{
WIN32_FIND_DATAW fd;
findhndl = FindFirstFileW(std.utf.toUTF16z(_name), &fd);
enforce(findhndl != INVALID_HANDLE_VALUE);
_size = (cast(ulong)fd.nFileSizeHigh << 32) | fd.nFileSizeLow;
_timeCreated = std.datetime.FILETIMEToSysTime(&fd.ftCreationTime);
_timeLastAccessed = std.datetime.FILETIMEToSysTime(&fd.ftLastAccessTime);
_timeLastModified = std.datetime.FILETIMEToSysTime(&fd.ftLastWriteTime);
_attributes = fd.dwFileAttributes;
}
else
{
WIN32_FIND_DATA fd;
findhndl = FindFirstFileA(toMBSz(_name), &fd);
enforce(findhndl != INVALID_HANDLE_VALUE);
_size = (cast(ulong)fd.nFileSizeHigh << 32) | fd.nFileSizeLow;
_timeCreated = std.datetime.FILETIMEToSysTime(&fd.ftCreationTime);
_timeLastAccessed = std.datetime.FILETIMEToSysTime(&fd.ftLastAccessTime);
_timeLastModified = std.datetime.FILETIMEToSysTime(&fd.ftLastWriteTime);
_attributes = fd.dwFileAttributes;
}
cenforce(findhndl != cast(HANDLE)-1 && FindClose(findhndl), _name);
}
void _init(in char[] path, in WIN32_FIND_DATA* fd)
{
auto clength = std.c.string.strlen(fd.cFileName.ptr);
// Convert cFileName[] to unicode
const wlength = MultiByteToWideChar(0, 0, fd.cFileName.ptr, clength, null, 0);
auto wbuf = new wchar[wlength];
const n = MultiByteToWideChar(0, 0, fd.cFileName.ptr, clength, wbuf.ptr, wlength);
assert(n == wlength);
// toUTF8() returns a new buffer
_name = std.path.join(path, std.utf.toUTF8(wbuf[0 .. wlength]));
_size = (cast(ulong)fd.nFileSizeHigh << 32) | fd.nFileSizeLow;
_timeCreated = std.datetime.FILETIMEToSysTime(&fd.ftCreationTime);
_timeLastAccessed = std.datetime.FILETIMEToSysTime(&fd.ftLastAccessTime);
_timeLastModified = std.datetime.FILETIMEToSysTime(&fd.ftLastWriteTime);
_attributes = fd.dwFileAttributes;
}
void _init(in char[] path, in WIN32_FIND_DATAW *fd)
{
size_t clength = std.string.wcslen(fd.cFileName.ptr);
_name = std.utf.toUTF8(fd.cFileName[0 .. clength]);
_name = std.path.join(path, std.utf.toUTF8(fd.cFileName[0 .. clength]));
_size = (cast(ulong)fd.nFileSizeHigh << 32) | fd.nFileSizeLow;
_timeCreated = std.datetime.FILETIMEToSysTime(&fd.ftCreationTime);
_timeLastAccessed = std.datetime.FILETIMEToSysTime(&fd.ftLastAccessTime);
_timeLastModified = std.datetime.FILETIMEToSysTime(&fd.ftLastWriteTime);
_attributes = fd.dwFileAttributes;
}
string _name; /// The file or directory represented by this DirEntry.
SysTime _timeCreated; /// The time when the file was created.
SysTime _timeLastAccessed; /// The time when the file was last accessed.
SysTime _timeLastModified; /// The time when the file was last modified.
ulong _size; /// The size of the file in bytes.
uint _attributes; /// The file attributes from WIN32_FIND_DATAW.
}
}
else version(Posix)
{
struct DirEntry
{
public:
void init(C)(in C[] path)
if(is(Unqual!C == char))
{
pragma(msg, "std.file.DirEntry.init has been scheduled for deprecation. " ~
"It was not documented before, and you shouldn't need it. " ~
"Just use std.file.dirEntry to get a DirEntry for an arbitrary file.");
_init(path);
}
void init(C)(in C[] path, core.sys.posix.dirent.dirent* fd)
if(is(Unqual!C == char))
{
pragma(msg, "std.file.DirEntry.init has been scheduled for deprecation. " ~
"It was not documented before, and you shouldn't need it. " ~
"Just use std.file.dirEntry to get a DirEntry for an arbitrary file.");
_init(path, fd);
}
@property string name() const
{
return _name;
}
@property bool isDir()
{
_ensureStatDone();
return (_statBuf.st_mode & S_IFMT) == S_IFDIR;
}
alias isDir isdir;
@property bool isFile()
{
_ensureStatDone();
return (_statBuf.st_mode & S_IFMT) == S_IFREG;
}
alias isFile isfile;
@property bool isSymLink()
{
_ensureLStatDone();
return (_lstatMode & S_IFMT) == S_IFLNK;
}
// This property was not documented before, and it's almost
// worthless, since the odds are high that it will be DT_UNKNOWN,
// so it continues to be left undocumented.
//
// For the moment, it's still here for backwards compatability, if
// nothing else. It may or may not be deprecated later.
@property ubyte d_type()
{
return _dType;
}
@property ulong size()
{
_ensureStatDone();
return _statBuf.st_size;
}
@property d_time creationTime()
{
_ensureStatDone();
return cast(d_time)_statBuf.st_ctime * ticksPerSecond;
}
@property SysTime timeStatusChanged()
{
_ensureStatDone();
return SysTime(unixTimeToStdTime(_statBuf.st_ctime));
}
@property d_time lastAccessTime()
{
_ensureStatDone();
return cast(d_time)_statBuf.st_atime * ticksPerSecond;
}
@property SysTime timeLastAccessed()
{
_ensureStatDone();
return SysTime(unixTimeToStdTime(_statBuf.st_ctime));
}
@property d_time lastWriteTime()
{
_ensureStatDone();
return cast(d_time)_statBuf.st_mtime * ticksPerSecond;
}
@property SysTime timeLastModified()
{
_ensureStatDone();
return SysTime(unixTimeToStdTime(_statBuf.st_mtime));
}
@property uint attributes()
{
_ensureStatDone();
return _statBuf.st_mode;
}
@property uint linkAttributes()
{
_ensureLStatDone();
return _lstatMode;
}
@property struct_stat64 statBuf()
{
_ensureStatDone();
return _statBuf;
}
private:
void _init(in char[] path)
{
_name = path.idup;
_didLStat = false;
_didStat = false;
_dTypeSet = false;
}
void _init(in char[] path, core.sys.posix.dirent.dirent* fd)
{
immutable len = std.c.string.strlen(fd.d_name.ptr);
_name = std.path.join(path, fd.d_name[0 .. len]);
_didLStat = false;
_didStat = false;
//fd_d_type doesn't work for all file systems,
//in which case the result is DT_UNKOWN. But we
//can determine the correct type from lstat, so
//we'll only set the dtype here if we could
//correctly determine it (not lstat in the case
//of DT_UNKNOWN in case we don't ever actually
//need the dtype, thus potentially avoiding the
//cost of calling lstat).
if(fd.d_type != DT_UNKNOWN)
{
_dType = fd.d_type;
_dTypeSet = true;
}
else
_dTypeSet = false;
}
/++
This is to support lazy evaluation, because doing stat's is
expensive and not always needed.
+/
void _ensureStatDone()
{
if(_didStat)
return;
enforce(stat64(toStringz(_name), &_statBuf) == 0,
"Failed to stat file `" ~ _name ~ "'");
_didStat = true;
}
/++
This is to support lazy evaluation, because doing stat's is
expensive and not always needed.
+/
void _ensureLStatDone()
{
if(_didLStat)
return;
struct_stat64 statbuf = void;
version (OSX)
{
enforce(stat64(toStringz(_name), &statbuf) == 0,
"Failed to stat file `" ~ _name ~ "'");
}
else
{
enforce(lstat64(toStringz(_name), &statbuf) == 0,
"Failed to stat file `" ~ _name ~ "'");
}
_lstatMode = statbuf.st_mode;
_dTypeSet = true;
_didLStat = true;
}
string _name; /// The file or directory represented by this DirEntry.
struct_stat64 _statBuf = void; /// The result of stat().
uint _lstatMode; /// The stat mode from lstat().
ubyte _dType; /// The type of the file.
bool _didLStat = false; /// Whether lstat() has been called for this DirEntry.
bool _didStat = false; /// Whether stat() has been called for this DirEntry.
bool _dTypeSet = false; /// Whether the dType of the file has been set.
}
}
else
{
static assert(0, "Unsupported/Unknown OS");
}
unittest
{
version(Windows)
{
if("C:\\Program Files\\".exists)
{
auto de = dirEntry("C:\\Program Files\\");
assert(!de.isFile);
assert(de.isDir);
assert(!de.isSymLink);
}
if("C:\\Windows\\system.ini".exists)
{
auto de = dirEntry("C:\\Windows\\system.ini");
assert(de.isFile);
assert(!de.isDir);
assert(!de.isSymLink);
}
}
else version(OSX)
{
}
else version(Posix)
{
if("/usr/include".exists)
{
{
auto de = dirEntry("/usr/include");
assert(!de.isFile);
assert(de.isDir);
assert(!de.isSymLink);
}
immutable symfile = deleteme ~ "_slink\0";
scope(exit) if(symfile.exists) symfile.remove();
core.sys.posix.unistd.symlink("/usr/include", symfile.ptr);
{
auto de = dirEntry(symfile);
assert(!de.isFile);
assert(de.isDir);
assert(de.isSymLink);
}
}
if("/usr/include/assert.h".exists)
{
auto de = dirEntry("/usr/include/assert.h");
assert(de.isFile);
assert(!de.isDir);
assert(!de.isSymLink);
}
}
else
static assert(0, "Unsupported/Unknown OS");
}
/******************************************************
* $(RED Scheduled for deprecation. Please use dirEntries instead.)
*
* For each file and directory DirEntry in pathname[],
* pass it to the callback delegate.
*
* Params:
* callback = Delegate that processes each
* DirEntry in turn. Returns true to
* continue, false to stop.
* Example:
* This program lists all the files in its
* path argument and all subdirectories thereof.
* ----
* import std.stdio;
* import std.file;
*
* void main(string[] args)
* {
* bool callback(DirEntry* de)
* {
* if(de.isDir)
* listdir(de.name, &callback);
* else
* writefln(de.name);
* return true;
* }
*
* listdir(args[1], &callback);
* }
* ----
*/
void listdir(in char[] pathname, bool delegate(DirEntry* de) callback)
{
_listDir(pathname, callback);
}
/***************************************************
Copy file $(D from) to file $(D to). File timestamps are preserved.
*/
version(Windows) void copy(in char[] from, in char[] to)
{
immutable result = useWfuncs
? CopyFileW(std.utf.toUTF16z(from), std.utf.toUTF16z(to), false)
: CopyFileA(toMBSz(from), toMBSz(to), false);
if (!result)
throw new FileException(to.idup);
}
version(Posix) void copy(in char[] from, in char[] to)
{
immutable fd = core.sys.posix.fcntl.open(toStringz(from), O_RDONLY);
cenforce(fd != -1, from);
scope(exit) core.sys.posix.unistd.close(fd);
struct_stat64 statbuf = void;
cenforce(fstat64(fd, &statbuf) == 0, from);
//cenforce(core.sys.posix.sys.stat.fstat(fd, &statbuf) == 0, from);
auto toz = toStringz(to);
immutable fdw = core.sys.posix.fcntl.open(toz,
O_CREAT | O_WRONLY | O_TRUNC, octal!666);
cenforce(fdw != -1, from);
scope(failure) std.c.stdio.remove(toz);
{
scope(failure) core.sys.posix.unistd.close(fdw);
auto BUFSIZ = 4096u * 16;
auto buf = std.c.stdlib.malloc(BUFSIZ);
if (!buf)
{
BUFSIZ = 4096;
buf = std.c.stdlib.malloc(BUFSIZ);
buf || assert(false, "Out of memory in std.file.copy");
}
scope(exit) std.c.stdlib.free(buf);
for (auto size = statbuf.st_size; size; )
{
immutable toxfer = (size > BUFSIZ) ? BUFSIZ : cast(size_t) size;
cenforce(
core.sys.posix.unistd.read(fd, buf, toxfer) == toxfer
&& core.sys.posix.unistd.write(fdw, buf, toxfer) == toxfer,
from);
assert(size >= toxfer);
size -= toxfer;
}
}
cenforce(core.sys.posix.unistd.close(fdw) != -1, from);
utimbuf utim = void;
utim.actime = cast(time_t)statbuf.st_atime;
utim.modtime = cast(time_t)statbuf.st_mtime;
cenforce(utime(toz, &utim) != -1, from);
}
version(D_Ddoc)
{
/++
$(RED Scheduled for deprecation. Please use the version which takes
std.datetime.SysTime instead).
Set access/modified times of file $(D_PARAM name).
Throws:
$(D_PARAM FileException) on error.
+/
void setTimes(in char[] name, d_time fta, d_time ftm);
}
else
{
void setTimes(C)(in C[] name, d_time fta, d_time ftm)
if(is(Unqual!C == char))
{
pragma(msg, "The version of std.file.setTimes which takes std.date.d_time " ~
"has been scheduled for deprecation. " ~
"Please use the version which takes std.datetime.SysTime instead.");
version(Windows)
{
const ta = d_time2FILETIME(fta);
const tm = d_time2FILETIME(ftm);
alias TypeTuple!(GENERIC_WRITE, 0, null, OPEN_EXISTING,
FILE_ATTRIBUTE_NORMAL, HANDLE.init)
defaults;
auto h = useWfuncs
? CreateFileW(std.utf.toUTF16z(name), defaults)
: CreateFileA(toMBSz(name), defaults);
cenforce(h != INVALID_HANDLE_VALUE, name);
scope(exit) cenforce(CloseHandle(h), name);
cenforce(SetFileTime(h, null, &ta, &tm), name);
}
else version(Posix)
{
timeval[2] t = void;
t[0].tv_sec = to!int(fta / ticksPerSecond);
t[0].tv_usec = cast(int)
(cast(long) ((cast(double) fta / ticksPerSecond)
* 1_000_000) % 1_000_000);
t[1].tv_sec = to!int(ftm / ticksPerSecond);
t[1].tv_usec = cast(int)
(cast(long) ((cast(double) ftm / ticksPerSecond)
* 1_000_000) % 1_000_000);
enforce(utimes(toStringz(name), t) == 0);
}
else
static assert(0, "Unsupported/Unknown OS");
}
}
version(D_Ddoc)
{
/++
Set access/modified times of file $(D name).
Params:
fileAccessTime = Time the file was last accessed.
fileModificationTime = Time the file was last modified.
Throws:
$(D FileException) on error.
+/
void setTimes(in char[] name,
SysTime fileAccessTime,
SysTime fileModificationTime);
}
else
{
void setTimes(C)(in C[] name,
SysTime fileAccessTime,
SysTime fileModificationTime)
if(is(Unqual!C == char))
{
version(Windows)
{
const ta = SysTimeToFILETIME(fileAccessTime);
const tm = SysTimeToFILETIME(fileModificationTime);
alias TypeTuple!(GENERIC_WRITE,
0,
null,
OPEN_EXISTING,
FILE_ATTRIBUTE_NORMAL, HANDLE.init)
defaults;
auto h = useWfuncs ?
CreateFileW(std.utf.toUTF16z(name), defaults) :
CreateFileA(toMBSz(name), defaults);
cenforce(h != INVALID_HANDLE_VALUE, name);
scope(exit)
cenforce(CloseHandle(h), name);
cenforce(SetFileTime(h, null, &ta, &tm), name);
}
else version(Posix)
{
timeval[2] t = void;
t[0] = fileAccessTime.toTimeVal();
t[1] = fileModificationTime.toTimeVal();
enforce(utimes(toStringz(name), t) == 0);
}
else
static assert(0, "Unsupported/Unknown OS");
}
}
/+
unittest
{
write(deleteme, "a\n");
scope(exit) { assert(exists(deleteme)); remove(deleteme); }
SysTime ftc1, fta1, ftm1;
getTimes(deleteme, ftc1, fta1, ftm1);
enforce(collectException(setTimes("nonexistent", fta1, ftm1)));
setTimes(deleteme, fta1 + dur!"seconds"(50), ftm1 + dur!"seconds"(50));
SysTime ftc2, fta2, ftm2;
getTimes(deleteme, ftc2, fta2, ftm2);
assert(fta1 + dur!"seconds(50) == fta2, text(fta1 + dur!"seconds(50), "!=", fta2));
assert(ftm1 + dur!"seconds(50) == ftm2);
}
+/
/++
Remove directory and all of its content and subdirectories,
recursively.
Throws:
FileException if there is an error (including if the given
file is not a directory).
+/
void rmdirRecurse(in char[] pathname)
{
DirEntry de = dirEntry(pathname);
rmdirRecurse(de);
}
/++
Remove directory and all of its content and subdirectories,
recursively.
Throws:
FileException if there is an error (including if the given
file is not a directory).
+/
void rmdirRecurse(ref DirEntry de)
{
if(!de.isDir)
throw new FileException(text("File ", de.name, " is not a directory"));
if(de.isSymLink())
remove(de.name);
else
{
// all children, recursively depth-first
foreach(DirEntry e; dirEntries(de.name, SpanMode.depth, false))
{
isDir(e.linkAttributes) ? rmdir(e.name) : remove(e.name);
}
// the dir itself
rmdir(de.name);
}
}
version(Windows) unittest
{
auto d = deleteme ~ r".dir\a\b\c\d\e\f\g";
mkdirRecurse(d);
rmdirRecurse(deleteme ~ ".dir");
enforce(!exists(deleteme ~ ".dir"));
}
version(Posix) unittest
{
version(OSX)
{
}
else
{
auto d = "/tmp/deleteme/a/b/c/d/e/f/g";
enforce(collectException(mkdir(d)));
mkdirRecurse(d);
core.sys.posix.unistd.symlink("/tmp/deleteme/a/b/c", "/tmp/deleteme/link");
rmdirRecurse("/tmp/deleteme/link");
enforce(exists(d));
rmdirRecurse("/tmp/deleteme");
enforce(!exists("/tmp/deleteme"));
d = "/tmp/deleteme/a/b/c/d/e/f/g";
mkdirRecurse(d);
std.process.system("ln -sf /tmp/deleteme/a/b/c /tmp/deleteme/link");
rmdirRecurse("/tmp/deleteme");
enforce(!exists("/tmp/deleteme"));
}
}
unittest
{
void[] buf;
buf = new void[10];
(cast(byte[])buf)[] = 3;
if (exists("unittest_write.tmp")) remove("unittest_write.tmp");
write("unittest_write.tmp", buf);
void buf2[] = read("unittest_write.tmp");
assert(buf == buf2);
copy("unittest_write.tmp", "unittest_write2.tmp");
buf2 = read("unittest_write2.tmp");
assert(buf == buf2);
remove("unittest_write.tmp");
assert(!exists("unittest_write.tmp"));
remove("unittest_write2.tmp");
assert(!exists("unittest_write2.tmp"));
}
unittest
{
_listDir(".", delegate bool (DirEntry * de)
{
version(Windows)
{
auto s = std.string.format("%s : c %s, w %s, a %s",
de.name,
de.timeCreated,
de.timeLastModified,
de.timeLastAccessed);
}
else version(Posix)
{
auto s = std.string.format("%s : c %s, w %s, a %s",
de.name,
de.timeStatusChanged,
de.timeLastModified,
de.timeLastAccessed);
}
else
static assert(0, "Unsupported/Unknown OS");
return true;
}
);
}
/**
* Dictates directory spanning policy for $(D_PARAM dirEntries) (see below).
*/
enum SpanMode
{
/** Only spans one directory. */
shallow,
/** Spans the directory depth-first, i.e. the content of any
subdirectory is spanned before that subdirectory itself. Useful
e.g. when recursively deleting files. */
depth,
/** Spans the directory breadth-first, i.e. the content of any
subdirectory is spanned right after that subdirectory itself. */
breadth,
}
struct DirIterator
{
string pathname;
SpanMode mode;
// Whether we should follow symlinked directories while iterating.
// It also indicates whether we should avoid functions which call
// stat (since we should only need lstat in this case and it would
// be more efficient to not call stat in addition to lstat).
bool followSymLinks;
private int doIt(D)(D dg, DirEntry* de)
{
alias ParameterTypeTuple!D Parms;
static if(is(Parms[0] : const(char)[]))
{
return dg(de.name[]);
}
else static if(is(Parms[0] : DirEntry))
{
return dg(*de);
}
else
{
static assert(0, "Dunno how to enumerate directory entries "
"against type " ~ Parms[0].stringof);
}
}
int opApply(D)(scope D dg)
{
int result = 0;
// worklist used only in breadth-first traversal
string[] worklist = [pathname];
bool callback(DirEntry* de)
{
switch(mode)
{
case SpanMode.shallow:
{
result = doIt(dg, de);
break;
}
case SpanMode.breadth:
{
result = doIt(dg, de);
if(!result && (followSymLinks ? de.isDir
: isDir(de.linkAttributes)))
{
worklist ~= de.name;
}
break;
}
default:
{
assert(mode == SpanMode.depth);
if(followSymLinks ? de.isdir
: isdir(de.linkAttributes))
{
_listDir(de.name, &callback);
}
if(!result)
result = doIt(dg, de);
break;
}
}
return result == 0;
}
while(!worklist.empty)
{
auto listThis = worklist.back;
worklist.popBack();
_listDir(listThis, &callback);
}
return result;
}
}
/++
Iterates a directory using foreach. The iteration variable can be
of type $(D_PARAM string) if only the name is needed, or $(D_PARAM
DirEntry) if additional details are needed. The span mode dictates
the how the directory is traversed. The name of the directory entry
includes the $(D_PARAM path) prefix.
Params:
path = The directory to iterato over.
mode = Whether the directory's sub-directories should be iterated
over depth-first ($(D_PARAM depth)), breadth-first
($(D_PARAM breadth)), or not at all ($(D_PARAM shallow)).
followSymLinks = Whether symbolic links which point to directories
should be treated as directories and their contents
iterated over. Ignored on Windows.
Examples:
--------------------
// Iterate a directory in depth
foreach (string name; dirEntries("destroy/me", SpanMode.depth))
{
remove(name);
}
// Iterate a directory in breadth
foreach (string name; dirEntries(".", SpanMode.breadth))
{
writeln(name);
}
// Iterate a directory and get detailed info about it
foreach (DirEntry e; dirEntries("dmd-testing", SpanMode.breadth))
{
writeln(e.name, "\t", e.size);
}
--------------------
+/
DirIterator dirEntries(string path, SpanMode mode, bool followSymLinks = true)
{
DirIterator result;
result.pathname = path;
result.mode = mode;
result.followSymLinks = followSymLinks;
return result;
}
unittest
{
version (linux)
{
assert(std.process.system("mkdir --parents dmd-testing") == 0);
scope(exit) std.process.system("rm -rf dmd-testing");
assert(std.process.system("mkdir --parents dmd-testing/somedir") == 0);
assert(std.process.system("touch dmd-testing/somefile") == 0);
assert(std.process.system("touch dmd-testing/somedir/somedeepfile")
== 0);
foreach (string name; dirEntries("dmd-testing", SpanMode.shallow))
{
}
foreach (string name; dirEntries("dmd-testing", SpanMode.depth))
{
//writeln(name);
}
foreach (string name; dirEntries("dmd-testing", SpanMode.breadth))
{
//writeln(name);
}
foreach (DirEntry e; dirEntries("dmd-testing", SpanMode.breadth))
{
//writeln(e.name);
}
foreach (DirEntry e; dirEntries("/usr/share/zoneinfo", SpanMode.depth))
{
assert(e.isFile || e.isDir, e.name);
}
}
}
/++
Returns a DirEntry for the given file (or directory).
Params:
name = The file (or directory) to get a DirEntry for.
Throws:
FileException) if the file does not exist.
+/
DirEntry dirEntry(in char[] name)
{
if(!name.exists)
throw new FileException(text("File ", name, " does not exist."));
DirEntry dirEntry;
dirEntry._init(name);
return dirEntry;
}
//Test dirEntry with a directory.
unittest
{
auto before = Clock.currTime();
Thread.sleep(dur!"seconds"(1));
immutable path = deleteme ~ "_dir";
scope(exit) { if(path.exists) rmdirRecurse(path); }
mkdir(path);
Thread.sleep(dur!"seconds"(1));
auto de = dirEntry(path);
assert(de.name == path);
assert(de.isDir);
assert(!de.isFile);
assert(!de.isSymLink);
assert(de.isDir == path.isDir);
assert(de.isFile == path.isFile);
assert(de.isSymLink == path.isSymLink);
assert(de.size == path.getSize());
assert(de.attributes == getAttributes(path));
assert(de.linkAttributes == getLinkAttributes(path));
auto now = Clock.currTime();
assert(de.timeLastAccessed > before);
assert(de.timeLastAccessed < now);
assert(de.timeLastModified > before);
assert(de.timeLastModified < now);
assert(isDir(de.attributes));
assert(isDir(de.linkAttributes));
assert(!isFile(de.attributes));
assert(!isFile(de.linkAttributes));
assert(!isSymLink(de.attributes));
assert(!isSymLink(de.linkAttributes));
version(Windows)
{
assert(de.timeCreated > before);
assert(de.timeCreated < now);
}
else version(Posix)
{
assert(de.timeStatusChanged > before);
assert(de.timeStatusChanged < now);
assert(de.attributes == de.statBuf.st_mode);
}
}
//Test dirEntry with a file.
unittest
{
auto before = Clock.currTime();
Thread.sleep(dur!"seconds"(1));
immutable path = deleteme ~ "_file";
scope(exit) { if(path.exists) remove(path); }
write(path, "hello world");
Thread.sleep(dur!"seconds"(1));
auto de = dirEntry(path);
assert(de.name == path);
assert(!de.isDir);
assert(de.isFile);
assert(!de.isSymLink);
assert(de.isDir == path.isDir);
assert(de.isFile == path.isFile);
assert(de.isSymLink == path.isSymLink);
assert(de.size == path.getSize());
assert(de.attributes == getAttributes(path));
assert(de.linkAttributes == getLinkAttributes(path));
auto now = Clock.currTime();
assert(de.timeLastAccessed > before);
assert(de.timeLastAccessed < now);
assert(de.timeLastModified > before);
assert(de.timeLastModified < now);
assert(!isDir(de.attributes));
assert(!isDir(de.linkAttributes));
assert(isFile(de.attributes));
assert(isFile(de.linkAttributes));
assert(!isSymLink(de.attributes));
assert(!isSymLink(de.linkAttributes));
version(Windows)
{
assert(de.timeCreated > before);
assert(de.timeCreated < now);
}
else version(Posix)
{
assert(de.timeStatusChanged > before);
assert(de.timeStatusChanged < now);
assert(de.attributes == de.statBuf.st_mode);
}
}
//Test dirEntry with a symlink to a directory.
version(linux) unittest
{
auto before = Clock.currTime();
Thread.sleep(dur!"seconds"(1));
immutable orig = deleteme ~ "_dir";
mkdir(orig);
immutable path = deleteme ~ "_slink";
scope(exit) { if(orig.exists) rmdirRecurse(orig); }
scope(exit) { if(path.exists) remove(path); }
core.sys.posix.unistd.symlink((orig ~ "\0").ptr, (path ~ "\0").ptr);
Thread.sleep(dur!"seconds"(1));
auto de = dirEntry(path);
assert(de.name == path);
assert(de.isDir);
assert(!de.isFile);
assert(de.isSymLink);
assert(de.isDir == path.isDir);
assert(de.isFile == path.isFile);
assert(de.isSymLink == path.isSymLink);
assert(de.size == path.getSize());
assert(de.attributes == getAttributes(path));
assert(de.linkAttributes == getLinkAttributes(path));
auto now = Clock.currTime();
assert(de.timeLastAccessed > before);
assert(de.timeLastAccessed < now);
assert(de.timeLastModified > before);
assert(de.timeLastModified < now);
assert(isDir(de.attributes));
assert(!isDir(de.linkAttributes));
assert(!isFile(de.attributes));
assert(!isFile(de.linkAttributes));
assert(!isSymLink(de.attributes));
assert(isSymLink(de.linkAttributes));
assert(de.timeStatusChanged > before);
assert(de.timeStatusChanged < now);
assert(de.attributes == de.statBuf.st_mode);
}
//Test dirEntry with a symlink to a file.
version(linux) unittest
{
auto before = Clock.currTime();
Thread.sleep(dur!"seconds"(1));
immutable orig = deleteme ~ "_file";
write(orig, "hello world");
immutable path = deleteme ~ "_slink";
scope(exit) { if(orig.exists) remove(orig); }
scope(exit) { if(path.exists) remove(path); }
core.sys.posix.unistd.symlink((orig ~ "\0").ptr, (path ~ "\0").ptr);
Thread.sleep(dur!"seconds"(1));
auto de = dirEntry(path);
assert(de.name == path);
assert(!de.isDir);
assert(de.isFile);
assert(de.isSymLink);
assert(de.isDir == path.isDir);
assert(de.isFile == path.isFile);
assert(de.isSymLink == path.isSymLink);
assert(de.size == path.getSize());
assert(de.attributes == getAttributes(path));
assert(de.linkAttributes == getLinkAttributes(path));
auto now = Clock.currTime();
assert(de.timeLastAccessed > before);
assert(de.timeLastAccessed < now);
assert(de.timeLastModified > before);
assert(de.timeLastModified < now);
assert(!isDir(de.attributes));
assert(!isDir(de.linkAttributes));
assert(isFile(de.attributes));
assert(!isFile(de.linkAttributes));
assert(!isSymLink(de.attributes));
assert(isSymLink(de.linkAttributes));
assert(de.timeStatusChanged > before);
assert(de.timeStatusChanged < now);
assert(de.attributes == de.statBuf.st_mode);
}
/**
Reads an entire file into an array.
Example:
----
// Load file; each line is an int followed by comma, whitespace and a
// double.
auto a = slurp!(int, double)("filename", "%s, %s");
----
*/
Select!(Types.length == 1, Types[0][], Tuple!(Types)[])
slurp(Types...)(string filename, in char[] format)
{
typeof(return) result;
auto app = appender!(typeof(return))();
ElementType!(typeof(return)) toAdd;
auto f = File(filename);
scope(exit) f.close;
foreach (line; f.byLine())
{
formattedRead(line, format, &toAdd);
enforce(line.empty,
text("Trailing characters at the end of line: `", line,
"'"));
app.put(toAdd);
}
return app.data;
}
unittest
{
// Tuple!(int, double)[] x;
// auto app = appender(&x);
write(deleteme, "12 12.25\n345 1.125");
scope(exit) { assert(exists(deleteme)); remove(deleteme); }
auto a = slurp!(int, double)(deleteme, "%s %s");
assert(a.length == 2);
assert(a[0] == tuple(12, 12.25));
assert(a[1] == tuple(345, 1.125));
}
/++
Returns the contents of the given directory.
The names in the contents do not include the pathname.
Throws:
FileException on error.
Examples:
This program lists all the files and subdirectories in its
path argument.
--------------------
import std.stdio;
import std.file;
void main(string[] args)
{
auto dirs = std.file.listdir(args[1]);
foreach(d; dirs)
writefln(d);
}
--------------------
+/
string[] listDir(in char[] pathname)
{
auto result = appender!(string[])();
bool listing(string filename)
{
result.put(filename);
return true; // continue
}
_listDir(pathname, &listing);
return result.data;
}
/++
$(RED Scheduled for deprecation. Please use listDir instead.)
Same is listDir.
+/
alias listDir listdir;
unittest
{
assert(listDir(".").length > 0);
}
/++
Returns all the files in the directory and its sub-directories
which match pattern or regular expression r.
Params:
pathname = The path of the directory to search.
pattern = String with wildcards, such as $(RED "*.d"). The supported
wildcard strings are described under fnmatch() in
$(LINK2 std_path.html, std.path).
r = Regular expression, for more powerful pattern matching.
followSymLinks = Whether symbolic links which point to directories
should be treated as directories and their contents
iterated over. Ignored on Windows.
Examples:
This program lists all the files with a "d" extension in
the path passed as the first argument.
--------------------
import std.stdio;
import std.file;
void main(string[] args)
{
auto d_source_files = std.file.listDir(args[1], "*.d");
foreach(d; d_source_files)
writefln(d);
}
--------------------
A regular expression version that searches for all files with "d" or
"obj" extensions:
--------------------
import std.stdio;
import std.file;
import std.regexp;
void main(string[] args)
{
auto d_source_files = std.file.listDir(args[1], RegExp(r"\.(d|obj)$"));
foreach(d; d_source_files)
writefln(d);
}
--------------------
+/
string[] listDir(in char[] pathname, in char[] pattern, bool followSymLinks = true)
{
auto result = appender!(string[])();
bool callback(DirEntry* de)
{
if(followSymLinks ? de.isDir : isDir(de.linkAttributes))
{
_listDir(de.name, &callback);
}
else if(std.path.fnmatch(de.name, pattern))
{
result.put(de.name);
}
return true; // continue
}
_listDir(pathname, &callback);
return result.data;
}
/++ Ditto +/
string[] listDir(in char[] pathname, RegExp r, bool followSymLinks = true)
{
auto result = appender!(string[])();
bool callback(DirEntry* de)
{
if(followSymLinks ? de.isdir : isDir(de.linkAttributes))
{
_listDir(de.name, &callback);
}
else if(r.test(de.name))
{
result.put(de.name);
}
return true; // continue
}
_listDir(pathname, &callback);
return result.data;
}
/******************************************************
* $(RED Scheduled for deprecation. Please use dirEntries instead.)
*
* For each file and directory name in pathname[],
* pass it to the callback delegate.
*
* Params:
* callback = Delegate that processes each
* filename in turn. Returns true to
* continue, false to stop.
* Example:
* This program lists all the files in its
* path argument, including the path.
* ----
* import std.stdio;
* import std.path;
* import std.file;
*
* void main(string[] args)
* {
* auto pathname = args[1];
* string[] result;
*
* bool listing(string filename)
* {
* result ~= std.path.join(pathname, filename);
* return true; // continue
* }
*
* listdir(pathname, &listing);
*
* foreach (name; result)
* writefln("%s", name);
* }
* ----
*/
void listdir(in char[] pathname, bool delegate(string filename) callback)
{
_listDir(pathname, callback);
}
//==============================================================================
// Private Section.
//==============================================================================
private:
void _listDir(in char[] pathname, bool delegate(string filename) callback)
{
bool listing(DirEntry* de)
{
return callback(de.name.basename);
}
_listDir(pathname, &listing);
}
version(Windows)
{
void _listDir(in char[] pathname, bool delegate(DirEntry* de) callback)
{
DirEntry de;
auto c = std.path.join(pathname, "*.*");
if(useWfuncs)
{
WIN32_FIND_DATAW fileinfo;
auto h = FindFirstFileW(std.utf.toUTF16z(c), &fileinfo);
if(h == INVALID_HANDLE_VALUE)
return;
scope(exit) FindClose(h);
do
{
// Skip "." and ".."
if(std.string.wcscmp(fileinfo.cFileName.ptr, ".") == 0 ||
std.string.wcscmp(fileinfo.cFileName.ptr, "..") == 0)
{
continue;
}
de._init(pathname, &fileinfo);
if(!callback(&de))
break;
} while(FindNextFileW(h, &fileinfo) != FALSE);
}
else
{
WIN32_FIND_DATA fileinfo;
auto h = FindFirstFileA(toMBSz(c), &fileinfo);
if(h == INVALID_HANDLE_VALUE)
return;
scope(exit) FindClose(h);
do
{
// Skip "." and ".."
if(std.c.string.strcmp(fileinfo.cFileName.ptr, ".") == 0 ||
std.c.string.strcmp(fileinfo.cFileName.ptr, "..") == 0)
{
continue;
}
de._init(pathname, &fileinfo);
if(!callback(&de))
break;
} while(FindNextFileA(h, &fileinfo) != FALSE);
}
}
}
else version(Posix)
{
void _listDir(in char[] pathname, bool delegate(DirEntry* de) callback)
{
auto h = cenforce(opendir(toStringz(pathname)), pathname);
scope(exit) closedir(h);
DirEntry de;
for(dirent* fdata; (fdata = readdir(h)) != null; )
{
// Skip "." and ".."
if(!std.c.string.strcmp(fdata.d_name.ptr, ".") ||
!std.c.string.strcmp(fdata.d_name.ptr, ".."))
{
continue;
}
de._init(pathname, fdata);
if(!callback(&de))
break;
}
}
}
else
static assert(0, "Unsupported/Unknown OS");
//==============================================================================
// Stuff from std.date so that we don't have to import std.date and end up with
// the "scheduled for deprecation" pragma message from std.date showing up just
// because someone imports std.file.
//
// These will be removed either when the functions in std.file which use them
// are removed.
//==============================================================================
//
alias long d_time;
enum d_time d_time_nan = long.min;
enum ticksPerSecond = 1000;
version(Windows)
{
d_time FILETIME2d_time(const FILETIME *ft)
{
auto sysTime = FILETIMEToSysTime(ft);
return sysTimeToDTime(sysTime);
}
}
Reference in a new issue View git blame Copy permalink