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
7e120ae5e9
refactor/Readme.md

46 lines
2.5 KiB
Markdown
Raw Normal View History

First working prototype. TODO: I need to cleanup memory.
2023-03-12 18:34:55 -07:00
# refactor
Rework of project implementation For include and multi-file support. I still need to debug it, Test will be adjusted as well; I want to get all the files not just zpl refactored using a powershell script. I dropped the idea of semantically identifiying macros. While it may be possible, I don't see the utility vs the regular idendentifier distinction. I want to keep the refactoring as simple as possible, where it just takes one pass to go through a file without any context to other files. So far the ignores behave as a good guard filter for unwanted refactors and the only true weak area was the includes (which should be aleviated with the coming support for it.
2023-03-16 23:09:19 -07:00
Refactor c/c++ files (and problably others) with ease.
First working prototype. TODO: I need to cleanup memory.
2023-03-12 18:34:55 -07:00
Parameters :
Rework of project implementation For include and multi-file support. I still need to debug it, Test will be adjusted as well; I want to get all the files not just zpl refactored using a powershell script. I dropped the idea of semantically identifiying macros. While it may be possible, I don't see the utility vs the regular idendentifier distinction. I want to keep the refactoring as simple as possible, where it just takes one pass to go through a file without any context to other files. So far the ignores behave as a good guard filter for unwanted refactors and the only true weak area was the includes (which should be aleviated with the coming support for it.
2023-03-16 23:09:19 -07:00
* `-num` : Used if more than one source file is provided (if used, number of destination files provided MUST MATCH).
did some reorganization, build script changes Moved header and source to code Changed all build scripts to just be powershell (preferred) Added clang format (but forgot that you cannot format zpl because it hangs clang format) Code changes: * Removed long names just using short names (there is an issue with the opts_compile...) * Removed zpl.refactored.h (its generated now when `.\build.ps1 test` is run * Modified zpl.h to just have the radix sort modification.
2023-03-13 17:17:12 -07:00
* `-src` : Source file to refactor
* `-dst` : Destination file after the refactor (omit to use the same as source)
* `-spec` : Specification containing rules to use for the refactor.
First working prototype. TODO: I need to cleanup memory.
2023-03-12 18:34:55 -07:00
Syntax :
* `not` Omit word or namespace.
Rework of project implementation For include and multi-file support. I still need to debug it, Test will be adjusted as well; I want to get all the files not just zpl refactored using a powershell script. I dropped the idea of semantically identifiying macros. While it may be possible, I don't see the utility vs the regular idendentifier distinction. I want to keep the refactoring as simple as possible, where it just takes one pass to go through a file without any context to other files. So far the ignores behave as a good guard filter for unwanted refactors and the only true weak area was the includes (which should be aleviated with the coming support for it.
2023-03-16 23:09:19 -07:00
* `include` Preprocessor include <file> related identifiers.
First working prototype. TODO: I need to cleanup memory.
2023-03-12 18:34:55 -07:00
* `word` Fixed sized identifier.
* `namespace` Variable sized identifiers, mainly intended to redefine c-namespace of an identifier.
fixing grammatical mistakes
2023-03-16 23:19:32 -07:00
* `,` is used to delimit arguments (if doing a find and replace).
First working prototype. TODO: I need to cleanup memory.
2023-03-12 18:34:55 -07:00
* `L-Value` is the signature to modify.
* `R-Value` is the substitute ( only available if rule does not use `not` keyword )
Rework of project implementation For include and multi-file support. I still need to debug it, Test will be adjusted as well; I want to get all the files not just zpl refactored using a powershell script. I dropped the idea of semantically identifiying macros. While it may be possible, I don't see the utility vs the regular idendentifier distinction. I want to keep the refactoring as simple as possible, where it just takes one pass to go through a file without any context to other files. So far the ignores behave as a good guard filter for unwanted refactors and the only true weak area was the includes (which should be aleviated with the coming support for it.
2023-03-16 23:09:19 -07:00
The only keyword here excluisve to c/c++ is the `include` as it does search specifically for `#include <L-Value>`.
However, the rest of the categorical keywords (word, namespace), can really be used for any langauge.
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)
fixing grammatical mistakes
2023-03-16 23:19:32 -07:00
The main benefit for using this over alts is its problably more ergonomic and performant for large refactors on libraries that
Rework of project implementation For include and multi-file support. I still need to debug it, Test will be adjusted as well; I want to get all the files not just zpl refactored using a powershell script. I dropped the idea of semantically identifiying macros. While it may be possible, I don't see the utility vs the regular idendentifier distinction. I want to keep the refactoring as simple as possible, where it just takes one pass to go through a file without any context to other files. So far the ignores behave as a good guard filter for unwanted refactors and the only true weak area was the includes (which should be aleviated with the coming support for it.
2023-03-16 23:09:19 -07:00
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.
**Note**
fixing grammatical mistakes
2023-03-16 23:19:32 -07:00
Rework of project implementation For include and multi-file support. I still need to debug it, Test will be adjusted as well; I want to get all the files not just zpl refactored using a powershell script. I dropped the idea of semantically identifiying macros. While it may be possible, I don't see the utility vs the regular idendentifier distinction. I want to keep the refactoring as simple as possible, where it just takes one pass to go through a file without any context to other files. So far the ignores behave as a good guard filter for unwanted refactors and the only true weak area was the includes (which should be aleviated with the coming support for it.
2023-03-16 23:09:19 -07:00
* 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).
* 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.
* 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.
fixing grammatical mistakes
2023-03-16 23:19:32 -07:00
* 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.
First working prototype. TODO: I need to cleanup memory.
2023-03-12 18:34:55 -07:00
TODO:
* Possibly come up with a better name.
Rework of project implementation For include and multi-file support. I still need to debug it, Test will be adjusted as well; I want to get all the files not just zpl refactored using a powershell script. I dropped the idea of semantically identifiying macros. While it may be possible, I don't see the utility vs the regular idendentifier distinction. I want to keep the refactoring as simple as possible, where it just takes one pass to go through a file without any context to other files. So far the ignores behave as a good guard filter for unwanted refactors and the only true weak area was the includes (which should be aleviated with the coming support for it.
2023-03-16 23:09:19 -07:00
* Test to see how much needs to be ported for other platforms (if at all)
* Provide binaries in the release page for github. (debug and release builds)
Reference in New Issue Copy Permalink