"{ Package: 'stx:goodies/petitparser/compiler' }"

"{ NameSpace: Smalltalk }"

	instanceVariableNames:'codeGen'

	classVariableNames:''

	poolDictionaries:''

	category:'PetitCompiler-Visitors-CodeGenerators'

!

!PPCCodeGenerator class methodsFor:'as yet unclassified'!

new

    ^ self basicNew

        initialize;

        yourself 

!

on: aPPCCompiler

    ^ self new 

        compiler: aPPCCompiler;

        yourself

! !

!PPCCodeGenerator methodsFor:'accessing'!

codeGen

    ^ codeGen

!

codeGen: anObject

    codeGen := anObject

!

guards

    ^ context options guards

    "Modified: / 26-08-2015 / 22:17:54 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!PPCCodeGenerator methodsFor:'code generation'!

generateChoiceChildOf: choiceNode atIndex: choiceChildNodeIndex useGuards: useGuards storeResultInto: resultVar

    | children |

    children := choiceNode children.

    useGuards ifTrue:[

        self addGuard: (children at: choiceChildNodeIndex) ifTrue: [ 

                    codeGen codeClearError.

                    codeGen 

                          codeEvaluateAndAssign:[ self visit:(children at: choiceChildNodeIndex) ]

                          to: resultVar.

                    codeGen codeIf: 'error' then: nil else: [ 

                        codeGen codeReturn: resultVar.  

                    ].

                ] ifFalse:[ 

                    codeGen code: 'error := true.'.

                ].

                codeGen codeIf: 'error' then: [ 

                    choiceChildNodeIndex < children size ifTrue:[ 

                        self generateChoiceChildOf: choiceNode atIndex: choiceChildNodeIndex + 1 useGuards: useGuards storeResultInto: resultVar.

                    ] ifFalse:[ 

                        codeGen codeError: 'no choice suitable'.

                    ].

                ].

    ] ifFalse:[ 

                choiceChildNodeIndex <= children size ifTrue:[ 

                    codeGen codeClearError.

                    codeGen 

                          codeEvaluateAndAssignParsedValueOf:[ self visit:(children at: choiceChildNodeIndex) ]

                          to: resultVar.

                    codeGen codeIf: 'error' then: nil else: [ 

                        codeGen codeReturn: resultVar.  

                    ].

                    self generateChoiceChildOf: choiceNode atIndex: choiceChildNodeIndex + 1 useGuards: useGuards storeResultInto: resultVar.

                ] ifFalse:[ 

                    codeGen codeError: 'no choice suitable'.

                ].

    ].

!

generateSequenceChildOf: sequenceNode atIndex: sequenceNodeChildIndex useMememntoVar: mementoVar storeResultInto: elementVars

        | child childValueVar |

        child := sequenceNode children at: sequenceNodeChildIndex.

        childValueVar := elementVars at: sequenceNodeChildIndex.

        codeGen codeEvaluateAndAssign: [ self visit:child ] 

                                      to: childValueVar.

        child acceptsEpsilon ifFalse: [   

            codeGen codeIfErrorThen: [

                "Handle error in the first element in a special way,

                 because one does not need to do backtracking  if the first element fails."

                (sequenceNodeChildIndex == 1) ifTrue: [                         

                    codeGen codeReturn: 'failure'

                ] ifFalse: [

                    codeGen restore: sequenceNode from: mementoVar.

                    codeGen codeReturn: 'failure.'.

                ]

            ] else:[ 

                sequenceNode returnParsedObjectsAsCollection ifTrue:[

                    codeGen code: self retvalVar , ' at: ', sequenceNodeChildIndex asString, ' put: ', childValueVar, '.'.

                ].

                (sequenceNodeChildIndex < sequenceNode children size) ifTrue:[ 

                    self generateSequenceChildOf: sequenceNode atIndex: sequenceNodeChildIndex + 1 useMememntoVar: mementoVar storeResultInto: elementVars.

                ].

            ]

        ] ifTrue:[

            sequenceNode returnParsedObjectsAsCollection ifTrue:[

                codeGen code: self retvalVar , ' at: ', sequenceNodeChildIndex asString, ' put: ', childValueVar, '.'.

            ].

            (sequenceNodeChildIndex < sequenceNode children size) ifTrue:[ 

                    self generateSequenceChildOf: sequenceNode atIndex: sequenceNodeChildIndex + 1 useMememntoVar: mementoVar storeResultInto: elementVars.

            ].

        ]

