1.10 API for Raw Compilation

1.10.1 Bytecode Compilation

The compiler takes a list of Racket files and compiles each of them to bytecode, placing the resulting bytecode in a ".zo" file within the directory specified by dest-dir. If dest-dir is #f, each bytecode result is placed in the same directory as its source file. If dest-dir is 'auto, each bytecode file is placed in a "compiled" subdirectory relative to the source; the directory is created if necessary.

If expr is anything other than #f, then a namespace is created for compiling the files that are supplied later, and expr is evaluated to initialize the created namespace. For example, expr might load a set of macros. In addition, the expansion-time part of each expression later compiled is evaluated in the namespace before being compiled, so that the effects are visible when compiling later expressions.

If expr is #f, then no compilation namespace is created (the current namespace is used), and expressions in the files are assumed to compile independently (so there’s no need to evaluate the expansion-time part of an expression to compile).

Typically, expr is #f for compiling module files, and it is (void) for compiling files with top-level definitions and expressions.

If module? is #t, then the given files are read and compiled as modules (so there is no dependency on the current namespace’s top-level environment).

If verbose? is #t, the output file for each given file is reported through the current output port.

By default, all files with the extension ".rkt", ".ss", or ".scm" in a collection are compiled, as are all such files within subdirectories; the set of such suffixes is extensible globally as described in get-module-suffixes, and compile-collection-zos recognizes suffixes from the 'libs group. However, any file or directory whose path starts with skip-path or an element of skip-paths is skipped. (“Starts with” means that the simplified complete path p’s byte-string form after (simplify-path p #f) starts with the byte-string form of (simplify-path skip-path #f); not that each skip-path should normally be a complete path.)

The collection compiler reads the collection’s "info.rkt" file (see "info.rkt" File Format) to obtain further instructions for compiling the collection. The following fields are used:

• name : The name of the collection as a string, used only for status and error reporting.

• compile-omit-paths : A list of immediate file and directory paths that should not be compiled. Alternatively, this field’s value is 'all, which is equivalent to specifying all files and directories in the collection (to effectively ignore the collection for compilation). Automatically omitted files and directories are "compiled", "doc", and those whose names start with ..

  Files that are required by other files, however, are always compiled in the process of compiling the requiring file—even when the required file is listed with this field or when the field’s value is 'all.

• compile-omit-files : A list of filenames (without directory paths) that are not compiled, in addition to the contents of compile-omit-paths. Do not use this field; it is for backward compatibility.

• scribblings : A list of lists, each of which starts with a path for documentation source. See Controlling raco setup with "info.rkt" Files for more information. The sources (and the files that they require) are compiled in the same way as other module files, unless skip-docs? is a true value.

• compile-include-files : A list of filenames (without directory paths) to be compiled, in addition to files that are compiled based on the file’s extension, being in scribblings, or being required by other compiled files.

• module-suffixes and doc-module-suffixes : Used indirectly via get-module-suffixes.

Changed in version 6.3 of package base: Added support for compile-include-files.
Changed in version 7.8.0.8: Changed “starts with” for skip-path to include an exact match.

Changed in version 7.8.0.8 of package base: Changed info handling to use info for 'compile-omit-paths, ignoring any "info.rkt" files in parent and child directories.

1.10.2 Recognizing Module Suffixes

Added in version 6.3 of package base.

The mode and namespace arguments are propagated to find-relevant-directories to determine which collection directories might configure the set of suffixes. Consequently, suffix registrations are found reliably only if raco setup (or package installations or updates that trigger raco setup) is run.

The group argument determines whether the result includes all registered suffixes, only those that are registered as general library suffixes, or only those that are registered as documentation suffixes. The set of general-library suffixes always includes ".rkt", ".ss", and ".scm". The set of documentation suffixes always includes ".scrbl".

The following fields in an "info.rkt" file extend the set of suffixes:

• module-suffixes : A list of byte strings that correspond to general-library module suffixes (without the . that must appear before the suffix). Non-lists or non-byte-string elements of the list are ignored.

• doc-module-suffixes : A list of byte strings as for module-suffixes, but for documentation modules.

1.10.3 Loading Compiler Support

The compiler unit loads certain tools on demand via dynamic-require and get-info. If the namespace used during compilation is different from the namespace used to load the compiler, or if other load-related parameters are set, then the following parameter can be used to restore settings for dynamic-require.

1.10.4 Options for the Compiler

More options are defined by the dynext/compile and dynext/link libraries, which control the actual C compiler and linker that are used for compilation via C.

1.10.5 The Compiler as a Unit

1.10.5.1 Signatures

1.10.5.2 Main Compiler Unit

The unit imports compiler:option^, dynext:compile^, dynext:link^, and dynext:file^. It exports compiler^.

1.10.5.3 Options Unit