Implement CFG

README.md

@@ -43,10 +43,27 @@ Or
     FASTPythonImporter parseFile: myFile
 ```
 
-# Documentation
+## Documentation
 
 The best documentation to read about this project is located in Pharo Tree Sitter's repository here: [https://github.com/Evref-BL/Pharo-Tree-Sitter/blob/main/resources/doc/fast_importer.md](https://github.com/Evref-BL/Pharo-Tree-Sitter/blob/main/resources/doc/fast_importer.md) and here: [https://github.com/Evref-BL/Pharo-Tree-Sitter/blob/main/resources/doc/ts_utilities.md](https://github.com/Evref-BL/Pharo-Tree-Sitter/blob/main/resources/doc/ts_utilities.md)
 
+
+## Control flow graph
+
+It is possible to get a control flow graph of your python entities like this:
+
+```smalltalk
+FASTPythonCFGVisitor buildCFGOf: aModel allFunctionDefinitions first.
+
+"or"
+
+aModel allFunctionDefinitions first cfg
+```
+
+A CFG can be done on a function, method, class, module or lambda. 
+
+You can visualize it in the inspector as a visualization and you can also export your CFG as a mermaid visualization using `#asMermaidScript`
+
 ## Moose versions compatibility
 
 | Version 	| Compatible Moose versions    |

src/BaselineOfFASTPython/BaselineOfFASTPython.class.st

