"

 COPYRIGHT (c) 1992 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

Object subclass:#Filename

	instanceVariableNames:'nameString'

	classVariableNames:'NextTempFilenameIndex ConcreteClass'

	poolDictionaries:''

	category:'System-Support'

!

!Filename class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1992 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    Filenames; originally added for ST-80 compatibility, is

    taking over functionality from other classes (FileDirectory).

    Instances of Filename do not nescessarily represent valid or existing

    files - i.e. it is possible (and useful) to have instances for non-existing

    files around. In other words: the name-string is not checked automatically

    for being correct or existing.

    Thus, it is possible to do queries such as:

        '/fee/foo/foe' asFilename exists     

        '/not_existing' asFilename isDirectory 

        '/foo/bar' asFilename isReadable 

    (all of the above examples will probably return false on your machine ;-).

    examples:

        'Makefile' asFilename readStream

        'newFile' asFilename writeStream

        Filename newTemporary writeStream

    Beside lots of protocol to query for a files attributes, the class

    protocol offers methods for filename completion, to construct pathes

    (in an OS-independent way) and to create temporary files.

    Especially the path-construction methods (i.e. #construct:) are highly

    recommended in order to avoid having OS details (like directory separators

    being slash or backslash) spreaded in your application.

    [author:]

        Claus Gittinger

    [see also:]

        String

        FileStream DirectoryStream PipeStream Socket

        OperatingSystem

        Date Time

"

!

examples

"

    does a file/directory exist ?:

        |f|

        f := 'foobar' asFilename.

        ^ f exists  

    is it a directory ?:

        |f|

        f := '/tmp' asFilename.

        ^ f isDirectory.   

    get the working directory:

        ^ Filename defaultDirectory

    get a files full pathname 

    (caring for relative names or symbolic links):

        |f|

        f := '..' asFilename.

        ^ f pathName  

    get a directories directory:

        |f|

        f := Filename defaultDirectory.

        ^ f directory 

    get a files directory:

        |f|

        f := './smalltalk' asFilename.

        ^ f directory 

    getting access & modification times:

        |f|

        f := '/tmp' asFilename.

        ^ f dates

    access time only:

        |f|

        f := '/tmp' asFilename.

        ^ f dates at:#accessed  

    getting all information on a file/directory:

        |f|

        f := '/tmp' asFilename.

        ^ f info

    getting a temporary file (unique name):

        |f|

        f := Filename newTemporary.

        ^ f    

    creating, writing, reading and removing a temporary file:

                                                                        [exBegin]

        |f writeStream readStream|

        f := Filename newTemporary.

        writeStream := f writeStream.

        writeStream nextPutAll:'hello world'.

        writeStream cr.

        writeStream close.

        'contents (as seen by unix''s cat command:' printNL.

        OperatingSystem executeCommand:('cat ' , f pathName).

        readStream := f readStream.

        Transcript showCR:'contents as seen by smalltalk:'.

        Transcript showCR:(readStream upToEnd).

        readStream close.

        f delete.

                                                                        [exEnd]

    getting a directories contents:

                                                                        [exBegin]

        |f files|

        f := Filename currentDirectory.

        files := f directoryContents.

        Transcript showCR:'the files are:'.

        Transcript showCR:(files printString).

                                                                        [exEnd]

    editing a file:

                                                                        [exBegin]

        |f|

        f := Filename newTemporary.

        (f writeStream) nextPutAll:'hello world'; close.

        f edit

                                                                        [exEnd]

"

! !

!Filename class methodsFor:'initialization'!

initialize

    "initialize for the OS we are running on"

    self initializeConcreteClass

    "

     self initialize

    "

    "Created: 7.9.1997 / 23:32:55 / cg"

!

initializeConcreteClass

    "initialize for the OS we are running on"

    OperatingSystem isMSDOSlike ifTrue:[

        ConcreteClass := PCFilename

    ] ifFalse:[

        OperatingSystem isVMSlike ifTrue:[

            ConcreteClass := OpenVMSFilename

        ] ifFalse:[

            OperatingSystem isUNIXlike ifTrue:[

                ConcreteClass := UnixFilename

            ] ifFalse:[

                ConcreteClass := nil

            ]

        ]

    ]

    "

     self initialize

    "

    "Modified: 7.9.1997 / 23:32:37 / cg"

!

reinitialize

    "initialize for the OS we are running on"

    self initializeConcreteClass

    "

     self initialize

    "

    "Created: 7.9.1997 / 23:33:02 / cg"

! !

!Filename class methodsFor:'instance creation'!

currentDirectory

    "return a filename for the current directory"

    (self ~~ ConcreteClass) ifTrue:[

        ^ ConcreteClass currentDirectory

    ].

    "/ fallBack - works on Unix & MSDOS (but not on VMS)

    ^ self named:'.'

    "/ ^ self named:('.' asFilename pathName)

    "

     Filename currentDirectory 

    "

    "Modified: 8.9.1997 / 00:24:15 / cg"

!

defaultDirectory

    "ST80 compatibility: same as currentDirectory"

    ^ self currentDirectory

    "

     Filename defaultDirectory 

    "

!

defaultDirectoryName

    "ST80 compatibility: return the defaultDirectories name (as a string)"

    ^ self defaultDirectory name

    "

     Filename defaultDirectoryName 

    "

!

defaultTempDirectoryName

    "return the default temp directory as a filename.

     This is used, if no special preferences were defined in

     any of the TEMP-environment variables (see tempDirectory)."

    (self ~~ ConcreteClass) ifTrue:[

        ^ ConcreteClass defaultTempDirectoryName

    ].

    ^ '/tmp'

    "

     Filename defaultTempDirectoryName           

    "

    "Modified: 7.9.1995 / 10:48:31 / claus"

    "Created: 7.3.1996 / 14:51:18 / cg"

    "Modified: 8.9.1997 / 00:24:53 / cg"

!

findDefaultDirectory

    "same as #defaultDirectory for ST80 compatibility"

    ^ self defaultDirectory

    "Created: 20.6.1997 / 17:00:29 / cg"

!

fromComponents:aCollectionOfDirectoryNames

    "create & return a new filename from components given in

     aCollectionOfDirectoryNames. If the first component is the name of the

     root directory (i.e. '/') an absolute path-filename is returned."

    |sep s|

    (self ~~ ConcreteClass) ifTrue:[

        ^ ConcreteClass fromComponents:aCollectionOfDirectoryNames

    ].

    "/ fallBack - works on Unix & MSDOS

    sep := self separator asString.

    s := ''.

    aCollectionOfDirectoryNames keysAndValuesDo:[:index :component |

        index == 1 ifTrue:[

            (component ~= sep 

            or:[aCollectionOfDirectoryNames size == 1]) ifTrue:[

                s := s , component

            ]

        ] ifFalse:[

            s := s , sep , component

        ].

    ].

    ^ self named:s

    "

     Filename fromComponents:#('/' 'foo' 'bar' 'baz')  

     Filename fromComponents:#('foo' 'bar' 'baz')  

     Filename fromComponents:#('/')  

     Filename fromComponents:

         (Filename components:('.' asFilename pathName))

     Filename fromComponents:

         (Filename components:('.' asFilename name)) 

    "

    "Modified: 8.9.1997 / 00:23:16 / cg"

!

fromUser

    "show a box to enter a filename. 

     Return a filename instance or nil (if cancel was pressed)."

    |name|

    name := Dialog requestFileName:'filename:' ifFail:nil.

    name notNil ifTrue:[^ self named:name].

    ^ nil

    "

     Filename fromUser

    "

    "Modified: 19.4.1996 / 13:57:44 / cg"

!

homeDirectory

    "return your homeDirectory.

     Some OperatingSystems do not support this - on those, the defaultDirectory

     (which is the currentDirectory) is returned."

    |s|

    s := OperatingSystem getHomeDirectory.

    s isNil ifTrue:[

        ^ self defaultDirectory

    ].

    ^ self named:s

    "

     Filename homeDirectory        

    "

    "Modified: 8.9.1997 / 00:25:23 / cg"

!

named:aString

    "return a filename for a directory named aString.

     This is the same as 'aString asFilename'."

    |cls|

    cls := self.

    cls == Filename ifTrue:[

        cls := self concreteClass

    ].

    ^ (cls basicNew) setName:aString

    "

     Filename named:'/tmp/fooBar'

    "

    "Modified: 7.9.1997 / 23:30:06 / cg"

!

newTemporary

    "return a new unique filename - use this for temporary files.

     The filenames returned are '/tmp/stxtmp_xx_nn' where xx is our

     unix process id, and nn is a unique number, incremented with every

     call to this method.

     If any of the environment variables ST_TMPDIR or TMPDIR is set, 

     its value defines the temp directory."

    ^ self newTemporaryIn:(self tempDirectory) pathName

    "

     Filename newTemporary    

     Filename newTemporary     

    "

    "Modified: 7.9.1995 / 10:48:31 / claus"

    "Modified: 7.3.1996 / 14:51:33 / cg"

!

newTemporaryIn:aDirectoryPrefix

    "return a new unique filename - use this for temporary files.

     The filenames returned are in aDirectoryPrefix and named 'stxtmp_xx_nn',

     where xx is our unix process id, and nn is a unique number, incremented 

     with every call to this method.

     Notice: only a unique filename object is created and returned - no physical

     file is created by this method (i.e. you have to send #writeStream or

     whatever to it in order to really create something).

     See also: #newTemporary which looks for a good temp directory."

    |pid nameString fn|

    (self ~~ ConcreteClass) ifTrue:[

        ^ ConcreteClass newTemporaryIn:aDirectoryPrefix

    ].

    "/ care for existing leftOver tempFiles

    "/ from a previous boot of the OS

    "/ (i.e. my pid could be the same as when executed

    "/  the last time before system reboot ...)

    [fn isNil or:[fn exists]] whileTrue:[

        "/ although the above allows things to be redefined in concrete classes,

        "/ the following should work on all systems ...

        NextTempFilenameIndex isNil ifTrue:[

            NextTempFilenameIndex := 1.

        ].

        pid := OperatingSystem getProcessId printString.

        nameString := (self tempFileNameTemplate) bindWith:pid with:(NextTempFilenameIndex printString).

        NextTempFilenameIndex := NextTempFilenameIndex + 1.

        (aDirectoryPrefix isNil or:[aDirectoryPrefix asString isEmpty]) ifFalse:[

            fn := aDirectoryPrefix asFilename construct:nameString

        ] ifTrue:[

            fn := self named:nameString

        ]

    ].

    ^ fn

    "temp files in '/tmp':

     Filename newTemporary    

    "

    "temp files somewhere 

     (not recommended - use above since it can be controlled via shell variables):