mirror of
https://github.com/Ed94/gencpp.git
synced 2024-11-10 02:54:53 -08:00
Ed_
6da615e6da
- Made a better global allocator for the process. - Some small fixes to gen.hpp, removed clear_code_memory as I'm designing this library to for now never free any memory. - Fixes to memory usage for cached strings - Added missing verification for attributes in some upfront constructors. Added attribute param for def_type procedure. - Started to use internal and global keywords in gen.cpp for associated definitions - Progress toward getting the parsing constructors to support operator definitions. - There was an *attempt* to get parse_type to support parsing function types. Its not tested yet.... - Its not an nice setup, there is no validation of parameters, problably will add that in the future.
103 lines
4.0 KiB
Markdown
103 lines
4.0 KiB
Markdown
# Documentation
|
|
|
|
This library is currently in a bootstrapping phase.
|
|
|
|
Eventually it will have zero dependencies and have its code size severely constricted.
|
|
|
|
All dependencies are currently held within `Bloat.hpp` and `Bloat.cpp`
|
|
|
|
All the library code is contained in two files: `gen.hpp` and `gen.cpp`
|
|
|
|
|
|
## Bloat.hpp/cpp
|
|
|
|
Currently acts as the isolation header for thridparty dependencies along with code not directly related to the library.
|
|
|
|
Organization:
|
|
|
|
* ZPL inclusion and selective symbol exposure to global scope.
|
|
* Utility macro definitions used throughout the library.
|
|
* Global memory arena definition
|
|
* StrC and String definitions
|
|
* Token string formatter
|
|
* Formatted and Fatal Logs
|
|
|
|
The cpp contains the implementation of the global memory arena and the token formmatter.
|
|
|
|
Any global symbol pollution will be removed when dependencies are intergrated properly into the library.
|
|
|
|
## gen.hpp
|
|
|
|
While getting fleshed out, all feature macros are defined on the top of the header.
|
|
|
|
These macros are:
|
|
|
|
* `GEN_DEFINE_LIBRARY_CORE_CONSTANTS` : Optional typename codes as they are non-standard to C/C++ and not necessary to library usage
|
|
* `GEN_FEATURE_PARSING` : Defines the parse constructors
|
|
* `GEN_FEATURE_EDITOR` : Defines the file editing features for changing definitions based on ASTs
|
|
* `GEN_FEATURE_SCANNER` : Defines the file scanning features for generating ASTs
|
|
|
|
Due to the design of `gen.hpp` to support being written alongside runtime intended code (in the same file), all the code is wrapped in a `gen_time` `#ifdef` and then wrapped further in a `gen` namespace to avoid pollution of the global scope.
|
|
|
|
*Note: Its possible with the scanner feature to support parsing runtime files that use "generic" macros or identifiers with certain patterns.
|
|
This can be used to auto-queue generation of dependent definitions for the symbols used.*
|
|
|
|
### Organization
|
|
|
|
log_failure definition : based on whether to always use fatal on all errors
|
|
|
|
Major enum definitions and their associated functions used with the AST data
|
|
|
|
* `ECode` : Used to tag ASTs by their type
|
|
* `EOperator` : Used to tag operator overloads with thier op type
|
|
* `ESpecifier` : Used with specifier ASTs for all specifiers the user may tag an associated
|
|
AST with.
|
|
* `AccessSpec` : Used with class and struct ASTs to denote the public, protected, or private fields.
|
|
* `ModuleFlag` : Used with any valid definition that can have export or import related keywords assoicated with it.
|
|
|
|
#### Data Structures
|
|
|
|
`StringTable` : Hash table for cached strings. (`StringCached` typedef used to denote strings managed by it)
|
|
|
|
`AST` : The node data strucuture for the code.
|
|
`Code` : Wrapper for `AST` with functionality for handling it appropriately.
|
|
|
|
`TypeTable` : Hash table for cached typename ASTs.
|
|
|
|
#### Gen Interface
|
|
|
|
First set of fowards are either backend functions used for various aspects of AST generation or configurating allocators used for different containers.
|
|
|
|
Interface fowards defined in order of: Upfront, Parsing, Untyped.
|
|
|
|
From there forwards for the File handlers are defined: Builder, Editor, Scanner.
|
|
|
|
#### Macros
|
|
|
|
General helper macros are defined along with the optional DSL macros.
|
|
|
|
#### Constants
|
|
|
|
Constants including optional ones are defined.
|
|
|
|
#### Inlines
|
|
|
|
Inlined functions related to the AST datatype that required forwards for gen interface functions are defined.
|
|
|
|
## gen.cpp
|
|
|
|
* Static data defined at the top.
|
|
* AST Body case macros are next.
|
|
* AST implementation follows
|
|
* Gen interface begins with its `init`, `deinit`, etc.. Until `make_code_entires`
|
|
* operator__validate defined, which will be used to verify if an operator definition is constructible.
|
|
* Allocator interface for data arrays, code pool, code entries, string arenas, and string table.
|
|
* Helper macros used throughout the constructor API
|
|
* Upfront constructors, following the same order as shown in the header.
|
|
* Incremental constructors
|
|
* Parsing constructors, it defines its own lexer, and has many helper functions for parsing not exposed through the header.
|
|
* Untyped constructors
|
|
* Builder
|
|
* Editor
|
|
* Scanner
|