ed/refactor
1
0
Fork 0
mirror of https://github.com/Ed94/refactor.git synced 2024-09-20 04:37:33 -07:00
Code Issues Packages Projects Releases Wiki Activity

fixing grammatical mistakes

Browse Source
This commit is contained in:
Edward R. Gonzalez 2023-03-17 02:19:32 -04:00
parent 231c893c6b
commit 7e120ae5e9
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Readme.md
View File

@ -15,7 +15,7 @@ Syntax :
* `include` Preprocessor include <file> related identifiers. * `include` Preprocessor include <file> related identifiers.
* `word` Fixed sized identifier. * `word` Fixed sized identifier.
* `namespace` Variable sized identifiers, mainly intended to redefine c-namespace of an identifier. * `namespace` Variable sized identifiers, mainly intended to redefine c-namespace of an identifier.
* `,` is used to delimit arguments to word or namespace. * `,` is used to delimit arguments (if doing a find and replace).
* `L-Value` is the signature to modify. * `L-Value` is the signature to modify.
* `R-Value` is the substitute ( only available if rule does not use `not` keyword ) * `R-Value` is the substitute ( only available if rule does not use `not` keyword )
@ -25,18 +25,19 @@ However, the rest of the categorical keywords (word, namespace), can really be u
There is no semantic awareness this is truely just a simple find and replace, but with some filters specifiable, and There is no semantic awareness this is truely just a simple find and replace, but with some filters specifiable, and
words/namespaces only being restricted to the rules for C/C++ identifiers (alphanumeric or underscores only) words/namespaces only being restricted to the rules for C/C++ identifiers (alphanumeric or underscores only)
The main benefit for using this over other stuff is its faster and more ergonomic for large refactors on libraries that The main benefit for using this over alts is its problably more ergonomic and performant for large refactors on libraries that
you may want to have automated in a script. you may want to have automated in a script.
There are other programs more robust for doing that sort of thing but I was not able to find something this simple. There are other programs more robust for doing that sort of thing but I was not able to find something this simple.
**Note** **Note**
* Building for debug provides some nice output with context on a per-line basis. * Building for debug provides some nice output with context on a per-line basis.
* Release will only show errors for asserts (that will kill the refactor early). * Release will only show errors for asserts (that will kill the refactor early).
* If the refactor crashes, the files previously written to will retain their changes. * If the refactor crashes, the files previously written to will retain their changes.
Make sure to have the code backed up on a VCS or in some other way. Make sure to have the code backed up on a VCS or in some other way.
* This was compiled using meson with ninja and clang on windows 11. The ZPL library used however should work fine on the other major os platforms and compiler venders. * This was compiled using meson with ninja and clang on windows 11. The ZPL library used however should work fine on the other major os platforms and compiler venders.
* The scripts used for building and otherwise are in the scripts directory and are all in powershell (with exception to the meson.build). Techncially there should be a powershell package available on other platorms but worst case it should be pretty easily to port these scripts to w/e shell script you'd perfer. * The scripts used for building and otherwise are in the scripts directory and are all in powershell (with exception to the meson.build). Techncially there should be a powershell package available on other platorms but worst case it should be pretty easy to port these scripts to w/e shell script you'd perfer.
TODO: TODO:
* Possibly come up with a better name. * Possibly come up with a better name.

8
project/_Docs.md → project/Readme.md
View File

@ -11,8 +11,8 @@ The files are setup to compile as one unit. As such the source files for Bloat,
Bloat contains some aliasing of some C++ keywords and does not use the standard library. Instead a library called ZPL is used (Single header replacement). Bloat contains some aliasing of some C++ keywords and does not use the standard library. Instead a library called ZPL is used (Single header replacement).
The program has pretty much no optimizations made to it, its just regular loops with no threading. The program has pretty much no optimizations made to it, its just regular loops with no threading.
Just tried to keep the memory at reasonable size of what it does. Just tried to keep the memory at a reasonable size for what it does.
The program execution is pretty much outlined quite clearly in `int main()`. The program execution is pretty much outlined quite clearly in `int main()`.
@ -27,7 +27,7 @@ The program execution is pretty much outlined quite clearly in `int main()`.
`*` This technically can be skipped on windows, may be worth doing to reduce latency of process shutdown. `*` This technically can be skipped on windows, may be worth doing to reduce latency of process shutdown.
There are constraints of specific sizes of variables; There are constraints for specific variables;
* `Path_Size_Largest` : Longest path size is set to 1 KB of characters. * `Path_Size_Largest` : Longest path size is set to 1 KB of characters.
* `Token_Max_Length` : Set to 1 KB characters as well. * `Token_Max_Length` : Set to 1 KB characters as well.
@ -36,6 +36,6 @@ There are constraints of specific sizes of variables;
The `Path_Size_Largest` and `Token_Max_Length` are compile-time constraints that the runtime will not have a fallback for, if 1 KB is not enough it will need to be changed for your use case. The `Path_Size_Largest` and `Token_Max_Length` are compile-time constraints that the runtime will not have a fallback for, if 1 KB is not enough it will need to be changed for your use case.
`Array_Reserve_Num` is used to dictate the assumed amount of tokens will be held in total for any of spec's arrays holding ignores and refactor entries. If any of the array's exceed 4 KB they will grow trigigng a resize which will bog down the speed of the refactor. Adjust if you think you can increase or lower for use case. `Array_Reserve_Num` is used to dictate the assumed amount of tokens will be held in total for any of spec's arrays holding ignores and refactor entries. If any of the array's exceed 4 KB they will grow triggering a resize which will bog down the speed of the refactor. Adjust if you think you can increase or lower for use case.
Initial Global arena size is a finicy thing, its most likely going to be custom allocator at one point so that it can handle growing properly, right now its just grows if the amount of memory file paths will need for sources is greater than 1 MB. Initial Global arena size is a finicy thing, its most likely going to be custom allocator at one point so that it can handle growing properly, right now its just grows if the amount of memory file paths will need for sources is greater than 1 MB.