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 a `.refactor` script (such as [`gencpp.refactor`](../base/gencpp.refactor)) 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).  
Its main uage is the [c_library generation](../gen_c_library/).

## Build & Run Scripts

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

**`build.ps1`**  
Build c_library, segmented, singleheader, unreal. Supports msvc or clang, release or debug.

```
args:
    c_library
    segemented
    singleheader
    unreal
    clang
    msvc    : By default this project builds with clang, specifying msvc will build with MSVC.
    debug
    release : By default this project builds in debug mode, specifying release will build with optimizations.
```

**`package_release.ps1`**  
Will build the build all, then package the release into a zip file.

*Note: My env is Windows 11 with MSVC 2022 and clang 16.0.6*
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
work on gettings things compiling again after restructuring 2024-12-10 17:45:00 -08:00			`refactor.ps1` Provides a way to run the [refactor](github.com/Ed94/refactor) program. It uses the a `.refactor` script (such as [`gencpp.refactor`](../base/gencpp.refactor)) 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
work on gettings things compiling again after restructuring 2024-12-10 17:45:00 -08: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).
			`Its main uage is the [c_library generation](../gen_c_library/).`
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
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.`

More refactoring, getting rid of meson in favor of just powershell scripts 2023-08-19 05:21:28 -07:00			`build.ps1`
work on gettings things compiling again after restructuring 2024-12-10 17:45:00 -08:00			`Build c_library, segmented, singleheader, unreal. Supports msvc or clang, release or debug.`
More refactoring, getting rid of meson in favor of just powershell scripts 2023-08-19 05:21:28 -07:00
			```
			`args:`
work on gettings things compiling again after restructuring 2024-12-10 17:45:00 -08:00			`c_library`
			`segemented`
More refactoring, getting rid of meson in favor of just powershell scripts 2023-08-19 05:21:28 -07:00			`singleheader`
work on gettings things compiling again after restructuring 2024-12-10 17:45:00 -08:00			`unreal`
More refactoring, getting rid of meson in favor of just powershell scripts 2023-08-19 05:21:28 -07:00			`clang`
Simpilication of build script, added initial support for tests 2023-08-20 09:31:24 -07:00			`msvc : By default this project builds with clang, specifying msvc will build with MSVC.`
			`debug`
			`release : By default this project builds in debug mode, specifying release will build with optimizations.`
More refactoring, getting rid of meson in favor of just powershell scripts 2023-08-19 05:21:28 -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
Simpilication of build script, added initial support for tests 2023-08-20 09:31:24 -07:00			`package_release.ps1`
work on gettings things compiling again after restructuring 2024-12-10 17:45:00 -08:00			`Will build the build all, then package the release into a zip file.`
More refactoring, getting rid of meson in favor of just powershell scripts 2023-08-19 05:21:28 -07:00
			`Note: My env is Windows 11 with MSVC 2022 and clang 16.0.6`