Class: ClassDefinitionChange

• Inheritance
• Description
• Instance protocol
  • accessing
  • applying
  • comparing
  • converting
  • printing & storing
  • queries
  • special
  • testing
  • visiting

Inheritance:

   Object
   |
   +--Change
      |
      +--ClassChange
         |
         +--ClassDefinitionChange

Package:

stx:libbasic3

Category:

System-Changes

Version:

rev: 1.103 date: 2019/06/22 14:05:20

user: cg

file: ClassDefinitionChange.st directory: libbasic3

module: stx stc-classLibrary: libbasic3

Author:

Claus Gittinger

Description:

instances represent class definition-changes. 
They are typically held in a ChangeSet.

Instance protocol:

 basicSuperClassName

 category

 category: aStringOrSymbol

Modified (format): / 30-06-2018 / 17:49:08 / Claus Gittinger

 classInstanceVariableNames

 classInstanceVariableNames: aCollectionOfWords

 classInstanceVariableString

 classInstanceVariableString: aString

 classVariableNames

 classVariableNames: aCollectionOfWords

 classVariableString

 classVariableString: aString

 delta

Tools::TextDiff2Tool openOn: changeSource label: 'Change' and: imageSource label: 'Image'

 deltaDetail

Returns a delta to the current state as a ChangeDelta object

 imageSource

return the source for the in-image version of the method

 indexedType

 instanceVariableNames

 instanceVariableNames: aCollectionOfWords

 instanceVariableString

 instanceVariableString: aString

 localClassName

for private classes, this returns the name relative to its owner;
for non-private ones, this is the regular name.
Notice that className always returns the full name (incl. any owner prefix)

 nameSpaceName

"/ JV: What is the following good for? Please explain..."

usage example(s):

^ self cutNameSpaceOf:(self nameSpaceOverride ? super nameSpaceName)

 nameSpaceName: aNameSpaceName classType: aClassType otherParameters: otherParametersArg

this instance setup message is used when reading from a VW-xml change file.
Support for this is not yet complete.

 objectType

return the value of the instance variable 'objectType' (automatically generated)

 objectType: something

set the value of the instance variable 'objectType' (automatically generated)

 poolDictionaries

 poolDictionaries: aCollectionOfPools

Modified (format): / 30-06-2018 / 17:52:07 / Claus Gittinger

 private: aBoolean

 source

return the source of the change;
either the original source or a synthesized

 superClassName

returns nil, if no superclass.
Notice, that squeak returns the string 'nil' in this case;
so this might change in the future;
in the meantime, senders should be written to accept both nil and 'nil'

 superClassName: aString

 superClassNameWithoutMyNamespace

 superClassNameWithoutNamespace

 apply

Some classes have nil superclass (such as Object)...

usage example(s):

(ClassDefinitionChange className: #TestB source: 'TestA subclass: #TestB instanceVariableNames:'''' classVariableNames:'''' poolDictionaries:'''' category:''* remove me *''') apply

 isConflict

true if this change is different than what is already in the image
(i.e. it overwrites some existing code)

 isForSameAs: changeB

return true, if the given change represents a change for the same
thingy as the receiver (i.e. same method, same definition etc.).

 sameAs: changeB

return true, if the given change represents the same change as the receiver.

 asAntiChange

(comment from inherited method)
Returns my anti-change, i.e. change that does the
opposite. For class definition change it returns
class remove change, for method definition change
it returns method remove change. If there is no way
how to revert the change, an error is triggered.

JV: personal note: we should switch to deltastreams
(http://wiki.squeak.org/squeak/6001)

CG: is the above really true - what about a classDefChange for
an existing class????

 definitionString

owningClassName isNil ifTrue:[

 definitionStringInNamespace: nsOrNil

a visualWorks static variable definition change.

 definitionStringWithoutNamespace

cg - huh - who needs that? (the definitionString already does NOT include the classes namespace)

 printOn: aStream

(comment from inherited method)
append a user printed representation of the receiver to aStream.
The format is suitable for a human - not meant to be read back.

 printWithoutClassNameOn: aStream

 definitionSelector

 definitionSelector: aSelector

 owningClassName

the owner's name, excluding the namespace

 owningClassName: aStringOrSymbol

 installAsAutoloadedClassIfPublicWithFilename: aFilenameString

install the class defined by this change as autoloaded.
Skip private classes.
Enter class file name as abbreviation

 invalidateSource

internal - flush the sourceString if it got invalidated due to a
className, superclassName, etc... change

 setupFromSource

Extract data from class definition string in source.
WARNING: This overwrites values in instvars!

 isClassDefinitionChange

 isOrContainsClassDefinitionChange

 isPrivateClassDefinitionChange

compute lazily; remember in private

 isVariable

 acceptChangeVisitor: aVisitor