"

 COPYRIGHT (c) 1993 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' }"

"{ NameSpace: Smalltalk }"

OrderedCollection subclass:#ChangeSet

	instanceVariableNames:'changedClasses changeSelectors name'

	classVariableNames:'CurrentIfNoCurrentProject'

	poolDictionaries:''

	category:'System-Changes'

!

Object subclass:#ChangeFileReader

	instanceVariableNames:'inputStream parseTree changeAction changeSet selector receiver

		arguments receiverSelector receiverReceiver lineNumber position

		className methodSelector nameSpaceOverride chunk timestamp

		classIsJava'

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

ChangeSet::ChangeFileReader subclass:#BeeChangeFileReader

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

Object subclass:#ChangeFileWriter

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

Error subclass:#ChangeProcessingError

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

SmalltalkChunkFileSourceWriter subclass:#ClassSourceWriter

	instanceVariableNames:'changeSetBeingSaved packageName namespaceName topClassName

		classInfos metaInfos'

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

Object subclass:#ClassInfo

	instanceVariableNames:'name superclass definition comment methods methodDictionary

		namespace primitiveDefinitions primitiveVariables

		primitiveFunctions'

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet::ClassSourceWriter

!

Object subclass:#DiffSet

	instanceVariableNames:'changed onlyInReceiver onlyInArg same'

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

ChangeSet::ChangeFileReader subclass:#DolphinPACFileReader

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

ChangeSet::ChangeFileReader subclass:#GNUSmalltalkFileReader

	instanceVariableNames:'parser'

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

ChangeSet::ChangeFileReader subclass:#GithubPharoSmalltalkFileReader

	instanceVariableNames:'parser'

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

ChangeSet::ChangeProcessingError subclass:#InvalidChangeChunkError

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

ChangeSet::ChangeFileReader subclass:#SIFChangeFileReader

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

!ChangeSet class methodsFor:'documentation'!

copyright

"

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

"

    used in the changes management to keep track of changes

    [author:]

	Claus Gittinger

"

! !

!ChangeSet class methodsFor:'instance creation'!

forExistingClass:aClass

    "build a changeSet for some given class, all of its private classes

     and all extensions if any.

     I.e. a changeSet which represents the existing class in the image.

     That does of course not give deltas, but instead reflects the current

     state of the given class.

     It is useful in conjunction with the other utility methods,

     for example, when building patchLists, diffSets, comparing etc."

    |changeSet s changeObject|

    "/ kludge: could do this much faster...

    s := CharacterWriteStream on:''.

    aClass fileOutOn:s.

    s := s contents readStream.

    changeSet := self fromStream:s.

    "/ fetch the real package info...

    changeSet do:[:eachChange |

        eachChange isMethodChange ifTrue:[

            changeObject := eachChange changeMethod.

            changeObject notNil ifTrue:[

                eachChange package:changeObject package

            ].

        ] ifFalse:[

            eachChange isClassChange ifTrue:[

                changeObject := eachChange changeClass.

                changeObject notNil ifTrue:[

                    eachChange package:changeObject package

                ].

            ].

        ].

    ].

    ^ changeSet

"/    |source changeSet chunk sawExcla lastTimeStamp s change nameSpace|

"/    changeSet := self new.

"/

"/    "/ first, a classDefinition change ...

"/    changeSet addClassDefinitionChangeFor:aClass.

"/    "/ are there any class-instVars ?

"/    aClass class instVarNames size > 0 ifTrue:[

"/        changeSet addInstVarDefinitionChangeFor:aClass class.

"/    ].

"/    "/ a comment ?

"/    aClass comment size > 0 ifTrue:[

"/        changeSet addClassCommentChangeFor:aClass.

"/    ].

"/

"/    "/ class methods first ...

"/    aClass class methodDictionary keysAndValuesDo:[:sel :mthd |

"/        changeSet addMethodChange:mthd in:aClass class.

"/    ].

"/

"/    "/ instance methods ...

"/    aClass methodDictionary keysAndValuesDo:[:sel :mthd |

"/        changeSet addMethodChange:mthd in:aClass.

"/    ].

"/

"/    ^ changeSet

    "

     ChangeSet forExistingClass:ChangeSet

     ChangeSet forExistingClass:A

     Rectangle hasExtensions

     ChangeSet forExistingClass:Rectangle

    "

    "Created: / 16-02-1998 / 12:19:34 / cg"

    "Modified: / 12-10-2006 / 23:45:14 / cg"

    "Modified (format): / 01-12-2011 / 19:10:22 / cg"

    "Modified: / 12-07-2019 / 14:02:20 / Stefan Reise"

