"

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

"

"{ Package: 'stx:libbasic3' }"

Object subclass:#AbstractSourceCodeManager

	instanceVariableNames:''

	classVariableNames:'DefaultManager CachingSources CacheDirectoryName UseWorkTree

		WorkTreeDirectoryName'

	poolDictionaries:''

	category:'System-SourceCodeManagement'

!

!AbstractSourceCodeManager class methodsFor:'documentation'!

copyright

"

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

"

    Abstract superclass for sourceCodeManagers.

    Concrete subclasses provide access to a source repository.

    All protocol here traps into subclassResponsbility errors.

    Please read more documentation in concrete subclasses 

    (especially: CVSSourceCodeManager) for how to use this manager.

    [author:]

        Claus Gittinger

"

! !

!AbstractSourceCodeManager class methodsFor:'initialization'!

initCacheDirPath

    "initialize the name of the cacheDirectory.

     This is:

          <tempDir>/stx_sourceCache."

    CacheDirectoryName := (Filename tempDirectory constructString:'stx_sourceCache').

    "

     self initCacheDirPath

    "

    "Modified: / 12.7.1999 / 10:01:31 / cg"

!

initialize

    "setup for no caching and no workTree"

    CachingSources ifNil:[CachingSources := false].

    UseWorkTree    ifNil:[UseWorkTree := false].

! !

!AbstractSourceCodeManager class methodsFor:'accessing'!

availableManagers

    ^ AbstractSourceCodeManager allSubclasses 

        reject:[:cls | (cls isAbstract) or:[cls isExperimental ]].

    "

     self availableManagers   

    "

!

cacheDirectoryName

    "return the name of the cache directory, where checked out class

     sources are kept for faster access. The default is '/tmp/stx_sourceCache'.

     This cache is shared among all ST/X users on a system."

    ^ CacheDirectoryName

    "Modified: 12.9.1996 / 02:20:45 / cg"

!

cacheDirectoryName:aStringOrFilename

    "set the name of the cache directory, where checked out class

     sources are kept for faster access. The default is '/tmp/stx_sourceCache'.

     This cache is shared among all ST/X users on a system.

     The directory is typically set via the launchers setting menu, or

     from a startup rc-file."

    CacheDirectoryName := aStringOrFilename

    "Created: 16.12.1995 / 15:18:43 / cg"

    "Modified: 12.9.1996 / 02:21:35 / cg"

!

cachingSources

    "return true, if source caching is enabled.

     (see cacheDirectoryName for what that means)"

    ^ CachingSources

    "Created: 16.12.1995 / 15:17:50 / cg"

    "Modified: 12.9.1996 / 02:22:19 / cg"

!

cachingSources:aBoolean

    "enable/disable the caching of source files.

     (see cacheDirectoryName for what that means)"

    CachingSources := aBoolean

    "Created: 16.12.1995 / 15:18:13 / cg"

    "Modified: 12.9.1996 / 02:22:42 / cg"

!

defaultManager

    "return the default sourceCodeManager class"

    ^ DefaultManager

    "Created: 7.12.1995 / 17:14:22 / cg"

    "Modified: 12.9.1996 / 02:22:56 / cg"

!

repositoryName

    "return the name of the repository.

     Since this is an abstract class, return nil (i.e. none)"

    ^ nil

    "Modified: 12.9.1996 / 02:20:45 / cg"

    "Created: 14.9.1996 / 13:21:37 / cg"

!

useWorkTree

    "return the setting of useWorkTree, which (eventually)

     controls if an up-to-date view of a CVS working tree should be

     kept in sync. This is not yet implemented."

    ^ UseWorkTree

    "Created: 16.12.1995 / 15:36:48 / cg"

    "Modified: 12.9.1996 / 02:24:01 / cg"

!

useWorkTree:aBoolean

    "enable/disable the useWorkTree feature, which (eventually)

     controls if an up-to-date view of a CVS working tree should be

     kept in sync. This is not yet implemented."

    UseWorkTree := aBoolean

    "Created: 16.12.1995 / 15:37:29 / cg"

    "Modified: 12.9.1996 / 02:24:38 / cg"

!

workTreeDirectoryName

    "return the name of the workTree, which is kept in sync

     with the current class versions. This is not yet implemented"

    ^ WorkTreeDirectoryName

    "Created: 16.12.1995 / 15:35:21 / cg"

    "Modified: 12.9.1996 / 02:25:13 / cg"

!

workTreeDirectoryName:aStringOrFilename

    "set the name of the workTree, which is kept in sync

     with the current class versions. This is not yet implemented"

    WorkTreeDirectoryName := aStringOrFilename

    "Created: 16.12.1995 / 15:35:34 / cg"

    "Modified: 12.9.1996 / 02:25:19 / cg"

