Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A few trivial improvements for code readability #35

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

stkeke
Copy link

@stkeke stkeke commented May 20, 2023

No feature change, just make code easier to read and understand

I have spent a few time deciphering the function prototype and magic number in code. Meaningful function declarations are essential for user to intuitively guess and use API parameters correctly.

  1. In ir_insn{} definition, opt and optx are different things.
    ir_emit{,0,1,2,3} functions require optx
    ir_emit_N function require opt
    Make this explicit in function declaration.
  2. IR_OPTX_{2,3} macros for easier optx construction in code
    Naming is kinda ugly. Have not got better names.
  3. Add comments to magic number used in ir_emit_N() function
  4. input_count and pos should be uint16_t instead of uint32_t

Tony Su added 3 commits May 20, 2023 14:05
No feature change, just make code easier to read and understand

I have spent a few time deciphering the function prototype and magic
number in code. Meaningful function declarations are essential for user
to intuitively guess and use API parameters correctly.
1) In ir_insn{} definition, opt and optx are different things.
   ir_emit{,0,1,2,3} functions require optx
   ir_emit_N function require opt
   Make this explicit in function declaration.
2) IR_OPTX_{2,3} macros for easier optx construction in code
   Naming is kinda ugly. Have not got better names.
3) Add comments to magic number used in ir_emit_N() function
4) input_count and pos should be uint16_t instead of uint32_t

Signed-off-by: Tony Su <[email protected]>
Make it more meaningful

Signed-off-by: Tony Su <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant