"

 COPYRIGHT (c) 1999 by eXept Software AG

              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.

"

"{ Package: 'stx:libwidg2' }"

HierarchicalList subclass:#HierarchicalFileList

	classVariableNames:''

	poolDictionaries:''

	category:'Views-Support'

!

	instanceVariableNames:'fileName icon'

	classVariableNames:''

	poolDictionaries:''

	privateIn:HierarchicalFileList

!

	instanceVariableNames:'modificationTime'

	classVariableNames:''

	poolDictionaries:''

!

!HierarchicalFileList class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1999 by eXept Software AG

              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.

"

! !

!HierarchicalFileList class methodsFor:'examples'!

examples

"

                                                                    [exBegin]

    |top sel list|

    list := HierarchicalFileList new.

    list directory:(Filename homeDirectory).

    list showRoot:false.

    list matchBlock:[:fn :isDir| true ].

    top := StandardSystemView new; extent:300@300.

    sel := ScrollableView for:HierarchicalListView miniScroller:true

                       origin:0.0@0.0 corner:1.0@1.0 in:top.

    sel list:list.

    list root expand.

    sel doubleClickAction:[:i| (list at:i) toggleExpand ].

    sel   indicatorAction:[:i| (list at:i) toggleExpand ].

    top open.

                                                                    [exEnd]

"

! !

!HierarchicalFileList methodsFor:'accessing'!

directory

    "returns the root directory or nil

    "

    ^ root notNil ifTrue:[root fileName] ifFalse:[nil]

!

directory:aDirectory

    "set the root directory or nil

    "

    |directory|

"/    must explicitly enabled by user: ca

"/    monitoringTaskDelay := 1.

    (aDirectory notNil and:[(directory := aDirectory asFilename) exists]) ifTrue:[

        directory isDirectory ifFalse:[

            directory := directory directory

        ]

    ] ifFalse:[

        directory := nil

    ].

    directory = self directory ifFalse:[

        directory notNil ifTrue:[

        ].

        self root:directory

    ].

! !

!HierarchicalFileList methodsFor:'actions'!

matchBlock

    "set the matchBlock - if non-nil, it controls which files are visible.

    "

    ^ matchBlock

!

matchBlock:aBlock

    "set the matchBlock - if non-nil, it controls which files are visible.

    "

    matchBlock := aBlock.

    root notNil ifTrue:[

        self recursionLock critical:[

            self stopMonitoringTask.

            root matchBlockChanged.

        ].

        self startMonitoringTask.

    ].

! !

!HierarchicalFileList methodsFor:'private monitoring task'!

monitoringCycle

    "the block evaluated by the monitoring task; test whether directory is expanded

     otherwise we have not to evaluate the directory contents.

     think about remote file-systems

    "

    item  := root.

    index := showRoot ifTrue:[1] ifFalse:[0].

    [item notNil] whileTrue:[

        ].

        Processor yield.

        index := index + 1.

        item  := self at:index ifAbsent:nil.

    ].

! !

!HierarchicalFileList methodsFor:'protocol'!

childrenFor:anItem

    "returns all visible children derived from the physical

     directory contents.

    "

    anItem isDirectory ifFalse:[^ #()].

    contents := DirectoryContents directoryNamed:(anItem fileName).

    contents ifNil:[ ^ #() ].

    list  := SortedCollection sortBlock:[:a :b| |res|

        a isDirectory == b isDirectory ifTrue:[ res := a baseName <= b baseName ]

                                      ifFalse:[ res := a isDirectory ].

        res

    ].

        ]

    ].

    list isEmpty ifTrue:[^ #()].

!

hasChildrenFor:anItem

    "returns true if the physical directory contains at least

     one visible item otherwise false.

    "

    |block|

    anItem isDirectory ifFalse:[

        ^ false

    ].

    (block := self matchBlockFor:anItem) isNil ifTrue:[

        block := [:aFilename :isDirectory| true ]

    ].

    ^ DirectoryContents directoryNamed:(anItem fileName) detect:block

!

iconFor:anItem

    "returns the icon for an item

    "

    (anItem isExpanded and:[anItem hasChildren]) ifTrue:[

        ^ FileBrowser iconForKeyMatching:#directoryOpen

    ].

    ^ FileBrowser iconForFile:(anItem fileName)

!

matchBlockFor:anItem

    "get the matchBlock - if non-nil, it controls which files are

     visible within the physical directory

    "

    ^ matchBlock        

!

validateIcon:anIcon for:anItem

    ^ anIcon

! !

!HierarchicalFileList methodsFor:'searching'!

detectItemFor:aPathOrFilename

    "make a filename visible

    "

    |file node p1 p2 sz|

    aPathOrFilename isNil ifTrue:[^ nil].

    file := aPathOrFilename asFilename.

    file exists ifFalse:[

        ^ nil

    ].

    (node := root) isNil ifTrue:[^ nil].

    p1 := node pathName.

    p2 := file pathName.

    (p2 startsWith:p1) ifFalse:[^ nil].

    sz := 1 + p1 size.

    (p1 last == Filename separator) ifFalse:[

        sz := sz + 1.

    ].

    p2 size > sz ifFalse:[^ nil].

    p2 :=  Filename components:(p2 copyFrom:sz).

    p2 do:[:bn|

        node := node detect:[:el| el baseName = bn] ifNone:nil.

        node isNil ifTrue:[^ nil ].

    ].

    ^ node

! !

fileName:aFileName isDirectory:isDirectory

    "instance creation

    "

    |item|

    item fileName:aFileName.

  ^ item

! !

baseName

    "returns the baseName

    "

    ^ fileName baseName.

"/    ^ baseName

!

fileName

    "returns the fileName

    "

    ^ fileName

!

fileName:fname

    "instance creation

    "

    fileName := fname.

"/    baseName := fname baseName.

!

icon

    "returns the icon key

    "

    |model|

    ].

!

label

    "returns the printable name, the baseName

    "

    ^ self baseName

!

pathName

    "returns the pathName

    "

    ^ fileName pathName

! !

invalidate

    "invalidate the contents

    "

    self invalidateRepairNow:false

!

invalidateRepairNow

    "invalidate the contents; repair now

    "

    self invalidateRepairNow:true

!

invalidateRepairNow:doRepair

    "invalidate the contents; dependent on the boolean

     do repair immediately

    "

!

matchBlockChanged

    "called if the matchBlock changed

    "

! !

printString

    ^ super printString, ' for: ', self fileName asString

! !

!HierarchicalFileList::File methodsFor:'queries'!

hasChildren

    "always returns false

    "

    ^ false

! !

children

    "returns the list of children

    "

    children notNil ifTrue:[

        ^ children

    ].

    (model := self model) isNil ifTrue:[

        "/ must reread later

        modificationTime := children := nil.

        ^ nil

    ].

    children := #().

    modificationTime := fileName modificationTime.

    list := model childrenFor:self.