"

 COPYRIGHT (c) 1989 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.

"

Collection subclass:#FileDirectory

       instanceVariableNames:'pathName lazy'

       classVariableNames:'PathOfCurrentDirectory'

       poolDictionaries:''

       category:'Collections-Files'

!

FileDirectory comment:'

COPYRIGHT (c) 1989 by Claus Gittinger

	     All Rights Reserved

'!

!FileDirectory class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 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

"

"

!

documentation

"

    FileDirectories represent directories in the underlying host system.

    They provide various methods to create/delete and query for files and/or

    directories. Also, since FileDirectory inherits from Collection, it

    provides all enumeration and testing protocol. For example, you can

    loop over the filenames in a directory using 'aFileDirectory do:[:nm | ...]'.

    Notice:

	This class is not available in other ST-systems, while for example,

	ST-80 provides a Filename class.

	Therefore, Filename will take over much of the functionality in the near 

	future.

	Use instances of Filename if possible.

"

! !

!FileDirectory class methodsFor:'initialization'!

initialize

    "/

    "/ want to know about image restart

    "/

    ObjectMemory addDependent:self

!

update:something

    "/

    "/ currentDirectory may be different when restarted

    "/

    something == #restarted ifTrue:[

	PathOfCurrentDirectory := nil

    ]

! !

!FileDirectory class methodsFor:'instance creation'!

directoryNamed:name

    "create and return a new FileDirectory for the directory

     with given pathname"

    ^ (self basicNew) pathName:name

    "

     (FileDirectory directoryNamed:'..') pathName

     (FileDirectory directoryNamed:'../..') files

    "

!

rootDirectory

    "create and return a new FileDirectory for the root directory"

    ^ self directoryNamed:(OperatingSystem fileSeparator asString)

    "

     FileDirectory rootDirectory contents

     FileDirectory rootDirectory files

     FileDirectory rootDirectory isReadable

    "

!

currentDirectory

    "create and return a new FileDirectory for the current directory"

    ^ self directoryNamed:'.'

    "

     FileDirectory currentDirectory contents

     FileDirectory currentDirectory files

     FileDirectory currentDirectory isReadable

     FileDirectory currentDirectory pathName

    "

!

directoryNamed:name in:aFileDirectory

    "create and return a new FileDirectory for the directory with given name

     in another FileDirectory"

    |baseName sep|

    sep := OperatingSystem fileSeparator.

    ((name at:1) == sep) ifTrue:[

	^ self directoryNamed:name

    ].

    (aFileDirectory isKindOf:FileDirectory) ifTrue:[

	baseName := aFileDirectory pathName

    ] ifFalse:[

	baseName := aFileDirectory

    ].

"

    (name = '..') ifTrue:[

	^ (self basicNew) pathName:(OperatingSystem directoryNameOf:baseName)

    ].

"

    (name = '.') ifTrue:[^ aFileDirectory].

    (baseName = sep asString) ifFalse:[

	(baseName endsWith:sep) ifFalse:[

	    baseName := baseName copyWith:sep

	]

    ].

    ^ self directoryNamed:(baseName , name)

! !

!FileDirectory class methodsFor:'private'!

fullPathNameOf:name in:path

    |sep|

    sep := OperatingSystem fileSeparator asString.

    (name startsWith:sep) ifTrue:[

	^ name

    ].

    ^ path , sep , name

! !

!FileDirectory methodsFor:'accessing'!

baseName

    "return my baseName

     - thats the directory name without leading parent-dirs"

    lazy ifTrue:[self getFullPathName].

    ^ OperatingSystem baseNameOf:pathName

!

directoryName

    "return my directoryName

     - thats the directory name where I'm in"

    lazy ifTrue:[self getFullPathName].

    ^ OperatingSystem directoryNameOf:pathName

!

pathName

    "return my full pathname"

    lazy ifTrue:[self getFullPathName].

    ^ pathName

!

pathName:dirName

    "set my pathname; return nil if not a valid path; self otherwise"

    pathName := dirName.

    (dirName startsWith:OperatingSystem fileSeparator) ifFalse:[

	lazy := true

    ] ifTrue:[

	(dirName includes:$.) ifTrue:[

	    lazy := true

	]

    ].

    ^ self

"

    (OperatingSystem isDirectory:pathName) ifFalse:[^ nil]

"

!

contents 

    "return a collection with all files and subdirectories in the receiver"

    |coll|

    coll := OrderedCollection new.

    self do:[:name |

	coll add:name

    ].

    coll sort.

    ^ coll

!

directories

    "return a collection with all subdirectories in the receiver directory"

    |coll|

    coll := OrderedCollection new.

    self directoriesDo:[:name |

	coll add:name

    ].

    coll sort.

    ^ coll

!

files

    "return a collection with all plain files in the receiver directory"

    |coll|

    coll := OrderedCollection new.

    self filesDo:[:name |

	coll add:name

    ].

    coll sort.

    ^ coll

! !

!FileDirectory methodsFor:'converting'!

asFilename

    "return myself as a filename"

    ^ self pathName asFilename

!

asFilename:someFile

    "return a filename for a file named someFile in myself"

    ^ self asFilename construct:someFile

! !

!FileDirectory methodsFor:'private'!

getFullPathName

    "make my pathname be a full pathname - i.e. starting at root"

    |shortPathName|

    (pathName = OperatingSystem fileSeparator asString) ifTrue:[

	lazy := false.

	^ self

    ].

    "since currentDirectory is used very often, cache its path here"

    (pathName = '.') ifTrue:[

	PathOfCurrentDirectory notNil ifTrue:[

	    pathName := PathOfCurrentDirectory.

	    lazy := false.

	    ^ self

	]

    ].

    shortPathName := pathName.

    pathName := OperatingSystem pathNameOf:pathName.

    lazy := false.

    "

     if it was the current dir, keep name for next query

    "

    (shortPathName = '.') ifTrue:[

	PathOfCurrentDirectory := pathName

    ]

