"

 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' }"

OrderedCollection subclass:#ChangeSet

	instanceVariableNames:'changedClasses changeSelectors name'

	classVariableNames:''

	poolDictionaries:''

	category:'System-Changes'

!

Object subclass:#ChangeFileReader

	instanceVariableNames:'inputStream parseTree changeAction changeSet selector receiver

		arguments receiverSelector receiverReceiver lineNumber position

		className methodSelector chunk'

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

Error subclass:#ChangeProcessingError

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

SmalltalkChunkFileSourceWriter subclass:#ClassSourceWriter

	instanceVariableNames:'changeSetBeingSaved namespaceName topClassName classInfos

		metaInfos'

	classVariableNames:''

	poolDictionaries:''

	privateIn:ChangeSet

!

Object subclass:#ClassInfo

	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::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 := ReadWriteStream on:''.

    aClass fileOutOn:s.

    s reset.

    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"

!

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."

    |changeSet classPackage|

    changeSet := self forExistingClass:aClass.

    classPackage := aClass package.

    extensionsOnly ifTrue:[

        ^ changeSet 

            select:[:change |

                change isMethodChange and:[ change package ~= classPackage ]

            ].

    ].

    withExtensions ifFalse:[

        ^ changeSet 

            reject:[:change |

                change isMethodChange and:[ change package ~= classPackage ]

            ].

    ].

    ^ 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.

     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: package

    ^self forPackage: package 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: package ignoreAutoloaded: ignoreAutoloaded

    "build a changeSet for a given package"

    |changeSet packageClasses packageExtensions|

    packageClasses := ProjectDefinition searchForClassesWithProject: package.

    packageExtensions := ProjectDefinition searchForExtensionsWithProject: package.

    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

                        extensionsOnly:false)]].

    changeSet name: 'Package ' , package.

    ^changeSet

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

    "Modified: / 16-03-2012 / 15:37:10 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

fromDiffSet:aDiffSet

    "build a changeSet from a given diffSet. This can be used as a patchSet,

     to update the first-version in the diffSet to the second-version"

    |changeSet|

    changeSet := self new.

    "/ class definitions first...

    changeSet addAll:((aDiffSet changed collect:[:eachPair | eachPair second]) select:[:ch | ch isClassDefinitionChange]).

    changeSet addAll:((aDiffSet onlyInArg) select:[:ch | ch isClassDefinitionChange]).

    "/ first add new methods...

    changeSet addAll:((aDiffSet onlyInArg) reject:[:ch | ch isClassDefinitionChange]).

    "/ then, changed methods...

    changeSet addAll:((aDiffSet changed collect:[:eachPair | eachPair second]) reject:[:ch | ch isClassDefinitionChange]).

    "/ then, removed methods...

    aDiffSet onlyInReceiver do:[:each |

        |ch|

        ch := MethodRemoveChange className:(each className) selector:(each selector).

        changeSet add:ch.

    ].

    ^ changeSet

    "Created: / 08-02-2011 / 10:48:36 / cg"

!

fromDirectory: aStringOfFilename

    | d cs |

    d := aStringOfFilename asFilename.

    cs := self new.    

    d directoryContentsAsFilenames do:

        [:each|

        each suffix = 'st' ifTrue:

            [cs addAll: (self fromFileOrDirectory: each)]].

    cs name: aStringOfFilename asFilename asAbsoluteFilename pathName.

    ^cs

    "

        ChangeSet fromDirectory: (Smalltalk getPackageDirectoryForPackage:'stx:libbasic')

    "

    "Created: / 02-04-2011 / 00:54:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

fromDolphinPACStream:aStream

    "build a changeSet from a stream, containing dolphin pac file chunks."

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

!

fromDolphinPACStream:aStream while:aConditionBlock

    "build a changeSet from a stream, containing dolphin pac file chunks."

    |changeSet|

    changeSet := self new.

    self 

        changesFromStream:aStream 

        for:changeSet 

        reader:(DolphinPACFileReader new) 

        do:[:aChange :lineNumberOrNil :posOrNil |

            changeSet add:aChange.

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

        ].

    ^ changeSet

!

fromFile:aFilename

    |mime stream nm|

    nm := aFilename asFilename asAbsoluteFilename pathName.

    mime := MIMETypes mimeTypeForFilename:aFilename.

    mime isNil ifTrue:[

        mime := aFilename asFilename mimeTypeOfContents.

        mime isNil ifTrue:[

            self error:'unknown MIME type for file'.

        ].

    ].

    [

        stream := aFilename asFilename readStream.

        mime = 'text/xml' ifTrue:[

            ^ (self fromXMLStream:stream) name: nm; yourself.

        ].

        mime = 'application/x-smalltalk-source-sif' ifTrue:[

            ^ (self fromSIFStream:stream) name: nm; yourself

        ].

        mime = 'application/x-smalltalk-dolphin-package' ifTrue:[

            ^ (self fromDolphinPACStream:stream) name: nm; yourself

        ].            

        stream := EncodedStream decodedStreamFor:stream.

        ^ (self fromStream:stream) name: nm; yourself

    ] ensure:[

        stream notNil ifTrue:[stream close].

    ].

    "

     ChangeSet fromFile:('changes')

     ChangeSet fromFile:('patches')

    "

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

    "Modified: / 14-12-1999 / 15:23:16 / cg"

    "Modified: / 16-03-2012 / 15:46:23 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

fromFileOrDirectory: fileOrDirectory

    | f |

    f := fileOrDirectory asFilename.

    ^(f isDirectory 

        ifTrue:[self fromDirectory: f]

        ifFalse:[self fromFile: f])

        name: f pathName;

        yourself.

    "

        ChangeSet fromFileOrDirectory: (Smalltalk getPackageDirectoryForPackage:'stx:libbasic')

    "

    "Created: / 02-04-2011 / 00:50:29 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

fromSIFStream:aStream

    "build a changeSet from a SIF stream, containing chunks

     in smalltalk interchange format.

     Return the changeSet."

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

!

fromSIFStream:aStream while:aConditionBlock

    "build a changeSet from a SIF stream, containing chunks

     in smalltalk interchange format.

     Return the changeSet."

    |changeSet|

    changeSet := self new.

    self 

        changesFromStream:aStream 

        for:changeSet 

        reader:(SIFChangeFileReader new) 

        do:[:aChange :lineNumberOrNil :posOrNil |

            changeSet add:aChange.

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

        ].

    ^ changeSet

!

fromStream:aStream

    "build a changeSet from a stream, containing chunks.

     (i.e. either a classes sourceFile or a change-file).

     Return the changeSet."

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

    "

     ChangeSet fromStream:('changes' asFilename readStream)

     ChangeSet fromStream:('patches' asFilename readStream)

     ChangeSet fromStream:(Object source asString readStream)

    "

    "Created: / 16.2.1998 / 12:19:34 / cg"

    "Modified: / 14.12.1999 / 15:23:16 / cg"

!

fromStream:aStream while:aConditionBlock

    "build a changeSet from a stream, containing chunks.

     (i.e. either a classes sourceFile or a change-file).