Support for Different Data Word Sizes (#37)

This pull request adds support for different data word sizes in the assembler, expanding beyond the traditional 8-bit words to support variable word sizes including 16-bit, 32-bit, and other configurations. The changes introduce flexible endianness handling at both the intra-word and multi-word levels, enabling more sophisticated processor architectures.

Key changes include:

* Introduction of new bytecode classes (Word, WordSlice, Value) for flexible word size handling
* Enhanced endianness support with separate intra-word and multi-word configurations
* Updated data structures and processing to work with configurable word sizes rather than fixed bytes
* Made the 'compile' command optional when using bespokeasm to compile code. 
* Improved unit test coverage.

Author: michaelkamprath

.cursor/config.json

@@ -0,0 +1,25 @@
+{
+  "pythonVersion": "3.11",
+  "lint": {
+    "flake8": {
+      "maxLineLength": 127
+    }
+  },
+  "format": {
+    "black": {
+      "lineLength": 127
+    }
+  },
+  "test": {
+    "pytest": {
+      "args": [
+        "-v"
+      ]
+    }
+  },
+  "precommit": {
+    "enabled": true,
+    "runOnSave": true
+  },
+  "instructions": "All code must pass pre-commit hooks, use single quotes, max line length 127, and have no trailing whitespace."
+}

CHANGELOG.md

@@ -19,13 +19,27 @@ Changes that are planned but not implemented yet:
 * Update the `#ifdef` and related preprocessor directives to include detection of labels and constants.
 * Allow multiple `cstr` defininitions on the same line
 
-## [Unreleased]
+* ## [Unreleased]
+
+## [0.5.0]
+* Major refactoring of the code base the enables support for data words of any size. See [Data Words and Endianness](https://github.com/michaelkamprath/bespokeasm/wiki/Instruction-Set-Configuration-File#data-words-and-endianness) for more information.This is a **BREAKING CHANGE** for the configuration file.
+  * The `endian` general configuration option is deprecated and replaced with `multi_word_endianness` and `intra_word_endianness`.
+  * The `byte_size` configuration options used in many places is deprecated and replaced with `word_size`. Similarly, the `byte_align` configuration option is deprecated and replaced with `word_align`.
+  * **Additional upgrade instructions for configuration file changes:**
+    * The new fields `multi_word_endianness` and `intra_word_endianness` must be set to either `'big'` or `'little'`. If omitted, they default to `'big'`.
+    * The new field `word_size` (in bits) replaces all uses of `byte_size`. If omitted, it defaults to `8`.
+    * The new field `word_segment_size` (in bits) is optional and defaults to the value of `word_size`. Only set this if your word is composed of smaller segments (e.g., 16-bit word with 8-bit segments).
+    * The new field `word_align` replaces `byte_align` for alignment settings.
+    * All these fields must be placed in the `general` section of the configuration file.
+    * The deprecated fields (`endian`, `byte_size`, `byte_align`) are still recognized for now, but will emit warnings and should be removed from your configuration files.
 * Upgrade python version requirements to 3.11
 * Improved several error messages
 * Fixed a bug where embedded strings weren't properly parsed if they contained a newline character or there were multiple embedded strings per line
 * Fixed a bug where parsing properly discriminate between labels starting with `BYTE` string and the `BYTEx()` operator.
 * Fixed a bug in generating the syntax highlighting configuration that caused mnemonics with special characters to not be highlighted properly.
 * Added support for symbol definitions in Sublime Text. Symbols defined are labels and constants.
+* Added a new `update_config` CLI command to automatically upgrade older configuration files to the latest format required by this version. This tool will convert deprecated fields, set new defaults, and update the `min_version` field for you.
+* Running 'bespokeasm <args>' now defaults to the 'compile' command, so you no longer need to specify 'compile' explicitly. Other commands (such as 'update-config' and 'generate-extension') still require their explicit subcommand.
 
 ## [0.4.2]
 *  Added support for The Minimal 64x4 Home Computer with an example and updated assembler functionality to support it.
@@ -164,7 +178,8 @@ First tracked released
 * Enabled the `reverse_argument_order` instruction option be applied to a specific operand configuration. This slightly changed the configuration file format.
 * Added ability for instructions with operands to have a single "empty operand" variant, e.g., `pop`
 
-[Unreleased]: https://github.com/michaelkamprath/bespokeasm/compare/v0.4.2...HEAD
+[Unreleased]: https://github.com/michaelkamprath/bespokeasm/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/michaelkamprath/bespokeasm/compare/v0.4.2...v0.5.0
 [0.4.2]: https://github.com/michaelkamprath/bespokeasm/compare/v0.4.1...v0.4.2
 [0.4.1]: https://github.com/michaelkamprath/bespokeasm/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/michaelkamprath/bespokeasm/compare/v0.3.3...v0.4.0

Pipfile

@@ -6,11 +6,12 @@ name = "pypi"
 [packages]
 click = "*"
 intelhex = "*"
-PyYAML = "*"
-build = "*"
+packaging = "*"
+pyyaml = "*"
+click-default-group = "*"
 
 [dev-packages]
-pre-commit = '*'
+pre-commit = "*"
 
 [requires]
 python_version = "3.11"

Pipfile.lock

@@ -6,12 +6,22 @@ This is a customizable byte code assembler that allows for the definition of cus
 **NOTE - This project should be considered to be in "beta" status. It should be stable, but features are subject to change.**
 
 ## Usage
-To install, clone this repository and install using `pip`. Preferably, you have a `python` virtual environment set up and it has `pipenv` installed when you do this.
+To install, clone this repository and install using `pip`.
+
+```sh
+git clone [email protected]:michaelkamprath/bespokeasm.git
+pip install ./bespokeasm/
+```
+
+Preferably, you use a `python` virtual environment to install BespokeASM into. For example:
 
 ```sh
 git clone [email protected]:michaelkamprath/bespokeasm.git
 cd bespokeasm
+python3 -m venv .venv/bespokeasm
+source .venv/bespokeasm/bin/activate
 pip install .
+bespokeasm —version
 ```
 
 Once installed, assembly code can be compiled in this manner:

README.md

@@ -1,6 +1,6 @@
 description: Eater SAP-1 ISA
 general:
-  min_version: 0.3.0
+  min_version: 0.5.0
   address_size: 4
   identifier:
     name: eater-sap1

examples/ben-eater-sap1/eater-sap1-isa.yaml

@@ -1,7 +1,7 @@
 description: Intel 8085
 general:
   address_size: 16
-  endian: little
+  multi_word_endianness: little
   registers:
     - a
     - b
@@ -21,7 +21,7 @@ general:
     name: intel-8085-asm
     version: "0.1.0"
     extension: a85
-  min_version: 0.3.0
+  min_version: 0.5.0
 operand_sets:
   8_bit_source:
     operand_values: