https://github.com/kaoffie/plover_rpn_calculator
A stack-based calculator plugin for Plover
https://github.com/kaoffie/plover_rpn_calculator
plover plover-plugins stenography
Last synced: 3 months ago
JSON representation
A stack-based calculator plugin for Plover
- Host: GitHub
- URL: https://github.com/kaoffie/plover_rpn_calculator
- Owner: Kaoffie
- License: mit
- Created: 2022-07-30T13:11:20.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-12T17:43:47.000Z (11 months ago)
- Last Synced: 2024-09-30T02:32:44.807Z (8 months ago)
- Topics: plover, plover-plugins, stenography
- Language: Python
- Homepage:
- Size: 5.86 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# RPN Calculator for Plover
[](https://pypi.org/project/plover-rpn-calculator/)
**RPN Calculator** is a stack-based calculator that you can use to calculate equations directly in-line while writing. It uses reverse polish notation, where operations are written after their arguments, rather than in-between.
## Commands
| Definition | Explanation |
|---:|:---|
| `{:rpn_put:}` | Put characters into buffer.
For example: `{:rpn_put:1}` |
| `{:rpn_put_ext}` | Put all characters after the most recent calculator command into buffer. This allows you to use regular number entry strokes rather than `rpn_put` strokes to put characters into buffer. |
| `{:rpn_del_buff}` | Delete rightmost character in buffer. |
| `{:rpn_clear_buff}` | Clear buffer. |
| `{:rpn_clear_all}` | Clear and delete everything. |
| `{:rpn_push}` | Parse and push buffer into stack. |
| `{:rpn_push_bin}` | Parse and push buffer into stack as binary. |
| `{:rpn_push_hex}` | Parse and push buffer into stack as hexadecimal. |
| `{:rpn_add}` | Addition: Pop `(x, y)` from stack (where `y` is at the top) and push `x + y`. |
| `{:rpn_sub}` | Subtraction: Pop `(x, y)`, push `x - y`. |
| `{:rpn_mul}` | Multiplication: Pop `(x, y)`, push `x * y`. |
| `{:rpn_div}` | Division: Pop `(x, y)`, push `x / y`. |
| `{:rpn_intdiv}` | Floor division: Pop `(x, y)`, push `floor(x / y)`. |
| `{:rpn_mod}` | Modulo: Pop `(x, y)`, push `x mod y`. |
| `{:rpn_pow}` | Exponent: Pop `(x, y)`, push `pow(x, y)`. |
| `{:rpn_neg}` | Negation: Pop `x`, push `-x`. |
| `{:rpn_and}` | Bitwise AND: Pop `(x, y)`, push `x & y`. |
| `{:rpn_or}` | Bitwise OR: Pop `(x, y)`, push `x \| y`. |
| `{:rpn_xor}` | Bitwise XOR: Pop `(x, y)`, push `x ^ y`. |
| `{:rpn_not}` | Bitwise NOT: Pop `x`, push `~x`. |
| `{:rpn_lsl}` | Logical Shift Left: Pop `(x, y)`, push `x << y`. |
| `{:rpn_lsr}` | Logical Shift Right: Pop `(x, y)`, push `x >> y`. |
| `{:rpn_swap}` | Swap top two stack items. |
| `{:rpn_pop}` | Remove the topmost item. |
| `{:rpn_dup}` | Duplicate top stack item. |
| `{:rpn_func::}` | Define custom function; parameters are separated by commas, and the return value is written using python syntax.
For example: `{:rpn_func:x,y:3*x+2*y}` |
| `{:rpn_end}` | Mark the end of the calculation. |
Here are a few things to note when using the plugin:
- You can chain these definitions in a single stroke. For instance, `"{:rpn_clear_buff}{:rpn_dup}{:rpn_put:2}{:rpn_mul}"` will let you repeatedly add double the topmost item onto the stack.
- When the stack has exactly one item, it will be formatted as a bare number, allowing you to quickly move on after calculation.
- You can use the undo stroke (Typically `*`) to undo all RPN commands. This is helpful whenever you encounter an error during calculation.
- Most operations that pop from the stack will push whatever you have in the buffer onto the stack first before popping. This allows you to, for example, use `{:rpn_add}` to directly add the buffer to the item at the top of the stack, without the need to stroke the `rpn_push` command.