Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Richer Source Positions #232

Merged
merged 2 commits into from
Jul 30, 2022
Merged

Richer Source Positions #232

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d65bc0e
Richer Source Positions
Pat-Lafon Jul 26, 2022
6ce9589
Add restriction on `pos_end`
Pat-Lafon Jul 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/lang/syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,11 +124,14 @@ It also has the optional `args`, `funcs`, and `labels` fields.
Source Positions
----------------

Any syntax object may optionally have a `pos` field to reflect a source position:
Any syntax object may optionally have position fields to reflect a source position:

{ ..., "pos": {"row": <int>, "col": <int>} }
{ ..., "pos": {"row": <int>, "col": <int>},
"pos_end": {"row": <int>, "col": <int>}?,
"src": "<string>"? }

The `pos` object has two keys: `row` (the line number) and `col` (the column number within the line).
The `pos` and `pos_end` objects have two keys: `row` (the line number) and `col` (the column number within the line). The `src` object can optionally provide the absolute path to a file which is referenced to by the source position.
If `pos_end` is provided, it must be equal to or greater than `pos`.
Front-end compilers that generate Bril code may add this information to help with debugging.
The [text format parser](../tools/text.md), for example, can optionally add source positions.
However, tools can't require positions to exist, to consistently exist or not on all syntax objects in a program, or to follow any particular rules.