1 ;;;; machine/filesystem-independent pathname functions
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 #!-sb-fluid (declaim (freeze-type logical-pathname logical-host))
18 (def!struct (unix-host
19 (:make-load-form-fun make-unix-host-load-form)
21 (parse #'parse-unix-namestring)
22 (unparse #'unparse-unix-namestring)
23 (unparse-host #'unparse-unix-host)
24 (unparse-directory #'unparse-unix-directory)
25 (unparse-file #'unparse-unix-file)
26 (unparse-enough #'unparse-unix-enough)
27 (customary-case :lower))))
29 (defvar *unix-host* (make-unix-host))
31 (defun make-unix-host-load-form (host)
32 (declare (ignore host))
35 ;;; Return a value suitable, e.g., for preinitializing
36 ;;; *DEFAULT-PATHNAME-DEFAULTS* before *DEFAULT-PATHNAME-DEFAULTS* is
37 ;;; initialized (at which time we can't safely call e.g. #'PATHNAME).
38 (defun make-trivial-default-pathname ()
39 (%make-pathname *unix-host* nil nil nil nil :newest))
43 (def!method print-object ((pathname pathname) stream)
44 (let ((namestring (handler-case (namestring pathname)
47 (format stream "#P~S" namestring)
48 (print-unreadable-object (pathname stream :type t)
50 "~@<(with no namestring) ~_:HOST ~S ~_:DEVICE ~S ~_:DIRECTORY ~S ~
51 ~_:NAME ~S ~_:TYPE ~S ~_:VERSION ~S~:>"
52 (%pathname-host pathname)
53 (%pathname-device pathname)
54 (%pathname-directory pathname)
55 (%pathname-name pathname)
56 (%pathname-type pathname)
57 (%pathname-version pathname))))))
59 (def!method make-load-form ((pathname pathname) &optional environment)
60 (make-load-form-saving-slots pathname :environment environment))
62 ;;; A pathname is logical if the host component is a logical host.
63 ;;; This constructor is used to make an instance of the correct type
64 ;;; from parsed arguments.
65 (defun %make-maybe-logical-pathname (host device directory name type version)
66 ;; We canonicalize logical pathname components to uppercase. ANSI
67 ;; doesn't strictly require this, leaving it up to the implementor;
68 ;; but the arguments given in the X3J13 cleanup issue
69 ;; PATHNAME-LOGICAL:ADD seem compelling: we should canonicalize the
70 ;; case, and uppercase is the ordinary way to do that.
71 (flet ((upcase-maybe (x) (typecase x (string (logical-word-or-lose x)) (t x))))
72 (if (typep host 'logical-host)
73 (%make-logical-pathname host
75 (mapcar #'upcase-maybe directory)
80 (aver (eq host *unix-host*))
81 (%make-pathname host device directory name type version)))))
83 ;;; Hash table searching maps a logical pathname's host to its
84 ;;; physical pathname translation.
85 (defvar *logical-hosts* (make-hash-table :test 'equal))
89 (def!method make-load-form ((pattern pattern) &optional environment)
90 (make-load-form-saving-slots pattern :environment environment))
92 (def!method print-object ((pattern pattern) stream)
93 (print-unreadable-object (pattern stream :type t)
95 (let ((*print-escape* t))
96 (pprint-fill stream (pattern-pieces pattern) nil))
97 (prin1 (pattern-pieces pattern) stream))))
99 (defun pattern= (pattern1 pattern2)
100 (declare (type pattern pattern1 pattern2))
101 (let ((pieces1 (pattern-pieces pattern1))
102 (pieces2 (pattern-pieces pattern2)))
103 (and (= (length pieces1) (length pieces2))
104 (every (lambda (piece1 piece2)
107 (and (simple-string-p piece2)
108 (string= piece1 piece2)))
111 (eq (car piece1) (car piece2))
112 (string= (cdr piece1) (cdr piece2))))
114 (eq piece1 piece2))))
118 ;;; If the string matches the pattern returns the multiple values T
119 ;;; and a list of the matched strings.
120 (defun pattern-matches (pattern string)
121 (declare (type pattern pattern)
122 (type simple-string string))
123 (let ((len (length string)))
124 (labels ((maybe-prepend (subs cur-sub chars)
126 (let* ((len (length chars))
127 (new (make-string len))
130 (setf (schar new (decf index)) char))
133 (matches (pieces start subs cur-sub chars)
136 (values t (maybe-prepend subs cur-sub chars))
138 (let ((piece (car pieces)))
141 (let ((end (+ start (length piece))))
143 (string= piece string
144 :start2 start :end2 end)
145 (matches (cdr pieces) end
146 (maybe-prepend subs cur-sub chars)
152 (let ((char (schar string start)))
153 (if (find char (cdr piece) :test #'char=)
154 (matches (cdr pieces) (1+ start) subs t
155 (cons char chars))))))))
156 ((member :single-char-wild)
158 (matches (cdr pieces) (1+ start) subs t
159 (cons (schar string start) chars))))
160 ((member :multi-char-wild)
161 (multiple-value-bind (won new-subs)
162 (matches (cdr pieces) start subs t chars)
166 (matches pieces (1+ start) subs t
167 (cons (schar string start)
169 (multiple-value-bind (won subs)
170 (matches (pattern-pieces pattern) 0 nil nil nil)
171 (values won (reverse subs))))))
173 ;;; PATHNAME-MATCH-P for directory components
174 (defun directory-components-match (thing wild)
177 ;; If THING has a null directory, assume that it matches
178 ;; (:ABSOLUTE :WILD-INFERIORS) or (:RELATIVE :WILD-INFERIORS).
181 (member (first wild) '(:absolute :relative))
182 (eq (second wild) :wild-inferiors))
184 (let ((wild1 (first wild)))
185 (if (eq wild1 :wild-inferiors)
186 (let ((wild-subdirs (rest wild)))
187 (or (null wild-subdirs)
189 (when (directory-components-match thing wild-subdirs)
192 (unless thing (return nil)))))
194 (components-match (first thing) wild1)
195 (directory-components-match (rest thing)
198 ;;; Return true if pathname component THING is matched by WILD. (not
200 (defun components-match (thing wild)
201 (declare (type (or pattern symbol simple-string integer) thing wild))
206 ;; String is matched by itself, a matching pattern or :WILD.
209 (values (pattern-matches wild thing)))
211 (string= thing wild))))
213 ;; A pattern is only matched by an identical pattern.
214 (and (pattern-p wild) (pattern= thing wild)))
216 ;; An integer (version number) is matched by :WILD or the
217 ;; same integer. This branch will actually always be NIL as
218 ;; long as the version is a fixnum.
221 ;;; a predicate for comparing two pathname slot component sub-entries
222 (defun compare-component (this that)
226 (and (simple-string-p that)
227 (string= this that)))
229 (and (pattern-p that)
230 (pattern= this that)))
233 (compare-component (car this) (car that))
234 (compare-component (cdr this) (cdr that)))))))
236 ;;;; pathname functions
238 (defun pathname= (pathname1 pathname2)
239 (declare (type pathname pathname1)
240 (type pathname pathname2))
241 (and (eq (%pathname-host pathname1)
242 (%pathname-host pathname2))
243 (compare-component (%pathname-device pathname1)
244 (%pathname-device pathname2))
245 (compare-component (%pathname-directory pathname1)
246 (%pathname-directory pathname2))
247 (compare-component (%pathname-name pathname1)
248 (%pathname-name pathname2))
249 (compare-component (%pathname-type pathname1)
250 (%pathname-type pathname2))
251 (or (eq (%pathname-host pathname1) *unix-host*)
252 (compare-component (%pathname-version pathname1)
253 (%pathname-version pathname2)))))
255 ;;; Convert PATHNAME-DESIGNATOR (a pathname, or string, or
256 ;;; stream), into a pathname in pathname.
258 ;;; FIXME: was rewritten, should be tested (or rewritten again, this
259 ;;; time using ONCE-ONLY, *then* tested)
260 ;;; FIXME: become SB!XC:DEFMACRO inside EVAL-WHEN (COMPILE EVAL)?
261 (defmacro with-pathname ((pathname pathname-designator) &body body)
262 (let ((pd0 (gensym)))
263 `(let* ((,pd0 ,pathname-designator)
264 (,pathname (etypecase ,pd0
266 (string (parse-namestring ,pd0))
267 (file-stream (file-name ,pd0)))))
270 ;;; Convert the var, a host or string name for a host, into a
271 ;;; LOGICAL-HOST structure or nil if not defined.
273 ;;; pw notes 1/12/97 this potentially useful macro is not used anywhere
274 ;;; and 'find-host' is not defined. 'find-logical-host' seems to be needed.
276 (defmacro with-host ((var expr) &body body)
277 `(let ((,var (let ((,var ,expr))
280 (string (find-logical-host ,var nil))
285 (defun pathname (thing)
287 "Convert thing (a pathname, string or stream) into a pathname."
288 (declare (type pathname-designator thing))
289 (with-pathname (pathname thing)
292 ;;; Change the case of thing if DIDDLE-P.
293 (defun maybe-diddle-case (thing diddle-p)
294 (if (and diddle-p (not (or (symbolp thing) (integerp thing))))
295 (labels ((check-for (pred in)
298 (dolist (piece (pattern-pieces in))
299 (when (typecase piece
301 (check-for pred piece))
305 (check-for pred (cdr piece))))))
309 (when (check-for pred x)
312 (dotimes (i (length in))
313 (when (funcall pred (schar in i))
316 (diddle-with (fun thing)
320 (mapcar (lambda (piece)
328 (funcall fun (cdr piece))))
333 (pattern-pieces thing))))
340 (let ((any-uppers (check-for #'upper-case-p thing))
341 (any-lowers (check-for #'lower-case-p thing)))
342 (cond ((and any-uppers any-lowers)
343 ;; mixed case, stays the same
346 ;; all uppercase, becomes all lower case
347 (diddle-with (lambda (x) (if (stringp x)
351 ;; all lowercase, becomes all upper case
352 (diddle-with (lambda (x) (if (stringp x)
356 ;; no letters? I guess just leave it.
360 (defun merge-directories (dir1 dir2 diddle-case)
361 (if (or (eq (car dir1) :absolute)
366 (if (and (eq dir :back)
368 (not (member (car results)
369 '(:back :wild-inferiors))))
371 (push dir results))))
372 (dolist (dir (maybe-diddle-case dir2 diddle-case))
374 (dolist (dir (cdr dir1))
378 (defun merge-pathnames (pathname
380 (defaults *default-pathname-defaults*)
381 (default-version :newest))
383 "Construct a filled in pathname by completing the unspecified components
385 (declare (type pathname-designator pathname)
386 (type pathname-designator defaults)
388 (with-pathname (defaults defaults)
389 (let ((pathname (let ((*default-pathname-defaults* defaults))
390 (pathname pathname))))
391 (let* ((default-host (%pathname-host defaults))
392 (pathname-host (%pathname-host pathname))
394 (and default-host pathname-host
395 (not (eq (host-customary-case default-host)
396 (host-customary-case pathname-host))))))
397 (%make-maybe-logical-pathname
398 (or pathname-host default-host)
399 (or (%pathname-device pathname)
400 (maybe-diddle-case (%pathname-device defaults)
402 (merge-directories (%pathname-directory pathname)
403 (%pathname-directory defaults)
405 (or (%pathname-name pathname)
406 (maybe-diddle-case (%pathname-name defaults)
408 (or (%pathname-type pathname)
409 (maybe-diddle-case (%pathname-type defaults)
411 (or (%pathname-version pathname)
412 (and (not (%pathname-name pathname)) (%pathname-version defaults))
413 default-version))))))
415 (defun import-directory (directory diddle-case)
418 ((member :wild) '(:absolute :wild-inferiors))
419 ((member :unspecific) '(:relative))
422 (results (pop directory))
423 (dolist (piece directory)
424 (cond ((member piece '(:wild :wild-inferiors :up :back))
426 ((or (simple-string-p piece) (pattern-p piece))
427 (results (maybe-diddle-case piece diddle-case)))
429 (results (maybe-diddle-case (coerce piece 'simple-string)
432 (error "~S is not allowed as a directory component." piece))))
436 ,(maybe-diddle-case directory diddle-case)))
439 ,(maybe-diddle-case (coerce directory 'simple-string)
442 (defun make-pathname (&key host
447 (version nil versionp)
451 "Makes a new pathname from the component arguments. Note that host is
452 a host-structure or string."
453 (declare (type (or string host pathname-component-tokens) host)
454 (type (or string pathname-component-tokens) device)
455 (type (or list string pattern pathname-component-tokens) directory)
456 (type (or string pattern pathname-component-tokens) name type)
457 (type (or integer pathname-component-tokens (member :newest))
459 (type (or pathname-designator null) defaults)
460 (type (member :common :local) case))
461 (let* ((defaults (when defaults
462 (with-pathname (defaults defaults) defaults)))
463 (default-host (if defaults
464 (%pathname-host defaults)
465 (pathname-host *default-pathname-defaults*)))
466 ;; Raymond Toy writes: CLHS says make-pathname can take a
467 ;; string (as a logical-host) for the host part. We map that
468 ;; string into the corresponding logical host structure.
470 ;; Paul Werkowski writes:
471 ;; HyperSpec says for the arg to MAKE-PATHNAME;
472 ;; "host---a valid physical pathname host. ..."
473 ;; where it probably means -- a valid pathname host.
474 ;; "valid pathname host n. a valid physical pathname host or
475 ;; a valid logical pathname host."
477 ;; "valid physical pathname host n. any of a string,
478 ;; a list of strings, or the symbol :unspecific,
479 ;; that is recognized by the implementation as the name of a host."
480 ;; "valid logical pathname host n. a string that has been defined
481 ;; as the name of a logical host. ..."
482 ;; HS is silent on what happens if the :HOST arg is NOT one of these.
483 ;; It seems an error message is appropriate.
485 (host host) ; A valid host, use it.
486 ((string 0) *unix-host*) ; "" cannot be a logical host
487 (string (find-logical-host host t)) ; logical-host or lose.
488 (t default-host))) ; unix-host
489 (diddle-args (and (eq (host-customary-case host) :lower)
492 (not (eq (host-customary-case host)
493 (host-customary-case default-host))))
494 (dev (if devp device (if defaults (%pathname-device defaults))))
495 (dir (import-directory directory diddle-args))
498 (defaults (%pathname-version defaults))
500 (when (and defaults (not dirp))
502 (merge-directories dir
503 (%pathname-directory defaults)
506 (macrolet ((pick (var varp field)
507 `(cond ((or (simple-string-p ,var)
509 (maybe-diddle-case ,var diddle-args))
511 (maybe-diddle-case (coerce ,var 'simple-string)
514 (maybe-diddle-case ,var diddle-args))
516 (maybe-diddle-case (,field defaults)
520 (%make-maybe-logical-pathname host
521 dev ; forced to :UNSPECIFIC when logical
523 (pick name namep %pathname-name)
524 (pick type typep %pathname-type)
527 (defun pathname-host (pathname &key (case :local))
529 "Return PATHNAME's host."
530 (declare (type pathname-designator pathname)
531 (type (member :local :common) case)
534 (with-pathname (pathname pathname)
535 (%pathname-host pathname)))
537 (defun pathname-device (pathname &key (case :local))
539 "Return PATHNAME's device."
540 (declare (type pathname-designator pathname)
541 (type (member :local :common) case))
542 (with-pathname (pathname pathname)
543 (maybe-diddle-case (%pathname-device pathname)
544 (and (eq case :common)
545 (eq (host-customary-case
546 (%pathname-host pathname))
549 (defun pathname-directory (pathname &key (case :local))
551 "Return PATHNAME's directory."
552 (declare (type pathname-designator pathname)
553 (type (member :local :common) case))
554 (with-pathname (pathname pathname)
555 (maybe-diddle-case (%pathname-directory pathname)
556 (and (eq case :common)
557 (eq (host-customary-case
558 (%pathname-host pathname))
560 (defun pathname-name (pathname &key (case :local))
562 "Return PATHNAME's name."
563 (declare (type pathname-designator pathname)
564 (type (member :local :common) case))
565 (with-pathname (pathname pathname)
566 (maybe-diddle-case (%pathname-name pathname)
567 (and (eq case :common)
568 (eq (host-customary-case
569 (%pathname-host pathname))
572 (defun pathname-type (pathname &key (case :local))
574 "Return PATHNAME's type."
575 (declare (type pathname-designator pathname)
576 (type (member :local :common) case))
577 (with-pathname (pathname pathname)
578 (maybe-diddle-case (%pathname-type pathname)
579 (and (eq case :common)
580 (eq (host-customary-case
581 (%pathname-host pathname))
584 (defun pathname-version (pathname)
586 "Return PATHNAME's version."
587 (declare (type pathname-designator pathname))
588 (with-pathname (pathname pathname)
589 (%pathname-version pathname)))
593 ;;; Handle the case for PARSE-NAMESTRING parsing a potentially
594 ;;; syntactically valid logical namestring with an explicit host.
596 ;;; This then isn't fully general -- we are relying on the fact that
597 ;;; we will only pass to parse-namestring namestring with an explicit
598 ;;; logical host, so that we can pass the host return from
599 ;;; parse-logical-namestring through to %PARSE-NAMESTRING as a truth
600 ;;; value. Yeah, this is probably a KLUDGE - CSR, 2002-04-18
601 (defun parseable-logical-namestring-p (namestr start end)
604 ((namestring-parse-error (lambda (c)
607 (let ((colon (position #\: namestr :start start :end end)))
609 (let ((potential-host
610 (logical-word-or-lose (subseq namestr start colon))))
611 ;; depending on the outcome of CSR comp.lang.lisp post
612 ;; "can PARSE-NAMESTRING create logical hosts", we may need
613 ;; to do things with potential-host (create it
614 ;; temporarily, parse the namestring and unintern the
615 ;; logical host potential-host on failure.
616 (declare (ignore potential-host))
619 ((simple-type-error (lambda (c)
622 (parse-logical-namestring namestr start end))))
623 ;; if we got this far, we should have an explicit host
624 ;; (first return value of parse-logical-namestring)
628 ;;; Handle the case where PARSE-NAMESTRING is actually parsing a
629 ;;; namestring. We pick off the :JUNK-ALLOWED case then find a host to
630 ;;; use for parsing, call the parser, then check whether the host matches.
631 (defun %parse-namestring (namestr host defaults start end junk-allowed)
632 (declare (type (or host null) host)
633 (type string namestr)
635 (type (or index null) end))
639 (%parse-namestring namestr host defaults start end nil)
640 (namestring-parse-error (condition)
641 (values nil (namestring-parse-error-offset condition)))))
643 (let* ((end (%check-vector-sequence-bounds namestr start end)))
644 (multiple-value-bind (new-host device directory file type version)
645 ;; Comments below are quotes from the HyperSpec
646 ;; PARSE-NAMESTRING entry, reproduced here to demonstrate
647 ;; that we actually have to do things this way rather than
648 ;; some possibly more logical way. - CSR, 2002-04-18
650 ;; "If host is a logical host then thing is parsed as a
651 ;; logical pathname namestring on the host."
652 (host (funcall (host-parse host) namestr start end))
653 ;; "If host is nil and thing is a syntactically valid
654 ;; logical pathname namestring containing an explicit
655 ;; host, then it is parsed as a logical pathname
657 ((parseable-logical-namestring-p namestr start end)
658 (parse-logical-namestring namestr start end))
659 ;; "If host is nil, default-pathname is a logical
660 ;; pathname, and thing is a syntactically valid logical
661 ;; pathname namestring without an explicit host, then it
662 ;; is parsed as a logical pathname namestring on the
663 ;; host that is the host component of default-pathname."
665 ;; "Otherwise, the parsing of thing is
666 ;; implementation-defined."
668 ;; Both clauses are handled here, as the default
669 ;; *DEFAULT-PATHNAME-DEFAULTS has a SB-IMPL::UNIX-HOST
671 ((pathname-host defaults)
672 (funcall (host-parse (pathname-host defaults))
676 ;; I don't think we should ever get here, as the default
677 ;; host will always have a non-null HOST, given that we
678 ;; can't create a new pathname without going through
679 ;; *DEFAULT-PATHNAME-DEFAULTS*, which has a non-null
681 (t (bug "Fallen through COND in %PARSE-NAMESTRING")))
682 (when (and host new-host (not (eq new-host host)))
683 (error 'simple-type-error
685 ;; Note: ANSI requires that this be a TYPE-ERROR,
686 ;; but there seems to be no completely correct
687 ;; value to use for TYPE-ERROR-EXPECTED-TYPE.
688 ;; Instead, we return a sort of "type error allowed
689 ;; type", trying to say "it would be OK if you
690 ;; passed NIL as the host value" but not mentioning
691 ;; that a matching string would be OK too.
694 "The host in the namestring, ~S,~@
695 does not match the explicit HOST argument, ~S."
696 :format-arguments (list new-host host)))
697 (let ((pn-host (or new-host host (pathname-host defaults))))
698 (values (%make-maybe-logical-pathname
699 pn-host device directory file type version)
702 ;;; If NAMESTR begins with a colon-terminated, defined, logical host,
703 ;;; then return that host, otherwise return NIL.
704 (defun extract-logical-host-prefix (namestr start end)
705 (declare (type simple-base-string namestr)
706 (type index start end)
707 (values (or logical-host null)))
708 (let ((colon-pos (position #\: namestr :start start :end end)))
710 (values (gethash (nstring-upcase (subseq namestr start colon-pos))
714 (defun parse-namestring (thing
717 (defaults *default-pathname-defaults*)
718 &key (start 0) end junk-allowed)
719 (declare (type pathname-designator thing)
720 (type (or list host string (member :unspecific)) host)
721 (type pathname defaults)
723 (type (or index null) end)
724 (type (or t null) junk-allowed)
725 (values (or null pathname) (or null index)))
726 ;; Generally, redundant specification of information in software,
727 ;; whether in code or in comments, is bad. However, the ANSI spec
728 ;; for this is messy enough that it's hard to hold in short-term
729 ;; memory, so I've recorded these redundant notes on the
730 ;; implications of the ANSI spec.
732 ;; According to the ANSI spec, HOST can be a valid pathname host, or
733 ;; a logical host, or NIL.
735 ;; A valid pathname host can be a valid physical pathname host or a
736 ;; valid logical pathname host.
738 ;; A valid physical pathname host is "any of a string, a list of
739 ;; strings, or the symbol :UNSPECIFIC, that is recognized by the
740 ;; implementation as the name of a host". In SBCL as of 0.6.9.8,
741 ;; that means :UNSPECIFIC: though someday we might want to
742 ;; generalize it to allow strings like "RTFM.MIT.EDU" or lists like
743 ;; '("RTFM" "MIT" "EDU"), that's not supported now.
745 ;; A valid logical pathname host is a string which has been defined as
746 ;; the name of a logical host, as with LOAD-LOGICAL-PATHNAME-TRANSLATIONS.
748 ;; A logical host is an object of implementation-dependent nature. In
749 ;; SBCL, it's a member of the HOST class (a subclass of STRUCTURE-OBJECT).
750 (let ((found-host (etypecase host
752 ;; This is a special host. It's not valid as a
753 ;; logical host, so it is a sensible thing to
754 ;; designate the physical Unix host object. So
758 ;; In general ANSI-compliant Common Lisps, a
759 ;; string might also be a physical pathname host,
760 ;; but ANSI leaves this up to the implementor,
761 ;; and in SBCL we don't do it, so it must be a
763 (find-logical-host host))
764 ((or null (member :unspecific))
765 ;; CLHS says that HOST=:UNSPECIFIC has
766 ;; implementation-defined behavior. We
767 ;; just turn it into NIL.
770 ;; ANSI also allows LISTs to designate hosts,
771 ;; but leaves its interpretation
772 ;; implementation-defined. Our interpretation
773 ;; is that it's unsupported.:-|
774 (error "A LIST representing a pathname host is not ~
775 supported in this implementation:~% ~S"
779 (declare (type (or null host) found-host))
782 (%parse-namestring thing found-host defaults start end junk-allowed))
784 (%parse-namestring (coerce thing 'simple-string)
785 found-host defaults start end junk-allowed))
787 (let ((defaulted-host (or found-host (%pathname-host defaults))))
788 (declare (type host defaulted-host))
789 (unless (eq defaulted-host (%pathname-host thing))
790 (error "The HOST argument doesn't match the pathname host:~% ~
792 defaulted-host (%pathname-host thing))))
793 (values thing start))
795 (let ((name (file-name thing)))
797 (error "can't figure out the file associated with stream:~% ~S"
799 (values name nil))))))
801 (defun namestring (pathname)
803 "Construct the full (name)string form of the pathname."
804 (declare (type pathname-designator pathname))
805 (with-pathname (pathname pathname)
807 (let ((host (%pathname-host pathname)))
809 (error "can't determine the namestring for pathnames with no ~
810 host:~% ~S" pathname))
811 (funcall (host-unparse host) pathname)))))
813 (defun host-namestring (pathname)
815 "Return a string representation of the name of the host in the pathname."
816 (declare (type pathname-designator pathname))
817 (with-pathname (pathname pathname)
818 (let ((host (%pathname-host pathname)))
820 (funcall (host-unparse-host host) pathname)
822 "can't determine the namestring for pathnames with no host:~% ~S"
825 (defun directory-namestring (pathname)
827 "Return a string representation of the directories used in the pathname."
828 (declare (type pathname-designator pathname))
829 (with-pathname (pathname pathname)
830 (let ((host (%pathname-host pathname)))
832 (funcall (host-unparse-directory host) pathname)
834 "can't determine the namestring for pathnames with no host:~% ~S"
837 (defun file-namestring (pathname)
839 "Return a string representation of the name used in the pathname."
840 (declare (type pathname-designator pathname))
841 (with-pathname (pathname pathname)
842 (let ((host (%pathname-host pathname)))
844 (funcall (host-unparse-file host) pathname)
846 "can't determine the namestring for pathnames with no host:~% ~S"
849 (defun enough-namestring (pathname
851 (defaults *default-pathname-defaults*))
853 "Return an abbreviated pathname sufficent to identify the pathname relative
855 (declare (type pathname-designator pathname))
856 (with-pathname (pathname pathname)
857 (let ((host (%pathname-host pathname)))
859 (with-pathname (defaults defaults)
860 (funcall (host-unparse-enough host) pathname defaults))
862 "can't determine the namestring for pathnames with no host:~% ~S"
867 (defun wild-pathname-p (pathname &optional field-key)
869 "Predicate for determining whether pathname contains any wildcards."
870 (declare (type pathname-designator pathname)
871 (type (member nil :host :device :directory :name :type :version)
873 (with-pathname (pathname pathname)
875 (or (pattern-p x) (member x '(:wild :wild-inferiors)))))
878 (or (wild-pathname-p pathname :host)
879 (wild-pathname-p pathname :device)
880 (wild-pathname-p pathname :directory)
881 (wild-pathname-p pathname :name)
882 (wild-pathname-p pathname :type)
883 (wild-pathname-p pathname :version)))
884 (:host (frob (%pathname-host pathname)))
885 (:device (frob (%pathname-host pathname)))
886 (:directory (some #'frob (%pathname-directory pathname)))
887 (:name (frob (%pathname-name pathname)))
888 (:type (frob (%pathname-type pathname)))
889 (:version (frob (%pathname-version pathname)))))))
891 (defun pathname-match-p (in-pathname in-wildname)
893 "Pathname matches the wildname template?"
894 (declare (type pathname-designator in-pathname))
895 (with-pathname (pathname in-pathname)
896 (with-pathname (wildname in-wildname)
897 (macrolet ((frob (field &optional (op 'components-match))
898 `(or (null (,field wildname))
899 (,op (,field pathname) (,field wildname)))))
900 (and (or (null (%pathname-host wildname))
901 (eq (%pathname-host wildname) (%pathname-host pathname)))
902 (frob %pathname-device)
903 (frob %pathname-directory directory-components-match)
904 (frob %pathname-name)
905 (frob %pathname-type)
906 (or (eq (%pathname-host wildname) *unix-host*)
907 (frob %pathname-version)))))))
909 ;;; Place the substitutions into the pattern and return the string or pattern
910 ;;; that results. If DIDDLE-CASE is true, we diddle the result case as well,
911 ;;; in case we are translating between hosts with difference conventional case.
912 ;;; The second value is the tail of subs with all of the values that we used up
913 ;;; stripped off. Note that PATTERN-MATCHES matches all consecutive wildcards
914 ;;; as a single string, so we ignore subsequent contiguous wildcards.
915 (defun substitute-into (pattern subs diddle-case)
916 (declare (type pattern pattern)
918 (values (or simple-base-string pattern) list))
919 (let ((in-wildcard nil)
922 (dolist (piece (pattern-pieces pattern))
923 (cond ((simple-string-p piece)
925 (setf in-wildcard nil))
930 (error "not enough wildcards in FROM pattern to match ~
933 (let ((sub (pop subs)))
937 (push (apply #'concatenate 'simple-string
940 (dolist (piece (pattern-pieces sub))
941 (push piece pieces)))
945 (error "can't substitute this into the middle of a word:~
950 (push (apply #'concatenate 'simple-string (nreverse strings))
954 (if (and pieces (simple-string-p (car pieces)) (null (cdr pieces)))
956 (make-pattern (nreverse pieces)))
960 ;;; Called when we can't see how source and from matched.
961 (defun didnt-match-error (source from)
962 (error "Pathname components from SOURCE and FROM args to TRANSLATE-PATHNAME~@
963 did not match:~% ~S ~S"
966 ;;; Do TRANSLATE-COMPONENT for all components except host, directory
968 (defun translate-component (source from to diddle-case)
975 (if (pattern= from source)
977 (didnt-match-error source from)))
979 (multiple-value-bind (won subs) (pattern-matches from source)
981 (values (substitute-into to subs diddle-case))
982 (didnt-match-error source from))))
984 (maybe-diddle-case source diddle-case))))
986 (values (substitute-into to (list source) diddle-case)))
988 (if (components-match source from)
989 (maybe-diddle-case source diddle-case)
990 (didnt-match-error source from)))))
992 (maybe-diddle-case source diddle-case))
994 (if (components-match source from)
996 (didnt-match-error source from)))))
998 ;;; Return a list of all the things that we want to substitute into the TO
999 ;;; pattern (the things matched by from on source.) When From contains
1000 ;;; :WILD-INFERIORS, the result contains a sublist of the matched source
1002 (defun compute-directory-substitutions (orig-source orig-from)
1003 (let ((source orig-source)
1008 (unless (every (lambda (x) (eq x :wild-inferiors)) from)
1009 (didnt-match-error orig-source orig-from))
1012 (unless from (didnt-match-error orig-source orig-from))
1013 (let ((from-part (pop from))
1014 (source-part (pop source)))
1017 (typecase source-part
1019 (if (pattern= from-part source-part)
1021 (didnt-match-error orig-source orig-from)))
1023 (multiple-value-bind (won new-subs)
1024 (pattern-matches from-part source-part)
1026 (dolist (sub new-subs)
1028 (didnt-match-error orig-source orig-from))))
1030 (didnt-match-error orig-source orig-from))))
1033 ((member :wild-inferiors)
1034 (let ((remaining-source (cons source-part source)))
1037 (when (directory-components-match remaining-source from)
1039 (unless remaining-source
1040 (didnt-match-error orig-source orig-from))
1041 (res (pop remaining-source)))
1043 (setq source remaining-source))))
1045 (unless (and (simple-string-p source-part)
1046 (string= from-part source-part))
1047 (didnt-match-error orig-source orig-from)))
1049 (didnt-match-error orig-source orig-from)))))
1052 ;;; This is called by TRANSLATE-PATHNAME on the directory components
1053 ;;; of its argument pathnames to produce the result directory
1054 ;;; component. If this leaves the directory NIL, we return the source
1055 ;;; directory. The :RELATIVE or :ABSOLUTE is taken from the source
1056 ;;; directory, except if TO is :ABSOLUTE, in which case the result
1057 ;;; will be :ABSOLUTE.
1058 (defun translate-directories (source from to diddle-case)
1059 (if (not (and source to from))
1060 (or (and to (null source) (remove :wild-inferiors to))
1061 (mapcar (lambda (x) (maybe-diddle-case x diddle-case)) source))
1063 ;; If TO is :ABSOLUTE, the result should still be :ABSOLUTE.
1064 (res (if (eq (first to) :absolute)
1067 (let ((subs-left (compute-directory-substitutions (rest source)
1069 (dolist (to-part (rest to))
1073 (let ((match (pop subs-left)))
1075 (error ":WILD-INFERIORS is not paired in from and to ~
1076 patterns:~% ~S ~S" from to))
1077 (res (maybe-diddle-case match diddle-case))))
1078 ((member :wild-inferiors)
1080 (let ((match (pop subs-left)))
1081 (unless (listp match)
1082 (error ":WILD-INFERIORS not paired in from and to ~
1083 patterns:~% ~S ~S" from to))
1085 (res (maybe-diddle-case x diddle-case)))))
1087 (multiple-value-bind
1089 (substitute-into to-part subs-left diddle-case)
1090 (setf subs-left new-subs-left)
1092 (t (res to-part)))))
1095 (defun translate-pathname (source from-wildname to-wildname &key)
1097 "Use the source pathname to translate the from-wildname's wild and
1098 unspecified elements into a completed to-pathname based on the to-wildname."
1099 (declare (type pathname-designator source from-wildname to-wildname))
1100 (with-pathname (source source)
1101 (with-pathname (from from-wildname)
1102 (with-pathname (to to-wildname)
1103 (let* ((source-host (%pathname-host source))
1104 (from-host (%pathname-host from))
1105 (to-host (%pathname-host to))
1107 (and source-host to-host
1108 (not (eq (host-customary-case source-host)
1109 (host-customary-case to-host))))))
1110 (macrolet ((frob (field &optional (op 'translate-component))
1111 `(let ((result (,op (,field source)
1115 (if (eq result :error)
1116 (error "~S doesn't match ~S." source from)
1118 (%make-maybe-logical-pathname
1119 (or to-host source-host)
1120 (frob %pathname-device)
1121 (frob %pathname-directory translate-directories)
1122 (frob %pathname-name)
1123 (frob %pathname-type)
1124 (if (eq from-host *unix-host*)
1125 (if (eq (%pathname-version to) :wild)
1126 (%pathname-version from)
1127 (%pathname-version to))
1128 (frob %pathname-version)))))))))
1130 ;;;; logical pathname support. ANSI 92-102 specification.
1132 ;;;; As logical-pathname translations are loaded they are
1133 ;;;; canonicalized as patterns to enable rapid efficient translation
1134 ;;;; into physical pathnames.
1138 ;;; Canonicalize a logical pathname word by uppercasing it checking that it
1139 ;;; contains only legal characters.
1140 (defun logical-word-or-lose (word)
1141 (declare (string word))
1142 (when (string= word "")
1143 (error 'namestring-parse-error
1144 :complaint "Attempted to treat invalid logical hostname ~
1145 as a logical host:~% ~S"
1147 :namestring word :offset 0))
1148 (let ((word (string-upcase word)))
1149 (dotimes (i (length word))
1150 (let ((ch (schar word i)))
1151 (unless (or (alpha-char-p ch) (digit-char-p ch) (char= ch #\-))
1152 (error 'namestring-parse-error
1153 :complaint "logical namestring character which ~
1154 is not alphanumeric or hyphen:~% ~S"
1156 :namestring word :offset i))))
1159 ;;; Given a logical host or string, return a logical host. If ERROR-P
1160 ;;; is NIL, then return NIL when no such host exists.
1161 (defun find-logical-host (thing &optional (errorp t))
1164 (let ((found (gethash (logical-word-or-lose thing)
1166 (if (or found (not errorp))
1168 ;; This is the error signalled from e.g.
1169 ;; LOGICAL-PATHNAME-TRANSLATIONS when host is not a defined
1170 ;; host, and ANSI specifies that that's a TYPE-ERROR.
1171 (error 'simple-type-error
1173 ;; God only knows what ANSI expects us to use for
1174 ;; the EXPECTED-TYPE here. Maybe this will be OK..
1176 '(and string (satisfies logical-pathname-translations))
1177 :format-control "logical host not yet defined: ~S"
1178 :format-arguments (list thing)))))
1179 (logical-host thing)))
1181 ;;; Given a logical host name or host, return a logical host, creating
1182 ;;; a new one if necessary.
1183 (defun intern-logical-host (thing)
1184 (declare (values logical-host))
1185 (or (find-logical-host thing nil)
1186 (let* ((name (logical-word-or-lose thing))
1187 (new (make-logical-host :name name)))
1188 (setf (gethash name *logical-hosts*) new)
1191 ;;;; logical pathname parsing
1193 ;;; Deal with multi-char wildcards in a logical pathname token.
1194 (defun maybe-make-logical-pattern (namestring chunks)
1195 (let ((chunk (caar chunks)))
1196 (collect ((pattern))
1198 (len (length chunk)))
1199 (declare (fixnum last-pos))
1201 (when (= last-pos len) (return))
1202 (let ((pos (or (position #\* chunk :start last-pos) len)))
1203 (if (= pos last-pos)
1205 (error 'namestring-parse-error
1206 :complaint "double asterisk inside of logical ~
1209 :namestring namestring
1210 :offset (+ (cdar chunks) pos)))
1211 (pattern (subseq chunk last-pos pos)))
1214 (pattern :multi-char-wild))
1215 (setq last-pos (1+ pos)))))
1218 (make-pattern (pattern))
1219 (let ((x (car (pattern))))
1220 (if (eq x :multi-char-wild)
1224 ;;; Return a list of conses where the CDR is the start position and
1225 ;;; the CAR is a string (token) or character (punctuation.)
1226 (defun logical-chunkify (namestr start end)
1228 (do ((i start (1+ i))
1232 (chunks (cons (nstring-upcase (subseq namestr prev end)) prev))))
1233 (let ((ch (schar namestr i)))
1234 (unless (or (alpha-char-p ch) (digit-char-p ch)
1235 (member ch '(#\- #\*)))
1237 (chunks (cons (nstring-upcase (subseq namestr prev i)) prev)))
1239 (unless (member ch '(#\; #\: #\.))
1240 (error 'namestring-parse-error
1241 :complaint "illegal character for logical pathname:~% ~S"
1245 (chunks (cons ch i)))))
1248 ;;; Break up a logical-namestring, always a string, into its
1249 ;;; constituent parts.
1250 (defun parse-logical-namestring (namestr start end)
1251 (declare (type simple-base-string namestr)
1252 (type index start end))
1253 (collect ((directory))
1258 (labels ((expecting (what chunks)
1259 (unless (and chunks (simple-string-p (caar chunks)))
1260 (error 'namestring-parse-error
1261 :complaint "expecting ~A, got ~:[nothing~;~S~]."
1262 :args (list what (caar chunks) (caar chunks))
1264 :offset (if chunks (cdar chunks) end)))
1266 (parse-host (chunks)
1267 (case (caadr chunks)
1270 (find-logical-host (expecting "a host name" chunks)))
1271 (parse-relative (cddr chunks)))
1273 (parse-relative chunks))))
1274 (parse-relative (chunks)
1277 (directory :relative)
1278 (parse-directory (cdr chunks)))
1280 (directory :absolute) ; Assumption! Maybe revoked later.
1281 (parse-directory chunks))))
1282 (parse-directory (chunks)
1283 (case (caadr chunks)
1286 (let ((res (expecting "a directory name" chunks)))
1287 (cond ((string= res "..") :up)
1288 ((string= res "**") :wild-inferiors)
1290 (maybe-make-logical-pattern namestr chunks)))))
1291 (parse-directory (cddr chunks)))
1293 (parse-name chunks))))
1294 (parse-name (chunks)
1296 (expecting "a file name" chunks)
1297 (setq name (maybe-make-logical-pattern namestr chunks))
1298 (expecting-dot (cdr chunks))))
1299 (expecting-dot (chunks)
1301 (unless (eql (caar chunks) #\.)
1302 (error 'namestring-parse-error
1303 :complaint "expecting a dot, got ~S."
1304 :args (list (caar chunks))
1306 :offset (cdar chunks)))
1308 (parse-version (cdr chunks))
1309 (parse-type (cdr chunks)))))
1310 (parse-type (chunks)
1311 (expecting "a file type" chunks)
1312 (setq type (maybe-make-logical-pattern namestr chunks))
1313 (expecting-dot (cdr chunks)))
1314 (parse-version (chunks)
1315 (let ((str (expecting "a positive integer, * or NEWEST"
1318 ((string= str "*") (setq version :wild))
1319 ((string= str "NEWEST") (setq version :newest))
1321 (multiple-value-bind (res pos)
1322 (parse-integer str :junk-allowed t)
1323 (unless (and res (plusp res))
1324 (error 'namestring-parse-error
1325 :complaint "expected a positive integer, ~
1329 :offset (+ pos (cdar chunks))))
1330 (setq version res)))))
1332 (error 'namestring-parse-error
1333 :complaint "extra stuff after end of file name"
1335 :offset (cdadr chunks)))))
1336 (parse-host (logical-chunkify namestr start end)))
1337 (values host :unspecific (directory) name type version))))
1339 ;;; We can't initialize this yet because not all host methods are
1341 (defvar *logical-pathname-defaults*)
1343 (defun logical-pathname (pathspec)
1345 "Converts the pathspec argument to a logical-pathname and returns it."
1346 (declare (type (or logical-pathname string stream) pathspec)
1347 (values logical-pathname))
1348 (if (typep pathspec 'logical-pathname)
1350 (let ((res (parse-namestring pathspec nil *logical-pathname-defaults*)))
1351 (when (eq (%pathname-host res)
1352 (%pathname-host *logical-pathname-defaults*))
1353 (error "This logical namestring does not specify a host:~% ~S"
1357 ;;;; logical pathname unparsing
1359 (defun unparse-logical-directory (pathname)
1360 (declare (type pathname pathname))
1362 (let ((directory (%pathname-directory pathname)))
1364 (ecase (pop directory)
1365 (:absolute) ; nothing special
1366 (:relative (pieces ";")))
1367 (dolist (dir directory)
1368 (cond ((or (stringp dir) (pattern-p dir))
1369 (pieces (unparse-logical-piece dir))
1373 ((eq dir :wild-inferiors)
1376 (error "invalid directory component: ~S" dir))))))
1377 (apply #'concatenate 'simple-string (pieces))))
1379 (defun unparse-logical-piece (thing)
1381 ((member :wild) "*")
1382 (simple-string thing)
1384 (collect ((strings))
1385 (dolist (piece (pattern-pieces thing))
1387 (simple-string (strings piece))
1389 (cond ((eq piece :wild-inferiors)
1391 ((eq piece :multi-char-wild)
1393 (t (error "invalid keyword: ~S" piece))))))
1394 (apply #'concatenate 'simple-string (strings))))))
1396 (defun unparse-logical-file (pathname)
1397 (declare (type pathname pathname))
1398 (collect ((strings))
1399 (let* ((name (%pathname-name pathname))
1400 (type (%pathname-type pathname))
1401 (version (%pathname-version pathname))
1402 (type-supplied (not (or (null type) (eq type :unspecific))))
1403 (version-supplied (not (or (null version)
1404 (eq version :unspecific)))))
1406 (when (and (null type) (position #\. name :start 1))
1407 (error "too many dots in the name: ~S" pathname))
1408 (strings (unparse-logical-piece name)))
1411 (error "cannot specify the type without a file: ~S" pathname))
1412 (when (typep type 'simple-base-string)
1413 (when (position #\. type)
1414 (error "type component can't have a #\. inside: ~S" pathname)))
1416 (strings (unparse-logical-piece type)))
1417 (when version-supplied
1418 (unless type-supplied
1419 (error "cannot specify the version without a type: ~S" pathname))
1421 ((member :newest) (strings ".NEWEST"))
1422 ((member :wild) (strings ".*"))
1423 (fixnum (strings ".") (strings (format nil "~D" version))))))
1424 (apply #'concatenate 'simple-string (strings))))
1426 ;;; Unparse a logical pathname string.
1427 (defun unparse-enough-namestring (pathname defaults)
1428 (let* ((path-directory (pathname-directory pathname))
1429 (def-directory (pathname-directory defaults))
1431 ;; Go down the directory lists to see what matches. What's
1432 ;; left is what we want, more or less.
1433 (cond ((and (eq (first path-directory) (first def-directory))
1434 (eq (first path-directory) :absolute))
1435 ;; Both paths are :ABSOLUTE, so find where the
1436 ;; common parts end and return what's left
1437 (do* ((p (rest path-directory) (rest p))
1438 (d (rest def-directory) (rest d)))
1439 ((or (endp p) (endp d)
1440 (not (equal (first p) (first d))))
1443 ;; At least one path is :RELATIVE, so just return the
1444 ;; original path. If the original path is :RELATIVE,
1445 ;; then that's the right one. If PATH-DIRECTORY is
1446 ;; :ABSOLUTE, we want to return that except when
1447 ;; DEF-DIRECTORY is :ABSOLUTE, as handled above. so return
1448 ;; the original directory.
1450 (unparse-logical-namestring
1451 (make-pathname :host (pathname-host pathname)
1452 :directory enough-directory
1453 :name (pathname-name pathname)
1454 :type (pathname-type pathname)
1455 :version (pathname-version pathname)))))
1457 (defun unparse-logical-namestring (pathname)
1458 (declare (type logical-pathname pathname))
1459 (concatenate 'simple-string
1460 (logical-host-name (%pathname-host pathname)) ":"
1461 (unparse-logical-directory pathname)
1462 (unparse-logical-file pathname)))
1464 ;;;; logical pathname translations
1466 ;;; Verify that the list of translations consists of lists and prepare
1467 ;;; canonical translations. (Parse pathnames and expand out wildcards
1469 (defun canonicalize-logical-pathname-translations (translation-list host)
1470 (declare (type list translation-list) (type host host)
1472 (mapcar (lambda (translation)
1473 (destructuring-bind (from to) translation
1474 (list (if (typep from 'logical-pathname)
1476 (parse-namestring from host))
1480 (defun logical-pathname-translations (host)
1482 "Return the (logical) host object argument's list of translations."
1483 (declare (type (or string logical-host) host)
1485 (logical-host-translations (find-logical-host host)))
1487 (defun (setf logical-pathname-translations) (translations host)
1489 "Set the translations list for the logical host argument."
1490 (declare (type (or string logical-host) host)
1491 (type list translations)
1493 (let ((host (intern-logical-host host)))
1494 (setf (logical-host-canon-transls host)
1495 (canonicalize-logical-pathname-translations translations host))
1496 (setf (logical-host-translations host) translations)))
1498 (defun translate-logical-pathname (pathname &key)
1500 "Translate PATHNAME to a physical pathname, which is returned."
1501 (declare (type pathname-designator pathname)
1502 (values (or null pathname)))
1505 (dolist (x (logical-host-canon-transls (%pathname-host pathname))
1506 (error 'simple-file-error
1508 :format-control "no translation for ~S"
1509 :format-arguments (list pathname)))
1510 (destructuring-bind (from to) x
1511 (when (pathname-match-p pathname from)
1512 (return (translate-logical-pathname
1513 (translate-pathname pathname from to)))))))
1515 (t (translate-logical-pathname (pathname pathname)))))
1517 (defvar *logical-pathname-defaults*
1518 (%make-logical-pathname (make-logical-host :name "BOGUS")
1525 (defun load-logical-pathname-translations (host)
1527 (declare (type string host)
1528 (values (member t nil)))
1529 (if (find-logical-host host nil)
1530 ;; This host is already defined, all is well and good.
1532 ;; ANSI: "The specific nature of the search is
1533 ;; implementation-defined." SBCL: doesn't search at all
1535 ;; FIXME: now that we have a SYS host that the system uses, it
1536 ;; might be cute to search in "SYS:TRANSLATIONS;<name>.LISP"
1537 (error "logical host ~S not found" host)))