!

forExistingClass:aClass withExtensions:withExtensions

    "build a changeSet for some given full class with or without extensions.

     That does of course not give deltas, but instead reflects the current

     state of the given class.

     It is useful in conjunction with the other utility methods,

     for example, when building patchLists, diffSets etc."

    ^ self

	forExistingClass:aClass

	withExtensions:withExtensions

	withLooseMethods:false

	extensionsOnly:false

    "

     Object hasExtensions

     Object extensions size

     (ChangeSet forExistingClass:Object) size

     (ChangeSet forExistingClass:Object withExtensions:false) size

     (ChangeSet forExistingClass:stx_libbasic3 withExtensions:false)

    "

    "Created: / 12-10-2006 / 18:13:02 / cg"

    "Modified: / 12-10-2006 / 23:46:05 / cg"

!

forExistingClass:aClass withExtensions:withExtensions extensionsOnly:extensionsOnly

    "build a changeSet for some given full class, the base-class or the extensions only,

     as specified by the with-arguments.

     That does of course not give deltas, but instead reflects the current

     state of the given class.

     It is useful in conjunction with the other utility methods,

     for example, when building patchLists, diffSets etc."

    ^ self

	forExistingClass:aClass

	withExtensions:withExtensions

	withLooseMethods:false

	extensionsOnly:extensionsOnly

    "

     ChangeSet forExistingClass:ChangeSet

     Rectangle hasExtensions

     Rectangle extensions

     ChangeSet forExistingClass:Rectangle withExtensions:true extensionsOnly:false

     ChangeSet forExistingClass:Rectangle withExtensions:false extensionsOnly:false

     ChangeSet forExistingClass:Rectangle withExtensions:false extensionsOnly:true

    "

    "Created: / 12-10-2006 / 18:13:02 / cg"

    "Modified: / 12-10-2006 / 23:46:05 / cg"

!

forExistingClass:aClass withExtensions:withExtensions withLooseMethods:withLooseMethods

    "build a changeSet for some given full class with or without extensions.

     That does of course not give deltas, but instead reflects the current

     state of the given class.

     It is useful in conjunction with the other utility methods,

     for example, when building patchLists, diffSets etc."

    ^ self

	forExistingClass:aClass

	withExtensions:withExtensions

	withLooseMethods:withLooseMethods

	extensionsOnly:false

    "

     Object hasExtensions

     Object extensions size

     (ChangeSet forExistingClass:Object) size

     (ChangeSet forExistingClass:Object withExtensions:false) size

     (ChangeSet forExistingClass:stx_libbasic3 withExtensions:false)

    "

    "Created: / 12-10-2006 / 18:13:02 / cg"

    "Modified: / 12-10-2006 / 23:46:05 / cg"

!

forExistingClass:aClass withExtensions:withExtensions withLooseMethods:withLooseMethods extensionsOnly:extensionsOnly

    "build a changeSet for some given full class, the base-class or the extensions only,

     as specified by the with-arguments.

     That does of course not give deltas, but instead reflects the current

     state of the given class.

     It is useful in conjunction with the other utility methods,

     for example, when building patchLists, diffSets etc."

    |changeSet classPackage notInClassesPackage realExtensions looseMethods|

    changeSet := self forExistingClass:aClass.

    classPackage := aClass package.

    notInClassesPackage :=

		[:change |

		    change isMethodChange

		    and:[ change package ~= classPackage ]

		].

    realExtensions :=

		[:change |

		    change isMethodChange

		    and:[ change package ~= classPackage

		    and:[ change package ~~ PackageId noProjectID ]]

		].

    looseMethods :=

		[:change |

		    change isMethodChange

		    and:[change package == PackageId noProjectID ]

		].

    extensionsOnly ifTrue:[

	withLooseMethods ifTrue:[

	    ^ changeSet select:notInClassesPackage

	].

	^ changeSet select:realExtensions.

    ].

    withExtensions ifFalse:[

	withLooseMethods ifFalse:[

	    ^ changeSet reject:notInClassesPackage

	].

	^ changeSet reject:realExtensions.

    ].

    withLooseMethods ifFalse:[

	^ changeSet reject:looseMethods.

    ].

    ^ changeSet

    "

     ChangeSet forExistingClass:ChangeSet

     Rectangle hasExtensions

     Rectangle extensions

     ChangeSet forExistingClass:Rectangle withExtensions:true extensionsOnly:false

     ChangeSet forExistingClass:Rectangle withExtensions:false extensionsOnly:false

     ChangeSet forExistingClass:Rectangle withExtensions:false extensionsOnly:true

    "

    "Created: / 12-10-2006 / 18:13:02 / cg"

    "Modified: / 12-10-2006 / 23:46:05 / cg"

