Fantom

 

abstract const class

sys::Env

sys::Obj
  sys::Env

Env defines a pluggable class used boot and manage a Fantom runtime environment.

Slots

archSource

Str arch()

Microprocessor architecture name as one of the following constants:

  • "x86"
  • "x86_64"
  • "ppc"
  • "sparc"
  • "ia64"
  • "ia64_32"
argsSource

virtual Str[] args()

Get the command line arguments used to run the fan process as an immutable List of strings. Default implementation delegates to parent.

compileScriptSource

virtual Type compileScript(File f, [Str:Obj]? options := null)

Compile a script file into a pod and return the first public type declared in the script file. If the file has been previously compiled and hasn't changed, then a cached type is returned. If the script contains errors then the first CompilerErr found is thrown. The options available:

  • logLevel: the default LogLevel to use for logging the compilation process and errors
  • log: the compiler::CompilerLog to use for logging the compilation process and errors
  • logOut: an output stream to capture logging
  • force: pass true to not use caching, always forces a recompile
configSource

virtual Str? config(Pod pod, Str key, Str? def := null)

Lookup a configuration property for given pod/key pair. If not found then return def. Default implementation routes to props using max age of one minute:

props(pod, `config.props`, 1min).get(key, def)

Also see Pod.config.

curSource

static Env cur()

Get the current runtime environment

diagnosticsSource

virtual Str:Obj diagnostics()

Poll for a platform dependent map of diagnostics name/value pairs for the current state of the VM. Java platforms return key values from the java.lang.management interface. Default implementation delegates to parent.

errSource

virtual OutStream err()

Standard error output stream. Default implementation delegates to parent.

exitSource

virtual Void exit(Int status := 0)

Terminate the current virtual machine. Default implementation delegates to parent.

findAllFilesSource

virtual File[] findAllFiles(Uri uri)

Find all the files in the environment which match a relative path such as "etc/foo/config.props". It is possible to have multiple matches if the environment uses a search path model. If the list contains more than one item, then the first file has the highest priority and the last item has the lowest priority. If the URI is not relative then throw ArgErr. Return empty list if the file is not found in environment. Default implementation delegates to parent.

findAllPodNamesSource

virtual Str[] findAllPodNames()

Return the list of pod names for all the pods currently installed in this environemnt. This method is used by Pod.list and for constructing the type database. Each of these names must be resolvable by findPodFile. The default implementation routes to findFile to look in the "lib/etc" directory and assumes a naming convention of "{name}.pod".

findFileSource

virtual File? findFile(Uri uri, Bool checked := true)

Find a file in the environment using a relative path such as "etc/foo/config.props". If the URI is not relative then throw ArgErr. If the file is not found in the environment then throw UnresolvedErr or return null based on checked flag. If findAllFiles would return multiple matches, then this method should always return the file with the highest priority. Default implementation delegates to parent.

findPodFileSource

virtual File? findPodFile(Str podName)

Resolve the pod file for the given pod name. If the name cannot be resovled to a pod, return null. The default implementation routes to findFile to look in "lib/etc" directory.

gcSource

virtual Void gc()

Run the garbage collector. No guarantee is made to what the VM will actually do. Default implementation delegates to parent.

homeDirSource

virtual File homeDir()

Get the home directory of Fantom installation. Default implementation delegates to parent.

hostSource

virtual Str host()

Get the local host name of the machine running the virtual machine process. Default implementation delegates to parent.

idHashSource

Int idHash(Obj? obj)

Return the default hash code of Obj.hash for the specified object regardless of whether the object has overridden the hash method. If null then return 0.

inSource

virtual InStream in()

Standard input stream. Default implementation delegates to parent.

localeSource

virtual Str? locale(Pod pod, Str key, Str? def := "key", Locale locale := Locale.cur())

Lookup a localized property for the specified pod/key pair. The following rules are used for resolution:

  1. props(pod, `locale/{locale}.props`)
  2. props(pod, `locale/{lang}.props`)
  3. props(pod, `locale/en.props`)
  4. Fallback to pod::key unless def specified

Where {locale} is Locale.toStr and {lang} is Locale.lang.

Also see Pod.locale.

makeSource

new make(Env parent := Env.cur())

Subclasses are constructed from a parent environment.

osSource

Str os()

Operating system name as one of the following constants:

  • "win32"
  • "macosx"
  • "linux"
  • "aix"
  • "solaris"
  • "hpux"
  • "qnx"
outSource

virtual OutStream out()

Standard output stream. Default implementation delegates to parent.

parentSource

Env? parent()

Get the parent environment or null if this is the bootstrap environment. Many virtual methods delegate to their parent by default.

platformSource

Str platform()

Name of the host platform as a string formatted as "<os>-<arch>". See os and arch.

propsSource

virtual Str:Str props(Pod pod, Uri uri, Duration maxAge)

Return a merged key/value map of all the prop files found using the following resolution rules:

  1. Env.findAllFiles: "etc/{pod}/{uri}"
  2. Pod.files: "/{uri}"

The uri must be relative.

The files are parsed using InStream.readProps and merged according to their priority order. If the file is defined as a resource in the pod itself, then it is treated as lowest priority. The first file returned by findAllFiles is treated as highest priority and overwrites any key-value pairs defined at a lower priority.

The map is cached so that subsequent calls for the same path doesn't require accessing the file system again. The maxAge parameter specifies the tolerance accepted before a cache refresh is performed to check if any of the files have been modified.

Also see Pod.props.

runtimeSource

Str runtime()

Virtual machine runtime as one of the following constants:

  • "java"
  • "dotnet"
  • "js"
tempDirSource

virtual File tempDir()

Get the temp directory to use for scratch files. Default implementation delegates to parent.

userSource

virtual Str user()

Get the user name of the user account used to run the virtual machine process. Default implementation delegates to parent.

varsSource

virtual Str:Str vars()

Get the environment variables as a case insensitive, immutable map of Str name/value pairs. The environment map is initialized from the following sources from lowest priority to highest priority:

  1. shell environment variables
  2. Java system properties (Java VM only obviously)

Default implementation delegates to parent.

workDirSource

virtual File workDir()

Get the working directory to use for saving compiled pods and configuration information. Default implementation delegates to parent.