Enhancing the documentation #37
Open
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
❌ Deploy Preview for majestic-fenglisu-8c6786 failed.
|
ftomassetti
approved these changes
Jan 7, 2025
| The Chisel method for writing parsers allows to build parsers consistently using the same approach which allows to achieve a consistency on the architectural decisions and enables developers to get familiar with a project easily. |
There was a problem hiding this comment.
Here parsers is repeated. We may write "The Chisel method allows to build parsers consistently using the same approach..."
|
|
||
| The Chisel method is based on the following principles: | ||
| 1. We define a clear goal, which is shared by the Client and the Language Engineering Team. This goal is objective, and it is not subject to interpretation. |
There was a problem hiding this comment.
For lists to work in markdown I am not sure if we need an empty line before the first point
| The Chisel method is based on the following principles: | ||
| 1. We define a clear goal, which is shared by the Client and the Language Engineering Team. This goal is objective, and it is not subject to interpretation. | ||
| 2. At each step, the Language Engineering Team should clearly understand where we are and what should be done next - parsing and then refining the produced AST. Tool support should facilitate each single step, removing friction due to repetitive tasks. For this the StarLasu Libraries can be used since it provides user-friendly APIs for seamless integration as well as cross-language integration. |
There was a problem hiding this comment.
In addition to the StarLasu Libraries also the StarLasu Tools play a role
| Code Generation modules are usefull to generate new files programmatically. This is the case when building a transpiler, where there is the need to generate text (code) from an AST representation. |
| Code Generation modules are usefull to generate new files programmatically. This is the case when building a transpiler, where there is the need to generate text (code) from an AST representation. | ||
|
|
||
| Currently Code Generation modules can be written only with Kolasu. |
There was a problem hiding this comment.
We now support them also in SharpLasu
| ## Heterogeneous APIs | ||
|
|
||
| On the other hand, each Node can also have its own specific set of properties and methods. For instance a Node that represents an if statement can have the condition and the body properties. |
There was a problem hiding this comment.
I would just add that this is typically useful to write specific applications like interpreters or semantic enrichment modules.
| @@ -1,12 +1,21 @@ | |||
| # Semantic Enrichment | |||
|
|
|||
| _To be written_ | |||
| People who are new to parser development may attempt to enforce grammar-level type coherence. For example, defining that a variable declared with type int can only have a subset of the expression types as its initial value, that doesn't work and can increase the complexity of writing a grammar and still not obtaining the desired constraints. | |||
| ## Semantic Checks | ||
|
|
||
| - [](SymbolResolution.md); |
There was a problem hiding this comment.
Should we put the name between []?
|
|
||
| StarLasu supports exporting ASTs to JSON and XML. | ||
| StarLasu supports exporting ASTs to JSON and XML. | ||
| Additionally, kolasu supports import/export from the [Lionweb](https://github.com/Strumenta/kolasu/blob/main/lionweb/src/main/kotlin/com/strumenta/kolasu/lionweb/LionWebModelConverter.kt) format. |
There was a problem hiding this comment.
Also Tylasu should have support for LionWeb, I think
|
|
||
| ## Declarative symbol resolution | ||
|
|
||
| As mentioned in the previous section, it is surely possible to manually implement symbol resolution as some kind of tree-traversal algorithm. However, StarLasu provides support to ease such task and allows the developer to focus on language-specific concerns by providing rules for each reference in a given AST. |
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.
Enhancing the documentation by working on the following sections: