File access permission, modelled after UNIX.

See also:

• getFilePermissions
• setFilePermissions
• FileInfo object

Enumeration specifying a path component.

See also:

• walkDirRec iterator
• FileInfo object

Contains information associated with a file object.

See also:

• getFileInfo(handle) proc
• getFileInfo(file) proc
• getFileInfo(path) proc

The constant character used by the operating system to refer to the current directory.

For example: '.' for POSIX or ':' for the classic Macintosh.

The constant string used by the operating system to refer to the parent directory.

For example: ".." for POSIX or "::" for the classic Macintosh.

Examples:

when defined(posix):
  assert normalizePathEnd("/lib//.//", trailingSep = true) == "/lib/"
  assert normalizePathEnd("lib/./.", trailingSep = false) == "lib"
  assert normalizePathEnd(".//./.", trailingSep = false) == "."
  assert normalizePathEnd("", trailingSep = true) == ""
  assert normalizePathEnd("/", trailingSep = false) == "/"

Joins two directory names to one.

returns normalized path concatenation of head and tail, preserving whether or not tail has a trailing slash (or, if tail if empty, whether head has one).

See also:

• joinPath(varargs) proc
• / proc
• splitPath proc
• uri.combine proc
• uri./ proc

Examples:

when defined(posix):
  assert joinPath("usr", "lib") == "usr/lib"
  assert joinPath("usr", "lib/") == "usr/lib/"
  assert joinPath("usr", "") == "usr"
  assert joinPath("usr/", "") == "usr/"
  assert joinPath("", "") == ""
  assert joinPath("", "lib") == "lib"
  assert joinPath("", "/lib") == "/lib"
  assert joinPath("usr/", "/lib") == "usr/lib"
  assert joinPath("usr/lib", "../bin") == "usr/bin"

The same as joinPath(head, tail) proc, but works with any number of directory parts.

You need to pass at least one element or the proc will assert in debug builds and crash on release builds.

See also:

• joinPath(head, tail) proc
• / proc
• /../ proc
• splitPath proc

Examples:

when defined(posix):
  assert joinPath("a") == "a"
  assert joinPath("a", "b", "c") == "a/b/c"
  assert joinPath("usr/lib", "../../var", "log") == "var/log"

The same as joinPath(head, tail) proc.

See also:

• /../ proc
• joinPath(head, tail) proc
• joinPath(varargs) proc
• splitPath proc
• uri.combine proc
• uri./ proc

Examples:

when defined(posix):
  assert "usr" / "" == "usr"
  assert "" / "lib" == "lib"
  assert "" / "/lib" == "/lib"
  assert "usr/" / "/lib/" == "usr/lib/"
  assert "usr" / "lib" / "../bin" == "usr/bin"

Splits a directory into (head, tail) tuple, so that head / tail == path (except for edge cases like "/usr").

See also:

• joinPath(head, tail) proc
• joinPath(varargs) proc
• / proc
• /../ proc
• relativePath proc

Examples:

assert splitPath("usr/local/bin") == ("usr/local", "bin")
assert splitPath("usr/local/bin/") == ("usr/local/bin", "")
assert splitPath("/bin/") == ("/bin", "")
when (NimMajor, NimMinor) <= (1, 0):
  assert splitPath("/bin") == ("", "bin")
else:
  assert splitPath("/bin") == ("/", "bin")
assert splitPath("bin") == ("", "bin")
assert splitPath("") == ("", "")

Checks whether a given path is absolute.

On Windows, network paths are considered absolute too.

Examples:

assert not "".isAbsolute
assert not ".".isAbsolute
when defined(posix):
  assert "/".isAbsolute
  assert not "a/".isAbsolute
  assert "/a/".isAbsolute

Converts path to a path relative to base.

The sep (default: DirSep) is used for the path normalizations, this can be useful to ensure the relative path only contains '/' so that it can be used for URL constructions.

On windows, if a root of path and a root of base are different, returns path as is because it is impossible to make a relative path. That means an absolute path can be returned.

See also:

• splitPath proc
• parentDir proc
• tailDir proc

Examples:

assert relativePath("/Users/me/bar/z.nim", "/Users/other/bad", '/') ==
    "../../me/bar/z.nim"
assert relativePath("/Users/me/bar/z.nim", "/Users/other", '/') ==
    "../me/bar/z.nim"
assert relativePath("/Users///me/bar//z.nim", "//Users/", '/') == "me/bar/z.nim"
assert relativePath("/Users/me/bar/z.nim", "/Users/me", '/') == "bar/z.nim"
assert relativePath("", "/users/moo", '/') == ""
assert relativePath("foo", ".", '/') == "foo"
assert relativePath("foo", "foo", '/') == "."

Examples:

doAssert isRelativeTo("./foo//bar", "foo")
doAssert isRelativeTo("foo/bar", ".")
doAssert isRelativeTo("/foo/bar.nim", "/foo/bar.nim")
doAssert not isRelativeTo("foo/bar.nims", "foo/bar.nim")

Returns the parent directory of path.

This is similar to splitPath(path).head when path doesn't end in a dir separator, but also takes care of path normalizations. The remainder can be obtained with lastPathPart(path) proc.

See also:

• relativePath proc
• splitPath proc
• tailDir proc
• parentDirs iterator

Examples:

assert parentDir("") == ""
when defined(posix):
  assert parentDir("/usr/local/bin") == "/usr/local"
  assert parentDir("foo/bar//") == "foo"
  assert parentDir("//foo//bar//.") == "/foo"
  assert parentDir("./foo") == "."
  assert parentDir("/./foo//./") == "/"
  assert parentDir("a//./") == "."
  assert parentDir("a/b/c/..") == "a"

Returns the tail part of path.

See also:

• relativePath proc
• splitPath proc
• parentDir proc

Examples:

assert tailDir("/bin") == "bin"
assert tailDir("bin") == ""
assert tailDir("bin/") == ""
assert tailDir("/usr/local/bin") == "usr/local/bin"
assert tailDir("//usr//local//bin//") == "usr//local//bin//"
assert tailDir("./usr/local/bin") == "usr/local/bin"
assert tailDir("usr/local/bin") == "local/bin"

Examples:

assert isRootDir("")
assert isRootDir(".")
assert isRootDir("/")
assert isRootDir("a")
assert not isRootDir("/a")
assert not isRootDir("a/b/c")

The same as parentDir(head) / tail, unless there is no parent directory. Then head / tail is performed instead.

See also:

• / proc
• parentDir proc

Examples:

when defined(posix):
  assert "a/b/c" /../ "d/e" == "a/b/d/e"
  assert "a" /../ "d/e" == "a/d/e"

Returns index of the '.' char in path if it signifies the beginning of extension. Returns -1 otherwise.

See also:

• splitFile proc
• extractFilename proc
• lastPathPart proc
• changeFileExt proc
• addFileExt proc

Examples:

assert searchExtPos("a/b/c") == -1
assert searchExtPos("c.nim") == 1
assert searchExtPos("a/b/c.nim") == 5
assert searchExtPos("a.b.c.nim") == 5

Splits a filename into (dir, name, extension) tuple.

dir does not end in DirSep unless it's /. extension includes the leading dot.

If path has no extension, ext is the empty string. If path has no directory component, dir is the empty string. If path has no filename component, name and ext are empty strings.

See also:

• searchExtPos proc
• extractFilename proc
• lastPathPart proc
• changeFileExt proc
• addFileExt proc

Examples:

var (dir, name, ext) = splitFile("usr/local/nimc.html")
assert dir == "usr/local"
assert name == "nimc"
assert ext == ".html"
(dir, name, ext) = splitFile("/usr/local/os")
assert dir == "/usr/local"
assert name == "os"
assert ext == ""
(dir, name, ext) = splitFile("/usr/local/")
assert dir == "/usr/local"
assert name == ""
assert ext == ""
(dir, name, ext) = splitFile("/tmp.txt")
assert dir == "/"
assert name == "tmp"
assert ext == ".txt"

Extracts the filename of a given path.

This is the same as name & ext from splitFile(path) proc.

See also:

• searchExtPos proc
• splitFile proc
• lastPathPart proc
• changeFileExt proc
• addFileExt proc

Examples:

assert extractFilename("foo/bar/") == ""
assert extractFilename("foo/bar") == "bar"
assert extractFilename("foo/bar.baz") == "bar.baz"

Like extractFilename proc, but ignores trailing dir separator; aka: baseName in some other languages.

See also:

• searchExtPos proc
• splitFile proc
• extractFilename proc
• changeFileExt proc
• addFileExt proc

Examples:

assert lastPathPart("foo/bar/") == "bar"
assert lastPathPart("foo/bar") == "bar"

