"

 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.

"

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 one of:

          STX_TMPPATH/stx_sourceCache

          TMPPATH/stx_sourceCache

          TMPDIR/stx_sourceCache

          /tmp/stx_sourceCache.

     whichever variable is first found to be nonEmpty."

    |path|

    path := OperatingSystem getEnvironment:'STX_TMPPATH'.

    path isNil ifTrue:[

        path := OperatingSystem getEnvironment:'TMPPATH'.

        path isNil ifTrue:[

            path := OperatingSystem getEnvironment:'TMPDIR'.

            path isNil ifTrue:[

                path := '/tmp'

            ]

        ]

    ].

    CacheDirectoryName := path , '/stx_sourceCache'.

    "Modified: 12.9.1996 / 02:27:48 / cg"

!

initialize

    "setup for no caching and no workTree"

    CachingSources := UseWorkTree := false.

    CacheDirectoryName := WorkTreeDirectoryName := ''.

    "Created: 16.12.1995 / 15:41:00 / cg"

    "Modified: 12.9.1996 / 02:28:11 / cg"

! !

!AbstractSourceCodeManager class methodsFor:'accessing'!

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

    "Modified: 14.2.1997 / 21:18:35 / 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'!

checkForExistingContainerForClass:aClass

    |sourceInfo packageDir moduleDir classFileName|

    sourceInfo := self sourceInfoOfClass:aClass.

    sourceInfo isNil ifTrue:[

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

        ^ false

    ].

    packageDir := self packageFromSourceInfo:sourceInfo.

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

    classFileName := self containerFromSourceInfo:sourceInfo.

    ^ self checkForExistingContainerInModule:moduleDir package:packageDir container:classFileName

    "Created: / 13.5.1998 / 22:35:50 / cg"

!

checkForExistingContainerInModule:moduleName package:dirName container:fileName

    "check for a container to be present"

    ^ self subclassResponsibility.

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

    "Modified: 14.2.1997 / 21:18:56 / 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 package:packageDir

    "check for a package directory to be present"

    ^ self subclassResponsibility.

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

    "Modified: 14.2.1997 / 21:19: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 package:package

    "create a new package directory"

    ^ self subclassResponsibility.

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

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

!

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

    "return a string usable as initial revision string"

    ^ self subclassResponsibility

    "Created: 14.2.1997 / 21:01:41 / cg"

!

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

    "remove a container"

    ^ self subclassResponsibility.

    "Created: 11.9.1996 / 13:18:33 / cg"

    "Modified: 14.2.1997 / 21:19:28 / 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"

!

writeHistoryLogSince:timeGoal filterSTSources:filter filterUser:userFilter to:aStream

    "send a full historyLog to some stream.

     Must be implemented by a concrete subclass."

    ^ self subclassResponsibility

    "Modified: 14.2.1997 / 21:13:51 / cg"

! !

!AbstractSourceCodeManager class methodsFor:'private'!

containerFromSourceInfo:info

    "given a sourceInfo, return the classes container"

    (info includesKey:#fileName) ifTrue:[

        ^ info at:#fileName

    ].

    (info includesKey:#expectedFileName) ifTrue:[

        ^ info at:#expectedFileName

    ].

    ^ (info at:#classFileNameBase) , '.st'

    "Modified: 12.9.1996 / 02:31:52 / cg"

!

directoryFromContainerPath:containerPath

    "given a full path as in an RCS header, 

     extract the directory (i.e. package)."

    |path idx|

    path := self pathInRepositoryFrom:containerPath.

    path isNil ifTrue:[^ nil].

    "/ these are always UNIX filenames ...

    idx := path indexOf:$/.

    idx ~~ 0 ifTrue:[

        path := path copyFrom:(idx + 1)

    ].

    "/ the code below used to be:

    "/     ^ path asFilename directoryName

    "/ however, that only works under UNIX, since

    "/ we MUST return a unix pathname here.

    "/ therefore, do what unix would do here ...

    idx := path lastIndexOf:$/.

    idx == 0 ifTrue:[

        "/ huh ?

        ^ path

    ].

    ^ path copyTo:(idx - 1)

    "

     CVSSourceCodeManager directoryFromContainerPath:'/files/CVS/stx/libbasic/Array.st'

    "

    "Created: / 25.9.1998 / 15:37:06 / cg"

    "Modified: / 25.9.1998 / 15:38:59 / cg"

!

filenameFromContainerPath:containerPath

    "given some path as present in an RCS Header string, extract the containers

     name.

     OBSOLETE - this is no longer used."

    |top rest|

    containerPath notNil ifTrue:[

        top := self repositoryTopDirectory.

        top notNil ifTrue:[

            (containerPath startsWith:(top , '/')) ifTrue:[

                rest := containerPath copyFrom:(top size + 2).

                ^ rest asFilename baseName

            ].

            (containerPath startsWith:(top)) ifTrue:[

                rest := containerPath copyFrom:(top size + 1).

                ^ rest asFilename baseName

            ]

        ]

    ].

    ^ containerPath

    "Created: 25.11.1995 / 18:42:34 / cg"

    "Modified: 11.11.1996 / 16:04:39 / cg"

!

moduleFromContainerPath:containerPath

    "given a full path as in an RCS header, extract the module."

    |path idx|

    path := self pathInRepositoryFrom:containerPath.

    path isNil ifTrue:[^ nil].

    "/ these are always UNIX filenames

    idx := path indexOf:$/.

    idx == 0 ifTrue:[^ path].

    ^ path copyTo:(idx - 1)

    "

     SourceCodeManager moduleFromContainerPath:'/files/CVS/stx/libbasic/Array.st'

    "

    "Created: / 25.11.1995 / 18:42:20 / cg"

    "Modified: / 11.8.1998 / 23:01:24 / cg"

!

moduleFromSourceInfo:info

    "given a sourceInfo, return the classes module directory"

    ^ info at:#module.  "/ use the modules name as CVS module

    "Created: 6.2.1996 / 17:26:38 / cg"

    "Modified: 12.9.1996 / 02:32:23 / cg"

!

packageFromSourceInfo:info

    "given a sourceInfo, return the classes package directory"

    ^ info at:#directory.

    "Created: 6.2.1996 / 17:26:23 / cg"

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

!

pathInRepositoryFrom:containerPath

    "this tries to extract the path within a repository, given some path

     as present in an RCS Header string.

     Typically, this ought to be that string directly; 

     however, if the repository directory is accessed via a symbolic link during

     ci/co, some systems extract different strings with co.

     One such system here had a symbolic link from /phys/ibm/CVS... to /file/CVS,

     and extracted sources had /phys/ibm/CVS in their header.

     Do not depend on the code below to work correctly all the time."

    |top lastTop idx|

    containerPath notNil ifTrue:[

        top := self repositoryTopDirectory.

        top notNil ifTrue:[

            (containerPath startsWith:(top , '/')) ifTrue:[

                ^ containerPath copyFrom:(top size + 2).

            ].

            (containerPath startsWith:(top)) ifTrue:[

                ^ containerPath copyFrom:(top size + 1).

            ].

            "/ hardcase - the repository-filename in the versionInfo

            "/ does no match my repository top.

            "/ check for mangled prefix (happens with symbolic links)

            lastTop := '/' , top asFilename baseName, '/'.

            idx := containerPath indexOfSubCollection:lastTop.

            idx ~~ 0 ifTrue:[

                ('SourceCodeManager [warning]: warning: repository path mismatch: ' , (containerPath copyTo:idx-1) , lastTop , ' vs. ' , top , '/') infoPrintCR.

                'SourceCodeManager [info]: warning: assuming that mismatch is ok.' infoPrintCR.

                ^ containerPath copyFrom:(idx + lastTop size).

            ]

        ]

    ].