!

forExistingMethods:aCollectionOfMethods

    "build a changeSet for a collection of methods in the image.

     That does of course not give deltas, but instead reflects the current

     state of the given set of methods.

     It is useful in conjunction with the other utility methods,

     for example, when building patchLists, diffSets etc."

    |changeSet stream previousPackage|

    changeSet := self new.

    aCollectionOfMethods do:[:eachMethod |

        |change source|

        source := eachMethod source.

        source isNil ifTrue:[

            Transcript showCR:'oops - no source for ',eachMethod whoString.

        ].

        change := MethodDefinitionChange new.

        eachMethod mclass notNil ifTrue:[ change className:eachMethod mclass name ].

        source notNil ifTrue:[ change source:source ].

        change selector:eachMethod selector.

        change package:(eachMethod package).

        change category:(eachMethod category).

        changeSet add:change.

    ].

"/    stream := ReadWriteStream on:''.

"/    aCollectionOfMethods do:[:eachMethod |

"/        previousPackage ~= eachMethod package ifTrue:[

"/            stream nextPutAll:'"{ Package: '''.

"/            stream nextPutAll:eachMethod package asString.

"/            stream nextPutAll:''' }"'; cr; cr.

"/        ].

"/        eachMethod mclass fileOutMethod:eachMethod on:stream

"/    ].

"/    stream reset.

"/    changeSet := self fromStream:stream.

"/    changeSet do:[:eachChange |

"/        eachChange package:(eachChange changeMethod package).

"/    ].

    ^ changeSet

    "

     ChangeSet forExistingMethods:(Array with:(Array compiledMethodAt:#at:)

                                         with:(Object compiledMethodAt:#at:)

                                         with:(Behavior compiledMethodAt:#compiledMethodAt:) )

    "

    "Modified: / 17-09-2011 / 10:26:03 / cg"

!

forPackage: pkg

    "build a changeSet for a given package in the image"

    ^self forPackage: pkg ignoreAutoloaded: false.

    "Created: / 20-05-2008 / 17:56:18 / Jan Vrany <vranyj1@fel.cvut.cz>"

    "Modified: / 12-08-2009 / 14:23:15 / Jan Vrany <vranyj1@fel.cvut.cz>"

!

forPackage: pkg ignoreAutoloaded: ignoreAutoloaded

    "build a changeSet for a given package in the image"

    |changeSet packageClasses packageExtensions|

    packageClasses := ProjectDefinition searchForClassesWithProject: pkg.

    packageClasses := packageClasses select:[:each | each programmingLanguage isSmalltalk ].

    packageExtensions := ProjectDefinition searchForExtensionsWithProject: pkg.

    packageExtensions := packageExtensions select:[:each | each programmingLanguage isSmalltalk ].

    changeSet := self forExistingMethods: packageExtensions.

    packageClasses do:[:cls|

        (ignoreAutoloaded not and:[cls isLoaded not]) ifTrue:[cls autoload].

        cls isLoaded ifTrue: [

            changeSet addAll: (self forExistingClass:cls withExtensions:false)

        ]

    ].

    changeSet name: 'Package ' , pkg.

    ^changeSet

    "Created: / 12-08-2009 / 14:22:44 / Jan Vrany <vranyj1@fel.cvut.cz>"

    "Modified: / 31-07-2014 / 09:51:55 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

fromBeeStream:aStream

    "build a changeSet from a Bee Smalltalk .bsc format stream, containing chunks.

     Return the changeSet."

    ^ self fromBeeStream:aStream while:[:thisChange | true]

    "Created: / 21-08-2014 / 18:34:01 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

fromBeeStream:aStream while:aConditionBlock

    "build a changeSet from a Bee Smalltalk .bsc stream, containing chunks

     Pass each change to the conditionBlock and stop whenever that

     returns false. This allows skipping reamaining chunks, and speeding up

     reading, if only parts need to be extracted

     (for example: only documentation methods).

     Return the changeSet."

    |changeSet|

    changeSet := self new.

    self

	changesFromStream:aStream

	for:changeSet

	reader:(BeeChangeFileReader new)

	do:[:aChange :lineNumberOrNil :posOrNil |

	    changeSet add:aChange.

	    (aConditionBlock value:aChange) ifFalse:[^ changeSet].

	].

    ^ changeSet

    "Created: / 21-08-2014 / 18:34:31 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!