History of Transformations based on operation instances

[racoelhosilva]

History of Transformations based on operation instances

Features

• Event System that is triggered before and after every Joinpoint action (it can be further extended for more functionalities and use cases)
• History Record for each one of the relevant 12 actions that transform the Clava's underlying AST, allowing checkpoints, rollbacks or simple undos in case of Exceptions
• Unit tests for the code associated with the History API with 100% coverage in all of the fields

Remaining Topics (before merging)

• Analyze the Joinpoint action replaceWith(Joinpoint[]) as it is causing some issues
• Change the return values of setFirstChild and setLastChild from void to the Joinpoint that previously existed there
• Export the API and test it when executing a script

As of writing this, most functionalities are working as expected, the remaining unchecked topics on the list above will be fixed on this pull request

References

• This feature updated the contents of the Joinpoints.ts file which is automatically generated. After merging this pull request, it might be adequate to also merge this one
• This pull request will fix the issues with the replaceWith(Joinpoint[]) function as well as changing the return type of the setFirstChild and setLastChild methods, improving the already functional history system.

---

This work is related to the topic [CSE02] Recording the History of Source-to-Source Transformations, which is part of the INESC TEC Summer Internship 2024

[joaobispo]

This file can be moved to the lara-framework repo. It needs to have a generic parameter for the join point that extends LaraJoinPoint, then the weaver generator can specialize to the join point of the specific compiler it is generating code for.

[joaobispo]

There should be a global event listener, instantiated by a class in in the lara-framework repo, and other libraries/code register events to that event listener.

Only a small part of this file should be moved to the lara-framework, the part that imports the EventEmitter and instantiates it, it should provide an EventListener class (or LaraEventListener) with a static method that returns the global event listener, and possibly some utility methods (if it makes sense).