See also:

• symlinks: createSymlink proc

setFilePermissions(filename, getFilePermissions(filename)-permissions)

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.

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

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

See also:

• appdirs: getHomeDir proc
• appdirs: getConfigDir proc
• appdirs: getTempDir proc
• ospaths2: getCurrentDir proc
• dirs: setCurrentDir proc

Example:

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

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

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 directory of the application's executable.

See also:

• getAppFilename proc

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

See also:

• getAppDir proc
• getCurrentCompilerExe 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

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).

Return current process ID.

See also:

• osproc.processID(p: Process)

Retrieves file information for the file object.

See also:

• getFileInfo(handle) proc
• getFileInfo(path, followSymlink) 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, followSymlink) 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 (however, field isSpecial is still determined from the target on Unix).

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

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

See also:

• getLastModificationTime proc
• getCreationTime proc
• fileNewer proc

Returns the file's last modification time.

See also:

• getLastAccessTime proc
• getCreationTime proc
• fileNewer proc

setFilePermissions(filename, getFilePermissions(filename)+permissions)

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.

Example:

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

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. It uses invalidFilenameChars, invalidFilenames and maxLen to verify the specified filename.

See also:

• https://docs.microsoft.com/en-us/dotnet/api/system.io.pathtoolongexception
• https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
• https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247%28v=vs.85%29.aspx

Example:

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)
assert not isValidFilename("")         # Empty string
assert not isValidFilename("foo/")     # Filename is empty

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

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

Example:

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

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

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

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

See also:

• ospaths2: sameFile proc