1 ;;;; the known-to-the-cross-compiler part of PATHNAME logic
3 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; This software is derived from the CMU CL system, which was
7 ;;;; written at Carnegie Mellon University and released into the
8 ;;;; public domain. The software is in the public domain and is
9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
10 ;;;; files for more information.
12 (in-package "SB!IMPL")
14 ;;;; data types used by pathnames
16 ;;; The HOST structure holds the functions that both parse the
17 ;;; pathname information into structure slot entries, and after
18 ;;; translation the inverse (unparse) functions.
19 (sb!xc:defstruct (host (:constructor nil))
20 (parse (required-argument) :type function)
21 (unparse (required-argument) :type function)
22 (unparse-host (required-argument) :type function)
23 (unparse-directory (required-argument) :type function)
24 (unparse-file (required-argument) :type function)
25 (unparse-enough (required-argument) :type function)
26 (customary-case (required-argument) :type (member :upper :lower)))
28 (sb!xc:defstruct (logical-host
30 (:parse #'parse-logical-namestring)
31 (:unparse #'unparse-logical-namestring)
34 (logical-host-name (%pathname-host x))))
35 (:unparse-directory #'unparse-logical-directory)
36 (:unparse-file #'unparse-unix-file)
37 (:unparse-enough #'identity)
38 (:customary-case :upper)))
39 (name "" :type simple-base-string)
40 (translations nil :type list)
41 (canon-transls nil :type list))
43 ;;; A PATTERN is a list of entries and wildcards used for pattern
44 ;;; matches of translations.
45 (sb!xc:defstruct (pattern (:constructor make-pattern (pieces)))
46 (pieces nil :type list))
48 ;;;; PATHNAME structures
50 ;;; the various magic tokens that are allowed to appear in pretty much
51 ;;; all pathname components
52 (sb!xc:deftype component-tokens () ; FIXME: rename to PATHNAME-COMPONENT-TOKENS
53 '(member nil :unspecific :wild))
55 (sb!xc:defstruct (pathname (:conc-name %pathname-)
56 (:constructor %make-pathname (host
62 (:predicate pathnamep))
63 ;; the host (at present either a UNIX or logical host)
64 (host nil :type (or host null))
65 ;; the name of a logical or physical device holding files
66 (device nil :type (or simple-string component-tokens))
67 ;; a list of strings that are the component subdirectory components
68 (directory nil :type list)
70 (name nil :type (or simple-string pattern component-tokens))
71 ;; the type extension of the file
72 (type nil :type (or simple-string pattern component-tokens))
73 ;; the version number of the file, a positive integer (not supported
74 ;; on standard Unix filesystems)
75 (version nil :type (or integer component-tokens (member :newest))))
77 ;;; Logical pathnames have the following format:
79 ;;; logical-namestring ::=
80 ;;; [host ":"] [";"] {directory ";"}* [name] ["." type ["." version]]
83 ;;; directory ::= word | wildcard-word | **
84 ;;; name ::= word | wildcard-word
85 ;;; type ::= word | wildcard-word
86 ;;; version ::= pos-int | newest | NEWEST | *
87 ;;; word ::= {uppercase-letter | digit | -}+
88 ;;; wildcard-word ::= [word] '* {word '*}* [word]
89 ;;; pos-int ::= integer > 0
91 ;;; Physical pathnames include all these slots and a device slot.
93 ;;; Logical pathnames are a subclass of pathname. Their class
94 ;;; relations are mimicked using structures for efficency.
95 (sb!xc:defstruct (logical-pathname (:conc-name %logical-pathname-)
97 (:constructor %make-logical-pathname
105 (defmacro-mundanely enumerate-search-list ((var pathname &optional result)
108 "Execute BODY with VAR bound to each successive possible expansion for
109 PATHNAME and then return RESULT. Note: if PATHNAME does not contain a
110 search-list, then BODY is executed exactly once. Everything is wrapped
111 in a block named NIL, so RETURN can be used to terminate early. Note:
112 VAR is *not* bound inside of RESULT."
113 (let ((body-name (gensym)))
115 (flet ((,body-name (,var)
117 (%enumerate-search-list ,pathname #',body-name)