123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479 |
|
/*******************************************************************************
copyright: Copyright (c) 2004 Kris Bell. All rights reserved
license: BSD style: $(LICENSE)
version: Oct 2004: Initial version
version: Nov 2006: Australian version
version: Feb 2007: Mutating version
version: Mar 2007: Folded FileProxy in
version: Nov 2007: VFS dictates '/' always be used
version: Feb 2008: Split file system calls into a struct
author: Kris
FilePath provides a means to efficiently edit path components and
to access the underlying file system.
Use module Path.d instead when you need pedestrian access to the
file system, and are not mutating the path components themselves
*******************************************************************************/
module tango.io.FilePath;
private import tango.io.Path;
private import tango.io.model.IFile : FileConst, FileInfo;
private import tango.stdc.string : memmove;
/*******************************************************************************
Models a file path. These are expected to be used as the constructor
argument to various file classes. The intention is that they easily
convert to other representations such as absolute, canonical, or Url.
File paths containing non-ansi characters should be UTF-8 encoded.
Supporting Unicode in this manner was deemed to be more suitable
than providing a wchar version of FilePath, and is both consistent
& compatible with the approach taken with the Uri class.
FilePath is designed to be transformed, thus each mutating method
modifies the internal content. See module Path.d for a lightweight
immutable variation.
Note that patterns of adjacent '.' separators are treated specially
in that they will be assigned to the name where there is no distinct
suffix. In addition, a '.' at the start of a name signifies it does
not belong to the suffix i.e. ".file" is a name rather than a suffix.
Patterns of intermediate '.' characters will otherwise be assigned
to the suffix, such that "file....suffix" includes the dots within
the suffix itself. See method ext() for a suffix without dots.
Note that Win32 '\' characters are converted to '/' by default via
the FilePath constructor.
*******************************************************************************/
class FilePath : PathView
{
private PathParser!(char) p; // the parsed path
private bool dir_; // this represents a dir?
final FilePath opOpAssign(immutable(char)[] s : "~")(const(char)[] path)
{
return append(path);
}
/***********************************************************************
Filter used for screening paths via toList().
***********************************************************************/
public alias bool delegate (FilePath, bool) Filter;
/***********************************************************************
Call-site shortcut to create a FilePath instance. This
enables the same syntax as struct usage, so may expose
a migration path.
***********************************************************************/
static FilePath opCall (char[] filepath = null)
{
return new FilePath (filepath);
}
/***********************************************************************
Create a FilePath from a copy of the provided string.
FilePath assumes both path & name are present, and therefore
may split what is otherwise a logically valid path. That is,
the 'name' of a file is typically the path segment following
a rightmost path-separator. The intent is to treat files and
directories in the same manner; as a name with an optional
ancestral structure. It is possible to bias the interpretation
by adding a trailing path-separator to the argument. Doing so
will result in an empty name attribute.
With regard to the filepath copy, we found the common case to
be an explicit .dup, whereas aliasing appeared to be rare by
comparison. We also noted a large proportion interacting with
C-oriented OS calls, implying the postfix of a null terminator.
Thus, FilePath combines both as a single operation.
Note that Win32 '\' characters are normalized to '/' instead.
***********************************************************************/
this (char[] filepath = null)
{
set (filepath, true);
}
/***********************************************************************
Return the complete text of this filepath.
***********************************************************************/
override final const string toString ()
{
return p.toString();
}
/***********************************************************************
Duplicate this path.
***********************************************************************/
@property final const FilePath dup ()
{
return FilePath (p.dString().dup);
}
/***********************************************************************
Return the complete text of this filepath as a null
terminated string for use with a C api. Use toString
instead for any D api.
Note that the nul is always embedded within the string
maintained by FilePath, so there's no heap overhead when
making a C call.
***********************************************************************/
final inout(char)[] cString() inout
{
return p.fp [0 .. p.end_+1];
}
/***********************************************************************
Return the root of this path. Roots are constructs such as
"C:".
***********************************************************************/
@property final inout(char)[] root () inout
{
return p.root;
}
/***********************************************************************
Return the file path.
Paths may start and end with a "/".
The root path is "/" and an unspecified path is returned as
an empty string. Directory paths may be split such that the
directory name is placed into the 'name' member; directory
paths are treated no differently than file paths.
***********************************************************************/
@property final inout(char)[] folder () inout
{
return p.folder;
}
/***********************************************************************
Returns a path representing the parent of this one. This
will typically return the current path component, though
with a special case where the name component is empty. In
such cases, the path is scanned for a prior segment:
$(UL
$(LI normal: /x/y/z => /x/y)
$(LI special: /x/y/ => /x))
Note that this returns a path suitable for splitting into
path and name components (there's no trailing separator).
See pop() also, which is generally more useful when working
with FilePath instances.
***********************************************************************/
@property final inout(char)[] parent () inout
{
return p.parent;
}
/***********************************************************************
Return the name of this file, or directory.
***********************************************************************/
@property final inout(char)[] name () inout
{
return p.name;
}
/***********************************************************************
Ext is the tail of the filename, rightward of the rightmost
'.' separator e.g. path "foo.bar" has ext "bar". Note that
patterns of adjacent separators are treated specially; for
example, ".." will wind up with no ext at all.
***********************************************************************/
@property final char[] ext ()
{
return p.ext;
}
/***********************************************************************
Suffix is like ext, but includes the separator e.g. path
"foo.bar" has suffix ".bar".
***********************************************************************/
@property final inout(char)[] suffix () inout
{
return p.suffix;
}
/***********************************************************************
Return the root + folder combination.
***********************************************************************/
@property final inout(char)[] path () inout
{
return p.path;
}
/***********************************************************************
Return the name + suffix combination.
***********************************************************************/
@property final inout(char)[] file () inout
{
return p.file;
}
/***********************************************************************
Returns true if all fields are identical. Note that some
combinations of operations may not produce an identical
set of fields. For example:
---
FilePath("/foo").append("bar").pop() == "/foo";
FilePath("/foo/").append("bar").pop() != "/foo/";
---
The latter is different due to variance in how append
injects data, and how pop is expected to operate under
different circumstances (both examples produce the same
pop result, although the initial path is not identical).
However, opEquals() can overlook minor distinctions such
as this example, and will return a match.
***********************************************************************/
final const override bool opEquals (Object o)
{
return (this is o) || (o && opEquals(o.toString()));
}
/***********************************************************************
Does this FilePath match the given text? Note that some
combinations of operations may not produce an identical
set of fields. For example:
---
FilePath("/foo").append("bar").pop() == "/foo";
FilePath("/foo/").append("bar").pop() != "/foo/";
---
The latter Is Different due to variance in how append
injects data, and how pop is expected to operate under
different circumstances (both examples produce the same
pop result, although the initial path is not identical).
However, opEquals() can overlook minor distinctions such
as this example, and will return a match.
***********************************************************************/
final const bool opEquals (const(char)[] s)
{
return p.equals(s);
}
/***********************************************************************
Returns true if this FilePath is *not* relative to the
current working directory.
***********************************************************************/
@property final const bool isAbsolute ()
{
return p.isAbsolute;
}
/***********************************************************************
Returns true if this FilePath is empty.
***********************************************************************/
@property final const bool isEmpty ()
{
return p.isEmpty;
}
/***********************************************************************
Returns true if this FilePath has a parent. Note that a
parent is defined by the presence of a path-separator in
the path. This means 'foo' within "\foo" is considered a
child of the root.
***********************************************************************/
@property final const bool isChild ()
{
return p.isChild;
}
/***********************************************************************
Replace all 'from' instances with 'to'.
***********************************************************************/
final FilePath replace (char from, char to)
{
.replace (path, from, to);
return this;
}
/***********************************************************************
Convert path separators to a standard format, using '/' as
the path separator. This is compatible with URI and all of
the contemporary O/S which Tango supports. Known exceptions
include the Windows command-line processor, which considers
'/' characters to be switches instead. Use the native()
method to support that.
Note: mutates the current path.
***********************************************************************/
@property final FilePath standard ()
{
.standard (path);
return this;
}
/***********************************************************************
Convert to native O/S path separators where that is required,
such as when dealing with the Windows command-line.
Note: Mutates the current path. Use this pattern to obtain a
copy instead: path.dup.native
***********************************************************************/
@property final FilePath native ()
{
.native (path);
return this;
}
/***********************************************************************
Concatenate text to this path; no separators are added.
See_also: $(SYMLINK FilePath.join, join)()
***********************************************************************/
final FilePath cat (const(char[])[] others...)
{
foreach (other; others)
{
auto len = p.end_ + other.length;
expand (len);
p.fp [p.end_ .. len] = other;
p.fp [len] = 0;
p.end_ = cast(int)len;
}
return parse();
}
/***********************************************************************
Append a folder to this path. A leading separator is added
as required.
***********************************************************************/
final FilePath append (const(char)[] path)
{
if (file.length)
path = prefixed (path);
return cat (path);
}
/***********************************************************************
Prepend a folder to this path. A trailing separator is added
if needed.
***********************************************************************/
final FilePath prepend (const(char)[] path)
{
adjust (0, p.folder_, p.folder_, padded (path));
return parse();
}
/***********************************************************************
Reset the content of this path to that of another and
reparse.
***********************************************************************/
FilePath set (FilePath path)
{
return set (path.toString(), false);
}
/***********************************************************************
Reset the content of this path, and reparse. There's an
optional boolean flag to convert the path into standard
form, before parsing (converting '\' into '/').
***********************************************************************/
final FilePath set (const(char)[] path, bool convert = false)
{
p.end_ = cast(int)path.length;
expand (p.end_);
if (p.end_)
{
p.fp[0 .. p.end_] = path;
if (convert)
.standard (p.fp [0 .. p.end_]);
}
p.fp[p.end_] = '\0';
return parse();
}
/***********************************************************************
Sidestep the normal lookup for paths that are known to
be folders. Where folder is true, file system lookups
will be skipped.
***********************************************************************/
@property final FilePath isFolder (bool folder)
{
dir_ = folder;
return this;
}
/***********************************************************************
Replace the root portion of this path.
***********************************************************************/
@property final FilePath root (const(char)[] other)
{
auto x = adjust (0, p.folder_, p.folder_, padded (other, ':'));
p.folder_ += x;
p.suffix_ += x;
p.name_ += x;
return this;
}
/***********************************************************************
Replace the folder portion of this path. The folder will be
padded with a path-separator as required.
***********************************************************************/
@property final FilePath folder (const(char)[] other)
{
auto x = adjust (p.folder_, p.name_, p.name_ - p.folder_, padded (other));
p.suffix_ += x;
p.name_ += x;
return this;
}
/***********************************************************************
Replace the name portion of this path.
***********************************************************************/
@property final FilePath name (const(char)[] other)
{
auto x = adjust (p.name_, p.suffix_, p.suffix_ - p.name_, other);
p.suffix_ += x;
return this;
}
/***********************************************************************
Replace the suffix portion of this path. The suffix will be
prefixed with a file-separator as required.
***********************************************************************/
@property final FilePath suffix (const(char)[] other)
{
adjust (p.suffix_, p.end_, p.end_ - p.suffix_, prefixed (other, '.'));
return this;
}
/***********************************************************************
Replace the root and folder portions of this path and
reparse. The replacement will be padded with a path
separator as required.
***********************************************************************/
@property final FilePath path (const(char)[] other)
{
adjust (0, p.name_, p.name_, padded (other));
return parse();
}
/***********************************************************************
Replace the file and suffix portions of this path and
reparse. The replacement will be prefixed with a suffix
separator as required.
***********************************************************************/
@property final FilePath file (const(char)[] other)
{
adjust (p.name_, p.end_, p.end_ - p.name_, other);
return parse();
}
/***********************************************************************
Pop to the parent of the current filepath (in situ - mutates
this FilePath). Note that this differs from parent() in that
it does not include any special cases.
***********************************************************************/
final FilePath pop ()
{
version (SpecialPop)
p.end_ = p.parent.length;
else
p.end_ = cast(int)p.pop().length;
p.fp [p.end_] = '\0';
return parse();
}
/***********************************************************************
Join a set of path specs together. A path separator is
potentially inserted between each of the segments.
***********************************************************************/
static char[] join (const(char[])[] paths...)
{
return FS.join (paths);
}
/***********************************************************************
Convert this FilePath to absolute format, using the given
prefix as necessary. If this FilePath is already absolute,
return it intact.
Returns this FilePath, adjusted as necessary.
***********************************************************************/
final FilePath absolute (const(char)[] prefix)
{
if (! isAbsolute)
prepend (padded(prefix));
return this;
}
/***********************************************************************
Return an adjusted path such that non-empty instances do not
have a trailing separator.
***********************************************************************/
static inout(char)[] stripped (inout(char)[] path, char c = FileConst.PathSeparatorChar)
{
return FS.stripped (path, c);
}
/***********************************************************************
Return an adjusted path such that non-empty instances always
have a trailing separator.
***********************************************************************/
static inout(char[]) padded (inout(char[]) path, char c = FileConst.PathSeparatorChar)
{
return FS.padded (path, c);
}
/***********************************************************************
Return an adjusted path such that non-empty instances always
have a prefixed separator.
***********************************************************************/
static inout(char)[] prefixed (inout(char)[] s, char c = FileConst.PathSeparatorChar)
{
if (s.length && s[0] != c)
s = c ~ s;
return s;
}
/***********************************************************************
Parse the path spec, and mutate '\' into '/' as necessary.
***********************************************************************/
private final FilePath parse ()
{
p.parse (p.fp, p.end_);
return this;
}
/***********************************************************************
Potentially make room for more content.
***********************************************************************/
private final void expand (size_t size)
{
++size;
if (p.fp.length < size)
p.fp.length = (size + 127) & ~127;
}
/***********************************************************************
Insert/delete internal content.
***********************************************************************/
private final int adjust (int head, int tail, int len, const(char)[] sub)
{
len = cast(int)(sub.length - len);
// don't destroy self-references!
if (len && sub.ptr >= p.fp.ptr+head+len && sub.ptr < p.fp.ptr+p.fp.length)
{
char[512] tmp = void;
assert (sub.length < tmp.length);
sub = tmp[0..sub.length] = sub;
}
// make some room if necessary
expand (len + p.end_);
// slide tail around to insert or remove space
memmove (p.fp.ptr+tail+len, p.fp.ptr+tail, p.end_ +1 - tail);
// copy replacement
memmove (p.fp.ptr + head, sub.ptr, sub.length);
// adjust length
p.end_ += len;
return len;
}
/* ****************************************************************** */
/* ******************** file system methods ************************* */
/* ****************************************************************** */
/***********************************************************************
Create an entire path consisting of this folder along with
all parent folders. The path must not contain '.' or '..'
segments. Related methods include PathUtil.normalize() and
absolute().
Note that each segment is created as a folder, including the
trailing segment.
Returns: A chaining reference (this).
Throws: IOException upon systen errors.
Throws: IllegalArgumentException if a segment exists but as
a file instead of a folder.
***********************************************************************/
final FilePath create ()
{
createPath (this.toString());
return this;
}
/***********************************************************************
List the set of filenames within this folder, using
the provided filter to control the list:
---
bool delegate (FilePath path, bool isFolder) Filter;
---
Returning true from the filter includes the given path,
whilst returning false excludes it. Parameter 'isFolder'
indicates whether the path is a file or folder.
Note that paths composed of '.' characters are ignored.
***********************************************************************/
final FilePath[] toList (Filter filter = null)
{
FilePath[] paths;
foreach (info; this)
{
auto p = from (info);
// test this entry for inclusion
if (filter is null || filter (p, info.folder))
paths ~= p;
else
delete p;
}
return paths;
}
/***********************************************************************
Construct a FilePath from the given FileInfo.
***********************************************************************/
static FilePath from (ref FileInfo info)
{
char[512] tmp = void;
auto len = info.path.length + info.name.length;
assert (tmp.length - len > 1);
// construct full pathname
tmp [0 .. info.path.length] = info.path;
tmp [info.path.length .. len] = info.name;
return FilePath(tmp[0 .. len]).isFolder(info.folder);
}
/***********************************************************************
Does this path currently exist?.
***********************************************************************/
@property final bool exists () inout
{
auto cstr = cString();
return FS.exists (cstr);
}
/***********************************************************************
Returns the time of the last modification. Accurate
to whatever the OS supports, and in a format dictated
by the file system. For example NTFS keeps UTC time,
while FAT timestamps are based on the local time.
***********************************************************************/
@property final const Time modified ()
{
return timeStamps().modified;
}
/***********************************************************************
Returns the time of the last access. Accurate to
whatever the OS supports, and in a format dictated
by the file system. For example NTFS keeps UTC time,
while FAT timestamps are based on the local time.
***********************************************************************/
@property final const Time accessed ()
{
return timeStamps().accessed;
}
/***********************************************************************
Returns the time of file creation. Accurate to
whatever the OS supports, and in a format dictated
by the file system. For example NTFS keeps UTC time,
while FAT timestamps are based on the local time.
***********************************************************************/
@property final const Time created ()
{
return timeStamps().created;
}
/***********************************************************************
Change the name or location of a file/directory, and
adopt the provided Path.
***********************************************************************/
final FilePath rename (FilePath dst)
{
FS.rename (cString(), dst.cString());
return this.set (dst);
}
/***********************************************************************
Transfer the content of another file to this one. Returns a
reference to this class on success, or throws an IOException
upon failure.
***********************************************************************/
final inout(FilePath) copy (const(char)[] source) inout
{
FS.copy (source~'\0', cString());
return this;
}
/***********************************************************************
Return the file length (in bytes).
***********************************************************************/
final const ulong fileSize ()
{
return FS.fileSize (cString());
}
/***********************************************************************
Is this file writable?
***********************************************************************/
@property final const bool isWritable ()
{
return FS.isWritable (cString());
}
/***********************************************************************
Is this file actually a folder/directory?
***********************************************************************/
@property final const bool isFolder ()
{
if (dir_)
return true;
return FS.isFolder (cString());
}
/***********************************************************************
Is this a regular file?
***********************************************************************/
@property final const bool isFile ()
{
if (dir_)
return false;
return FS.isFile (cString());
}
/***********************************************************************
Return timestamp information.
Timstamps are returns in a format dictated by the
file system. For example NTFS keeps UTC time,
while FAT timestamps are based on the local time.
***********************************************************************/
final const Stamps timeStamps ()
{
return FS.timeStamps (cString());
}
/***********************************************************************
Transfer the content of another file to this one. Returns a
reference to this class on success, or throws an IOException
upon failure.
***********************************************************************/
final inout(FilePath) copy (const(FilePath) src) inout
{
FS.copy (src.cString(), cString());
return this;
}
/***********************************************************************
Remove the file/directory from the file system.
***********************************************************************/
final inout(FilePath) remove () inout
{
FS.remove (cString());
return this;
}
/***********************************************************************
change the name or location of a file/directory, and
adopt the provided Path.
***********************************************************************/
final FilePath rename (const(char)[] dst)
{
FS.rename (cString(), dst~'\0');
return this.set (dst, true);
}
/***********************************************************************
Create a new file.
***********************************************************************/
final inout(FilePath) createFile () inout
{
FS.createFile (cString());
return this;
}
/***********************************************************************
Create a new directory.
***********************************************************************/
final inout(FilePath) createFolder () inout
{
FS.createFolder (cString());
return this;
}
/***********************************************************************
List the set of filenames within this folder.
Each path and filename is passed to the provided
delegate, along with the path prefix and whether
the entry is a folder or not.
Returns the number of files scanned.
***********************************************************************/
final const int opApply (scope int delegate(ref FileInfo) dg)
{
return FS.list (cString(), dg);
}
}
/*******************************************************************************
*******************************************************************************/
interface PathView
{
alias FS.Stamps Stamps;
//alias FS.FileInfo FileInfo;
/***********************************************************************
Return the complete text of this filepath.
***********************************************************************/
const immutable(char)[] toString ();
/***********************************************************************
Return the complete text of this filepath.
***********************************************************************/
inout(char)[] cString() () inout;
/***********************************************************************
Return the root of this path. Roots are constructs such as
"C:".
***********************************************************************/
@property inout(char)[] root () inout;
/***********************************************************************
Return the file path. Paths may start and end with a "/".
The root path is "/" and an unspecified path is returned as
an empty string. Directory paths may be split such that the
directory name is placed into the 'name' member; directory
paths are treated no differently than file paths.
***********************************************************************/
@property inout(char)[] folder () inout;
/***********************************************************************
Return the name of this file, or directory, excluding a
suffix.
***********************************************************************/
@property inout(char)[] name () inout;
/***********************************************************************
Ext is the tail of the filename, rightward of the rightmost
'.' separator e.g. path "foo.bar" has ext "bar". Note that
patterns of adjacent separators are treated specially; for
example, ".." will wind up with no ext at all.
***********************************************************************/
@property char[] ext ();
/***********************************************************************
Suffix is like ext, but includes the separator e.g. path
"foo.bar" has suffix ".bar".
***********************************************************************/
@property inout(char)[] suffix () inout;
/***********************************************************************
Return the root + folder combination.
***********************************************************************/
@property inout(char)[] path () inout;
/***********************************************************************
Return the name + suffix combination.
***********************************************************************/
@property inout(char)[] file () inout;
/***********************************************************************
Returns true if this FilePath is *not* relative to the
current working directory.
***********************************************************************/
@property const bool isAbsolute ();
/***********************************************************************
Returns true if this FilePath is empty.
***********************************************************************/
@property const bool isEmpty ();
/***********************************************************************
Returns true if this FilePath has a parent.
***********************************************************************/
@property const bool isChild ();
/***********************************************************************
Does this path currently exist?
***********************************************************************/
@property bool exists () inout;
/***********************************************************************
Returns the time of the last modification. Accurate
to whatever the OS supports.
***********************************************************************/
@property const Time modified ();
/***********************************************************************
Returns the time of the last access. Accurate to
whatever the OS supports.
***********************************************************************/
@property const Time accessed ();
/***********************************************************************
Returns the time of file creation. Accurate to
whatever the OS supports.
***********************************************************************/
@property const Time created ();
/***********************************************************************
Return the file length (in bytes).
***********************************************************************/
@property const ulong fileSize ();
/***********************************************************************
Is this file writable?
***********************************************************************/
@property const bool isWritable ();
/***********************************************************************
Is this file actually a folder/directory?
***********************************************************************/
@property const bool isFolder ();
/***********************************************************************
Return timestamp information.
***********************************************************************/
@property const Stamps timeStamps ();
}
/*******************************************************************************
*******************************************************************************/
debug (UnitTest)
{
unittest
{
version(Win32)
{
assert (FilePath("/foo".dup).append("bar").pop() == "/foo");
assert (FilePath("/foo/".dup).append("bar").pop() == "/foo");
auto fp = new FilePath(r"C:/home/foo/bar".dup);
fp ~= "john";
assert (fp == r"C:/home/foo/bar/john");
fp.set (r"C:/");
fp ~= "john";
assert (fp == r"C:/john");
fp.set("foo.bar");
fp ~= "john";
assert (fp == r"foo.bar/john");
fp.set("");
fp ~= "john";
assert (fp == r"john");
fp.set(r"C:/home/foo/bar/john/foo.d".dup);
assert (fp.pop() == r"C:/home/foo/bar/john");
assert (fp.pop() == r"C:/home/foo/bar");
assert (fp.pop() == r"C:/home/foo");
assert (fp.pop() == r"C:/home");
assert (fp.pop() == r"C:");
assert (fp.pop() == r"C:");
// special case for popping empty names
fp.set (r"C:/home/foo/bar/john/".dup);
assert (fp.parent == r"C:/home/foo/bar");
fp = new FilePath;
fp.set (r"C:/home/foo/bar/john/".dup);
assert (fp.isAbsolute);
assert (fp.name == "");
assert (fp.folder == r"/home/foo/bar/john/");
assert (fp == r"C:/home/foo/bar/john/");
assert (fp.path == r"C:/home/foo/bar/john/");
assert (fp.file == r"");
assert (fp.suffix == r"");
assert (fp.root == r"C:");
assert (fp.ext == "");
assert (fp.isChild);
fp = new FilePath(r"C:/home/foo/bar/john".dup);
assert (fp.isAbsolute);
assert (fp.name == "john");
assert (fp.folder == r"/home/foo/bar/");
assert (fp == r"C:/home/foo/bar/john");
assert (fp.path == r"C:/home/foo/bar/");
assert (fp.file == r"john");
assert (fp.suffix == r"");
assert (fp.ext == "");
assert (fp.isChild);
fp.pop();
assert (fp.isAbsolute);
assert (fp.name == "bar");
assert (fp.folder == r"/home/foo/");
assert (fp == r"C:/home/foo/bar");
assert (fp.path == r"C:/home/foo/");
assert (fp.file == r"bar");
assert (fp.suffix == r"");
assert (fp.ext == "");
assert (fp.isChild);
fp.pop();
assert (fp.isAbsolute);
assert (fp.name == "foo");
assert (fp.folder == r"/home/");
assert (fp == r"C:/home/foo");
assert (fp.path == r"C:/home/");
assert (fp.file == r"foo");
assert (fp.suffix == r"");
assert (fp.ext == "");
assert (fp.isChild);
fp.pop();
assert (fp.isAbsolute);
assert (fp.name == "home");
assert (fp.folder == r"/");
assert (fp == r"C:/home");
assert (fp.path == r"C:/");
assert (fp.file == r"home");
assert (fp.suffix == r"");
assert (fp.ext == "");
assert (fp.isChild);
fp = new FilePath(r"foo/bar/john.doe".dup);
assert (!fp.isAbsolute);
assert (fp.name == "john");
assert (fp.folder == r"foo/bar/");
assert (fp.suffix == r".doe");
assert (fp.file == r"john.doe");
assert (fp == r"foo/bar/john.doe");
assert (fp.ext == "doe");
assert (fp.isChild);
fp = new FilePath(r"c:doe".dup);
assert (fp.isAbsolute);
assert (fp.suffix == r"");
assert (fp == r"c:doe");
assert (fp.folder == r"");
assert (fp.name == "doe");
assert (fp.file == r"doe");
assert (fp.ext == "");
assert (!fp.isChild);
fp = new FilePath(r"/doe".dup);
assert (fp.isAbsolute);
assert (fp.suffix == r"");
assert (fp == r"/doe");
assert (fp.name == "doe");
assert (fp.folder == r"/");
assert (fp.file == r"doe");
assert (fp.ext == "");
assert (fp.isChild);
fp = new FilePath(r"john.doe.foo".dup);
assert (!fp.isAbsolute);
assert (fp.name == "john.doe");
assert (fp.folder == r"");
assert (fp.suffix == r".foo");
assert (fp == r"john.doe.foo");
assert (fp.file == r"john.doe.foo");
assert (fp.ext == "foo");
assert (!fp.isChild);
fp = new FilePath(r".doe".dup);
assert (!fp.isAbsolute);
assert (fp.suffix == r"");
assert (fp == r".doe");
assert (fp.name == ".doe");
assert (fp.folder == r"");
assert (fp.file == r".doe");
assert (fp.ext == "");
assert (!fp.isChild);
fp = new FilePath(r"doe".dup);
assert (!fp.isAbsolute);
assert (fp.suffix == r"");
assert (fp == r"doe");
assert (fp.name == "doe");
assert (fp.folder == r"");
assert (fp.file == r"doe");
assert (fp.ext == "");
assert (!fp.isChild);
fp = new FilePath(r".".dup);
assert (!fp.isAbsolute);
assert (fp.suffix == r"");
assert (fp == r".");
assert (fp.name == ".");
assert (fp.folder == r"");
assert (fp.file == r".");
assert (fp.ext == "");
assert (!fp.isChild);
fp = new FilePath(r"..".dup);
assert (!fp.isAbsolute);
assert (fp.suffix == r"");
assert (fp == r"..");
assert (fp.name == "..");
assert (fp.folder == r"");
assert (fp.file == r"..");
assert (fp.ext == "");
assert (!fp.isChild);
fp = new FilePath(r"c:/a/b/c/d/e/foo.bar".dup);
assert (fp.isAbsolute);
fp.folder (r"/a/b/c/");
assert (fp.suffix == r".bar");
assert (fp == r"c:/a/b/c/foo.bar");
assert (fp.name == "foo");
assert (fp.folder == r"/a/b/c/");
assert (fp.file == r"foo.bar");
assert (fp.ext == "bar");
assert (fp.isChild);
fp = new FilePath(r"c:/a/b/c/d/e/foo.bar".dup);
assert (fp.isAbsolute);
fp.folder (r"/a/b/c/d/e/f/g/");
assert (fp.suffix == r".bar");
assert (fp == r"c:/a/b/c/d/e/f/g/foo.bar");
assert (fp.name == "foo");
assert (fp.folder == r"/a/b/c/d/e/f/g/");
assert (fp.file == r"foo.bar");
assert (fp.ext == "bar");
assert (fp.isChild);
fp = new FilePath(r"C:/foo/bar/test.bar".dup);
assert (fp.path == "C:/foo/bar/");
fp = new FilePath(r"C:\foo\bar\test.bar".dup);
assert (fp.path == r"C:/foo/bar/");
fp = new FilePath("".dup);
assert (fp.isEmpty);
assert (!fp.isChild);
assert (!fp.isAbsolute);
assert (fp.suffix == r"");
assert (fp == r"");
assert (fp.name == "");
assert (fp.folder == r"");
assert (fp.file == r"");
assert (fp.ext == "");
/+
fp = new FilePath(r"C:/foo/bar/test.bar");
fp = new FilePath(fp.asPath ("foo"));
assert (fp.name == r"test");
assert (fp.folder == r"foo/");
assert (fp.path == r"C:foo/");
assert (fp.ext == ".bar");
fp = new FilePath(fp.asPath (""));
assert (fp.name == r"test");
assert (fp.folder == r"");
assert (fp.path == r"C:");
assert (fp.ext == ".bar");
fp = new FilePath(r"c:/joe/bar");
assert(fp.cat(r"foo/bar/") == r"c:/joe/bar/foo/bar/");
assert(fp.cat(new FilePath(r"foo/bar")).toString == r"c:/joe/bar/foo/bar");
assert (FilePath.join (r"a/b/c/d", r"e/f/" r"g") == r"a/b/c/d/e/f/g");
fp = new FilePath(r"C:/foo/bar/test.bar");
assert (fp.asExt(null) == r"C:/foo/bar/test");
assert (fp.asExt("foo") == r"C:/foo/bar/test.foo");
+/
}
}
}
debug (FilePath)
{
import tango.io.Console;
void main()
{
assert (FilePath("/foo/").create.exists);
Cout (FilePath("c:/temp/").file("foo.bar")).newline;
}
}
|