https://github.com/tekord/cpp-opcode-generator

A python script for generating enums with opcode constants based on YAML file definition
https://github.com/tekord/cpp-opcode-generator

compilers cpp emulation generators opcode programming-language-development python rust virtual-machine

Last synced: about 2 months ago
JSON representation

A python script for generating enums with opcode constants based on YAML file definition

• Host: GitHub
• URL: https://github.com/tekord/cpp-opcode-generator
• Owner: tekord
• License: mit
• Created: 2018-10-27T17:52:35.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-11T18:36:59.000Z (12 months ago)
• Last Synced: 2024-01-12T05:12:48.120Z (12 months ago)
• Topics: compilers, cpp, emulation, generators, opcode, programming-language-development, python, rust, virtual-machine
• Language: Python
• Homepage:
• Size: 14.6 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Opcode constant generator for C, C++ and Rust programming languages

A python script for generating enums with opcode constants based on YAML file definition. It may be useful for 

virtual machine developers. Defining opcodes in external file instead of direct C++/Rust enum has some advantages:

1. It is easier to read. Definition file contains only relevant information, no C++ code.

2. You can automate a documentation building.

3. Opcode definition is isolated from your virtual machine implementation, so you can use it in non-C++ implementation

(of course you'll have to modify this script a little bit).

Written on Python 3.

## Installation

Execute the following command to install dependencies:

```

pip install -r requirements.txt

```

## Usage

Copy the `opcodes.example.yaml` file to your application's folder, define all the opcodes you need in this file. 

Then run the script with the following arguments:

```

python main.py   [--output path/to/file]

```

where `opcode-list` is a path to file with opcodes (.yaml file); `language` is one of the following options: `c`, 

`cpp`, `rust`; `--output` specified the output file path. If the `output` option is not provided then result will 

be printed to the standard output.

 

The result may look like this:

```cpp

enum _GeneratedOpCodes {

    OPCODE_NOP = 0x00,

    OPCODE_B = 0xA0,

    OPCODE_BZ = 0xA1,

    OPCODE_B_FALSE = 0xA1 /* alias for BZ */,

    OPCODE_B_ZERO = 0xA1 /* alias for BZ */,

    OPCODE_B_NULL = 0xA1 /* alias for BZ */,

    OPCODE_BNZ = 0xA2,

    OPCODE_B_TRUE = 0xA2 /* alias for BNZ */,

    OPCODE_B_NOT_ZERO = 0xA2 /* alias for BNZ */,

    OPCODE_B_NOT_NULL = 0xA2 /* alias for BNZ */

};

```