https://github.com/spyoungtech/ahk-ast
Create abstract syntax trees from AHK code
https://github.com/spyoungtech/ahk-ast
Last synced: about 1 month ago
JSON representation
Create abstract syntax trees from AHK code
- Host: GitHub
- URL: https://github.com/spyoungtech/ahk-ast
- Owner: spyoungtech
- Created: 2022-01-28T23:55:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-20T22:31:36.000Z (about 4 years ago)
- Last Synced: 2025-03-04T00:44:46.873Z (over 1 year ago)
- Language: Python
- Size: 51.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ahk-ast
[](https://coveralls.io/github/spyoungtech/ahk-ast?branch=main)
This is an attempt at implementing a parser for AutoHotkey using a LALR(1) parser generator (provided by `sly`).
Ultimately, the ability to parse AHK syntax programmatically will help in the production of other tools, such as
linters, code formatters, compilers, and more.
Goals:
- Define a formal grammar for [AutoHotkey V2](https://lexikos.github.io/v2/docs/v2-changes.htm)
- Ability to tokenize AutoHotkey code
- Ability to generate an abstract syntax tree (AST) from AutoHotkey V2 code
Extended goals:
- Ability to reproduce source code from AST models ("round-tripping")
- Ability to modify AST nodes and reproduce source code
- Ability to preserve comments in round-trip editing.
However, it's unclear how successful this endeavor will be, or if it can be successful at all. If a LALR grammar cannot
be established, then this project will likely remain incomplete.
# Usage
## Tokenizing
```bash
python -m ahk_ast.tokenizer myfile.ahk
```
## Parsing
```python
import ahk_ast
ahk_source = """\
a := 1
b := a + 1
MsgBox b
"""
ahk_ast.parse(ahk_source)
# Program(
# statements=(
# Assignment(location=Identifier(name="a"), value=Integer(value=1)),
# Assignment(
# location=Identifier(name="b"), value=BinOp(op="+", left=Identifier(name="a"), right=Integer(value=1))
# ),
# FunctionCall(name="MsgBox", arguments=(Identifier(name="b"),)),
# )
# )
```
# Status
This project is in its very early phases. Almost none of the language syntax is fully implemented into the parser.
The tokenizer has most the tokens that exist for AHK, but is still very much subject to change.