Skip to main content

logical-pathname

logical-pathname Function

Syntax:

logical-pathname pathspec → logical-pathname

Arguments and Values:

pathspec—a logical pathname, a logical pathname namestring, or a stream.

logical-pathname—a logical pathname.

Description:

logical-pathname converts pathspec to a logical pathname and returns the new logical pathname. If pathspec is a logical pathname namestring, it should contain a host component and its following colon. If pathspec is a stream, it should be one for which pathname returns a logical pathname.

If pathspec is a stream, the stream can be either open or closed. logical-pathname returns the same logical pathname after a file is closed as it did when the file was open. It is an error if pathspec is a stream that is created with make-two-way-stream, make-echo-stream, make-broadcast-stream, make-concatenated-stream, make-string-input-stream, or make-string-output-stream.

Exceptional Situations:

Signals an error of type type-error if pathspec isn’t supplied correctly.

See Also:

logical-pathname, translate-logical-pathname, Section 19.3 (Logical Pathnames)

Expanded Reference: logical-pathname​

Creating a logical pathname from a namestring​

The logical-pathname function converts a logical pathname namestring (which must include the host and colon) into a logical pathname object.

(setf (logical-pathname-translations "APPHOST")
      '(("**;*.*.*" "/opt/app/**/*.*")))

(logical-pathname "APPHOST:CODE;MAIN.LISP")
=> #P"APPHOST:CODE;MAIN.LISP"

(typep (logical-pathname "APPHOST:CODE;MAIN.LISP") 'logical-pathname)
=> T

Passing through an existing logical pathname​

If the argument is already a logical pathname, it is returned as-is.

(setf (logical-pathname-translations "LPH")
      '(("**;*.*.*" "/tmp/**/*.*")))

(let ((lp (logical-pathname "LPH:DATA;FILE.TXT")))
  (eq lp (logical-pathname lp)))
=> T

Accessing components of a logical pathname​

Once created, the components of a logical pathname can be examined with the standard pathname accessors.

(setf (logical-pathname-translations "PROJ")
      '(("**;*.*.*" "/home/dev/proj/**/*.*")))

(let ((lp (logical-pathname "PROJ:SRC;UTILS.LISP.1")))
  (values (pathname-directory lp)
          (pathname-name lp)
          (pathname-type lp)))
=> (:ABSOLUTE "SRC")
=> "UTILS"
=> "LISP"