Changes the file extension to ext.

If the filename has no extension, ext will be added. If ext == "" then any extension is removed.

Ext should be given without the leading '.', because some filesystems may use a different character. (Although I know of none such beast.)

See also:

• searchExtPos proc
• splitFile proc
• extractFilename proc
• lastPathPart proc
• addFileExt proc

Examples:

assert changeFileExt("foo.bar", "baz") == "foo.baz"
assert changeFileExt("foo.bar", "") == "foo"
assert changeFileExt("foo", "baz") == "foo.baz"

Adds the file extension ext to filename, unless filename already has an extension.

Ext should be given without the leading '.', because some filesystems may use a different character. (Although I know of none such beast.)

See also:

• searchExtPos proc
• splitFile proc
• extractFilename proc
• lastPathPart proc
• changeFileExt proc

Examples:

assert addFileExt("foo.bar", "baz") == "foo.bar"
assert addFileExt("foo.bar", "") == "foo.bar"
assert addFileExt("foo", "baz") == "foo.baz"

Compares two paths.

On a case-sensitive filesystem this is done case-sensitively otherwise case-insensitively. Returns:

0 iff pathA == pathB
< 0 iff pathA < pathB
> 0 iff pathA > pathB

Examples:

when defined(macosx):
  assert cmpPaths("foo", "Foo") == 0
elif defined(posix):
  assert cmpPaths("foo", "Foo") > 0

Converts an UNIX-like path to a native one.

On an UNIX system this does nothing. Else it converts '/', '.', '..' to the appropriate things.

On systems with a concept of "drives", drive is used to determine which drive label to use during absolute path conversion. drive defaults to the drive of the current working directory, and is ignored on systems that do not have a concept of "drives".

Converts an OS error code into a human readable string.

The error code can be retrieved using the osLastError proc.

If conversion fails, or errorCode is 0 then "" will be returned.

On Windows, the -d:useWinAnsi compilation flag can be used to make this procedure use the non-unicode Win API calls to retrieve the message.

See also:

• raiseOSError proc
• osLastError proc

Examples:

when defined(linux):
  assert osErrorMsg(OSErrorCode(0)) == ""
  assert osErrorMsg(OSErrorCode(1)) == "Operation not permitted"
  assert osErrorMsg(OSErrorCode(2)) == "No such file or directory"

Creates a new OSError exception.

The errorCode will determine the message, osErrorMsg proc will be used to get this message.

The error code can be retrieved using the osLastError proc.

If the error code is 0 or an error message could not be retrieved, the message unknown OS error will be used.

See also:

• osErrorMsg proc
• osLastError proc

Raises an OSError exception.

Read the description of the newOSError proc to learn how the exception object is created.

Retrieves the last operating system error code.

This procedure is useful in the event when an OS call fails. In that case this procedure will return the error code describing the reason why the OS call failed. The OSErrorMsg procedure can then be used to convert this code into a string.

Warning: The behaviour of this procedure varies between Windows and POSIX systems. On Windows some OS calls can reset the error code to 0 causing this procedure to return 0. It is therefore advised to call this procedure immediately after an OS call fails. On POSIX systems this is not a problem.

See also:

• osErrorMsg proc
• raiseOSError proc

Returns the value of the environment variable named key.

If the variable does not exist, "" is returned. To distinguish whether a variable exists or it's value is just "", call existsEnv(key) proc.

See also:

• existsEnv proc
• putEnv proc
• delEnv proc
• envPairs iterator

Examples:

assert getEnv("unknownEnv") == ""
assert getEnv("unknownEnv", "doesn\'t exist") == "doesn\'t exist"

Checks whether the environment variable named key exists. Returns true if it exists, false otherwise.

See also:

• getEnv proc
• putEnv proc
• delEnv proc
• envPairs iterator

Examples:

assert not existsEnv("unknownEnv")

Sets the value of the environment variable named key to val. If an error occurs, OSError is raised.

See also:

• getEnv proc
• existsEnv proc
• delEnv proc
• envPairs iterator

Deletes the environment variable named key. If an error occurs, OSError is raised.

See also:ven

• getEnv proc
• existsEnv proc
• putEnv proc
• envPairs iterator

Returns the home directory of the current user.

This proc is wrapped by the expandTilde proc for the convenience of processing paths coming from user configuration files.

See also:

