tlang
/
documentation
mirror of https://github.com/tbklang/documentation
1
0
Fork 0
Code Issues 3 Packages Projects 2 Releases Activity

Lexical 

- Added TODO table for the remaining methods
This commit is contained in:
Tristan B. Velloza Kildaire 2023-07-09 16:53:22 +02:00
parent bf37603077
commit 02729f8b20
2 changed files with 36 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/implementation/31-lexical.md
View File

@ -149,6 +149,8 @@ unittest
}
```
------------------------------------------------------------------------
#### Using `performLex()`
This method contains a looping structure which will read
@ -216,3 +218,18 @@ character == ':';
Whenever this method returns `true` it generally means you should flush
the current token, start a new token add the offending spliter token and
flush that as well.
### Others
TODO: Document the other methods remaining
| Method name | Return type | Description |
|------------------------------------|-------------|-------------|
| `numbericalEncoderSegmentFetch()` | `x` | Desc. |
| `isBuildUpNumerical()` | `x` | Desc. |
| `isNumericalStr(string)` | `x` | Desc. |
| `isSpliter(char)` | `x` | Desc. |
| `isNumericalEncoder(char)` | `x` | Desc. |
| `isNumericalEncoder_Size(char)` | `x` | Desc. |
| `isNumericalEncoder_Signage(char)` | `x` | Desc. |
| `isValidEscape_String(char)` | `x` | Desc. |

20
docs_src/implementation/31-lexical.md
View File

@ -123,6 +123,8 @@ unittest
}
```
---
#### Using `performLex()`
This method contains a looping structure which will read character-by-character from the `sourceCode` string and follow the rules of the grammar (TODO: add link), looping whilst there are still characters available for consumption (`position < sourceCode.length`).
@ -179,4 +181,20 @@ character == ':';
• \texttt{=} | (TODO: make it texttt) \texttt{\^} \texttt{!} \texttt{\\n}(TODO: \n not appearing) \texttt{\~} \texttt{.} \texttt{\:}
Whenever this method returns `true` it generally means you should flush the current token, start a new token add the offending spliter token and flush that as well.
Whenever this method returns `true` it generally means you should flush the current token, start a new token add the offending spliter token and flush that as well.
### Others
TODO: Document the other methods remaining
| Method name | Return type | Description |
|-----------------------------------------|---------------|-------------------------------------------------------------------------------|
| `numbericalEncoderSegmentFetch()` | `x` | Desc. |
| `isBuildUpNumerical()` | `x` | Desc. |
| `isNumericalStr(string)` | `x` | Desc. |
| `isSpliter(char)` | `x` | Desc. |
| `isNumericalEncoder(char)` | `x` | Desc. |
| `isNumericalEncoder_Size(char)` | `x` | Desc. |
| `isNumericalEncoder_Signage(char)` | `x` | Desc. |
| `isValidEscape_String(char)` | `x` | Desc. |