"

 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'

	 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.

"

!

version

    ^ '$Header: /cvs/stx/stx/libbasic/Filename.st,v 1.41 1995-11-14 21:42:42 cg Exp $'

!

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

"

!

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:

	|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.

    getting a directories contents:

	|f files|

	f := '.' asFilename.

	files := f directoryContents.

	Transcript showCr:'the files are:'.

	Transcript showCr:(files printString).

    editing a file:

	|f|

	f := '/tmp/fooBar' asFilename.

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

	f edit

"

! !

!Filename class methodsFor:'instance creation'!

named:aString

    "return a filename for a directory named aString.

     This is the same as 'aString asFilename'."

    ^ (self basicNew) setName:aString

    "

     Filename named:'/tmp/fooBar'

    "

!

currentDirectory

    "return a filename for the current directory"

    ^ self named:(FileDirectory currentDirectory pathName)

    "

     Filename currentDirectory 

    "

!

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 

    "

!

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."

    |tempDir|

    tempDir := OperatingSystem getEnvironment:'ST_TMPDIR'.

    tempDir isNil ifTrue:[

	tempDir := OperatingSystem getEnvironment:'TMPDIR'.

	tempDir isNil ifTrue:[

	    tempDir := '/tmp'

	].

    ].

    ^ self newTemporaryIn:tempDir

    "

     Filename newTemporary    

     Filename newTemporary  

    "

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

    "Modified: 4.11.1995 / 20:08:51 / 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 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 nm|

    NextTempFilenameIndex isNil ifTrue:[

	NextTempFilenameIndex := 1.

    ].

    "

     the following has to be made OS independent ...

    "

    pid := OperatingSystem getProcessId printString.

    nm := 'stxtmp_' , pid , '_' , NextTempFilenameIndex printString.

    NextTempFilenameIndex := NextTempFilenameIndex + 1.

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

	nm := aDirectoryPrefix asFilename construct:nm

    ] ifTrue:[

	nm := nm asFilename

    ].

    ^ nm

    "temp files in '/tmp':

     Filename newTemporary   

     Filename newTemporaryIn:'/tmp'    

     Filename newTemporaryIn:'/tmp'  

    "

    "temp files somewhere (not recommended):

     Filename newTemporaryIn:'/usr/tmp'    

     Filename newTemporaryIn:'/'  

    "

    "a local temp file:

     Filename newTemporaryIn:''         

     Filename newTemporaryIn:nil         

     Filename newTemporaryIn:'.'         

     Filename newTemporaryIn:('source' asFilename) 

    "

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

    "Modified: 4.11.1995 / 20:26:23 / cg"

!

fromUser

    "show a box to enter a filename. Return a filename instance or

     nil (if cancel was pressed)."

    |name|

    name := FileSelectionBox requestFilename.

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

    ^ nil

    "

     Filename fromUser

    "

! !

!Filename class methodsFor:'queries'!

separator

    "return the file/directory separator.

     Usually, this is $/ for unix-like systems 

     and $\ for dos-like ones (there may be more in the future)."

     ^ OperatingSystem fileSeparator

     "

      Filename separator  

     "

!

suffixSeparator

    "return the filename suffix separator.

     Usually, this is $. for unix-like and msdos systems 

     (there is currently no knowns system, where this differs)"

     ^ $.

     "

      Filename suffixSeparator  

     "

    "Modified: 7.9.1995 / 11:10:43 / claus"

!

parentDirectoryName 

    "return the name used for the parent directory.

     This is '..' for unix and dos-like systems. 

     (there may be more in the future."

     ^ OperatingSystem parentDirectoryName

     "

      Filename parentDirectoryName  

     "

!

isCaseSensitive

    "return true, if filenames are case sensitive.

     We ask the OS about this, to be independent here."

    ^ OperatingSystem caseSensitiveFilenames

!

defaultClass

    "ST-80 compatibility:

     in ST-80, different subclasses of Filename are used for different

     OperatingSystems; defaultClass is supposed to return an appropriate class.

     Since in ST/X, there is (currently) only one Filename class, return it here."

    ^ self

!

localNameStringFrom:aString

    "ST-80 compatibility.

     what does this do ? (used in FileNavigator-goody).

     GUESS: does it strip off the voulume-character on MSDOS systems ?"

    (aString startsWith:'/') ifTrue:[

	^ aString copyFrom:2

    ].

    ^ aString

    "Modified: 7.9.1995 / 10:44:56 / claus"

!

volumes

    "ST-80 compatibility.

     what does this do ? (used in FileNavigator-goody).

     GUESS: does it return the available drives on MSDOS systems ?"

    ^ #('/')

    "Modified: 7.9.1995 / 10:45:25 / claus"

!

filenameCompletionFor:aString directory:inDirectory directoriesOnly:directoriesOnly filesOnly:filesOnly ifMultiple:aBlock

    "perform filename completion on aString in some directory;

     return the longest matching filename prefix as a string.

     If directoriesOnly and filesOnly are true, only directories and files

     are considered respectively. If multiple files match, the exception

     block aBlock is evaluated with a filename representing the directory

     (where the match was done) as argument.

     (this may be different from the inDirectory argument, if aString is absolute

      or starts with ../)"

    |s f matchSet nMatch name words dir|

    s := aString.

    "

     find the last word ...

    "

    words := s asCollectionOfWords.

    words size == 0 ifTrue:[

	aBlock value:'.' asFilename.

	^ ''

    ].

    f := words last asFilename.

    matchSet := f filenameCompletionIn:inDirectory.

    dir := f directory.

    directoriesOnly ifTrue:[

	matchSet := matchSet select:[:aFilename |

	    (dir construct:aFilename) isDirectory

	].

    ] ifFalse:[

	filesOnly ifTrue:[

	    matchSet := matchSet select:[:aFilename |

		(dir construct:aFilename) isDirectory not

	    ].

	]

    ].

    (nMatch := matchSet size) ~~ 1 ifTrue:[

	"

	 more than one possible completion -

	"

	aBlock value:f

    ].

    "

     even with more than one possible completion,

     f's name is now the common prefix

    "

    name := f asString.

    nMatch == 1 ifTrue:[

	"

	 exactly one possible completion -

	"

	f := dir construct:matchSet first.

	directoriesOnly ifFalse:[

	    f isDirectory ifTrue:[

		(name endsWith:(Filename separator)) ifFalse:[

		    name := name , '/'

		].

	    ].

	]

    ].

    "

     construct new contents, by taking

     last words completion

    "

    s := ''.

    1 to:(words size - 1) do:[:idx |

	s := s , (words at:idx) , ' '

    ].

    s := s , name.

    "/ special: if there was no change, and the string represented

    "/ is a directories name, add a directory separator

    s = aString ifTrue:[

	(s endsWith:Filename separator) ifFalse:[

	    s asFilename isDirectory ifTrue:[

		^ s , Filename separator asString

	    ]