"

 COPYRIGHT (c) 2002 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:libtool' }"

"{ NameSpace: Smalltalk }"

ApplicationModel subclass:#AbstractFileBrowser

	instanceVariableNames:'aspects'

	classVariableNames:'CommandHistory CommandHistorySize DefaultCommandPerSuffix

		DefaultFilters DirectoryBookmarks LastEnforcedNameSpace

		LastFileDiffDirectory LastFileDiffFile LastFileSelection

		LastMercurialRepository LastMoveDestination LastMustMatchPattern

		LastScriptBlockString MaxFileSizeShownWithoutAsking RootHolder

		RuntimeAspects VisitedDirectories'

	poolDictionaries:''

	category:'Interface-Tools-File'

!

AbstractFileBrowser class instanceVariableNames:'DisabledCursorImage EnabledCursorImage'

"

 The following class instance variables are inherited by this class:

	ApplicationModel - ClassResources

	Model - 

	Object - 

"

!

Object subclass:#Clipboard

	instanceVariableNames:'method files'

	classVariableNames:''

	poolDictionaries:''

	privateIn:AbstractFileBrowser

!

Object subclass:#CodeExecutionLock

	instanceVariableNames:'locked'

	classVariableNames:''

	poolDictionaries:''

	privateIn:AbstractFileBrowser

!

List subclass:#DirectoryHistory

	instanceVariableNames:'forwardList backList lastWasForwardPath lastBackPath lastAddPath

		backForwardList backForwardIndex historySize'

	classVariableNames:'HistorySize'

	poolDictionaries:''

	privateIn:AbstractFileBrowser

!

Object subclass:#DirectoryHistoryItem

	instanceVariableNames:'path position'

	classVariableNames:''

	poolDictionaries:''

	privateIn:AbstractFileBrowser::DirectoryHistory

!

Object subclass:#SaveAspectItem

	instanceVariableNames:'value isHolder'

	classVariableNames:''

	poolDictionaries:''

	privateIn:AbstractFileBrowser

!

!AbstractFileBrowser class methodsFor:'documentation'!

copyright

"

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

"

!

documentation

"

    [Author:]

        Christian Penk

    Notice: this certainly needs a redesign - all those abstract-abstract classes which

    define stuff which is only needed in some parts makes this hard to understand.

    Especially the fact, that AbstractFileBrowser defines things both as abstract superclass

    and as a container is almost incomprehensable...

    [class variables:]

        CommandHistory 

        CommandHistorySize 

        DefaultCommandPerSuffix

        DefaultFilters 

        DirectoryBookmarks 

        LastEnforcedNameSpace

        LastFileDiffDirectory 

        LastFileDiffFile 

        LastFileSelection

        LastMercurialRepository 

        LastMoveDestination 

        LastMustMatchPattern

        LastScriptBlockString 

        RootHolder 

        RuntimeAspects

        VisitedDirectories 

        MaxFileSizeShownWithoutAsking ..... for big files, I will ask if only the first part is

                                            to be shown. This number (if non-nil) suppresses this

                                            question for files smaller.

                                            The initial default is 1Mb (1024*1024)

"

! !

!AbstractFileBrowser class methodsFor:'accessing'!

currentSelection

    LastFileSelection isNil ifTrue:[

        LastFileSelection := #().

    ].

    ^ LastFileSelection

!

currentSelection:aFilenameCol

    aFilenameCol notEmptyOrNil ifTrue:[

        LastFileSelection := aFilenameCol collect:[:file | (file ? '') asFilename]

    ]

!

directoryHistory

    VisitedDirectories isNil ifTrue:[

        VisitedDirectories := self directoryHistoryClass new.

        "/ VisitedDirectories inspect.

    ].

    ^ VisitedDirectories

    "Modified: / 21-11-2012 / 08:45:49 / cg"

!

maxFileSizeShownWithoutAsking

    "the max. filesize which is loaded without asking if only the first

     part should be shown"

    MaxFileSizeShownWithoutAsking notNil ifTrue:[^ MaxFileSizeShownWithoutAsking]. 

    ExternalAddress pointerSize == 8 ifTrue:[

        ^ (32*1024*1024)

    ].

    ^ (4*1024*1024)

    "Created: / 19-11-2017 / 14:48:19 / cg"

    "Modified: / 22-05-2019 / 18:19:24 / Claus Gittinger"

!

maxFileSizeShownWithoutAsking:anIntegerOrNilForDefault

    "the max. filesize which is loaded without asking if only the first

     part should be shown.

     Nil resets to the default (currently 1Mb)"

    MaxFileSizeShownWithoutAsking := anIntegerOrNilForDefault

    "

     self maxFileSizeShownWithoutAsking:nil

    "

    "Created: / 19-11-2017 / 14:48:45 / cg"

