eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'ClassDefinitionChange':



Class: ClassDefinitionChange



rev: 1.103 date: 2019/06/22 14:05:20
user: cg
file: ClassDefinitionChange.st directory: libbasic3
module: stx stc-classLibrary: libbasic3
Claus Gittinger


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

Instance protocol:

o  basicSuperClassName

o  category

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

o  classInstanceVariableNames

o  classInstanceVariableNames: aCollectionOfWords

o  classInstanceVariableString

o  classInstanceVariableString: aString

o  classVariableNames

o  classVariableNames: aCollectionOfWords

o  classVariableString

o  classVariableString: aString

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

o  deltaDetail
Returns a delta to the current state as a ChangeDelta object

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

o  indexedType

o  instanceVariableNames

o  instanceVariableNames: aCollectionOfWords

o  instanceVariableString

o  instanceVariableString: aString

o  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)

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

usage example(s):

^ self cutNameSpaceOf:(self nameSpaceOverride ? super nameSpaceName)

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

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

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

o  poolDictionaries

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

o  private: aBoolean

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

o  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'

o  superClassName: aString

o  superClassNameWithoutMyNamespace

o  superClassNameWithoutNamespace

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

usage example(s):

      (ClassDefinitionChange className: #TestB source: 'TestA subclass: #TestB
          category:''* remove me *''')

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

o  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.).

o  sameAs: changeB
return true, if the given change represents the same change as the receiver.

o  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

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

printing & storing
o  definitionString
owningClassName isNil ifTrue:[

o  definitionStringInNamespace: nsOrNil
a visualWorks static variable definition change.

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

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

o  printWithoutClassNameOn: aStream

o  definitionSelector

o  definitionSelector: aSelector

o  owningClassName
the owner's name, excluding the namespace

o  owningClassName: aStringOrSymbol

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

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

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

o  isClassDefinitionChange

o  isOrContainsClassDefinitionChange

o  isPrivateClassDefinitionChange
compute lazily; remember in private

o  isVariable

o  acceptChangeVisitor: aVisitor

ST/X; WebServer 1.670 at bd0aa1f87cdd.unknown:8081; Sun, 04 Jun 2023 07:26:27 GMT