"

 COPYRIGHT (c) 2003 by eXept Software AG

	      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: Packages }"

AbstractPackage subclass:#Package

	instanceVariableNames:'packageHandler packagedClasses packagedMethods packageComment

		prerequisites scripts isDirty isInstalled packageVersion

		overriddenClassChanges overriddenMethodChanges blockedMethods'

	classVariableNames:''

	poolDictionaries:''

	category:'Package'

!

Package class instanceVariableNames:'CurrentPackage'

"

 No other class instance variables are inherited by this class.

"

!

Object subclass:#PackagedClass

	instanceVariableNames:'name package instanceDefinition classDefinition

		instanceVariableNames classVariableNames

		classInstanceVariableNames poolDictionaries category'

	classVariableNames:''

	poolDictionaries:''

	privateIn:Package

!

Object subclass:#ClassSide

	instanceVariableNames:'instanceSide'

	classVariableNames:''

	poolDictionaries:''

	privateIn:Package::PackagedClass

!

Object subclass:#PackagedMethod

	instanceVariableNames:'name package category source ownedClassName'

	classVariableNames:''

	poolDictionaries:''

	privateIn:Package

!

Object subclass:#PackagedScript

	instanceVariableNames:'string receiver'

	classVariableNames:''

	poolDictionaries:''

	privateIn:Package

!

!Package class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 2003 by eXept Software AG

	      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

"

    documentation to be added.

    [author:]

	 (james@miraculix)

    [instance variables:]

	blockedMethods                <Dictionary>

					    A reference of methods that the receiver is NOT responsible for

					    but the receiver is responsible for the method's class. It usage is

					    the same as a filter would be.

	overriddenChanges                <Dictionary1><Dictionary2><Dictionary3>

					    This variable helps the receiver keep its original state. When a

					    method changes it is held here so we can get the original. So the package

					    is still responsible for the overridden changes.

					    There are two way items can become added to overriddenChanges:

						1) through loading packages - too many of these may not be desirable.

						2) through editing a package - default package 'overrides it!!'

					    DESIGN: it is designed with dictionaries containing dictionaries as - for the

						time being - to cope with different types of change. At the moment being

						methodChanges (and soon classChanges). It is easier to search for changes

						by using this hierarchy of dictionaries, and - i think - it is quite

						extendable.

						The only problem i can see with it is lingering dictionaries which are not deleted

						when they contain nothing.

    [class variables:]

    [see also:]

"

!

examples

"

   more  examples to be added:

								[exBegin]

    ... add code fragment for

    ... executable example here ...

								[exEnd]

"

!

history

    "Created: / 31.3.2003 / 16:45:04 / james"

! !

!Package class methodsFor:'instance creation'!

named:aString

    "create a new package named aString "

    ^ self named:aString asSymbol addToManager:nil.    "or 'self defaultPackageManager'"

!

named:aString addToManager:aManager

    ^ self named:aString withClasses:nil withMethods:nil addToManager:aManager

!

named:aString withClasses:classes

    ^ self named:aString withClasses:classes withMethods:nil addToManager:nil

!

named:aString withClasses:classes withMethods:methods addToManager:aManager

    "create a new package named aString "

    |anInstance |

    anInstance := self new name:aString.

    classes ifNotNil:[

	anInstance addedClasses:classes.

    ].

    methods ifNotNil:[

	anInstance addedMethods:methods.

    ].

    aManager ifNotNil:[

	aManager addPackage:anInstance.

    ].

    ^ anInstance

!

named:aString withMethods:methods

    ^ self named:aString withClasses:nil withMethods:methods addToManager:nil

! !

!Package class methodsFor:'defaults'!

defaultBlockedMethodsCollection

    ^ Dictionary new

!

defaultOverriddenChangesCollection

    "a dictionary of sets. The keys are the classes and

    the sets are a collection of selectors!!"

    ^ Dictionary new

!

defaultPackagedClassesCollection

    ^ Dictionary new

!

defaultPackagedMethodsCollection

    ^ Dictionary new

!

defaultPrerequisiteCollection

    ^ PrerequisiteCollection new

!

defaultScriptsCollection

    ^ IdentityDictionary new

!

newDefaultPackage

    ^ self named:(Project noProjectID).

!

packageManager

    ^ self packageManagerClass smalltalkPackageManager.

!

packageManagerClass

    ^ PackageManager.

! !

!Package class methodsFor:'private - instance creation'!

new

    "creates a new package and initialize's"

    | anInstance |

    anInstance := self basicNew initialize.

    ^ anInstance

! !

!Package methodsFor:'accessing'!

