-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e029263
commit 6f3e47e
Showing
6 changed files
with
299 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| // MIT License | ||
| // | ||
| // Copyright (C) 2022-2024 Geraldo Luis da Silva Ribeiro | ||
| // | ||
| // ░░░░░░░░░░░░░░░░░ | ||
| // ░░░░░░░█▀▀░▀█▀░░░ | ||
| // ░░░█░█░█░░░░█░░░░ | ||
| // ░░░█▀▀░▀▀▀░▀▀▀░░░ | ||
| // ░░░▀░░░░░░░░░░░░░ | ||
| // ░░░░░░░░░░░░░░░░░ | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to | ||
| // deal in the Software without restriction, including without limitation the | ||
| // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or | ||
| // sell copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS | ||
| // IN THE SOFTWARE. | ||
|
|
||
| #include <spdlog/spdlog.h> | ||
|
|
||
| #include <VHDLFormatPluginStepParser.hpp> | ||
| #include <fstream> | ||
|
|
||
| namespace microci { | ||
| using namespace std; | ||
|
|
||
| // ---------------------------------------------------------------------- | ||
| // | ||
| // ---------------------------------------------------------------------- | ||
| void VHDLFormatPluginStepParser::Parse(const YAML::Node &step) { | ||
| auto data = mMicroCI->DefaultDataTemplate(); | ||
|
|
||
| auto volumes = parseVolumes(step); | ||
| auto envs = parseEnvs(step); | ||
| data = parseRunAs(step, data, "user"); | ||
| data = parseNetwork(step, data, "none"); | ||
| tie(data, volumes, envs) = parseSsh(step, data, volumes, envs); | ||
|
|
||
| data["STEP_NAME"] = stepName(step); | ||
| data["STEP_DESCRIPTION"] = | ||
| stepDescription(step, "Process source code to make readable or match to a project code style"); | ||
| data["FUNCTION_NAME"] = sanitizeName(stepName(step)); | ||
| data["DOCKER_IMAGE"] = stepDockerImage(step, "intmain/microci_ghdl:latest"); | ||
|
|
||
| auto emacsConfigFilename = inja::render( "{{ WORKSPACE }}/emacs_vhdl_formatter.lisp", data); | ||
| ofstream emacsConfig(emacsConfigFilename); | ||
| emacsConfig << inja::render(R"( | ||
| (custom-set-variables | ||
| '(vhdl-align-group-separate "^\\s---*$") | ||
| '(vhdl-align-groups t) | ||
| '(vhdl-align-same-indent t) | ||
| '(vhdl-auto-align t) | ||
| '(vhdl-basic-offset 2) | ||
| '(vhdl-beautify-options '(t ;; whitespace cleanup | ||
| t ;; single statement per line | ||
| t ;; indentation | ||
| t ;; aligment | ||
| t)) ;; case fixing | ||
| ;; '(vhdl-standard '(8 nil)) | ||
| '(vhdl-standard '(8 (ams math))) ;; VHDL-08 | ||
| '(vhdl-array-index-record-field-in-sensitivity-list t) | ||
| '(vhdl-upper-case-attributes t) | ||
| '(vhdl-upper-case-constants t) | ||
| '(vhdl-upper-case-enum-values t) | ||
| '(vhdl-upper-case-keywords t) | ||
| '(vhdl-upper-case-types t) | ||
| '(vhdl-use-direct-instantiation 'always) | ||
| ) | ||
| )", | ||
| data); | ||
| emacsConfig.close(); | ||
|
|
||
| beginFunction(data, envs); | ||
| prepareRunDocker(data, envs, volumes); | ||
|
|
||
| mMicroCI->Script() << inja::render(R"( \ | ||
| bash -c "cd {{ WORKSPACE }})", data); | ||
|
|
||
| copySshIfAvailable(step, data); | ||
|
|
||
| mMicroCI->Script() << inja::render(R"( \ | ||
| && emacs -batch -l {{ WORKSPACE }}/emacs_vhdl_formatter.lisp \ | ||
| ../hdl/**/*.vhd \ | ||
| -f vhdl-beautify-buffer)", data ); | ||
|
|
||
| mMicroCI->Script() << "\"\n"; | ||
| endFunction(data); | ||
| } | ||
| } // namespace microci | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| // MIT License | ||
| // | ||
| // Copyright (c) 2022-2024 Geraldo Luis da Silva Ribeiro | ||
| // | ||
| // ░░░░░░░░░░░░░░░░░ | ||
| // ░░░░░░░█▀▀░▀█▀░░░ | ||
| // ░░░█░█░█░░░░█░░░░ | ||
| // ░░░█▀▀░▀▀▀░▀▀▀░░░ | ||
| // ░░░▀░░░░░░░░░░░░░ | ||
| // ░░░░░░░░░░░░░░░░░ | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to | ||
| // deal in the Software without restriction, including without limitation the | ||
| // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or | ||
| // sell copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS | ||
| // IN THE SOFTWARE. | ||
|
|
||
| // DON'T EDIT THIS FILE, INSTEAD UPDATE ../new/vhdl-format.yml | ||
| unsigned char ___new_vhdl_format_yml[] = { | ||
| 0x23, 0x20, 0x20, 0x20, 0x23, 0x20, 0x76, 0x68, 0x64, 0x6c, 0x2d, 0x66, 0x6f, 0x72, 0x6d, 0x61, 0x74, 0x20, | ||
| 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, | ||
|
|
||
| 0x0a, 0x23, 0x20, 0x20, 0x20, | ||
|
|
||
| 0x0a, 0x23, 0x7b, 0x7b, 0x7b, | ||
|
|
||
| 0x0a, 0x73, 0x74, 0x65, 0x70, 0x73, 0x3a, | ||
|
|
||
| 0x0a, 0x20, 0x20, 0x2d, 0x20, 0x6e, 0x61, 0x6d, 0x65, 0x3a, 0x20, 0x22, 0x56, 0x48, 0x44, 0x4c, 0x20, 0x73, | ||
| 0x6f, 0x75, 0x72, 0x63, 0x65, 0x20, 0x63, 0x6f, 0x64, 0x65, 0x20, 0x66, 0x6f, 0x72, 0x6d, 0x61, 0x74, 0x74, | ||
| 0x65, 0x72, 0x20, 0x61, 0x6e, 0x64, 0x20, 0x62, 0x65, 0x61, 0x75, 0x74, 0x69, 0x66, 0x69, 0x65, 0x72, 0x22, | ||
|
|
||
| 0x0a, 0x20, 0x20, 0x20, 0x20, 0x64, 0x65, 0x73, 0x63, 0x72, 0x69, 0x70, 0x74, 0x69, 0x6f, 0x6e, 0x3a, 0x20, | ||
| 0x22, 0x50, 0x72, 0x6f, 0x63, 0x65, 0x73, 0x73, 0x20, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x20, 0x63, 0x6f, | ||
| 0x64, 0x65, 0x20, 0x74, 0x6f, 0x20, 0x6d, 0x61, 0x6b, 0x65, 0x20, 0x72, 0x65, 0x61, 0x64, 0x61, 0x62, 0x6c, | ||
| 0x65, 0x20, 0x6f, 0x72, 0x20, 0x6d, 0x61, 0x74, 0x63, 0x68, 0x20, 0x74, 0x6f, 0x20, 0x61, 0x20, 0x70, 0x72, | ||
| 0x6f, 0x6a, 0x65, 0x63, 0x74, 0x20, 0x63, 0x6f, 0x64, 0x65, 0x20, 0x73, 0x74, 0x79, 0x6c, 0x65, 0x22, | ||
|
|
||
| 0x0a, 0x20, 0x20, 0x20, 0x20, 0x72, 0x75, 0x6e, 0x5f, 0x61, 0x73, 0x3a, 0x20, 0x75, 0x73, 0x65, 0x72, | ||
|
|
||
| 0x0a, 0x20, 0x20, 0x20, 0x20, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x3a, | ||
|
|
||
| 0x0a, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x6e, 0x61, 0x6d, 0x65, 0x3a, 0x20, 0x22, 0x76, 0x68, 0x64, 0x6c, | ||
| 0x2d, 0x66, 0x6f, 0x72, 0x6d, 0x61, 0x74, 0x22, | ||
|
|
||
| 0x0a, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x3a, | ||
|
|
||
| 0x0a, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x2d, 0x20, 0x22, 0x73, 0x72, 0x63, 0x2f, 0x2a, 0x2e, | ||
| 0x76, 0x68, 0x64, 0x22, | ||
|
|
||
| 0x0a, 0x23, 0x7d, 0x7d, 0x7d, | ||
|
|
||
| 0x0a, 0x23, 0x20, 0x76, 0x69, 0x6d, 0x3a, 0x20, 0x73, 0x70, 0x65, 0x6c, 0x6c, 0x20, 0x73, 0x70, 0x65, 0x6c, | ||
| 0x6c, 0x6c, 0x61, 0x6e, 0x67, 0x3d, 0x65, 0x6e, | ||
|
|
||
| 0x0a}; | ||
| unsigned int ___new_vhdl_format_yml_len = 307; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # # vhdl-format plugin | ||
| # | ||
| #{{{ | ||
| steps: | ||
| - name: "VHDL source code formatter and beautifier" | ||
| description: "Process source code to make readable or match to a project code style" | ||
| run_as: user | ||
| plugin: | ||
| name: "vhdl-format" | ||
| source: | ||
| - "src/*.vhd" | ||
| #}}} | ||
| # vim: spell spelllang=en |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| // MIT License | ||
| // | ||
| // Copyright (C) 2022-2024 Geraldo Luis da Silva Ribeiro | ||
| // | ||
| // ░░░░░░░░░░░░░░░░░ | ||
| // ░░░░░░░█▀▀░▀█▀░░░ | ||
| // ░░░█░█░█░░░░█░░░░ | ||
| // ░░░█▀▀░▀▀▀░▀▀▀░░░ | ||
| // ░░░▀░░░░░░░░░░░░░ | ||
| // ░░░░░░░░░░░░░░░░░ | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to | ||
| // deal in the Software without restriction, including without limitation the | ||
| // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or | ||
| // sell copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS | ||
| // IN THE SOFTWARE. | ||
|
|
||
| #include <spdlog/spdlog.h> | ||
|
|
||
| #include <VHDLFormatPluginStepParser.hpp> | ||
| #include <fstream> | ||
|
|
||
| namespace microci { | ||
| using namespace std; | ||
|
|
||
| // ---------------------------------------------------------------------- | ||
| // | ||
| // ---------------------------------------------------------------------- | ||
| void VHDLFormatPluginStepParser::Parse(const YAML::Node &step) { | ||
| auto data = mMicroCI->DefaultDataTemplate(); | ||
|
|
||
| auto volumes = parseVolumes(step); | ||
| auto envs = parseEnvs(step); | ||
| data = parseRunAs(step, data, "user"); | ||
| data = parseNetwork(step, data, "none"); | ||
| tie(data, volumes, envs) = parseSsh(step, data, volumes, envs); | ||
|
|
||
| data["STEP_NAME"] = stepName(step); | ||
| data["STEP_DESCRIPTION"] = | ||
| stepDescription(step, "Process source code to make readable or match to a project code style"); | ||
| data["FUNCTION_NAME"] = sanitizeName(stepName(step)); | ||
| data["DOCKER_IMAGE"] = stepDockerImage(step, "intmain/microci_ghdl:latest"); | ||
|
|
||
| auto emacsConfigFilename = inja::render( "{{ WORKSPACE }}/emacs_vhdl_formatter.lisp", data); | ||
| ofstream emacsConfig(emacsConfigFilename); | ||
| emacsConfig << inja::render(R"( | ||
| (custom-set-variables | ||
| '(vhdl-align-group-separate "^\\s---*$") | ||
| '(vhdl-align-groups t) | ||
| '(vhdl-align-same-indent t) | ||
| '(vhdl-auto-align t) | ||
| '(vhdl-basic-offset 2) | ||
| '(vhdl-beautify-options '(t ;; whitespace cleanup | ||
| t ;; single statement per line | ||
| t ;; indentation | ||
| t ;; aligment | ||
| t)) ;; case fixing | ||
| ;; '(vhdl-standard '(8 nil)) | ||
| '(vhdl-standard '(8 (ams math))) ;; VHDL-08 | ||
| '(vhdl-array-index-record-field-in-sensitivity-list t) | ||
| '(vhdl-upper-case-attributes t) | ||
| '(vhdl-upper-case-constants t) | ||
| '(vhdl-upper-case-enum-values t) | ||
| '(vhdl-upper-case-keywords t) | ||
| '(vhdl-upper-case-types t) | ||
| '(vhdl-use-direct-instantiation 'always) | ||
| ) | ||
| )", | ||
| data); | ||
| emacsConfig.close(); | ||
|
|
||
| beginFunction(data, envs); | ||
| prepareRunDocker(data, envs, volumes); | ||
|
|
||
| mMicroCI->Script() << inja::render(R"( \ | ||
| bash -c "cd {{ WORKSPACE }})", data); | ||
|
|
||
| copySshIfAvailable(step, data); | ||
|
|
||
| mMicroCI->Script() << inja::render(R"( \ | ||
| && emacs -batch -l {{ WORKSPACE }}/emacs_vhdl_formatter.lisp \ | ||
| ../hdl/**/*.vhd \ | ||
| -f vhdl-beautify-buffer)", data ); | ||
|
|
||
| mMicroCI->Script() << "\"\n"; | ||
| endFunction(data); | ||
| } | ||
| } // namespace microci | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters