oaknut-basic 10.0.1__py3-none-any.whl

oaknut/basic/__init__.py

@@ -0,0 +1,60 @@
+"""BBC BASIC tokenisation and detokenisation.
+
+Tokenised BBC BASIC is a compact on-disc representation in which
+keywords like ``PRINT`` and ``GOTO`` are replaced with single bytes,
+line numbers are packed at the start of each line, and string
+literals and ``REM`` comments are stored in the Acorn character
+encoding. This module converts between source text and that byte
+representation.
+
+BBC BASIC is a language, not a text encoding — tokenised programs
+are bytecode, not text. The two functions here therefore work in
+``str`` ↔ ``bytes`` pairs and must never be composed with
+``DFSPath.read_text`` / ``write_text`` (which would silently mangle
+the bytecode). The canonical way to move a BASIC program through a
+disc image is ``DFSPath.read_basic`` / ``write_basic``, which wrap
+these functions with the correct load-address default.
+
+This module is deliberately self-contained and has no runtime
+dependencies on any other oaknut package.
+"""
+
+from __future__ import annotations
+
+__version__ = "10.0.1"
+
+# Canonical load addresses for BBC BASIC programs on each host.
+# Programs saved by *SAVE on a real machine use these by default.
+BBC_BASIC_LOAD_ADDRESS = 0x1900
+ELECTRON_BASIC_LOAD_ADDRESS = 0x0E00
+
+
+def tokenise(source: str) -> bytes:
+    """Tokenise BBC BASIC source text into its on-disc byte form.
+
+    Args:
+        source: BBC BASIC source as a Unicode string.
+
+    Returns:
+        Tokenised BASIC program bytes, ready to be written to a disc
+        image via ``DFSPath.write_bytes`` or ``ADFSPath.write_bytes``.
+
+    Raises:
+        NotImplementedError: The tokeniser has not yet been implemented.
+    """
+    raise NotImplementedError("BBC BASIC tokenisation is not yet implemented")
+
+
+def detokenise(data: bytes) -> str:
+    """Detokenise a BBC BASIC program into source text.
+
+    Args:
+        data: Tokenised BASIC program bytes, as read from a disc image.
+
+    Returns:
+        BBC BASIC source as a Unicode string.
+
+    Raises:
+        NotImplementedError: The detokeniser has not yet been implemented.
+    """
+    raise NotImplementedError("BBC BASIC detokenisation is not yet implemented")

oaknut_basic-10.0.1.dist-info/METADATA

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: oaknut-basic
+Version: 10.0.1
+Summary: BBC BASIC tokeniser and detokeniser for Acorn 8-bit and 32-bit BASIC source files
+Author-email: Robert Smallshire <robert@smallshire.org.uk>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/rob-smallshire/oaknut
+Project-URL: Repository, https://github.com/rob-smallshire/oaknut
+Project-URL: Issues, https://github.com/rob-smallshire/oaknut/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# oaknut-basic
+
+BBC BASIC tokeniser and detokeniser for Acorn 8-bit BASIC (BBC
+Micro, Acorn Electron) and 32-bit BASIC V/VI (Archimedes, RISC OS)
+source files. Self-contained, no runtime dependencies on other
+`oaknut-*` packages.
+
+Part of the [oaknut](https://github.com/rob-smallshire/oaknut)
+monorepo.

oaknut_basic-10.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+oaknut/basic/__init__.py,sha256=Ol8ngWO7w3u_bIpO3x-9EZv-STbfipUAP6WpRDiUtD8,2118
+oaknut_basic-10.0.1.dist-info/licenses/LICENSE,sha256=L_Uw2MQC3xsCy2nOzWmY_DYRQMHC-Yu2_zTvUTadNAY,1074
+oaknut_basic-10.0.1.dist-info/METADATA,sha256=cxB0hxRIk9tXe1dX9ez9Tq7xIAxxfrZjdFh-OtSI1IA,1135
+oaknut_basic-10.0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+oaknut_basic-10.0.1.dist-info/top_level.txt,sha256=QLKweXQ1HlrA4vuJ4fj2AKq-_qs54zd2M4O0DahuKzw,7
+oaknut_basic-10.0.1.dist-info/RECORD,,

oaknut_basic-10.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

oaknut_basic-10.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robert Smallshire
+
+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.

oaknut_basic-10.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+oaknut