code.delx.au - gnu-emacs-elpa/blob - context-coloring.el

   1 ;;; context-coloring.el --- Highlight by scope  -*- lexical-binding: t; -*-
   2
   3 ;; Copyright (C) 2014-2015  Free Software Foundation, Inc.
   4
   5 ;; Author: Jackson Ray Hamilton <jackson@jacksonrayhamilton.com>
   6 ;; Version: 6.3.0
   7 ;; Keywords: convenience faces tools
   8 ;; Package-Requires: ((emacs "24") (js2-mode "20150126"))
   9 ;; URL: https://github.com/jacksonrayhamilton/context-coloring
  10
  11 ;; This file is part of GNU Emacs.
  12
  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.
  17
  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.
  22
  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/>.
  25
  26 ;;; Commentary:
  27
  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.
  32
  33 ;; By default, comments and strings are still highlighted syntactically.
  34
  35 ;;; Code:
  36
  37 (require 'js2-mode)
  38
  39
  40 ;;; Utilities
  41
  42 (defun context-coloring-join (strings delimiter)
  43   "Join a list of STRINGS with the string DELIMITER."
  44   (mapconcat 'identity strings delimiter))
  45
  46 (defsubst context-coloring-trim-right (string)
  47   "Remove leading whitespace from STRING."
  48   (if (string-match "[ \t\n\r]+\\'" string)
  49       (replace-match "" t t string)
  50     string))
  51
  52 (defsubst context-coloring-trim-left (string)
  53   "Remove trailing whitespace from STRING."
  54   (if (string-match "\\`[ \t\n\r]+" string)
  55       (replace-match "" t t string)
  56     string))
  57
  58 (defsubst context-coloring-trim (string)
  59   "Remove leading and trailing whitespace from STRING."
  60   (context-coloring-trim-left (context-coloring-trim-right string)))
  61
  62
  63 ;;; Faces
  64
  65 (defun context-coloring-defface (level tty light dark)
  66   "Define a face for LEVEL with colors for TTY, LIGHT and DARK
  67 backgrounds."
  68   (let ((face (intern (format "context-coloring-level-%s-face" level)))
  69         (doc (format "Context coloring face, level %s." level)))
  70     (custom-declare-face
  71      face
  72      `((((type tty)) (:foreground ,tty))
  73        (((background light)) (:foreground ,light))
  74        (((background dark)) (:foreground ,dark)))
  75      doc
  76      :group 'context-coloring)))
  77
  78 (defun context-coloring-defface-neutral (level)
  79   "Define a face for LEVEL with the default neutral colors."
  80   (context-coloring-defface level nil "#3f3f3f" "#cdcdcd"))
  81
  82 (context-coloring-defface 0 nil       "#000000" "#ffffff")
  83 (context-coloring-defface 1 "yellow"  "#008b8b" "#00ffff")
  84 (context-coloring-defface 2 "green"   "#0000ff" "#87cefa")
  85 (context-coloring-defface 3 "cyan"    "#483d8b" "#b0c4de")
  86 (context-coloring-defface 4 "blue"    "#a020f0" "#eedd82")
  87 (context-coloring-defface 5 "magenta" "#a0522d" "#98fb98")
  88 (context-coloring-defface 6 "red"     "#228b22" "#7fffd4")
  89 (context-coloring-defface-neutral 7)
  90
  91 (defvar context-coloring-maximum-face nil
  92   "Index of the highest face available for coloring.")
  93
  94 (defvar context-coloring-original-maximum-face nil
  95   "Fallback value for `context-coloring-maximum-face' when all
  96   themes have been disabled.")
  97
  98 (setq context-coloring-maximum-face 7)
  99
 100 (setq context-coloring-original-maximum-face
 101       context-coloring-maximum-face)
 102
 103 ;; Theme authors can have up to 26 levels: 1 (0th) for globals, 24 (1st-24th)
 104 ;; for nested levels, and 1 (25th) for infinity.
 105 (dotimes (number 18)
 106   (context-coloring-defface-neutral (+ number context-coloring-maximum-face 1)))
 107
 108
 109 ;;; Face functions
 110
 111 (defsubst context-coloring-level-face (level)
 112   "Return the symbol for a face with LEVEL."
 113   ;; `concat' is faster than `format' here.
 114   (intern-soft
 115    (concat "context-coloring-level-" (number-to-string level) "-face")))
 116
 117 (defsubst context-coloring-bounded-level-face (level)
 118   "Return the symbol for a face with LEVEL, bounded by
 119 `context-coloring-maximum-face'."
 120   (context-coloring-level-face (min level context-coloring-maximum-face)))
 121
 122
 123 ;;; Colorization utilities
 124
 125 (defsubst context-coloring-colorize-region (start end level)
 126   "Color characters from the 1-indexed START point (inclusive) to
 127 the END point (exclusive) with the face corresponding to LEVEL."
 128   (add-text-properties
 129    start
 130    end
 131    `(face ,(context-coloring-bounded-level-face level))))
 132
 133 (make-obsolete-variable
 134  'context-coloring-comments-and-strings
 135  "use `context-coloring-syntactic-comments' and
 136  `context-coloring-syntactic-strings' instead."
 137  "6.1.0")
 138
 139 (defcustom context-coloring-syntactic-comments t
 140   "If non-nil, also color comments using `font-lock'."
 141   :group 'context-coloring)
 142
 143 (defcustom context-coloring-syntactic-strings t
 144   "If non-nil, also color strings using `font-lock'."
 145   :group 'context-coloring)
 146
 147 (defun context-coloring-font-lock-syntactic-comment-function (state)
 148   "Tell `font-lock' to color a comment but not a string."
 149   (if (nth 3 state) nil font-lock-comment-face))
 150
 151 (defun context-coloring-font-lock-syntactic-string-function (state)
 152   "Tell `font-lock' to color a string but not a comment."
 153   (if (nth 3 state) font-lock-string-face nil))
 154
 155 (defsubst context-coloring-maybe-colorize-comments-and-strings (&optional min max)
 156   "Color the current buffer's comments or strings if
 157 `context-coloring-syntactic-comments' or
 158 `context-coloring-syntactic-strings' are non-nil."
 159   (when (or context-coloring-syntactic-comments
 160             context-coloring-syntactic-strings)
 161     (let ((min (or min (point-min)))
 162           (max (or max (point-max)))
 163           (font-lock-syntactic-face-function
 164            (cond
 165             ((and context-coloring-syntactic-comments
 166                   (not context-coloring-syntactic-strings))
 167              'context-coloring-font-lock-syntactic-comment-function)
 168             ((and context-coloring-syntactic-strings
 169                   (not context-coloring-syntactic-comments))
 170              'context-coloring-font-lock-syntactic-string-function)
 171             (t
 172              font-lock-syntactic-face-function))))
 173       (save-excursion
 174         (font-lock-fontify-syntactically-region min max)
 175         ;; TODO: Make configurable at the dispatch level.
 176         (when (eq major-mode 'emacs-lisp-mode)
 177           (font-lock-fontify-keywords-region min max))))))
 178
 179
 180 ;;; js2-mode colorization
 181
 182 (defvar-local context-coloring-js2-scope-level-hash-table nil
 183   "Associate `js2-scope' structures and with their scope
 184   levels.")
 185
 186 (defcustom context-coloring-js-block-scopes nil
 187   "If non-nil, also color block scopes in the scope hierarchy in JavaScript.
 188
 189 The block-scoped `let' and `const' are introduced in ES6.  Enable
 190 this for ES6 code; disable it elsewhere.
 191
 192 Supported modes: `js2-mode'"
 193   :group 'context-coloring)
 194
 195 (defsubst context-coloring-js2-scope-level (scope)
 196   "Return the level of SCOPE."
 197   (cond ((gethash scope context-coloring-js2-scope-level-hash-table))
 198         (t
 199          (let ((level 0)
 200                (current-scope scope)
 201                enclosing-scope)
 202            (while (and current-scope
 203                        (js2-node-parent current-scope)
 204                        (setq enclosing-scope
 205                              (js2-node-get-enclosing-scope current-scope)))
 206              (when (or context-coloring-js-block-scopes
 207                        (let ((type (js2-scope-type current-scope)))
 208                          (or (= type js2-SCRIPT)
 209                              (= type js2-FUNCTION)
 210                              (= type js2-CATCH))))
 211                (setq level (+ level 1)))
 212              (setq current-scope enclosing-scope))
 213            (puthash scope level context-coloring-js2-scope-level-hash-table)))))
 214
 215 (defsubst context-coloring-js2-local-name-node-p (node)
 216   "Determine if NODE is a `js2-name-node' representing a local
 217 variable."
 218   (and (js2-name-node-p node)
 219        (let ((parent (js2-node-parent node)))
 220          (not (or (and (js2-object-prop-node-p parent)
 221                        (eq node (js2-object-prop-node-left parent)))
 222                   (and (js2-prop-get-node-p parent)
 223                        ;; For nested property lookup, the node on the left is a
 224                        ;; `js2-prop-get-node', so this always works.
 225                        (eq node (js2-prop-get-node-right parent))))))))
 226
 227 (defvar-local context-coloring-point-max nil
 228   "Cached value of `point-max'.")
 229
 230 (defsubst context-coloring-js2-colorize-node (node level)
 231   "Color NODE with the color for LEVEL."
 232   (let ((start (js2-node-abs-pos node)))
 233     (context-coloring-colorize-region
 234      start
 235      (min
 236       ;; End
 237       (+ start (js2-node-len node))
 238       ;; Somes nodes (like the ast when there is an unterminated multiline
 239       ;; comment) will stretch to the value of `point-max'.
 240       context-coloring-point-max)
 241      level)))
 242
 243 (defun context-coloring-js2-colorize ()
 244   "Color the current buffer using the abstract syntax tree
 245 generated by `js2-mode'."
 246   ;; Reset the hash table; the old one could be obsolete.
 247   (setq context-coloring-js2-scope-level-hash-table (make-hash-table :test 'eq))
 248   (setq context-coloring-point-max (point-max))
 249   (with-silent-modifications
 250     (js2-visit-ast
 251      js2-mode-ast
 252      (lambda (node end-p)
 253        (when (null end-p)
 254          (cond
 255           ((js2-scope-p node)
 256            (context-coloring-js2-colorize-node
 257             node
 258             (context-coloring-js2-scope-level node)))
 259           ((context-coloring-js2-local-name-node-p node)
 260            (let* ((enclosing-scope (js2-node-get-enclosing-scope node))
 261                   (defining-scope (js2-get-defining-scope
 262                                    enclosing-scope
 263                                    (js2-name-node-name node))))
 264              ;; The tree seems to be walked lexically, so an entire scope will
 265              ;; be colored, including its name nodes, before they are reached.
 266              ;; Coloring the nodes defined in that scope would be redundant, so
 267              ;; don't do it.
 268              (when (not (eq defining-scope enclosing-scope))
 269                (context-coloring-js2-colorize-node
 270                 node
 271                 (context-coloring-js2-scope-level defining-scope))))))
 272          ;; The `t' indicates to search children.
 273          t)))
 274     (context-coloring-maybe-colorize-comments-and-strings)))
 275
 276
 277 ;;; Emacs Lisp colorization
 278
 279 (defsubst context-coloring-forward-sws ()
 280   "Move forward through whitespace and comments."
 281   (while (forward-comment 1)))
 282
 283 (defsubst context-coloring-get-syntax-code ()
 284   (syntax-class (syntax-after (point))))
 285
 286 (defsubst context-coloring-exact-regexp (word)
 287   "Create a regexp that matches exactly WORD."
 288   (concat "\\`" (regexp-quote word) "\\'"))
 289
 290 (defsubst context-coloring-exact-or-regexp (words)
 291   "Create a regexp that matches any exact word in WORDS."
 292   (context-coloring-join
 293    (mapcar 'context-coloring-exact-regexp words) "\\|"))
 294
 295 (defconst context-coloring-elisp-defun-regexp
 296   (context-coloring-exact-or-regexp
 297    '("defun" "defun*" "defsubst" "defmacro"
 298      "cl-defun" "cl-defsubst" "cl-defmacro")))
 299
 300 (defconst context-coloring-elisp-lambda-regexp
 301   (context-coloring-exact-regexp "lambda"))
 302
 303 (defconst context-coloring-elisp-let-regexp
 304   (context-coloring-exact-regexp "let"))
 305
 306 (defconst context-coloring-elisp-let*-regexp
 307   (context-coloring-exact-regexp "let*"))
 308
 309 (defconst context-coloring-elisp-arglist-arg-regexp
 310   "\\`[^&:]")
 311
 312 (defconst context-coloring-ignored-word-regexp
 313   (context-coloring-join (list "\\`[-+]?[0-9]"
 314                                "\\`[&:].+"
 315                                (context-coloring-exact-or-regexp
 316                                 '("t" "nil" "." "?")))
 317                          "\\|"))
 318
 319 (defconst context-coloring-WORD-CODE 2)
 320 (defconst context-coloring-SYMBOL-CODE 3)
 321 (defconst context-coloring-OPEN-PARENTHESIS-CODE 4)
 322 (defconst context-coloring-CLOSE-PARENTHESIS-CODE 5)
 323 (defconst context-coloring-EXPRESSION-PREFIX-CODE 6)
 324 (defconst context-coloring-STRING-QUOTE-CODE 7)
 325 (defconst context-coloring-ESCAPE-CODE 9)
 326 (defconst context-coloring-COMMENT-START-CODE 11)
 327 (defconst context-coloring-COMMENT-END-CODE 12)
 328
 329 (defconst context-coloring-APOSTROPHE-CHAR (string-to-char "'"))
 330 (defconst context-coloring-OPEN-PARENTHESIS-CHAR (string-to-char "("))
 331 (defconst context-coloring-COMMA-CHAR (string-to-char ","))
 332 (defconst context-coloring-BACKTICK-CHAR (string-to-char "`"))
 333
 334 (defvar context-coloring-elisp-scope-stack '())
 335
 336 (defsubst context-coloring-elisp-make-scope (level)
 337   (list
 338    :level level
 339    :variables '()))
 340
 341 (defsubst context-coloring-elisp-scope-get-level (scope)
 342   (plist-get scope :level))
 343
 344 (defsubst context-coloring-elisp-scope-add-variable (scope variable)
 345   (plist-put scope :variables (cons variable (plist-get scope :variables))))
 346
 347 (defsubst context-coloring-elisp-scope-has-variable (scope variable)
 348   (member variable (plist-get scope :variables)))
 349
 350 (defsubst context-coloring-elisp-get-variable-level (variable)
 351   (let* ((scope-stack context-coloring-elisp-scope-stack)
 352          scope
 353          level)
 354     (while (and scope-stack (not level))
 355       (setq scope (car scope-stack))
 356       (cond
 357        ((context-coloring-elisp-scope-has-variable scope variable)
 358         (setq level (context-coloring-elisp-scope-get-level scope)))
 359        (t
 360         (setq scope-stack (cdr scope-stack)))))
 361     ;; Assume a global variable.
 362     (or level 0)))
 363
 364 (defsubst context-coloring-elisp-current-scope-level ()
 365   (cond
 366    ((car context-coloring-elisp-scope-stack)
 367     (context-coloring-elisp-scope-get-level (car context-coloring-elisp-scope-stack)))
 368    (t
 369     0)))
 370
 371 (defsubst context-coloring-elisp-push-scope ()
 372   (push (context-coloring-elisp-make-scope
 373          (1+ (context-coloring-elisp-current-scope-level)))
 374         context-coloring-elisp-scope-stack))
 375
 376 (defsubst context-coloring-elisp-pop-scope ()
 377   (pop context-coloring-elisp-scope-stack))
 378
 379 (defsubst context-coloring-elisp-add-variable (variable)
 380   (context-coloring-elisp-scope-add-variable
 381    (car context-coloring-elisp-scope-stack)
 382    variable))
 383
 384 (defun context-coloring-elisp-parse-arg (callback)
 385   (let (arg-pos
 386         arg-end
 387         arg-string)
 388     (setq arg-pos (point))
 389     (forward-sexp)
 390     (setq arg-end (point))
 391     (setq arg-string (buffer-substring-no-properties
 392                       arg-pos
 393                       arg-end))
 394     (when (string-match-p
 395            context-coloring-elisp-arglist-arg-regexp
 396            arg-string)
 397       (funcall callback arg-string))))
 398
 399 (defun context-coloring-elisp-parse-let-varlist (type)
 400   (let ((varlist '())
 401         syntax-code)
 402     ;; Enter.
 403     (forward-char)
 404     (while (/= (setq syntax-code (context-coloring-get-syntax-code))
 405                context-coloring-CLOSE-PARENTHESIS-CODE)
 406       (cond
 407        ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE)
 408         (forward-char)
 409         (context-coloring-forward-sws)
 410         (setq syntax-code (context-coloring-get-syntax-code))
 411         (when (or (= syntax-code context-coloring-WORD-CODE)
 412                   (= syntax-code context-coloring-SYMBOL-CODE))
 413           (context-coloring-elisp-parse-arg
 414            (lambda (var)
 415              (push var varlist)))
 416           (context-coloring-forward-sws)
 417           (setq syntax-code (context-coloring-get-syntax-code))
 418           (when (/= syntax-code context-coloring-CLOSE-PARENTHESIS-CODE)
 419             (context-coloring-elisp-colorize-sexp)))
 420         (context-coloring-forward-sws)
 421         ;; Skip past the closing parenthesis.
 422         (forward-char))
 423        ((or (= syntax-code context-coloring-WORD-CODE)
 424             (= syntax-code context-coloring-SYMBOL-CODE))
 425         (context-coloring-elisp-parse-arg
 426          (lambda (var)
 427            (push var varlist)))))
 428       (when (eq type 'let*)
 429         (context-coloring-elisp-add-variable (pop varlist)))
 430       (context-coloring-forward-sws))
 431     (when (eq type 'let)
 432       (while varlist
 433         (context-coloring-elisp-add-variable (pop varlist))))
 434     ;; Exit.
 435     (forward-char)))
 436
 437 (defun context-coloring-elisp-parse-arglist ()
 438   (let (syntax-code)
 439     ;; Enter.
 440     (forward-char)
 441     (while (/= (setq syntax-code (context-coloring-get-syntax-code))
 442                context-coloring-CLOSE-PARENTHESIS-CODE)
 443       (cond
 444        ((or (= syntax-code context-coloring-WORD-CODE)
 445             (= syntax-code context-coloring-SYMBOL-CODE))
 446         (context-coloring-elisp-parse-arg
 447          (lambda (arg)
 448            (context-coloring-elisp-add-variable arg))))
 449        (t
 450         (forward-sexp)))
 451       (context-coloring-forward-sws))
 452     ;; Exit.
 453     (forward-char)))
 454
 455 (defun context-coloring-elisp-colorize-defun (&optional anonymous-p
 456                                                         let-type)
 457   (let ((start (point))
 458         end
 459         stop
 460         syntax-code
 461         defun-name-pos
 462         defun-name-end)
 463     (context-coloring-elisp-push-scope)
 464     ;; Color the whole sexp.
 465     (forward-sexp)
 466     (setq end (point))
 467     (context-coloring-colorize-region
 468      start
 469      end
 470      (context-coloring-elisp-current-scope-level))
 471     (goto-char start)
 472     ;; Skip past the "defun".
 473     (skip-syntax-forward "^w_")
 474     (forward-sexp)
 475     (context-coloring-forward-sws)
 476     (setq stop nil)
 477     (unless anonymous-p
 478       ;; Check for the defun's name.
 479       (setq syntax-code (context-coloring-get-syntax-code))
 480       (cond
 481        ((or (= syntax-code context-coloring-WORD-CODE)
 482             (= syntax-code context-coloring-SYMBOL-CODE))
 483         ;; Color the defun's name with the top-level color.
 484         (setq defun-name-pos (point))
 485         (forward-sexp)
 486         (setq defun-name-end (point))
 487         (context-coloring-colorize-region defun-name-pos defun-name-end 0)
 488         (context-coloring-forward-sws))
 489        (t
 490         (setq stop t))))
 491     (cond
 492      (stop
 493       ;; Skip it.
 494       (goto-char start)
 495       (forward-sexp))
 496      (t
 497       (setq syntax-code (context-coloring-get-syntax-code))
 498       (cond
 499        ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE)
 500         (cond
 501          (let-type
 502           (context-coloring-elisp-parse-let-varlist let-type))
 503          (t
 504           (context-coloring-elisp-parse-arglist)))
 505         ;; Colorize the rest of the function.
 506         (context-coloring-elisp-colorize-region (point) (1- end))
 507         ;; Exit the defun.
 508         (forward-char))
 509        (t
 510         ;; Skip it.
 511         (goto-char start)
 512         (forward-sexp)))))
 513     (context-coloring-elisp-pop-scope)))
 514
 515 (defun context-coloring-elisp-colorize-lambda ()
 516   (context-coloring-elisp-colorize-defun t))
 517
 518 (defun context-coloring-elisp-colorize-let ()
 519   (context-coloring-elisp-colorize-defun t 'let))
 520
 521 (defun context-coloring-elisp-colorize-let* ()
 522   (context-coloring-elisp-colorize-defun t 'let*))
 523
 524 (defun context-coloring-elisp-colorize-parenthesized-sexp ()
 525   (let ((start (point))
 526         end
 527         syntax-code
 528         child-0-pos
 529         child-0-end
 530         child-0-string)
 531     (forward-sexp)
 532     (setq end (point))
 533     (goto-char start)
 534     (forward-char)
 535     (context-coloring-forward-sws)
 536     (setq syntax-code (context-coloring-get-syntax-code))
 537     ;; Figure out if the sexp is a special form.
 538     (cond
 539      ((or (= syntax-code context-coloring-WORD-CODE)
 540           (= syntax-code context-coloring-SYMBOL-CODE))
 541       (setq child-0-pos (point))
 542       (forward-sexp)
 543       (setq child-0-end (point))
 544       (setq child-0-string (buffer-substring-no-properties
 545                             child-0-pos
 546                             child-0-end))
 547       (cond
 548        ((string-match-p context-coloring-elisp-defun-regexp child-0-string)
 549         (goto-char start)
 550         (context-coloring-elisp-colorize-defun))
 551        ((string-match-p context-coloring-elisp-lambda-regexp child-0-string)
 552         (goto-char start)
 553         (context-coloring-elisp-colorize-lambda))
 554        ((string-match-p context-coloring-elisp-let-regexp child-0-string)
 555         (goto-char start)
 556         (context-coloring-elisp-colorize-let))
 557        ((string-match-p context-coloring-elisp-let*-regexp child-0-string)
 558         (goto-char start)
 559         (context-coloring-elisp-colorize-let*))
 560        ;; Not a special form; just colorize the remaining region.
 561        (t
 562         (context-coloring-colorize-region
 563          start
 564          end
 565          (context-coloring-elisp-current-scope-level))
 566         (context-coloring-elisp-colorize-region (point) (1- end))
 567         (forward-char))))
 568      (t
 569       ;; Skip it.
 570       (goto-char start)
 571       (forward-sexp)))))
 572
 573 (defun context-coloring-elisp-colorize-symbol ()
 574   (let (symbol-pos
 575         symbol-end
 576         symbol-string)
 577     (setq symbol-pos (point))
 578     (forward-sexp)
 579     (setq symbol-end (point))
 580     (setq symbol-string (buffer-substring-no-properties
 581                          symbol-pos
 582                          symbol-end))
 583     (cond
 584      ((string-match-p context-coloring-ignored-word-regexp symbol-string))
 585      (t
 586       (context-coloring-colorize-region
 587        symbol-pos
 588        symbol-end
 589        (context-coloring-elisp-get-variable-level
 590         symbol-string))))))
 591
 592 (defun context-coloring-elisp-colorize-expression-prefix ()
 593   (let (start
 594         end
 595         char)
 596     (setq char (char-after))
 597     (cond
 598      ((= char context-coloring-APOSTROPHE-CHAR)
 599       (forward-sexp))
 600      ((= char context-coloring-BACKTICK-CHAR)
 601       (setq start (point))
 602       (forward-sexp)
 603       (setq end (point))
 604       (goto-char start)
 605       (while (> end (progn (forward-char)
 606                            (point)))
 607         (setq char (char-after))
 608         (when (= char context-coloring-COMMA-CHAR)
 609           (forward-char)
 610           (context-coloring-forward-sws)
 611           (context-coloring-elisp-colorize-sexp)))))))
 612
 613 (defvar context-coloring-parse-interruptable-p t
 614   "Set this to nil to force parse to continue until finished.")
 615
 616 (defconst context-coloring-elisp-sexps-per-pause 1000
 617   "Pause after this many iterations to check for user input.
 618 If user input is pending, stop the parse.  This makes for a
 619 smoother user experience for large files.
 620
 621 As of this writing, emacs lisp colorization seems to run at about
 622 60,000 iterations per second.  A default value of 1000 should
 623 provide visually \"instant\" updates at 60 frames per second.")
 624
 625 (defvar context-coloring-elisp-sexp-count 0)
 626
 627 (defun context-coloring-elisp-increment-sexp-count ()
 628   (setq context-coloring-elisp-sexp-count
 629         (1+ context-coloring-elisp-sexp-count))
 630   (when (and (zerop (% context-coloring-elisp-sexp-count
 631                        context-coloring-elisp-sexps-per-pause))
 632              context-coloring-parse-interruptable-p
 633              (input-pending-p))
 634     (throw 'interrupted t)))
 635
 636 (defun context-coloring-elisp-colorize-sexp ()
 637   (let (syntax-code)
 638     (context-coloring-elisp-increment-sexp-count)
 639     (setq syntax-code (context-coloring-get-syntax-code))
 640     (cond
 641      ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE)
 642       (context-coloring-elisp-colorize-parenthesized-sexp))
 643      ((or (= syntax-code context-coloring-WORD-CODE)
 644           (= syntax-code context-coloring-SYMBOL-CODE))
 645       (context-coloring-elisp-colorize-symbol))
 646      ((= syntax-code context-coloring-EXPRESSION-PREFIX-CODE)
 647       (context-coloring-elisp-colorize-expression-prefix))
 648      (t
 649       (forward-char)))))
 650
 651 (defun context-coloring-elisp-colorize-comment ()
 652   (let ((start (point)))
 653     (context-coloring-elisp-increment-sexp-count)
 654     (skip-syntax-forward "^>")
 655     (context-coloring-maybe-colorize-comments-and-strings
 656      start
 657      (point))))
 658
 659 (defun context-coloring-elisp-colorize-string ()
 660   (let ((start (point))
 661         syntax-code)
 662     (context-coloring-elisp-increment-sexp-count)
 663     ;; Move past the opening string delimiter.
 664     (forward-char)
 665     (while (progn
 666              (skip-syntax-forward "^\\\"")
 667              (setq syntax-code (context-coloring-get-syntax-code))
 668              (cond
 669               ((= syntax-code context-coloring-ESCAPE-CODE)
 670                ;; If there was an escape char, keep going.
 671                (forward-char 2)
 672                t)
 673               ((= syntax-code context-coloring-STRING-QUOTE-CODE)
 674                ;; If the string ended, move outside it.
 675                (forward-char)
 676                nil))))
 677     (context-coloring-maybe-colorize-comments-and-strings
 678      start
 679      (point))))
 680
 681 (defun context-coloring-elisp-colorize-region (start end)
 682   (let (syntax-code)
 683     (goto-char start)
 684     (while (> end (progn (skip-syntax-forward "^()w_'<\"" end)
 685                          (point)))
 686       (setq syntax-code (context-coloring-get-syntax-code))
 687       (cond
 688        ((or (= syntax-code context-coloring-OPEN-PARENTHESIS-CODE)
 689             (= syntax-code context-coloring-WORD-CODE)
 690             (= syntax-code context-coloring-SYMBOL-CODE)
 691             (= syntax-code context-coloring-EXPRESSION-PREFIX-CODE))
 692         (context-coloring-elisp-colorize-sexp))
 693        ((= syntax-code context-coloring-COMMENT-START-CODE)
 694         (context-coloring-elisp-colorize-comment))
 695        ((= syntax-code context-coloring-STRING-QUOTE-CODE)
 696         (context-coloring-elisp-colorize-string))
 697        (t
 698         (forward-char))))))
 699
 700 (defun context-coloring-elisp-colorize (start end)
 701   (setq context-coloring-elisp-sexp-count 0)
 702   (setq context-coloring-elisp-scope-stack '())
 703   (context-coloring-elisp-colorize-region start end))
 704
 705 (defun context-coloring-elisp-colorize-changed-region (start end)
 706   (with-silent-modifications
 707     (save-excursion
 708       (let ((start (progn (goto-char start)
 709                           (beginning-of-defun)
 710                           (point)))
 711             (end (progn (goto-char end)
 712                         (end-of-defun)
 713                         (point))))
 714         (context-coloring-elisp-colorize start end)))))
 715
 716 (defun context-coloring-elisp-colorize-buffer ()
 717   (interactive)
 718   (with-silent-modifications
 719     (save-excursion
 720       (context-coloring-elisp-colorize (point-min) (point-max)))))
 721
 722 (defalias 'ccecb 'context-coloring-elisp-colorize-buffer)
 723
 724
 725 ;;; Shell command scopification / colorization
 726
 727 (defun context-coloring-apply-tokens (tokens)
 728   "Process a vector of TOKENS to apply context-based coloring to
 729 the current buffer.  Tokens are 3 integers: start, end, level.
 730 The vector is flat, with a new token occurring after every 3rd
 731 element."
 732   (with-silent-modifications
 733     (let ((i 0)
 734           (len (length tokens)))
 735       (while (< i len)
 736         (context-coloring-colorize-region
 737          (elt tokens i)
 738          (elt tokens (+ i 1))
 739          (elt tokens (+ i 2)))
 740         (setq i (+ i 3))))
 741     (context-coloring-maybe-colorize-comments-and-strings)))
 742
 743 (defun context-coloring-parse-array (array)
 744   "Parse ARRAY as a flat JSON array of numbers."
 745   (let ((braceless (substring (context-coloring-trim array) 1 -1)))
 746     (cond
 747      ((> (length braceless) 0)
 748       (vconcat
 749        (mapcar 'string-to-number (split-string braceless ","))))
 750      (t
 751       (vector)))))
 752
 753 (defvar-local context-coloring-scopifier-process nil
 754   "The single scopifier process that can be running.")
 755
 756 (defun context-coloring-kill-scopifier ()
 757   "Kill the currently-running scopifier process."
 758   (when (not (null context-coloring-scopifier-process))
 759     (delete-process context-coloring-scopifier-process)
 760     (setq context-coloring-scopifier-process nil)))
 761
 762 (defun context-coloring-scopify-shell-command (command callback)
 763   "Invoke a scopifier via COMMAND, read its response
 764 asynchronously and invoke CALLBACK with its output."
 765
 766   ;; Prior running tokenization is implicitly obsolete if this function is
 767   ;; called.
 768   (context-coloring-kill-scopifier)
 769
 770   ;; Start the process.
 771   (setq context-coloring-scopifier-process
 772         (start-process-shell-command "scopifier" nil command))
 773
 774   (let ((output ""))
 775
 776     ;; The process may produce output in multiple chunks.  This filter
 777     ;; accumulates the chunks into a message.
 778     (set-process-filter
 779      context-coloring-scopifier-process
 780      (lambda (_process chunk)
 781        (setq output (concat output chunk))))
 782
 783     ;; When the process's message is complete, this sentinel parses it as JSON
 784     ;; and applies the tokens to the buffer.
 785     (set-process-sentinel
 786      context-coloring-scopifier-process
 787      (lambda (_process event)
 788        (when (equal "finished\n" event)
 789          (funcall callback output))))))
 790
 791 (defun context-coloring-send-buffer-to-scopifier ()
 792   "Give the scopifier process its input so it can begin
 793 scopifying."
 794   (process-send-region
 795    context-coloring-scopifier-process
 796    (point-min) (point-max))
 797   (process-send-eof
 798    context-coloring-scopifier-process))
 799
 800 (defun context-coloring-scopify-and-colorize (command &optional callback)
 801   "Invoke a scopifier via COMMAND with the current buffer's contents,
 802 read the scopifier's response asynchronously and apply a parsed
 803 list of tokens to `context-coloring-apply-tokens'.
 804
 805 Invoke CALLBACK when complete."
 806   (let ((buffer (current-buffer)))
 807     (context-coloring-scopify-shell-command
 808      command
 809      (lambda (output)
 810        (let ((tokens (context-coloring-parse-array output)))
 811          (with-current-buffer buffer
 812            (context-coloring-apply-tokens tokens))
 813          (setq context-coloring-scopifier-process nil)
 814          (when callback (funcall callback))))))
 815   (context-coloring-send-buffer-to-scopifier))
 816
 817
 818 ;;; Dispatch
 819
 820 (defvar context-coloring-dispatch-hash-table (make-hash-table :test 'eq)
 821   "Map dispatch strategy names to their corresponding property
 822   lists, which contain details about the strategies.")
 823
 824 (defvar context-coloring-mode-hash-table (make-hash-table :test 'eq)
 825   "Map major mode names to dispatch property lists.")
 826
 827 (defun context-coloring-get-dispatch-for-mode (mode)
 828   "Return the dispatch for MODE (or a derivative mode)."
 829   (let ((parent mode)
 830         dispatch)
 831     (while (and parent
 832                 (not (setq dispatch (gethash parent context-coloring-mode-hash-table)))
 833                 (setq parent (get parent 'derived-mode-parent))))
 834     dispatch))
 835
 836 (defun context-coloring-define-dispatch (symbol &rest properties)
 837   "Define a new dispatch named SYMBOL with PROPERTIES.
 838
 839 A \"dispatch\" is a property list describing a strategy for
 840 coloring a buffer.  There are three possible strategies: Parse
 841 and color in a single function (`:colorizer'), parse in a
 842 function that returns scope data (`:scopifier'), or parse with a
 843 shell command that returns scope data (`:command').  In the
 844 latter two cases, the scope data will be used to automatically
 845 color the buffer.
 846
 847 PROPERTIES must include `:modes' and one of `:colorizer',
 848 `:scopifier' or `:command'.
 849
 850 `:modes' - List of major modes this dispatch is valid for.
 851
 852 `:colorizer' - Symbol referring to a function that parses and
 853 colors the buffer.
 854
 855 `:scopifier' - Symbol referring to a function that parses the
 856 buffer a returns a flat vector of start, end and level data.
 857
 858 `:executable' - Optional name of an executable required by
 859 `:command'.
 860
 861 `:command' - Shell command to execute with the current buffer
 862 sent via stdin, and with a flat JSON array of start, end and
 863 level data returned via stdout.
 864
 865 `:version' - Minimum required version that should be printed when
 866 executing `:command' with a \"--version\" flag.  The version
 867 should be numeric, e.g. \"2\", \"19700101\", \"1.2.3\",
 868 \"v1.2.3\" etc.
 869
 870 `:setup' - Arbitrary code to set up this dispatch when
 871 `context-coloring-mode' is enabled.
 872
 873 `:teardown' - Arbitrary code to tear down this dispatch when
 874 `context-coloring-mode' is disabled."
 875   (let ((modes (plist-get properties :modes))
 876         (colorizer (plist-get properties :colorizer))
 877         (scopifier (plist-get properties :scopifier))
 878         (command (plist-get properties :command)))
 879     (when (null modes)
 880       (error "No mode defined for dispatch"))
 881     (when (not (or colorizer
 882                    scopifier
 883                    command))
 884       (error "No colorizer, scopifier or command defined for dispatch"))
 885     (puthash symbol properties context-coloring-dispatch-hash-table)
 886     (dolist (mode modes)
 887       (puthash mode properties context-coloring-mode-hash-table))))
 888
 889
 890 ;;; Colorization
 891
 892 (defvar context-coloring-colorize-hook nil
 893   "Hooks to run after coloring a buffer.")
 894
 895 (defun context-coloring-colorize (&optional callback)
 896   "Color the current buffer by function context.
 897
 898 Invoke CALLBACK when complete; see `context-coloring-dispatch'."
 899   (interactive)
 900   (context-coloring-dispatch
 901    (lambda ()
 902      (when callback (funcall callback))
 903      (run-hooks 'context-coloring-colorize-hook))))
 904
 905 (defvar-local context-coloring-changed nil
 906   "Indication that the buffer has changed recently, which implies
 907 that it should be colored again by
 908 `context-coloring-colorize-idle-timer' if that timer is being
 909 used.")
 910
 911 (defun context-coloring-change-function (_start _end _length)
 912   "Register a change so that a buffer can be colorized soon."
 913   ;; Tokenization is obsolete if there was a change.
 914   (context-coloring-kill-scopifier)
 915   (setq context-coloring-changed t))
 916
 917 (defun context-coloring-maybe-colorize (buffer)
 918   "Colorize the current buffer if it has changed."
 919   (when (and (eq buffer (current-buffer))
 920              context-coloring-changed)
 921     (setq context-coloring-changed nil)
 922     (context-coloring-colorize)))
 923
 924
 925 ;;; Versioning
 926
 927 (defun context-coloring-parse-version (string)
 928   "Extract segments of a version STRING into a list.  \"v1.0.0\"
 929 produces (1 0 0), \"19700101\" produces (19700101), etc."
 930   (let (version)
 931     (while (string-match "[0-9]+" string)
 932       (setq version (append version
 933                             (list (string-to-number (match-string 0 string)))))
 934       (setq string (substring string (match-end 0))))
 935     version))
 936
 937 (defun context-coloring-check-version (expected actual)
 938   "Check that version EXPECTED is less than or equal to ACTUAL."
 939   (let ((expected (context-coloring-parse-version expected))
 940         (actual (context-coloring-parse-version actual))
 941         (continue t)
 942         (acceptable t))
 943     (while (and continue expected)
 944       (let ((an-expected (car expected))
 945             (an-actual (car actual)))
 946         (cond
 947          ((> an-actual an-expected)
 948           (setq acceptable t)
 949           (setq continue nil))
 950          ((< an-actual an-expected)
 951           (setq acceptable nil)
 952           (setq continue nil))))
 953       (setq expected (cdr expected))
 954       (setq actual (cdr actual)))
 955     acceptable))
 956
 957 (defvar context-coloring-check-scopifier-version-hook nil
 958   "Hooks to run after checking the scopifier version.")
 959
 960 (defun context-coloring-check-scopifier-version (&optional callback)
 961   "Asynchronously invoke CALLBACK with a predicate indicating
 962 whether the current scopifier version satisfies the minimum
 963 version number required for the current major mode."
 964   (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
 965     (when dispatch
 966       (let ((version (plist-get dispatch :version))
 967             (command (plist-get dispatch :command)))
 968         (context-coloring-scopify-shell-command
 969          (context-coloring-join (list command "--version") " ")
 970          (lambda (output)
 971            (if (context-coloring-check-version version output)
 972                (progn
 973                  (when callback (funcall callback t)))
 974              (when callback (funcall callback nil)))
 975            (run-hooks 'context-coloring-check-scopifier-version-hook)))))))
 976
 977
 978 ;;; Themes
 979
 980 (defvar context-coloring-theme-hash-table (make-hash-table :test 'eq)
 981   "Map theme names to theme properties.")
 982
 983 (defun context-coloring-theme-p (theme)
 984   "Return t if THEME is defined, nil otherwise."
 985   (and (gethash theme context-coloring-theme-hash-table)))
 986
 987 (defconst context-coloring-level-face-regexp
 988   "context-coloring-level-\\([[:digit:]]+\\)-face"
 989   "Extract a level from a face.")
 990
 991 (defvar context-coloring-originally-set-theme-hash-table
 992   (make-hash-table :test 'eq)
 993   "Cache custom themes who originally set their own
 994   `context-coloring-level-N-face' faces.")
 995
 996 (defun context-coloring-theme-originally-set-p (theme)
 997   "Return t if there is a `context-coloring-level-N-face'
 998 originally set for THEME, nil otherwise."
 999   (let (originally-set)
1000     (cond
1001      ;; `setq' might return a non-nil value for the sake of this `cond'.
1002      ((setq
1003        originally-set
1004        (gethash
1005         theme
1006         context-coloring-originally-set-theme-hash-table))
1007       (eq originally-set 'yes))
1008      (t
1009       (let* ((settings (get theme 'theme-settings))
1010              (tail settings)
1011              found)
1012         (while (and tail (not found))
1013           (and (eq (nth 0 (car tail)) 'theme-face)
1014                (string-match
1015                 context-coloring-level-face-regexp
1016                 (symbol-name (nth 1 (car tail))))
1017                (setq found t))
1018           (setq tail (cdr tail)))
1019         found)))))
1020
1021 (defun context-coloring-cache-originally-set (theme originally-set)
1022   "Remember if THEME had colors originally set for it.  If
1023 ORIGINALLY-SET is non-nil, it did, otherwise it didn't."
1024   ;; Caching whether a theme was originally set is kind of dirty, but we have to
1025   ;; do it to remember the past state of the theme.  There are probably some
1026   ;; edge cases where caching will be an issue, but they are probably rare.
1027   (puthash
1028    theme
1029    (if originally-set 'yes 'no)
1030    context-coloring-originally-set-theme-hash-table))
1031
1032 (defun context-coloring-warn-theme-originally-set (theme)
1033   "Warn the user that the colors for THEME are already originally
1034 set."
1035   (warn "Context coloring colors for theme `%s' are already defined" theme))
1036
1037 (defun context-coloring-theme-highest-level (theme)
1038   "Return the highest level N of a face like
1039 `context-coloring-level-N-face' set for THEME, or `-1' if there
1040 is none."
1041   (let* ((settings (get theme 'theme-settings))
1042          (tail settings)
1043          face-string
1044          number
1045          (found -1))
1046     (while tail
1047       (and (eq (nth 0 (car tail)) 'theme-face)
1048            (setq face-string (symbol-name (nth 1 (car tail))))
1049            (string-match
1050             context-coloring-level-face-regexp
1051             face-string)
1052            (setq number (string-to-number
1053                          (substring face-string
1054                                     (match-beginning 1)
1055                                     (match-end 1))))
1056            (> number found)
1057            (setq found number))
1058       (setq tail (cdr tail)))
1059     found))
1060
1061 (defun context-coloring-apply-theme (theme)
1062   "Apply THEME's properties to its respective custom theme,
1063 which must already exist and which *should* already be enabled."
1064   (let* ((properties (gethash theme context-coloring-theme-hash-table))
1065          (colors (plist-get properties :colors))
1066          (level -1))
1067     ;; Only clobber when we have to.
1068     (when (custom-theme-enabled-p theme)
1069       (setq context-coloring-maximum-face (- (length colors) 1)))
1070     (apply
1071      'custom-theme-set-faces
1072      theme
1073      (mapcar
1074       (lambda (color)
1075         (setq level (+ level 1))
1076         `(,(context-coloring-level-face level) ((t (:foreground ,color)))))
1077       colors))))
1078
1079 (defun context-coloring-define-theme (theme &rest properties)
1080   "Define a context theme named THEME for coloring scope levels.
1081
1082 PROPERTIES is a property list specifiying the following details:
1083
1084 `:aliases': List of symbols of other custom themes that these
1085 colors are applicable to.
1086
1087 `:colors': List of colors that this context theme uses.
1088
1089 `:override': If non-nil, this context theme is intentionally
1090 overriding colors set by a custom theme.  Don't set this non-nil
1091 unless there is a custom theme you want to use which sets
1092 `context-coloring-level-N-face' faces that you want to replace.
1093
1094 `:recede': If non-nil, this context theme should not apply its
1095 colors if a custom theme already sets
1096 `context-coloring-level-N-face' faces.  This option is
1097 optimistic; set this non-nil if you would rather confer the duty
1098 of picking colors to a custom theme author (if / when he ever
1099 gets around to it).
1100
1101 By default, context themes will always override custom themes,
1102 even if those custom themes set `context-coloring-level-N-face'
1103 faces.  If a context theme does override a custom theme, a
1104 warning will be raised, at which point you may want to enable the
1105 `:override' option, or just delete your context theme and opt to
1106 use your custom theme's author's colors instead.
1107
1108 Context themes only work for the custom theme with the highest
1109 precedence, i.e. the car of `custom-enabled-themes'."
1110   (let ((aliases (plist-get properties :aliases))
1111         (override (plist-get properties :override))
1112         (recede (plist-get properties :recede)))
1113     (dolist (name (append `(,theme) aliases))
1114       (puthash name properties context-coloring-theme-hash-table)
1115       (when (custom-theme-p name)
1116         (let ((originally-set (context-coloring-theme-originally-set-p name)))
1117           (context-coloring-cache-originally-set name originally-set)
1118           ;; In the particular case when you innocently define colors that a
1119           ;; custom theme originally set, warn.  Arguably this only has to be
1120           ;; done at enable time, but it is probably more useful to do it at
1121           ;; definition time for prompter feedback.
1122           (when (and originally-set
1123                      (not recede)
1124                      (not override))
1125             (context-coloring-warn-theme-originally-set name))
1126           ;; Set (or overwrite) colors.
1127           (when (not (and originally-set
1128                           recede))
1129             (context-coloring-apply-theme name)))))))
1130
1131 (defun context-coloring-enable-theme (theme)
1132   "Apply THEME if its colors are not already set, else just set
1133 `context-coloring-maximum-face' to the correct value for THEME."
1134   (let* ((properties (gethash theme context-coloring-theme-hash-table))
1135          (recede (plist-get properties :recede))
1136          (override (plist-get properties :override)))
1137     (cond
1138      (recede
1139       (let ((highest-level (context-coloring-theme-highest-level theme)))
1140         (cond
1141          ;; This can be true whether originally set by a custom theme or by a
1142          ;; context theme.
1143          ((> highest-level -1)
1144           (setq context-coloring-maximum-face highest-level))
1145          ;; It is possible that the corresponding custom theme did not exist at
1146          ;; the time of defining this context theme, and in that case the above
1147          ;; condition proves the custom theme did not originally set any faces,
1148          ;; so we have license to apply the context theme for the first time
1149          ;; here.
1150          (t
1151           (context-coloring-apply-theme theme)))))
1152      (t
1153       (let ((originally-set (context-coloring-theme-originally-set-p theme)))
1154         ;; Cache now in case the context theme was defined after the custom
1155         ;; theme.
1156         (context-coloring-cache-originally-set theme originally-set)
1157         (when (and originally-set
1158                    (not override))
1159           (context-coloring-warn-theme-originally-set theme))
1160         (context-coloring-apply-theme theme))))))
1161
1162 (defadvice enable-theme (after context-coloring-enable-theme (theme) activate)
1163   "Enable colors for context themes just-in-time."
1164   (when (and (not (eq theme 'user)) ; Called internally by `enable-theme'.
1165              (custom-theme-p theme) ; Guard against non-existent themes.
1166              (context-coloring-theme-p theme))
1167     (when (= (length custom-enabled-themes) 1)
1168       ;; Cache because we can't reliably figure it out in reverse.
1169       (setq context-coloring-original-maximum-face
1170             context-coloring-maximum-face))
1171     (context-coloring-enable-theme theme)))
1172
1173 (defadvice disable-theme (after context-coloring-disable-theme (theme) activate)
1174   "Update `context-coloring-maximum-face'."
1175   (when (custom-theme-p theme) ; Guard against non-existent themes.
1176     (let ((enabled-theme (car custom-enabled-themes)))
1177       (if (context-coloring-theme-p enabled-theme)
1178           (progn
1179             (context-coloring-enable-theme enabled-theme))
1180         ;; Assume we are back to no theme; act as if nothing ever happened.
1181         ;; This is still prone to intervention, but rather extraordinarily.
1182         (setq context-coloring-maximum-face
1183               context-coloring-original-maximum-face)))))
1184
1185 (context-coloring-define-theme
1186  'ample
1187  :recede t
1188  :colors '("#bdbdb3"
1189            "#baba36"
1190            "#6aaf50"
1191            "#5180b3"
1192            "#ab75c3"
1193            "#cd7542"
1194            "#df9522"
1195            "#454545"))
1196
1197 (context-coloring-define-theme
1198  'anti-zenburn
1199  :recede t
1200  :colors '("#232333"
1201            "#6c1f1c"
1202            "#401440"
1203            "#0f2050"
1204            "#205070"
1205            "#336c6c"
1206            "#23733c"
1207            "#6b400c"
1208            "#603a60"
1209            "#2f4070"
1210            "#235c5c"))
1211
1212 (context-coloring-define-theme
1213  'grandshell
1214  :recede t
1215  :colors '("#bebebe"
1216            "#5af2ee"
1217            "#b2baf6"
1218            "#f09fff"
1219            "#efc334"
1220            "#f6df92"
1221            "#acfb5a"
1222            "#888888"))
1223
1224 (context-coloring-define-theme
1225  'leuven
1226  :recede t
1227  :colors '("#333333"
1228            "#0000ff"
1229            "#6434a3"
1230            "#ba36a5"
1231            "#d0372d"
1232            "#036a07"
1233            "#006699"
1234            "#006fe0"
1235            "#808080"))
1236
1237 (context-coloring-define-theme
1238  'monokai
1239  :recede t
1240  :colors '("#f8f8f2"
1241            "#66d9ef"
1242            "#a1efe4"
1243            "#a6e22e"
1244            "#e6db74"
1245            "#fd971f"
1246            "#f92672"
1247            "#fd5ff0"
1248            "#ae81ff"))
1249
1250 (context-coloring-define-theme
1251  'solarized
1252  :recede t
1253  :aliases '(solarized-light
1254             solarized-dark
1255             sanityinc-solarized-light
1256             sanityinc-solarized-dark)
1257  :colors '("#839496"
1258            "#268bd2"
1259            "#2aa198"
1260            "#859900"
1261            "#b58900"
1262            "#cb4b16"
1263            "#dc322f"
1264            "#d33682"
1265            "#6c71c4"
1266            "#69b7f0"
1267            "#69cabf"
1268            "#b4c342"
1269            "#deb542"
1270            "#f2804f"
1271            "#ff6e64"
1272            "#f771ac"
1273            "#9ea0e5"))
1274
1275 (context-coloring-define-theme
1276  'spacegray
1277  :recede t
1278  :colors '("#ffffff"
1279            "#89aaeb"
1280            "#c189eb"
1281            "#bf616a"
1282            "#dca432"
1283            "#ebcb8b"
1284            "#b4eb89"
1285            "#89ebca"))
1286
1287 (context-coloring-define-theme
1288  'tango
1289  :recede t
1290  :colors '("#2e3436"
1291            "#346604"
1292            "#204a87"
1293            "#5c3566"
1294            "#a40000"
1295            "#b35000"
1296            "#c4a000"
1297            "#8ae234"
1298            "#8cc4ff"
1299            "#ad7fa8"
1300            "#ef2929"
1301            "#fcaf3e"
1302            "#fce94f"))
1303
1304 (context-coloring-define-theme
1305  'zenburn
1306  :recede t
1307  :colors '("#dcdccc"
1308            "#93e0e3"
1309            "#bfebbf"
1310            "#f0dfaf"
1311            "#dfaf8f"
1312            "#cc9393"
1313            "#dc8cc3"
1314            "#94bff3"
1315            "#9fc59f"
1316            "#d0bf8f"
1317            "#dca3a3"))
1318
1319
1320 ;;; Change detection
1321
1322 (defvar-local context-coloring-colorize-idle-timer nil
1323   "The currently-running idle timer.")
1324
1325 (defcustom context-coloring-delay 0.25
1326   "Delay between a buffer update and colorization.
1327
1328 Increase this if your machine is high-performing.  Decrease it if
1329 it ain't.
1330
1331 Supported modes: `js-mode', `js3-mode', `emacs-lisp-mode'"
1332   :group 'context-coloring)
1333
1334 (defun context-coloring-setup-idle-change-detection ()
1335   "Setup idle change detection."
1336   (add-hook
1337    'after-change-functions 'context-coloring-change-function nil t)
1338   (add-hook
1339    'kill-buffer-hook 'context-coloring-teardown-idle-change-detection nil t)
1340   (setq context-coloring-colorize-idle-timer
1341         (run-with-idle-timer
1342          context-coloring-delay
1343          t
1344          'context-coloring-maybe-colorize
1345          (current-buffer))))
1346
1347 (defun context-coloring-teardown-idle-change-detection ()
1348   "Teardown idle change detection."
1349   (context-coloring-kill-scopifier)
1350   (when context-coloring-colorize-idle-timer
1351     (cancel-timer context-coloring-colorize-idle-timer))
1352   (remove-hook
1353    'kill-buffer-hook 'context-coloring-teardown-idle-change-detection t)
1354   (remove-hook
1355    'after-change-functions 'context-coloring-change-function t))
1356
1357
1358 ;;; Built-in dispatches
1359
1360 (context-coloring-define-dispatch
1361  'javascript-node
1362  :modes '(js-mode js3-mode)
1363  :executable "scopifier"
1364  :command "scopifier"
1365  :version "v1.1.1")
1366
1367 (context-coloring-define-dispatch
1368  'javascript-js2
1369  :modes '(js2-mode)
1370  :colorizer 'context-coloring-js2-colorize
1371  :setup
1372  (lambda ()
1373    (add-hook 'js2-post-parse-callbacks 'context-coloring-colorize nil t))
1374  :teardown
1375  (lambda ()
1376    (remove-hook 'js2-post-parse-callbacks 'context-coloring-colorize t)))
1377
1378 (context-coloring-define-dispatch
1379  'emacs-lisp
1380  :modes '(emacs-lisp-mode)
1381  :colorizer 'context-coloring-elisp-colorize-buffer
1382  :setup 'context-coloring-setup-idle-change-detection
1383  :teardown 'context-coloring-teardown-idle-change-detection)
1384
1385 (defun context-coloring-dispatch (&optional callback)
1386   "Determine the optimal track for scopification / coloring of
1387 the current buffer, then execute it.
1388
1389 Invoke CALLBACK when complete.  It is invoked synchronously for
1390 elisp tracks, and asynchronously for shell command tracks."
1391   (let* ((dispatch (context-coloring-get-dispatch-for-mode major-mode))
1392          (colorizer (plist-get dispatch :colorizer))
1393          (scopifier (plist-get dispatch :scopifier))
1394          (command (plist-get dispatch :command))
1395          interrupted-p)
1396     (cond
1397      ((or colorizer scopifier)
1398       (setq interrupted-p
1399             (catch 'interrupted
1400               (cond
1401                (colorizer
1402                 (funcall colorizer))
1403                (scopifier
1404                 (context-coloring-apply-tokens (funcall scopifier))))))
1405       (cond
1406        (interrupted-p
1407         (setq context-coloring-changed t))
1408        (t
1409         (when callback (funcall callback)))))
1410      (command
1411       (context-coloring-scopify-and-colorize command callback)))))
1412
1413
1414 ;;; Minor mode
1415
1416 ;;;###autoload
1417 (define-minor-mode context-coloring-mode
1418   "Context-based code coloring, inspired by Douglas Crockford."
1419   nil " Context" nil
1420   (if (not context-coloring-mode)
1421       (progn
1422         (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
1423           (when dispatch
1424             (let ((command (plist-get dispatch :command))
1425                   (teardown (plist-get dispatch :teardown)))
1426               (when command
1427                 (context-coloring-teardown-idle-change-detection))
1428               (when teardown
1429                 (funcall teardown)))))
1430         (font-lock-mode)
1431         (jit-lock-mode t))
1432
1433     ;; Font lock is incompatible with this mode; the converse is also true.
1434     (font-lock-mode 0)
1435     (jit-lock-mode nil)
1436
1437     ;; ...but we do use font-lock functions here.
1438     (font-lock-set-defaults)
1439
1440     ;; Safely change the valye of this function as necessary.
1441     (make-local-variable 'font-lock-syntactic-face-function)
1442
1443     (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
1444       (if dispatch
1445           (progn
1446             (let ((command (plist-get dispatch :command))
1447                   (version (plist-get dispatch :version))
1448                   (executable (plist-get dispatch :executable))
1449                   (setup (plist-get dispatch :setup))
1450                   (colorize-initially-p t))
1451               (when command
1452                 ;; Shell commands recolor on change, idly.
1453                 (cond
1454                  ((and executable
1455                        (null (executable-find executable)))
1456                   (message "Executable \"%s\" not found" executable)
1457                   (setq colorize-initially-p nil))
1458                  (version
1459                   (context-coloring-check-scopifier-version
1460                    (lambda (sufficient-p)
1461                      (if sufficient-p
1462                          (progn
1463                            (context-coloring-setup-idle-change-detection)
1464                            (context-coloring-colorize))
1465                        (message "Update to the minimum version of \"%s\" (%s)"
1466                                 executable version))))
1467                   (setq colorize-initially-p nil))
1468                  (t
1469                   (context-coloring-setup-idle-change-detection))))
1470               (when setup
1471                 (funcall setup))
1472               ;; Colorize once initially.
1473               (when colorize-initially-p
1474                 (let ((context-coloring-parse-interruptable-p nil))
1475                   (context-coloring-colorize)))))
1476         (when (null dispatch)
1477           (message "Context coloring is not available for this major mode"))))))
1478
1479 (provide 'context-coloring)
1480
1481 ;;; context-coloring.el ends here