!

resetClassVars

    VisitedDirectories := nil.

    LastFileSelection := nil.

    "

     AbstractFileBrowser resetClassVars

    "

    "Modified: / 21-11-2012 / 08:45:53 / cg"

!

rootHolder

    ^ RootHolder

!

rootHolder:aRoot

    RootHolder := aRoot

! !

!AbstractFileBrowser class methodsFor:'accessing-bookmarks'!

addBookmark:aDirectoryPath

    "add aDirectoryPath to the list of our known bookmarks.

     Do not add duplicates."

    |bookmarks|

    bookmarks := self directoryBookmarks.

    (bookmarks includes:aDirectoryPath) ifFalse:[

        bookmarks add:aDirectoryPath asFilename.

    ].

!

bookmarksFrom:aFileNameOrString

    |bookmarks s fileName line|

    fileName := aFileNameOrString asFilename.

    [

        s := fileName readStream.

    ] on:OpenError do:[:ex|

        ^ nil.

    ].

    bookmarks := OrderedCollection new.

    [s atEnd] whileFalse:[

        line := s nextLine.

        (line startsWith:';') ifFalse:[

            bookmarks add:(Base64Coder decode:line) asString.

        ]

    ].

    s close.

    ^ bookmarks

!

defaultBookMarksFileDirectory

    "the directory, where the default bookmarks are stored (as defaultBookMarksFilename)"

    ^ Filename homeDirectory

!

defaultBookMarksFilename

    "the filename, in which the default bookmarks are stored (in defaultBookMarksDirectory)"

    ^ '.fileBrowserBookmarks'

!

directoryBookmarks

    DirectoryBookmarks isNil ifTrue:[                     

        self loadBookmarksFrom:(self defaultBookMarksFileDirectory construct:self defaultBookMarksFilename).

        DirectoryBookmarks isEmptyOrNil ifTrue:[

            DirectoryBookmarks := 

                OrderedCollection 

                    with:(Filename homeDirectory asAbsoluteFilename)

                    with:(Filename currentDirectory asAbsoluteFilename).

        ]

    ].

    ^ DirectoryBookmarks

    "

     DirectoryBookmarks := nil.

     self directoryBookmarks.

    "

!

directoryBookmarks: collectionOfFilenames

    DirectoryBookmarks := collectionOfFilenames.

    self saveBookmarksInDefaultBookmarksFile.

!

editBookmarksWithDefault: aFilenameOrNil

    | oldBookmarks newBookmarks |

    oldBookmarks := self directoryBookmarks copy.

    newBookmarks := BookmarksEditDialog openWith: oldBookmarks defaultBookmark: aFilenameOrNil.

    newBookmarks isNil ifTrue:[^ self].

    self directoryBookmarks: newBookmarks.

    "Modified: / 13-01-2011 / 12:52:28 / cg"

!

hasBookmarks

    ^ self directoryBookmarks notEmptyOrNil

!

loadBookmarksFrom:aFileNameOrString

    |bookmarks|

    bookmarks := self bookmarksFrom: aFileNameOrString.

    bookmarks isNil ifTrue:[^ self].

    DirectoryBookmarks := OrderedCollection new.

    bookmarks do:[:eachPath |

        self addBookmark:eachPath asFilename

    ].

!

removeBookmark:aDirectoryPath

    |bookmarks|

    bookmarks := self directoryBookmarks.

    bookmarks isEmptyOrNil ifTrue:[ ^ self].

    bookmarks remove:aDirectoryPath ifAbsent:[].

!

saveBookmarks

    |fn|

    fn := Dialog 

            requestFileNameForSave:(self resources string:'Save Bookmarks')

            default:(self defaultBookMarksFilename)

            fromDirectory:(self defaultBookMarksFileDirectory).

    fn isEmptyOrNil ifTrue:[^ self].

    self saveBookmarksIn:fn

    "Modified: / 27-10-2010 / 11:27:09 / cg"

    "Modified: / 01-05-2019 / 11:45:37 / Claus Gittinger"

!

saveBookmarks: bookmarks in:aFileNameOrString

    "save the bokmarks in aFileNameOrString.

     Use Base64 coding"

    |bookmarkStream fileName coder|

    fileName := aFileNameOrString asFilename.

    fileName exists ifTrue:[

        fileName renameTo:(fileName addSuffix:'sav').

    ].

    bookmarkStream := fileName writeStream.

    "save each bookmark in one line"

    coder := (Base64Coder on:bookmarkStream) lineLimit:nil.

    bookmarks do:[:eachPath |

        eachPath asFilename pathName acceptVisitor:coder.

        coder flush.

        bookmarkStream cr.

    ].

    bookmarkStream syncData; close.

