Adds syntax highlighting VS Code extensions for .bin_fmt and .isa files. PiperOrigin-RevId: 696127120 Change-Id: I5de33f2aa98094597a1f4d7df63f5e3c21e20891
diff --git a/mpact/sim/decoder/vscode/README.md b/mpact/sim/decoder/vscode/README.md new file mode 100644 index 0000000..6ba6a6c --- /dev/null +++ b/mpact/sim/decoder/vscode/README.md
@@ -0,0 +1,46 @@ +# MPACT-Sim Syntax Highlighting VS Code Extensions + +This directory contains two directories that provide the source code for the VS +Code extensions that enable syntax highlighting for .isa and .bin_fmt files in +VS Code. + +For the time being, they are not published in the VS Code marketplace, but have +to be built and then manually installed in VS Code as detailed below. + +## Building and installing + +### Prerequisites + +Before you can build an extension, make sure you have `node/npm` and `vsce` +installed. You should be able to install node using most package managers. Once +node is installed you use `nvm` to install `vsce`: + +``` +nvm install -g @vscode/vsce +``` + +### Building the extension + +Each syntax highlighting extension is built by executing the following command +from within the syntax highlighting extension source directory (isa/binfmt): + +``` +vsce package --allow-missing-repository +``` + +This will produce a file `vscode-mpact-sim-<name>-N.N.N.vsix` that can be +installed in VS Code. + +### Installing the extension + +Repeat the following for each (bin_fmt and isa) extension: + +1. Open VS Code +1. Select the *Extensions* view on the left hand side of the window. +1. Click on the three dots (...) in the top right corner of the Extensions + panel. +1. Select `Install from VSIX...` +1. Navigate to and select the `.vsix` file generated previously and click + `Open`. + +The extensions should now be installed and available.
diff --git a/mpact/sim/decoder/vscode/binfmt/CHANGELOG.md b/mpact/sim/decoder/vscode/binfmt/CHANGELOG.md new file mode 100644 index 0000000..5b617b2 --- /dev/null +++ b/mpact/sim/decoder/vscode/binfmt/CHANGELOG.md
@@ -0,0 +1,5 @@ +# Change Log + +## Version 0.0.1 + +- Initial release
diff --git a/mpact/sim/decoder/vscode/binfmt/LICENSE b/mpact/sim/decoder/vscode/binfmt/LICENSE new file mode 100644 index 0000000..14c4343 --- /dev/null +++ b/mpact/sim/decoder/vscode/binfmt/LICENSE
@@ -0,0 +1,227 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +The files in util/renode/renode_cs subdirectory were derived from files +copyrighted by AntMicro under the MIT License and are therefore covered by it. + +The MIT License (MIT) + +Copyright (c) Antmicro <www.antmicro.com> + +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.
diff --git a/mpact/sim/decoder/vscode/binfmt/README.md b/mpact/sim/decoder/vscode/binfmt/README.md new file mode 100644 index 0000000..8e92ffc --- /dev/null +++ b/mpact/sim/decoder/vscode/binfmt/README.md
@@ -0,0 +1,25 @@ +# MPACT-Sim .bin_fmt Syntax Highlighting + +## Features + +This extension offers syntax highlighting of the description files used to +generate binary format instruction decoder C++ code for MPACT-Sim +instruction-set simulators. See https://github.com/google/mpact-sim for more +information about syntax and how the description files are used to generate +instruction decoder code. + + + +## Known Issues + +None. + +## Release Notes + +### 0.0.1 + +Initial release of syntax highlighting extension for MPACT-Sim .isa files. + +## For more information + +* [MPACT-Sim](https://github.com/google/mpact-sim)
diff --git a/mpact/sim/decoder/vscode/binfmt/icons/icon.png b/mpact/sim/decoder/vscode/binfmt/icons/icon.png new file mode 100644 index 0000000..d4e3148 --- /dev/null +++ b/mpact/sim/decoder/vscode/binfmt/icons/icon.png Binary files differ
diff --git a/mpact/sim/decoder/vscode/binfmt/images/bin_fmt.png b/mpact/sim/decoder/vscode/binfmt/images/bin_fmt.png new file mode 100644 index 0000000..a272497 --- /dev/null +++ b/mpact/sim/decoder/vscode/binfmt/images/bin_fmt.png Binary files differ
diff --git a/mpact/sim/decoder/vscode/binfmt/language-configuration.json b/mpact/sim/decoder/vscode/binfmt/language-configuration.json new file mode 100644 index 0000000..8f162a0 --- /dev/null +++ b/mpact/sim/decoder/vscode/binfmt/language-configuration.json
@@ -0,0 +1,30 @@ +{ + "comments": { + // symbol used for single line comment. Remove this entry if your language does not support line comments + "lineComment": "//", + // symbols used for start and end a block comment. Remove this entry if your language does not support block comments + "blockComment": [ "/*", "*/" ] + }, + // symbols used as brackets + "brackets": [ + ["{", "}"], + ["[", "]"], + ["(", ")"] + ], + // symbols that are auto closed when typing + "autoClosingPairs": [ + ["{", "}"], + ["[", "]"], + ["(", ")"], + ["\"", "\""], + ["'", "'"] + ], + // symbols that can be used to surround a selection + "surroundingPairs": [ + ["{", "}"], + ["[", "]"], + ["(", ")"], + ["\"", "\""], + ["'", "'"] + ] +} \ No newline at end of file
diff --git a/mpact/sim/decoder/vscode/binfmt/package.json b/mpact/sim/decoder/vscode/binfmt/package.json new file mode 100644 index 0000000..f84b5c0 --- /dev/null +++ b/mpact/sim/decoder/vscode/binfmt/package.json
@@ -0,0 +1,26 @@ +{ + "name": "vscode-mpact-sim-binfmt", + "displayName": "MPACT-Sim bin_fmt", + "description": "Syntax highlighting for .bin_fmt files for MPACT-Sim", + "icon": "icons/icon.png", + "version": "0.0.1", + "engines": { + "vscode": "^1.86.0" + }, + "categories": [ + "Programming Languages" + ], + "contributes": { + "languages": [{ + "id": "bin_fmt", + "aliases": ["bin_fmt", "bin_fmt"], + "extensions": [".bin_fmt"], + "configuration": "./language-configuration.json" + }], + "grammars": [{ + "language": "bin_fmt", + "scopeName": "source.bin_fmt", + "path": "./syntaxes/bin_fmt.tmLanguage.json" + }] + } +}
diff --git a/mpact/sim/decoder/vscode/binfmt/syntaxes/bin_fmt.tmLanguage.json b/mpact/sim/decoder/vscode/binfmt/syntaxes/bin_fmt.tmLanguage.json new file mode 100644 index 0000000..e2de089 --- /dev/null +++ b/mpact/sim/decoder/vscode/binfmt/syntaxes/bin_fmt.tmLanguage.json
@@ -0,0 +1,236 @@ +{ + "name": "bin_fmt", + "scopeName": "source.bin_fmt", + "foldingStartMarker": "\\{\\s*$", + "foldingStopMarker": "^\\s*\\}", + "patterns": [ + { "include": "#assignment" }, + { "include": "#block_comments" }, + { "include": "#line_comments" }, + { "include": "#include_file" }, + { "include": "#include_decl" }, + { "include": "#instruction_group"}, + { "include": "#format_decl"}, + { "include": "#field_decl"}, + { "include": "#overlay_decl"}, + { "include": "#decoder"}, + { "include": "#signed_unsigned" }, + { "include": "#bin_number" }, + { "include": "#constants" }, + { "include": "#strings"}, + { "include": "#reserved_words"}, + { "include": "#reserved_other"} + ], + "repository": { + "line_comments": { + "name": "comment.line.double-slash.bin_fmt", + "begin": "//", + "end": "$" + }, + "block_comments": { + "name": "comment.block.bin_fmt", + "begin": "/\\*", + "end": "\\*\\/" + }, + "namespace_decl": { + "begin": "\\b(namespace)\\s*", + "end": ";", + "beginCaptures": { + "1": { "name": "keyword.other.bin_fmt" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#namespace_list"} + ] + }, + "namespace_list": { + "match": "\\b(\\w+)\\b", + "captures": { + "1": { "name": "support.class.bin_fmt" } + } + }, + "include_decl": { + "begin": "\\b(includes)\\s*{", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.other.bin_fmt" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#include_file" } + ] + }, + "include_file": { + "begin": "^\\s*(#include)\\b", + "end": "$", + "beginCaptures": { + "1": { "name": "keyword.control.bin_fmt" } + }, + "patterns": [{ "include": "#strings" }] + }, + "instruction_group": { + "begin": "\\b(instruction)\\s+(group)\\s+(\\w+)\\s*\\[(\\d+)\\]\\s*:\\s*(\\w+)\\s*{", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.control.bin_fmt" }, + "2": { "name": "keyword.control.bin_fmt" }, + "3": { "name": "constant.numeric.bin_fmt" }, + "4": { "name": "support.class.bin_fmt" }, + "5": { "name": "support.class.bin_fmt"} + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#instruction" } + ] + }, + "signed_unsigned": { + "match": "\\b(signed|unsigned)\\b", + "name": "support.type.bin_fmt" + }, + "field_decl": { + "match": "\\b(signed|unsigned)\\s+(\\w+)\\s*\\[(\\d+)\\]\\s*;", + "captures": { + "1": { "name": "support.type.bin_fmt"}, + "2": { "name": "variable.other.bin_fmt"}, + "3": { "name": "constant.numeric.bin_fmt"} + } + }, + "overlay_decl": { + "begin": "\\b(signed|unsigned)\\s+(\\w+)\\s*\\[(\\d+)\\]\\s*=", + "end": ";", + "beginCaptures": { + "1": { "name": "support.type.bin_fmt"}, + "2": { "name": "variable.other.bin_fmt"}, + "3": { "name": "constant.numeric.bin_fmt"} + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#array_ref"}, + { "include": "#identifier"}, + { "include": "#bin_number"}, + { "include": "#constants"} + ] + }, + "format_decl": { + "begin": "\\b(format)\\s+(\\w+)\\s*\\[(\\d+)\\]\\s*:?", + "end": "{", + "beginCaptures": { + "1": { "name": "keyword.control.bin_fmt"}, + "2": { "name": "support.class.bin_fmt"}, + "3": { "name": "constant.numeric.bin_fmt"} + }, + "patterns": [ + { "include": "#format_name"} + ] + }, + "instruction": { + "begin": "\\b(\\w+)\\s*:\\s*(\\w+)\\s*:", + "end": ";", + "beginCaptures": { + "1" : { "name": "support.function.bin_fmt"}, + "2" : { "name": "support.class.bin_fmt"} + }, + "patterns": [ + { "include": "#identifier"}, + { "include": "#array_ref"}, + { "include": "#bin_number"}, + { "include": "#constants"} + ] + }, + "decoder": { + "begin": "\\b(decoder)\\s+(\\w+)\\s+{", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.control.bin_fmt"}, + "2": { "name": "support.class.bin_fmt"} + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#namespace_decl" }, + { "include": "#include_decl" }, + { "include": "#opcode_enum"}, + { "include": "#format_list"}, + { "include": "#format_name"} + ] + }, + "opcode_enum": { + "begin": "\\b(opcode_enum)\\s*=\\s*", + "end": ";", + "beginCaptures": { + "1": { "name": "keyword.other.bin_fmt"} + }, + "patterns": [ + {"include": "#strings"} + ] + }, + "reserved_words": { + "match": "\\b(format|fields|overlays|includes|instruction|group|decoder|opcode_enum)\\b", + "name": "keyword.control.bin_fmt" + }, + "reserved_other": { + "match": "\\b(includes)\\b", + "name": "keyword.other.bin_fmt" + }, + "brackets": { + "name": "brackets.bin_fmt", + "match": "[\\{\\}\\(\\)\\[\\]]" + }, + "bin_number": { + "match": "\\b0b[01]+(\\'?[01])*\\b", + "name": "constant.numeric.bin_fmt" + }, + "constants": { + "name": "constant.numeric.bin_fmt", + "match": "\\b\\d+\\b" + }, + "array_ref": { + "begin": "\\b(\\w+)\\s*\\[", + "end": "\\]", + "beginCaptures": { + "1": { "name": "variable.other.bin_fmt"} + }, + "patterns": [ + { "include": "#range"}, + { "include": "#bin_number"}, + { "include": "#constants"} + ] + }, + "range": { + "match": "\\b(\\d+)\\.\\.(\\d+)\\b", + "captures": { + "1": { "name": "constant.numeric.bin_fmt"}, + "2": { "name": "constant.numeric.bin_fmt"} + } + }, + "identifier": { + "match": "\\b([a-zA-Z_][a-zA-Z_0-9]*)\\b", + "name": "variable.other.bin_fmt" + }, + "format_list": { + "begin": "\\b([a-zA-Z_][a-zA-Z_0-9]*)\\s*=\\s*{", + "end": "}\\s*;", + "beginCaptures" : { + "1": { "name": "support.class.bin_fmt"} + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#format_name"} + ] + }, + "format_name": { + "match": "\\b([a-zA-Z_][a-zA-Z_0-9]*)\\b", + "name": "support.class.bin_fmt" + }, + "strings": { + "name": "string.quoted.double.bin_fmt", + "begin": "\"", + "end": "\"" + } + } +}
diff --git a/mpact/sim/decoder/vscode/isa/CHANGELOG.md b/mpact/sim/decoder/vscode/isa/CHANGELOG.md new file mode 100644 index 0000000..5b617b2 --- /dev/null +++ b/mpact/sim/decoder/vscode/isa/CHANGELOG.md
@@ -0,0 +1,5 @@ +# Change Log + +## Version 0.0.1 + +- Initial release
diff --git a/mpact/sim/decoder/vscode/isa/LICENSE b/mpact/sim/decoder/vscode/isa/LICENSE new file mode 100644 index 0000000..14c4343 --- /dev/null +++ b/mpact/sim/decoder/vscode/isa/LICENSE
@@ -0,0 +1,227 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +The files in util/renode/renode_cs subdirectory were derived from files +copyrighted by AntMicro under the MIT License and are therefore covered by it. + +The MIT License (MIT) + +Copyright (c) Antmicro <www.antmicro.com> + +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.
diff --git a/mpact/sim/decoder/vscode/isa/README.md b/mpact/sim/decoder/vscode/isa/README.md new file mode 100644 index 0000000..875ded4 --- /dev/null +++ b/mpact/sim/decoder/vscode/isa/README.md
@@ -0,0 +1,25 @@ +# MPACT-Sim .isa Syntax Highlighting + +## Features + +This extension offers syntax highlighting of the description files used to +generate ISA (representation independent) instruction decoder C++ code for +MPACT-Sim instruction-set simulators. See https://github.com/google/mpact-sim +for more information about syntax and how the description files are used to +generate instruction decoder code. + + + +## Known Issues + +None. + +## Release Notes + +### 0.0.1 + +Initial release of syntax highlighting extension for MPACT-Sim .isa files. + +## For more information + +* [MPACT-Sim](https://github.com/google/mpact-sim)
diff --git a/mpact/sim/decoder/vscode/isa/icons/icon.png b/mpact/sim/decoder/vscode/isa/icons/icon.png new file mode 100644 index 0000000..0cf6b32 --- /dev/null +++ b/mpact/sim/decoder/vscode/isa/icons/icon.png Binary files differ
diff --git a/mpact/sim/decoder/vscode/isa/images/isa.png b/mpact/sim/decoder/vscode/isa/images/isa.png new file mode 100644 index 0000000..8146c6c --- /dev/null +++ b/mpact/sim/decoder/vscode/isa/images/isa.png Binary files differ
diff --git a/mpact/sim/decoder/vscode/isa/language-configuration.json b/mpact/sim/decoder/vscode/isa/language-configuration.json new file mode 100644 index 0000000..8f162a0 --- /dev/null +++ b/mpact/sim/decoder/vscode/isa/language-configuration.json
@@ -0,0 +1,30 @@ +{ + "comments": { + // symbol used for single line comment. Remove this entry if your language does not support line comments + "lineComment": "//", + // symbols used for start and end a block comment. Remove this entry if your language does not support block comments + "blockComment": [ "/*", "*/" ] + }, + // symbols used as brackets + "brackets": [ + ["{", "}"], + ["[", "]"], + ["(", ")"] + ], + // symbols that are auto closed when typing + "autoClosingPairs": [ + ["{", "}"], + ["[", "]"], + ["(", ")"], + ["\"", "\""], + ["'", "'"] + ], + // symbols that can be used to surround a selection + "surroundingPairs": [ + ["{", "}"], + ["[", "]"], + ["(", ")"], + ["\"", "\""], + ["'", "'"] + ] +} \ No newline at end of file
diff --git a/mpact/sim/decoder/vscode/isa/package.json b/mpact/sim/decoder/vscode/isa/package.json new file mode 100644 index 0000000..a9ae057 --- /dev/null +++ b/mpact/sim/decoder/vscode/isa/package.json
@@ -0,0 +1,26 @@ +{ + "name": "vscode-mpact-sim-isa", + "displayName": "MPACT-Sim isa", + "description": "Syntax highlighting for .isa files for MPACT-Sim", + "icon": "icons/icon.png", + "version": "0.0.1", + "engines": { + "vscode": "^1.86.0" + }, + "categories": [ + "Programming Languages" + ], + "contributes": { + "languages": [{ + "id": "isa", + "aliases": ["isa", "isa"], + "extensions": [".isa"], + "configuration": "./language-configuration.json" + }], + "grammars": [{ + "language": "isa", + "scopeName": "source.isa", + "path": "./syntaxes/isa.tmLanguage.json" + }] + } +}
diff --git a/mpact/sim/decoder/vscode/isa/syntaxes/isa.tmLanguage.json b/mpact/sim/decoder/vscode/isa/syntaxes/isa.tmLanguage.json new file mode 100644 index 0000000..0038345 --- /dev/null +++ b/mpact/sim/decoder/vscode/isa/syntaxes/isa.tmLanguage.json
@@ -0,0 +1,410 @@ +{ + "name": "isa", + "scopeName": "source.isa", + "foldingStartMarker": "\\{\\s*$", + "foldingStopMarker": "^\\s*\\}", + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#assignment" }, + { "include": "#include_decl"}, + { "include": "#include_file" }, + { "include": "#isa_decl" }, + { "include": "#template" }, + { "include": "#bundle_decl" }, + { "include": "#slot_decl" }, + { "include": "#disasm_width" }, + { "include": "#constants" } + ], + "repository": { + "line_comments": { + "name": "comment.line.double-slash.isa", + "begin": "//", + "end": "$" + }, + "block_comments": { + "name": "comment.block.isa", + "begin": "/\\*", + "end": "\\*\\/" + }, + "include_decl": { + "begin": "\\b(includes)\\s*{", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.control.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#include_file" } + ] + }, + "include_file": { + "begin": "^\\s*(#include)\\b", + "end": "$", + "beginCaptures": { + "1": { "name": "keyword.control.isa" } + }, + "patterns": [{ "include": "#strings" }] + }, + "disasm_width": { + "begin": "\\b(disasm\\s+widths)\\b", + "end": ";", + "beginCaptures": { + "1": {"name": "variable.language.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#constants"} + ] + }, + "template": { + "begin": "\\b(template)\\s*<", + "end": ">", + "beginCaptures": { + "1": { "name": "keyword.control.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#template_param" } + ] + }, + "template_param": { + "match": "\\b(int)\\s+(\\w+)\\b", + "captures": { + "1": { "name": "support.type.isa" }, + "2": { "name": "variable.parameter.isa" } + } + }, + "isa_decl": { + "begin": "\\b(isa)\\b\\s*(\\w+)\\s*{", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.control.isa" }, + "2": { "name": "support.class.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#namespace_decl" }, + { "include": "#bundle_list" }, + { "include": "#slot_list" } + ] + }, + "bundle_list": { + "begin": "\\b(bundles)\\s*{", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.other.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#bundle_slot_ident" } + ] + }, + "slot_list": { + "begin": "\\b(slots)\\s*{", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.other.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#array_spec" }, + { "include": "#bundle_slot_ident" } + ] + }, + "array_spec": { + "begin": "\\[", + "end": "\\]", + "patterns": [{ "include": "#expression" }] + }, + "bundle_slot_ident": { + "match": "\\b([a-zA-Z_][a-zA-Z_0-9]*)\\b", + "name": "support.class.isa" + }, + "bundle_decl": { + "begin": "\\b(bundle)\\s+(\\w+)\\s*{", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.other.isa" }, + "2": { "name": "support.class.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#bundle_list" }, + { "include": "#slot_list" } + ] + }, + "slot_decl": { + "begin": "\\b(slot)\\b", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.control.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#include_decl" }, + { "include": "#default_latency" }, + { "include": "#default_size" }, + { "include": "#default_opcode" }, + { "include": "#default_attributes" }, + { "include": "#assignment" }, + { "include": "#opcodes_decl" }, + { "include": "#resources_assign" }, + { "include": "#slot_header" } + ] + }, + "slot_header": { + "begin": "\\b(\\w+)\\b", + "end": "{", + "captures": { + "1": { "name": "support.class.isa" } + }, + "patterns": [ + { "include": "#slot_template_use" }, + { "include": "#slot_name" } + ] + }, + "slot_template_use": { + "begin": "\\b(\\w+)\\s*<", + "end": ">", + "beginCaptures": { + "1": { "name": "support.class.isa" } + }, + "patterns": [{ "include": "#assignment" }] + }, + "slot_name": { + "match": "\\b(\\w+)\\b", + "name": "support.class.isa" + }, + "assignment": { + "begin": "\\b(int)\\s+(\\w+)\\s*=", + "end": ";", + "beginCaptures": { + "1": { "name": "support.type.isa" }, + "2": { "name": "variable.other.isa" } + }, + "patterns": [{ "include": "#expression" }] + }, + "semfunc_decl": { + "match": "\\b(semfunc)\\s*:\\s*(\".*\")", + "captures": { + "1": { "name": "keyword.other.isa" }, + "2": { "name": "string.quoted.double.isa" } + } + }, + "disasm_decl": { + "match": "\\b(disasm)\\s*:\\s*(\".*\")", + "captures": { + "1": { "name": "keyword.other.isa" }, + "2": { "name": "string.quoted.double.isa" } + } + }, + "resources_decl_name": { + "match": "\\b(resources)\\s*:\\s*(\\w+)", + "captures": { + "1": { "name": "keyword.other.isa" }, + "2": { "name": "variable.other.isa" } + } + }, + "resources_decl": { + "begin": "\\b(resources)\\s*:\\s*{", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.other.isa" } + }, + "patterns": [{ "include": "#dest_range" }, { "include": "#parameter" }] + }, + "resources_assign": { + "begin": "\\b(resources)\\s*(\\w+)\\s*=\\s*{", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.other.isa" }, + "2": { "name": "variable.other.isa" } + }, + "patterns": [{ "include": "#dest_range" }, { "include": "#parameter" }] + }, + "dest_parameter": { + "begin": "\\b([a-zA-Z_]\\w*)\\s*\\(", + "end": "\\)", + "beginCaptures": { + "1": { "name": "variable.parameter.isa" } + }, + "patterns": [{ "include": "#expression" }] + }, + "dest_range": { + "begin": "\\b([a-zA-Z_]\\w*)\\s*\\[", + "end": "\\]", + "beginCaptures": { + "1": { "name": "variable.parameter.isa" } + }, + "patterns": [{ "include": "#expression" }] + }, + "parameter": { + "match": "\\b([a-zA-Z_]\\w*)\\b", + "name": "variable.parameter.isa" + }, + "default_size": { + "begin": "\\b(default)\\s+(size)\\s*=", + "end": ";", + "beginCaptures": { + "1": { "name": "keyword.other.isa" }, + "2": { "name": "variable.language.isa" } + }, + "patterns": [{ "include": "#expression" }] + }, + "default_latency": { + "begin": "\\b(default)\\s+(latency)\\s*=", + "end": ";", + "beginCaptures": { + "1": { "name": "keyword.other.isa" }, + "2": { "name": "variable.language.isa" } + }, + "patterns": [{ "include": "#expression" }] + }, + "default_opcode": { + "begin": "\\b(default)\\s+(opcode)\\s*=", + "end": ";", + "beginCaptures": { + "1": { "name": "keyword.other.isa" }, + "2": { "name": "variable.language.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#semfunc_decl" }, + { "include": "#disasm_decl" }, + { "include": "#resources_decl_name" }, + { "include": "#resources_decl" }, + { "include": "#strings" } + ] + }, + "default_attributes": { + "begin": "\\b(default)\\s+(attributes)\\s*=", + "end": ";", + "beginCaptures": { + "1": { "name": "keyword.other.isa" }, + "2": { "name": "variable.language.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#parameter" }, + { "include": "#assignment" } + ] + }, + "opcode_decl": { + "begin": "\\b(\\w+)\\{", + "end": "}", + "beginCaptures": { + "1": { "name": "support.function.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#dest_parameter" }, + { "include": "#parameter" } + ] + }, + "opcode_delete": { + "match": "\\b(\\w+)\\s*=\\s*(delete)\\b", + "captures": { + "1": { "name": "support.function.isa" }, + "2": { "name": "keyword.other.isa" } + } + }, + "opcode_override": { + "match": "\\b(\\w+)\\s*=\\s*(override)\\b", + "captures": { + "1": { "name": "support.function.isa" }, + "2": { "name": "keyword.other.isa" } + } + }, + "opcodes_decl": { + "begin": "\\b(opcodes)\\s*{\\s*", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.control.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#semfunc_decl" }, + { "include": "#disasm_decl" }, + { "include": "#attribute_decl" }, + { "include": "#resources_decl_name" }, + { "include": "#resources_decl" }, + { "include": "#opcode_decl" }, + { "include": "#opcode_delete" }, + { "include": "#opcode_override" }, + { "include": "#strings" } + ] + }, + "attribute_decl": { + "begin": "\\b(attributes)\\s*:\\s*{", + "end": "}", + "beginCaptures": { + "1": { "name": "keyword.other.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#parameter" }, + { "include": "#assignment" } + ] + }, + "namespace_decl": { + "begin": "\\b(namespace)\\s*", + "end": ";", + "beginCaptures": { + "1": { "name": "keyword.other.isa" } + }, + "patterns": [ + { "include": "#line_comments" }, + { "include": "#block_comments" }, + { "include": "#namespace_list"} + ] + }, + "namespace_list": { + "match": "\\b(\\w+)\\b", + "captures": { + "1": { "name": "support.class.isa" } + } + }, + "brackets": { + "name": "brackets.isa", + "match": "[\\{\\}\\(\\)\\[\\]]" + }, + "strings": { + "name": "string.quoted.double.isa", + "begin": "\"", + "end": "\"" + }, + "constants": { + "name": "constant.numeric.isa", + "match": "\\b\\d+\\b" + }, + "expression": { + "patterns": [ + { "include": "#operators" }, + { "include": "#constants" }, + { "include": "#identifier" } + ] + }, + "identifier": { + "match": "\\b([a-zA-Z_][a-zA-Z_0-9]*)\\b", + "name": "variable.other.isa" + }, + "operators": { + "match": "\\b(\\+|-|\\*|/|\\.\\.)\\b", + "name": "keyword.operator.isa" + } + } +}
