Initial commit

Author: joakimwinum

.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "tuesday"
+      time: "19:30"
+      timezone: "CET"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "tuesday"
+      time: "19:30"
+      timezone: "CET"

.github/workflows/python-package.yml

@@ -0,0 +1,45 @@
+name: Python package
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install autopep8 flake8 coverage pytest mypy
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with autopep8 and get statistics from flake8
+      run: |
+        # exit-zero treats all errors as warnings.
+        # show statistics for Python syntax errors or undefined names.
+        # the GitHub editor is 127 chars wide.
+        flake8 . --count --exit-zero --extend-ignore E402 --max-complexity=10 --max-line-length=127 --show-source --statistics
+        # stop the build if there are Python syntax errors.
+        autopep8 . --ignore E402 --recursive --diff --exit-code
+    - name: Test with pytest
+      run: |
+        coverage run -m pytest
+    - name: Report coverage statistics on modules
+      run: |
+        coverage report --fail-under=80 --show-missing
+    - name: Type checking with mypy
+      run: |
+        mypy --strict .

.gitignore

@@ -0,0 +1,4 @@
+__pycache__/
+dist/
+.coverage
+src/bytecorecompiler.egg-info/

.gitpod.Dockerfile

@@ -0,0 +1,4 @@
+FROM gitpod/workspace-full
+
+RUN pyenv install 3.11 \
+    && pyenv global 3.11

.gitpod.yml

@@ -0,0 +1,14 @@
+image:
+  file: .gitpod.Dockerfile
+tasks:
+  - init: pip3 install -r requirements.txt
+    command: autopep8 . --recursive --in-place && (pytest || true) && mypy --strict .
+vscode:
+  extensions:
+    - streetsidesoftware.code-spell-checker # The Code Spell Checker extension is GPLv3-licensed, separate from this project. See its docs for details.
+    - ms-toolsai.jupyter # The Jupyter extension is MIT-licensed, separate from this project. See its docs for details.
+    - ms-toolsai.jupyter-keymap # The Jupyter Keymap extension is MIT-licensed, separate from this project. See its docs for details.
+    - ms-toolsai.jupyter-renderers # The Jupyter Notebook Renderers extension is MIT-licensed, separate from this project. See its docs for details.
+    - ms-toolsai.vscode-jupyter-cell-tags # The Jupyter Cell Tags extension is MIT-licensed, separate from this project. See its docs for details.
+    - ms-toolsai.vscode-jupyter-slideshow # The Jupyter Slide Show extension is MIT-licensed, separate from this project. See its docs for details.
+    - ms-python.python # The Python extension is MIT-licensed, separate from this project. Dependencies: Jupyter (MIT), Pylance (Microsoft proprietary). See docs for details.

.pep8

@@ -0,0 +1,2 @@
+[pycodestyle]
+ignore = E402

.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+    "python.linting.mypyEnabled": true,
+    "python.linting.mypyArgs": [
+        "--strict"
+    ],
+    "cSpell.words": [
+        "bytecore",
+        "bytecorecompiler",
+        "subtractor",
+        "setuptools",
+        "pycache"
+    ]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Joakim Winum Lien
+
+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.

README.md

@@ -0,0 +1,155 @@
+# ByteCoreCompiler
+
+The ByteCoreCompiler transforms ByteCore assembly code into a 64KB memory byte array, compatible with the [ByteCore Emulator](https://github.com/joakimwinum/bytecore). It includes features to identify syntax errors and guide developers through debugging their code.
+
+## Overview
+
+The compiler process involves several steps to convert text-based assembly code into executable memory bytes:
+
+1. **Lexical Analysis**: Converts raw text into tokens.
+2. **Syntax Analysis**: Checks token structure and builds a syntax tree.
+3. **Semantic Analysis**: Further inspects the syntax tree for logical consistency.
+
+Successful compilation results in a memory byte array ready for emulation; errors during any stage will generate exceptions to highlight issues.
+
+## ByteCore Assembly Language
+
+The ByteCore assembly language represents instructions in a format that the ByteCore Emulator can execute directly, consisting of:
+
+- **MSB (Most Significant Byte)**
+- **LSB (Least Significant Byte)**
+- **DATA**: Can be either a valid hexadecimal number or an opcode.
+
+### Rules
+
+The compiler adheres to specific rules to ensure the correct interpretation of ByteCore assembly:
+
+- Strips leading, trailing, and extra spaces.
+- Treats line breaks (`\n`, `\r`, `\r\n`) as new lines.
+- Ignores text after a semicolon (`;`), which denotes a comment.
+- Requires lines to have exactly 0 or 3 tokens, not counting comments.
+- Expects the first two tokens of a line to represent numbers in hexadecimal format (0-255).
+- Requires the third token to be a valid opcode or a hexadecimal number corresponding to one of the specific opcodes (0, 1, 2, 4, 8, 16, 32).
+- Prohibits assigning data to a memory address that has already been set.
+
+### Instructions
+
+Refer to the [ByteCore Emulator README](https://github.com/joakimwinum/bytecore?tab=readme-ov-file#instructions) for a detailed list of supported instructions.
+
+## Installation and Setup
+
+### Prerequisites
+
+Ensure Python 3.11 or newer is installed. Clone the repository and navigate to the root directory. Consider setting up a Python virtual environment to manage dependencies.
+
+### Dependencies
+
+Install required dependencies with:
+
+```bash
+pip3 install -r requirements.txt
+```
+
+### Gitpod
+
+Alternatively, use Gitpod for a pre-configured environment by clicking [here](https://gitpod.io/#https://github.com/joakimwinum/bytecorecompiler).
+
+## Usage
+
+To compile ByteCore assembly code into memory bytes and execute it, follow these steps:
+
+### Example 1: Simple Program
+
+```python
+from bytecorecompiler.compiler import Compiler
+from bytecore.emulator import ByteCore
+
+bytecore_assembly = """
+00 00 LOAD
+00 01 00
+00 02 0A
+00 03 ADD
+00 04 00
+00 05 0B
+00 06 STORE
+00 07 FF
+00 08 FF
+00 09 HALT
+00 0A 14; 20
+00 0B 1E; 30
+"""
+
+memory_bytes = Compiler(bytecore_assembly).get_memory_bytes()
+byte_core = ByteCore(memory_bytes)
+byte_core.cycle_until_halt()
+dump = byte_core.dump()
+
+dump.memory[-1]  # equals 50
+```
+
+### Example 2: Advanced Program
+
+This example uses all defined opcodes to demonstrate the compiler's capabilities with a more complex program structure.
+
+```python
+from bytecorecompiler.compiler import Compiler
+from bytecore.emulator import ByteCore
+
+bytecore_assembly = """
+00 00 JMP
+00 01 FE
+00 02 00
+
+01 00 37; 55
+01 01 14; 20
+01 02 02;  2
+01 03 01;  1
+
+FE 00 LOAD
+FE 01 01
+FE 02 00
+FE 03 ADD
+FE 04 01
+FE 05 02
+FE 06 STORE
+FE 07 01
+FE 08 00
+FE 09 LOAD
+FE 0A 01
+FE 0B 01
+FE 0C SUB
+FE 0D 01
+FE 0E 03
+FE 0F STORE
+FE 10 01
+FE 11 01
+FE 12 LOAD
+FE 13 01
+FE 14 01
+FE 15 JZ
+FE 16 FF
+FE 17 00
+FE 18 JMP
+FE 19 FE
+FE 1A 00
+
+FF 00 LOAD
+FF 01 01
+FF 02 00
+FF 03 STORE
+FF 04 FF
+FF 05 FF
+FF 06 HALT
+"""
+
+memory_bytes = Compiler(bytecore_assembly).get_memory_bytes()
+byte_core = ByteCore(memory_bytes)
+byte_core.cycle_until_halt()
+dump = byte_core.dump()
+
+dump.memory[-1]  # equals 95
+```
+
+## License
+
+This project is licensed under the terms of the MIT License. See the [LICENSE](https://github.com/joakimwinum/bytecorecompiler/blob/main/LICENSE) file for the full text.

pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bytecorecompiler"
+version = "1.0.0"
+authors = [
+  { name="Joakim Winum Lien", email="joakim@winum.xyz" },
+]
+description = "A compiler that transforms ByteCore assembly code into executable memory bytes, seamlessly bridging the gap between high-level assembly instructions and the ByteCore Emulator's low-level functionality."
+readme = "README.md"
+requires-python = ">=3.11"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/joakimwinum/bytecorecompiler"
+"Bug Tracker" = "https://github.com/joakimwinum/bytecorecompiler/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+bytecore = ["py.typed"]

requirements.txt

@@ -0,0 +1,4 @@
+pytest>=8.1.1,<8.2.0
+autopep8>=2.1.0,<2.2.0
+mypy>=1.9.0,<1.10.0
+bytecore>=1.1.0,<1.2.0

src/bytecorecompiler/__init__.py

@@ -0,0 +1,34 @@
+from bytecore.byte import Byte
+from bytecore.memory import Memory
+from bytecorecompiler.parser import Parser
+from bytecorecompiler.exception import ByteCoreCompilerException
+
+
+class Compiler:
+    def __init__(self, string: str) -> None:
+        parser = Parser(string)
+        self._syntax_trees = parser.syntax_trees
+        self._memory_bytes = self._convert_syntax_trees_to_memory_bytes()
+
+    def _convert_syntax_trees_to_memory_bytes(self) -> list[Byte]:
+        memory_bytes = Memory.get_default_memory_bytes()
+
+        for syntax_tree in self._syntax_trees:
+            memory_address = syntax_tree.get_memory_address()
+            data = syntax_tree.get_data()
+
+            if memory_address is None or data is None:
+                raise ConvertException(
+                    'Should not be missing these data.')
+
+            memory_bytes[memory_address] = Byte(data)
+
+        return memory_bytes
+
+    def get_memory_bytes(self) -> list[Byte]:
+        return self._memory_bytes
+
+
+class ConvertException(ByteCoreCompilerException):
+    def __init__(self, message: str) -> None:
+        super().__init__(message)

src/bytecorecompiler/compiler.py

@@ -0,0 +1,3 @@
+class ByteCoreCompilerException(Exception):
+    def __init__(self, message: str) -> None:
+        super().__init__(message)