MLLocalizationTestCase.class.st

Class {
	#name : #MLLocalizationTestCase,
	#superclass : #TestCase,
	#instVars : [
		'ccg'
	],
	#category : #Melchor
}

{ #category : #running }
MLLocalizationTestCase >> applyLocalizationTo: interpreterSelector [

	| interpretMethod |
	ccg addClass: MockLocalizationInterpreterMock.
	ccg prepareMethods.
	ccg inlineDispatchesInMethodNamed: interpreterSelector.
	ccg doBasicInlining: true.

	SLAutomaticLocalization new
		codeGenerator: ccg;
		applyMethodNamed: interpreterSelector.
	
	interpretMethod := ccg methodNamed: interpreterSelector.
	ccg currentMethod: interpretMethod.
	^ interpretMethod
]

{ #category : #running }
MLLocalizationTestCase >> applyLocalizationToInterpretWith: initializationSelector [
	
	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"
	MockLocalizationInterpreterMock perform: initializationSelector.
	^ self applyLocalizationTo: #interpret
]

{ #category : #running }
MLLocalizationTestCase >> applyManyLocalizationsToInterpretWith: initializationSelector [
	
	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"
	MockLocalizationInterpreterMock perform: initializationSelector.
	^ self applyLocalizationTo: #interpretWithSeveralVariablesToLocalize
]

{ #category : #helpers }
MLLocalizationTestCase >> assert: aTStatementListNode isRewrittenAs: aString [ 
	
	self assert: (aTStatementListNode isSameAs: (self tastFor: aString))
]

{ #category : #running }
MLLocalizationTestCase >> externalizationOf: aVariableName [

	^ (TAssignmentNode
			variableNamed: aVariableName
			expression: (TVariableNode named: #local_, aVariableName))
]

{ #category : #running }
MLLocalizationTestCase >> internalizationOf: aVariableName [

	^ (TAssignmentNode
			variableNamed: #local_, aVariableName
			expression: (TVariableNode named: aVariableName))
]

{ #category : #helpers }
MLLocalizationTestCase >> linearise: aMethod [

	| methodToLinearize |
	ccg vmmakerConfiguration bytesPerWord: 8.
	ccg vmmakerConfiguration bytesPerOop: 8.
	ccg addClass: aMethod methodClass.
	methodToLinearize := ccg methodNamed: aMethod selector.
	
	ccg prepareMethods.
	ccg currentMethod: methodToLinearize.
	SLAutomaticLocalization new
		codeGenerator: ccg;
		linearizeExternalCallsIn: methodToLinearize
		withVariableBindings: ((ccg initAutoLocalizationOfVariablesIn: #interpret) asDictionary
			collect: [:n| TVariableNode named: n]).

	^ methodToLinearize
]

{ #category : #helpers }
MLLocalizationTestCase >> linearizedBlockOfCaseMethod: aTMethod [ 

	| case inlinedMethod |
	case := (aTMethod detect: [ :e | e isCaseStmt ]) cases first.
	inlinedMethod := (case detect: [ :e | e isInline ]) method.

	^ inlinedMethod parseTree
]

{ #category : #running }
MLLocalizationTestCase >> setUp [
	super setUp.
	ccg := MLVMCCodeGenerator new.
	ccg vmMaker: VMMaker new.
	ccg vmMaker vmmakerConfiguration: VMMakerConfiguration.
	MockLocalizationInterpreterMock initialize
]

{ #category : #helpers }
MLLocalizationTestCase >> tastFor: someCode [

	"Parse the expression as a method with a single expression.
	Transform it to TAST and get the first statement of the TMethod.
	
	Expected: the first statement of the TMethod should correspond to the first statement of the RMethod"
	^ ((RBParser parseExpression: someCode) methodNode
		compilationContext: CompilationContext new;
		asTranslationMethodOfClass: TMethod)
			parseTree
]

{ #category : #'tests - initialization' }
MLLocalizationTestCase >> testAutoLocalizeVariableDefinesNewLocalVariable [
	
	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"
	ccg addClass: MockLocalizationInterpreterMock.
	ccg initAutoLocalizationOfVariablesIn: #interpret.

	self assert: ((ccg methodNamed: #interpret) locals includes: #local_autoLocalizedVariable)
]

{ #category : #'tests - initialization' }
MLLocalizationTestCase >> testAutoLocalizeVariableDefinesNewLocalVariableWhenNameConflict [
	
	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"
	ccg addClass: MockLocalizationInterpreterMock.
	ccg initAutoLocalizationOfVariablesIn: #interpretWithLocalizedVariableConflict.
	self assert: ((ccg methodNamed: #interpretWithLocalizedVariableConflict) locals includes: #local_autoLocalizedVariable1)
]

{ #category : #'tests - initialization' }
MLLocalizationTestCase >> testAutoLocalizeVariableDefinesNewLocalVariables [
	
	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"
	| method |
	ccg addClass: MockLocalizationInterpreterMock.
	ccg initAutoLocalizationOfVariablesIn: #interpretWithSeveralVariablesToLocalize.
	method := (ccg methodNamed: #interpretWithSeveralVariablesToLocalize).
	self assert: ( method locals includes: #local_autoLocalizedVariable1).
	self assert: (method locals includes: #local_autoLocalizedVariable)
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testAutoLocalizeVariableDoesNotLineariseUnnecessaryStatements [

	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"

	| interpretMethod printedString block |
	interpretMethod := self applyLocalizationToInterpretWith: #initializeWithoutAutoLocalizedVariable.
	block := self linearizedBlockOfCaseMethod: interpretMethod.

	printedString := String streamContents: [ :str | (block asCASTIn: ccg) prettyPrintOn: str ].

	self assert: printedString equals: '{
	nonInlinedMethodNotUsingAutolocalizedVariables(nonInlinedMethodNotUsingAutolocalizedVariables());
}'
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testAutoLocalizeVariableExternalizesAtTheEnd [

	| externalizationStatement interpretMethod |
	interpretMethod := self applyLocalizationTo: #interpret.
	externalizationStatement := interpretMethod statements last first.

	self assert: (externalizationStatement isSameAs:
			 (self externalizationOf: #autoLocalizedVariable))
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testAutoLocalizeVariableExternalizesBeforeReturnReferenchingAutoLocalizedVariable [

	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"

	| interpretMethod printedString |
	interpretMethod := self applyLocalizationTo: #interpretWithReturnExpressionUpdatingAutoLocalizedVariable.
	printedString := String streamContents: [ :str | 
		                 ((TStatementListNode statements: (interpretMethod statements last: 2)) asCASTIn: ccg) 
			                 prettyPrintOn: str ].
	self assert: printedString equals: '{
	local_autoLocalizedVariable += 1;
	{
		autoLocalizedVariable = local_autoLocalizedVariable;
		autoLocalizedVariable1 = local_autoLocalizedVariable1;
		return local_autoLocalizedVariable;
	}
}'
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testAutoLocalizeVariableExternalizesBeforeReturns [

	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"

	| interpretMethod sendNode |
	interpretMethod := self applyLocalizationTo: #interpretWithReturnExpression.

	sendNode := interpretMethod last.
	self assert: sendNode arguments first last last isReturn.
	self
		assert: (sendNode arguments first last first
		isSameAs: (self externalizationOf: #autoLocalizedVariable)).

	self assert: sendNode arguments second last last isReturn.
	self
		assert: (sendNode arguments second last first
		isSameAs: (self externalizationOf: #autoLocalizedVariable))
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testAutoLocalizeVariableInternalizesAtTheBeginning [

	| internalizationStatement interpretMethod |
	interpretMethod := self applyLocalizationTo: #interpret.

	internalizationStatement := interpretMethod statements first.

	self
		assert: (internalizationStatement isSameAs: (self internalizationOf: #autoLocalizedVariable))
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testAutoLocalizeVariableReplacesByLocalOnInline [
	
	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"
	| interpretMethod variableNode case |
	interpretMethod := self applyLocalizationToInterpretWith: #initializeWithAutoLocalizedVariableOnly.
	
	"Fail if we find some node inside the case that uses the localized variable"
	case := (interpretMethod detect: [:e | e isCaseStmt ]) cases first.
	variableNode := (case detect: [ :e | e isAssignment ]) variable.

	self assert: (variableNode isVariable and: [ variableNode name = #local_autoLocalizedVariable ]).
]

{ #category : #'tests - free variables' }
MLLocalizationTestCase >> testCollectFreeVariablesOfMethodWithManyCallers [

	| collector |
	collector := SLCallGraphFreeVariableCollector codeGenerator: ccg.
	ccg addClass: MockLocalizationInterpreterMock.
	ccg prepareMethods.
	
	"
	variableToLocalize should be considered free in the entire transitive call graph.
	
			 				  /-- methodCallingBytecodeUsingLocalizedVariable  --\
							 /																	  \
	methodWithDiamond <													  				   >--> bytecodeUsingLocalizedVariable (using variable variableToLocalize)
						    \			 														  /
							  \-- methodCallingBytecodeUsingLocalizedVariable2 --/
	"
	collector startFromSelector: #methodWithDiamond.

	self assert: ((collector freeVariablesUsedByMethodNamed: #bytecodeUsingLocalizedVariable) includes: #variableToLocalize).	
	self assert: ((collector freeVariablesUsedByMethodNamed: #methodCallingBytecodeUsingLocalizedVariable) includes: #variableToLocalize).
	self assert: ((collector freeVariablesUsedByMethodNamed: #methodCallingBytecodeUsingLocalizedVariable2) includes: #variableToLocalize).
	self assert: ((collector freeVariablesUsedByMethodNamed: #methodWithDiamond) includes: #variableToLocalize).
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testExternalEscapingAsArgument [
	
	| interpretMethod cast printedString linearizedBlock |
	interpretMethod := self applyLocalizationToInterpretWith: #initializeWithEscapingCallAsArgument.

	"Assert that the send node is preceded by variable externalization"
	linearizedBlock := self linearizedBlockOfCaseMethod: interpretMethod.
	cast := linearizedBlock asCASTIn: ccg.
	
	printedString := String streamContents: [ :str | cast prettyPrintOn: str ].
	
	self assert: printedString equals:
'{
	sqInt t0;

	{
		autoLocalizedVariable = local_autoLocalizedVariable;
		t0 = foo2();
		local_autoLocalizedVariable = autoLocalizedVariable;
	}
	if (1 == t0) {
	}
}'
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testExternalEscapingAsArgumentOfExternalCall [
	
	| interpretMethod cast printedString linearizedBlock |
	interpretMethod := self applyManyLocalizationsToInterpretWith: #initializeWithEscapingCallAsArgumentOfExternalCall.

	"Assert that the send node is preceded by variable externalization"
	linearizedBlock := self linearizedBlockOfCaseMethod: interpretMethod.
	cast := linearizedBlock asCASTIn: ccg.

	printedString := String streamContents: [ :str | cast prettyPrintOn: str ].
	
	self assert: printedString equals: '{
	sqInt t0;

	{
		autoLocalizedVariable1 = local_autoLocalizedVariable1;
		t0 = nonInlinedMethodUsingAutolocalizedVariable1();
		local_autoLocalizedVariable1 = autoLocalizedVariable1;
	}
	{
		autoLocalizedVariable = local_autoLocalizedVariable;
		autoLocalizedVariable1 = local_autoLocalizedVariable1;
		autoLocalizedVariable2 = local_autoLocalizedVariable2;
		foo(t0);
		local_autoLocalizedVariable = autoLocalizedVariable;
		local_autoLocalizedVariable1 = autoLocalizedVariable1;
		local_autoLocalizedVariable2 = autoLocalizedVariable2;
	}
}'.
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testExternalEscapingSendNodeInInlinedMethod [
	
	| interpretMethod cast printedString linearizedBlock |
	interpretMethod := self applyManyLocalizationsToInterpretWith: #initializeWithInlinedMethodCall.

	"Assert that the send node is preceded by variable externalization"
	linearizedBlock := self linearizedBlockOfCaseMethod: interpretMethod.
	cast := linearizedBlock second asCASTIn: ccg.
	
	printedString := String streamContents: [ :str | cast prettyPrintOn: str ].
	
	self assert: printedString equals: '{
	autoLocalizedVariable = local_autoLocalizedVariable;
	autoLocalizedVariable1 = local_autoLocalizedVariable1;
	foo2();
	local_autoLocalizedVariable = autoLocalizedVariable;
	local_autoLocalizedVariable1 = autoLocalizedVariable1;
}'
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testExternalEscapingSendNodeShouldBeTranslatedWithExternalizationAndInternalization [
	
	| interpretMethod cast printedString linearizedBlock |

	interpretMethod := self applyLocalizationToInterpretWith: #initializeWithEscapingCall.

	"Assert that the send node is preceded by variable externalization"
	linearizedBlock := self linearizedBlockOfCaseMethod: interpretMethod.
	cast := linearizedBlock asCASTIn: ccg.

	printedString := String streamContents: [ :str | cast prettyPrintOn: str ].
	
	self assert: printedString equals: '{
	local_autoLocalizedVariable += 1;
	{
		autoLocalizedVariable = local_autoLocalizedVariable;
		foo(local_autoLocalizedVariable);
		local_autoLocalizedVariable = autoLocalizedVariable;
	}
}'
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testExternalEscapingStatementInConditionalBody [
	
	| interpretMethod cast printedString linearizedBlock |
	interpretMethod := self applyLocalizationToInterpretWith: #initializeWithIfStatement.

	"Assert that the send node is preceded by variable externalization"
	linearizedBlock := self linearizedBlockOfCaseMethod: interpretMethod.
	cast := linearizedBlock asCASTIn: ccg.
	
	printedString := String streamContents: [ :str | cast prettyPrintOn: str ].
	
	"The if statement should not be wrapped. Only the inner statements"
	self assert: printedString equals:
'{
	if (1) {
		sqInt t0;

		{
			autoLocalizedVariable = local_autoLocalizedVariable;
			t0 = nonInlinedMethodUsingAutolocalizedVariable();
			local_autoLocalizedVariable = autoLocalizedVariable;
		}
		{
			autoLocalizedVariable = local_autoLocalizedVariable;
			foo(t0);
			local_autoLocalizedVariable = autoLocalizedVariable;
		}
	}
}'
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testExternalPerform [
	
	| interpretMethod cast printedString linearizedBlock |
	interpretMethod := self applyLocalizationToInterpretWith: #initializeWithPerform.

	"Assert that the send node is preceded by variable externalization"
	linearizedBlock := self linearizedBlockOfCaseMethod: interpretMethod.
	cast := linearizedBlock asCASTIn: ccg.
	
	printedString := String streamContents: [ :str | cast prettyPrintOn: str ].
	
	self assert: printedString equals:
'{
	{
		autoLocalizedVariable = local_autoLocalizedVariable;
		foo();
		local_autoLocalizedVariable = autoLocalizedVariable;
	}
}'
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testExternalSendNodeExternalizeAndInternalizeOnlyNeededVariables [
	
	| interpretMethod cast printedString linearizedBlock |

	interpretMethod := self applyManyLocalizationsToInterpretWith: #initializeWithEscapingCall.

	"Assert that the send node is preceded by variable externalization"
	linearizedBlock := self linearizedBlockOfCaseMethod: interpretMethod.
	cast := linearizedBlock asCASTIn: ccg.

	printedString := String streamContents: [ :str | cast prettyPrintOn: str ].
	self assert: printedString equals: '{
	local_autoLocalizedVariable += 1;
	{
		autoLocalizedVariable = local_autoLocalizedVariable;
		autoLocalizedVariable1 = local_autoLocalizedVariable1;
		autoLocalizedVariable2 = local_autoLocalizedVariable2;
		foo(local_autoLocalizedVariable);
		local_autoLocalizedVariable = autoLocalizedVariable;
		local_autoLocalizedVariable1 = autoLocalizedVariable1;
		local_autoLocalizedVariable2 = autoLocalizedVariable2;
	}
}'
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testExternalSendNodeShouldBeTranslatedWithExternalizationAndInternalization [
	
	| interpretMethod cast printedString linearizedBlock |
	interpretMethod := self
		applyLocalizationToInterpretWith: #initializeWithExternalizedAutoLocalizedVariableInExpressionOnly.

	"Assert that the send node is preceded by variable externalization"
	linearizedBlock := self linearizedBlockOfCaseMethod: interpretMethod.
	
	cast := linearizedBlock asCASTIn: ccg.
	printedString := String streamContents: [ :str | cast prettyPrintOn: str ].
	
	self assert: printedString equals: '{
	sqInt t0;

	{
		autoLocalizedVariable = local_autoLocalizedVariable;
		t0 = nonInlinedMethodUsingAutolocalizedVariable();
		local_autoLocalizedVariable = autoLocalizedVariable;
	}
	{
		autoLocalizedVariable = local_autoLocalizedVariable;
		foo(t0);
		local_autoLocalizedVariable = autoLocalizedVariable;
	}
}'
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeAndInsideValueIf [

	| methodToLinearize replacementBlock |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingNestedConditionalValueWithAnd.

	"Before it was 
		^ overflow := self condition
			ifTrue: [ self condition ]
			ifFalse: [ self condition and: [ self condition ] ]"

	replacementBlock := methodToLinearize parseTree.

	"We have an extra nested code because the linearisation algorithm does not flatten..."
	self assert: replacementBlock isRewrittenAs: '
		self condition
			ifTrue: [ t0 := self condition ]
			ifFalse: [
				t0 := self condition.
				t0
					ifTrue: [ t0 := self condition ]
					ifFalse: [ t0 := t0 ] ].
		overflow := t0.
		^ overflow'.
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeAndInsideValueIfNestedTwice [

	| methodToLinearize replacementBlock |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingTwiceNestedConditionalValueWithAnd.

	"Before it was 
		^ overflow := self condition
		              ifTrue: [ self condition ]
		              ifFalse: [ 
			              self condition
				              ifTrue: [ self condition ]
				              ifFalse: [ self condition and: [ self condition ] ] ]"

	replacementBlock := methodToLinearize parseTree.

	"We have an extra nested code because the linearisation algorithm does not flatten..."
	self assert: replacementBlock isRewrittenAs: '
		self condition
			ifTrue: [ t0 := self condition ]
			ifFalse: [
				self condition
					ifTrue: [ t0 := self condition ]
					ifFalse: [ 
						t0 := self condition.
						t0
							ifTrue: [ t0 := self condition ]
							ifFalse: [ t0 := t0 ] ] ].
		overflow := t0.
		^ overflow'.
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeCallsInNestedLexicalScope [

	| methodToLinearize ifBlock expected |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingExternalizedAutoLocalizedVariableInNestedLexicalScope.

	"Before it was 
		true ifTrue: [
			self foo: self nonInlinedMethodUsingAutolocalizedVariable
		]
	After
		true ifTrue: [
			| t0 |
			t0 := self nonInlinedMethodUsingAutolocalizedVariable.
			self foo: t0
		] "

	ifBlock := methodToLinearize statements first arguments first.

	expected := self tastFor: '[| t0 |
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		self foo: t0]'.

	self assert: (ifBlock isSameAs: expected first)
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeComplexAssert [

	| methodToLinearize replacementBlock |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingComplexAssert.

	"Before it was 
		self assert: (self foo or: [ self bar and: [ self fum ] ])"

	replacementBlock := methodToLinearize parseTree.

	"We have an extra nested code because the linearisation algorithm does not flatten..."
	self assert: replacementBlock isRewrittenAs: '
		self assert: (self foo or: [ self bar and: [ self fum ] ])'.
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeNestedCalls [

	| methodToLinearize replacementBlock expected |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingExternalizedAutoLocalizedVariableAsExpression.

	"Before it was 
		self foo: self nonInlinedMethodUsingAutolocalizedVariable.
	After
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		self foo: t0"

	replacementBlock := methodToLinearize parseTree.
	
	expected := self tastFor: '| t0 |
			t0 := self nonInlinedMethodUsingAutolocalizedVariable.
			self foo: t0'.

	self assert: (replacementBlock isSameAs: expected)
]

{ #category : #'tests - initialization' }
MLLocalizationTestCase >> testLinearizeNestedCallsWithAssignment [

	| methodToLinearize replacementBlock |
	ccg addClass: MockLocalizationInterpreterMock.
	methodToLinearize := ccg methodNamed: #bytecodeUsingExternalizedAutoLocalizedVariableAsExpressionInAssignment.
	
	ccg prepareMethods.
	ccg currentMethod: methodToLinearize.
	SLAutomaticLocalization new
		codeGenerator: ccg;
		linearizeExternalCallsIn: methodToLinearize
		withVariableBindings: ((ccg initAutoLocalizationOfVariablesIn: #interpret) asDictionary
			collect: [:n| TVariableNode named: n]).

	"Before it was 
		foo := self foo: self nonInlinedMethodUsingAutolocalizedVariable.
	After
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		t1 := self foo: t0.
		foo := t1"
	
	replacementBlock := methodToLinearize parseTree.
	self assert: (replacementBlock statements first
			isSameAs: (TAssignmentNode
				variableNamed: 't0'
				expression: (TSendNode
					receiver: TVariableNode selfNode
					selector: #nonInlinedMethodUsingAutolocalizedVariable))).
	self assert: (replacementBlock statements second
			isSameAs: (TAssignmentNode
				variableNamed: 't1'
				expression: (TSendNode
					receiver: TVariableNode selfNode
					selector: #foo:
					arguments: { TVariableNode named: 't0' }))).
	self assert: (replacementBlock statements third
			isSameAs: (TAssignmentNode
				variableNamed: 'foo'
				expression: (TVariableNode named: 't1')))
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeNestedCallsWithReturn [

	| methodToLinearize replacementBlock expected |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >>  #bytecodeUsingExternalizedAutoLocalizedVariableAsExpressionInReturn.

	"Before it was 
		^ self foo: self nonInlinedMethodUsingAutolocalizedVariable.
	After
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		t1 := self foo: t0.
		^ t1"
	
	replacementBlock := methodToLinearize parseTree.
	
	expected := self tastFor: '| t0 t1 |
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		t1 := self foo: t0.
		^ t1'.

	self assert: (replacementBlock isSameAs: expected)
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeReceiverOfConditional [

	| methodToLinearize replacementBlock expected |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingExternalizedAutoLocalizedVariableAsIfReceiver.

	"Before it was 
		self nonInlinedMethodUsingAutolocalizedVariable ifTrue: [].
	After
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		t0 ifTrue: []"

	replacementBlock := methodToLinearize parseTree.
	
	expected := self tastFor: '| t0 t1 |
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		t0 ifTrue: [ nil ]'.

	self assert: (replacementBlock isSameAs: expected)
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeReceiverOfConditionalAnd [

	| methodToLinearize replacementBlock |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingExternalizedAutoLocalizedVariableAsIfReceiverWithAnd.

	"Before it was 
		(self nonInlinedMethodUsingAutolocalizedVariable and: [ 
			 self nonInlinedMethodUsingAutolocalizedVariable ]) ifTrue: [  ]"

	replacementBlock := methodToLinearize parseTree.

	"We have an extra nested code because the linearisation algorithm does not flatten..."
	self assert: replacementBlock isRewrittenAs: '
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		t0 ifTrue: [ t1 := self nonInlinedMethodUsingAutolocalizedVariable ] ifFalse: [ t1 := t0 ].
		t1 ifTrue: [nil]'.
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeReceiverOfConditionalAndAssigned [

	| methodToLinearize replacementBlock |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingExternalizedAutoLocalizedVariableAsAssignmentWithAnd.

	"Before it was 
		var := self nonInlinedMethodUsingAutolocalizedVariable and: [ 
			 self nonInlinedMethodUsingAutolocalizedVariable ].
		var ifTrue: [  ]"

	replacementBlock := methodToLinearize parseTree.

	"We have an extra nested code because the linearisation algorithm does not flatten..."
	self assert: replacementBlock isRewrittenAs: '
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		t0 ifTrue: [ t1 := self nonInlinedMethodUsingAutolocalizedVariable ] ifFalse: [ t1 := t0 ].
		var := t1.
		var ifTrue: [nil]'.
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeReceiverOfConditionalNestedAnd [

	| methodToLinearize replacementBlock |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingExternalizedAutoLocalizedVariableAsIfReceiverWithNestedAnd.

	"Before it was 
		(self nonInlinedMethodUsingAutolocalizedVariable and: [ 
		 self foo and: [ self bar ] ]) ifTrue: [  ]"

	replacementBlock := methodToLinearize parseTree.

	"We have an extra nested code because the linearisation algorithm does not flatten..."
	self assert: replacementBlock isRewrittenAs: '
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		t0 ifTrue: [ | t0 |
				t0 := self foo.
				t0
					ifTrue: [ t1 := self bar ]
					ifFalse: [ t1 := t0 ]]
			ifFalse: [ t1 := t0 ].
		t1 ifTrue: [nil]'.
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeReceiverOfConditionalOr [

	| methodToLinearize replacementBlock |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingExternalizedAutoLocalizedVariableAsIfReceiverWithOr.

	"Before it was 
		(self nonInlinedMethodUsingAutolocalizedVariable or: [ 
			 self nonInlinedMethodUsingAutolocalizedVariable ]) ifTrue: [  ]"

	replacementBlock := methodToLinearize parseTree.

	"We have an extra nested code because the linearisation algorithm does not flatten..."
	self assert: replacementBlock isRewrittenAs: '
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		t0 ifTrue: [ t1 := t0 ] ifFalse: [ t1 := self nonInlinedMethodUsingAutolocalizedVariable ].
		t1 ifTrue: [ nil ]'.
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeReceiverOfNestedConditional [

	| methodToLinearize replacementBlock |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingExternalizedAutoLocalizedVariableAsIfReceiverWithNestedConditional.

	"Before it was 
		(self nonInlinedMethodUsingAutolocalizedVariable ifTrue: [ 
		 self nonInlinedMethodUsingAutolocalizedVariable ])
			ifTrue: [  ]
	After
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		t0 ifTrue: [t1 := self nonInlinedMethodUsingAutolocalizedVariable] ifFalse: [t1 := t0].
		t1 ifTrue: []"

	replacementBlock := methodToLinearize parseTree.

	"We have an extra nested code because the linearisation algorithm does not flatten..."
	self assert: replacementBlock isRewrittenAs: '
		t0 := self nonInlinedMethodUsingAutolocalizedVariable.
		t0 ifTrue: [t1 := self nonInlinedMethodUsingAutolocalizedVariable] ifFalse: [t1 := t0].
		t1 ifTrue: [nil]'.
]

{ #category : #'tests - linearization' }
MLLocalizationTestCase >> testLinearizeSingleCalls [

	| methodToLinearize replacementBlock |
	methodToLinearize := self linearise:
		MockLocalizationInterpreterMock >> #bytecodeUsingInlinedCall.

	"Before it was 
		self inlinedMethodUsingExternalCall.
	After
		self inlinedMethodUsingExternalCall"

	replacementBlock := methodToLinearize parseTree.
	
	self assert: replacementBlock isRewrittenAs: 'self inlinedMethodUsingExternalCall'
]

{ #category : #'tests - old localization' }
MLLocalizationTestCase >> testLocalizeSharedVariableShouldFail [
	
	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"
	ccg addClass: MockLocalizationInterpreterMock.
	ccg prepareMethods.

	[ ccg localizeVariables: #( sharedVariableToLocalize ) inMethod: (ccg methodNamed: #interpret).
		
		"This should not arrive here"
		self fail
		] on: Error do: [ :error |
		self assert: error messageText equals: 'Cannot localize Shared Variables in the interpreter loop: sharedVariableToLocalize' ].
]

{ #category : #'tests - old localization' }
MLLocalizationTestCase >> testLocalizeSharedVariableShouldFailIfAllInlinedUsesAreNotInlined [
	
	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"
	ccg addClass: MockLocalizationInterpreterMock.
	ccg retainMethods: #( interpret ).
	ccg prepareMethods.
	ccg inlineDispatchesInMethodNamed: #interpret.
	ccg pruneUnreachableMethods.
	
	self assert: (ccg methodNamed: #methodAlsoSharedLocalizedVariableBeforeInlining) notNil.

	"This should not fail"
	[
	ccg localizeVariables: #( sharedVariableToLocalizeBeforeInlining ) inMethod: (ccg methodNamed: #interpret).
		
		"This should not arrive here"
		self fail
		] on: Error do: [ :error |
		self assert: error messageText equals: 'Cannot localize Shared Variables in the interpreter loop: sharedVariableToLocalizeBeforeInlining' ]
]

{ #category : #'tests - old localization' }
MLLocalizationTestCase >> testLocalizeSharedVariableShouldNotFailIfAllUsesAreInlined [
	
	"Prepare methods will replace the bytecode dispatch instruction into a dispatch switch"
	ccg addClass: MockLocalizationInterpreterMock.
	ccg retainMethods: #( interpret ).
	ccg prepareMethods.
	ccg doBasicInlining: true.
	ccg inlineDispatchesInMethodNamed: #interpret.
	ccg pruneUnreachableMethods.
	
	"This should not fail"
	ccg localizeVariables: #( sharedVariableToLocalizeBeforeInlining ) inMethod: (ccg methodNamed: #interpret)
]

{ #category : #'tests - localisation' }
MLLocalizationTestCase >> testNoExternalSendNodeOnSafeExternalCall [
	
	| interpretMethod cast printedString linearizedBlock |
	interpretMethod := self applyManyLocalizationsToInterpretWith: #initializeWithSafeEscapingCall.

	"Assert that the send node is preceded by variable externalization"
	linearizedBlock := self linearizedBlockOfCaseMethod: interpretMethod.
	cast := linearizedBlock asCASTIn: ccg.
	
	printedString := String streamContents: [ :str | cast prettyPrintOn: str ].
	
	self assert: printedString equals: '{
	nonInlinedMethodNotUsingAutolocalizedVariables((local_autoLocalizedVariable += 1));
}'
]