• getConfigDir proc
• getTempDir proc
• expandTilde proc
• getCurrentDir proc
• setCurrentDir proc

Examples:

assert getHomeDir() == expandTilde("~")

Returns the config directory of the current user for applications.

On non-Windows OSs, this proc conforms to the XDG Base Directory spec. Thus, this proc returns the value of the XDG_CONFIG_HOME environment variable if it is set, otherwise it returns the default configuration directory ("~/.config/").

An OS-dependent trailing slash is always present at the end of the returned string: \ on Windows and / on all other OSs.

See also:

• getHomeDir proc
• getTempDir proc
• expandTilde proc
• getCurrentDir proc
• setCurrentDir proc

Returns the temporary directory of the current user for applications to save temporary files in.

Please do not use this: On Android, it currently returns getHomeDir(), and on other Unix based systems it can cause security problems too. That said, you can override this implementation by adding -d:tempDir=mytempname to your compiler invocation.

See also:

• getHomeDir proc
• getConfigDir proc
• expandTilde proc
• getCurrentDir proc
• setCurrentDir proc

Expands ~ or a path starting with ~/ to a full path, replacing ~ with getHomeDir() (otherwise returns path unmodified).

Windows: this is still supported despite Windows platform not having this convention; also, both ~/ and ~\ are handled.

See also:

• getHomeDir proc
• getConfigDir proc
• getTempDir proc
• getCurrentDir proc
• setCurrentDir proc

Examples:

assert expandTilde("~" / "appname.cfg") == getHomeDir() / "appname.cfg"
assert expandTilde("~/foo/bar") == getHomeDir() / "foo/bar"
assert expandTilde("/foo/bar") == "/foo/bar"

Quote s, so it can be safely passed to Windows API.

Based on Python's subprocess.list2cmdline. See this link for more details.

Quote s, so it can be safely passed to shell.

When on Windows, it calls quoteShellWindows proc. Otherwise, calls quoteShellPosix proc.

Examples:

when defined(posix):
  assert quoteShellCommand(["aaa", "", "c d"]) == "aaa \'\' \'c d\'"
when defined(windows):
  assert quoteShellCommand(["aaa", "", "c d"]) == "aaa \"\" \"c d\""

Returns true if filename exists and is a regular file or symlink.

Directories, device files, named pipes and sockets return false.

See also:

• existsDir proc
• symlinkExists proc

Returns true iff the directory dir exists. If dir is a file, false is returned. Follows symlinks.

See also:

• existsFile proc
• symlinkExists proc

Returns true iff the symlink link exists. Will return true regardless of whether the link points to a directory or file.

See also:

• existsFile proc
• existsDir proc

Alias for existsFile proc.

See also:

• existsDir proc
• symlinkExists proc

Alias for existsDir proc.

See also:

• existsFile proc
• symlinkExists proc

Searches for exe in the current working directory and then in directories listed in the PATH environment variable.

Returns "" if the exe cannot be found. exe is added the ExeExts file extensions if it has none.

If the system supports symlinks it also resolves them until it meets the actual file. This behavior can be disabled if desired by setting followSymlinks = false.

Returns the file's last modification time.

See also:

• getLastAccessTime proc
• getCreationTime proc
• fileNewer proc

Returns the file's last read or write access time.

See also:

• getLastModificationTime proc
• getCreationTime proc
• fileNewer proc

Returns the file's creation time.

Note: Under POSIX OS's, the returned time may actually be the time at which the file's attribute's were last modified. See here for details.

See also:

• getLastModificationTime proc
• getLastAccessTime proc
• fileNewer proc

Returns true if the file a is newer than file b, i.e. if a's modification time is later than b's.

See also:

• getLastModificationTime proc
• getLastAccessTime proc
• getCreationTime proc

Returns the current working directory i.e. where the built binary is run.

So the path returned by this proc is determined at run time.

See also:

• getHomeDir proc
• getConfigDir proc
• getTempDir proc
• setCurrentDir proc
• currentSourcePath template
• getProjectPath proc

Sets the current working directory; OSError is raised if newDir cannot been set.

See also:

• getHomeDir proc
• getConfigDir proc
• getTempDir proc
• getCurrentDir proc

Returns the absolute path of path, rooted at root (which must be absolute; default: current directory). If path is absolute, return it, ignoring root.

See also:

• normalizedPath proc
• normalizePath proc

Examples:

assert absolutePath("a") == getCurrentDir() / "a"

Normalize a path.

Consecutive directory separators are collapsed, including an initial double slash.

On relative paths, double dot (..) sequences are collapsed if possible. On absolute paths they are always collapsed.

Warning: URL-encoded and Unicode attempts at directory traversal are not detected. Triple dot is not handled.

See also:

• absolutePath proc
• normalizedPath proc for a version which returns a new string

Examples:

when defined(posix):
  var a = "a///b//..//c///d"
  a.normalizePath()
  assert a == "a/c/d"

Returns a normalized path for the current OS.

See also:

• absolutePath proc
• normalizePath proc for the in-place version

Examples:

when defined(posix):
  assert normalizedPath("a///b//..//c///d") == "a/c/d"

Returns true if both pathname arguments refer to the same physical file or directory.

Raises OSError if any of the files does not exist or information about it can not be obtained.

This proc will return true if given two alternative hard-linked or sym-linked paths to the same file or directory.

See also:

• sameFileContent proc

Returns true if both pathname arguments refer to files with identical binary content.

See also:

• sameFile proc

Retrieves file permissions for filename.

OSError is raised in case of an error. On Windows, only the readonly flag is checked, every other permission is available in any case.

See also:

• setFilePermissions proc
• FilePermission enum

Sets the file permissions for filename.

OSError is raised in case of an error. On Windows, only the readonly flag is changed, depending on fpUserWrite permission.

See also:

• getFilePermissions
• FilePermission enum

Copies a file from source to dest.

If this fails, OSError is raised.

On the Windows platform this proc will copy the source file's attributes into dest.

On other platforms you need to use getFilePermissions and setFilePermissions procs to copy them by hand (or use the convenience copyFileWithPermissions proc), otherwise dest will inherit the default permissions of a newly created file for the user.

If dest already exists, the file attributes will be preserved and the content overwritten.

See also:

• copyDir proc
• copyFileWithPermissions proc
• tryRemoveFile proc
• removeFile proc
• moveFile proc

Removes the file.

If this fails, returns false. This does not fail if the file never existed in the first place.

On Windows, ignores the read-only attribute.

See also:

• copyFile proc
• copyFileWithPermissions proc
• removeFile proc
• moveFile proc

Removes the file.

If this fails, OSError is raised. This does not fail if the file never existed in the first place.

On Windows, ignores the read-only attribute.

See also:

• removeDir proc
• copyFile proc
• copyFileWithPermissions proc
• tryRemoveFile proc
• moveFile proc

Moves a file from source to dest.

If this fails, OSError is raised. If dest already exists, it will be overwritten.

Can be used to rename files.

See also:

• moveDir proc
• copyFile proc
• copyFileWithPermissions proc
• removeFile proc
• tryRemoveFile proc

Executes a shell command.

Command has the form 'program args' where args are the command line arguments given to program. The proc returns the error code of the shell when it has finished (zero if there is no error). The proc does not return until the process has finished.

To execute a program without having a shell involved, use osproc.execProcess proc.

Examples:

discard execShellCmd("ls -la")

Returns the full (absolute) path of an existing file filename.

Raises OSError in case of an error. Follows symlinks.

This is getAppFilename() at compile time.

Can be used to retrieve the currently executing Nim compiler from a Nim or nimscript program, or the nimble binary inside a nimble program (likewise with other binaries built from compiler API).

Removes the directory dir including all subdirectories and files in dir (recursively).

If this fails, OSError is raised. This does not fail if the directory never existed in the first place, unless checkDir = true

See also:

• tryRemoveFile proc
• removeFile proc
• existsOrCreateDir proc
• createDir proc
• copyDir proc
• copyDirWithPermissions proc
• moveDir proc

Check if a directory dir exists, and create it otherwise.

Does not create parent directories (fails if parent does not exist). Returns true if the directory already exists, and false otherwise.

See also:

• removeDir proc
• createDir proc
• copyDir proc
• copyDirWithPermissions proc
• moveDir proc

Creates the directory dir.

The directory may contain several subdirectories that do not exist yet. The full path is created. If this fails, OSError is raised.

It does not fail if the directory already exists because for most usages this does not indicate an error.

See also:

• removeDir proc
• existsOrCreateDir proc
• copyDir proc
• copyDirWithPermissions proc
• moveDir proc

Copies a directory from source to dest.

If this fails, OSError is raised.

