Merge pull request pharo-project#6655 from dionisiydk/specialVarRefactor

Rename special variables into reserved variables
demarey · Jun 23, 2020 · f36e381 · f36e381
2 parents 7544b03 + 8c7eaa3
commit f36e381
Show file tree

Hide file tree

Showing 18 changed files with 213 additions and 29 deletions.
diff --git a/...OpalCompiler-Core/OCSelfVariable.class.st → src/Deprecated90/OCSelfVariable.class.st b/...OpalCompiler-Core/OCSelfVariable.class.st → src/Deprecated90/OCSelfVariable.class.st
@@ -4,7 +4,7 @@ I model self variables
 Class {
 	#name : #OCSelfVariable,
 	#superclass : #OCSpecialVariable,
-	#category : #'OpalCompiler-Core-Semantics'
+	#category : #'Deprecated90-OpalCompiler-Core'
 }
 
 { #category : #accessing }

diff --git a/...lCompiler-Core/OCSpecialVariable.class.st → src/Deprecated90/OCSpecialVariable.class.st b/...lCompiler-Core/OCSpecialVariable.class.st → src/Deprecated90/OCSpecialVariable.class.st
@@ -4,7 +4,7 @@ I model self, thisContext and super
 Class {
 	#name : #OCSpecialVariable,
 	#superclass : #OCAbstractLocalVariable,
-	#category : #'OpalCompiler-Core-Semantics'
+	#category : #'Deprecated90-OpalCompiler-Core'
 }
 
 { #category : #emitting }

diff --git a/.../OCStoreIntoSpecialVariableError.class.st → .../OCStoreIntoSpecialVariableError.class.st b/.../OCStoreIntoSpecialVariableError.class.st → .../OCStoreIntoSpecialVariableError.class.st
@@ -5,5 +5,5 @@ Error when trying to assign to a special Variable.
 Class {
 	#name : #OCStoreIntoSpecialVariableError,
 	#superclass : #OCSemanticError,
-	#category : #'OpalCompiler-Core-Exception'
+	#category : #'Deprecated90-OpalCompiler-Core'
 }
diff --git a/...palCompiler-Core/OCSuperVariable.class.st → src/Deprecated90/OCSuperVariable.class.st b/...palCompiler-Core/OCSuperVariable.class.st → src/Deprecated90/OCSuperVariable.class.st
@@ -4,7 +4,7 @@ I model super variables
 Class {
 	#name : #OCSuperVariable,
 	#superclass : #OCSpecialVariable,
-	#category : #'OpalCompiler-Core-Semantics'
+	#category : #'Deprecated90-OpalCompiler-Core'
 }
 
 { #category : #accessing }

diff --git a/...piler-Core/OCThisContextVariable.class.st → ...precated90/OCThisContextVariable.class.st b/...piler-Core/OCThisContextVariable.class.st → ...precated90/OCThisContextVariable.class.st
@@ -4,7 +4,7 @@ I model thisContext variables
 Class {
 	#name : #OCThisContextVariable,
 	#superclass : #OCSpecialVariable,
-	#category : #'OpalCompiler-Core-Semantics'
+	#category : #'Deprecated90-OpalCompiler-Core'
 }
 
 { #category : #accessing }

diff --git a/src/Deprecated90/RBVariableNode.extension.st b/src/Deprecated90/RBVariableNode.extension.st
@@ -0,0 +1,10 @@
+Extension { #name : #RBVariableNode }
+
+{ #category : #'*Deprecated90' }
+RBVariableNode >> isSpecialVariable [
+	self 
+		deprecated: 'Use #isReservedVariable instead.' 
+		transformWith: '`@receiver isSpecialVariable' -> '`@receiver isReservedVariable'.
+
+	^ self isReservedVariable
+]
diff --git a/src/Deprecated90/Variable.extension.st b/src/Deprecated90/Variable.extension.st
@@ -1,5 +1,14 @@
 Extension { #name : #Variable }
 
+{ #category : #'*Deprecated90' }
+Variable >> isSpecialVariable [
+	self 
+		deprecated: 'Use #isReservedVariable instead.' 
+		transformWith: '`@receiver isSpecialVariable' -> '`@receiver isReservedVariable'.
+
+	^ self isReservedVariable
+]
+
 { #category : #'*Deprecated90' }
 Variable >> variable [
 

diff --git a/src/Kernel/Variable.class.st b/src/Kernel/Variable.class.st
@@ -130,19 +130,19 @@ Variable >> isReferenced [
 ]
 
 { #category : #testing }
-Variable >> isSelf [
+Variable >> isReservedVariable [
 	^false
 ]
 
 { #category : #testing }
-Variable >> isSelfOrSuper [
-
-	^ false
+Variable >> isSelf [
+	^false
 ]
 
 { #category : #testing }
-Variable >> isSpecialVariable [
-	^false
+Variable >> isSelfOrSuper [
+
+	^ self isSelf or: [ self isSuper ]
 ]
 
 { #category : #testing }

diff --git a/src/OpalCompiler-Core/OCASTSemanticAnalyzer.class.st b/src/OpalCompiler-Core/OCASTSemanticAnalyzer.class.st
@@ -99,7 +99,7 @@ OCASTSemanticAnalyzer >> lookupVariableForWrite: aVariableNode [
 	var := scope lookupVar: aVariableNode name.
 
 	var ifNil: [^var].
-	var isSpecialVariable ifTrue: [ self storeIntoSpecialVariable: aVariableNode ].
+	var isReservedVariable ifTrue: [ self storeIntoReservedVariable: aVariableNode ].
 	var isWritable ifFalse: [ self storeIntoReadOnlyVariable: aVariableNode ].
 	var isTemp ifTrue: [ self analyseEscapingWrite: var ].
 	^var
@@ -122,9 +122,9 @@ OCASTSemanticAnalyzer >> storeIntoReadOnlyVariable: variableNode [
 ]
 
 { #category : #'error handling' }
-OCASTSemanticAnalyzer >> storeIntoSpecialVariable: variableNode [
+OCASTSemanticAnalyzer >> storeIntoReservedVariable: variableNode [
 	compilationContext optionSkipSemanticWarnings ifTrue: [ ^ self ].
-	^ OCStoreIntoSpecialVariableError new
+	^ OCStoreIntoReservedVariableError new
 		node: variableNode;
 		compilationContext: compilationContext;
 		messageText: 'Cannot store into';

diff --git a/src/OpalCompiler-Core/OCAbstractMethodScope.class.st b/src/OpalCompiler-Core/OCAbstractMethodScope.class.st
@@ -120,9 +120,7 @@ OCAbstractMethodScope >> initialize [
 	copiedVars := Dictionary new.
 	id := 0.
 
-	thisContextVar := OCThisContextVariable new
-		scope: self; yourself.
-
+	thisContextVar := ThisContextVariable instance
 ]
 
 { #category : #'temp vars' }

diff --git a/src/OpalCompiler-Core/OCInstanceScope.class.st b/src/OpalCompiler-Core/OCInstanceScope.class.st
@@ -32,12 +32,8 @@ OCInstanceScope >> hasBindingThatBeginsWith: aString [
 OCInstanceScope >> initialize [
 
 	vars := Dictionary new.
-	selfVar := OCSelfVariable new
-		scope: self;
-		yourself.
-	superVar := OCSuperVariable new
-		scope: self;
-		yourself.
+	selfVar := SelfVariable instance.
+	superVar := SuperVariable instance
 ]
 
 { #category : #acessing }

diff --git a/src/OpalCompiler-Core/OCStoreIntoReservedVariableError.class.st b/src/OpalCompiler-Core/OCStoreIntoReservedVariableError.class.st
@@ -0,0 +1,5 @@
+Class {
+	#name : #OCStoreIntoReservedVariableError,
+	#superclass : #OCSemanticError,
+	#category : #'OpalCompiler-Core-Exception'
+}
diff --git a/src/OpalCompiler-Core/RBVariableNode.extension.st b/src/OpalCompiler-Core/RBVariableNode.extension.st
@@ -24,7 +24,7 @@ RBVariableNode >> isArgOrTemp [
 
 { #category : #'*opalcompiler-core' }
 RBVariableNode >> isClean [
-	^ (self isInstance | self isSpecialVariable) not
+	^ (self isInstance | self isReservedVariable) not
 ]
 
 { #category : #'*opalcompiler-core' }
@@ -38,8 +38,8 @@ RBVariableNode >> isInstance [
 ]
 
 { #category : #'*opalcompiler-core' }
-RBVariableNode >> isSpecialVariable [
-	^ self binding isSpecialVariable
+RBVariableNode >> isReservedVariable [
+	^ self binding isReservedVariable
 ]
 
 { #category : #'*opalcompiler-core' }

diff --git a/src/OpalCompiler-Core/ReservedVariable.class.st b/src/OpalCompiler-Core/ReservedVariable.class.st
@@ -0,0 +1,55 @@
+"
+I model self, thisContext and super
+"
+Class {
+	#name : #ReservedVariable,
+	#superclass : #Variable,
+	#classInstVars : [
+		'instance'
+	],
+	#category : #'OpalCompiler-Core-Semantics'
+}
+
+{ #category : #accessing }
+ReservedVariable class >> instance [ 
+	^instance ifNil: [ instance := self new ]
+]
+
+{ #category : #testing }
+ReservedVariable class >> isAbstract [ 
+	^self = ReservedVariable  
+]
+
+{ #category : #converting }
+ReservedVariable >> asString [
+
+	^ self name
+]
+
+{ #category : #'code generation' }
+ReservedVariable >> emitStore: methodBuilder [
+
+	self shouldNotImplement
+]
+
+{ #category : #testing }
+ReservedVariable >> isReservedVariable [
+	^true
+]
+
+{ #category : #testing }
+ReservedVariable >> isWritable [
+	^ false
+]
+
+{ #category : #printing }
+ReservedVariable >> printOn: stream [
+
+	stream nextPutAll: self name
+]
+
+{ #category : #debugging }
+ReservedVariable >> write: aValue inContext: aContext [
+
+	self error: name, ' is reserved word and cant be modified'
+]
diff --git a/src/OpalCompiler-Core/SelfVariable.class.st b/src/OpalCompiler-Core/SelfVariable.class.st
@@ -0,0 +1,37 @@
+"
+I model ""self"" keyword 
+"
+Class {
+	#name : #SelfVariable,
+	#superclass : #ReservedVariable,
+	#category : #'OpalCompiler-Core-Semantics'
+}
+
+{ #category : #accessing }
+SelfVariable class >> semanticNodeClass [
+
+	^RBSelfNode 
+]
+
+{ #category : #emitting }
+SelfVariable >> emitValue: methodBuilder [
+
+	methodBuilder pushReceiver
+]
+
+{ #category : #initialization }
+SelfVariable >> initialize [
+	super initialize.
+
+	name := 'self'
+]
+
+{ #category : #testing }
+SelfVariable >> isSelf [
+	^true
+]
+
+{ #category : #debugging }
+SelfVariable >> readInContext: aContext [
+	^aContext receiver
+]
diff --git a/src/OpalCompiler-Core/SuperVariable.class.st b/src/OpalCompiler-Core/SuperVariable.class.st
@@ -0,0 +1,37 @@
+"
+I model ""super"" keyword
+"
+Class {
+	#name : #SuperVariable,
+	#superclass : #ReservedVariable,
+	#category : #'OpalCompiler-Core-Semantics'
+}
+
+{ #category : #accessing }
+SuperVariable class >> semanticNodeClass [
+
+	^RBSuperNode 
+]
+
+{ #category : #emitting }
+SuperVariable >> emitValue: methodBuilder [
+	"super references the receiver, send that follows is a super send (the message lookup starts in the superclass)"
+	methodBuilder pushReceiver
+]
+
+{ #category : #initialization }
+SuperVariable >> initialize [
+	super initialize.
+
+	name := 'super'
+]
+
+{ #category : #testing }
+SuperVariable >> isSuper [
+	^true
+]
+
+{ #category : #debugging }
+SuperVariable >> readInContext: aContext [
+	^aContext receiver
+]
diff --git a/src/OpalCompiler-Core/ThisContextVariable.class.st b/src/OpalCompiler-Core/ThisContextVariable.class.st
@@ -0,0 +1,37 @@
+"
+I model thisContext keyword
+"
+Class {
+	#name : #ThisContextVariable,
+	#superclass : #ReservedVariable,
+	#category : #'OpalCompiler-Core-Semantics'
+}
+
+{ #category : #accessing }
+ThisContextVariable class >> semanticNodeClass [
+
+	^RBThisContextNode 
+]
+
+{ #category : #emitting }
+ThisContextVariable >> emitValue: methodBuilder [
+
+	methodBuilder pushThisContext
+]
+
+{ #category : #initialization }
+ThisContextVariable >> initialize [
+	super initialize.
+
+	name := 'thisContext'
+]
+
+{ #category : #testing }
+ThisContextVariable >> isThisContext [
+	^true
+]
+
+{ #category : #debugging }
+ThisContextVariable >> readInContext: aContext [
+	^aContext
+]
diff --git a/src/OpalCompiler-Tests/OCASTVariableTranslatorTest.class.st b/src/OpalCompiler-Tests/OCASTVariableTranslatorTest.class.st
@@ -38,14 +38,14 @@ OCASTVariableTranslatorTest >> testAssignInstanceVariable [
 OCASTVariableTranslatorTest >> testAssignSelfVariable [
 	self
 		should: [self compileSource: 'foo
-	self := 17'] raise: OCStoreIntoSpecialVariableError
+	self := 17'] raise: OCStoreIntoReservedVariableError
 ]
 
 { #category : #'testing - variables' }
 OCASTVariableTranslatorTest >> testAssignSuperVariable [
 	self
 		should: [self compileSource: 'foo
-	super := 17'] raise: OCStoreIntoSpecialVariableError
+	super := 17'] raise: OCStoreIntoReservedVariableError
 ]
 
 { #category : #'testing - variables' }
@@ -59,7 +59,7 @@ OCASTVariableTranslatorTest >> testAssignTemporaryVariable [
 OCASTVariableTranslatorTest >> testAssignThisContextVariable [
 	self
 		should: [self compileSource: 'foo
-	thisContext := 17'] raise: OCStoreIntoSpecialVariableError
+	thisContext := 17'] raise: OCStoreIntoReservedVariableError
 ]
 
 { #category : #'testing - variables' }