enso/engine/runtime-compiler
Pavel Marek 76061e1c04
Add IRDumper for Scala IR (#9543)
Debugging/inspecting/watching changes in the [Scala IR](fe0f9046db/engine/runtime-parser/src/main/java/org/enso/compiler/core/IR.java) has always been very tricky. The only way to do that, other than attaching the debugger and inspecting nested object structures, has been [IR.pretty](fe0f9046db/engine/runtime-parser/src/main/java/org/enso/compiler/core/IR.java (L91)) method, that is not useful for large IRs. This PR add an [IRDumper](a98b674f9e/engine/runtime-compiler/src/main/java/org/enso/compiler/dump/IRDumper.java) utility class that dumps the `IR` into a [GraphViz](https://graphviz.org/) textual format that can be further processed by the [dot](https://graphviz.org/download/) program to generate, e.g., svg files from these IRs.

A simple example (dumped by `IRDumper` into a file that is processed with `dot -O -Tsvg file`):
![fqn_end_tmp gv](https://github.com/enso-org/enso/assets/14013887/7441dc31-45ac-469e-9e06-4c98795a95eb)

# Important Notes
- GraphViz format is even simpler than JSON format.
- No dependencies added, just 3 simple Java classes.
- Dumping the IR is optional and not used anywhere, when desired, one can dump IRs for example from [Compiler.runPipeline](9a91b7bcc6/engine/runtime-compiler/src/main/scala/org/enso/compiler/Compiler.scala (L438))
2024-03-27 09:19:47 +00:00
..
src/main Add IRDumper for Scala IR (#9543) 2024-03-27 09:19:47 +00:00