On the Windows platform this proc will copy the attributes from source into dest.

On other platforms created files and directories will inherit the default permissions of a newly created file/directory for the user. Use copyDirWithPermissions proc to preserve attributes recursively on these platforms.

See also:

• copyDirWithPermissions proc
• copyFile proc
• copyFileWithPermissions proc
• removeDir proc
• existsOrCreateDir proc
• createDir proc
• moveDir proc

Moves a directory from source to dest.

If this fails, OSError is raised.

See also:

• moveFile proc
• copyDir proc
• copyDirWithPermissions proc
• removeDir proc
• existsOrCreateDir proc
• createDir proc

Create a symbolic link at dest which points to the item specified by src. On most operating systems, will fail if a link already exists.

Warning: Some OS's (such as Microsoft Windows) restrict the creation of symlinks to root users (administrators).

See also:

• createHardlink proc
• expandSymlink proc

Create a hard link at dest which points to the item specified by src.

Warning: Some OS's restrict the creation of hard links to root users (administrators).

See also:

• createSymlink proc

Copies a file from source to dest preserving file permissions.

This is a wrapper proc around copyFile, getFilePermissions and setFilePermissions procs on non-Windows platforms.

On Windows this proc is just a wrapper for copyFile proc since that proc already copies attributes.

On non-Windows systems permissions are copied after the file itself has been copied, which won't happen atomically and could lead to a race condition. If ignorePermissionErrors is true (default), errors while reading/setting file attributes will be ignored, otherwise will raise OSError.

See also:

• copyFile proc
• copyDir proc
• tryRemoveFile proc
• removeFile proc
• moveFile proc
• copyDirWithPermissions proc

Copies a directory from source to dest preserving file permissions.

If this fails, OSError is raised. This is a wrapper proc around copyDir and copyFileWithPermissions procs on non-Windows platforms.

On Windows this proc is just a wrapper for copyDir proc since that proc already copies attributes.

On non-Windows systems permissions are copied after the file or directory itself has been copied, which won't happen atomically and could lead to a race condition. If ignorePermissionErrors is true (default), errors while reading/setting file attributes will be ignored, otherwise will raise OSError.

See also:

• copyDir proc
• copyFile proc
• copyFileWithPermissions proc
• removeDir proc
• moveDir proc
• existsOrCreateDir proc
• createDir proc

setFilePermissions(filename, getFilePermissions(filename)+permissions)

setFilePermissions(filename, getFilePermissions(filename)-permissions)

Returns a string representing the path to which the symbolic link points.

On Windows this is a noop, symlinkPath is simply returned.

See also:

• createSymlink proc

Splits a command line into several components.

Note: This proc is only occasionally useful, better use the parseopt module.

On Windows, it uses the following parsing rules:

• Arguments are delimited by white space, which is either a space or a tab.
• The caret character (^) is not recognized as an escape character or delimiter. The character is handled completely by the command-line parser in the operating system before being passed to the argv array in the program.
• A string surrounded by double quotation marks ("string") is interpreted as a single argument, regardless of white space contained within. A quoted string can be embedded in an argument.
• A double quotation mark preceded by a backslash (") is interpreted as a literal double quotation mark character (").
• Backslashes are interpreted literally, unless they immediately precede a double quotation mark.
• If an even number of backslashes is followed by a double quotation mark, one backslash is placed in the argv array for every pair of backslashes, and the double quotation mark is interpreted as a string delimiter.
• If an odd number of backslashes is followed by a double quotation mark, one backslash is placed in the argv array for every pair of backslashes, and the double quotation mark is "escaped" by the remaining backslash, causing a literal double quotation mark (") to be placed in argv.

On Posix systems, it uses the following parsing rules: Components are separated by whitespace unless the whitespace occurs within " or ' quotes.

See also:

• parseopt module
• paramCount proc
• paramStr proc
• commandLineParams proc

Returns the number of command line arguments given to the application.

Unlike argc in C, if your binary was called without parameters this will return zero. You can query each individual parameter with paramStr proc or retrieve all of them in one go with commandLineParams proc.

Availability: When generating a dynamic library (see --app:lib) on Posix this proc is not defined. Test for availability using declared().

See also:

• parseopt module
• parseCmdLine proc
• paramStr proc
• commandLineParams proc

Examples:

when declared(paramCount):
  # Use paramCount() here
else:
  # Do something else!

Returns the i-th command line argument given to the application.

i should be in the range 1..paramCount(), the IndexError exception will be raised for invalid values. Instead of iterating over paramCount() with this proc you can call the convenience commandLineParams().

Similarly to argv in C, it is possible to call paramStr(0) but this will return OS specific contents (usually the name of the invoked executable). You should avoid this and call getAppFilename() instead.

Availability: When generating a dynamic library (see --app:lib) on Posix this proc is not defined. Test for availability using declared().

See also:

• parseopt module
• parseCmdLine proc
• paramCount proc
• commandLineParams proc
• getAppFilename proc

Examples:

when declared(paramStr):
  # Use paramStr() here
else:
  # Do something else!

Convenience proc which returns the command line parameters.

This returns only the parameters. If you want to get the application executable filename, call getAppFilename().

Availability: On Posix there is no portable way to get the command line from a DLL and thus the proc isn't defined in this environment. You can test for its availability with declared().

See also:

• parseopt module
• parseCmdLine proc
• paramCount proc
• paramStr proc
• getAppFilename proc

Examples:

when declared(commandLineParams):
  # Use commandLineParams() here
else:
  # Do something else!

Returns the filename of the application's executable. This proc will resolve symlinks.

See also:

• getAppDir proc
• getCurrentCompilerExe proc

Returns the directory of the application's executable.

See also:

• getAppFilename proc

Retrieves file information for the file object represented by the given handle.

If the information cannot be retrieved, such as when the file handle is invalid, OSError is raised.

See also:

• getFileInfo(file) proc
• getFileInfo(path) proc

Retrieves file information for the file object.

See also:

• getFileInfo(handle) proc
• getFileInfo(path) proc

Retrieves file information for the file object pointed to by path.

Due to intrinsic differences between operating systems, the information contained by the returned FileInfo object will be slightly different across platforms, and in some cases, incomplete or inaccurate.

When followSymlink is true (default), symlinks are followed and the information retrieved is information related to the symlink's target. Otherwise, information on the symlink itself is retrieved.

If the information cannot be retrieved, such as when the path doesn't exist, or when permission restrictions prevent the program from retrieving file information, OSError is raised.

See also:

• getFileInfo(handle) proc
• getFileInfo(file) proc

Determines whether path is hidden or not, using this reference.

On Windows: returns true if it exists and its "hidden" attribute is set.

On posix: returns true if lastPathPart(path) starts with . and is not . or ...

Note: paths are not normalized to determine isHidden.

Examples:

when defined(posix):
  assert ".foo".isHidden
  assert not ".foo/bar".isHidden
  assert not ".".isHidden
  assert not "..".isHidden
  assert not "".isHidden
  assert ".foo/".isHidden

Return current process ID.

See also:

• osproc.processID(p: Process)

Returns true if filename is valid for crossplatform use.

This is useful if you want to copy or save files across Windows, Linux, Mac, etc. You can pass full paths as argument too, but func only checks filenames. It uses invalidFilenameChars, invalidFilenames and maxLen to verify the specified filename.

assert not isValidFilename(" foo")    ## Leading white space
assert not isValidFilename("foo ")    ## Trailing white space
assert not isValidFilename("foo.")    ## Ends with Dot
assert not isValidFilename("con.txt") ## "CON" is invalid (Windows)
assert not isValidFilename("OwO:UwU") ## ":" is invalid (Mac)
assert not isValidFilename("aux.bat") ## "AUX" is invalid (Windows)

Walks over all parent directories of a given path.

If fromRoot is true (default: false), the traversal will start from the file system root directory. If inclusive is true (default), the original argument will be included in the traversal.

Relative paths won't be expanded by this iterator. Instead, it will traverse only the directories appearing in the relative path.

See also:

• parentDir proc

Examples:

let g = "a/b/c"

for p in g.parentDirs:
  echo p
# a/b/c
# a/b
# a

for p in g.parentDirs(fromRoot=true):
  echo p
# a/
# a/b/
# a/b/c

for p in g.parentDirs(inclusive=false):
  echo p
# a/b
# a

Iterate over all environments variables.

In the first component of the tuple is the name of the current variable stored, in the second its value.

See also:

• getEnv proc
• existsEnv proc
• putEnv proc
• delEnv proc

Iterate over all the files and directories that match the pattern.

On POSIX this uses the glob call. pattern is OS dependent, but at least the "*.ext" notation is supported.