Kernel Language examples + Experimental VS Code Extension (#40)

faberga · christopherngutierrez · commit e803922f47b1 · 2024-10-21T16:15:25.000-07:00
* Experimental VS Code Extension for the Kernel Language
* Kernel Language examples

Signed-off-by: Flavio Bergamaschi &lt;flavio@intel.com&gt;
diff --git a/kerngen/.gitignore b/kerngen/.gitignore
@@ -7,3 +7,9 @@ data/
 
 # Python artefacts
 **/__pycache__/
+
+# Playground
+zz_playground/
+
+# vs code local config
+.vscode
diff --git a/kerngen/kerngen.py b/kerngen/kerngen.py
diff --git a/kerngen/tutorials/SimpleExamples/ADD_16K1rns.ker b/kerngen/tutorials/SimpleExamples/ADD_16K1rns.ker
@@ -0,0 +1,5 @@
+CONTEXT BGV 16384 1
+DATA a 1
+DATA b 1
+DATA c 1
+ADD c a b
diff --git a/kerngen/tutorials/SimpleExamples/ADD_16K4rns.ker b/kerngen/tutorials/SimpleExamples/ADD_16K4rns.ker
@@ -0,0 +1,5 @@
+CONTEXT BGV 16384 4
+DATA a 1
+DATA b 1
+DATA c 1
+ADD c a b
diff --git a/kerngen/tutorials/SimpleExamples/ADD_8K1rns.ker b/kerngen/tutorials/SimpleExamples/ADD_8K1rns.ker
@@ -0,0 +1,5 @@
+CONTEXT BGV 8192 1
+DATA a 1
+DATA b 1
+DATA c 1
+ADD c a b
diff --git a/kerngen/tutorials/SimpleExamples/ADD_8K4rns.ker b/kerngen/tutorials/SimpleExamples/ADD_8K4rns.ker
@@ -0,0 +1,5 @@
+CONTEXT BGV 8192 4
+DATA a 1
+DATA b 1
+DATA c 1
+ADD c a b
diff --git a/kerngen/tutorials/SimpleExamples/ADD_C16K1rns_pyramid.ker b/kerngen/tutorials/SimpleExamples/ADD_C16K1rns_pyramid.ker
@@ -0,0 +1,21 @@
+CONTEXT BGV 16384 1
+# inputs
+DATA a 2
+DATA b 2
+DATA c 2
+DATA d 2
+DATA e 2
+DATA f 2
+# temp variables
+DATA temp1 2
+DATA temp2 2
+DATA temp3 2
+DATA temp4 2
+# output
+DATA g 2
+# Code
+ADD temp1 a b
+ADD temp2 c d
+ADD temp3 e f
+ADD temp4 temp1 temp2
+ADD f temp3 temp4
diff --git a/kerngen/tutorials/SimpleExamples/ADD_C16K4rns.ker b/kerngen/tutorials/SimpleExamples/ADD_C16K4rns.ker
@@ -0,0 +1,5 @@
+CONTEXT BGV 16384 4
+DATA a 2
+DATA b 2
+DATA c 2
+ADD c a b
diff --git a/kerngen/tutorials/SimpleExamples/ADD_C8K1rns.ker b/kerngen/tutorials/SimpleExamples/ADD_C8K1rns.ker
@@ -0,0 +1,5 @@
+CONTEXT BGV 8192 1
+DATA a 2
+DATA b 2
+DATA c 2
+ADD c a b
diff --git a/kerngen/tutorials/SimpleExamples/ADD_C8K4rns.ker b/kerngen/tutorials/SimpleExamples/ADD_C8K4rns.ker
@@ -0,0 +1,5 @@
+CONTEXT BGV 8192 4
+DATA a 2
+DATA b 2
+DATA c 2
+ADD c a b
diff --git a/kerngen/tutorials/SimpleExamples/MUL_C16K1rns.ker b/kerngen/tutorials/SimpleExamples/MUL_C16K1rns.ker
@@ -0,0 +1,5 @@
+CONTEXT BGV 16384 1 1
+DATA a 2
+DATA b 2
+DATA c 3
+MUL c a b
diff --git a/kerngen/tutorials/SimpleExamples/RELIN_C16K1rns.ker b/kerngen/tutorials/SimpleExamples/RELIN_C16K1rns.ker
@@ -0,0 +1,4 @@
+CONTEXT BGV 16384 1 1
+DATA a 3
+DATA b 2
+RELIN b a
diff --git a/kerngen/vsc_kerlang_extension/.vscodeignore b/kerngen/vsc_kerlang_extension/.vscodeignore
@@ -0,0 +1,3 @@
+.vscode/**
+.vscode-test/**
+.gitignore
diff --git a/kerngen/vsc_kerlang_extension/LICENSE b/kerngen/vsc_kerlang_extension/LICENSE
@@ -0,0 +1,201 @@
+                                 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 2022 Intel Corporation
+
+   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.
diff --git a/kerngen/vsc_kerlang_extension/README.md b/kerngen/vsc_kerlang_extension/README.md
@@ -0,0 +1,29 @@
+# HERACLES Kernel Language extension for VS Code
+
+This is an experimental first attempt at creating a VS Code extension that
+understands the grammar of the HERACLES Kernel Language.
+
+<mark>
+<b>This is experimental code. Use it at your own risk.</b>
+</mark>
+
+## Installation
+
+A pre-packaged version of this extension '.vsix' file is avialble in the
+current folder.
+You can manually install using the Install from VSIX command in the Extensions
+view command dropdown. For an alternative way to install a local VS Code 
+extensions, please check the
+[VS Code documentaiton](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix).
+
+## Features
+
+The only available feature is the toggle comments on a line
+
+## Known Issues
+
+The actual grammar is not yet working.
+
+## Release Notes
+
+None at the moment.
diff --git a/kerngen/vsc_kerlang_extension/grammars/kerlang.tmLanguage.json b/kerngen/vsc_kerlang_extension/grammars/kerlang.tmLanguage.json
@@ -0,0 +1,15 @@
+{
+  "scopeName": "source.kerlang",
+  "fileTypes": ["kerlang"],
+  "patterns": [
+    {
+      "name": "comment.line.number-sign.kerlang",
+      "match": "# .*$"
+    },
+    {
+      "name": "keyword.other.kerlang",
+      "match": "\b(COPY|ADD|MUL|MULI|RELIN|NTT|INTT|MOD|MODUP|SQUARE)\b"
+    }
+  ],
+  "repository": {}
+}
diff --git a/kerngen/vsc_kerlang_extension/heracles-kerlang-syntax-0.0.1.vsix b/kerngen/vsc_kerlang_extension/heracles-kerlang-syntax-0.0.1.vsix
diff --git a/kerngen/vsc_kerlang_extension/language-configuration.json b/kerngen/vsc_kerlang_extension/language-configuration.json
@@ -0,0 +1,5 @@
+{
+  "comments": {
+    "lineComment": "# "
+  }
+}
diff --git a/kerngen/vsc_kerlang_extension/package.json b/kerngen/vsc_kerlang_extension/package.json
@@ -0,0 +1,31 @@
+{
+    "name": "heracles-kerlang-syntax",
+    "displayName": "HERACLES Kernel Language Syntax Extension",
+    "description": "Syntax Extension for HERACLES kernel-language",
+    "version": "0.0.1",
+    "publisher": "Intel",
+    "private": true,
+    "license": "Apache-2.0",
+    "engines": {
+      "vscode": "^1.92.0"
+    },
+    "categories": ["Programming Languages"],
+    "contributes": {
+      "languages": [
+        {
+          "id": "kerlang",
+          "aliases": ["KerLang", "kerlang"],
+          "extensions": [".ker"],
+          "configuration": "./language-configuration.json"
+        }
+      ],
+      "grammars": [
+        {
+          "language": "kerlang",
+          "scopeName": "source.kerlang",
+          "path": "./grammars/kerlang.tmLanguage.json"
+        }
+      ]
+    },
+    "repository": {}
+}
diff --git a/kerngen/vsc_kerlang_extension/themes/kerlang.tmTheme.json b/kerngen/vsc_kerlang_extension/themes/kerlang.tmTheme.json
@@ -0,0 +1,11 @@
+{
+    "tokenColors": [
+    {
+        "scope": "comment",
+        "settings": {
+            "foreground": "#d4922f",
+            "fontStyle": "italic"
+        }
+    }
+]
+}
