ed/gencpp
1
0
Fork 0
mirror of https://github.com/Ed94/gencpp.git synced 2025-07-30 00:46:59 -07:00
Code Issues Packages Projects Releases Wiki Activity

Proofing docs

Browse Source
This commit is contained in:
Edward R. Gonzalez
2024-12-12 10:24:21 -05:00
parent 71b7320e1c
commit 55427822a0
4 changed files with 17 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/AST_Design.md
View File

@@ -37,7 +37,7 @@ The full definitions of all asts are within:
* [`ast.hpp`](../base/components/ast.hpp)
* [`ast_types.hpp`](../base/components/ast_types.hpp)
* [`code_types.hpp`](../base/components/ast_types.hpp)
* [`code_types.hpp`](../base/components/code_types.hpp)
The C/C++ interface procedures are located with `ast.hpp` (for the Code type), and `code_types.hpp` for all others.

4
docs/Parser_Algo.md
View File

@@ -12,8 +12,8 @@ gencpp uses a hand-written recursive descent parser. Both the lexer and parser c
### Lexer
The lex procedure does the lexical pass of content provided as a `StrC` type.
The tokens are stored (for now) in `gen::parser::Lexer_Tokens`.
The lex procedure does the lexical pass of content provided as a `StrC` type.
The tokens are stored (for now) in `Lexer_Tokens`.
Fields:

4
docs/Readme.md
View File

@@ -4,7 +4,7 @@
Contains:
* [AST_Design](./AST_Design.md): Overvie of ASTs
* [AST_Design](./AST_Design.md): Overview of ASTs
* [AST Types](./AST_Types.md): Listing of all AST types along with their Code type interface.
* [Parsing](./Parsing.md): Overview of the parsing interface.
* [Parser Algo](./Parser_Algo.md): In-depth breakdown of the parser's implementation.
@@ -49,9 +49,9 @@ However, the user may specifiy memory configuration.
https://github.com/Ed94/gencpp/blob/eea4ebf5c40d5d87baa465abfb1be30845b2377e/base/components/ast.hpp#L396-L461
*`StringCahced` is a typedef for `StrC` (a string slice), to denote it is an interned string*
*`CodeType` is enum taggin the type of code. Has an underlying type of `u32`*
*`OperatorT` is a typedef for `EOperator::Type` which has an underlying type of `u32`*
*`StringCahced` is a typedef for `String const`, to denote it is an interned string*
*`String` is the dynamically allocated string type for the library*
AST widths are setup to be AST_POD_Size.