! !

!PPCCodeGenerator methodsFor:'hooks'!

afterAccept: node retval: retval

    "return the method from compiler"

    ^ self stopMethodForNode: node.

!

beforeAccept: node

    self startMethodForNode: node

!

closedDetected: node

    ^ node isMarkedForInline ifFalse: [ 

        self error: 'Should not happen!!'

    ]

!

openDetected: node

    ^ codeGen cachedMethod: (codeGen idFor: node)

! !

!PPCCodeGenerator methodsFor:'private'!

checkBlockIsInlinable: block

    "Check whether the given block could be inlined. If not, 

     throw an error. If yes, this method is noop.

     A block is inlineable if and only if it's a purely functional

     (see PPCASTUtilities>>checkBlockIsPurelyFunctional:inClass: for 

     details)

     As a side-effect, copy all self-sent methods from the block

     to the target class.          

    "

    | blockNode |

    blockNode := block sourceNode.

    "In Smalltalk implementation which use cheap-block optimization (Smalltalk/X) it may

     happen that home context of the block is nil (in case of cheap blocks)"

    block home notNil ifTrue:[ 

        | blockClass |

        blockClass := block home receiver class.

        PPCASTUtilities new checkNodeIsFunctional: blockNode inClass: blockClass.

        "The above code should raise an error when block is not functional (i.e., when not

         inlineable, so if the control flow reach this point, block is OK and we can safely 

         copy self-sent methods."

        self copySelfSentMethodsOf: blockNode inClass: blockClass

    ].

    "Created: / 27-07-2015 / 14:40:07 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 27-07-2015 / 15:52:59 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

copySelfSentMethodsOf: anRBProgramNode inClass: aClass

    PPCASTUtilities new withAllMessageNodesOf: anRBProgramNode sentToSelfDo: [ :node|

        | method source |

        method := aClass lookupSelector: node selector.

        method isNil ifTrue:[

            PPCCompilationError new signalWith: 'oops, no method found (internal error)!!'.        

        ].

        source := method sourceCode.

        source isNil ifTrue:[ 

            PPCCompilationError new signalWith: 'unavailable source for method ', method printString ,'!!'.        

        ].

        "Following actually copies the method to the target class,

         though the APU is not nice. This has to be cleaned up"

        (codeGen cachedMethod: node selector) isNil ifTrue:[ 

            codeGen cacheMethod: (PPCMethod new id: node selector; source: source; yourself) as: node selector.

            "Now compile self-sends of the just copied method"

            self copySelfSentMethodsOf: method parseTree inClass: aClass

        ].

    ]

    "Created: / 27-07-2015 / 14:50:47 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!PPCCodeGenerator methodsFor:'running'!

run: ir

    "Actually run the pass on given IR (tree of PPCNode) and return

     (possibly transformed or completely new) another IR."

    | entry |

    context isNil ifTrue:[ 

        PPCCompilationError new signal: 'oops, no context set, use #context: before running a pass!!'.

    ].

    ^ ir

    "Created: / 26-08-2015 / 22:38:58 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!PPCCodeGenerator methodsFor:'support'!

compileTokenWhitespace: node

    codeGen codeIf: 'context atWs' then: nil else: [ 

        codeGen 

              codeEvaluateAndAssign:[ self visit:node whitespace ]

              to:#whatever.

        codeGen code: 'context setWs.'.

    ]

!

notCharSetPredicateBody: node

    | classificationId  classification |

    self error: 'deprecated.'.

    classification := node extendClassification: node predicate classification.

    classificationId := (codeGen idFor: classification defaultName: #classification).

    codeGen  addConstant: classification as: classificationId.

    codeGen addOnLine: '(', classificationId, ' at: context peek asInteger)'.

    codeGen indent.

    codeGen add: ' ifTrue: [ self error: '' predicate not expected'' ]'.

    codeGen add: ' ifFalse: [ nil ].'.

    codeGen dedent.

!

notMessagePredicateBody: node

    self error: 'deprecated'.

    codeGen addOnLine: '(context peek ', node message, ')'.

    codeGen indent.

    codeGen add: ' ifTrue: [ self error: '' predicate not expected'' ]'.

    codeGen add: ' ifFalse: [ nil ].'.

    codeGen dedent.

!

predicateBody: node

    | tmpId |

    self error:'deprecated'.

    tmpId := (codeGen idFor: node predicate prefixed: #predicate).

    codeGen addConstant: node predicate as: tmpId.

    codeGen addOnLine: '(context atEnd not and: [ ', tmpId , ' value: context uncheckedPeek])'.

    codeGen indent.

    codeGen add: 'ifFalse: [ self error: ''predicate not found'' ]'.

    codeGen add: 'ifTrue: [ context next ].'.

    codeGen dedent.	

!

retvalVar

    ^ codeGen currentReturnVariable

    "Modified: / 15-06-2015 / 18:20:37 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

startMethodForNode:node

    node isMarkedForInline ifTrue:[ 

        codeGen startInline: (codeGen idFor: node).

        codeGen codeComment: 'BEGIN inlined code of ' , node printString.

        codeGen indent.

    ] ifFalse:[ 

        codeGen startMethod: (codeGen idFor: node).

        codeGen codeComment: 'GENERATED by ' , node printString.

        codeGen allocateReturnVariable.

    ].

    "Created: / 23-04-2015 / 15:51:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 23-04-2015 / 19:13:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (format): / 15-06-2015 / 18:03:07 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

stopMethodForNode:aPPCNode

    ^ codeGen currentMethod isInline ifTrue:[ 

                codeGen dedent.

                codeGen code: '"END inlined code of ' , aPPCNode printString , '"'.

                codeGen stopInline.

    ] ifFalse:[ 

                codeGen stopMethod

    ].

    "Created: / 23-04-2015 / 15:51:09 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 23-04-2015 / 18:35:41 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!PPCCodeGenerator methodsFor:'traversing - caching'!

cache: node value: retval

    "this is compiler thing, not mine"

!

cachedDetected: node

    ^ codeGen clazz cachedMethod: (codeGen idFor: node)

!

isCached: node

    ^ (codeGen cachedMethod: (codeGen idFor: node)) isNil not

! !

!PPCCodeGenerator methodsFor:'visiting'!

visitActionNode: node

    | blockNode blockBody blockNodesVar blockNeedsCollection blockMatches childValueVars |

    self checkBlockIsInlinable: node block.

    blockNode := node block sourceNode copy.

    self assert: blockNode arguments size == 1.

    blockNodesVar := blockNode arguments first .

    blockBody := blockNode body.

    "Now, analyze block body, search for all references to

     block arg <barg> and check if in all cases it's used 

     in one of the following patterns:

        * <barg> first , <barg> second, ... , <barg> sixth

        * <barg> at: <integer constant>

     If so, then the block code can be inlined and the intermediate

     result collection need not to be created. Keep this information

     in temporary `blockNeedsCollection`. 

     During the analysis, remember all nodes that matches the pattern

     in a dictionary `blockMatches` mapping the node to actual temporary

     variable where the node is used. This will be later used for block's node

     rewriting"

    blockNeedsCollection := true.

    node child isSequenceNode ifTrue:[

        blockNeedsCollection := false.

        blockMatches := IdentityDictionary new."Must use IDENTITY dict as nodes have overwritten their #=!!!!!!"

        childValueVars := node child preferredChildrenVariableNames.

        PPCASTUtilities new withAllVariableNodesOf: blockBody do:[:variableNode| 

            variableNode name = blockNodesVar name ifTrue:[ 

                "Check if variable node matches..."

                variableNode parent isMessage ifTrue:[ 

                    | parent |

                    parent := variableNode parent.

                    "Check for <barg> at: <number>"

                    ((parent selector == #at:) and:[ parent options first isLiteralNumber ]) ifTrue:[ 

                        blockMatches at: parent put: (childValueVars at: parent options first value).

                    ] ifFalse:[ 

                        "Check for <barg> first / second / ..."

                        | i |

                        i := #(first second third fourth fifth sixth) indexOf: parent selector.

                        i ~~ 0 ifTrue:[ 

                            blockMatches at: parent put: (childValueVars at: i).

                        ] ifFalse:[ 

                            blockNeedsCollection := true.

                        ].

                    ].

                ] ifFalse:[ 

                    blockNeedsCollection := true.

                ].

            ].

        ].

    ].

    blockNeedsCollection ifTrue:[

        "Bad, we have to use the collection.

         Replace all references to blockNodeVar to retvalVar..."

        PPCASTUtilities new withAllVariableNodesOf: blockBody do:[:variableNode| 

            variableNode name = blockNodesVar name ifTrue:[ 

                variableNode name: self retvalVar.

            ].

        ].

    ] ifFalse:[ 

        "Good, can avoid intermediate collection.

         Replace references to collection with corresponding temporary variable"

        blockMatches keysAndValuesDo:[:matchingNode :childValueVar |

            matchingNode parent replaceNode: matchingNode withNode: (RBVariableNode named: childValueVar).

        ].

        node child returnParsedObjectsAsCollection: false. 

    ].

    "Block return value is return value of last statement.

     So if the method is not inline, make last statement a return.

        if the method is inline, make it assignment to retvalVar."

    blockBody statements notEmpty ifTrue:["Care for empty blocks - [:t | ] !!"

        codeGen currentMethod isInline ifTrue:[ 

            |  assignment |

            assignment := RBAssignmentNode variable: (RBVariableNode named: self retvalVar) value:  blockBody statements last.

            blockBody replaceNode: blockBody statements last withNode: assignment.

        ] ifFalse:[  

            | return |

            return := RBReturnNode value: blockBody statements last.

            blockBody replaceNode: blockBody statements last withNode: return.

        ].

    ].

    codeGen codeEvaluateAndAssign:[ self visit:node child ] to:self retvalVar.

    codeGen codeIfErrorThen: [ 

        codeGen codeReturn: 'failure'. 

    ] else: [

        codeGen code: blockBody.    

    ]

    "Modified: / 27-07-2015 / 15:49:15 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

visitAndNode: node

    | mementoVar |

    mementoVar := codeGen allocateTemporaryVariableNamed: 'memento'.

    codeGen remember: node child to: mementoVar.

    codeGen 

          codeEvaluateAndAssign:[ self visit:node child ]

          to:self retvalVar.

    codeGen restore: node child from: mementoVar.

    codeGen codeReturn.

    "Modified: / 23-04-2015 / 15:59:07 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

visitAnyNode: node

    codeGen codeReturn: 'context next ifNil: [ error := true. ].'.

    "Modified: / 23-04-2015 / 20:52:15 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

visitCharSetPredicateNode: node

    | classification classificationId |

    classification := node extendClassification: node predicate classification.

    classificationId := codeGen idFor: classification defaultName: #classification.

    codeGen addConstant: classification as: classificationId.

    codeGen codeIf: '(', classificationId, ' at: context peek asInteger)' then: [ 

        codeGen codeReturn: 'context next'.

    ] else: [ 

        codeGen codeError: 'predicate not found'.

    ]

!

visitCharacterNode: node

    | chid |

    node character ppcPrintable ifTrue: [ 

        chid := node character storeString 

    ] ifFalse: [ 

        chid := codeGen idFor: node character defaultName: #char.

        codeGen addConstant: (Character value: node character asInteger) as: chid .

    ].

    codeGen codeIf: '(context peek == ', chid, ')' then: [  

        codeGen codeReturn: 'context next'.

    ] else: [ 

        codeGen codeError: node character asInteger asString, ' expected'.

    ].

!

visitChild: child of: node

    |  |

    (self isOpen: child) ifTrue: [ 

        "already processing..."

        ^ nil

    ].

    ^ self visit: child.

!

visitChoiceNode: node

    |  whitespaceConsumed useGuards resultVar  |

    resultVar := codeGen allocateTemporaryVariableNamed: 'element'.

    whitespaceConsumed := self addGuardTrimming: node.

    useGuards := whitespaceConsumed.

    self generateChoiceChildOf: node atIndex: 1 useGuards: useGuards storeResultInto: resultVar