blockedMethods

    "return the value of the instance variable 'blockedMethods' (automatically generated)"

    ^ blockedMethods

!

blockedMethods:something

    "set the value of the instance variable 'blockedMethods' (automatically generated)"

    blockedMethods := something.

!

blockedMethodsAtClassNamed:arg

    ^ (blockedMethods at:arg ifAbsent:[nil])

!

blockedMethodsAtClassNamed:aClassName ifAbsentPut:anObject

    ^ blockedMethods at:aClassName ifAbsentPut:anObject

!

blockedMethodsRemoveAtClassNamed:arg ifAbsent:aBlock

    ^ (blockedMethods removeKey:arg ifAbsent:aBlock)

!

classNames

    ^ self packagedClasses values collect:[:aPackagedClass |

	aPackagedClass name

    ].

!

classPrerequisites

    ^ prerequisites select:[:aPre |

	aPre isClassPrerequisite

    ].

!

filename

    "return the value of the instance variable 'filename' (automatically generated)"

    ^ packageHandler filename

!

getInterestedMethodsFromClass:aClass

    | aClassName |

    aClassName := aClass name.

    ^ aClass methodDictionary copy values select:[:aMethod |

	self definesSelector:aMethod name forClassNamed:aClassName

    ]

!

getInterestedPackagedMethodsFromClass:aClass

    | aClassName aPackagedClass|

    aClassName := aClass name.

    (aPackagedClass := self packagedClassNamed:aClassName) ifNotNil:[

	^ aPackagedClass packagedMethods

    ].

    ^ (packagedMethods at:aClassName ifAbsent:[^ OrderedCollection new ]) values

"/    ^ aClass methodDictionary copy values collectAndselect:[:aMethod |

"/        self definesSelector:aMethod name forClassNamed:aClassName

"/    ]

"/

!

isDirty

   "has the receiver been changed by adding scripts or added classes since the

    time it is loaded. This instance variable is NOT affected by changes in the image!!

    but it could be worked out by looking at the receivers variables!!"

   ^ isDirty "? true" "not needed because set by initialize"

!

isDirty:aBoolean

    isDirty := aBoolean

!

isInstalled

    "return the value of the instance variable 'isInstalled' (automatically generated)"

    ^ isInstalled

!

isInstalled:something

    "set the value of the instance variable 'isInstalled' (automatically generated)"

    isInstalled := something.

!

looseMethodAtClass:aClassName atMethodName:aMethodName

    self looseMethods do:[:aLooseMethod |

	((aLooseMethod name == aMethodName) and:[

	    aLooseMethod className == aClassName]) ifTrue:[

		^ aLooseMethod

	].

    ].

    ^ nil

!

looseMethods

    | col mthdInImage |

    col := OrderedCollection new.

    self packagedMethods keysAndValuesDo:[:key :aDic | | looseMethodsInKey|

	looseMethodsInKey := aDic keysAndValuesDo:[:selector :aPackagedMethod  | |collectValue|

	    aPackagedMethod isLoose ifTrue:[

		mthdInImage := aPackagedMethod methodInImage.

		   col add:aPackagedMethod.

	    ].

	].

    ].

    ^ col.

!

packageComment

    "return the value of the instance variable 'packageComment' (automatically generated)"

    ^ packageComment

!

packageComment:something

    "set the value of the instance variable 'packageComment' (automatically generated)"

    packageComment := something.

!

packageHandler

    "return the value of the instance variable 'packageHandler' (automatically generated)"

    packageHandler isNil ifTrue:[

	packageHandler := PackageHandler forPackage:self.

    ].

    ^ packageHandler

!

packageHandler:something

    "set the value of the instance variable 'packageHandler' (automatically generated)"

    packageHandler := something.

!

packagePrerequisites

    ^ prerequisites select:[:aPre |

	aPre isPackagePrerequisite

    ].

!

packageType

    ^ 'STX Package' copy.

!

packageVersion

    "return the value of the instance variable 'packageVersion' (automatically generated)"

    ^ packageVersion

!

packageVersion:something

    "set the value of the instance variable 'packageVersion' (automatically generated)"

    packageVersion := something.

!

packagedClasses

    "return the value of the instance variable 'packagedClasses' (automatically generated)"

    ^ packagedClasses

!

packagedMethods

    "return the value of the instance variable 'packagedMethods' (automatically generated)"

    ^ packagedMethods

!

packagedMethodsAtClassName:arg ifAbsent:aBlock

    ^ (packagedMethods at:arg ifAbsent:aBlock)

!

packagedMethodsAtClassNamed:arg

    ^ (self packagedMethodsAtClassNamed:arg ifAbsent:[])

