feat: Add opcode enumerating helpers using macros #346
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, we have to manually maintain the opcodes so the list of opcode definitions is in sync with the array of `INSTRUCTION_OPCODE_NAMES`, which is a tedious step. In addition, it is also quite easier to forget one opcode or two in the implementations somewhere. This change leverages some purposely designed macros to grant us a way to enumerate all the macros, providing accessing code for each of them individually. This way we can define opcodes in one place and make sure every enumeration contains all the opcodes correctly. Note that using macros does have the drawbacks of making code less clearer to read. We are also providing a one-line command to generate the underlying Rust code. What's more one can also refer to Rust docs to see all the defined opcodes
mohanson
approved these changes
Jun 6, 2023
mohanson
pushed a commit
to libraries/ckb-vm
that referenced
this pull request
Jul 21, 2023
* feat: Add opcode enumerating helpers using macros Previously, we have to manually maintain the opcodes so the list of opcode definitions is in sync with the array of `INSTRUCTION_OPCODE_NAMES`, which is a tedious step. In addition, it is also quite easier to forget one opcode or two in the implementations somewhere. This change leverages some purposely designed macros to grant us a way to enumerate all the macros, providing accessing code for each of them individually. This way we can define opcodes in one place and make sure every enumeration contains all the opcodes correctly. Note that using macros does have the drawbacks of making code less clearer to read. We are also providing a one-line command to generate the underlying Rust code. What's more one can also refer to Rust docs to see all the defined opcodes * ci: Format
mohanson
pushed a commit
that referenced
this pull request
Jul 21, 2023
* feat: Add opcode enumerating helpers using macros Previously, we have to manually maintain the opcodes so the list of opcode definitions is in sync with the array of `INSTRUCTION_OPCODE_NAMES`, which is a tedious step. In addition, it is also quite easier to forget one opcode or two in the implementations somewhere. This change leverages some purposely designed macros to grant us a way to enumerate all the macros, providing accessing code for each of them individually. This way we can define opcodes in one place and make sure every enumeration contains all the opcodes correctly. Note that using macros does have the drawbacks of making code less clearer to read. We are also providing a one-line command to generate the underlying Rust code. What's more one can also refer to Rust docs to see all the defined opcodes * ci: Format
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, we have to manually maintain the opcodes so the list of opcode definitions is in sync with the array of
INSTRUCTION_OPCODE_NAMES, which is a tedious step. In addition, it is also quite easier to forget one opcode or two in the implementations somewhere. This change leverages some purposely designed macros to grant us a way to enumerate all the macros, providing accessing code for each of them individually. This way we can define opcodes in one place and make sure every enumeration contains all the opcodes correctly.Note that using macros does have the drawbacks of making code less clearer to read. We are also providing a one-line command to generate the underlying Rust code. What's more one can also refer to Rust docs to see all the defined opcodes