1 ;;; context-coloring.el --- Highlight by scope -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2014-2015 Free Software Foundation, Inc.
5 ;; Author: Jackson Ray Hamilton <jackson@jacksonrayhamilton.com>
7 ;; Keywords: convenience faces tools
8 ;; Package-Requires: ((emacs "24") (js2-mode "20150126"))
9 ;; URL: https://github.com/jacksonrayhamilton/context-coloring
11 ;; This file is part of GNU Emacs.
13 ;; This program is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; This program is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
28 ;; Highlights code by scope. Top-level scopes are one color, second-level
29 ;; scopes are another color, and so on. Variables retain the color of the scope
30 ;; in which they are defined. A variable defined in an outer scope referenced
31 ;; by an inner scope is colored the same as the outer scope.
33 ;; By default, comments and strings are still highlighted syntactically.
35 ;; To use with js2-mode, add the following to your init file:
37 ;; (require 'context-coloring)
38 ;; (add-hook 'js2-mode-hook 'context-coloring-mode)
40 ;; To use with js-mode or js3-mode, install Node.js 0.10+ and the scopifier
43 ;; $ npm install -g scopifier
52 (defun context-coloring-join (strings delimiter)
53 "Join a list of STRINGS with the string DELIMITER."
54 (mapconcat 'identity strings delimiter))
56 (defsubst context-coloring-trim-right (string)
57 "Remove leading whitespace from STRING."
58 (if (string-match "[ \t\n\r]+\\'" string)
59 (replace-match "" t t string)
62 (defsubst context-coloring-trim-left (string)
63 "Remove trailing whitespace from STRING."
64 (if (string-match "\\`[ \t\n\r]+" string)
65 (replace-match "" t t string)
68 (defsubst context-coloring-trim (string)
69 "Remove leading and trailing whitespace from STRING."
70 (context-coloring-trim-left (context-coloring-trim-right string)))
75 (defun context-coloring-defface (level tty light dark)
76 "Define a face for LEVEL with colors for TTY, LIGHT and DARK
78 (let ((face (intern (format "context-coloring-level-%s-face" level)))
79 (doc (format "Context coloring face, level %s." level)))
82 `((((type tty)) (:foreground ,tty))
83 (((background light)) (:foreground ,light))
84 (((background dark)) (:foreground ,dark)))
86 :group 'context-coloring)))
88 (defun context-coloring-defface-neutral (level)
89 "Define a face for LEVEL with the default neutral colors."
90 (context-coloring-defface level nil "#3f3f3f" "#cdcdcd"))
92 (context-coloring-defface 0 nil "#000000" "#ffffff")
93 (context-coloring-defface 1 "yellow" "#008b8b" "#00ffff")
94 (context-coloring-defface 2 "green" "#0000ff" "#87cefa")
95 (context-coloring-defface 3 "cyan" "#483d8b" "#b0c4de")
96 (context-coloring-defface 4 "blue" "#a020f0" "#eedd82")
97 (context-coloring-defface 5 "magenta" "#a0522d" "#98fb98")
98 (context-coloring-defface 6 "red" "#228b22" "#7fffd4")
99 (context-coloring-defface-neutral 7)
101 (defvar context-coloring-maximum-face nil
102 "Index of the highest face available for coloring.")
104 (defvar context-coloring-original-maximum-face nil
105 "Fallback value for `context-coloring-maximum-face' when all
106 themes have been disabled.")
108 (setq context-coloring-maximum-face 7)
110 (setq context-coloring-original-maximum-face
111 context-coloring-maximum-face)
113 ;; Theme authors can have up to 26 levels: 1 (0th) for globals, 24 (1st-24th)
114 ;; for nested levels, and 1 (25th) for infinity.
116 (context-coloring-defface-neutral (+ number context-coloring-maximum-face 1)))
121 (defsubst context-coloring-level-face (level)
122 "Return the symbol for a face with LEVEL."
123 ;; `concat' is faster than `format' here.
125 (concat "context-coloring-level-" (number-to-string level) "-face")))
127 (defsubst context-coloring-bounded-level-face (level)
128 "Return the symbol for a face with LEVEL, bounded by
129 `context-coloring-maximum-face'."
130 (context-coloring-level-face (min level context-coloring-maximum-face)))
133 ;;; Colorization utilities
135 (defsubst context-coloring-colorize-region (start end level)
136 "Color characters from the 1-indexed START point (inclusive) to
137 the END point (exclusive) with the face corresponding to LEVEL."
141 `(face ,(context-coloring-bounded-level-face level))))
143 (defcustom context-coloring-comments-and-strings nil
144 "If non-nil, also color comments and strings using `font-lock'."
145 :group 'context-coloring)
147 (make-obsolete-variable
148 'context-coloring-comments-and-strings
149 "use `context-coloring-syntactic-comments' and
150 `context-coloring-syntactic-strings' instead."
153 (defcustom context-coloring-syntactic-comments t
154 "If non-nil, also color comments using `font-lock'."
155 :group 'context-coloring)
157 (defcustom context-coloring-syntactic-strings t
158 "If non-nil, also color strings using `font-lock'."
159 :group 'context-coloring)
161 (defun context-coloring-font-lock-syntactic-comment-function (state)
162 "Tell `font-lock' to color a comment but not a string."
163 (if (nth 3 state) nil font-lock-comment-face))
165 (defun context-coloring-font-lock-syntactic-string-function (state)
166 "Tell `font-lock' to color a string but not a comment."
167 (if (nth 3 state) font-lock-string-face nil))
169 (defsubst context-coloring-maybe-colorize-comments-and-strings (&optional min max)
170 "Color the current buffer's comments and strings if
171 `context-coloring-comments-and-strings' is non-nil."
172 (when (or context-coloring-comments-and-strings
173 context-coloring-syntactic-comments
174 context-coloring-syntactic-strings)
175 (let ((min (or min (point-min)))
176 (max (or max (point-max)))
177 (font-lock-syntactic-face-function
179 ((and context-coloring-syntactic-comments
180 (not context-coloring-syntactic-strings))
181 'context-coloring-font-lock-syntactic-comment-function)
182 ((and context-coloring-syntactic-strings
183 (not context-coloring-syntactic-comments))
184 'context-coloring-font-lock-syntactic-string-function)
186 font-lock-syntactic-face-function))))
188 (font-lock-fontify-syntactically-region min max)
189 ;; TODO: Make configurable at the dispatch level.
190 (when (eq major-mode 'emacs-lisp-mode)
191 (font-lock-fontify-keywords-region min max))))))
194 ;;; js2-mode colorization
196 (defvar-local context-coloring-js2-scope-level-hash-table nil
197 "Associate `js2-scope' structures and with their scope
200 (defcustom context-coloring-js-block-scopes nil
201 "If non-nil, also color block scopes in the scope hierarchy in JavaScript.
203 The block-scoped `let' and `const' are introduced in ES6. Enable
204 this for ES6 code; disable it elsewhere.
206 Supported modes: `js2-mode'"
207 :group 'context-coloring)
209 (defsubst context-coloring-js2-scope-level (scope)
210 "Return the level of SCOPE."
211 (cond ((gethash scope context-coloring-js2-scope-level-hash-table))
214 (current-scope scope)
216 (while (and current-scope
217 (js2-node-parent current-scope)
218 (setq enclosing-scope
219 (js2-node-get-enclosing-scope current-scope)))
220 (when (or context-coloring-js-block-scopes
221 (let ((type (js2-scope-type current-scope)))
222 (or (= type js2-SCRIPT)
223 (= type js2-FUNCTION)
224 (= type js2-CATCH))))
225 (setq level (+ level 1)))
226 (setq current-scope enclosing-scope))
227 (puthash scope level context-coloring-js2-scope-level-hash-table)))))
229 (defsubst context-coloring-js2-local-name-node-p (node)
230 "Determine if NODE is a `js2-name-node' representing a local
232 (and (js2-name-node-p node)
233 (let ((parent (js2-node-parent node)))
234 (not (or (and (js2-object-prop-node-p parent)
235 (eq node (js2-object-prop-node-left parent)))
236 (and (js2-prop-get-node-p parent)
237 ;; For nested property lookup, the node on the left is a
238 ;; `js2-prop-get-node', so this always works.
239 (eq node (js2-prop-get-node-right parent))))))))
241 (defvar-local context-coloring-point-max nil
242 "Cached value of `point-max'.")
244 (defsubst context-coloring-js2-colorize-node (node level)
245 "Color NODE with the color for LEVEL."
246 (let ((start (js2-node-abs-pos node)))
247 (context-coloring-colorize-region
251 (+ start (js2-node-len node))
252 ;; Somes nodes (like the ast when there is an unterminated multiline
253 ;; comment) will stretch to the value of `point-max'.
254 context-coloring-point-max)
257 (defun context-coloring-js2-colorize ()
258 "Color the current buffer using the abstract syntax tree
259 generated by `js2-mode'."
260 ;; Reset the hash table; the old one could be obsolete.
261 (setq context-coloring-js2-scope-level-hash-table (make-hash-table :test 'eq))
262 (setq context-coloring-point-max (point-max))
263 (with-silent-modifications
270 (context-coloring-js2-colorize-node
272 (context-coloring-js2-scope-level node)))
273 ((context-coloring-js2-local-name-node-p node)
274 (let* ((enclosing-scope (js2-node-get-enclosing-scope node))
275 (defining-scope (js2-get-defining-scope
277 (js2-name-node-name node))))
278 ;; The tree seems to be walked lexically, so an entire scope will
279 ;; be colored, including its name nodes, before they are reached.
280 ;; Coloring the nodes defined in that scope would be redundant, so
282 (when (not (eq defining-scope enclosing-scope))
283 (context-coloring-js2-colorize-node
285 (context-coloring-js2-scope-level defining-scope))))))
286 ;; The `t' indicates to search children.
288 (context-coloring-maybe-colorize-comments-and-strings)))
291 ;;; Emacs Lisp colorization
293 (defsubst context-coloring-make-scope (depth level)
297 :variables (make-hash-table)))
299 (defsubst context-coloring-scope-get-level (scope)
300 (plist-get scope :level))
302 (defsubst context-coloring-scope-add-variable (scope variable)
303 (puthash variable t (plist-get scope :variables)))
305 (defsubst context-coloring-scope-get-variable (scope variable)
306 (gethash variable (plist-get scope :variables)))
308 (defsubst context-coloring-get-variable-level (scope-stack variable)
311 (while (and scope-stack (not level))
312 (setq scope (car scope-stack))
314 ((context-coloring-scope-get-variable scope variable)
315 (setq level (context-coloring-scope-get-level scope)))
317 (setq scope-stack (cdr scope-stack)))))
318 ;; Assume a global variable.
321 (defsubst context-coloring-make-backtick (end enabled)
326 (defsubst context-coloring-backtick-get-end (backtick)
327 (plist-get backtick :end))
329 (defsubst context-coloring-backtick-get-enabled (backtick)
330 (plist-get backtick :enabled))
332 (defsubst context-coloring-backtick-enabled-p (backtick-stack)
333 (context-coloring-backtick-get-enabled (car backtick-stack)))
335 (defsubst context-coloring-make-let-varlist (depth type)
341 (defsubst context-coloring-let-varlist-get-type (let-varlist)
342 (plist-get let-varlist :type))
344 (defsubst context-coloring-let-varlist-add-var (let-varlist var)
345 (plist-put let-varlist :vars (cons var (plist-get let-varlist :vars))))
347 (defsubst context-coloring-let-varlist-pop-vars (let-varlist)
348 (let ((type (context-coloring-let-varlist-get-type let-varlist))
349 (vars (plist-get let-varlist :vars)))
351 ;; `let' binds all at once at the end.
355 (plist-put let-varlist :vars '())))
356 ;; `let*' binds incrementally.
360 (plist-put let-varlist :vars (cdr vars)))))))
362 (defsubst context-coloring-forward-sws ()
363 "Move forward through whitespace and comments."
364 (while (forward-comment 1)))
366 (defsubst context-coloring-forward-sexp-position ()
367 (scan-sexps (point) 1))
369 (defsubst context-coloring-emacs-lisp-identifier-syntax-p (syntax-code)
370 (or (= 2 syntax-code)
373 (defsubst context-coloring-open-parenthesis-p (syntax-code)
376 (defsubst context-coloring-close-parenthesis-p (syntax-code)
379 (defsubst context-coloring-expression-prefix-p (syntax-code)
382 (defsubst context-coloring-at-open-parenthesis-p ()
383 (= 4 (logand #xFFFF (car (syntax-after (point))))))
385 (defsubst context-coloring-ppss-depth (ppss)
386 ;; Same as (nth 0 ppss).
389 (defsubst context-coloring-stack-depth-equal (stack depth)
390 (= (plist-get (car stack) :depth) depth))
392 (defsubst context-coloring-exact-regexp (word)
393 "Create a regexp that matches exactly WORD."
394 (concat "\\`" (regexp-quote word) "\\'"))
396 (defsubst context-coloring-exact-or-regexp (words)
397 "Create a regexp that matches any exact word in WORDS."
398 (context-coloring-join
399 (mapcar 'context-coloring-exact-regexp words) "\\|"))
401 (defconst context-coloring-defun-regexp
402 (context-coloring-exact-or-regexp
403 '("defun" "defun*" "defsubst" "defmacro"
404 "cl-defun" "cl-defsubst" "cl-defmacro")))
406 (defconst context-coloring-arglist-arg-regexp
409 (defconst context-coloring-ignored-word-regexp
410 (concat "\\`[-+]?[0-9]\\|" (context-coloring-exact-or-regexp
411 '("t" "nil" "." "?"))))
413 (defconst context-coloring-COMMA-CHAR 44)
414 (defconst context-coloring-BACKTICK-CHAR 96)
416 (defvar context-coloring-parse-interruptable-p t
417 "Set this to nil to force parse to continue until finished.")
419 (defconst context-coloring-emacs-lisp-iterations-per-pause 1000
420 "Pause after this many iterations to check for user input.
421 If user input is pending, stop the parse. This makes for a
422 smoother user experience for large files.
424 As of this writing, emacs lisp colorization seems to run at about
425 60,000 iterations per second. A default value of 1000 should
426 provide visually \"instant\" updates at ~60 frames per second.")
428 (defun context-coloring-emacs-lisp-colorize ()
429 "Color the current buffer by parsing emacs lisp sexps."
430 (with-silent-modifications
432 ;; TODO: Can probably make this lazy to the nearest defun.
433 (goto-char (point-min))
434 (let* ((inhibit-point-motion-hooks t)
436 (last-fontified-position (point))
437 beginning-of-current-defun
440 (last-ppss-pos (point))
443 ;; -1 never matches a depth. This is a minor optimization.
444 (scope-stack `(,(context-coloring-make-scope -1 0)))
446 (let-varlist-stack '())
476 (while (> end (progn (skip-syntax-forward "^()w_'" end)
478 ;; Sparingly-executed tasks.
479 (setq iteration-count (1+ iteration-count))
480 (when (zerop (% iteration-count
481 context-coloring-emacs-lisp-iterations-per-pause))
482 ;; Fontify until the end of the current defun because doing it in
483 ;; chunks based soley on point could result in partial
484 ;; re-fontifications over the contents of scopes.
487 (setq end-of-current-defun (point))
489 (setq beginning-of-current-defun (point)))
491 ;; Fontify in chunks.
492 (context-coloring-maybe-colorize-comments-and-strings
493 last-fontified-position
495 ;; We weren't actually in a defun, so don't color the next one, as
496 ;; that could result in `font-lock' properties being added to it.
497 ((> beginning-of-current-defun (point))
500 end-of-current-defun)))
501 (setq last-fontified-position (point))
502 (when (and context-coloring-parse-interruptable-p
504 (throw 'interrupted t)))
506 (setq token-pos (point))
507 (setq token-syntax (syntax-after token-pos))
508 (setq token-syntax-code (logand #xFFFF (car token-syntax)))
509 (setq token-char (char-after))
510 (setq ppss (parse-partial-sexp last-ppss-pos token-pos nil nil ppss))
511 (setq last-ppss-pos token-pos)
514 ;; Resolve an invalid state.
518 (skip-syntax-forward "^\"" end)
523 (skip-syntax-forward "^>" end)
526 ;; Need to check early in case there's a comma.
527 ((context-coloring-expression-prefix-p token-syntax-code)
530 ;; Skip top-level symbols.
531 ((not (or backtick-stack
532 (= token-char context-coloring-BACKTICK-CHAR)))
533 (goto-char (context-coloring-forward-sexp-position)))
534 ;; Push a backtick state.
535 ((or (= token-char context-coloring-BACKTICK-CHAR)
536 (= token-char context-coloring-COMMA-CHAR))
537 (setq backtick-stack (cons (context-coloring-make-backtick
538 (context-coloring-forward-sexp-position)
539 (= token-char context-coloring-BACKTICK-CHAR))
542 ;; Pop a backtick state.
544 (>= (point) (context-coloring-backtick-get-end (car backtick-stack))))
545 (setq backtick-stack (cdr backtick-stack)))
547 ;; Restricted by an enabled backtick.
549 (context-coloring-backtick-enabled-p backtick-stack))
552 ((context-coloring-open-parenthesis-p token-syntax-code)
554 ;; Look for function calls.
555 (context-coloring-forward-sws)
556 (setq child-0-pos (point))
557 (setq child-0-syntax (syntax-after child-0-pos))
558 (setq child-0-syntax-code (logand #xFFFF (car child-0-syntax)))
560 ((context-coloring-emacs-lisp-identifier-syntax-p child-0-syntax-code)
561 (setq one-word-found-p t)
562 (setq child-0-end (scan-sexps child-0-pos 1))
563 (setq child-0-string (buffer-substring-no-properties child-0-pos child-0-end))
565 ;; Parse a var in a `let' varlist.
568 (context-coloring-stack-depth-equal
570 ;; 1- because we're inside the varlist.
571 (1- (context-coloring-ppss-depth ppss))))
572 (context-coloring-let-varlist-add-var
573 (car let-varlist-stack)
574 (intern child-0-string))
575 (setq let-var-stack (cons (context-coloring-ppss-depth ppss)
577 ((string-match-p context-coloring-defun-regexp child-0-string)
579 ((string-match-p "\\`lambda\\'" child-0-string)
580 (setq in-lambda-p t))
581 ((string-match-p "\\`let\\'" child-0-string)
583 (setq let-varlist-type 'let))
584 ((string-match-p "\\`let\\*\\'" child-0-string)
586 (setq let-varlist-type 'let*)))))
591 (setq scope-stack (cons (context-coloring-make-scope
592 (context-coloring-ppss-depth ppss)
593 (1+ (context-coloring-scope-get-level
596 ;; TODO: Probably redundant and wasteful.
597 (context-coloring-colorize-region token-pos
598 (scan-sexps token-pos 1)
599 (context-coloring-scope-get-level
604 (goto-char child-0-end)
606 ;; Look for a function name.
607 (context-coloring-forward-sws)
608 (setq child-1-pos (point))
609 (setq child-1-syntax (syntax-after child-1-pos))
610 (setq child-1-syntax-code (logand #xFFFF (car child-1-syntax)))
612 ((context-coloring-emacs-lisp-identifier-syntax-p child-1-syntax-code)
613 (setq child-1-end (scan-sexps child-1-pos 1))
614 ;; Defuns are global, so use level 0.
615 (context-coloring-colorize-region child-1-pos child-1-end 0)
616 (goto-char child-1-end))))
617 ;; Look for an arglist.
618 (context-coloring-forward-sws)
619 (when (context-coloring-at-open-parenthesis-p)
620 ;; (Actually it should be `child-1-end' for `lambda'.)
621 (setq child-2-end (context-coloring-forward-sexp-position))
622 (setq defun-arglist (read (buffer-substring-no-properties
626 (setq defun-arg (car defun-arglist))
627 (when (and (symbolp defun-arg)
629 context-coloring-arglist-arg-regexp
630 (symbol-name defun-arg)))
631 (context-coloring-scope-add-variable
634 (setq defun-arglist (cdr defun-arglist)))
635 (goto-char child-2-end))
637 (setq in-defun-p nil)
638 (setq in-lambda-p nil))
641 (goto-char child-0-end)
642 ;; Look for a varlist.
643 (context-coloring-forward-sws)
644 (setq child-1-pos (point))
645 (setq child-1-syntax (syntax-after child-1-pos))
646 (setq child-1-syntax-code (logand #xFFFF (car child-1-syntax)))
647 (when (context-coloring-open-parenthesis-p child-1-syntax-code)
648 ;; Begin parsing the varlist.
650 (setq let-varlist-stack (cons (context-coloring-make-let-varlist
651 ;; 1+ because we parsed it at a
653 (1+ (context-coloring-ppss-depth ppss))
658 (setq in-let*-p nil))
661 ;; If there was a word, continue parsing after it.
667 (setq one-word-found-p nil))
669 ((context-coloring-emacs-lisp-identifier-syntax-p token-syntax-code)
670 (setq variable-end (context-coloring-forward-sexp-position))
671 (setq variable-string (buffer-substring-no-properties
675 ;; Ignore constants such as numbers, keywords, t, nil. These can't
676 ;; be rebound, so they should be treated like syntax.
677 ((string-match-p context-coloring-ignored-word-regexp variable-string))
678 ((keywordp (read variable-string)))
680 (setq variable (intern variable-string))
682 ;; Parse a `let' varlist's uninitialized var.
685 (context-coloring-stack-depth-equal
687 ;; 1- because we're inside the varlist.
688 (1- (context-coloring-ppss-depth ppss))))
689 (setq let-varlist (car let-varlist-stack))
690 (setq let-varlist-type (context-coloring-let-varlist-get-type let-varlist))
692 ;; Defer `let' binding until the end of the varlist.
693 ((eq let-varlist-type 'let)
694 (context-coloring-let-varlist-add-var let-varlist variable))
695 ;; Bind a `let*' right away.
696 ((eq let-varlist-type 'let*)
697 (context-coloring-scope-add-variable (car scope-stack) variable))))
699 (setq variable-scope-level
700 (context-coloring-get-variable-level scope-stack variable))
701 (when (/= variable-scope-level (context-coloring-scope-get-level
703 (context-coloring-colorize-region
706 variable-scope-level))))))
707 (goto-char variable-end))
709 ((context-coloring-close-parenthesis-p token-syntax-code)
711 (setq ppss (parse-partial-sexp last-ppss-pos (point) nil nil ppss))
712 (setq last-ppss-pos (point))
713 (setq ppss-depth (context-coloring-ppss-depth ppss))
714 ;; TODO: Order might matter here but I'm not certain.
715 (when (context-coloring-stack-depth-equal scope-stack ppss-depth)
716 (setq scope-stack (cdr scope-stack)))
719 (= (car let-var-stack) ppss-depth))
720 (setq let-var-stack (cdr let-var-stack))
721 (when (eq (context-coloring-let-varlist-get-type (car let-varlist-stack))
723 (setq popped-vars (context-coloring-let-varlist-pop-vars
724 (car let-varlist-stack)))))
727 (context-coloring-stack-depth-equal let-varlist-stack ppss-depth))
728 (setq popped-vars (context-coloring-let-varlist-pop-vars
729 (car let-varlist-stack)))
730 (setq let-varlist-stack (cdr let-varlist-stack)))
732 (context-coloring-scope-add-variable (car scope-stack) (car popped-vars))
733 (setq popped-vars (cdr popped-vars))))
736 ;; Fontify the last stretch.
737 (context-coloring-maybe-colorize-comments-and-strings
738 last-fontified-position
742 ;;; Shell command scopification / colorization
744 (defun context-coloring-apply-tokens (tokens)
745 "Process a vector of TOKENS to apply context-based coloring to
746 the current buffer. Tokens are 3 integers: start, end, level.
747 The vector is flat, with a new token occurring after every 3rd
749 (with-silent-modifications
751 (len (length tokens)))
753 (context-coloring-colorize-region
756 (elt tokens (+ i 2)))
758 (context-coloring-maybe-colorize-comments-and-strings)))
760 (defun context-coloring-parse-array (array)
761 "Parse ARRAY as a flat JSON array of numbers."
762 (let ((braceless (substring (context-coloring-trim array) 1 -1)))
764 ((> (length braceless) 0)
766 (mapcar 'string-to-number (split-string braceless ","))))
770 (defvar-local context-coloring-scopifier-process nil
771 "The single scopifier process that can be running.")
773 (defun context-coloring-kill-scopifier ()
774 "Kill the currently-running scopifier process."
775 (when (not (null context-coloring-scopifier-process))
776 (delete-process context-coloring-scopifier-process)
777 (setq context-coloring-scopifier-process nil)))
779 (defun context-coloring-scopify-shell-command (command callback)
780 "Invoke a scopifier via COMMAND, read its response
781 asynchronously and invoke CALLBACK with its output."
783 ;; Prior running tokenization is implicitly obsolete if this function is
785 (context-coloring-kill-scopifier)
787 ;; Start the process.
788 (setq context-coloring-scopifier-process
789 (start-process-shell-command "scopifier" nil command))
793 ;; The process may produce output in multiple chunks. This filter
794 ;; accumulates the chunks into a message.
796 context-coloring-scopifier-process
797 (lambda (_process chunk)
798 (setq output (concat output chunk))))
800 ;; When the process's message is complete, this sentinel parses it as JSON
801 ;; and applies the tokens to the buffer.
802 (set-process-sentinel
803 context-coloring-scopifier-process
804 (lambda (_process event)
805 (when (equal "finished\n" event)
806 (funcall callback output))))))
808 (defun context-coloring-send-buffer-to-scopifier ()
809 "Give the scopifier process its input so it can begin
812 context-coloring-scopifier-process
813 (point-min) (point-max))
815 context-coloring-scopifier-process))
817 (defun context-coloring-scopify-and-colorize (command &optional callback)
818 "Invoke a scopifier via COMMAND with the current buffer's contents,
819 read the scopifier's response asynchronously and apply a parsed
820 list of tokens to `context-coloring-apply-tokens'.
822 Invoke CALLBACK when complete."
823 (let ((buffer (current-buffer)))
824 (context-coloring-scopify-shell-command
827 (let ((tokens (context-coloring-parse-array output)))
828 (with-current-buffer buffer
829 (context-coloring-apply-tokens tokens))
830 (setq context-coloring-scopifier-process nil)
831 (when callback (funcall callback))))))
832 (context-coloring-send-buffer-to-scopifier))
837 (defvar context-coloring-dispatch-hash-table (make-hash-table :test 'eq)
838 "Map dispatch strategy names to their corresponding property
839 lists, which contain details about the strategies.")
841 (defvar context-coloring-mode-hash-table (make-hash-table :test 'eq)
842 "Map major mode names to dispatch property lists.")
844 (defun context-coloring-get-dispatch-for-mode (mode)
845 "Return the dispatch for MODE (or a derivative mode)."
849 (not (setq dispatch (gethash parent context-coloring-mode-hash-table)))
850 (setq parent (get parent 'derived-mode-parent))))
853 (defun context-coloring-define-dispatch (symbol &rest properties)
854 "Define a new dispatch named SYMBOL with PROPERTIES.
856 A \"dispatch\" is a property list describing a strategy for
857 coloring a buffer. There are three possible strategies: Parse
858 and color in a single function (`:colorizer'), parse in a
859 function that returns scope data (`:scopifier'), or parse with a
860 shell command that returns scope data (`:command'). In the
861 latter two cases, the scope data will be used to automatically
864 PROPERTIES must include `:modes' and one of `:colorizer',
865 `:scopifier' or `:command'.
867 `:modes' - List of major modes this dispatch is valid for.
869 `:colorizer' - Symbol referring to a function that parses and
872 `:scopifier' - Symbol referring to a function that parses the
873 buffer a returns a flat vector of start, end and level data.
875 `:executable' - Optional name of an executable required by
878 `:command' - Shell command to execute with the current buffer
879 sent via stdin, and with a flat JSON array of start, end and
880 level data returned via stdout.
882 `:version' - Minimum required version that should be printed when
883 executing `:command' with a \"--version\" flag. The version
884 should be numeric, e.g. \"2\", \"19700101\", \"1.2.3\",
887 `:setup' - Arbitrary code to set up this dispatch when
888 `context-coloring-mode' is enabled.
890 `:teardown' - Arbitrary code to tear down this dispatch when
891 `context-coloring-mode' is disabled."
892 (let ((modes (plist-get properties :modes))
893 (colorizer (plist-get properties :colorizer))
894 (scopifier (plist-get properties :scopifier))
895 (command (plist-get properties :command)))
897 (error "No mode defined for dispatch"))
898 (when (not (or colorizer
901 (error "No colorizer, scopifier or command defined for dispatch"))
902 (puthash symbol properties context-coloring-dispatch-hash-table)
904 (puthash mode properties context-coloring-mode-hash-table))))
909 (defvar context-coloring-colorize-hook nil
910 "Hooks to run after coloring a buffer.")
912 (defun context-coloring-colorize (&optional callback)
913 "Color the current buffer by function context.
915 Invoke CALLBACK when complete; see `context-coloring-dispatch'."
917 (context-coloring-dispatch
919 (when callback (funcall callback))
920 (run-hooks 'context-coloring-colorize-hook))))
922 (defvar-local context-coloring-changed nil
923 "Indication that the buffer has changed recently, which implies
924 that it should be colored again by
925 `context-coloring-colorize-idle-timer' if that timer is being
928 (defun context-coloring-change-function (_start _end _length)
929 "Register a change so that a buffer can be colorized soon."
930 ;; Tokenization is obsolete if there was a change.
931 (context-coloring-kill-scopifier)
932 (setq context-coloring-changed t))
934 (defun context-coloring-maybe-colorize (buffer)
935 "Colorize the current buffer if it has changed."
936 (when (and (eq buffer (current-buffer))
937 context-coloring-changed)
938 (setq context-coloring-changed nil)
939 (context-coloring-colorize)))
944 (defun context-coloring-parse-version (string)
945 "Extract segments of a version STRING into a list. \"v1.0.0\"
946 produces (1 0 0), \"19700101\" produces (19700101), etc."
948 (while (string-match "[0-9]+" string)
949 (setq version (append version
950 (list (string-to-number (match-string 0 string)))))
951 (setq string (substring string (match-end 0))))
954 (defun context-coloring-check-version (expected actual)
955 "Check that version EXPECTED is less than or equal to ACTUAL."
956 (let ((expected (context-coloring-parse-version expected))
957 (actual (context-coloring-parse-version actual))
960 (while (and continue expected)
961 (let ((an-expected (car expected))
962 (an-actual (car actual)))
964 ((> an-actual an-expected)
967 ((< an-actual an-expected)
968 (setq acceptable nil)
969 (setq continue nil))))
970 (setq expected (cdr expected))
971 (setq actual (cdr actual)))
974 (defvar context-coloring-check-scopifier-version-hook nil
975 "Hooks to run after checking the scopifier version.")
977 (defun context-coloring-check-scopifier-version (&optional callback)
978 "Asynchronously invoke CALLBACK with a predicate indicating
979 whether the current scopifier version satisfies the minimum
980 version number required for the current major mode."
981 (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
983 (let ((version (plist-get dispatch :version))
984 (command (plist-get dispatch :command)))
985 (context-coloring-scopify-shell-command
986 (context-coloring-join (list command "--version") " ")
988 (if (context-coloring-check-version version output)
990 (when callback (funcall callback t)))
991 (when callback (funcall callback nil)))
992 (run-hooks 'context-coloring-check-scopifier-version-hook)))))))
997 (defvar context-coloring-theme-hash-table (make-hash-table :test 'eq)
998 "Map theme names to theme properties.")
1000 (defun context-coloring-theme-p (theme)
1001 "Return t if THEME is defined, nil otherwise."
1002 (and (gethash theme context-coloring-theme-hash-table)))
1004 (defconst context-coloring-level-face-regexp
1005 "context-coloring-level-\\([[:digit:]]+\\)-face"
1006 "Extract a level from a face.")
1008 (defvar context-coloring-originally-set-theme-hash-table
1009 (make-hash-table :test 'eq)
1010 "Cache custom themes who originally set their own
1011 `context-coloring-level-N-face' faces.")
1013 (defun context-coloring-theme-originally-set-p (theme)
1014 "Return t if there is a `context-coloring-level-N-face'
1015 originally set for THEME, nil otherwise."
1016 (let (originally-set)
1018 ;; `setq' might return a non-nil value for the sake of this `cond'.
1023 context-coloring-originally-set-theme-hash-table))
1024 (eq originally-set 'yes))
1026 (let* ((settings (get theme 'theme-settings))
1029 (while (and tail (not found))
1030 (and (eq (nth 0 (car tail)) 'theme-face)
1032 context-coloring-level-face-regexp
1033 (symbol-name (nth 1 (car tail))))
1035 (setq tail (cdr tail)))
1038 (defun context-coloring-cache-originally-set (theme originally-set)
1039 "Remember if THEME had colors originally set for it. If
1040 ORIGINALLY-SET is non-nil, it did, otherwise it didn't."
1041 ;; Caching whether a theme was originally set is kind of dirty, but we have to
1042 ;; do it to remember the past state of the theme. There are probably some
1043 ;; edge cases where caching will be an issue, but they are probably rare.
1046 (if originally-set 'yes 'no)
1047 context-coloring-originally-set-theme-hash-table))
1049 (defun context-coloring-warn-theme-originally-set (theme)
1050 "Warn the user that the colors for THEME are already originally
1052 (warn "Context coloring colors for theme `%s' are already defined" theme))
1054 (defun context-coloring-theme-highest-level (theme)
1055 "Return the highest level N of a face like
1056 `context-coloring-level-N-face' set for THEME, or `-1' if there
1058 (let* ((settings (get theme 'theme-settings))
1064 (and (eq (nth 0 (car tail)) 'theme-face)
1065 (setq face-string (symbol-name (nth 1 (car tail))))
1067 context-coloring-level-face-regexp
1069 (setq number (string-to-number
1070 (substring face-string
1074 (setq found number))
1075 (setq tail (cdr tail)))
1078 (defun context-coloring-apply-theme (theme)
1079 "Apply THEME's properties to its respective custom theme,
1080 which must already exist and which *should* already be enabled."
1081 (let* ((properties (gethash theme context-coloring-theme-hash-table))
1082 (colors (plist-get properties :colors))
1084 ;; Only clobber when we have to.
1085 (when (custom-theme-enabled-p theme)
1086 (setq context-coloring-maximum-face (- (length colors) 1)))
1088 'custom-theme-set-faces
1092 (setq level (+ level 1))
1093 `(,(context-coloring-level-face level) ((t (:foreground ,color)))))
1096 (defun context-coloring-define-theme (theme &rest properties)
1097 "Define a context theme named THEME for coloring scope levels.
1099 PROPERTIES is a property list specifiying the following details:
1101 `:aliases': List of symbols of other custom themes that these
1102 colors are applicable to.
1104 `:colors': List of colors that this context theme uses.
1106 `:override': If non-nil, this context theme is intentionally
1107 overriding colors set by a custom theme. Don't set this non-nil
1108 unless there is a custom theme you want to use which sets
1109 `context-coloring-level-N-face' faces that you want to replace.
1111 `:recede': If non-nil, this context theme should not apply its
1112 colors if a custom theme already sets
1113 `context-coloring-level-N-face' faces. This option is
1114 optimistic; set this non-nil if you would rather confer the duty
1115 of picking colors to a custom theme author (if / when he ever
1118 By default, context themes will always override custom themes,
1119 even if those custom themes set `context-coloring-level-N-face'
1120 faces. If a context theme does override a custom theme, a
1121 warning will be raised, at which point you may want to enable the
1122 `:override' option, or just delete your context theme and opt to
1123 use your custom theme's author's colors instead.
1125 Context themes only work for the custom theme with the highest
1126 precedence, i.e. the car of `custom-enabled-themes'."
1127 (let ((aliases (plist-get properties :aliases))
1128 (override (plist-get properties :override))
1129 (recede (plist-get properties :recede)))
1130 (dolist (name (append `(,theme) aliases))
1131 (puthash name properties context-coloring-theme-hash-table)
1132 (when (custom-theme-p name)
1133 (let ((originally-set (context-coloring-theme-originally-set-p name)))
1134 (context-coloring-cache-originally-set name originally-set)
1135 ;; In the particular case when you innocently define colors that a
1136 ;; custom theme originally set, warn. Arguably this only has to be
1137 ;; done at enable time, but it is probably more useful to do it at
1138 ;; definition time for prompter feedback.
1139 (when (and originally-set
1142 (context-coloring-warn-theme-originally-set name))
1143 ;; Set (or overwrite) colors.
1144 (when (not (and originally-set
1146 (context-coloring-apply-theme name)))))))
1148 (defun context-coloring-enable-theme (theme)
1149 "Apply THEME if its colors are not already set, else just set
1150 `context-coloring-maximum-face' to the correct value for THEME."
1151 (let* ((properties (gethash theme context-coloring-theme-hash-table))
1152 (recede (plist-get properties :recede))
1153 (override (plist-get properties :override)))
1156 (let ((highest-level (context-coloring-theme-highest-level theme)))
1158 ;; This can be true whether originally set by a custom theme or by a
1160 ((> highest-level -1)
1161 (setq context-coloring-maximum-face highest-level))
1162 ;; It is possible that the corresponding custom theme did not exist at
1163 ;; the time of defining this context theme, and in that case the above
1164 ;; condition proves the custom theme did not originally set any faces,
1165 ;; so we have license to apply the context theme for the first time
1168 (context-coloring-apply-theme theme)))))
1170 (let ((originally-set (context-coloring-theme-originally-set-p theme)))
1171 ;; Cache now in case the context theme was defined after the custom
1173 (context-coloring-cache-originally-set theme originally-set)
1174 (when (and originally-set
1176 (context-coloring-warn-theme-originally-set theme))
1177 (context-coloring-apply-theme theme))))))
1179 (defadvice enable-theme (after context-coloring-enable-theme (theme) activate)
1180 "Enable colors for context themes just-in-time."
1181 (when (and (not (eq theme 'user)) ; Called internally by `enable-theme'.
1182 (custom-theme-p theme) ; Guard against non-existent themes.
1183 (context-coloring-theme-p theme))
1184 (when (= (length custom-enabled-themes) 1)
1185 ;; Cache because we can't reliably figure it out in reverse.
1186 (setq context-coloring-original-maximum-face
1187 context-coloring-maximum-face))
1188 (context-coloring-enable-theme theme)))
1190 (defadvice disable-theme (after context-coloring-disable-theme (theme) activate)
1191 "Update `context-coloring-maximum-face'."
1192 (when (custom-theme-p theme) ; Guard against non-existent themes.
1193 (let ((enabled-theme (car custom-enabled-themes)))
1194 (if (context-coloring-theme-p enabled-theme)
1196 (context-coloring-enable-theme enabled-theme))
1197 ;; Assume we are back to no theme; act as if nothing ever happened.
1198 ;; This is still prone to intervention, but rather extraordinarily.
1199 (setq context-coloring-maximum-face
1200 context-coloring-original-maximum-face)))))
1202 (context-coloring-define-theme
1214 (context-coloring-define-theme
1229 (context-coloring-define-theme
1241 (context-coloring-define-theme
1254 (context-coloring-define-theme
1267 (context-coloring-define-theme
1270 :aliases '(solarized-light
1272 sanityinc-solarized-light
1273 sanityinc-solarized-dark)
1292 (context-coloring-define-theme
1304 (context-coloring-define-theme
1321 (context-coloring-define-theme
1337 ;;; Change detection
1339 (defvar-local context-coloring-colorize-idle-timer nil
1340 "The currently-running idle timer.")
1342 (defcustom context-coloring-delay 0.25
1343 "Delay between a buffer update and colorization.
1345 Increase this if your machine is high-performing. Decrease it if
1348 Supported modes: `js-mode', `js3-mode', `emacs-lisp-mode'"
1349 :group 'context-coloring)
1351 (defun context-coloring-setup-idle-change-detection ()
1352 "Setup idle change detection."
1354 'after-change-functions 'context-coloring-change-function nil t)
1356 'kill-buffer-hook 'context-coloring-teardown-idle-change-detection nil t)
1357 (setq context-coloring-colorize-idle-timer
1358 (run-with-idle-timer
1359 context-coloring-delay
1361 'context-coloring-maybe-colorize
1364 (defun context-coloring-teardown-idle-change-detection ()
1365 "Teardown idle change detection."
1366 (context-coloring-kill-scopifier)
1367 (when context-coloring-colorize-idle-timer
1368 (cancel-timer context-coloring-colorize-idle-timer))
1370 'kill-buffer-hook 'context-coloring-teardown-idle-change-detection t)
1372 'after-change-functions 'context-coloring-change-function t))
1375 ;;; Built-in dispatches
1377 (context-coloring-define-dispatch
1379 :modes '(js-mode js3-mode)
1380 :executable "scopifier"
1381 :command "scopifier"
1384 (context-coloring-define-dispatch
1387 :colorizer 'context-coloring-js2-colorize
1390 (add-hook 'js2-post-parse-callbacks 'context-coloring-colorize nil t))
1393 (remove-hook 'js2-post-parse-callbacks 'context-coloring-colorize t)))
1395 (context-coloring-define-dispatch
1397 :modes '(emacs-lisp-mode)
1398 :colorizer 'context-coloring-emacs-lisp-colorize
1399 :setup 'context-coloring-setup-idle-change-detection
1400 :teardown 'context-coloring-teardown-idle-change-detection)
1402 (defun context-coloring-dispatch (&optional callback)
1403 "Determine the optimal track for scopification / coloring of
1404 the current buffer, then execute it.
1406 Invoke CALLBACK when complete. It is invoked synchronously for
1407 elisp tracks, and asynchronously for shell command tracks."
1408 (let* ((dispatch (context-coloring-get-dispatch-for-mode major-mode))
1409 (colorizer (plist-get dispatch :colorizer))
1410 (scopifier (plist-get dispatch :scopifier))
1411 (command (plist-get dispatch :command))
1414 ((or colorizer scopifier)
1419 (funcall colorizer))
1421 (context-coloring-apply-tokens (funcall scopifier))))))
1424 (setq context-coloring-changed t))
1426 (when callback (funcall callback)))))
1428 (context-coloring-scopify-and-colorize command callback)))))
1434 (define-minor-mode context-coloring-mode
1435 "Context-based code coloring, inspired by Douglas Crockford."
1437 (if (not context-coloring-mode)
1439 (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
1441 (let ((command (plist-get dispatch :command))
1442 (teardown (plist-get dispatch :teardown)))
1444 (context-coloring-teardown-idle-change-detection))
1446 (funcall teardown)))))
1450 ;; Font lock is incompatible with this mode; the converse is also true.
1454 ;; ...but we do use font-lock functions here.
1455 (font-lock-set-defaults)
1457 ;; Safely change the valye of this function as necessary.
1458 (make-local-variable 'font-lock-syntactic-face-function)
1460 (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
1463 (let ((command (plist-get dispatch :command))
1464 (version (plist-get dispatch :version))
1465 (executable (plist-get dispatch :executable))
1466 (setup (plist-get dispatch :setup))
1467 (colorize-initially-p t))
1469 ;; Shell commands recolor on change, idly.
1472 (null (executable-find executable)))
1473 (message "Executable \"%s\" not found" executable)
1474 (setq colorize-initially-p nil))
1476 (context-coloring-check-scopifier-version
1477 (lambda (sufficient-p)
1480 (context-coloring-setup-idle-change-detection)
1481 (context-coloring-colorize))
1482 (message "Update to the minimum version of \"%s\" (%s)"
1483 executable version))))
1484 (setq colorize-initially-p nil))
1486 (context-coloring-setup-idle-change-detection))))
1489 ;; Colorize once initially.
1490 (when colorize-initially-p
1491 (let ((context-coloring-parse-interruptable-p nil))
1492 (context-coloring-colorize)))))
1493 (when (null dispatch)
1494 (message "Context coloring is not available for this major mode"))))))
1496 (provide 'context-coloring)
1498 ;;; context-coloring.el ends here