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-OCTOTHORPE-CHAR (string-to-char "#"))
 330 (defconst context-coloring-APOSTROPHE-CHAR (string-to-char "'"))
 331 (defconst context-coloring-OPEN-PARENTHESIS-CHAR (string-to-char "("))
 332 (defconst context-coloring-COMMA-CHAR (string-to-char ","))
 333 (defconst context-coloring-AT-CHAR (string-to-char "@"))
 334 (defconst context-coloring-BACKTICK-CHAR (string-to-char "`"))
 335
 336 (defvar context-coloring-elisp-scope-stack '())
 337
 338 (defsubst context-coloring-elisp-make-scope (level)
 339   (list
 340    :level level
 341    :variables '()))
 342
 343 (defsubst context-coloring-elisp-scope-get-level (scope)
 344   (plist-get scope :level))
 345
 346 (defsubst context-coloring-elisp-scope-add-variable (scope variable)
 347   (plist-put scope :variables (cons variable (plist-get scope :variables))))
 348
 349 (defsubst context-coloring-elisp-scope-has-variable (scope variable)
 350   (member variable (plist-get scope :variables)))
 351
 352 (defsubst context-coloring-elisp-get-variable-level (variable)
 353   (let* ((scope-stack context-coloring-elisp-scope-stack)
 354          scope
 355          level)
 356     (while (and scope-stack (not level))
 357       (setq scope (car scope-stack))
 358       (cond
 359        ((context-coloring-elisp-scope-has-variable scope variable)
 360         (setq level (context-coloring-elisp-scope-get-level scope)))
 361        (t
 362         (setq scope-stack (cdr scope-stack)))))
 363     ;; Assume a global variable.
 364     (or level 0)))
 365
 366 (defsubst context-coloring-elisp-current-scope-level ()
 367   (cond
 368    ((car context-coloring-elisp-scope-stack)
 369     (context-coloring-elisp-scope-get-level (car context-coloring-elisp-scope-stack)))
 370    (t
 371     0)))
 372
 373 (defsubst context-coloring-elisp-push-scope ()
 374   (push (context-coloring-elisp-make-scope
 375          (1+ (context-coloring-elisp-current-scope-level)))
 376         context-coloring-elisp-scope-stack))
 377
 378 (defsubst context-coloring-elisp-pop-scope ()
 379   (pop context-coloring-elisp-scope-stack))
 380
 381 (defsubst context-coloring-elisp-add-variable (variable)
 382   (context-coloring-elisp-scope-add-variable
 383    (car context-coloring-elisp-scope-stack)
 384    variable))
 385
 386 (defun context-coloring-elisp-parse-arg (callback)
 387   (let (arg-pos
 388         arg-end
 389         arg-string)
 390     (setq arg-pos (point))
 391     (forward-sexp)
 392     (setq arg-end (point))
 393     (setq arg-string (buffer-substring-no-properties
 394                       arg-pos
 395                       arg-end))
 396     (when (string-match-p
 397            context-coloring-elisp-arglist-arg-regexp
 398            arg-string)
 399       (funcall callback arg-string))))
 400
 401 (defun context-coloring-elisp-parse-let-varlist (type)
 402   (let ((varlist '())
 403         syntax-code)
 404     ;; Enter.
 405     (forward-char)
 406     (while (/= (setq syntax-code (context-coloring-get-syntax-code))
 407                context-coloring-CLOSE-PARENTHESIS-CODE)
 408       (cond
 409        ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE)
 410         (forward-char)
 411         (context-coloring-forward-sws)
 412         (setq syntax-code (context-coloring-get-syntax-code))
 413         (when (or (= syntax-code context-coloring-WORD-CODE)
 414                   (= syntax-code context-coloring-SYMBOL-CODE))
 415           (context-coloring-elisp-parse-arg
 416            (lambda (var)
 417              (push var varlist)))
 418           (context-coloring-forward-sws)
 419           (setq syntax-code (context-coloring-get-syntax-code))
 420           (when (/= syntax-code context-coloring-CLOSE-PARENTHESIS-CODE)
 421             (context-coloring-elisp-colorize-sexp)))
 422         (context-coloring-forward-sws)
 423         ;; Skip past the closing parenthesis.
 424         (forward-char))
 425        ((or (= syntax-code context-coloring-WORD-CODE)
 426             (= syntax-code context-coloring-SYMBOL-CODE))
 427         (context-coloring-elisp-parse-arg
 428          (lambda (var)
 429            (push var varlist)))))
 430       (when (eq type 'let*)
 431         (context-coloring-elisp-add-variable (pop varlist)))
 432       (context-coloring-forward-sws))
 433     (when (eq type 'let)
 434       (while varlist
 435         (context-coloring-elisp-add-variable (pop varlist))))
 436     ;; Exit.
 437     (forward-char)))
 438
 439 (defun context-coloring-elisp-parse-arglist ()
 440   (let (syntax-code)
 441     ;; Enter.
 442     (forward-char)
 443     (while (/= (setq syntax-code (context-coloring-get-syntax-code))
 444                context-coloring-CLOSE-PARENTHESIS-CODE)
 445       (cond
 446        ((or (= syntax-code context-coloring-WORD-CODE)
 447             (= syntax-code context-coloring-SYMBOL-CODE))
 448         (context-coloring-elisp-parse-arg
 449          (lambda (arg)
 450            (context-coloring-elisp-add-variable arg))))
 451        (t
 452         (forward-sexp)))
 453       (context-coloring-forward-sws))
 454     ;; Exit.
 455     (forward-char)))
 456
 457 (defun context-coloring-elisp-colorize-defun (&optional anonymous-p
 458                                                         let-type)
 459   (let ((start (point))
 460         end
 461         stop
 462         syntax-code
 463         defun-name-pos
 464         defun-name-end)
 465     (context-coloring-elisp-push-scope)
 466     ;; Color the whole sexp.
 467     (forward-sexp)
 468     (setq end (point))
 469     (context-coloring-colorize-region
 470      start
 471      end
 472      (context-coloring-elisp-current-scope-level))
 473     (goto-char start)
 474     ;; Skip past the "defun".
 475     (skip-syntax-forward "^w_")
 476     (forward-sexp)
 477     (context-coloring-forward-sws)
 478     (setq stop nil)
 479     (unless anonymous-p
 480       ;; Check for the defun's name.
 481       (setq syntax-code (context-coloring-get-syntax-code))
 482       (cond
 483        ((or (= syntax-code context-coloring-WORD-CODE)
 484             (= syntax-code context-coloring-SYMBOL-CODE))
 485         ;; Color the defun's name with the top-level color.
 486         (setq defun-name-pos (point))
 487         (forward-sexp)
 488         (setq defun-name-end (point))
 489         (context-coloring-colorize-region defun-name-pos defun-name-end 0)
 490         (context-coloring-forward-sws))
 491        (t
 492         (setq stop t))))
 493     (cond
 494      (stop
 495       ;; Skip it.
 496       (goto-char start)
 497       (forward-sexp))
 498      (t
 499       (setq syntax-code (context-coloring-get-syntax-code))
 500       (cond
 501        ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE)
 502         (cond
 503          (let-type
 504           (context-coloring-elisp-parse-let-varlist let-type))
 505          (t
 506           (context-coloring-elisp-parse-arglist)))
 507         ;; Colorize the rest of the function.
 508         (context-coloring-elisp-colorize-region (point) (1- end))
 509         ;; Exit the defun.
 510         (forward-char))
 511        (t
 512         ;; Skip it.
 513         (goto-char start)
 514         (forward-sexp)))))
 515     (context-coloring-elisp-pop-scope)))
 516
 517 (defun context-coloring-elisp-colorize-lambda ()
 518   (context-coloring-elisp-colorize-defun t))
 519
 520 (defun context-coloring-elisp-colorize-let ()
 521   (context-coloring-elisp-colorize-defun t 'let))
 522
 523 (defun context-coloring-elisp-colorize-let* ()
 524   (context-coloring-elisp-colorize-defun t 'let*))
 525
 526 (defun context-coloring-elisp-colorize-parenthesized-sexp ()
 527   (let ((start (point))
 528         end
 529         syntax-code
 530         child-0-pos
 531         child-0-end
 532         child-0-string)
 533     (forward-sexp)
 534     (setq end (point))
 535     (goto-char start)
 536     (forward-char)
 537     (context-coloring-forward-sws)
 538     (setq syntax-code (context-coloring-get-syntax-code))
 539     ;; Figure out if the sexp is a special form.
 540     (cond
 541      ((when (or (= syntax-code context-coloring-WORD-CODE)
 542                 (= syntax-code context-coloring-SYMBOL-CODE))
 543         (setq child-0-pos (point))
 544         (forward-sexp)
 545         (setq child-0-end (point))
 546         (setq child-0-string (buffer-substring-no-properties
 547                               child-0-pos
 548                               child-0-end))
 549         (cond
 550          ((string-match-p context-coloring-elisp-defun-regexp child-0-string)
 551           (goto-char start)
 552           (context-coloring-elisp-colorize-defun)
 553           t)
 554          ((string-match-p context-coloring-elisp-lambda-regexp child-0-string)
 555           (goto-char start)
 556           (context-coloring-elisp-colorize-lambda)
 557           t)
 558          ((string-match-p context-coloring-elisp-let-regexp child-0-string)
 559           (goto-char start)
 560           (context-coloring-elisp-colorize-let)
 561           t)
 562          ((string-match-p context-coloring-elisp-let*-regexp child-0-string)
 563           (goto-char start)
 564           (context-coloring-elisp-colorize-let*)
 565           t)
 566          (t
 567           nil))))
 568      ;; Not a special form; just colorize the remaining region.
 569      (t
 570       (context-coloring-colorize-region
 571        start
 572        end
 573        (context-coloring-elisp-current-scope-level))
 574       (context-coloring-elisp-colorize-region (point) (1- end))
 575       (forward-char)))))
 576
 577 (defun context-coloring-elisp-colorize-symbol ()
 578   (let (symbol-pos
 579         symbol-end
 580         symbol-string)
 581     (setq symbol-pos (point))
 582     (forward-sexp)
 583     (setq symbol-end (point))
 584     (setq symbol-string (buffer-substring-no-properties
 585                          symbol-pos
 586                          symbol-end))
 587     (cond
 588      ((string-match-p context-coloring-ignored-word-regexp symbol-string))
 589      (t
 590       (context-coloring-colorize-region
 591        symbol-pos
 592        symbol-end
 593        (context-coloring-elisp-get-variable-level
 594         symbol-string))))))
 595
 596 (defun context-coloring-elisp-colorize-expression-prefix ()
 597   (let ((char (char-after))
 598         (start (point))
 599         (end (progn (forward-sexp)
 600                     (point))))
 601     (cond
 602      ((or (= char context-coloring-APOSTROPHE-CHAR)
 603           (= char context-coloring-OCTOTHORPE-CHAR))
 604       (context-coloring-elisp-colorize-comments-and-strings-in-region start end))
 605      ((= char context-coloring-BACKTICK-CHAR)
 606       (goto-char start)
 607       (while (> end (progn (forward-char)
 608                            (point)))
 609         (setq char (char-after))
 610         (when (= char context-coloring-COMMA-CHAR)
 611           (forward-char)
 612           (when (= (char-after) context-coloring-AT-CHAR)
 613             ;; If we don't do this "@" could be interpreted as a symbol.
 614             (forward-char))
 615           (context-coloring-forward-sws)
 616           (context-coloring-elisp-colorize-sexp)))
 617       (context-coloring-elisp-colorize-comments-and-strings-in-region start end)))))
 618
 619 (defvar context-coloring-parse-interruptable-p t
 620   "Set this to nil to force parse to continue until finished.")
 621
 622 (defconst context-coloring-elisp-sexps-per-pause 1000
 623   "Pause after this many iterations to check for user input.
 624 If user input is pending, stop the parse.  This makes for a
 625 smoother user experience for large files.
 626
 627 As of this writing, emacs lisp colorization seems to run at about
 628 60,000 iterations per second.  A default value of 1000 should
 629 provide visually \"instant\" updates at 60 frames per second.")
 630
 631 (defvar context-coloring-elisp-sexp-count 0)
 632
 633 (defun context-coloring-elisp-increment-sexp-count ()
 634   (setq context-coloring-elisp-sexp-count
 635         (1+ context-coloring-elisp-sexp-count))
 636   (when (and (zerop (% context-coloring-elisp-sexp-count
 637                        context-coloring-elisp-sexps-per-pause))
 638              context-coloring-parse-interruptable-p
 639              (input-pending-p))
 640     (throw 'interrupted t)))
 641
 642 (defun context-coloring-elisp-colorize-sexp ()
 643   (let (syntax-code)
 644     (context-coloring-elisp-increment-sexp-count)
 645     (setq syntax-code (context-coloring-get-syntax-code))
 646     (cond
 647      ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE)
 648       (context-coloring-elisp-colorize-parenthesized-sexp))
 649      ((or (= syntax-code context-coloring-WORD-CODE)
 650           (= syntax-code context-coloring-SYMBOL-CODE))
 651       (context-coloring-elisp-colorize-symbol))
 652      ((= syntax-code context-coloring-EXPRESSION-PREFIX-CODE)
 653       (context-coloring-elisp-colorize-expression-prefix))
 654      (t
 655       (forward-char)))))
 656
 657 (defun context-coloring-elisp-colorize-comment ()
 658   (let ((start (point)))
 659     (context-coloring-elisp-increment-sexp-count)
 660     (context-coloring-forward-sws)
 661     (context-coloring-maybe-colorize-comments-and-strings
 662      start
 663      (point))))
 664
 665 (defun context-coloring-elisp-colorize-string ()
 666   (let ((start (point)))
 667     (context-coloring-elisp-increment-sexp-count)
 668     (forward-sexp)
 669     (context-coloring-maybe-colorize-comments-and-strings
 670      start
 671      (point))))
 672
 673 (defun context-coloring-elisp-colorize-comments-and-strings-in-region (start end)
 674   (let (syntax-code)
 675     (goto-char start)
 676     (while (> end (progn (skip-syntax-forward "^<\"\\" end)
 677                          (point)))
 678       (setq syntax-code (context-coloring-get-syntax-code))
 679       (cond
 680        ((= syntax-code context-coloring-COMMENT-START-CODE)
 681         (context-coloring-elisp-colorize-comment))
 682        ((= syntax-code context-coloring-STRING-QUOTE-CODE)
 683         (context-coloring-elisp-colorize-string))
 684        ((= syntax-code context-coloring-ESCAPE-CODE)
 685         (forward-char 2))
 686        (t
 687         (forward-char))))))
 688
 689 (defun context-coloring-elisp-colorize-region (start end)
 690   (let (syntax-code)
 691     (goto-char start)
 692     (while (> end (progn (skip-syntax-forward "^()w_'<\"\\" end)
 693                          (point)))
 694       (setq syntax-code (context-coloring-get-syntax-code))
 695       (cond
 696        ((or (= syntax-code context-coloring-OPEN-PARENTHESIS-CODE)
 697             (= syntax-code context-coloring-WORD-CODE)
 698             (= syntax-code context-coloring-SYMBOL-CODE)
 699             (= syntax-code context-coloring-EXPRESSION-PREFIX-CODE))
 700         (context-coloring-elisp-colorize-sexp))
 701        ((= syntax-code context-coloring-COMMENT-START-CODE)
 702         (context-coloring-elisp-colorize-comment))
 703        ((= syntax-code context-coloring-STRING-QUOTE-CODE)
 704         (context-coloring-elisp-colorize-string))
 705        ((= syntax-code context-coloring-ESCAPE-CODE)
 706         (forward-char 2))
 707        (t
 708         (forward-char))))))
 709
 710 (defun context-coloring-elisp-colorize (start end)
 711   (setq context-coloring-elisp-sexp-count 0)
 712   (setq context-coloring-elisp-scope-stack '())
 713   (context-coloring-elisp-colorize-region start end))
 714
 715 (defun context-coloring-elisp-colorize-changed-region (start end)
 716   (with-silent-modifications
 717     (save-excursion
 718       (let ((start (progn (goto-char start)
 719                           (beginning-of-defun)
 720                           (point)))
 721             (end (progn (goto-char end)
 722                         (end-of-defun)
 723                         (point))))
 724         (context-coloring-elisp-colorize start end)))))
 725
 726 (defun context-coloring-elisp-colorize-buffer ()
 727   (interactive)
 728   (with-silent-modifications
 729     (save-excursion
 730       (context-coloring-elisp-colorize (point-min) (point-max)))))
 731
 732 (defalias 'ccecb 'context-coloring-elisp-colorize-buffer)
 733
 734
 735 ;;; Shell command scopification / colorization
 736
 737 (defun context-coloring-apply-tokens (tokens)
 738   "Process a vector of TOKENS to apply context-based coloring to
 739 the current buffer.  Tokens are 3 integers: start, end, level.
 740 The vector is flat, with a new token occurring after every 3rd
 741 element."
 742   (with-silent-modifications
 743     (let ((i 0)
 744           (len (length tokens)))
 745       (while (< i len)
 746         (context-coloring-colorize-region
 747          (elt tokens i)
 748          (elt tokens (+ i 1))
 749          (elt tokens (+ i 2)))
 750         (setq i (+ i 3))))
 751     (context-coloring-maybe-colorize-comments-and-strings)))
 752
 753 (defun context-coloring-parse-array (array)
 754   "Parse ARRAY as a flat JSON array of numbers."
 755   (let ((braceless (substring (context-coloring-trim array) 1 -1)))
 756     (cond
 757      ((> (length braceless) 0)
 758       (vconcat
 759        (mapcar 'string-to-number (split-string braceless ","))))
 760      (t
 761       (vector)))))
 762
 763 (defvar-local context-coloring-scopifier-process nil
 764   "The single scopifier process that can be running.")
 765
 766 (defun context-coloring-kill-scopifier ()
 767   "Kill the currently-running scopifier process."
 768   (when (not (null context-coloring-scopifier-process))
 769     (delete-process context-coloring-scopifier-process)
 770     (setq context-coloring-scopifier-process nil)))
 771
 772 (defun context-coloring-scopify-shell-command (command callback)
 773   "Invoke a scopifier via COMMAND, read its response
 774 asynchronously and invoke CALLBACK with its output."
 775
 776   ;; Prior running tokenization is implicitly obsolete if this function is
 777   ;; called.
 778   (context-coloring-kill-scopifier)
 779
 780   ;; Start the process.
 781   (setq context-coloring-scopifier-process
 782         (start-process-shell-command "scopifier" nil command))
 783
 784   (let ((output ""))
 785
 786     ;; The process may produce output in multiple chunks.  This filter
 787     ;; accumulates the chunks into a message.
 788     (set-process-filter
 789      context-coloring-scopifier-process
 790      (lambda (_process chunk)
 791        (setq output (concat output chunk))))
 792
 793     ;; When the process's message is complete, this sentinel parses it as JSON
 794     ;; and applies the tokens to the buffer.
 795     (set-process-sentinel
 796      context-coloring-scopifier-process
 797      (lambda (_process event)
 798        (when (equal "finished\n" event)
 799          (funcall callback output))))))
 800
 801 (defun context-coloring-send-buffer-to-scopifier ()
 802   "Give the scopifier process its input so it can begin
 803 scopifying."
 804   (process-send-region
 805    context-coloring-scopifier-process
 806    (point-min) (point-max))
 807   (process-send-eof
 808    context-coloring-scopifier-process))
 809
 810 (defun context-coloring-scopify-and-colorize (command &optional callback)
 811   "Invoke a scopifier via COMMAND with the current buffer's contents,
 812 read the scopifier's response asynchronously and apply a parsed
 813 list of tokens to `context-coloring-apply-tokens'.
 814
 815 Invoke CALLBACK when complete."
 816   (let ((buffer (current-buffer)))
 817     (context-coloring-scopify-shell-command
 818      command
 819      (lambda (output)
 820        (let ((tokens (context-coloring-parse-array output)))
 821          (with-current-buffer buffer
 822            (context-coloring-apply-tokens tokens))
 823          (setq context-coloring-scopifier-process nil)
 824          (when callback (funcall callback))))))
 825   (context-coloring-send-buffer-to-scopifier))
 826
 827
 828 ;;; Dispatch
 829
 830 (defvar context-coloring-dispatch-hash-table (make-hash-table :test 'eq)
 831   "Map dispatch strategy names to their corresponding property
 832   lists, which contain details about the strategies.")
 833
 834 (defvar context-coloring-mode-hash-table (make-hash-table :test 'eq)
 835   "Map major mode names to dispatch property lists.")
 836
 837 (defun context-coloring-get-dispatch-for-mode (mode)
 838   "Return the dispatch for MODE (or a derivative mode)."
 839   (let ((parent mode)
 840         dispatch)
 841     (while (and parent
 842                 (not (setq dispatch (gethash parent context-coloring-mode-hash-table)))
 843                 (setq parent (get parent 'derived-mode-parent))))
 844     dispatch))
 845
 846 (defun context-coloring-define-dispatch (symbol &rest properties)
 847   "Define a new dispatch named SYMBOL with PROPERTIES.
 848
 849 A \"dispatch\" is a property list describing a strategy for
 850 coloring a buffer.  There are three possible strategies: Parse
 851 and color in a single function (`:colorizer'), parse in a
 852 function that returns scope data (`:scopifier'), or parse with a
 853 shell command that returns scope data (`:command').  In the
 854 latter two cases, the scope data will be used to automatically
 855 color the buffer.
 856
 857 PROPERTIES must include `:modes' and one of `:colorizer',
 858 `:scopifier' or `:command'.
 859
 860 `:modes' - List of major modes this dispatch is valid for.
 861
 862 `:colorizer' - Symbol referring to a function that parses and
 863 colors the buffer.
 864
 865 `:scopifier' - Symbol referring to a function that parses the
 866 buffer a returns a flat vector of start, end and level data.
 867
 868 `:executable' - Optional name of an executable required by
 869 `:command'.
 870
 871 `:command' - Shell command to execute with the current buffer
 872 sent via stdin, and with a flat JSON array of start, end and
 873 level data returned via stdout.
 874
 875 `:version' - Minimum required version that should be printed when
 876 executing `:command' with a \"--version\" flag.  The version
 877 should be numeric, e.g. \"2\", \"19700101\", \"1.2.3\",
 878 \"v1.2.3\" etc.
 879
 880 `:setup' - Arbitrary code to set up this dispatch when
 881 `context-coloring-mode' is enabled.
 882
 883 `:teardown' - Arbitrary code to tear down this dispatch when
 884 `context-coloring-mode' is disabled."
 885   (let ((modes (plist-get properties :modes))
 886         (colorizer (plist-get properties :colorizer))
 887         (scopifier (plist-get properties :scopifier))
 888         (command (plist-get properties :command)))
 889     (when (null modes)
 890       (error "No mode defined for dispatch"))
 891     (when (not (or colorizer
 892                    scopifier
 893                    command))
 894       (error "No colorizer, scopifier or command defined for dispatch"))
 895     (puthash symbol properties context-coloring-dispatch-hash-table)
 896     (dolist (mode modes)
 897       (puthash mode properties context-coloring-mode-hash-table))))
 898
 899
 900 ;;; Colorization
 901
 902 (defvar context-coloring-colorize-hook nil
 903   "Hooks to run after coloring a buffer.")
 904
 905 (defun context-coloring-colorize (&optional callback)
 906   "Color the current buffer by function context.
 907
 908 Invoke CALLBACK when complete; see `context-coloring-dispatch'."
 909   (interactive)
 910   (context-coloring-dispatch
 911    (lambda ()
 912      (when callback (funcall callback))
 913      (run-hooks 'context-coloring-colorize-hook))))
 914
 915 (defvar-local context-coloring-changed nil
 916   "Indication that the buffer has changed recently, which implies
 917 that it should be colored again by
 918 `context-coloring-colorize-idle-timer' if that timer is being
 919 used.")
 920
 921 (defun context-coloring-change-function (_start _end _length)
 922   "Register a change so that a buffer can be colorized soon."
 923   ;; Tokenization is obsolete if there was a change.
 924   (context-coloring-kill-scopifier)
 925   (setq context-coloring-changed t))
 926
 927 (defun context-coloring-maybe-colorize (buffer)
 928   "Colorize the current buffer if it has changed."
 929   (when (and (eq buffer (current-buffer))
 930              context-coloring-changed)
 931     (setq context-coloring-changed nil)
 932     (context-coloring-colorize)))
 933
 934
 935 ;;; Versioning
 936
 937 (defun context-coloring-parse-version (string)
 938   "Extract segments of a version STRING into a list.  \"v1.0.0\"
 939 produces (1 0 0), \"19700101\" produces (19700101), etc."
 940   (let (version)
 941     (while (string-match "[0-9]+" string)
 942       (setq version (append version
 943                             (list (string-to-number (match-string 0 string)))))
 944       (setq string (substring string (match-end 0))))
 945     version))
 946
 947 (defun context-coloring-check-version (expected actual)
 948   "Check that version EXPECTED is less than or equal to ACTUAL."
 949   (let ((expected (context-coloring-parse-version expected))
 950         (actual (context-coloring-parse-version actual))
 951         (continue t)
 952         (acceptable t))
 953     (while (and continue expected)
 954       (let ((an-expected (car expected))
 955             (an-actual (car actual)))
 956         (cond
 957          ((> an-actual an-expected)
 958           (setq acceptable t)
 959           (setq continue nil))
 960          ((< an-actual an-expected)
 961           (setq acceptable nil)
 962           (setq continue nil))))
 963       (setq expected (cdr expected))
 964       (setq actual (cdr actual)))
 965     acceptable))
 966
 967 (defvar context-coloring-check-scopifier-version-hook nil
 968   "Hooks to run after checking the scopifier version.")
 969
 970 (defun context-coloring-check-scopifier-version (&optional callback)
 971   "Asynchronously invoke CALLBACK with a predicate indicating
 972 whether the current scopifier version satisfies the minimum
 973 version number required for the current major mode."
 974   (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
 975     (when dispatch
 976       (let ((version (plist-get dispatch :version))
 977             (command (plist-get dispatch :command)))
 978         (context-coloring-scopify-shell-command
 979          (context-coloring-join (list command "--version") " ")
 980          (lambda (output)
 981            (if (context-coloring-check-version version output)
 982                (progn
 983                  (when callback (funcall callback t)))
 984              (when callback (funcall callback nil)))
 985            (run-hooks 'context-coloring-check-scopifier-version-hook)))))))
 986
 987
 988 ;;; Themes
 989
 990 (defvar context-coloring-theme-hash-table (make-hash-table :test 'eq)
 991   "Map theme names to theme properties.")
 992
 993 (defun context-coloring-theme-p (theme)
 994   "Return t if THEME is defined, nil otherwise."
 995   (and (gethash theme context-coloring-theme-hash-table)))
 996
 997 (defconst context-coloring-level-face-regexp
 998   "context-coloring-level-\\([[:digit:]]+\\)-face"
 999   "Extract a level from a face.")
1000
1001 (defvar context-coloring-originally-set-theme-hash-table
1002   (make-hash-table :test 'eq)
1003   "Cache custom themes who originally set their own
1004   `context-coloring-level-N-face' faces.")
1005
1006 (defun context-coloring-theme-originally-set-p (theme)
1007   "Return t if there is a `context-coloring-level-N-face'
1008 originally set for THEME, nil otherwise."
1009   (let (originally-set)
1010     (cond
1011      ;; `setq' might return a non-nil value for the sake of this `cond'.
1012      ((setq
1013        originally-set
1014        (gethash
1015         theme
1016         context-coloring-originally-set-theme-hash-table))
1017       (eq originally-set 'yes))
1018      (t
1019       (let* ((settings (get theme 'theme-settings))
1020              (tail settings)
1021              found)
1022         (while (and tail (not found))
1023           (and (eq (nth 0 (car tail)) 'theme-face)
1024                (string-match
1025                 context-coloring-level-face-regexp
1026                 (symbol-name (nth 1 (car tail))))
1027                (setq found t))
1028           (setq tail (cdr tail)))
1029         found)))))
1030
1031 (defun context-coloring-cache-originally-set (theme originally-set)
1032   "Remember if THEME had colors originally set for it.  If
1033 ORIGINALLY-SET is non-nil, it did, otherwise it didn't."
1034   ;; Caching whether a theme was originally set is kind of dirty, but we have to
1035   ;; do it to remember the past state of the theme.  There are probably some
1036   ;; edge cases where caching will be an issue, but they are probably rare.
1037   (puthash
1038    theme
1039    (if originally-set 'yes 'no)
1040    context-coloring-originally-set-theme-hash-table))
1041
1042 (defun context-coloring-warn-theme-originally-set (theme)
1043   "Warn the user that the colors for THEME are already originally
1044 set."
1045   (warn "Context coloring colors for theme `%s' are already defined" theme))
1046
1047 (defun context-coloring-theme-highest-level (theme)
1048   "Return the highest level N of a face like
1049 `context-coloring-level-N-face' set for THEME, or `-1' if there
1050 is none."
1051   (let* ((settings (get theme 'theme-settings))
1052          (tail settings)
1053          face-string
1054          number
1055          (found -1))
1056     (while tail
1057       (and (eq (nth 0 (car tail)) 'theme-face)
1058            (setq face-string (symbol-name (nth 1 (car tail))))
1059            (string-match
1060             context-coloring-level-face-regexp
1061             face-string)
1062            (setq number (string-to-number
1063                          (substring face-string
1064                                     (match-beginning 1)
1065                                     (match-end 1))))
1066            (> number found)
1067            (setq found number))
1068       (setq tail (cdr tail)))
1069     found))
1070
1071 (defun context-coloring-apply-theme (theme)
1072   "Apply THEME's properties to its respective custom theme,
1073 which must already exist and which *should* already be enabled."
1074   (let* ((properties (gethash theme context-coloring-theme-hash-table))
1075          (colors (plist-get properties :colors))
1076          (level -1))
1077     ;; Only clobber when we have to.
1078     (when (custom-theme-enabled-p theme)
1079       (setq context-coloring-maximum-face (- (length colors) 1)))
1080     (apply
1081      'custom-theme-set-faces
1082      theme
1083      (mapcar
1084       (lambda (color)
1085         (setq level (+ level 1))
1086         `(,(context-coloring-level-face level) ((t (:foreground ,color)))))
1087       colors))))
1088
1089 (defun context-coloring-define-theme (theme &rest properties)
1090   "Define a context theme named THEME for coloring scope levels.
1091
1092 PROPERTIES is a property list specifiying the following details:
1093
1094 `:aliases': List of symbols of other custom themes that these
1095 colors are applicable to.
1096
1097 `:colors': List of colors that this context theme uses.
1098
1099 `:override': If non-nil, this context theme is intentionally
1100 overriding colors set by a custom theme.  Don't set this non-nil
1101 unless there is a custom theme you want to use which sets
1102 `context-coloring-level-N-face' faces that you want to replace.
1103
1104 `:recede': If non-nil, this context theme should not apply its
1105 colors if a custom theme already sets
1106 `context-coloring-level-N-face' faces.  This option is
1107 optimistic; set this non-nil if you would rather confer the duty
1108 of picking colors to a custom theme author (if / when he ever
1109 gets around to it).
1110
1111 By default, context themes will always override custom themes,
1112 even if those custom themes set `context-coloring-level-N-face'
1113 faces.  If a context theme does override a custom theme, a
1114 warning will be raised, at which point you may want to enable the
1115 `:override' option, or just delete your context theme and opt to
1116 use your custom theme's author's colors instead.
1117
1118 Context themes only work for the custom theme with the highest
1119 precedence, i.e. the car of `custom-enabled-themes'."
1120   (let ((aliases (plist-get properties :aliases))
1121         (override (plist-get properties :override))
1122         (recede (plist-get properties :recede)))
1123     (dolist (name (append `(,theme) aliases))
1124       (puthash name properties context-coloring-theme-hash-table)
1125       (when (custom-theme-p name)
1126         (let ((originally-set (context-coloring-theme-originally-set-p name)))
1127           (context-coloring-cache-originally-set name originally-set)
1128           ;; In the particular case when you innocently define colors that a
1129           ;; custom theme originally set, warn.  Arguably this only has to be
1130           ;; done at enable time, but it is probably more useful to do it at
1131           ;; definition time for prompter feedback.
1132           (when (and originally-set
1133                      (not recede)
1134                      (not override))
1135             (context-coloring-warn-theme-originally-set name))
1136           ;; Set (or overwrite) colors.
1137           (when (not (and originally-set
1138                           recede))
1139             (context-coloring-apply-theme name)))))))
1140
1141 (defun context-coloring-enable-theme (theme)
1142   "Apply THEME if its colors are not already set, else just set
1143 `context-coloring-maximum-face' to the correct value for THEME."
1144   (let* ((properties (gethash theme context-coloring-theme-hash-table))
1145          (recede (plist-get properties :recede))
1146          (override (plist-get properties :override)))
1147     (cond
1148      (recede
1149       (let ((highest-level (context-coloring-theme-highest-level theme)))
1150         (cond
1151          ;; This can be true whether originally set by a custom theme or by a
1152          ;; context theme.
1153          ((> highest-level -1)
1154           (setq context-coloring-maximum-face highest-level))
1155          ;; It is possible that the corresponding custom theme did not exist at
1156          ;; the time of defining this context theme, and in that case the above
1157          ;; condition proves the custom theme did not originally set any faces,
1158          ;; so we have license to apply the context theme for the first time
1159          ;; here.
1160          (t
1161           (context-coloring-apply-theme theme)))))
1162      (t
1163       (let ((originally-set (context-coloring-theme-originally-set-p theme)))
1164         ;; Cache now in case the context theme was defined after the custom
1165         ;; theme.
1166         (context-coloring-cache-originally-set theme originally-set)
1167         (when (and originally-set
1168                    (not override))
1169           (context-coloring-warn-theme-originally-set theme))
1170         (context-coloring-apply-theme theme))))))
1171
1172 (defadvice enable-theme (after context-coloring-enable-theme (theme) activate)
1173   "Enable colors for context themes just-in-time."
1174   (when (and (not (eq theme 'user)) ; Called internally by `enable-theme'.
1175              (custom-theme-p theme) ; Guard against non-existent themes.
1176              (context-coloring-theme-p theme))
1177     (when (= (length custom-enabled-themes) 1)
1178       ;; Cache because we can't reliably figure it out in reverse.
1179       (setq context-coloring-original-maximum-face
1180             context-coloring-maximum-face))
1181     (context-coloring-enable-theme theme)))
1182
1183 (defadvice disable-theme (after context-coloring-disable-theme (theme) activate)
1184   "Update `context-coloring-maximum-face'."
1185   (when (custom-theme-p theme) ; Guard against non-existent themes.
1186     (let ((enabled-theme (car custom-enabled-themes)))
1187       (if (context-coloring-theme-p enabled-theme)
1188           (progn
1189             (context-coloring-enable-theme enabled-theme))
1190         ;; Assume we are back to no theme; act as if nothing ever happened.
1191         ;; This is still prone to intervention, but rather extraordinarily.
1192         (setq context-coloring-maximum-face
1193               context-coloring-original-maximum-face)))))
1194
1195 (context-coloring-define-theme
1196  'ample
1197  :recede t
1198  :colors '("#bdbdb3"
1199            "#baba36"
1200            "#6aaf50"
1201            "#5180b3"
1202            "#ab75c3"
1203            "#cd7542"
1204            "#df9522"
1205            "#454545"))
1206
1207 (context-coloring-define-theme
1208  'anti-zenburn
1209  :recede t
1210  :colors '("#232333"
1211            "#6c1f1c"
1212            "#401440"
1213            "#0f2050"
1214            "#205070"
1215            "#336c6c"
1216            "#23733c"
1217            "#6b400c"
1218            "#603a60"
1219            "#2f4070"
1220            "#235c5c"))
1221
1222 (context-coloring-define-theme
1223  'grandshell
1224  :recede t
1225  :colors '("#bebebe"
1226            "#5af2ee"
1227            "#b2baf6"
1228            "#f09fff"
1229            "#efc334"
1230            "#f6df92"
1231            "#acfb5a"
1232            "#888888"))
1233
1234 (context-coloring-define-theme
1235  'leuven
1236  :recede t
1237  :colors '("#333333"
1238            "#0000ff"
1239            "#6434a3"
1240            "#ba36a5"
1241            "#d0372d"
1242            "#036a07"
1243            "#006699"
1244            "#006fe0"
1245            "#808080"))
1246
1247 (context-coloring-define-theme
1248  'monokai
1249  :recede t
1250  :colors '("#f8f8f2"
1251            "#66d9ef"
1252            "#a1efe4"
1253            "#a6e22e"
1254            "#e6db74"
1255            "#fd971f"
1256            "#f92672"
1257            "#fd5ff0"
1258            "#ae81ff"))
1259
1260 (context-coloring-define-theme
1261  'solarized
1262  :recede t
1263  :aliases '(solarized-light
1264             solarized-dark
1265             sanityinc-solarized-light
1266             sanityinc-solarized-dark)
1267  :colors '("#839496"
1268            "#268bd2"
1269            "#2aa198"
1270            "#859900"
1271            "#b58900"
1272            "#cb4b16"
1273            "#dc322f"
1274            "#d33682"
1275            "#6c71c4"
1276            "#69b7f0"
1277            "#69cabf"
1278            "#b4c342"
1279            "#deb542"
1280            "#f2804f"
1281            "#ff6e64"
1282            "#f771ac"
1283            "#9ea0e5"))
1284
1285 (context-coloring-define-theme
1286  'spacegray
1287  :recede t
1288  :colors '("#ffffff"
1289            "#89aaeb"
1290            "#c189eb"
1291            "#bf616a"
1292            "#dca432"
1293            "#ebcb8b"
1294            "#b4eb89"
1295            "#89ebca"))
1296
1297 (context-coloring-define-theme
1298  'tango
1299  :recede t
1300  :colors '("#2e3436"
1301            "#346604"
1302            "#204a87"
1303            "#5c3566"
1304            "#a40000"
1305            "#b35000"
1306            "#c4a000"
1307            "#8ae234"
1308            "#8cc4ff"
1309            "#ad7fa8"
1310            "#ef2929"
1311            "#fcaf3e"
1312            "#fce94f"))
1313
1314 (context-coloring-define-theme
1315  'zenburn
1316  :recede t
1317  :colors '("#dcdccc"
1318            "#93e0e3"
1319            "#bfebbf"
1320            "#f0dfaf"
1321            "#dfaf8f"
1322            "#cc9393"
1323            "#dc8cc3"
1324            "#94bff3"
1325            "#9fc59f"
1326            "#d0bf8f"
1327            "#dca3a3"))
1328
1329
1330 ;;; Change detection
1331
1332 (defvar-local context-coloring-colorize-idle-timer nil
1333   "The currently-running idle timer.")
1334
1335 (defcustom context-coloring-delay 0.25
1336   "Delay between a buffer update and colorization.
1337
1338 Increase this if your machine is high-performing.  Decrease it if
1339 it ain't.
1340
1341 Supported modes: `js-mode', `js3-mode', `emacs-lisp-mode'"
1342   :group 'context-coloring)
1343
1344 (defun context-coloring-setup-idle-change-detection ()
1345   "Setup idle change detection."
1346   (add-hook
1347    'after-change-functions 'context-coloring-change-function nil t)
1348   (add-hook
1349    'kill-buffer-hook 'context-coloring-teardown-idle-change-detection nil t)
1350   (setq context-coloring-colorize-idle-timer
1351         (run-with-idle-timer
1352          context-coloring-delay
1353          t
1354          'context-coloring-maybe-colorize
1355          (current-buffer))))
1356
1357 (defun context-coloring-teardown-idle-change-detection ()
1358   "Teardown idle change detection."
1359   (context-coloring-kill-scopifier)
1360   (when context-coloring-colorize-idle-timer
1361     (cancel-timer context-coloring-colorize-idle-timer))
1362   (remove-hook
1363    'kill-buffer-hook 'context-coloring-teardown-idle-change-detection t)
1364   (remove-hook
1365    'after-change-functions 'context-coloring-change-function t))
1366
1367
1368 ;;; Built-in dispatches
1369
1370 (context-coloring-define-dispatch
1371  'javascript-node
1372  :modes '(js-mode js3-mode)
1373  :executable "scopifier"
1374  :command "scopifier"
1375  :version "v1.1.1")
1376
1377 (context-coloring-define-dispatch
1378  'javascript-js2
1379  :modes '(js2-mode)
1380  :colorizer 'context-coloring-js2-colorize
1381  :setup
1382  (lambda ()
1383    (add-hook 'js2-post-parse-callbacks 'context-coloring-colorize nil t))
1384  :teardown
1385  (lambda ()
1386    (remove-hook 'js2-post-parse-callbacks 'context-coloring-colorize t)))
1387
1388 (context-coloring-define-dispatch
1389  'emacs-lisp
1390  :modes '(emacs-lisp-mode)
1391  :colorizer 'context-coloring-elisp-colorize-buffer
1392  :setup 'context-coloring-setup-idle-change-detection
1393  :teardown 'context-coloring-teardown-idle-change-detection)
1394
1395 (defun context-coloring-dispatch (&optional callback)
1396   "Determine the optimal track for scopification / coloring of
1397 the current buffer, then execute it.
1398
1399 Invoke CALLBACK when complete.  It is invoked synchronously for
1400 elisp tracks, and asynchronously for shell command tracks."
1401   (let* ((dispatch (context-coloring-get-dispatch-for-mode major-mode))
1402          (colorizer (plist-get dispatch :colorizer))
1403          (scopifier (plist-get dispatch :scopifier))
1404          (command (plist-get dispatch :command))
1405          interrupted-p)
1406     (cond
1407      ((or colorizer scopifier)
1408       (setq interrupted-p
1409             (catch 'interrupted
1410               (cond
1411                (colorizer
1412                 (funcall colorizer))
1413                (scopifier
1414                 (context-coloring-apply-tokens (funcall scopifier))))))
1415       (cond
1416        (interrupted-p
1417         (setq context-coloring-changed t))
1418        (t
1419         (when callback (funcall callback)))))
1420      (command
1421       (context-coloring-scopify-and-colorize command callback)))))
1422
1423
1424 ;;; Minor mode
1425
1426 ;;;###autoload
1427 (define-minor-mode context-coloring-mode
1428   "Context-based code coloring, inspired by Douglas Crockford."
1429   nil " Context" nil
1430   (if (not context-coloring-mode)
1431       (progn
1432         (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
1433           (when dispatch
1434             (let ((command (plist-get dispatch :command))
1435                   (teardown (plist-get dispatch :teardown)))
1436               (when command
1437                 (context-coloring-teardown-idle-change-detection))
1438               (when teardown
1439                 (funcall teardown)))))
1440         (font-lock-mode)
1441         (jit-lock-mode t))
1442
1443     ;; Font lock is incompatible with this mode; the converse is also true.
1444     (font-lock-mode 0)
1445     (jit-lock-mode nil)
1446
1447     ;; ...but we do use font-lock functions here.
1448     (font-lock-set-defaults)
1449
1450     ;; Safely change the valye of this function as necessary.
1451     (make-local-variable 'font-lock-syntactic-face-function)
1452
1453     (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
1454       (if dispatch
1455           (progn
1456             (let ((command (plist-get dispatch :command))
1457                   (version (plist-get dispatch :version))
1458                   (executable (plist-get dispatch :executable))
1459                   (setup (plist-get dispatch :setup))
1460                   (colorize-initially-p t))
1461               (when command
1462                 ;; Shell commands recolor on change, idly.
1463                 (cond
1464                  ((and executable
1465                        (null (executable-find executable)))
1466                   (message "Executable \"%s\" not found" executable)
1467                   (setq colorize-initially-p nil))
1468                  (version
1469                   (context-coloring-check-scopifier-version
1470                    (lambda (sufficient-p)
1471                      (if sufficient-p
1472                          (progn
1473                            (context-coloring-setup-idle-change-detection)
1474                            (context-coloring-colorize))
1475                        (message "Update to the minimum version of \"%s\" (%s)"
1476                                 executable version))))
1477                   (setq colorize-initially-p nil))
1478                  (t
1479                   (context-coloring-setup-idle-change-detection))))
1480               (when setup
1481                 (funcall setup))
1482               ;; Colorize once initially.
1483               (when colorize-initially-p
1484                 (let ((context-coloring-parse-interruptable-p nil))
1485                   (context-coloring-colorize)))))
1486         (when (null dispatch)
1487           (message "Context coloring is not available for this major mode"))))))
1488
1489 (provide 'context-coloring)
1490
1491 ;;; context-coloring.el ends here