staticos.nim

## This module implements path handling like os module but works at only compile-time.
## This module works even when cross compiling to OS that is not supported by os module.

whendefined(nimPreviewSlimSystem):
import std/assertions

procstaticFileExists*(filename: string): bool {.compileTime.} =
## Returns true if `filename` exists and is a regular file or symlink.
##
## Directories, device files, named pipes and sockets return false.
raiseAssert"implemented in the vmops"

procstaticDirExists*(dir: string): bool {.compileTime.} =
## Returns true if the directory `dir` exists. If `dir` is a file, false
## is returned. Follows symlinks.
raiseAssert"implemented in the vmops"

type
PathComponent*=enum## Enumeration specifying a path component.
##
## See also:
## * `walkDirRec iterator`_
## * `FileInfo object`_
 pcFile, ## path refers to a file
 pcLinkToFile, ## path refers to a symbolic link to a file
 pcDir, ## path refers to a directory
 pcLinkToDir ## path refers to a symbolic link to a directory

procstaticWalkDir*(dir: string; relative =false): seq[
tuple[kind: PathComponent, path: string]] {.compileTime.} =
## Walks over the directory `dir` and returns a seq with each directory or
## file in `dir`. The component type and full path for each item are returned.
##
## Walking is not recursive.
## * If `relative` is true (default: false)
## the resulting path is shortened to be relative to ``dir``,
## otherwise the full path is returned.
raiseAssert"implemented in the vmops"