gencpp/scripts/Readme.md

# Scripts

Generation, testing, and cleanup scripts for the test directory are found here along with `natvis` and `natstepfilter` files for debugging.

## Refactoring

`refactor.ps1` Provides a way to run the [refactor](github.com/Ed94/refactor) program. It uses the `gencpp.refactor` script to complete a mass refactor of all content within the files of the specified within the script.

Currently `refactor` only supports naive sort of *find and replace* feature set and will not be able to rename identifiers excluisvely to a specific context (such as only renaming member names of a specific struct, etc).

**Note: The following macros are used with specifiers and token parsing within the library:**

* global
* internal
* local_persist
* forceinline
* neverinline

IF they are changed the following files would need adjustment:

* `./project/enums/ESpecifier.csv`
* `./project/enums/ETokType.csv`
* `./project/helpers/helper.hpp`

## Build & Run Scripts

**`clean.ps1`**  
Remove any generated content from the repository.

**`bootstrap.ps1`**  
Generate a version of gencpp where components are inlined directly to `gen.<hpp/cpp>` and `gen. <hpp/cpp>`  
Any heavily preprocessed code is not inlined and are instead generated using the code in the `helpers` directory.

**`singleheader.ps1`**  
Generate a single-header version of the library where all code that would normally good in the usual four files (see bootstrap) are inlined into a single `gen.hpp` file.  
As with the bootstrap, any heavily preprocessed code is not inlined and instead generated with helper code.

**`test.gen.build.ps1`**  
Build the metaprogram for generating the test code.

**`test.gen.ps1`**  
Build (if not already) the metaprogram for generating test code, then run it to generate code.

**`test.build.ps1`**  
Build and run metaprogram, build test program.

**`test.run.ps1`**  
Build and run metaprogram, build and run test program.
Updated readmes 2023-07-15 20:38:53 -07:00			`# Scripts`

Reorganization of files, refactors, doc updates (WIP) Removing the gen. namespace from the files for components, dependencies, and file_processors. They are only necessary if the include directory is transparent, and in my case those are not. Made a docs directory. I'm offloading information from the main readme to there along with additional informationn I end up elaborating on down the line. Enum tables were moved to their own directory (project/enums). Library will not compile for now. Major refactor occuring with parsing related components. 2023-07-29 02:52:06 -07:00			Generation, testing, and cleanup scripts for the test directory are found here along with `natvis` and `natstepfilter` files for debugging.
Updated readmes 2023-07-15 20:38:53 -07:00
Reorganization of files, refactors, doc updates (WIP) Removing the gen. namespace from the files for components, dependencies, and file_processors. They are only necessary if the include directory is transparent, and in my case those are not. Made a docs directory. I'm offloading information from the main readme to there along with additional informationn I end up elaborating on down the line. Enum tables were moved to their own directory (project/enums). Library will not compile for now. Major refactor occuring with parsing related components. 2023-07-29 02:52:06 -07:00			`## Refactoring`
Updated readmes 2023-07-15 20:38:53 -07:00
Reorganization of files, refactors, doc updates (WIP) Removing the gen. namespace from the files for components, dependencies, and file_processors. They are only necessary if the include directory is transparent, and in my case those are not. Made a docs directory. I'm offloading information from the main readme to there along with additional informationn I end up elaborating on down the line. Enum tables were moved to their own directory (project/enums). Library will not compile for now. Major refactor occuring with parsing related components. 2023-07-29 02:52:06 -07:00			`refactor.ps1` Provides a way to run the [refactor](github.com/Ed94/refactor) program. It uses the `gencpp.refactor` script to complete a mass refactor of all content within the files of the specified within the script.
Updated readmes 2023-07-15 20:38:53 -07:00
Reorganization of files, refactors, doc updates (WIP) Removing the gen. namespace from the files for components, dependencies, and file_processors. They are only necessary if the include directory is transparent, and in my case those are not. Made a docs directory. I'm offloading information from the main readme to there along with additional informationn I end up elaborating on down the line. Enum tables were moved to their own directory (project/enums). Library will not compile for now. Major refactor occuring with parsing related components. 2023-07-29 02:52:06 -07:00			Currently `refactor` only supports naive sort of find and replace feature set and will not be able to rename identifiers excluisvely to a specific context (such as only renaming member names of a specific struct, etc).

Scripting updates, some refactors.. Made a package release script. Did refactors based on some design considerations Still need to make some major decisions... 2023-08-09 15:47:59 -07:00			`Note: The following macros are used with specifiers and token parsing within the library:`

			`* global`
			`* internal`
			`* local_persist`
			`* forceinline`
			`* neverinline`

			`IF they are changed the following files would need adjustment:`

			* `./project/enums/ESpecifier.csv`
			* `./project/enums/ETokType.csv`
			* `./project/helpers/helper.hpp`

Reorganization of files, refactors, doc updates (WIP) Removing the gen. namespace from the files for components, dependencies, and file_processors. They are only necessary if the include directory is transparent, and in my case those are not. Made a docs directory. I'm offloading information from the main readme to there along with additional informationn I end up elaborating on down the line. Enum tables were moved to their own directory (project/enums). Library will not compile for now. Major refactor occuring with parsing related components. 2023-07-29 02:52:06 -07:00			`## Build & Run Scripts`

			`clean.ps1`
			`Remove any generated content from the repository.`

			`bootstrap.ps1`
			Generate a version of gencpp where components are inlined directly to `gen.<hpp/cpp>` and `gen. <hpp/cpp>`
			Any heavily preprocessed code is not inlined and are instead generated using the code in the `helpers` directory.

Scripting updates, some refactors.. Made a package release script. Did refactors based on some design considerations Still need to make some major decisions... 2023-08-09 15:47:59 -07:00			`singleheader.ps1`
Reorganization of files, refactors, doc updates (WIP) Removing the gen. namespace from the files for components, dependencies, and file_processors. They are only necessary if the include directory is transparent, and in my case those are not. Made a docs directory. I'm offloading information from the main readme to there along with additional informationn I end up elaborating on down the line. Enum tables were moved to their own directory (project/enums). Library will not compile for now. Major refactor occuring with parsing related components. 2023-07-29 02:52:06 -07:00			Generate a single-header version of the library where all code that would normally good in the usual four files (see bootstrap) are inlined into a single `gen.hpp` file.
			`As with the bootstrap, any heavily preprocessed code is not inlined and instead generated with helper code.`

			`test.gen.build.ps1`
			`Build the metaprogram for generating the test code.`

			`test.gen.ps1`
			`Build (if not already) the metaprogram for generating test code, then run it to generate code.`

			`test.build.ps1`
			`Build and run metaprogram, build test program.`

			`test.run.ps1`
			`Build and run metaprogram, build and run test program.`