CompilerInput encapsulates all the input needed run the compiler. The compiler can be run in one of two modes - file or str. In file mode the source code and resource files are read from the file system. In str mode we compile a single source file from an in-memory string.
Slots
- dependsSource
-
Depend[] depends := Depend[,]
List of this pod's dependencies used for both the compiler checking and output in the pod's manifest.
- dependsDirSource
-
File? dependsDir := null
The directory to look in for the dependency pod file (and potentially their recursive dependencies). If null then we use the compiler's own pod definitions via reflection (which is more efficient).
- descriptionSource
-
Str description := ""
Description to include in output pod's manifest.
- fcodeDumpSource
-
Bool fcodeDump := false
If set to true, then disassembled fcode is dumped to
log.out
. - homeDirSource
-
File homeDir
Root directory of source tree - this directory is used to create the relative paths of the resource files in the pod zip.
- includeDocSource
-
Bool includeDoc := false
Include fandoc in output pod, default is false
- includeSrcSource
-
Bool includeSrc := false
Include source code in output pod, default is false
- inputLocSource
-
Location inputLoc := Location.make("CompilerInput")
Location to use for reporting errors associated with the input itself - typically this is mapped to the build script.
- isScriptSource
-
Bool isScript := false
Flag to indicate if we are are compiling a script. Scripts don't require explicit depends and can import any type via the using statement or with qualified type names.
- isTestSource
-
Bool isTest := false
Is this compile process being run inside a test, default is false
- logSource
-
CompilerLog log := CompilerLog.make
Log used for reporting compile status
- modeSource
-
CompilerInputMode? mode := null
This mode determines whether the source code is input from the file system or from an in-memory string.
- outDirSource
-
File outDir := Sys.homeDir() + `lib/fan/`
Output directory to write pod to, defaults to the current runtime's lib directory
- outputSource
-
CompilerOutputMode? output := null
What type of output should be generated - the compiler can be used to generate a transient in-memory pod or to write out a pod zip file to disk.
- podFacetsSource
-
Str:Obj podFacets := [Str:Obj][:]
User defined pod level facets.
- podNameSource
-
Str podName
Required name of output pod
- resDirsSource
-
File[] resDirs := File[,]
Optional list of directories containing resources files to include in the pod zip (file mode only)
- srcDirsSource
-
File[] srcDirs
List of directories containing fan source files (file mode only)
- srcStrSource
-
Str srcStr
Fan source code to compile (str mode only)
- srcStrLocationSource
-
Location srcStrLocation
Location to use for SourceFile facet (str mode only)
-
internal Void validate()
Validate the CompilerInput is correctly configured, throw CompilerErr is not.
-
private Void validateReqField(Str field)
Check that the specified field is non-null, if not then log an error and return false.
- versionSource
-
Version version := Version.fromStr("0.0.0")
Version to include in ouput pod's manifest.