Ed_
9b6dc3cbd8
The NumEntries checks need to be deferred until the end as a final unresolved check on valdiation. As if there really is a discrepancy of entires it should be revealed by the specific entry failing. Right now the latest failure with the single header check involves a define directive specifically the define does omit whitespace properly and so the check interprets the different cached content to be non-equivalent. This will happen with all unvalidated aspects of the AST ( expressions, function bodies, etc ) There are two ways to resolve, either make an AST that can tokenize all items (not realistic), or I need to strip non-syntax important whitespace and then cache the string. This would mean removing everything but a single whitespace for all content within a content string. Otherwise, I would have to somehow make sure the content of the string has the exact formatting between both files for the definitions that matter. AST types with this issue: * Define Directive * Pragma Directive * Comment * Execution * Platform Attributes * Untyped Comments can technically be left unverified as they do not matter semantically. When the serialization is first emitted, the content these strings should for the most part be equivalent. However I do see some possible failures for that if a different style of bracket placment is used (between the serialization). At that point what I could do is just leave those unverified and just emit the content to the user as warning that the ast and the other compared could not be verified. Those technically can be handled on a per-eye basis, and worst case the tests with the compiler will in the determine if any critical defintions are missing for the user. |
||
|---|---|---|
| .. | ||
| auxillary | ||
| components | ||
| dependencies | ||
| enums | ||
| helpers | ||
| bootstrap.cpp | ||
| gen.cpp | ||
| gen.dep.cpp | ||
| gen.dep.hpp | ||
| gen.hpp | ||
| Readme.md | ||
Documentation
The library is fragmented into a series of headers and source files meant to be scanned in and then generated to a tailored format for the target gen files.
The principal (user) files are gen.hpp and gen.cpp.
They contain includes for its various components: components/<component_name>.<hpp/cpp>
Dependencies are bundled into gen.dep.<hpp/cpp>.
Just like the gen.<hpp/cpp> they include their components: dependencies/<dependency_name>.<hpp/cpp>
The fle processors are in their own respective files. (Ex: file_processors/<file_processor>.<hpp/cpp> )
They directly include depedencies/file_handling.<hpp/cpp> as the core library does not include file processing by defualt.
TODO : Right now the library is not finished, as such the first self-hosting iteration is still WIP
Both libraries use pre-generated (self-hosting I guess) version of the library to then generate the latest version of itself.
The default gen.bootstrap.cpp located in the project folder is meant to be produce a standard segmented library, where the components of the library
have relatively dedicated header and source files. Dependencies included at the top of the file and each header starting with a pragma once.
The output will be in the project/gen directory (if the directory does not exist, it will create it).
Use those to get a general idea of how to make your own tailored version.
Feature Macros:
GEN_DEFINE_ATTRIBUTE_TOKENS: Allows user to define their own attribute macros for use in parsing.- This is auto-generated if using the bootstrap or single-header generation
- Note: The user will use the
AttributeTokens.csvwhen the library is fully self-hosting.
GEN_DEFINE_LIBRARY_CORE_CONSTANTS: Optional typename codes as they are non-standard to C/C++ and not necessary to library usageGEN_DONT_ENFORCE_GEN_TIME_GUARD: By default, the library ( gen.hpp/ gen.cpp ) expects the macroGEN_TIMEto be defined, this disables that.GEN_ENFORCE_STRONG_CODE_TYPES: Enforces casts to filtered code types.GEN_EXPOSE_BACKEND: Will expose symbols meant for internal use only.GEN_ROLL_OWN_DEPENDENCIES: Optional override so that user may define the dependencies themselves.
On multi-threading
Currently unsupported.
Extending the library
This library is relatively very small, and can be extended without much hassle.
The convention you'll see used throughout the interface of the library is as follows:
- Check name or parameters to make sure they are valid for the construction requested
- Create a code object using
make_code. - Populate immediate fields (Name, Type, ModuleFlags, etc)
- Populate sub-entires using
add_entry. If using the default serialization functionto_string, follow the order at which entires are expected to appear (there is a strong ordering expected).
Names or Content fields are interned strings and thus showed be cached using get_cached_string if its desired to preserve that behavior.
def_operator is the most sophisticated constructor as it has multiple permutations of definitions that could be created that are not trivial to determine if valid.
The library has its code segmented into component files, use it to help create a derived version without needing to have to rewrite a generated file directly or build on top of the header via composition or inheritance. When the scanner is implemented, this will be even easier to customize.