"

 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.

"

'From Smalltalk/X, Version:2.10.8 on 4-nov-1995 at 10:07:36 pm'                 !

Object subclass:#AbstractSourceCodeManager

	 instanceVariableNames:''

	 classVariableNames:'CacheDirectoryName'

	 poolDictionaries:''

	 category:'System-Support'

!

!AbstractSourceCodeManager class methodsFor:'documentation'!

version

"

"

!

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.

"

!

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.

"

! !

!AbstractSourceCodeManager class methodsFor:'initialization'!

initCacheDirPath

    |path|

    path isNil ifTrue:[

	path := OperatingSystem getEnvironment:'TMPPATH'.

	path isNil ifTrue:[

	    path := '/tmp'

	]

    ].

    CacheDirectoryName := path , '/stx_sourceCache'.

! !

!AbstractSourceCodeManager class methodsFor:'source code access'!

sourceStreamFor:aClass

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

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

     which itself is extracted from the classes packageString."

    |classFileName revision packageDir moduleDir sourceInfo cls|

    cls := aClass.

    cls isMeta ifTrue:[

	cls := cls soleInstance

    ].

    revision := cls revision.

    revision isNil ifTrue:[ self halt.

	'SOURCEMGR: class has no revision string' infoPrintNL.

	^ nil.

    ].

    sourceInfo := cls sourceCodeInfo.

    sourceInfo isNil ifTrue:[

	'SOURCEMGR: cannot extract classes sourceInfo' infoPrintNL.

	^ nil

    ].

    packageDir := sourceInfo at:#directory.

    moduleDir := sourceInfo at:#module.  "/ use the modules name as CVS module

    classFileName := Smalltalk fileNameForClass:cls.

    ^ self 

	streamForClass:cls

	fileName:classFileName 

	revision:revision 

	directory:packageDir 

	module:moduleDir

!

mostRecentSourceStreamForClassNamed:aClassOrClassName

    |abbrev classFileName revision packageDir moduleDir sourceInfo cls|

    classFileName := Smalltalk fileNameForClass:aClassOrClassName.

    packageDir := Smalltalk sourceDirectoryNameOfClass:aClassOrClassName.

    moduleDir := 'stx'.

    packageDir isNil ifTrue:[^ nil].

    ^ self 

	streamForClass:nil

	fileName:classFileName 

	revision:#newest 

	directory:packageDir 

	module:moduleDir

    "Created: 6.11.1995 / 16:09:06 / cg"

!

checkinClass:aClass

    |cls sourceInfo tempDir packageDir moduleDir tempFile classFileName|

    cls := aClass.

    cls isMeta ifTrue:[

	cls := cls soleInstance

    ].

    sourceInfo := cls sourceCodeInfo.

    sourceInfo isNil ifTrue:[

	'SOURCEMGR: cannot extract classes sourceInfo' infoPrintNL.

	^ nil

    ].

    packageDir := sourceInfo at:#directory.

    moduleDir := sourceInfo at:#module.  "/ use the modules name as CVS module

    classFileName := Smalltalk fileNameForClass:cls.

    tempDir := (Filename newTemporaryIn:nil) makeDirectory.

    [

	aClass fileOutIn:tempDir.

	(tempFile := tempDir construct:(classFileName,'.st')) exists ifFalse:[

	    'SOURCEMG: temporary fileout failed' infoPrintNL.

	].

	^ self 

	    checkinClass:cls

	    fileName:classFileName 

	    directory:packageDir 

	    module:moduleDir

	    source:(tempFile name)

    ] valueNowOrOnUnwindDo:[

	OperatingSystem recursiveRemoveDirectory:tempDir name

    ].

    "

     SourceCodeManager checkinClass:Array

    "

    "Created: 6.11.1995 / 18:56:00 / cg"

    "Modified: 6.11.1995 / 20:05:17 / cg"

! !

!AbstractSourceCodeManager class methodsFor:'private'!

cacheDirectoryName

    ^ CacheDirectoryName

!

sourceCacheDirectory

    |dir nm|

    (nm := self cacheDirectoryName) isNil ifTrue:[^ nil].

    (dir := nm asFilename) exists ifFalse:[

	dir makeDirectory.

	dir asFilename exists ifFalse:[

	    'SOURCEMGR: could not create cache dir ''' , CacheDirectoryName , '''' infoPrintNL.

	    ^ nil

	].

    ].

    ^ dir

!

    self subclassResponsibility.

    ^ nil

    "Created: 4.11.1995 / 19:09:12 / cg"

    "Modified: 4.11.1995 / 19:15:43 / cg"

! !