Add JSON AST dumps #46
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kbieganski
requested changes
Nov 22, 2023
Comment on lines
+901
to
+904
| // --dump-json-tree will serve as alias to --dump-tree-json. Rationale is that: | ||
| // - It is easy typo to make (after all tool used for pretty printing is called jsontree) | ||
| // - Parsing of dump* options is very "forgiving" and does not report error when non-existing | ||
| // option is used |
There was a problem hiding this comment.
Suggested change
| // --dump-json-tree will serve as alias to --dump-tree-json. Rationale is that: | |
| // - It is easy typo to make (after all tool used for pretty printing is called jsontree) | |
| // - Parsing of dump* options is very "forgiving" and does not report error when non-existing | |
| // option is used | |
| // --dump-json-tree aliases --dump-tree-json, as it's an easy mistake |
Co-authored-by: Krzysztof Bieganski <[email protected]>
Co-authored-by: Krzysztof Bieganski <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Verilator's AST can currently be dumped into custom
.treerepresentation for debug purposes. This PR adds a mostly equivalent JSON representation which is easier to process programmatically.Example use cases
Tree diffing
An example of how this is useful is the
astseetool which can pretty-print and diff these JSON dumps.Tree navigation
An example HTML representation for easy navigation of the AST:
example.zip
GDB commands
astseecan also be used from within GDB. Useful for diffing the AST at runtime, even within a single Verilator stage.