!

packagedMethodsAtClassNamed:arg ifAbsent:aBlock

    ^ (packagedMethods at:arg ifAbsent:aBlock)

!

packagedMethodsAtClassNamed:arg ifAbsentPut:aBlock

    ^ (packagedMethods at:arg ifAbsentPut:aBlock)

!

packagedMethodsForClass:arg ifAbsent:aBlock

    ^ (packagedMethods at:arg ifAbsent:aBlock)

!

prerequisites

    "return the value of the instance variable 'prerequisites' (automatically generated)"

    ^ prerequisites

!

scripts

    "return the value of the instance variable 'scripts' (automatically generated)"

    ^ scripts

! !

!Package methodsFor:'adding & removing'!

addBlockedMethodNamed:aMethodName forClassNamed:aClassName

    ^ (self blockedMethodsAtClassNamed:aClassName ifAbsentPut:[Set new]) add:aMethodName.

!

addOverriddenClassChange:aPackagedClass byPackageNamed:byPackageName

    "add an overridden method. under #package -> #className -> #classChangeNamespace -> aPackagedClass"

    | className |

    self assert:(byPackageName isSymbol).

    className := aPackagedClass name.

    ((overriddenClassChanges at:byPackageName ifAbsentPut:[Set new])

	add:className)

!

addOverriddenMethodChange:aPackagedMethod byPackageNamed:byPackageNamed

    "add an overridden method. under #package -> #methodClassName -> #packagedMethod"

    | methodClassName |

    methodClassName := aPackagedMethod ownedClassName.

    "so that we have this method stored"

    self addPackagedMethod:aPackagedMethod.

    (((overriddenMethodChanges at:byPackageNamed ifAbsentPut:[Dictionary new])

	at:methodClassName ifAbsentPut:[Set new]) add:aPackagedMethod name)

!

addPackagedClass:aPackagedClass

    "adds a class to the receiver.

     NOTE: Does not mark the receiver as dirty.

     That is the responsibility of the called of this method!!"

    aPackagedClass isClass ifTrue:[

	self error:'I am expected a PackagedClass not a Class'.

    ].

    self packagedClasses at:aPackagedClass name put:(aPackagedClass).

    ^ aPackagedClass

!

addPackagedMethod:aPackagedMethod

    "add or replace aPackagedMethod from the receiver"

    | aPackagedMethodsOwnedClass |

    aPackagedMethodsOwnedClass := aPackagedMethod ownedClassName.

    ^ (self packagedMethodsAtClassNamed:aPackagedMethodsOwnedClass ifAbsentPut:[Dictionary new])

		at:aPackagedMethod name put:aPackagedMethod.

!

addPackagedMethods:somePackageMethods

    somePackageMethods do:[:aPackageMethod |

	self addPackagedMethod:aPackageMethod copy.

    ].

    ^ somePackageMethods

!

addPrerequisite:aPrerequisite

    prerequisites add:aPrerequisite

!

addedPackagedClasses:somePackagedClasses

    somePackagedClasses do:[:each |

	self addedPackagedClass:each

    ].

    ^ somePackagedClasses

!

packagedClassesRemoveAtClassName:aKey ifAbsent:aBlock

    ^ self packagedClasses removeKey:aKey ifAbsent:aBlock

!

removeBlockedMethodNamed:aMethodName forClassNamed:aClassName

    ^ (self blockedMethodsAtClassNamed:aClassName) remove:aMethodName.

!

removeBlockedMethodsForClassNamed:aClassName ifAbsent:aBlock

    ^ (blockedMethods removeKey:aClassName ifAbsent:aBlock).

!

removeOverriddenMethodNamed:aMethodName forClassNamed:aClassName

    ^ self

	removeOverriddenMethodNamed:aMethodName

	forClassNamed:aClassName

	ifAbsent:[self error:'trying to remove a method that does not exist!!'"should i keep this?"]

!

removeOverriddenMethodNamed:aMethodName forClassNamed:aClassName ifAbsent:aBlock

    | dictionaryOfMethodNamesAndPackagedMethods removedPackagedMethod|

    overriddenMethodChanges values do:[:aDictionaryOfClassNamesAndPackagedMethods |

	(dictionaryOfMethodNamesAndPackagedMethods :=

	    aDictionaryOfClassNamesAndPackagedMethods at:aClassName ifAbsent:[nil]).

	dictionaryOfMethodNamesAndPackagedMethods ifNotNil:[

	    removedPackagedMethod := (dictionaryOfMethodNamesAndPackagedMethods remove:aMethodName ifAbsent:[nil]).