Skip to main content

compile-file-pathname

compile-file-pathname Function

Syntax:

compile-file-pathname input-file &key output-file &allow-other-keys → pathname

Arguments and Values:

input-file—a pathname designator . (Default fillers for unspecified components are taken from *default-pathname-defaults*.)

output-file—a pathname designator . The default is implementation-defined.

pathname—a pathname.

Description:

Returns the pathname that compile-file would write into, if given the same arguments.

The defaults for the output-file are taken from the pathname that results from merging the input-file with the value of *default-pathname-defaults*, except that the type component should default to the appropriate implementation-defined default type for compiled files.

If input-file is a logical pathname and output-file is unsupplied, the result is a logical pathname. If input-file is a logical pathname, it is translated into a physical pathname as if by calling translate-logical-pathname. If input-file is a stream, the stream can be either open or closed. compile-file-pathname returns the same pathname after a file is closed as it did when the file was open. It is an error if input-file is a stream that is created with make-two-way-stream, make-echo-stream, make-broadcast-stream, make-concatenated-stream, make-string-input-stream, make-string-output-stream.

If an implementation supports additional keyword arguments to compile-file, compile-file-pathname must accept the same arguments.

Examples:

See **logical-pathname-translations**.

Exceptional Situations:

An error of type file-error might be signaled if either input-file or output-file is wild. See Also:

System

compile-file, pathname, logical-pathname, Section 20.1 (File System Concepts), Section 19.1.2 (Pathnames as Filenames)

Expanded Reference: compile-file-pathname​

Determining the output pathname for compile-file​

compile-file-pathname returns the pathname that compile-file would use as its output file, without actually performing compilation.

(compile-file-pathname "myfile.lisp")
;; => #P"myfile.fasl"  ; extension is implementation-dependent (e.g., .fasl, .fas, .o)

The type component changes to the compiled file type​

The primary effect is changing the type component to the implementation's compiled file type.

(pathname-type (compile-file-pathname "test.lisp"))
;; => "fasl"  ; implementation-dependent

Specifying a custom output file​

The :output-file keyword overrides the default, just as it would with compile-file.

(compile-file-pathname "test.lisp" :output-file "/tmp/output.bin")
;; => #P"/tmp/output.bin"

Useful for building file dependency systems​

compile-file-pathname is commonly used to determine whether a compiled file is up to date relative to its source.

(let* ((source #P"/tmp/cl-cfp-test.lisp")
       (compiled (compile-file-pathname source)))
  (namestring compiled))
;; => "/tmp/cl-cfp-test.fasl"  ; implementation-dependent