!

saveBookmarksIn:aFileNameOrString

    "save the bokmarks in aFileNameOrString.

     Use Base64 coding"

    | bookmarks |

    bookmarks := self directoryBookmarks.

    self saveBookmarks: bookmarks in:aFileNameOrString

!

saveBookmarksInDefaultBookmarksFile

    self saveBookmarksIn:(self defaultBookMarksFileDirectory construct:self defaultBookMarksFilename)

! !

!AbstractFileBrowser class methodsFor:'accessing-classes'!

directoryHistoryClass

    ^ DirectoryHistory

    "Modified: / 21-11-2012 / 08:46:34 / cg"

! !

!AbstractFileBrowser class methodsFor:'aspects-visibility'!

cvsMenusAreShown

    ^ ConfigurableFeatures includesFeature: #CVSSupportEnabled

    "Created: / 15-01-2012 / 13:00:05 / cg"

    "Modified: / 19-01-2012 / 10:43:30 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

gitMenusAreShown

     ^ (ConfigurableFeatures includesFeature: #GITSupportEnabled)

    "Created: / 10-06-2019 / 15:56:33 / Claus Gittinger"

!

hgMenusAreShown

     ^ (ConfigurableFeatures includesFeature: #HGSupportEnabled)

    "Created: / 14-01-2013 / 11:53:51 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

mercurialMenusAreShown

    ^ ConfigurableFeatures hasMercurialSupportEnabled

    "Created: / 15-01-2012 / 13:00:00 / cg"

!

perforceMenusAreShown

    ^ (ConfigurableFeatures includesFeature: #PerforceSupportEnabled)

    and:[ ConfigurableFeatures hasPerforceSupportEnabled ]

    "Created: / 15-01-2012 / 13:12:11 / cg"

    "Modified: / 19-01-2012 / 10:43:42 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 02-11-2012 / 11:19:59 / cg"

!

svnMenusAreShown

    ^ ConfigurableFeatures includesFeature: #SubversionSupportEnabled

    "Created: / 15-01-2012 / 13:02:03 / cg"

    "Modified: / 19-01-2012 / 10:43:46 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!AbstractFileBrowser class methodsFor:'defaults'!

commandHistory

    CommandHistory isNil ifTrue:[

        CommandHistory := OrderedCollection new.

    ].

    ^ CommandHistory

!

commandHistorySize

    "max no of entries in the HistoryList "

    CommandHistorySize isNil ifTrue:[

        CommandHistorySize := 150

    ].

    ^ CommandHistorySize

!

defaultFilterList

    DefaultFilters isNil ifTrue:[

        DefaultFilters := #(        '*'

                                    '*.st' 

                                    '*.[h,c]*' 

                                    '*.txt; *.htm*' 

                                    '*.gif; *.xpm; *.jpg; *.png' 

                                    '~*o; ~*.obj; ~*.dll;' 

                                )

    ].

    ^ DefaultFilters.

    "

     DefaultFilters := nil

    "

!

initialCommandFor:fileName in:aDirectory intoBox:aBox

    "set a useful initial command in an execute box."

    |mime cmd select path suffix baseName pathName|

    path := aDirectory filenameFor:fileName.

    baseName := path baseName.

    suffix := path suffix.

    cmd := UserPreferences current defaultFileOpenCommandFor:suffix.

    cmd notNil ifTrue:[

        aBox initialText:(cmd bindWith:fileName pathName).

        ^ self

    ].

    mime := MIMETypes mimeTypeForSuffix:suffix.

"/    mime notNil ifTrue:[

"/        cmd := self initialCommandForMIME:mime file:path

"/    ].

    "/ XXX should be changed to take stuff from a config file

    "/ XXX or from resources.

    (path type == #regular) ifTrue:[

        path isExecutableProgram ifTrue:[

            aBox initialText:(path pathName , ' <arguments>').

            ^ self

        ].

        select := true.

        "some heuristics - my personal preferences ...

         (actually this should come from a configfile)"

        (baseName endsWith:'akefile') ifTrue:[

            aBox initialText:'make target' selectFrom:6 to:11.

            ^ self

        ].

        cmd := MIMETypes defaultCommandTemplateToOpenMimeType:mime.

        cmd notNil ifTrue:[

            select := false