!

pathNameOf:fileName

    ^ self class fullPathNameOf:fileName in:pathName

! !

!FileDirectory methodsFor:'basic'!

createDirectory:newName

    "create a new filedirectory as a subdirectory of myself;

     return true if successful"

    |realName|

    (newName = '.') ifFalse:[

	(newName = '..') ifFalse:[

	    ((newName at:1) == OperatingSystem fileSeparator) ifTrue:[

		realName := newName copyFrom:2

	    ] ifFalse:[

		realName := newName

	    ].

	    ^ OperatingSystem createDirectory:(self pathNameOf:realName)

	]

    ].

    ^ false

!

removeFile:fileName

    "remove the file 'fileName' from myself; return true if successful"

    ^ OperatingSystem removeFile:(self pathNameOf:fileName).

!

removeDirectory:dirName

    "remove the directory 'dirName' from myself; return true if successful.

     If the directory is not empty, the containing files/directories are also

     removed."

    |path|

    path := self pathNameOf:dirName.

    (OperatingSystem removeDirectory:path) ifTrue:[^ true].

    ^ OperatingSystem recursiveRemoveDirectory:path

!

remove:aFileOrDirectoryName

    "remove the file or directory from myself; return true if successful"

    |path|

    path := self pathNameOf:aFileOrDirectoryName.

    (OperatingSystem isDirectory:path) ifTrue:[

	^ OperatingSystem removeDirectory:path

    ].

    ^ OperatingSystem removeFile:path

!

link:oldFileName to:newFileName

    "link oldFileName to newFileName in myself, return true if successful"

    |path1 path2|

    path1 := self pathNameOf:oldFileName.

    path2 := self pathNameOf:newFileName.

    ^ OperatingSystem linkFile:path1 to:path2

!

renameFile:oldFileName newName:newFileName

    "rename the file; return true if successful"

    |path1 path2|

    path1 := self pathNameOf:oldFileName.

    path2 := self pathNameOf:newFileName.

    ^ OperatingSystem renameFile:path1 to:path2

! !

!FileDirectory methodsFor:'queries'!

species

    ^ OrderedCollection

!

id

    "return the directories file-id (inode number)"

    ^ OperatingSystem idOf:pathName

!

exists

    "return true if this directory exists"

    ^ OperatingSystem isDirectory:pathName

    "

     (FileDirectory directoryNamed:'fooBar') exists

     (FileDirectory directoryNamed:'/tmp') exists

    "

!

isEmpty

    "return true, if the directory is empty;

     redefined since '.' and '..' do not count as entries here."

    self do:[:fName |

	((fName ~= '.') and:[fName ~= '..']) ifTrue:[^ false].

    ].

    ^ true

!

infoOf:name

    "return an array filled with file info for the file 'aFileName';

     return nil if such a file does not exist"

    ^ OperatingSystem infoOf:(self pathNameOf:name)

!

timeOfLastChange:name

    "return the timeStamp of a file in myself"

    ^ OperatingSystem timeOfLastChange:(self pathNameOf:name)

!

timeOfLastChange

    "return the timeStamp of myself"

    ^ OperatingSystem timeOfLastChange:pathName

!

accessModeOf:name

    "return the access-mode bits (rwxrwxrwx) of a file in myself"

    ^ OperatingSystem accessModeOf:(self pathNameOf:name)

!

changeAccessModeOf:name to:modeBits

    "set the access-mode bits (rwxrwxrwx) of a file in myself"

    ^ OperatingSystem changeAccessModeOf:(self pathNameOf:name) to:modeBits

!

typeOf:name

    "return the symbolic type of a file in myself"

    ^ OperatingSystem typeOf:(self pathNameOf:name)

!

exists:name

    "return true, if the given name exists in myself"

    ^ OperatingSystem isValidPath:(self pathNameOf:name)

!

isDirectory:name

    "return true, if the given name is that of a directory in myself"

    ^ OperatingSystem isDirectory:(self pathNameOf:name)

!

isReadable:name

    "return true, if the given file is readable"

    ^ OperatingSystem isReadable:(self pathNameOf:name)

!

isWritable:name

    "return true, if the given file is readable"

    ^ OperatingSystem isWritable:(self pathNameOf:name)

!

isExecutable:name

    "return true, if the given file is executable"

    ^ OperatingSystem isExecutable:(self pathNameOf:name)

! !

!FileDirectory methodsFor:'printing & storing'!

printOn:aStream

    "append a printed representation of the receiver to aStream."

    lazy ifTrue:[self getFullPathName].

    aStream nextPutAll:'(a FileDirectory pathName:';

	    nextPutAll:pathName;

	    nextPutAll:')'

!

storeOn:aStream

    "append a printed representation of the receiver to aStream,

     which allows reconstructing it via readFrom:"

    lazy ifTrue:[self getFullPathName].

    aStream nextPutAll:'(FileDirectory directoryNamed:'.

    aStream nextPutAll:pathName.

    aStream nextPut:$)

! !

!FileDirectory methodsFor:'more instance creation'!

directoryNamed:aName

    ^ self class directoryNamed:aName in:self pathName

! !

!FileDirectory methodsFor:'enumerating'!

where:testBlock do:aBlock

    "evaluate the argument, aBlock for every object in the directory

     for which testBlock evaluates to true."