Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page.
Requires a signed-in GitHub account. This works well for small changes.
If you'd like to make larger changes you may want to consider using
a local clone.
dmd.root.filename
Compiler implementation of the D programming language
http://dlang.org
Authors:
Walter Bright, http://www.digitalmars.com
License:
Source root/filename.d
Documentation https://dlang.org/phobos/dmd_root_filename.html
- struct
FileName; - Encapsulate path and file names.
- pure nothrow this(const(char)[]
str); - static pure nothrow @nogc bool
equals(const(char)*name1, const(char)*name2);
static pure nothrow @nogc boolequals(const(char)[]name1, const(char)[]name2); - Compare two name according to the platform's rules (case sensitive or not)
- static pure nothrow @nogc bool
absolute(const(char)*name);
static pure nothrow @nogc boolabsolute(const(char)[]name); - Determine if path is absolute.Parameters:
const(char)* namepath Returns:true if absolute path name. - static nothrow const(char)*
toAbsolute(const(char)*name, const(char)*base= null); - Return the given name as an absolute pathParameters:
const(char)* namepath const(char)* basethe absolute base to prefix name with if it is relative Returns:name as an absolute path relative to base - static pure nothrow @nogc const(char)*
ext(const(char)*str);
static pure nothrow @nogc @safe const(char)[]ext(const(char)[]str); - Determine file name extension as slice of input.Parameters:
const(char)* strfile name Returns:filename extension (read-only). Points past '.' of extension. If there isn't one, return null. - static nothrow const(char)*
removeExt(const(char)*str);
static nothrow const(char)[]removeExt(const(char)[]str); - Return file name without extension.
TODO Once slice are used everywhere and \0 is not assumed, this can be turned into a simple slicing.
Parameters:const(char)* strfile name Returns:mem.xmalloc'd filename with extension removed. - static pure nothrow @nogc const(char)*
name(const(char)*str);
static pure nothrow @nogc const(char)[]name(const(char)[]str); - Return filename name excluding path (read-only).
- static nothrow const(char)*
path(const(char)*str);
static nothrow const(char)[]path(const(char)[]str); - Return path portion of str. returned string is newly allocated Path does not include trailing path separator.
- static nothrow const(char)[]
replaceName(const(char)[]path, const(char)[]name); - Replace filename portion of path.
- static nothrow const(char)*
combine(const(char)*path, const(char)*name);
static nothrow const(char)[]combine(const(char)[]path, const(char)[]name); - Combine a
pathand a filenameParameters:const(char)* pathPath to append to const(char)* nameName to append to path Returns:The \0 terminated string which is the combination ofpathandnameand a valid path. - static nothrow void
splitPath(int delegate(const(char)*) nothrowsink, const(char)*path); - Split path (such as that returned by getenv("PATH")) into pieces, each piece is mem.xmalloc'd Handle double quotes and ~. Pass the pieces to sink()Parameters:
int delegate(const(char)*) nothrow sinksend the path pieces here, end when sink() returns !=0 const(char)* paththe path to split up. - static pure nothrow char[]
addExt(const(char)[]name, const(char)[]ext); - Add the extension
exttoname, regardless of the content ofnameParameters:const(char)[] namePath to append the extension to const(char)[] extExtension to add (should not include '.') Returns:A newly allocated string (free with FileName.free) - static nothrow const(char)*
defaultExt(const(char)*name, const(char)*ext);
static nothrow const(char)[]defaultExt(const(char)[]name, const(char)[]ext); - Free returned value with FileName::free()
- static nothrow const(char)*
forceExt(const(char)*name, const(char)*ext);
static nothrow const(char)[]forceExt(const(char)[]name, const(char)[]ext); - Free returned value with FileName::free()
- static pure nothrow @nogc bool
equalsExt(const(char)*name, const(char)*ext);
static pure nothrow @nogc boolequalsExt(const(char)[]name, const(char)[]ext); - Returns:true if
name's extension isext - const pure nothrow @nogc bool
equalsExt(const(char)*ext); - Return !=0 if extensions match.
- static nothrow const(char)*
searchPath(Strings*path, const(char)*name, boolcwd); - Search paths for file.Parameters:
Strings* patharray of path strings const(char)* namefile to look for bool cwdtrue means search current directory before searching path Returns:if found, filename combined with path, otherwise null - static nothrow const(char)*
safeSearchPath(Strings*path, const(char)*name); - Search Path for file in a safe manner.Be wary of CWE-22: Improper Limitation of a Pathname to a Restricted Directory ('Path Traversal') attacks. http://cwe.mitre.org/data/definitions/22.html More info: https://www.securecoding.cert.org/confluence/display/c/FIO02-C.+Canonicalize+path+names+originating+from+tainted+sourcesReturns:NULL file not found !=NULL mem.xmalloc'd file name
- static nothrow int
exists(const(char)*name);
static nothrow intexists(const(char)[]name); - Check if the file the path points to existsReturns:0 if it does not exists 1 if it exists and is not a directory 2 if it exists and is a directory
- static nothrow bool
ensurePathExists(const(char)[]path);
static nothrow boolensurePathExists(const(char)*path); - Ensure that the provided path existsAccepts a path to either a file or a directory. In the former case, the basepath (path to the containing directory) will be checked for existence, and created if it does not exists. In the later case, the directory pointed to will be checked for existence and created if needed.Parameters:
const(char)[] patha path to a file or a directory Returns:true if the directory exists or was successfully created - static nothrow const(char)*
canonicalName(const(char)*name);
static nothrow const(char)[]canonicalName(const(char)[]name); - Return canonical version of name in a malloc'd buffer. This code is high risk.
- static pure nothrow void
free(const(char)*str); - Free memory allocated by FileName routines
Copyright © 1999-2019 by the D Language Foundation | Page generated by
Ddoc on Sun Sep 1 19:49:36 2019