! !

!AbstractSourceCodeManager class methodsFor:'basic access'!

checkinClass:aClass fileName:classFileName directory:packageDir module:moduleDir source:sourceFile logMessage:logMessage force:force

    "checkin of a class into the source repository.

     Return true if ok, false if not."

    ^ self subclassResponsibility.

    "Created: 14.2.1997 / 21:17:33 / cg"

    "Modified: 14.2.1997 / 21:18:48 / cg"

!

checkoutModule:aModule directory:aPackage andDo:aBlock

    "check out everything from a package into a temporary directory.

     Then evaluate aBlock, passing the name of that temp-directory.

     Afterwards, the tempDir is removed.

     Return true, if OK, false if any error occurred."

    ^ self subclassResponsibility

    "Created: / 23-08-2006 / 14:07:08 / cg"

!

streamForClass:aClass fileName:classFileName revision:revision directory:packageDir module:moduleDir cache:doCache

    "extract a classes source code and return an open readStream on it.

     A revision of nil selects the current (in image) revision.

     The classes source code is extracted using the revision and the sourceCodeInfo,

     which itself is extracted from the classes packageString."

    ^ self subclassResponsibility

    "Modified: 14.2.1997 / 21:18:35 / cg"

! !

!AbstractSourceCodeManager class methodsFor:'basic administration'!

checkForExistingContainer:fileName inModule:moduleName directory:dirName

    "check for a container to be present"

    ^ self subclassResponsibility.

    "Created: / 13-09-2006 / 18:22:24 / cg"

!

checkForExistingContainer:fileName inPackage:aPackage

    "check if a source-code container is present in a packages directory."

    |packageDir moduleDir|

    packageDir := aPackage asPackageId directory.

    moduleDir := aPackage asPackageId module. 

    ^ self 

        checkForExistingContainer:fileName

        inModule:moduleDir 

        directory:packageDir

    "Created: / 13-09-2006 / 18:10:30 / cg"

!

checkForExistingContainerForClass:aClass

    "check if a source-code container for a given class is present in the repository."

    |sourceInfo packageDir moduleDir classFileName|

    sourceInfo := self sourceInfoOfClass:aClass.

    sourceInfo isNil ifTrue:[

        ('SourceCodeManager [warning]: no sourceInfo for class: ' , aClass name) errorPrintCR.

        ^ false

    ].

    packageDir := self directoryFromSourceInfo:sourceInfo.

    moduleDir := self moduleFromSourceInfo:sourceInfo.  "/ use the modules name as CVS module

    classFileName := self containerFromSourceInfo:sourceInfo.

    ^ self 

        checkForExistingContainer:classFileName 

        inModule:moduleDir 

        directory:packageDir

    "Created: / 13-05-1998 / 22:35:50 / cg"

    "Modified: / 13-09-2006 / 18:23:20 / cg"

!

checkForExistingModule:moduleName

    "check for a module directory to be present"

    ^ self subclassResponsibility.

    "Created: 9.12.1995 / 19:02:23 / cg"

    "Modified: 14.2.1997 / 21:19:01 / cg"

!

checkForExistingModule:moduleDir directory:packageDir

    "check for a package directory to be present"

    ^ self subclassResponsibility.

    "Created: / 23-08-2006 / 14:03:06 / cg"

!

createContainerFor:aClass inModule:moduleName directory:dirName container:fileName

    "create a new container & check into it an initial version of aClass"

    ^ self subclassResponsibility.

    "Created: 9.12.1995 / 19:02:47 / cg"

    "Modified: 14.2.1997 / 21:19:11 / cg"

!

createModule:moduleName

    "create a new module directory"

    ^ self subclassResponsibility.

    "Created: 9.12.1995 / 19:02:23 / cg"

    "Modified: 14.2.1997 / 21:19:16 / cg"

!

createModule:module directory:directory

    "create a new package directory"

    ^ self subclassResponsibility.

    "Created: / 23-08-2006 / 14:04:41 / cg"

!

initialRevisionStringFor:aClass inModule:moduleDir directory:packageDir container:fileName

    "return a string usable as initial revision string"

    ^ self subclassResponsibility

    "Created: / 23-08-2006 / 14:05:42 / cg"

!

revisionLogOf:cls fromRevision:rev1 toRevision:rev2 fileName:classFileName directory:packageDir module:moduleDir 

    "actually do return a revisionLog. The main worker method.

     This must be implemented by a concrete source-code manager"

    ^ self subclassResponsibility.

    "Created: 15.11.1995 / 18:12:51 / cg"

    "Modified: 14.2.1997 / 21:14:01 / cg"

! !

!AbstractSourceCodeManager class methodsFor:'cache administration'!

