ToC DocOverview CGDoc RelNotes Index PermutedIndex
Allegro CL
Home Previous Up Next Table of Contents Index
  ANSI Common Lisp   19 Filenames   19.4 Dictionary of Filenames

19.4.11 namestring, file-namestring, directory-namestring, host-namestring, enough-namestring Function

namestring pathname    namestring

file-namestring pathname    namestring

directory-namestring pathname    namestring

host-namestring pathname    namestring

enough-namestring pathname &optional defaults    namestring

Arguments and Values:
pathname - a pathname designator.

defaults - a pathname designator. The default is the value of *default-pathname-defaults*.

namestring - a string or nil.


These functions convert pathname into a namestring. The name represented by pathname is returned as a namestring in an implementation-dependent canonical form.

namestring returns the full form of pathname.

file-namestring returns just the name, type, and version components of pathname.

directory-namestring returns the directory name portion.

host-namestring returns the host name.

enough-namestring returns an abbreviated namestring that is just sufficient to identify the file named by pathname when considered relative to the defaults. It is required that

 (merge-pathnames (enough-namestring pathname defaults) defaults)
==(merge-pathnames (parse-namestring pathname nil defaults) defaults)
in all cases, and the result of enough-namestring is the shortest reasonable string that will satisfy this criterion.

It is not necessarily possible to construct a valid namestring by concatenating some of the three shorter namestrings in some order.

 (namestring "getty")            
 (setq q (make-pathname :host "kathy" 
                           (pathname-directory *default-pathname-defaults*)
                         :name "getty")) 
 #S(PATHNAME :HOST "kathy" :DEVICE NIL :DIRECTORY directory-name 
       :NAME "getty" :TYPE NIL :VERSION NIL)
 (file-namestring q)  "getty"
 (directory-namestring q)  directory-name
 (host-namestring q)  "kathy" 
 ;;;Using Unix syntax and the wildcard conventions used by the
 ;;;particular version of Unix on which this example was created:
   (translate-pathname "/usr/dmr/hacks/frob.l"
   (translate-pathname "/usr/dmr/hacks/frob.l"
 ;;;This is similar to the above example but uses two different hosts,
 ;;;U: which is a Unix and V: which is a VMS.  Note the translation
 ;;;of file type and alphabetic case conventions.
   (translate-pathname "U:/usr/dmr/hacks/frob.l"
   (translate-pathname "U:/usr/dmr/hacks/frob.l"

See Also:
truename, merge-pathnames, pathname, logical-pathname, Section 20.1 File System Concepts, Section 19.1.2 Pathnames as Filenames

Allegro CL Implementation Details:
See cl:namestring for information on the Allegro CL implementation of namestring. Note the links are to the documentation for the current Allegro CL version. Replace /current/ in the URL with the Allegro CL version number to see similar documentation is earlier releases.

Home Previous Up Next Table of Contents Index
© Franz Inc. 1998-2015 - File last updated 03-23-2015