/[cmucl]/src/code/pathname.lisp
ViewVC logotype

Contents of /src/code/pathname.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.74 - (hide annotations)
Mon Sep 12 14:38:17 2005 UTC (8 years, 7 months ago) by rtoy
Branch: MAIN
Changes since 1.73: +19 -3 lines
Fix some issues with printing (make-pathname :directory '(:relative)),
which used to print as #p"", and with reading #p".", #p"./".

code/filesys.lisp:
o When parsing a unix namestring, delete any "." elements of the
  directory list.
o If we've parsed a namestring such that the file name is ".", replace
  that with :name NIL and adjust the :directory component
  appropriately, because on Unix, "." can't be the name of a file.
o Make :directory '(:relative) be printed as "./"

code/pathname.lisp:
o If the :directory argument to MAKE-PATHNAME contains strings with
  #\/, print a warning that this is not a valid element.
o Remove all "."'s from a :relative directory component.
1 wlott 1.1 ;;; -*- Package: LISP -*-
2     ;;; **********************************************************************
3     ;;; This code was written as part of the CMU Common Lisp project at
4     ;;; Carnegie Mellon University, and has been placed in the public domain.
5     ;;;
6     (ext:file-comment
7 rtoy 1.74 "$Header: /tiger/var/lib/cvsroots/cmucl/src/code/pathname.lisp,v 1.74 2005/09/12 14:38:17 rtoy Exp $")
8 wlott 1.1 ;;;
9     ;;; **********************************************************************
10     ;;;
11     ;;; Machine/filesystem independent pathname functions for CMU Common Lisp.
12     ;;;
13 ram 1.17 ;;; Written by William Lott, Paul Gleichauf and Rob MacLachlan.
14 wlott 1.1 ;;; Earlier version written by Jim Large and Rob MacLachlan
15     ;;;
16     ;;; **********************************************************************
17    
18     (in-package "LISP")
19    
20 pw 1.45 (export '(pathname pathnamep logical-pathname
21 wlott 1.1 parse-namestring merge-pathnames make-pathname
22     pathname-host pathname-device pathname-directory pathname-name
23     pathname-type pathname-version namestring file-namestring
24     directory-namestring host-namestring enough-namestring
25     wild-pathname-p pathname-match-p translate-pathname
26     translate-logical-pathname logical-pathname-translations
27     load-logical-pathname-translations *default-pathname-defaults*))
28    
29     (in-package "EXTENSIONS")
30 wlott 1.9 (export '(search-list search-list-defined-p clear-search-list
31 pw 1.44 enumerate-search-list *autoload-translations*))
32 wlott 1.1
33     (in-package "LISP")
34    
35 pw 1.44 (defvar *autoload-translations* nil
36     "When non-nil, attempt to load \"library:<host>.translations\" to resolve
37     an otherwise undefined logical host.")
38    
39 wlott 1.1
40 phg 1.16 ;;;; HOST structures
41 wlott 1.1
42 phg 1.16 ;;; The host structure holds the functions that both parse the pathname
43     ;;; information into sturcture slot entries, and after translation the inverse
44     ;;; (unparse) functions.
45     ;;;
46     (defstruct (host
47     (:print-function %print-host))
48     (parse (required-argument) :type function)
49     (unparse (required-argument) :type function)
50     (unparse-host (required-argument) :type function)
51     (unparse-directory (required-argument) :type function)
52     (unparse-file (required-argument) :type function)
53     (unparse-enough (required-argument) :type function)
54     (customary-case (required-argument) :type (member :upper :lower)))
55 phg 1.13
56 phg 1.16 ;;; %PRINT-HOST -- Internal
57     ;;;
58     (defun %print-host (host stream depth)
59     (declare (ignore depth))
60 pw 1.53 (print-unreadable-object (host stream :type t)))
61 phg 1.16
62     (defstruct (logical-host
63     (:include host
64     (:parse #'parse-logical-namestring)
65     (:unparse #'unparse-logical-namestring)
66 ram 1.17 (:unparse-host
67     #'(lambda (x) (logical-host-name (%pathname-host x))))
68 phg 1.16 (:unparse-directory #'unparse-logical-directory)
69 ram 1.17 (:unparse-file #'unparse-unix-file)
70 dtc 1.36 (:unparse-enough #'unparse-enough-namestring)
71 toy 1.57 (:customary-case :upper))
72     (:make-load-form-fun make-logical-host-load-form-fun))
73 phg 1.16 (name "" :type simple-base-string)
74     (translations nil :type list)
75     (canon-transls nil :type list))
76    
77 toy 1.57 (defun make-logical-host-load-form-fun (logical-host)
78     (values `(find-logical-host ',(logical-host-name logical-host))
79     nil))
80    
81 ram 1.17 ;;; The various magic tokens that are allowed to appear in pretty much all
82     ;;; pathname components.
83     ;;;
84     (deftype component-tokens ()
85     '(member nil :unspecific :wild))
86    
87 phg 1.16 ;;;; Pathname structures
88    
89 wlott 1.1 (defstruct (pathname
90     (:conc-name %pathname-)
91     (:print-function %print-pathname)
92     (:constructor
93     %make-pathname (host device directory name type version))
94     (:predicate pathnamep)
95     (:make-load-form-fun :just-dump-it-normally))
96 phg 1.13 ;; Slot holds the host, at present either a UNIX or logical host.
97 wlott 1.1 (host nil :type (or host null))
98 phg 1.13 ;; Device is the name of a logical or physical device holding files.
99 dtc 1.32 (device nil :type (or simple-string component-tokens))
100 phg 1.13 ;; A list of strings that are the component subdirectory components.
101 wlott 1.1 (directory nil :type list)
102 phg 1.13 ;; The filename.
103 ram 1.17 (name nil :type (or simple-string pattern component-tokens))
104 phg 1.13 ;; The type extension of the file.
105 ram 1.17 (type nil :type (or simple-string pattern component-tokens))
106 phg 1.13 ;; The version number of the file, a positive integer, but not supported
107     ;; on standard UNIX filesystems.
108 ram 1.17 (version nil :type (or integer component-tokens (member :newest))))
109 wlott 1.1
110 phg 1.13 ;;; %PRINT-PATHNAME -- Internal
111     ;;;
112     ;;; The printed representation of the pathname structure.
113     ;;;
114 wlott 1.1 (defun %print-pathname (pathname stream depth)
115     (declare (ignore depth))
116     (let ((namestring (handler-case (namestring pathname)
117     (error nil))))
118     (cond (namestring
119 dtc 1.39 (if (or *print-escape* *print-readably*)
120 rtoy 1.67 (format stream "#P~S" namestring)
121 dtc 1.39 (format stream "~A" namestring)))
122 wlott 1.1 (*print-readably*
123 rtoy 1.69 (error 'print-not-readable :object pathname))
124 wlott 1.1 (t
125     (funcall (formatter "#<Unprintable pathname, Host=~S, Device=~S, ~
126 pw 1.28 Directory=~S, Name=~S, Type=~S, Version=~S>")
127 wlott 1.1 stream
128     (%pathname-host pathname)
129     (%pathname-device pathname)
130     (%pathname-directory pathname)
131     (%pathname-name pathname)
132     (%pathname-type pathname)
133     (%pathname-version pathname))))))
134    
135 phg 1.16 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
136 phg 1.13 ;;;
137 phg 1.16 ;;; Logical pathnames have the following format:
138     ;;;
139     ;;; logical-namestring ::=
140     ;;; [host ":"] [";"] {directory ";"}* [name] ["." type ["." version]]
141     ;;;
142     ;;; host ::= word
143     ;;; directory ::= word | wildcard-word | **
144     ;;; name ::= word | wildcard-word
145     ;;; type ::= word | wildcard-word
146     ;;; version ::= pos-int | newest | NEWEST | *
147     ;;; word ::= {uppercase-letter | digit | -}+
148     ;;; wildcard-word ::= [word] '* {word '*}* [word]
149     ;;; pos-int ::= integer > 0
150     ;;;
151     ;;; Physical pathnames include all these slots and a device slot.
152     ;;;
153     ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
154 wlott 1.1
155 phg 1.16 ;; Logical pathnames are a subclass of pathname, their class relations are
156     ;; mimiced using structures for efficency.
157    
158     (defstruct (logical-pathname
159     (:conc-name %logical-pathname-)
160     (:print-function %print-logical-pathname)
161     (:include pathname)
162 ram 1.17 (:constructor %make-logical-pathname
163     (host device directory name type version))
164 phg 1.16 (:make-load-form-fun :just-dump-it-normally)))
165 ram 1.19
166     (declaim (freeze-type logical-pathname logical-host))
167 phg 1.16
168     ;;; %PRINT-LOGICAL-PATHNAME -- Internal
169 phg 1.13 ;;;
170 phg 1.16 ;;; The printed representation of the logical-pathname structure.
171     ;;; The potential conflict with search-lists requires isolating the printed
172     ;;; representation to use the i/o macro #.(logical-pathname <path-designator>).
173     ;;;
174 rtoy 1.68 ;;; Is there really a potential conflict? CMUCL does not allow
175     ;;; search-list hosts and logical pathname hosts have the same name.
176     ;;; Hence, if we use #P to print them out, we can always read them
177     ;;; back without confusion. (rtoy)
178     ;;;
179 phg 1.16 (defun %print-logical-pathname (pathname stream depth)
180 wlott 1.1 (declare (ignore depth))
181 phg 1.16 (let ((namestring (handler-case (namestring pathname)
182     (error nil))))
183     (cond (namestring
184 dtc 1.39 (if (or *print-escape* *print-readably*)
185 rtoy 1.68 (format stream "#P~S" namestring)
186 dtc 1.39 (format stream "~A" namestring)))
187 phg 1.16 (*print-readably*
188 rtoy 1.69 (error 'print-not-readable :object pathname))
189 phg 1.16 (t
190     (funcall (formatter "#<Unprintable pathname, Host=~S, ~
191     Directory=~S, File=~S, Name=~S, Version=~S>")
192     stream
193     (%pathname-host pathname)
194     (%pathname-directory pathname)
195     (%pathname-name pathname)
196     (%pathname-type pathname)
197     (%pathname-version pathname))))))
198 wlott 1.1
199 pw 1.28 ;;; %MAKE-PATHNAME-OBJECT -- internal
200     ;;;
201     ;;; A pathname is logical if the host component is a logical-host.
202     ;;; This constructor is used to make an instance of the correct type
203     ;;; from parsed arguments.
204    
205     (defun %make-pathname-object (host device directory name type version)
206     (if (typep host 'logical-host)
207 rtoy 1.65 (flet ((upcasify (thing)
208     (typecase thing
209     (list
210     (mapcar #'(lambda (x)
211     (if (stringp x)
212     (string-upcase x)
213     x))
214     thing))
215     (simple-base-string
216     (string-upcase thing))
217     (t
218     thing))))
219     (%make-logical-pathname host :unspecific
220     (upcasify directory)
221     (upcasify name)
222     (upcasify type)
223     (upcasify version)))
224 pw 1.28 (%make-pathname host device directory name type version)))
225    
226 phg 1.16 ;;; *LOGICAL-HOSTS* --internal.
227     ;;;
228     ;;; Hash table searching maps a logical-pathname's host to their physical
229     ;;; pathname translation.
230    
231     (defvar *logical-hosts* (make-hash-table :test #'equal))
232    
233 ram 1.17 ;;; PATH-DESIGNATOR -- internal type
234 phg 1.16 ;;;
235     (deftype path-designator ()
236     "A path specification, either a string, stream or pathname."
237 ram 1.17 '(or string stream pathname))
238 phg 1.16
239 wlott 1.1
240     ;;;; Patterns
241    
242 phg 1.13 ;;; Patterns are a list of entries and wildcards used for pattern matches
243     ;;; of translations.
244    
245 wlott 1.1 (defstruct (pattern
246     (:print-function %print-pattern)
247     (:make-load-form-fun :just-dump-it-normally)
248     (:constructor make-pattern (pieces)))
249     (pieces nil :type list))
250    
251 phg 1.13 ;;; %PRINT-PATTERN -- Internal
252     ;;;
253 wlott 1.1 (defun %print-pattern (pattern stream depth)
254     (declare (ignore depth))
255     (print-unreadable-object (pattern stream :type t)
256     (if *print-pretty*
257     (let ((*print-escape* t))
258     (pprint-fill stream (pattern-pieces pattern) nil))
259     (prin1 (pattern-pieces pattern) stream))))
260    
261 phg 1.13 ;;; PATTERN= -- Internal
262     ;;;
263 wlott 1.1 (defun pattern= (pattern1 pattern2)
264     (declare (type pattern pattern1 pattern2))
265     (let ((pieces1 (pattern-pieces pattern1))
266     (pieces2 (pattern-pieces pattern2)))
267     (and (= (length pieces1) (length pieces2))
268     (every #'(lambda (piece1 piece2)
269     (typecase piece1
270     (simple-string
271     (and (simple-string-p piece2)
272     (string= piece1 piece2)))
273     (cons
274     (and (consp piece2)
275     (eq (car piece1) (car piece2))
276     (string= (cdr piece1) (cdr piece2))))
277     (t
278     (eq piece1 piece2))))
279     pieces1
280     pieces2))))
281    
282 phg 1.13 ;;; PATTERN-MATCHES -- Internal
283     ;;;
284 pw 1.30 ;;; If the string matches the pattern returns the multiple values T and a
285 phg 1.16 ;;; list of the matched strings.
286     ;;;
287 phg 1.13 (defun pattern-matches (pattern string)
288     (declare (type pattern pattern)
289     (type simple-string string))
290     (let ((len (length string)))
291     (labels ((maybe-prepend (subs cur-sub chars)
292     (if cur-sub
293     (let* ((len (length chars))
294     (new (make-string len))
295     (index len))
296     (dolist (char chars)
297     (setf (schar new (decf index)) char))
298     (cons new subs))
299     subs))
300     (matches (pieces start subs cur-sub chars)
301     (if (null pieces)
302     (if (= start len)
303     (values t (maybe-prepend subs cur-sub chars))
304     (values nil nil))
305     (let ((piece (car pieces)))
306     (etypecase piece
307     (simple-string
308     (let ((end (+ start (length piece))))
309     (and (<= end len)
310     (string= piece string
311     :start2 start :end2 end)
312     (matches (cdr pieces) end
313     (maybe-prepend subs cur-sub chars)
314     nil nil))))
315     (list
316     (ecase (car piece)
317     (:character-set
318     (and (< start len)
319     (let ((char (schar string start)))
320 rtoy 1.66 (if (find char (second piece) :test #'char=)
321 phg 1.13 (matches (cdr pieces) (1+ start) subs t
322     (cons char chars))))))))
323     ((member :single-char-wild)
324     (and (< start len)
325     (matches (cdr pieces) (1+ start) subs t
326     (cons (schar string start) chars))))
327 ram 1.17 ((member :multi-char-wild)
328 phg 1.13 (multiple-value-bind
329     (won new-subs)
330     (matches (cdr pieces) start subs t chars)
331     (if won
332     (values t new-subs)
333     (and (< start len)
334     (matches pieces (1+ start) subs t
335     (cons (schar string start)
336     chars)))))))))))
337     (multiple-value-bind
338     (won subs)
339     (matches (pattern-pieces pattern) 0 nil nil nil)
340     (values won (reverse subs))))))
341 wlott 1.1
342 phg 1.16
343 ram 1.17 ;;; DIRECTORY-COMPONENTS-MATCH -- Internal
344 phg 1.16 ;;;
345 dtc 1.35 ;;; Pathname-match-p for directory components. If thing is empty
346     ;;; then it matches :wild, (:absolute :wild-inferiors), or (:relative
347     ;;; :wild-inferiors).
348 phg 1.16 ;;;
349 ram 1.17 (defun directory-components-match (thing wild)
350     (or (eq thing wild)
351     (eq wild :wild)
352     (and (consp wild)
353     (let ((wild1 (first wild)))
354 dtc 1.35 (cond ((and (null thing) (member wild1 '(:absolute :relative)))
355     (equal (rest wild) '(:wild-inferiors)))
356     ((eq wild1 :wild-inferiors)
357     (let ((wild-subdirs (rest wild)))
358     (or (null wild-subdirs)
359     (loop
360     (when (directory-components-match thing
361     wild-subdirs)
362     (return t))
363     (pop thing)
364     (unless thing (return nil))))))
365     ((consp thing)
366     (and (components-match (first thing) wild1)
367     (directory-components-match (rest thing)
368     (rest wild)))))))))
369 phg 1.16
370    
371 phg 1.13 ;;; COMPONENTS-MATCH -- Internal
372     ;;;
373 ram 1.17 ;;; Return true if pathname component Thing is matched by Wild. Not
374     ;;; commutative.
375 phg 1.13 ;;;
376 ram 1.17 (defun components-match (thing wild)
377     (declare (type (or pattern symbol simple-string integer) thing wild))
378     (or (eq thing wild)
379     (eq wild :wild)
380     (typecase thing
381 phg 1.13 (simple-base-string
382 ram 1.17 ;; String is matched by itself, a matching pattern or :WILD.
383     (typecase wild
384 phg 1.16 (pattern
385 ram 1.17 (values (pattern-matches wild thing)))
386 phg 1.13 (simple-base-string
387 ram 1.17 (string= thing wild))))
388 phg 1.13 (pattern
389 ram 1.17 ;; A pattern is only matched by an identical pattern.
390     (and (pattern-p wild) (pattern= thing wild)))
391     (integer
392     ;; an integer (version number) is matched by :WILD or the same
393     ;; integer. This branch will actually always be NIL as long is the
394     ;; version is a fixnum.
395     (eql thing wild)))))
396 phg 1.13
397 ram 1.17
398 phg 1.13 ;;; COMPARE-COMPONENT -- Internal
399     ;;;
400     ;;; A predicate for comparing two pathname slot component sub-entries.
401     ;;;
402 wlott 1.1 (defun compare-component (this that)
403     (or (eql this that)
404     (typecase this
405     (simple-string
406     (and (simple-string-p that)
407     (string= this that)))
408     (pattern
409     (and (pattern-p that)
410     (pattern= this that)))
411     (cons
412     (and (consp that)
413     (compare-component (car this) (car that))
414     (compare-component (cdr this) (cdr that)))))))
415    
416    
417 phg 1.13 ;;;; Pathname functions.
418 wlott 1.1
419 phg 1.13 ;;; Implementation determined defaults to pathname slots.
420 wlott 1.1
421     (defvar *default-pathname-defaults*)
422    
423 phg 1.13 ;;; PATHNAME= -- Internal
424     ;;;
425 wlott 1.1 (defun pathname= (pathname1 pathname2)
426 phg 1.16 (declare (type pathname pathname1)
427     (type pathname pathname2))
428 wlott 1.1 (and (eq (%pathname-host pathname1)
429     (%pathname-host pathname2))
430     (compare-component (%pathname-device pathname1)
431     (%pathname-device pathname2))
432     (compare-component (%pathname-directory pathname1)
433     (%pathname-directory pathname2))
434     (compare-component (%pathname-name pathname1)
435     (%pathname-name pathname2))
436     (compare-component (%pathname-type pathname1)
437     (%pathname-type pathname2))
438     (compare-component (%pathname-version pathname1)
439     (%pathname-version pathname2))))
440    
441 phg 1.13 ;;; WITH-PATHNAME -- Internal
442 phg 1.16 ;;; Converts the expr, a pathname designator (a pathname, or string, or
443 phg 1.13 ;;; stream), into a pathname.
444     ;;;
445 wlott 1.1 (defmacro with-pathname ((var expr) &body body)
446     `(let ((,var (let ((,var ,expr))
447     (etypecase ,var
448     (pathname ,var)
449     (string (parse-namestring ,var))
450 toy 1.61 (file-stream (file-name ,var))
451     (stream:file-simple-stream (file-name ,var))))))
452 wlott 1.1 ,@body))
453    
454 phg 1.16 ;;; WITH-HOST -- Internal
455     ;;;
456     ;;; Converts the var, a host or string name for a host, into a logical-host
457     ;;; structure or nil if not defined.
458     ;;;
459 pw 1.28 ;;; pw notes 1/12/97 this potentially useful macro is not used anywhere
460     ;;; and 'find-host' is not defined. 'find-logical-host' seems to be needed.
461     ;;;
462 phg 1.16 (defmacro with-host ((var expr) &body body)
463     `(let ((,var (let ((,var ,expr))
464     (typecase ,var
465     (logical-host ,var)
466 pw 1.28 (string (find-logical-host ,var nil))
467 phg 1.16 (t nil)))))
468     ,@body))
469 wlott 1.1
470 phg 1.13 ;;; PATHNAME -- Interface
471     ;;;
472 wlott 1.1 (defun pathname (thing)
473 phg 1.13 "Convert thing (a pathname, string or stream) into a pathname."
474 phg 1.16 (declare (type path-designator thing))
475 wlott 1.1 (with-pathname (pathname thing)
476     pathname))
477    
478 phg 1.13 ;;; MAYBE-DIDDLE-CASE -- Internal
479     ;;;
480     ;;; Change the case of thing if diddle-p T.
481     ;;;
482 wlott 1.1 (defun maybe-diddle-case (thing diddle-p)
483 ram 1.17 (if (and diddle-p (not (or (symbolp thing) (integerp thing))))
484 wlott 1.1 (labels ((check-for (pred in)
485 ram 1.17 (typecase in
486 wlott 1.1 (pattern
487     (dolist (piece (pattern-pieces in))
488     (when (typecase piece
489     (simple-string
490     (check-for pred piece))
491     (cons
492     (case (car in)
493     (:character-set
494     (check-for pred (cdr in))))))
495     (return t))))
496     (list
497     (dolist (x in)
498     (when (check-for pred x)
499     (return t))))
500     (simple-base-string
501     (dotimes (i (length in))
502     (when (funcall pred (schar in i))
503     (return t))))
504 ram 1.17 (t nil)))
505 wlott 1.1 (diddle-with (fun thing)
506 ram 1.17 (typecase thing
507 wlott 1.1 (pattern
508     (make-pattern
509     (mapcar #'(lambda (piece)
510     (typecase piece
511     (simple-base-string
512 pw 1.29 (funcall fun piece))
513 wlott 1.1 (cons
514     (case (car piece)
515     (:character-set
516     (cons :character-set
517     (funcall fun (cdr piece))))
518     (t
519     piece)))
520     (t
521     piece)))
522     (pattern-pieces thing))))
523     (list
524     (mapcar fun thing))
525 phg 1.12 (simple-base-string
526     (funcall fun thing))
527 ram 1.17 (t
528 phg 1.12 thing))))
529 wlott 1.1 (let ((any-uppers (check-for #'upper-case-p thing))
530     (any-lowers (check-for #'lower-case-p thing)))
531     (cond ((and any-uppers any-lowers)
532     ;; Mixed case, stays the same.
533     thing)
534 phg 1.12 (any-uppers
535     ;; All uppercase, becomes all lower case.
536     (diddle-with #'(lambda (x) (if (stringp x)
537     (string-downcase x)
538     x)) thing))
539     (any-lowers
540     ;; All lowercase, becomes all upper case.
541     (diddle-with #'(lambda (x) (if (stringp x)
542     (string-upcase x)
543     x)) thing))
544     (t
545     ;; No letters? I guess just leave it.
546     thing))))
547 wlott 1.1 thing))
548    
549 ram 1.17
550 phg 1.13 ;;; MERGE-DIRECTORIES -- Internal
551     ;;;
552 wlott 1.1 (defun merge-directories (dir1 dir2 diddle-case)
553 wlott 1.6 (if (or (eq (car dir1) :absolute)
554     (null dir2))
555 wlott 1.1 dir1
556     (let ((results nil))
557     (flet ((add (dir)
558     (if (and (eq dir :back)
559     results
560     (not (eq (car results) :back)))
561     (pop results)
562     (push dir results))))
563     (dolist (dir (maybe-diddle-case dir2 diddle-case))
564     (add dir))
565     (dolist (dir (cdr dir1))
566     (add dir)))
567     (reverse results))))
568    
569 phg 1.13 ;;; MERGE-PATHNAMES -- Interface
570     ;;;
571 wlott 1.1 (defun merge-pathnames (pathname
572     &optional
573     (defaults *default-pathname-defaults*)
574     (default-version :newest))
575 phg 1.13 "Construct a filled in pathname by completing the unspecified components
576     from the defaults."
577 phg 1.16 (declare (type path-designator pathname)
578     (type path-designator defaults)
579     (values pathname))
580 wlott 1.1 (with-pathname (defaults defaults)
581 wlott 1.2 (let ((pathname (let ((*default-pathname-defaults* defaults))
582     (pathname pathname))))
583 wlott 1.1 (let* ((default-host (%pathname-host defaults))
584     (pathname-host (%pathname-host pathname))
585     (diddle-case
586     (and default-host pathname-host
587     (not (eq (host-customary-case default-host)
588     (host-customary-case pathname-host))))))
589 pw 1.28 (%make-pathname-object
590     (or pathname-host default-host)
591     (or (%pathname-device pathname)
592     (maybe-diddle-case (%pathname-device defaults)
593     diddle-case))
594     (merge-directories (%pathname-directory pathname)
595     (%pathname-directory defaults)
596     diddle-case)
597     (or (%pathname-name pathname)
598     (maybe-diddle-case (%pathname-name defaults)
599     diddle-case))
600     (or (%pathname-type pathname)
601     (maybe-diddle-case (%pathname-type defaults)
602     diddle-case))
603 toy 1.55 (or (if (null (%pathname-name pathname))
604     (or (%pathname-version pathname)
605     (%pathname-version defaults))
606     (%pathname-version pathname))
607 pw 1.28 default-version))))))
608 wlott 1.1
609 phg 1.13 ;;; IMPORT-DIRECTORY -- Internal
610     ;;;
611 wlott 1.1 (defun import-directory (directory diddle-case)
612     (etypecase directory
613     (null nil)
614 ram 1.17 ((member :wild) '(:absolute :wild-inferiors))
615     ((member :unspecific) '(:relative))
616 wlott 1.1 (list
617     (collect ((results))
618     (ecase (pop directory)
619     (:absolute
620     (results :absolute)
621     (when (search-list-p (car directory))
622     (results (pop directory))))
623     (:relative
624     (results :relative)))
625     (dolist (piece directory)
626 ram 1.17 (cond ((member piece '(:wild :wild-inferiors :up :back))
627 phg 1.12 (results piece))
628 wlott 1.1 ((or (simple-string-p piece) (pattern-p piece))
629     (results (maybe-diddle-case piece diddle-case)))
630     ((stringp piece)
631     (results (maybe-diddle-case (coerce piece 'simple-string)
632     diddle-case)))
633     (t
634     (error "~S is not allowed as a directory component." piece))))
635     (results)))
636     (simple-string
637     `(:absolute
638     ,(maybe-diddle-case directory diddle-case)))
639     (string
640     `(:absolute
641     ,(maybe-diddle-case (coerce directory 'simple-string)
642     diddle-case)))))
643    
644 phg 1.13 ;;; MAKE-PATHNAME -- Interface
645     ;;;
646 rtoy 1.72 (defun make-pathname (&key (host nil hostp)
647 ram 1.11 (device nil devp)
648     (directory nil dirp)
649     (name nil namep)
650     (type nil typep)
651     (version nil versionp)
652 phg 1.16 defaults
653     (case :local))
654 ram 1.27 "Makes a new pathname from the component arguments. Note that host is
655     a host-structure or string."
656 rtoy 1.72 (declare (type (or null string host component-tokens) host)
657 dtc 1.32 (type (or string component-tokens) device)
658 ram 1.17 (type (or list string pattern component-tokens) directory)
659     (type (or string pattern component-tokens) name type)
660     (type (or integer component-tokens (member :newest)) version)
661 phg 1.16 (type (or path-designator null) defaults)
662 wlott 1.1 (type (member :common :local) case))
663 phg 1.16 (let* ((defaults (when defaults
664     (with-pathname (defaults defaults) defaults)))
665 wlott 1.1 (default-host (if defaults
666     (%pathname-host defaults)
667 pmai 1.60 (%pathname-host *default-pathname-defaults*)))
668 ram 1.27 ;; toy@rtp.ericsson.se: CLHS says make-pathname can take a
669     ;; string (as a logical-host) for the host part. We map that
670     ;; string into the corresponding logical host structure.
671 pw 1.28
672     ;; pw@snoopy.mv.com:
673     ;; HyperSpec says for the arg to MAKE-PATHNAME;
674     ;; "host---a valid physical pathname host. ..."
675     ;; where it probably means -- a valid pathname host.
676     ;; "valid pathname host n. a valid physical pathname host or
677     ;; a valid logical pathname host."
678     ;; and defines
679     ;; "valid physical pathname host n. any of a string,
680     ;; a list of strings, or the symbol :unspecific,
681     ;; that is recognized by the implementation as the name of a host."
682     ;; "valid logical pathname host n. a string that has been defined
683     ;; as the name of a logical host. ..."
684     ;; HS is silent on what happens if the :host arg is NOT one of these.
685     ;; It seems an error message is appropriate.
686     (host (typecase host
687 toy 1.57 (host host) ; A valid host, use it.
688     ((string 0) default-host) ; "" cannot be a logical host
689 pw 1.28 (string (find-logical-host host t)) ; logical-host or lose.
690 rtoy 1.72 (t
691     ;; If the user specifically set :host to be NIL, use
692     ;; it. Otherwise, we use the default host.
693     (if (and hostp (null host))
694     nil
695     default-host))))
696     (diddle-args
697     ;; What to do if no host is given? Can't figure out the
698     ;; customary case, so I (rtoy) am going to assume we don't
699     ;; need to diddle args.
700     (and host (eq (host-customary-case host) :lower)
701     (eq case :common)))
702 wlott 1.1 (diddle-defaults
703 rtoy 1.72 ;; Same for diddle-defaults. Do nothing if no host was given.
704     (and host (not (eq (host-customary-case host)
705     (host-customary-case default-host)))))
706 phg 1.16 (dev (if devp device (if defaults (%pathname-device defaults))))
707     (dir (import-directory directory diddle-args))
708     (ver (cond
709     (versionp version)
710     (defaults (%pathname-version defaults))
711     (t nil))))
712     (when (and defaults (not dirp))
713     (setf dir
714     (merge-directories dir
715     (%pathname-directory defaults)
716     diddle-defaults)))
717 pw 1.47
718     ;; A bit of sanity checking on user arguments.
719     (flet ((check-component-validity (name name-or-type)
720 pw 1.49 (when (stringp name)
721     (let ((unix-directory-separator #\/))
722 pmai 1.60 (when (eq host (%pathname-host *default-pathname-defaults*))
723 pw 1.49 (when (find unix-directory-separator name)
724     (warn "Silly argument for a unix ~A: ~S"
725     name-or-type name)))))))
726 pw 1.47 (check-component-validity name :pathname-name)
727 rtoy 1.74 (check-component-validity type :pathname-type)
728     (mapc #'(lambda (d)
729     (check-component-validity d :directory))
730     (cdr dir)))
731    
732     ;; More sanity checking
733     (when dir
734     ;; Try to canonicalize the directory component. :absolute
735     ;; followed by a bunch of "/" deletes the leading "/"'s.
736     ;; :relative followed by "." anywhere gets them all deleted.
737     (ecase (first dir)
738     (:absolute
739     (do ((p (cdr dir) (cdr p)))
740     ((or (null p)
741     (not (equal "/" (car p))))
742     (setf (cdr dir) p))))
743     (:relative
744     (setf (cdr dir) (delete "." (cdr dir) :test #'equal)))))
745 toy 1.63 ;; CLHS 19.2.2.4.3 says :absolute or :wild-inferiors immediately
746     ;; followed by :up or :back signals a file-error.
747    
748     (let ((d (or (member :wild-inferiors dir)
749     (member :absolute dir))))
750     (when (and d (rest d) (member (second d) '(:up :back)))
751 rtoy 1.73 ;; What should we put in the for pathname part of file-error?
752     ;; I'm just going to use the directory but removing the
753     ;; offending :up or :back. Or would just (make-pathname) be
754     ;; enough?
755     ;;
756     ;; Or instead of checking here, we could check whenever we
757     ;; "use" the file system (CLHS 19.2.2.4.3). But that's a lot
758     ;; harder to do.
759     (error 'simple-file-error
760     :pathname (make-pathname :directory (remove-if #'(lambda (x)
761     (member x '(:up :back)))
762     dir))
763     :format-control "Illegal pathname: ~
764     Directory with ~S immediately followed by ~S"
765     :format-arguments (list (first d) (second d)))))
766 phg 1.16
767 ram 1.11 (macrolet ((pick (var varp field)
768 ram 1.17 `(cond ((or (simple-string-p ,var)
769 wlott 1.1 (pattern-p ,var))
770     (maybe-diddle-case ,var diddle-args))
771     ((stringp ,var)
772     (maybe-diddle-case (coerce ,var 'simple-string)
773     diddle-args))
774 ram 1.11 (,varp
775 wlott 1.1 (maybe-diddle-case ,var diddle-args))
776     (defaults
777     (maybe-diddle-case (,field defaults)
778     diddle-defaults))
779     (t
780     nil))))
781 pw 1.28 (%make-pathname-object host
782     dev ; forced to :unspecific when logical-host
783     dir
784     (pick name namep %pathname-name)
785     (pick type typep %pathname-type)
786     ver))))
787 wlott 1.1
788 phg 1.13 ;;; PATHNAME-HOST -- Interface
789     ;;;
790 wlott 1.1 (defun pathname-host (pathname &key (case :local))
791 phg 1.13 "Accessor for the pathname's host."
792 phg 1.16 (declare (type path-designator pathname)
793 wlott 1.1 (type (member :local :common) case)
794 pmai 1.60 (values (or string null))
795 wlott 1.1 (ignore case))
796 pmai 1.60 (host-namestring pathname))
797 wlott 1.1
798 phg 1.13 ;;; PATHNAME-DEVICE -- Interface
799     ;;;
800 wlott 1.1 (defun pathname-device (pathname &key (case :local))
801 phg 1.13 "Accessor for pathname's device."
802 phg 1.16 (declare (type path-designator pathname)
803 wlott 1.1 (type (member :local :common) case))
804     (with-pathname (pathname pathname)
805     (maybe-diddle-case (%pathname-device pathname)
806     (and (eq case :common)
807     (eq (host-customary-case
808     (%pathname-host pathname))
809     :lower)))))
810    
811 phg 1.13 ;;; PATHNAME-DIRECTORY -- Interface
812     ;;;
813 wlott 1.1 (defun pathname-directory (pathname &key (case :local))
814 phg 1.13 "Accessor for the pathname's directory list."
815 phg 1.16 (declare (type path-designator pathname)
816 wlott 1.1 (type (member :local :common) case))
817     (with-pathname (pathname pathname)
818     (maybe-diddle-case (%pathname-directory pathname)
819     (and (eq case :common)
820     (eq (host-customary-case
821     (%pathname-host pathname))
822     :lower)))))
823 phg 1.13 ;;; PATHNAME-NAME -- Interface
824     ;;;
825 wlott 1.1 (defun pathname-name (pathname &key (case :local))
826 phg 1.13 "Accessor for the pathname's name."
827 phg 1.16 (declare (type path-designator pathname)
828 wlott 1.1 (type (member :local :common) case))
829     (with-pathname (pathname pathname)
830     (maybe-diddle-case (%pathname-name pathname)
831     (and (eq case :common)
832     (eq (host-customary-case
833     (%pathname-host pathname))
834     :lower)))))
835    
836 phg 1.13 ;;; PATHNAME-TYPE
837     ;;;
838 wlott 1.1 (defun pathname-type (pathname &key (case :local))
839 phg 1.13 "Accessor for the pathname's name."
840 phg 1.16 (declare (type path-designator pathname)
841 wlott 1.1 (type (member :local :common) case))
842     (with-pathname (pathname pathname)
843     (maybe-diddle-case (%pathname-type pathname)
844     (and (eq case :common)
845     (eq (host-customary-case
846     (%pathname-host pathname))
847     :lower)))))
848 phg 1.16
849 phg 1.13 ;;; PATHNAME-VERSION
850     ;;;
851 wlott 1.1 (defun pathname-version (pathname)
852 phg 1.13 "Accessor for the pathname's version."
853 phg 1.16 (declare (type path-designator pathname))
854 wlott 1.1 (with-pathname (pathname pathname)
855     (%pathname-version pathname)))
856    
857 phg 1.13
858     ;;;; Namestrings
859    
860     ;;; %PRINT-NAMESTRING-PARSE-ERROR -- Internal
861     ;;;
862     (defun %print-namestring-parse-error (condition stream)
863     (format stream "Parse error in namestring: ~?~% ~A~% ~V@T^"
864     (namestring-parse-error-complaint condition)
865     (namestring-parse-error-arguments condition)
866     (namestring-parse-error-namestring condition)
867     (namestring-parse-error-offset condition)))
868    
869 rtoy 1.71 (define-condition namestring-parse-error (parse-error type-error)
870 ram 1.24 ((complaint :reader namestring-parse-error-complaint :initarg :complaint)
871     (arguments :reader namestring-parse-error-arguments :initarg :arguments
872     :initform nil)
873     (namestring :reader namestring-parse-error-namestring :initarg :namestring)
874     (offset :reader namestring-parse-error-offset :initarg :offset))
875 phg 1.13 (:report %print-namestring-parse-error))
876    
877    
878 ram 1.17 ;;; %PARSE-NAMESTRING -- Internal
879 phg 1.16 ;;;
880 ram 1.17 ;;; Handle the case where parse-namestring is actually parsing a namestring.
881     ;;; We pick off the :JUNK-ALLOWED case then find a host to use for parsing,
882     ;;; call the parser, then check if the host matches.
883     ;;;
884     (defun %parse-namestring (namestr host defaults start end junk-allowed)
885 dtc 1.41 (declare (type string namestr)
886 pw 1.48 (type (or host string null) host)
887     (type pathname defaults)
888 dtc 1.41 (type index start)
889     (type (or index null) end))
890 ram 1.17 (if junk-allowed
891     (handler-case
892     (%parse-namestring namestr host defaults start end nil)
893     (namestring-parse-error (condition)
894     (values nil (namestring-parse-error-offset condition))))
895     (let* ((end (or end (length namestr)))
896 pw 1.48 (host (if (and host (stringp host))
897     (find-logical-host host)
898     host))
899 pmai 1.60 (default-host (%pathname-host defaults))
900 ram 1.17 (parse-host (or host
901     (extract-logical-host-prefix namestr start end)
902 pw 1.48 default-host)))
903 ram 1.17 (unless parse-host
904     (error "When Host arg is not supplied, Defaults arg must ~
905     have a non-null PATHNAME-HOST."))
906 phg 1.16
907 ram 1.17 (multiple-value-bind
908     (new-host device directory file type version)
909     (funcall (host-parse parse-host) namestr start end)
910     (when (and host new-host (not (eq new-host host)))
911     (error "Host in namestring: ~S~@
912     does not match explicit host argument: ~S"
913 pw 1.43 namestr host))
914 ram 1.17 (let ((pn-host (or new-host parse-host)))
915 pw 1.28 (values (%make-pathname-object
916     pn-host device directory file type version)
917 ram 1.17 end))))))
918    
919    
920     ;;; EXTRACT-LOGICAL-HOST-PREFIX -- Internal
921 phg 1.16 ;;;
922 ram 1.17 ;;; If namestr begins with a colon-terminated, defined, logical host, then
923     ;;; return that host, otherwise return NIL.
924 phg 1.16 ;;;
925 ram 1.17 (defun extract-logical-host-prefix (namestr start end)
926 phg 1.16 (declare (type simple-base-string namestr)
927     (type index start end)
928 ram 1.17 (values (or logical-host null)))
929     (let ((colon-pos (position #\: namestr :start start :end end)))
930     (if colon-pos
931 pw 1.50 (find-logical-host (nstring-upcase (subseq namestr start colon-pos))
932     nil)
933 pw 1.43 nil)))
934 phg 1.16
935 phg 1.13 ;;; PARSE-NAMESTRING -- Interface
936     ;;;
937     (defun parse-namestring (thing
938     &optional host (defaults *default-pathname-defaults*)
939     &key (start 0) end junk-allowed)
940 phg 1.16 "Converts pathname, a pathname designator, into a pathname structure,
941     for a physical pathname, returns the printed representation. Host may be
942     a physical host structure or host namestring."
943     (declare (type path-designator thing)
944 toy 1.57 (type (or list string host (member :unspecific)) host)
945 phg 1.16 (type pathname defaults)
946 phg 1.13 (type index start)
947 dtc 1.41 (type (or index null) end))
948 toy 1.57 ;; Generally, redundant specification of information in software,
949     ;; whether in code or in comments, is bad. However, the ANSI spec
950     ;; for this is messy enough that it's hard to hold in short-term
951     ;; memory, so I've recorded these redundant notes on the
952     ;; implications of the ANSI spec.
953     ;;
954     ;; According to the ANSI spec, HOST can be a valid pathname host, or
955     ;; a logical host, or NIL.
956     ;;
957     ;; A valid pathname host can be a valid physical pathname host or a
958     ;; valid logical pathname host.
959     ;;
960     ;; A valid physical pathname host is "any of a string, a list of
961     ;; strings, or the symbol :UNSPECIFIC, that is recognized by the
962     ;; implementation as the name of a host". In SBCL as of 0.6.9.8,
963     ;; that means :UNSPECIFIC: though someday we might want to
964     ;; generalize it to allow strings like "RTFM.MIT.EDU" or lists like
965     ;; '("RTFM" "MIT" "EDU"), that's not supported now.
966     ;;
967     ;; A valid logical pathname host is a string which has been defined as
968     ;; the name of a logical host, as with LOAD-LOGICAL-PATHNAME-TRANSLATIONS.
969     ;;
970     (let ((host (etypecase host
971     ((string 0)
972     ;; This is a special host. It's not valid as a
973     ;; logical host, so it is a sensible thing to
974     ;; designate the physical Unix host object. So
975     ;; we do that.
976     *unix-host*)
977     (string
978     ;; In general ANSI-compliant Common Lisps, a
979     ;; string might also be a physical pathname host,
980     ;; but ANSI leaves this up to the implementor,
981     ;; and in CMUCL we don't do it, so it must be a
982     ;; logical host.
983     (find-logical-host host))
984     ((or null (member :unspecific))
985     ;; CLHS says that HOST=:UNSPECIFIC has
986     ;; implementation-defined behavior. We
987     ;; just turn it into NIL.
988     nil)
989     (list
990     ;; ANSI also allows LISTs to designate hosts,
991     ;; but leaves its interpretation
992     ;; implementation-defined. Our interpretation
993     ;; is that it's unsupported.:-|
994     (error "A LIST representing a pathname host is not ~
995     supported in this implementation:~% ~S"
996     host))
997     (host
998     host))))
999     (declare (type (or null host) host))
1000 dtc 1.40 (etypecase thing
1001 ram 1.17 (simple-string
1002     (%parse-namestring thing host defaults start end junk-allowed))
1003     (string
1004     (%parse-namestring (coerce thing 'simple-string)
1005     host defaults start end junk-allowed))
1006     (pathname
1007 dtc 1.31 (let ((host (if host host (%pathname-host defaults))))
1008     (unless (eq host (%pathname-host thing))
1009 phg 1.16 (error "Hosts do not match: ~S and ~S."
1010 dtc 1.31 host (%pathname-host thing))))
1011 phg 1.16 (values thing start))
1012     (stream
1013 ram 1.21 (let ((name (file-name thing)))
1014     (unless name
1015 rtoy 1.70 (error 'simple-type-error
1016     :datum thing
1017     :expected-type 'pathname
1018     :format-control "Can't figure out the file associated with stream:~% ~S"
1019     :format-arguments (list thing)))
1020 toy 1.57 (values name nil))))))
1021 phg 1.13
1022 ram 1.17
1023 phg 1.13 ;;; NAMESTRING -- Interface
1024     ;;;
1025 wlott 1.1 (defun namestring (pathname)
1026 phg 1.12 "Construct the full (name)string form of the pathname."
1027 phg 1.16 (declare (type path-designator pathname)
1028     (values (or null simple-base-string)))
1029 wlott 1.1 (with-pathname (pathname pathname)
1030 wlott 1.23 (when pathname
1031     (let ((host (%pathname-host pathname)))
1032     (unless host
1033     (error "Cannot determine the namestring for pathnames with no ~
1034     host:~% ~S" pathname))
1035     (funcall (host-unparse host) pathname)))))
1036 wlott 1.1
1037 ram 1.17
1038 phg 1.13 ;;; HOST-NAMESTRING -- Interface
1039     ;;;
1040 wlott 1.1 (defun host-namestring (pathname)
1041 phg 1.13 "Returns a string representation of the name of the host in the pathname."
1042 phg 1.16 (declare (type path-designator pathname)
1043     (values (or null simple-base-string)))
1044 wlott 1.1 (with-pathname (pathname pathname)
1045     (let ((host (%pathname-host pathname)))
1046     (if host
1047     (funcall (host-unparse-host host) pathname)
1048     (error
1049     "Cannot determine the namestring for pathnames with no host:~% ~S"
1050     pathname)))))
1051    
1052 phg 1.13 ;;; DIRECTORY-NAMESTRING -- Interface
1053     ;;;
1054 wlott 1.1 (defun directory-namestring (pathname)
1055 phg 1.13 "Returns a string representation of the directories used in the pathname."
1056 phg 1.16 (declare (type path-designator pathname)
1057     (values (or null simple-base-string)))
1058 wlott 1.1 (with-pathname (pathname pathname)
1059     (let ((host (%pathname-host pathname)))
1060     (if host
1061     (funcall (host-unparse-directory host) pathname)
1062     (error
1063     "Cannot determine the namestring for pathnames with no host:~% ~S"
1064     pathname)))))
1065    
1066 phg 1.13 ;;; FILE-NAMESTRING -- Interface
1067     ;;;
1068 wlott 1.1 (defun file-namestring (pathname)
1069 phg 1.13 "Returns a string representation of the name used in the pathname."
1070 phg 1.16 (declare (type path-designator pathname)
1071     (values (or null simple-base-string)))
1072 wlott 1.1 (with-pathname (pathname pathname)
1073     (let ((host (%pathname-host pathname)))
1074     (if host
1075     (funcall (host-unparse-file host) pathname)
1076     (error
1077     "Cannot determine the namestring for pathnames with no host:~% ~S"
1078     pathname)))))
1079    
1080 phg 1.13 ;;; ENOUGH-NAMESTRING -- Interface
1081     ;;;
1082 wlott 1.1 (defun enough-namestring (pathname
1083     &optional (defaults *default-pathname-defaults*))
1084 phg 1.13 "Returns an abbreviated pathname sufficent to identify the pathname relative
1085     to the defaults."
1086 phg 1.16 (declare (type path-designator pathname))
1087 wlott 1.1 (with-pathname (pathname pathname)
1088     (let ((host (%pathname-host pathname)))
1089     (if host
1090     (with-pathname (defaults defaults)
1091     (funcall (host-unparse-enough host) pathname defaults))
1092     (error
1093     "Cannot determine the namestring for pathnames with no host:~% ~S"
1094     pathname)))))
1095    
1096    
1097     ;;;; Wild pathnames.
1098    
1099 phg 1.13 ;;; WILD-PATHNAME-P -- Interface
1100     ;;;
1101 wlott 1.1 (defun wild-pathname-p (pathname &optional field-key)
1102 phg 1.13 "Predicate for determining whether pathname contains any wildcards."
1103 phg 1.16 (declare (type path-designator pathname)
1104 wlott 1.1 (type (member nil :host :device :directory :name :type :version)
1105     field-key))
1106     (with-pathname (pathname pathname)
1107 ram 1.17 (flet ((frob (x)
1108     (or (pattern-p x) (member x '(:wild :wild-inferiors)))))
1109     (ecase field-key
1110     ((nil)
1111     (or (wild-pathname-p pathname :host)
1112     (wild-pathname-p pathname :device)
1113     (wild-pathname-p pathname :directory)
1114     (wild-pathname-p pathname :name)
1115     (wild-pathname-p pathname :type)
1116     (wild-pathname-p pathname :version)))
1117     (:host (frob (%pathname-host pathname)))
1118 dtc 1.38 (:device (frob (%pathname-device pathname)))
1119 ram 1.17 (:directory (some #'frob (%pathname-directory pathname)))
1120     (:name (frob (%pathname-name pathname)))
1121     (:type (frob (%pathname-type pathname)))
1122     (:version (frob (%pathname-version pathname)))))))
1123 wlott 1.1
1124 ram 1.17
1125     ;;; PATHNAME-MATCH-P -- Interface
1126 phg 1.13 ;;;
1127 phg 1.16 (defun pathname-match-p (in-pathname in-wildname)
1128 phg 1.12 "Pathname matches the wildname template?"
1129 phg 1.16 (declare (type path-designator in-pathname))
1130     (with-pathname (pathname in-pathname)
1131     (with-pathname (wildname in-wildname)
1132 ram 1.17 (macrolet ((frob (field &optional (op 'components-match ))
1133 wlott 1.1 `(or (null (,field wildname))
1134 ram 1.17 (,op (,field pathname) (,field wildname)))))
1135 phg 1.16 (and (or (null (%pathname-host wildname))
1136 ram 1.17 (eq (%pathname-host wildname) (%pathname-host pathname)))
1137 wlott 1.1 (frob %pathname-device)
1138 ram 1.17 (frob %pathname-directory directory-components-match)
1139 wlott 1.1 (frob %pathname-name)
1140     (frob %pathname-type)
1141 ram 1.17 (frob %pathname-version))))))
1142 wlott 1.1
1143 ram 1.17
1144 phg 1.13 ;;; SUBSTITUTE-INTO -- Internal
1145     ;;;
1146 ram 1.17 ;;; Place the substitutions into the pattern and return the string or pattern
1147     ;;; that results. If DIDDLE-CASE is true, we diddle the result case as well,
1148     ;;; in case we are translating between hosts with difference conventional case.
1149     ;;; The second value is the tail of subs with all of the values that we used up
1150     ;;; stripped off. Note that PATTERN-MATCHES matches all consecutive wildcards
1151     ;;; as a single string, so we ignore subsequent contiguous wildcards.
1152 phg 1.16 ;;;
1153 ram 1.17 (defun substitute-into (pattern subs diddle-case)
1154 wlott 1.1 (declare (type pattern pattern)
1155 phg 1.16 (type list subs)
1156 dtc 1.40 (values (or simple-base-string pattern) list))
1157 wlott 1.1 (let ((in-wildcard nil)
1158     (pieces nil)
1159     (strings nil))
1160     (dolist (piece (pattern-pieces pattern))
1161     (cond ((simple-string-p piece)
1162 ram 1.17 (push piece strings)
1163 wlott 1.1 (setf in-wildcard nil))
1164     (in-wildcard)
1165     (t
1166 ram 1.17 (setf in-wildcard t)
1167     (unless subs
1168     (error "Not enough wildcards in FROM pattern to match ~
1169     TO pattern:~% ~S"
1170     pattern))
1171 wlott 1.1 (let ((sub (pop subs)))
1172 ram 1.17 (typecase sub
1173 wlott 1.1 (pattern
1174     (when strings
1175     (push (apply #'concatenate 'simple-string
1176     (nreverse strings))
1177     pieces))
1178     (dolist (piece (pattern-pieces sub))
1179 ram 1.17 (push piece pieces)))
1180 wlott 1.1 (simple-string
1181 ram 1.17 (push sub strings))
1182     (t
1183     (error "Can't substitute this into the middle of a word:~
1184     ~% ~S"
1185     sub)))))))
1186    
1187 wlott 1.1 (when strings
1188 phg 1.16 (push (apply #'concatenate 'simple-string (nreverse strings))
1189 wlott 1.1 pieces))
1190 ram 1.17 (values
1191     (maybe-diddle-case
1192     (if (and pieces (simple-string-p (car pieces)) (null (cdr pieces)))
1193     (car pieces)
1194     (make-pattern (nreverse pieces)))
1195     diddle-case)
1196     subs)))
1197 wlott 1.1
1198 ram 1.17
1199     ;;; DIDNT-MATCH-ERROR -- Internal
1200     ;;;
1201     ;;; Called when we can't see how source and from matched.
1202     ;;;
1203     (defun didnt-match-error (source from)
1204     (error "Pathname components from Source and From args to TRANSLATE-PATHNAME~@
1205     did not match:~% ~S ~S"
1206     source from))
1207    
1208    
1209 phg 1.13 ;;; TRANSLATE-COMPONENT -- Internal
1210     ;;;
1211 ram 1.17 ;;; Do TRANSLATE-COMPONENT for all components except host and directory.
1212 phg 1.13 ;;;
1213 ram 1.17 (defun translate-component (source from to diddle-case)
1214 wlott 1.1 (typecase to
1215     (pattern
1216 ram 1.17 (typecase from
1217     (pattern
1218     (typecase source
1219     (pattern
1220     (if (pattern= from source)
1221     source
1222     (didnt-match-error source from)))
1223     (simple-string
1224     (multiple-value-bind
1225     (won subs)
1226     (pattern-matches from source)
1227     (if won
1228     (values (substitute-into to subs diddle-case))
1229     (didnt-match-error source from))))
1230     (t
1231     (maybe-diddle-case source diddle-case))))
1232     ((member :wild)
1233     (values (substitute-into to (list source) diddle-case)))
1234     (t
1235     (if (components-match source from)
1236     (maybe-diddle-case source diddle-case)
1237     (didnt-match-error source from)))))
1238 wlott 1.1 ((member nil :wild)
1239 ram 1.17 (maybe-diddle-case source diddle-case))
1240 wlott 1.1 (t
1241     (if (components-match source from)
1242     to
1243 ram 1.17 (didnt-match-error source from)))))
1244 wlott 1.1
1245 ram 1.17
1246     ;;; COMPUTE-DIRECTORY-SUBSTITUTIONS -- Internal
1247     ;;;
1248     ;;; Return a list of all the things that we want to substitute into the TO
1249     ;;; pattern (the things matched by from on source.) When From contains
1250     ;;; :WILD-INFERIORS, the result contains a sublist of the matched source
1251     ;;; subdirectories.
1252     ;;;
1253     (defun compute-directory-substitutions (orig-source orig-from)
1254     (let ((source orig-source)
1255     (from orig-from))
1256     (collect ((subs))
1257     (loop
1258     (unless source
1259     (unless (every #'(lambda (x) (eq x :wild-inferiors)) from)
1260     (didnt-match-error orig-source orig-from))
1261     (subs ())
1262     (return))
1263     (unless from (didnt-match-error orig-source orig-from))
1264     (let ((from-part (pop from))
1265     (source-part (pop source)))
1266     (typecase from-part
1267     (pattern
1268     (typecase source-part
1269     (pattern
1270     (if (pattern= from-part source-part)
1271     (subs source-part)
1272     (didnt-match-error orig-source orig-from)))
1273     (simple-string
1274     (multiple-value-bind
1275     (won new-subs)
1276     (pattern-matches from-part source-part)
1277     (if won
1278     (dolist (sub new-subs)
1279     (subs sub))
1280     (didnt-match-error orig-source orig-from))))
1281     (t
1282     (didnt-match-error orig-source orig-from))))
1283     ((member :wild)
1284     (subs source-part))
1285     ((member :wild-inferiors)
1286     (let ((remaining-source (cons source-part source)))
1287     (collect ((res))
1288     (loop
1289     (when (directory-components-match remaining-source from)
1290     (return))
1291     (unless remaining-source
1292     (didnt-match-error orig-source orig-from))
1293     (res (pop remaining-source)))
1294     (subs (res))
1295     (setq source remaining-source))))
1296     (simple-string
1297     (unless (and (simple-string-p source-part)
1298     (string= from-part source-part))
1299     (didnt-match-error orig-source orig-from)))
1300     (t
1301     (didnt-match-error orig-source orig-from)))))
1302     (subs))))
1303    
1304    
1305 phg 1.13 ;;; TRANSLATE-DIRECTORIES -- Internal
1306     ;;;
1307 ram 1.17 ;;; Called by TRANSLATE-PATHNAME on the directory components of its argument
1308     ;;; pathanames to produce the result directory component. If any leaves the
1309     ;;; directory NIL, we return the source directory. The :RELATIVE or :ABSOLUTE
1310 dtc 1.36 ;;; is taken from the source directory, except if TO is :ABSOLUTE, in which
1311     ;;; case the result will be :ABSOLUTE.
1312 ram 1.17 ;;;
1313     (defun translate-directories (source from to diddle-case)
1314     (if (not (and source to from))
1315 dtc 1.37 (let ((source (mapcar #'(lambda (x) (maybe-diddle-case x diddle-case))
1316     source)))
1317     (if (null to)
1318     source
1319     (collect ((res))
1320     (res (cond ((null source) (first to))
1321     ((eq (first to) :absolute) :absolute)
1322     (t (first source))))
1323     (let ((match (rest source)))
1324     (dolist (to-part (rest to))
1325     (cond ((eq to-part :wild)
1326     (when match
1327     (res (first match))
1328     (setf match nil)))
1329     ((eq to-part :wild-inferiors)
1330     (when match
1331     (dolist (src-part match)
1332     (res src-part))
1333     (setf match nil)))
1334     (t
1335     (res to-part)))))
1336     (res))))
1337 ram 1.17 (collect ((res))
1338 dtc 1.35 (res (if (eq (first to) :absolute)
1339     :absolute
1340     (first source)))
1341 ram 1.17 (let ((subs-left (compute-directory-substitutions (rest source)
1342     (rest from))))
1343     (dolist (to-part (rest to))
1344     (typecase to-part
1345     ((member :wild)
1346     (assert subs-left)
1347     (let ((match (pop subs-left)))
1348     (when (listp match)
1349     (error ":WILD-INFERIORS not paired in from and to ~
1350     patterns:~% ~S ~S" from to))
1351 dtc 1.33 (res (maybe-diddle-case match diddle-case))))
1352 ram 1.17 ((member :wild-inferiors)
1353     (assert subs-left)
1354     (let ((match (pop subs-left)))
1355     (unless (listp match)
1356     (error ":WILD-INFERIORS not paired in from and to ~
1357     patterns:~% ~S ~S" from to))
1358     (dolist (x match)
1359     (res (maybe-diddle-case x diddle-case)))))
1360     (pattern
1361     (multiple-value-bind
1362     (new new-subs-left)
1363     (substitute-into to-part subs-left diddle-case)
1364     (setf subs-left new-subs-left)
1365 dtc 1.33 (res new)))
1366 ram 1.17 (t (res to-part)))))
1367     (res))))
1368 wlott 1.1
1369 ram 1.17
1370 phg 1.13 ;;; TRANSLATE-PATHNAME -- Interface
1371     ;;;
1372 wlott 1.1 (defun translate-pathname (source from-wildname to-wildname &key)
1373 phg 1.13 "Use the source pathname to translate the from-wildname's wild and
1374     unspecified elements into a completed to-pathname based on the to-wildname."
1375 phg 1.16 (declare (type path-designator source from-wildname to-wildname))
1376 wlott 1.1 (with-pathname (source source)
1377     (with-pathname (from from-wildname)
1378     (with-pathname (to to-wildname)
1379 ram 1.17 (let* ((source-host (%pathname-host source))
1380     (to-host (%pathname-host to))
1381     (diddle-case
1382     (and source-host to-host
1383     (not (eq (host-customary-case source-host)
1384     (host-customary-case to-host))))))
1385     (macrolet ((frob (field &optional (op 'translate-component))
1386     `(let ((result (,op (,field source)
1387     (,field from)
1388     (,field to)
1389     diddle-case)))
1390 wlott 1.1 (if (eq result :error)
1391     (error "~S doesn't match ~S" source from)
1392 ram 1.17 result))))
1393 pw 1.28 (%make-pathname-object
1394     (or to-host source-host)
1395     (frob %pathname-device)
1396     (frob %pathname-directory translate-directories)
1397     (frob %pathname-name)
1398     (frob %pathname-type)
1399     (frob %pathname-version))))))))
1400 wlott 1.1
1401    
1402     ;;;; Search lists.
1403    
1404     ;;; The SEARCH-LIST structure.
1405     ;;;
1406     (defstruct (search-list
1407     (:print-function %print-search-list)
1408     (:make-load-form-fun
1409     (lambda (search-list)
1410     (values `(intern-search-list ',(search-list-name search-list))
1411     nil))))
1412     ;;
1413     ;; The name of this search-list. Always stored in lowercase.
1414     (name (required-argument) :type simple-string)
1415     ;;
1416     ;; T if this search-list has been defined. Otherwise NIL.
1417     (defined nil :type (member t nil))
1418     ;;
1419     ;; The list of expansions for this search-list. Each expansion is the list
1420     ;; of directory components to use in place of this search-list.
1421 ram 1.21 (expansions nil :type list))
1422 ram 1.4
1423 wlott 1.1 (defun %print-search-list (sl stream depth)
1424     (declare (ignore depth))
1425     (print-unreadable-object (sl stream :type t)
1426     (write-string (search-list-name sl) stream)))
1427    
1428     ;;; *SEARCH-LISTS* -- internal.
1429     ;;;
1430     ;;; Hash table mapping search-list names to search-list structures.
1431     ;;;
1432     (defvar *search-lists* (make-hash-table :test #'equal))
1433    
1434 pw 1.43 ;;; FIND-SEARCH-LIST -- internal
1435     ;;;
1436     (defun find-search-list (name &optional (flame-not-found-p t))
1437     (let ((search-list (gethash (string-downcase name) *search-lists*)))
1438     (if search-list search-list
1439     (when flame-not-found-p
1440     (error "Search-list ~a not defined." name)))))
1441    
1442 wlott 1.1 ;;; INTERN-SEARCH-LIST -- internal interface.
1443     ;;;
1444     ;;; When search-lists are encountered in namestrings, they are converted to
1445     ;;; search-list structures right then, instead of waiting until the search
1446     ;;; list used. This allows us to verify ahead of time that there are no
1447     ;;; circularities and makes expansion much quicker.
1448     ;;;
1449     (defun intern-search-list (name)
1450     (let ((name (string-downcase name)))
1451     (or (gethash name *search-lists*)
1452     (let ((new (make-search-list :name name)))
1453     (setf (gethash name *search-lists*) new)
1454     new))))
1455    
1456     ;;; CLEAR-SEARCH-LIST -- public.
1457     ;;;
1458     ;;; Clear the definition. Note: we can't remove it from the hash-table
1459     ;;; because there may be pathnames still refering to it. So we just clear
1460 pw 1.43 ;;; out the expansions and set defined to NIL.
1461 wlott 1.1 ;;;
1462     (defun clear-search-list (name)
1463     "Clear the current definition for the search-list NAME. Returns T if such
1464     a definition existed, and NIL if not."
1465     (let* ((name (string-downcase name))
1466     (search-list (gethash name *search-lists*)))
1467     (when (and search-list (search-list-defined search-list))
1468     (setf (search-list-defined search-list) nil)
1469     (setf (search-list-expansions search-list) nil)
1470     t)))
1471    
1472     ;;; CLEAR-ALL-SEARCH-LISTS -- sorta public.
1473     ;;;
1474     ;;; Again, we can't actually remove the entries from the hash-table, so we
1475     ;;; just mark them as being undefined.
1476     ;;;
1477     (defun clear-all-search-lists ()
1478     "Clear the definition for all search-lists. Only use this if you know
1479     what you are doing."
1480     (maphash #'(lambda (name search-list)
1481     (declare (ignore name))
1482     (setf (search-list-defined search-list) nil)
1483     (setf (search-list-expansions search-list) nil))
1484     *search-lists*)
1485     nil)
1486    
1487     ;;; EXTRACT-SEARCH-LIST -- internal.
1488     ;;;
1489     ;;; Extract the search-list from PATHNAME and return it. If PATHNAME
1490     ;;; doesn't start with a search-list, then either error (if FLAME-IF-NONE
1491     ;;; is true) or return NIL (if FLAME-IF-NONE is false).
1492     ;;;
1493     (defun extract-search-list (pathname flame-if-none)
1494     (with-pathname (pathname pathname)
1495     (let* ((directory (%pathname-directory pathname))
1496     (search-list (cadr directory)))
1497     (cond ((search-list-p search-list)
1498     search-list)
1499     (flame-if-none
1500 wlott 1.8 (error "~S doesn't start with a search-list." pathname))
1501 wlott 1.1 (t
1502     nil)))))
1503    
1504     ;;; SEARCH-LIST -- public.
1505     ;;;
1506     ;;; We have to convert the internal form of the search-list back into a
1507     ;;; bunch of pathnames.
1508     ;;;
1509     (defun search-list (pathname)
1510     "Return the expansions for the search-list starting PATHNAME. If PATHNAME
1511     does not start with a search-list, then an error is signaled. If
1512     the search-list has not been defined yet, then an error is signaled.
1513 phg 1.16 The expansion for a search-list can be set with SETF."
1514 wlott 1.1 (with-pathname (pathname pathname)
1515     (let ((search-list (extract-search-list pathname t))
1516 pmai 1.60 (host (%pathname-host pathname)))
1517 wlott 1.1 (if (search-list-defined search-list)
1518     (mapcar #'(lambda (directory)
1519     (make-pathname :host host
1520     :directory (cons :absolute directory)))
1521     (search-list-expansions search-list))
1522     (error "Search list ~S has not been defined yet." pathname)))))
1523 wlott 1.9
1524     ;;; SEARCH-LIST-DEFINED-P -- public.
1525     ;;;
1526     (defun search-list-defined-p (pathname)
1527     "Returns T if the search-list starting PATHNAME is currently defined, and
1528     NIL otherwise. An error is signaled if PATHNAME does not start with a
1529     search-list."
1530     (with-pathname (pathname pathname)
1531     (search-list-defined (extract-search-list pathname t))))
1532 wlott 1.1
1533     ;;; %SET-SEARCH-LIST -- public setf method
1534     ;;;
1535     ;;; Set the expansion for the search-list in PATHNAME. If this would result
1536     ;;; in any circularities, we flame out. If anything goes wrong, we leave the
1537     ;;; old defintion intact.
1538     ;;;
1539     (defun %set-search-list (pathname values)
1540     (let ((search-list (extract-search-list pathname t)))
1541     (labels
1542     ((check (target-list path)
1543     (when (eq search-list target-list)
1544     (error "That would result in a circularity:~% ~
1545     ~A~{ -> ~A~} -> ~A"
1546     (search-list-name search-list)
1547     (reverse path)
1548     (search-list-name target-list)))
1549     (when (search-list-p target-list)
1550     (push (search-list-name target-list) path)
1551     (dolist (expansion (search-list-expansions target-list))
1552     (check (car expansion) path))))
1553     (convert (pathname)
1554     (with-pathname (pathname pathname)
1555     (when (or (pathname-name pathname)
1556     (pathname-type pathname)
1557     (pathname-version pathname))
1558     (error "Search-lists cannot expand into pathnames that have ~
1559     a name, type, or ~%version specified:~% ~S"
1560     pathname))
1561     (let ((directory (pathname-directory pathname)))
1562 wlott 1.7 (let ((expansion
1563     (if directory
1564     (ecase (car directory)
1565     (:absolute (cdr directory))
1566     (:relative (cons (intern-search-list "default")
1567     (cdr directory))))
1568     (list (intern-search-list "default")))))
1569 wlott 1.1 (check (car expansion) nil)
1570     expansion)))))
1571     (setf (search-list-expansions search-list)
1572     (if (listp values)
1573     (mapcar #'convert values)
1574     (list (convert values)))))
1575     (setf (search-list-defined search-list) t))
1576     values)
1577    
1578     ;;; ENUMERATE-SEARCH-LIST -- public.
1579     ;;;
1580     (defmacro enumerate-search-list ((var pathname &optional result) &body body)
1581     "Execute BODY with VAR bound to each successive possible expansion for
1582     PATHNAME and then return RESULT. Note: if PATHNAME does not contain a
1583     search-list, then BODY is executed exactly once. Everything is wrapped
1584     in a block named NIL, so RETURN can be used to terminate early. Note:
1585     VAR is *not* bound inside of RESULT."
1586     (let ((body-name (gensym)))
1587     `(block nil
1588     (flet ((,body-name (,var)
1589     ,@body))
1590     (%enumerate-search-list ,pathname #',body-name)
1591     ,result))))
1592    
1593     (defun %enumerate-search-list (pathname function)
1594 ram 1.22 (let* ((pathname (if (logical-pathname-p pathname)
1595     (translate-logical-pathname pathname)
1596     pathname))
1597 ram 1.21 (search-list (extract-search-list pathname nil)))
1598 wlott 1.1 (cond
1599     ((not search-list)
1600     (funcall function pathname))
1601     ((not (search-list-defined search-list))
1602     (error "Undefined search list: ~A"
1603     (search-list-name search-list)))
1604     (t
1605     (let ((tail (cddr (pathname-directory pathname))))
1606     (dolist (expansion
1607     (search-list-expansions search-list))
1608     (%enumerate-search-list (make-pathname :defaults pathname
1609     :directory
1610     (cons :absolute
1611     (append expansion
1612     tail)))
1613     function)))))))
1614 phg 1.12
1615    
1616     ;;;; Logical pathname support. ANSI 92-102 specification.
1617 phg 1.16 ;;;; As logical-pathname translations are loaded they are canonicalized as
1618     ;;;; patterns to enable rapid efficent translation into physical pathnames.
1619 phg 1.12
1620 ram 1.17 ;;;; Utilities:
1621 phg 1.12
1622 ram 1.17 ;;; LOGICAL-WORD-OR-LOSE -- Internal
1623 phg 1.13 ;;;
1624 ram 1.17 ;;; Canonicalize a logical pathanme word by uppercasing it checking that it
1625     ;;; contains only legal characters.
1626 phg 1.16 ;;;
1627 ram 1.17 (defun logical-word-or-lose (word)
1628     (declare (string word))
1629     (let ((word (string-upcase word)))
1630     (dotimes (i (length word))
1631     (let ((ch (schar word i)))
1632     (unless (or (alpha-char-p ch) (digit-char-p ch) (char= ch #\-))
1633     (error 'namestring-parse-error
1634     :complaint "Logical namestring character ~
1635     is not alphanumeric or hyphen:~% ~S"
1636     :arguments (list ch)
1637     :namestring word :offset i))))
1638     word))
1639 phg 1.12
1640 ram 1.17
1641     ;;; FIND-LOGICAL-HOST -- Internal
1642     ;;;
1643     ;;; Given a logical host or string, return a logical host. If Error-p is
1644     ;;; NIL, then return NIL when no such host exists.
1645     ;;;
1646     (defun find-logical-host (thing &optional (errorp t))
1647     (etypecase thing
1648     (string
1649 pw 1.50 (let* ((valid-hostname
1650     (catch 'error-bailout
1651     (handler-bind
1652     ((namestring-parse-error
1653     (lambda(c)(declare (ignore c))
1654     (unless errorp
1655     (throw 'error-bailout nil)))))
1656     (logical-word-or-lose thing))))
1657     (found
1658     (and valid-hostname
1659     (or (gethash valid-hostname *logical-hosts*)
1660 pw 1.46 (and *autoload-translations*
1661 pw 1.50 (ignore-errors
1662 pw 1.51 (load-logical-pathname-translations
1663     valid-hostname))
1664 pw 1.50 (gethash valid-hostname *logical-hosts*))))))
1665 ram 1.17 (if (or found (not errorp))
1666     found
1667 dtc 1.34 (error 'simple-file-error
1668     :pathname thing
1669     :format-control "Logical host not yet defined: ~S"
1670     :format-arguments (list thing)))))
1671 ram 1.17 (logical-host thing)))
1672 pw 1.43
1673 phg 1.16 ;;; INTERN-LOGICAL-HOST -- Internal
1674 phg 1.13 ;;;
1675 ram 1.17 ;;; Given a logical host name or host, return a logical host, creating a new
1676     ;;; one if necessary.
1677 phg 1.16 ;;;
1678 ram 1.17 (defun intern-logical-host (thing)
1679     (declare (values logical-host))
1680     (or (find-logical-host thing nil)
1681     (let* ((name (logical-word-or-lose thing))
1682     (new (make-logical-host :name name)))
1683 phg 1.16 (setf (gethash name *logical-hosts*) new)
1684     new)))
1685 phg 1.12
1686 ram 1.17
1687     ;;;; Logical pathname parsing:
1688    
1689     ;;; MAYBE-MAKE-LOGICAL-PATTERN -- Internal
1690 phg 1.13 ;;;
1691 ram 1.17 ;;; Deal with multi-char wildcards in a logical pathname token.
1692 phg 1.16 ;;;
1693 ram 1.17 (defun maybe-make-logical-pattern (namestring chunks)
1694     (let ((chunk (caar chunks)))
1695     (collect ((pattern))
1696     (let ((last-pos 0)
1697     (len (length chunk)))
1698     (declare (fixnum last-pos))
1699     (loop
1700     (when (= last-pos len) (return))
1701     (let ((pos (or (position #\* chunk :start last-pos) len)))
1702     (if (= pos last-pos)
1703     (when (pattern)
1704     (error 'namestring-parse-error
1705     :complaint "Double asterisk inside of logical ~
1706     word: ~S"
1707     :arguments (list chunk)
1708     :namestring namestring
1709     :offset (+ (cdar chunks) pos)))
1710     (pattern (subseq chunk last-pos pos)))
1711     (if (= pos len)
1712     (return)
1713     (pattern :multi-char-wild))
1714     (setq last-pos (1+ pos)))))
1715     (assert (pattern))
1716     (if (cdr (pattern))
1717     (make-pattern (pattern))
1718     (let ((x (car (pattern))))
1719     (if (eq x :multi-char-wild)
1720     :wild
1721     x))))))
1722 phg 1.12
1723 ram 1.17
1724     ;;; LOGICAL-CHUNKIFY -- Internal
1725 phg 1.13 ;;;
1726 ram 1.17 ;;; Return a list of conses where the cdr is the start position and the car
1727     ;;; is a string (token) or character (punctuation.)
1728 phg 1.13 ;;;
1729 ram 1.17 (defun logical-chunkify (namestr start end)
1730     (collect ((chunks))
1731     (do ((i start (1+ i))
1732 toy 1.62 (prev start))
1733 ram 1.17 ((= i end)
1734     (when (> end prev)
1735     (chunks (cons (nstring-upcase (subseq namestr prev end)) prev))))
1736     (let ((ch (schar namestr i)))
1737     (unless (or (alpha-char-p ch) (digit-char-p ch)
1738     (member ch '(#\- #\*)))
1739     (when (> i prev)
1740     (chunks (cons (nstring-upcase (subseq namestr prev i)) prev)))
1741     (setq prev (1+ i))
1742     (unless (member ch '(#\; #\: #\.))
1743     (error 'namestring-parse-error
1744     :complaint "Illegal character for logical pathname:~% ~S"
1745     :arguments (list ch)
1746     :namestring namestr
1747     :offset i))
1748     (chunks (cons ch i)))))
1749     (chunks)))
1750 phg 1.12
1751    
1752 phg 1.13 ;;; PARSE-LOGICAL-NAMESTRING -- Internal
1753     ;;;
1754 phg 1.16 ;;; Break up a logical-namestring, always a string, into its constituent
1755     ;;; parts.
1756 phg 1.13 ;;;
1757 ram 1.17 (defun parse-logical-namestring (namestr start end)
1758 phg 1.12 (declare (type simple-base-string namestr)
1759 ram 1.17 (type index start end))
1760     (collect ((directory))
1761     (let ((host nil)
1762     (name nil)
1763     (type nil)
1764     (version nil))
1765     (labels ((expecting (what chunks)
1766     (unless (and chunks (simple-string-p (caar chunks)))
1767     (error 'namestring-parse-error
1768 pmai 1.54 :complaint "Expecting ~A, got ~:[nothing~;~:*~S~]."
1769 ram 1.17 :arguments (list what (caar chunks))
1770     :namestring namestr
1771     :offset (if chunks (cdar chunks) end)))
1772     (caar chunks))
1773     (parse-host (chunks)
1774     (case (caadr chunks)
1775     (#\:
1776     (setq host
1777     (find-logical-host (expecting "a host name" chunks)))
1778     (parse-relative (cddr chunks)))
1779     (t
1780     (parse-relative chunks))))
1781     (parse-relative (chunks)
1782     (case (caar chunks)
1783     (#\;
1784     (directory :relative)
1785     (parse-directory (cdr chunks)))
1786     (t
1787 pw 1.30 (directory :absolute) ; Assumption! Maybe revoked later.
1788 ram 1.17 (parse-directory chunks))))
1789     (parse-directory (chunks)
1790     (case (caadr chunks)
1791     (#\;
1792     (directory
1793     (let ((res (expecting "a directory name" chunks)))
1794     (cond ((string= res "..") :up)
1795     ((string= res "**") :wild-inferiors)
1796     (t
1797     (maybe-make-logical-pattern namestr chunks)))))
1798     (parse-directory (cddr chunks)))
1799     (t
1800     (parse-name chunks))))
1801     (parse-name (chunks)
1802     (when chunks
1803     (expecting "a file name" chunks)
1804     (setq name (maybe-make-logical-pattern namestr chunks))
1805     (expecting-dot (cdr chunks))))
1806     (expecting-dot (chunks)
1807     (when chunks
1808     (unless (eql (caar chunks) #\.)
1809     (error 'namestring-parse-error
1810     :complaint "Expecting a dot, got ~S."
1811     :arguments (list (caar chunks))
1812     :namestring namestr
1813     :offset (cdar chunks)))
1814     (if type
1815     (parse-version (cdr chunks))
1816     (parse-type (cdr chunks)))))
1817     (parse-type (chunks)
1818     (expecting "a file type" chunks)
1819     (setq type (maybe-make-logical-pattern namestr chunks))
1820     (expecting-dot (cdr chunks)))
1821     (parse-version (chunks)
1822     (let ((str (expecting "a positive integer, * or NEWEST"
1823     chunks)))
1824     (cond
1825     ((string= str "*") (setq version :wild))
1826     ((string= str "NEWEST") (setq version :newest))
1827     (t
1828     (multiple-value-bind
1829     (res pos)
1830     (parse-integer str :junk-allowed t)
1831     (unless (and res (plusp res))
1832     (error 'namestring-parse-error
1833     :complaint "Expected a positive integer, ~
1834     got ~S"
1835     :arguments (list str)
1836     :namestring namestr
1837     :offset (+ pos (cdar chunks))))
1838     (setq version res)))))
1839     (when (cdr chunks)
1840     (error 'namestring-parse-error
1841     :complaint "Extra stuff after end of file name."
1842     :namestring namestr
1843     :offset (cdadr chunks)))))
1844     (parse-host (logical-chunkify namestr start end)))
1845 pw 1.30 (values host :unspecific
1846 toy 1.59 (directory)
1847 pw 1.30 name type version))))
1848 phg 1.12
1849 ram 1.17
1850     ;;; Can't defvar here because not all host methods are loaded yet.
1851     (declaim (special *logical-pathname-defaults*))
1852    
1853     ;;; LOGICAL-PATHNAME -- Public
1854 phg 1.13 ;;;
1855 ram 1.17 (defun logical-pathname (pathspec)
1856     "Converts the pathspec argument to a logical-pathname and returns it."
1857     (declare (type (or logical-pathname string stream) pathspec)
1858     (values logical-pathname))
1859     (if (typep pathspec 'logical-pathname)
1860     pathspec
1861     (let ((res (parse-namestring pathspec nil *logical-pathname-defaults*)))
1862     (when (eq (%pathname-host res)
1863     (%pathname-host *logical-pathname-defaults*))
1864 pw 1.43 (error
1865     'simple-type-error
1866     :format-control "Logical namestring does not specify a host:~% ~S"
1867     :format-arguments (list pathspec)
1868     :datum pathspec
1869     :expected-type '(satisfies logical-pathname-namestring-p)))
1870 rtoy 1.71 ;; Make sure the result is a logical pathname. This can
1871     ;; happen if the pathspec is stream, and the stream was opened
1872     ;; with a pathname instead of a logical-pathname.
1873     (check-type res logical-pathname)
1874 ram 1.17 res)))
1875 phg 1.12
1876 pw 1.43
1877 ram 1.17
1878     ;;;; Logical pathname unparsing:
1879    
1880 phg 1.13 ;;; UNPARSE-LOGICAL-DIRECTORY -- Internal
1881     ;;;
1882 phg 1.12 (defun unparse-logical-directory (pathname)
1883 ram 1.17 (declare (type pathname pathname))
1884     (collect ((pieces))
1885     (let ((directory (%pathname-directory pathname)))
1886     (when directory
1887     (ecase (pop directory)
1888     (:absolute) ;; Nothing special.
1889     (:relative (pieces ";")))
1890     (dolist (dir directory)
1891     (cond ((or (stringp dir) (pattern-p dir))
1892     (pieces (unparse-logical-piece dir))
1893     (pieces ";"))
1894     ((eq dir :wild)
1895     (pieces "*;"))
1896     ((eq dir :wild-inferiors)
1897     (pieces "**;"))
1898     (t
1899     (error "Invalid directory component: ~S" dir))))))
1900     (apply #'concatenate 'simple-string (pieces))))
1901 phg 1.12
1902 ram 1.17
1903 phg 1.13 ;;; UNPARSE-LOGICAL-PIECE -- Internal
1904     ;;;
1905 phg 1.12 (defun unparse-logical-piece (thing)
1906     (etypecase thing
1907 ram 1.17 (simple-string thing)
1908 phg 1.12 (pattern
1909     (collect ((strings))
1910 ram 1.17 (dolist (piece (pattern-pieces thing))
1911     (etypecase piece
1912     (simple-string (strings piece))
1913     (keyword
1914     (cond ((eq piece :wild-inferiors)
1915     (strings "**"))
1916     ((eq piece :multi-char-wild)
1917     (strings "*"))
1918     (t (error "Invalid keyword: ~S" piece))))))
1919     (apply #'concatenate 'simple-string (strings))))))
1920 phg 1.12
1921 dtc 1.36 ;;; UNPARSE-ENOUGH-NAMESTRING -- Internal
1922     ;;;
1923     (defun unparse-enough-namestring (pathname defaults)
1924     (let* ((path-dir (pathname-directory pathname))
1925     (def-dir (pathname-directory defaults))
1926     (enough-dir
1927     ;; Go down the directory lists to see what matches. What's
1928     ;; left is what we want, more or less.
1929     (cond ((and (eq (first path-dir) (first def-dir))
1930     (eq (first path-dir) :absolute))
1931     ;; Both paths are :absolute, so find where the common
1932     ;; parts end and return what's left
1933     (do* ((p (rest path-dir) (rest p))
1934     (d (rest def-dir) (rest d)))
1935     ((or (endp p) (endp d)
1936     (not (equal (first p) (first d))))
1937     `(:relative ,@p))))
1938     (t
1939     ;; At least one path is :relative, so just return the
1940     ;; original path. If the original path is :relative,
1941     ;; then that's the right one. If PATH-DIR is
1942     ;; :absolute, we want to return that except when
1943     ;; DEF-DIR is :absolute, as handled above. so return
1944     ;; the original directory.
1945     path-dir))))
1946 pmai 1.60 (make-pathname :host (%pathname-host pathname)
1947 dtc 1.36 :directory enough-dir
1948     :name (pathname-name pathname)
1949     :type (pathname-type pathname)
1950     :version (pathname-version pathname))))
1951 phg 1.12
1952 phg 1.13 ;;; UNPARSE-LOGICAL-NAMESTRING -- Internal
1953     ;;;
1954 phg 1.12 (defun unparse-logical-namestring (pathname)
1955     (declare (type logical-pathname pathname))
1956     (concatenate 'simple-string
1957 ram 1.17 (logical-host-name (%pathname-host pathname)) ":"
1958 phg 1.12 (unparse-logical-directory pathname)
1959 ram 1.17 (unparse-unix-file pathname)))
1960 phg 1.12
1961 ram 1.17
1962     ;;;; Logical pathname translations:
1963 phg 1.12
1964 ram 1.17 ;;; CANONICALIZE-LOGICAL-PATHNAME-TRANSLATIONS -- Internal
1965 phg 1.13 ;;;
1966     ;;; Verify that the list of translations consists of lists and prepare
1967 phg 1.16 ;;; canonical translations (parse pathnames and expand out wildcards into
1968     ;;; patterns).
1969 phg 1.13 ;;;
1970 ram 1.17 (defun canonicalize-logical-pathname-translations (transl-list host)
1971     (declare (type list transl-list) (type host host)
1972     (values list))
1973     (collect ((res))
1974     (dolist (tr transl-list)
1975     (unless (and (consp tr) (= (length tr) 2))
1976     (error "Logical pathname translation is not a two-list:~% ~S"
1977     tr))
1978     (let ((from (first tr)))
1979     (res (list (if (typep from 'logical-pathname)
1980     from
1981     (parse-namestring from host))
1982     (pathname (second tr))))))
1983     (res)))
1984 phg 1.12
1985 ram 1.17
1986 phg 1.13 ;;; LOGICAL-PATHNAME-TRANSLATIONS -- Public
1987     ;;;
1988 phg 1.12 (defun logical-pathname-translations (host)
1989     "Return the (logical) host object argument's list of translations."
1990 ram 1.17 (declare (type (or string logical-host) host)
1991 phg 1.12 (values list))
1992 ram 1.17 (logical-host-translations (find-logical-host host)))
1993 phg 1.12
1994 phg 1.13 ;;; (SETF LOGICAL-PATHNAME-TRANSLATIONS) -- Public
1995     ;;;
1996 phg 1.12 (defun (setf logical-pathname-translations) (translations host)
1997     "Set the translations list for the logical host argument.
1998     Return translations."
1999 ram 1.17 (declare (type (or string logical-host) host)
2000 phg 1.12 (type list translations)
2001     (values list))
2002    
2003 toy 1.63 (let ((maybe-search-list-host (concatenate 'string host ":")))
2004 rtoy 1.64 (when (and (not (logical-pathname-p (pathname maybe-search-list-host)))
2005     (search-list-defined-p maybe-search-list-host))
2006 toy 1.63 (cerror "Clobber search-list host with logical pathname host"
2007     "~S names a CMUCL search-list"
2008     host)))
2009 ram 1.17 (let ((host (intern-logical-host host)))
2010     (setf (logical-host-canon-transls host)
2011     (canonicalize-logical-pathname-translations translations host))
2012     (setf (logical-host-translations host) translations)))
2013    
2014    
2015 phg 1.12 ;;; The search mechanism for loading pathname translations uses the CMUCL
2016     ;;; extension of search-lists. The user can add to the library: search-list
2017     ;;; using setf. The file for translations should have the name defined by
2018 phg 1.14 ;;; the hostname (a string) and with type component "translations".
2019 phg 1.12
2020 phg 1.13 ;;; LOAD-LOGICAL-PATHNAME-TRANSLATIONS -- Public
2021     ;;;
2022 pw 1.43 (defun load-logical-pathname-translations (host)
2023     "Search for a logical pathname named host, if not already defined. If already
2024     defined no attempt to find or load a definition is attempted and NIL is
2025     returned. If host is not already defined, but definition is found and loaded
2026     successfully, T is returned, else error."
2027     (declare (type string host)
2028     (values (member t nil)))
2029 pw 1.44 (let ((*autoload-translations* nil))
2030     (unless (or (string-equal host "library")
2031     (find-logical-host host nil))
2032     (with-open-file (in-str (make-pathname :defaults "library:"
2033     :name (string-downcase host)
2034     :type "translations"))
2035     (if *load-verbose*
2036     (format *error-output*
2037     ";; Loading pathname translations from ~A~%"
2038     (namestring (truename in-str))))
2039     (setf (logical-pathname-translations host) (read in-str)))
2040     t)))
2041 phg 1.12
2042 phg 1.13 ;;; TRANSLATE-LOGICAL-PATHNAME -- Public
2043     ;;;
2044 phg 1.12 (defun translate-logical-pathname (pathname &key)
2045     "Translates pathname to a physical pathname, which is returned."
2046 phg 1.16 (declare (type path-designator pathname)
2047     (values (or null pathname)))
2048 ram 1.17 (typecase pathname
2049     (logical-pathname
2050     (dolist (x (logical-host-canon-transls (%pathname-host pathname))
2051 dtc 1.34 (error 'simple-file-error
2052     :pathname pathname
2053     :format-control "No translation for ~S"
2054     :format-arguments (list pathname)))
2055 ram 1.17 (destructuring-bind (from to) x
2056     (when (pathname-match-p pathname from)
2057     (return (translate-logical-pathname
2058     (translate-pathname pathname from to)))))))
2059     (pathname pathname)
2060 ram 1.22 (stream (translate-logical-pathname (pathname pathname)))
2061 toy 1.58 (t (translate-logical-pathname (pathname pathname)))))
2062 phg 1.12
2063 ram 1.17 (defvar *logical-pathname-defaults*
2064     (%make-logical-pathname (make-logical-host :name "BOGUS") :unspecific
2065     nil nil nil nil))

  ViewVC Help
Powered by ViewVC 1.1.5