super-smart-ops

Summary

My own spin on the smart-operators concept, intended to provide more a more convenient editing experience.

Provides enhanced editing support for operators in programming languages.

Automatically inserts padding around operators
Deleting backwards deletes the padding and last character of the operator
Customisable for different languages

Installing

You will need Emacs 24+, make and Cask to build the project.

cd super-smart-ops
make && make install

Configuration

To add support for smart operators to a language mode, call the super-smart-ops-configure-for-mode function.

(super-smart-ops-configure-for-mode 'asm-mode)

Common arithmetic operators are enabled by default. Use the :rem keyword argument to disable certain operators.

(super-smart-ops-configure-for-mode 'asm-mode
  :rem '("%" "-"))

Add support for more operators using the :add keyword argument.

(super-smart-ops-configure-for-mode 'haskell-mode
  :add '("$"))

You can also specify your own custom commands to perform the insertion and formatting. <backspace> will still work as expected for these operators. Use the :custom keyword argument to configure these commands.

(super-smart-ops-configure-for-mode 'haskell-mode
  ; ...
  :custom
  '(("." . cb-hs:smart-dot)
    ("," . cb-hs:smart-comma)
    ("|" . cb-hs:smart-pipe)
    ("#" . cb-hs:smart-hash)
    (":" . cb-hs:smart-colon)))

Examples

The examples below use a pipe character ('|') to represent the cursor position.

Example 1: Intelligent padding

Padding is managed automatically when inserting operators.

1|

Typing '+' inserts the operator and adds padding:

1 + |

Typing '=' adjusts the padding as you'd expect:

1 += |

Deleting backwards (with <backspace>) deletes any trailing padding and the last operator:

1 +|

Deleting backwards again deletes the last operator and its leading padding:

1|

Example 2: Convenient corrections

It's common to mistype an operator, then want to correct it immediately.

1|

Typing '+' inserts the operator and adds padding:

1 + |

Deleting backwards (with <backspace>) deletes the operator and its padding, ready for your correction.

1|

Example 3: Smart behaviour inside parens

Some languages support operator sections. To support this, operators are not padded when they are the first element in a parenthesised expression.

(|

Typing '+' gives:

(+|

If there are non-operator chars after the paren padding will be used. This means arithmetic still works as you'd expect within parenthesised expressions:

(1 + |

Contributing

Yes, please do! See CONTRIBUTING for guidelines.

chrisbarrett / super-smart-ops

readme