Initial structure for memory engine data structures

Author: henriquegemignani

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"  
+    schedule:
+      interval: "daily"

.github/workflows/python.yml

@@ -0,0 +1,112 @@
+name: Python Package
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '*'
+    tags:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Wheel
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          submodules: 'recursive'
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+     
+      - name: Install Python packages
+        run: python -m pip install --upgrade build pip
+
+      - name: build wheel
+        run: python -m build --wheel
+
+      - name: build sdist
+        run: python -m build --sdist
+      
+      - name: Store the packages
+        uses: actions/upload-artifact@v2
+        with:
+          name: python-package-distributions
+          path: dist
+
+  test:
+    needs:
+      - build
+      
+    runs-on: ubuntu-latest
+    name: Test Python ${{ matrix.python.version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python:
+          - {version: '3.8', wheel: 'cp38-cp38'}
+          - {version: '3.9', wheel: 'cp39-cp39'}
+          - {version: '3.10', wheel: 'cp310-cp310'}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          submodules: 'recursive'
+
+      - name: remove code outside of wheel
+        run: rm -rf mercury_engine_data_structures
+        shell: bash
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python.version }}
+
+      - name: Download all the dists
+        uses: actions/download-artifact@v2
+        with:
+          name: python-package-distributions
+          path: dist/
+            
+      - name: Install Python packages
+        run: python -m pip install --upgrade pip pytest
+
+      - name: install built wheel
+        run: python -m pip install dist/*.whl
+        shell: bash
+
+      - name: test
+        run: python -m pytest test/
+
+  pypi:
+    runs-on: 'ubuntu-latest'
+    needs:
+      - test
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v2
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish 📦 to TestPyPI
+        if: ${{ github.ref == 'refs/heads/main' }}
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.testpypi_password }}
+          repository_url: https://test.pypi.org/legacy/
+      
+      - name: Publish 📦 to PyPI
+        if: ${{ startsWith(github.ref, 'refs/tags/') }}
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.pypi_password }}

.gitignore

@@ -0,0 +1,135 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# PyCharm
+/.idea
+
+# Version
+mercury_engine_data_structures/version.py

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Henrique Gemignani Passos Lima
+
+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,13 @@
+# Mercury Engine Data Structures
+Construct type definitions for Mercury Engine
+
+| Format   | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) |
+| -------- | -------------------- | --------------------- | ------------ | ------------- |
+| PAK      | ✗              | ✗               | ✓      | ✓       |
+
+
+## Example Usage
+
+```python
+# TODO
+```

mercury_engine_data_structures/__init__.py

@@ -0,0 +1,4 @@
+from retro_data_structures import cli
+
+if __name__ == "__main__":
+    cli.main()

mercury_engine_data_structures/__main__.py

@@ -0,0 +1,13 @@
+from construct import Adapter, Int32ub, Enum
+
+
+class EnumAdapter(Adapter):
+    def __init__(self, enum_class, subcon=Int32ub):
+        super().__init__(Enum(subcon, enum_class))
+        self._enum_class = enum_class
+
+    def _decode(self, obj, context, path):
+        return self._enum_class[obj]
+
+    def _encode(self, obj, context, path):
+        return obj.name

mercury_engine_data_structures/adapters/__init__.py

@@ -0,0 +1,43 @@
+from construct import Adapter, AdaptationError
+
+
+class OffsetAdapter(Adapter):
+    # stores offsets as indices
+
+    def _get_table(self, context):
+        raise NotImplementedError()
+
+    def _get_table_length(self, context):
+        raise NotImplementedError()
+
+    def _get_base_offset(self, context):
+        return 0
+
+    def _get_item_size(self, item):
+        return item.size
+
+    def _decode(self, obj, context, path):
+        table = self._get_table(context)
+        offset = obj
+        size = self._get_base_offset(context)
+
+        for i in range(self._get_table_length(context)):
+            if size == offset:
+                return i
+            if size > offset:
+                raise AdaptationError("No string begins at the requested offset!")
+
+            item = table[i]
+            size += self._get_item_size(item)
+
+    def _encode(self, obj, context, path):
+        table = self._get_table(context)
+        index = obj
+        size = self._get_base_offset(context)
+
+        for i in range(self._get_table_length(context)):
+            if i == index:
+                return size
+
+            item = table[i]
+            size += self._get_item_size(item)