@@ -22,13 +22,12 @@ BaselineOfFASTPython >> baseline: spec [
 				package: 'FAST-Python-Model' with: [ spec requires: #( 'FAST' 'TreeSitter' ) ];
 				package: 'FAST-Python-Model-Generator';
 				package: 'FAST-Python-Model-Tests' with: [ spec requires: #( 'FAST-Python-Model' ) ];
-				package: 'FAST-Python-Tools' with: [ spec requires: #( 'FAST-Python-Model' 'FAST-Python-Visitor' ) ];
-				package: 'FAST-Python-Tools-Tests' with: [ spec requires: #( 'FAST-Python-Tools' ) ];
-				package: 'FAST-Python-Visitor' with: [ spec requires: #( 'FAST-Python-Model' ) ].
+				package: 'FAST-Python-Tools' with: [ spec requires: #( 'FAST-Python-Model' ) ];
+				package: 'FAST-Python-Tools-Tests' with: [ spec requires: #( 'FAST-Python-Tools' ) ].
 
 			"Groups"
 			spec
-				group: 'Core' with: #( 'FAST-Python-Model' 'FAST-Python-Tools' 'FAST-Python-Visitor' );
+				group: 'Core' with: #( 'FAST-Python-Model' 'FAST-Python-Tools' );
 				group: 'Generator' with: #( 'FAST-Python-Model-Generator' );
 				group: 'Tests' with: #( 'FAST-Python-Model-Tests' 'FAST-Python-Tools-Tests' ) ]
 ]

src/FAST-Python-Model-Generator/FASTPythonMetamodelGenerator.class.st

@@ -155,7 +155,9 @@ Class {
 		'tCallable',
 		'tSliceIndex',
 		'tAwaitable',
-		'tExecutable'
+		'tExecutable',
+		'tBreakStatement',
+		'tContinueStatement'
 	],
 	#category : 'FAST-Python-Model-Generator',
 	#package : 'FAST-Python-Model-Generator'
@@ -173,12 +175,6 @@ FASTPythonMetamodelGenerator class >> packageName [
 	^ #'FAST-Python-Model'
 ]
 
-{ #category : 'accessing' }
-FASTPythonMetamodelGenerator class >> packageNameForVisitor [
-
-	^ #'FAST-Python-Visitor'
-]
-
 { #category : 'accessing' }
 FASTPythonMetamodelGenerator class >> prefix [
 
@@ -246,7 +242,7 @@ FASTPythonMetamodelGenerator >> defineClasses [
 
 	comparisonOperator := builder newClassNamed: #ComparisonOperator.
 
-	(comprehension := builder newClassNamed: #Comprehension) comment:
+	(comprehension := builder newAbstractClassNamed: #Comprehension) comment:
 		'I am an abstract class for comprehensions. Comprehensions are a structure in python to generate some collections or a generator.'.
 
 	(complex := builder newClassNamed: #Complex) comment: 'I represent a complex number such as `2j`'.
@@ -279,7 +275,7 @@ FASTPythonMetamodelGenerator >> defineClasses [
 	escapeSequence := builder newClassNamed: #EscapeSequence.
 	exceptClause := builder newClassNamed: #ExceptClause.
 	execStatement := builder newClassNamed: #ExecStatement.
-	expression := builder newClassNamed: #Expression.
+	expression := builder newAbstractClassNamed: #Expression.
 	finallyClause := builder newClassNamed: #FinallyClause.
 	float := builder newClassNamed: #Float.
 	forInClause := builder newClassNamed: #ForInClause.
@@ -306,7 +302,7 @@ FASTPythonMetamodelGenerator >> defineClasses [
 	lambdaParameters := builder newClassNamed: #LambdaParameters.
 	list := builder newClassNamed: #List.
 	listComprehension := builder newClassNamed: #ListComprehension.
-	literal := builder newClassNamed: #Literal.
+	literal := builder newAbstractClassNamed: #Literal.
 	matchStatement := builder newClassNamed: #MatchStatement.
 	memberType := builder newClassNamed: #MemberType.
 	methodDefinition := builder newClassNamed: #MethodDefinition.
@@ -331,7 +327,7 @@ FASTPythonMetamodelGenerator >> defineClasses [
 		'In Python a collection (list or dictionary) splat is the unpacking of a collection in a call or in the definition of another definition like `[ *list , 4 ]` or `func(*list)`'.
 	splatParameter := builder newClassNamed: #SplatParameter.
 	splatType := builder newClassNamed: #SplatType.
-	statement := builder newClassNamed: #Statement.
+	statement := builder newAbstractClassNamed: #Statement.
 	string := builder newClassNamed: #String.
 	subscript := builder newClassNamed: #Subscript.
 	thenClause := builder newClassNamed: #ThenClause.
@@ -395,6 +391,7 @@ FASTPythonMetamodelGenerator >> defineHierarchy [
 	boolean --|> tBooleanLiteral.
 
 	breakStatement --|> statement.
+	breakStatement --|> tBreakStatement.
 
 	call --|> expression.
 	call --|> tInvocation.
@@ -433,6 +430,7 @@ FASTPythonMetamodelGenerator >> defineHierarchy [
 	conditionalExpression --|> tExecutable.
 
 	continueStatement --|> statement.
+	continueStatement --|> tContinueStatement.
 
 	constrainedType --|> tTypeContent.
 
@@ -743,7 +741,7 @@ FASTPythonMetamodelGenerator >> defineRelations [
 	((deleteStatement property: #expression) comment: 'The expression to apply the delete on')
 	<>- ((tDeletable property: #parentDeleteStatement) comment: 'The delete statement that own the expression (if it''s the case)').
 
-	(exceptClause property: #expressions) <>-* (expression property: #parentExceptClause). "We could point less things than expression, but in reality in Python any expression can be provided. It will just end up in runtime error."
+	(exceptClause property: #expression) <>- (expression property: #parentExceptClause). "We could point less things than expression, but in reality in Python any expression can be provided. It will just end up in runtime error."
 
 	(execStatement property: #code) <>- (tExecutable property: #parentExecStatement).
 	(execStatement property: #scopes) <>-* (expression property: #parentExecStatementScopes).
@@ -902,8 +900,10 @@ FASTPythonMetamodelGenerator >> defineTraits [
 	tAssignment := self remoteTrait: #TAssignment withPrefix: #FAST.
 	tBinaryExpression := self remoteTrait: #TBinaryExpression withPrefix: #FAST.
 	tBooleanLiteral := self remoteTrait: #TBooleanLiteral withPrefix: #FAST.
+	tBreakStatement := self remoteTrait: #TBreakStatement withPrefix: #FAST.
 	tComment := self remoteTrait: #TComment withPrefix: #FAST.
 	tConditionalStatement := self remoteTrait: #TConditionalStatement withPrefix: #FAST.
+	tContinueStatement := self remoteTrait: #TContinueStatement withPrefix: #FAST.
 	tExpression := self remoteTrait: #TExpression withPrefix: #FAST.
 	tInvocation := self remoteTrait: #TInvocation withPrefix: #FAST.
 	tLiteral := self remoteTrait: #TLiteral withPrefix: #FAST.

src/FAST-Python-Model/FASTPyBreakStatement.class.st

@@ -1,11 +1,30 @@
 "
 I represent a break statement used to break loops.
 
+## Relations
+======================
+
+### Parents
+| Relation | Origin | Opposite | Type | Comment |
+|---|
+| `parentLoopStatement` | `FASTTStatement` | `body` | `FASTTLoopStatement` | Optional loop of which this statement is the body|
+| `statementContainer` | `FASTTStatement` | `statements` | `FASTTStatementBlock` | Block containing this statement.|
+
+
+## Properties
+======================
+
+| Name | Type | Default value | Comment |
+|---|
+| `endPos` | `Number` | nil | |
+| `startPos` | `Number` | nil | |
 
 "
 Class {
 	#name : 'FASTPyBreakStatement',
 	#superclass : 'FASTPyStatement',
+	#traits : 'FASTTBreakStatement',
+	#classTraits : 'FASTTBreakStatement classTrait',
 	#category : 'FAST-Python-Model-Entities',
 	#package : 'FAST-Python-Model',
 	#tag : 'Entities'

src/FAST-Python-Model/FASTPyComprehension.class.st

@@ -40,6 +40,14 @@ FASTPyComprehension class >> annotation [
 	<FMClass: #Comprehension super: #FASTPyExpression>
 	<package: #'FAST-Python-Model'>
 	<generated>
+	<abstract>
+]
+
+{ #category : 'testing' }
+FASTPyComprehension class >> isAbstract [
+
+	<generated>
+	^ self == FASTPyComprehension
 ]
 
 { #category : 'adding' }

src/FAST-Python-Model/FASTPyContinueStatement.class.st

@@ -6,6 +6,8 @@ I represent a continue statement to use in loops.
 Class {
 	#name : 'FASTPyContinueStatement',
 	#superclass : 'FASTPyStatement',
+	#traits : 'FASTTContinueStatement',
+	#classTraits : 'FASTTContinueStatement classTrait',
 	#category : 'FAST-Python-Model-Entities',
 	#package : 'FAST-Python-Model',
 	#tag : 'Entities'

src/FAST-Python-Model/FASTPyEntity.class.st

@@ -71,13 +71,27 @@ FASTPyEntity >> isBooleanLiteral [
 	^ false
 ]
 
+{ #category : 'testing' }
+FASTPyEntity >> isBreakStatement [
+
+	<generated>
+	^ false
+]
+
 { #category : 'testing' }
 FASTPyEntity >> isClassDefinition [
 
 	<generated>
 	^ false
 ]
 
+{ #category : 'testing' }
+FASTPyEntity >> isContinueStatement [
+
+	<generated>
+	^ false
+]
+
 { #category : 'testing' }
 FASTPyEntity >> isExpression [
 

src/FAST-Python-Model/FASTPyExceptClause.class.st

@@ -13,7 +13,7 @@
 ### Children
 | Relation | Origin | Opposite | Type | Comment |
 |---|
-| `expressions` | `FASTPyExceptClause` | `parentExceptClause` | `FASTPyExpression` | |
+| `expression` | `FASTPyExceptClause` | `parentExceptClause` | `FASTPyExpression` | |
 | `statements` | `FASTTStatementBlock` | `statementContainer` | `FASTTStatement` | Statements enclosed in this block|
 
 
@@ -34,7 +34,7 @@ Class {
 	#classTraits : 'FASTTStatementBlock classTrait',
 	#instVars : [
 		'#alias => FMProperty',
-		'#expressions => FMMany type: #FASTPyExpression opposite: #parentExceptClause',
+		'#expression => FMOne type: #FASTPyExpression opposite: #parentExceptClause',
 		'#parentTryStatement => FMOne type: #FASTPyTryStatement opposite: #excepts'
 	],
 	#category : 'FAST-Python-Model-Entities',
@@ -50,12 +50,6 @@ FASTPyExceptClause class >> annotation [
 	<generated>
 ]
 
-{ #category : 'adding' }
-FASTPyExceptClause >> addExpression: anObject [
-	<generated>
-	^ self expressions add: anObject
-]
-
 { #category : 'accessing' }
 FASTPyExceptClause >> alias [
 
@@ -72,19 +66,18 @@ FASTPyExceptClause >> alias: anObject [
 ]
 
 { #category : 'accessing' }
-FASTPyExceptClause >> expressions [
-	"Relation named: #expressions type: #FASTPyExpression opposite: #parentExceptClause"
+FASTPyExceptClause >> expression [
+	"Relation named: #expression type: #FASTPyExpression opposite: #parentExceptClause"
 
 	<generated>
-	<derived>
-	^ expressions
+	^ expression
 ]
 
 { #category : 'accessing' }
-FASTPyExceptClause >> expressions: anObject [
+FASTPyExceptClause >> expression: anObject [
 
 	<generated>
-	expressions value: anObject
+	expression := anObject
 ]
 
 { #category : 'accessing' }

src/FAST-Python-Model/FASTPyExpression.class.st

@@ -21,7 +21,7 @@
 | `parentConditionalExpressionElse` | `FASTPyExpression` | `elseExpression` | `FASTPyConditionalExpression` | |
 | `parentConditionalExpressionThen` | `FASTPyExpression` | `thenExpression` | `FASTPyConditionalExpression` | |
 | `parentDefaultParameterValue` | `FASTPyExpression` | `defaultValue` | `FASTPyParameter` | |
-| `parentExceptClause` | `FASTPyExpression` | `expressions` | `FASTPyExceptClause` | |
+| `parentExceptClause` | `FASTPyExpression` | `expression` | `FASTPyExceptClause` | |
 | `parentExecStatementScopes` | `FASTPyExpression` | `scopes` | `FASTPyExecStatement` | |
 | `parentExpression` | `FASTTExpression` | `expression` | `FASTTUnaryExpression` | Parent (unary) expression|
 | `parentExpressionLeft` | `FASTTExpression` | `leftOperand` | `FASTTBinaryExpression` | Parent (binary) expression of which I am left side|
@@ -75,7 +75,7 @@ Class {
 		'#parentConditionalExpressionElse => FMOne type: #FASTPyConditionalExpression opposite: #elseExpression',
 		'#parentConditionalExpressionThen => FMOne type: #FASTPyConditionalExpression opposite: #thenExpression',
 		'#parentDefaultParameterValue => FMOne type: #FASTPyParameter opposite: #defaultValue',
-		'#parentExceptClause => FMOne type: #FASTPyExceptClause opposite: #expressions',
+		'#parentExceptClause => FMOne type: #FASTPyExceptClause opposite: #expression',
 		'#parentExecStatementScopes => FMOne type: #FASTPyExecStatement opposite: #scopes',
 		'#parentForInClauseLeft => FMOne type: #FASTPyForInClause opposite: #left',
 		'#parentForInClauseRight => FMOne type: #FASTPyForInClause opposite: #right',
@@ -106,6 +106,14 @@ FASTPyExpression class >> annotation [
 	<FMClass: #Expression super: #FASTPyStatement>
 	<package: #'FAST-Python-Model'>
 	<generated>
+	<abstract>
+]
+
+{ #category : 'testing' }
+FASTPyExpression class >> isAbstract [
+
+	<generated>
+	^ self == FASTPyExpression
 ]
 
 { #category : 'accessing' }
@@ -125,6 +133,14 @@ FASTPyExpression >> collectionInitializer: anObject [
 	collectionInitializer := anObject
 ]
 
+{ #category : 'testing' }
+FASTPyExpression >> isExpressionStatement [
+
+	self containersDo: [ :container | (container isOfType: FASTTStatementBlock) ifTrue: [ ^ true ] ].
+
+	^ false
+]
+
 { #category : 'accessing' }
 FASTPyExpression >> parentAssertStatement [
 	"Relation named: #parentAssertStatement type: #FASTPyAssertStatement opposite: #expressions"
@@ -313,10 +329,11 @@ FASTPyExpression >> parentDefaultParameterValue: anObject [
 
 { #category : 'accessing' }
 FASTPyExpression >> parentExceptClause [
-	"Relation named: #parentExceptClause type: #FASTPyExceptClause opposite: #expressions"
+	"Relation named: #parentExceptClause type: #FASTPyExceptClause opposite: #expression"
 
 	<generated>
 	<container>
+	<derived>
 	^ parentExceptClause
 ]
 

src/FAST-Python-Model/FASTPyLiteral.class.st

@@ -44,4 +44,12 @@ FASTPyLiteral class >> annotation [
 	<FMClass: #Literal super: #FASTPyExpression>
 	<package: #'FAST-Python-Model'>
 	<generated>
+	<abstract>
+]
+
+{ #category : 'testing' }
+FASTPyLiteral class >> isAbstract [
+
+	<generated>
+	^ self == FASTPyLiteral
 ]

src/FAST-Python-Model/FASTPyModel.class.st

@@ -21,3 +21,21 @@ FASTPyModel class >> annotation [
 	<package: #'FAST-Python-Model'>
 	<generated>
 ]
+
+{ #category : 'accessing' }
+FASTPyModel >> allClassDefinitions [
+
+	^ self allWithType: FASTPyClassDefinition
+]
+
+{ #category : 'accessing' }
+FASTPyModel >> allFunctionDefinitions [
+
+	^ self allWithType: FASTPyFunctionDefinition
+]
+
+{ #category : 'accessing' }
+FASTPyModel >> allModules [
+
+	^ self allWithType: FASTPyModule
+]

src/FAST-Python-Model/FASTPyStatement.class.st

@@ -34,4 +34,12 @@ FASTPyStatement class >> annotation [
 	<FMClass: #Statement super: #FASTPyEntity>
 	<package: #'FAST-Python-Model'>
 	<generated>
+	<abstract>
+]
+
+{ #category : 'testing' }
+FASTPyStatement class >> isAbstract [
+
+	<generated>
+	^ self == FASTPyStatement
 ]