condenseSourceCache

    "remove all cached old versions (i.e. leave the newest only)"

    |extractBaseAndVersion versionIsGreater vsnNumberString baseName|

    CacheDirectoryName isNil ifTrue:[^ self].

    extractBaseAndVersion := 

        [:filenameString |

            |i|

            i := filenameString size.

            [i > 0 and:[(filenameString at:i) isDigit or:[(filenameString at:i) == $.]]] whileTrue:[ i := i - 1 ].

            vsnNumberString := filenameString copyFrom:i + 1.

            (filenameString at:i) == $_ ifTrue:[i := i - 1].

            baseName := filenameString copyTo:i.

        ].        

    versionIsGreater :=

        [:vA :vB |

            |seqA seqB sequenceIsGreater|

            seqA := (vA asCollectionOfSubstringsSeparatedBy:$.) collect:[:each | Integer readFrom:each].

            seqB := (vB asCollectionOfSubstringsSeparatedBy:$.) collect:[:each | Integer readFrom:each].

            sequenceIsGreater :=

                [:seqA :seqB :index |

                    |elA elB|

                    elA := seqA at:index.

                    elB := seqB at:index.

                    elA > elB ifTrue:[

                        true

                    ] ifFalse:[

                        elA < elB ifTrue:[

                            false

                        ] ifFalse:[

                            sequenceIsGreater value:seqA value:seqB value:index+1.

                        ].

                    ].

                ].

            sequenceIsGreater value:seqA value:seqB value:1.

        ].    

    CacheDirectoryName asFilename withAllDirectoriesDo:[:d |

        |allFiles newestVersions|

        newestVersions := Dictionary new.

        allFiles := d files.

        allFiles do:[:eachFilename |

            |prevVsnString|

            extractBaseAndVersion value:eachFilename baseName.

            vsnNumberString notEmpty ifTrue:[

                prevVsnString := newestVersions at:baseName ifAbsent:nil.

                prevVsnString isNil ifTrue:[

                    newestVersions at:baseName put:vsnNumberString.

                ] ifFalse:[

                    (versionIsGreater value:vsnNumberString value:prevVsnString) ifTrue:[

                        newestVersions at:baseName put:vsnNumberString

                    ]

                ].

            ].

        ].

        allFiles do:[:eachFilename |

            extractBaseAndVersion value:eachFilename baseName.

            (vsnNumberString isEmpty 

            or:[(vsnNumberString ~= (newestVersions at:baseName))]) ifTrue:[

                eachFilename remove

            ]

        ].

    ]

    "

     self condenseSourceCache

    "

    "Modified: / 29-08-2006 / 11:25:25 / cg"

!

flushSourceCache

    "remove all cached versions"

    |d|

    CacheDirectoryName notNil ifTrue:[

        d := CacheDirectoryName asFilename.

        d directoryContentsAsFilenames do:[:eachFile |

            eachFile recursiveRemove

        ]

    ]

    "

     self flushSourceCache

    "

    "Modified: / 29-08-2006 / 11:25:47 / cg"

! !

!AbstractSourceCodeManager class methodsFor:'obsolete backward compatibility'!

checkForExistingContainerInModule:moduleDir directory:packageDir container:fileName

    "check for a container to exist"

    self obsoleteMethodWarning.

    ^ self checkForExistingContainer:fileName inModule:moduleDir directory:packageDir

    "Modified: / 13-09-2006 / 18:23:45 / cg"

!

checkForExistingContainerInModule:moduleName package:dirName container:fileName

    "check for a container to be present"

    self obsoleteMethodWarning.

    ^ self 

        checkForExistingContainer:fileName

        inModule:moduleName 

        directory:dirName

    "Modified: / 13-09-2006 / 18:23:35 / cg"

!

checkForExistingModule:moduleDir package:packageDir

    "check for a package directory to be present"

    self obsoleteMethodWarning.

    ^ self checkForExistingModule:moduleDir directory:packageDir.

    "Created: / 09-12-1995 / 19:02:23 / cg"

    "Modified: / 23-08-2006 / 14:03:25 / cg"

!

checkoutModule:aModule package:aPackage andDo:aBlock

    "check out everything from a package into a temporary directory.

     Then evaluate aBlock, passing the name of that temp-directory.

     Afterwards, the tempDir is removed.

     Return true, if OK, false if any error occurred."

    self obsoleteMethodWarning.

    ^ self checkoutModule:aModule directory:aPackage andDo:aBlock

    "Modified: / 23-08-2006 / 14:07:31 / cg"

!

createModule:module package:package

    "create a new package directory"

    self obsoleteMethodWarning.

    ^ self createModule:module directory:package.

    "Created: / 09-12-1995 / 19:02:23 / cg"