File: rainbow-delimiters.el.html
Rainbow-delimiters is a "rainbow parentheses"-like mode which highlights parentheses, brackets, and braces according to their depth. Each successive level is highlighted in a different color. This makes it easy to spot matching delimiters, orient yourself in the code, and tell which statements are at a given level.
Great care has been taken to make this mode fast. You shouldn't see any discernible change in scrolling or editing speed while using it, even in delimiter-rich languages like Clojure, Lisp, and Scheme.
Usage:
To toggle the mode in the current buffer:
M-x rainbow-delimiters-mode
To start the mode automatically in foo-mode, add the following to your init
file:
(add-hook 'foo-mode-hook #'rainbow-delimiters-mode)
To start the mode automatically in most programming modes (Emacs 24 and
above):
(add-hook 'prog-mode-hook #'rainbow-delimiters-mode)
Customization:
To customize various options, including the color theme:
M-x customize-group rainbow-delimiters
You can specify custom colors by customizing following faces:
- Faces take the form rainbow-delimiters-depth-N-face, with N being the
depth. Depth begins at 1, the outermost color. Faces exist for depths 1-9.
- The unmatched delimiter face: rainbow-delimiters-unmatched-face.
- The mismatched delimiter face: rainbow-delimiters-mismatched-face.
Defined variables (5)
rainbow-delimiters-max-face-count | Number of faces defined for highlighting delimiter levels. |
rainbow-delimiters-mode | Non-nil if Rainbow-Delimiters mode is enabled. |
rainbow-delimiters-mode-hook | Hook run after entering or leaving ‘rainbow-delimiters-mode’. |
rainbow-delimiters-outermost-only-face-count | Number of faces to be used only for N outermost delimiter levels. |
rainbow-delimiters-pick-face-function | The function used to pick a face used to highlight a delimiter. |
Defined functions (7)
rainbow-delimiters--apply-color | (LOC DEPTH MATCH) |
rainbow-delimiters--char-ineligible-p | (LOC PPSS DELIM-SYNTAX-CODE) |
rainbow-delimiters--propertize | (END) |
rainbow-delimiters-default-pick-face | (DEPTH MATCH LOC) |
rainbow-delimiters-mode | (&optional ARG) |
rainbow-delimiters-mode-disable | () |
rainbow-delimiters-mode-enable | () |
Defined faces (11)
rainbow-delimiters-base-error-face | Face inherited by all other rainbow-delimiter error faces. |
rainbow-delimiters-base-face | Face inherited by all other rainbow-delimiter faces. |
rainbow-delimiters-depth-1-face | Nested delimiter face, depth 1. |
rainbow-delimiters-depth-2-face | Nested delimiter face, depth 2. |
rainbow-delimiters-depth-3-face | Nested delimiter face, depth 3. |
rainbow-delimiters-depth-4-face | Nested delimiter face, depth 4. |
rainbow-delimiters-depth-5-face | Nested delimiter face, depth 5. |
rainbow-delimiters-depth-6-face | Nested delimiter face, depth 6. |
rainbow-delimiters-depth-7-face | Nested delimiter face, depth 7. |
rainbow-delimiters-depth-8-face | Nested delimiter face, depth 8. |
rainbow-delimiters-depth-9-face | Nested delimiter face, depth 9. |