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 (context-coloring-get-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              (cond
 668               ((= syntax-code context-coloring-ESCAPE-CODE)
 669                ;; If there was an escape char, keep going.
 670                (forward-char 2)
 671                t)
 672               ((= syntax-code context-coloring-STRING-QUOTE-CODE)
 673                ;; If the string ended, move outside it.
 674                (forward-char)
 675                nil))))
 676     (context-coloring-maybe-colorize-comments-and-strings
 677      start
 678      (point))))
 679
 680 (defun context-coloring-elisp-colorize-region (start end)
 681   (let (syntax-code)
 682     (goto-char start)
 683     (while (> end (progn (skip-syntax-forward "^()w_'<\"" end)
 684                          (point)))
 685       (setq syntax-code (context-coloring-get-syntax-code))
 686       (cond
 687        ((or (= syntax-code context-coloring-OPEN-PARENTHESIS-CODE)
 688             (= syntax-code context-coloring-WORD-CODE)
 689             (= syntax-code context-coloring-SYMBOL-CODE)
 690             (= syntax-code context-coloring-EXPRESSION-PREFIX-CODE))
 691         (context-coloring-elisp-colorize-sexp))
 692        ((= syntax-code context-coloring-COMMENT-START-CODE)
 693         (context-coloring-elisp-colorize-comment))
 694        ((= syntax-code context-coloring-STRING-QUOTE-CODE)
 695         (context-coloring-elisp-colorize-string))
 696        (t
 697         (forward-char))))))
 698
 699 (defun context-coloring-elisp-colorize (start end)
 700   (setq context-coloring-elisp-sexp-count 0)
 701   (setq context-coloring-elisp-scope-stack '())
 702   (context-coloring-elisp-colorize-region start end))
 703
 704 (defun context-coloring-elisp-colorize-changed-region (start end)
 705   (with-silent-modifications
 706     (save-excursion
 707       (let ((start (progn (goto-char start)
 708                           (beginning-of-defun)
 709                           (point)))
 710             (end (progn (goto-char end)
 711                         (end-of-defun)
 712                         (point))))
 713         (context-coloring-elisp-colorize start end)))))
 714
 715 (defun context-coloring-elisp-colorize-buffer ()
 716   (interactive)
 717   (with-silent-modifications
 718     (save-excursion
 719       (context-coloring-elisp-colorize (point-min) (point-max)))))
 720
 721 (defalias 'ccecb 'context-coloring-elisp-colorize-buffer)
 722
 723
 724 ;;; Shell command scopification / colorization
 725
 726 (defun context-coloring-apply-tokens (tokens)
 727   "Process a vector of TOKENS to apply context-based coloring to
 728 the current buffer.  Tokens are 3 integers: start, end, level.
 729 The vector is flat, with a new token occurring after every 3rd
 730 element."
 731   (with-silent-modifications
 732     (let ((i 0)
 733           (len (length tokens)))
 734       (while (< i len)
 735         (context-coloring-colorize-region
 736          (elt tokens i)
 737          (elt tokens (+ i 1))
 738          (elt tokens (+ i 2)))
 739         (setq i (+ i 3))))
 740     (context-coloring-maybe-colorize-comments-and-strings)))
 741
 742 (defun context-coloring-parse-array (array)
 743   "Parse ARRAY as a flat JSON array of numbers."
 744   (let ((braceless (substring (context-coloring-trim array) 1 -1)))
 745     (cond
 746      ((> (length braceless) 0)
 747       (vconcat
 748        (mapcar 'string-to-number (split-string braceless ","))))
 749      (t
 750       (vector)))))
 751
 752 (defvar-local context-coloring-scopifier-process nil
 753   "The single scopifier process that can be running.")
 754
 755 (defun context-coloring-kill-scopifier ()
 756   "Kill the currently-running scopifier process."
 757   (when (not (null context-coloring-scopifier-process))
 758     (delete-process context-coloring-scopifier-process)
 759     (setq context-coloring-scopifier-process nil)))
 760
 761 (defun context-coloring-scopify-shell-command (command callback)
 762   "Invoke a scopifier via COMMAND, read its response
 763 asynchronously and invoke CALLBACK with its output."
 764
 765   ;; Prior running tokenization is implicitly obsolete if this function is
 766   ;; called.
 767   (context-coloring-kill-scopifier)
 768
 769   ;; Start the process.
 770   (setq context-coloring-scopifier-process
 771         (start-process-shell-command "scopifier" nil command))
 772
 773   (let ((output ""))
 774
 775     ;; The process may produce output in multiple chunks.  This filter
 776     ;; accumulates the chunks into a message.
 777     (set-process-filter
 778      context-coloring-scopifier-process
 779      (lambda (_process chunk)
 780        (setq output (concat output chunk))))
 781
 782     ;; When the process's message is complete, this sentinel parses it as JSON
 783     ;; and applies the tokens to the buffer.
 784     (set-process-sentinel
 785      context-coloring-scopifier-process
 786      (lambda (_process event)
 787        (when (equal "finished\n" event)
 788          (funcall callback output))))))
 789
 790 (defun context-coloring-send-buffer-to-scopifier ()
 791   "Give the scopifier process its input so it can begin
 792 scopifying."
 793   (process-send-region
 794    context-coloring-scopifier-process
 795    (point-min) (point-max))
 796   (process-send-eof
 797    context-coloring-scopifier-process))
 798
 799 (defun context-coloring-scopify-and-colorize (command &optional callback)
 800   "Invoke a scopifier via COMMAND with the current buffer's contents,
 801 read the scopifier's response asynchronously and apply a parsed
 802 list of tokens to `context-coloring-apply-tokens'.
 803
 804 Invoke CALLBACK when complete."
 805   (let ((buffer (current-buffer)))
 806     (context-coloring-scopify-shell-command
 807      command
 808      (lambda (output)
 809        (let ((tokens (context-coloring-parse-array output)))
 810          (with-current-buffer buffer
 811            (context-coloring-apply-tokens tokens))
 812          (setq context-coloring-scopifier-process nil)
 813          (when callback (funcall callback))))))
 814   (context-coloring-send-buffer-to-scopifier))
 815
 816
 817 ;;; Dispatch
 818
 819 (defvar context-coloring-dispatch-hash-table (make-hash-table :test 'eq)
 820   "Map dispatch strategy names to their corresponding property
 821   lists, which contain details about the strategies.")
 822
 823 (defvar context-coloring-mode-hash-table (make-hash-table :test 'eq)
 824   "Map major mode names to dispatch property lists.")
 825
 826 (defun context-coloring-get-dispatch-for-mode (mode)
 827   "Return the dispatch for MODE (or a derivative mode)."
 828   (let ((parent mode)
 829         dispatch)
 830     (while (and parent
 831                 (not (setq dispatch (gethash parent context-coloring-mode-hash-table)))
 832                 (setq parent (get parent 'derived-mode-parent))))
 833     dispatch))
 834
 835 (defun context-coloring-define-dispatch (symbol &rest properties)
 836   "Define a new dispatch named SYMBOL with PROPERTIES.
 837
 838 A \"dispatch\" is a property list describing a strategy for
 839 coloring a buffer.  There are three possible strategies: Parse
 840 and color in a single function (`:colorizer'), parse in a
 841 function that returns scope data (`:scopifier'), or parse with a
 842 shell command that returns scope data (`:command').  In the
 843 latter two cases, the scope data will be used to automatically
 844 color the buffer.
 845
 846 PROPERTIES must include `:modes' and one of `:colorizer',
 847 `:scopifier' or `:command'.
 848
 849 `:modes' - List of major modes this dispatch is valid for.
 850
 851 `:colorizer' - Symbol referring to a function that parses and
 852 colors the buffer.
 853
 854 `:scopifier' - Symbol referring to a function that parses the
 855 buffer a returns a flat vector of start, end and level data.
 856
 857 `:executable' - Optional name of an executable required by
 858 `:command'.
 859
 860 `:command' - Shell command to execute with the current buffer
 861 sent via stdin, and with a flat JSON array of start, end and
 862 level data returned via stdout.
 863
 864 `:version' - Minimum required version that should be printed when
 865 executing `:command' with a \"--version\" flag.  The version
 866 should be numeric, e.g. \"2\", \"19700101\", \"1.2.3\",
 867 \"v1.2.3\" etc.
 868
 869 `:setup' - Arbitrary code to set up this dispatch when
 870 `context-coloring-mode' is enabled.
 871
 872 `:teardown' - Arbitrary code to tear down this dispatch when
 873 `context-coloring-mode' is disabled."
 874   (let ((modes (plist-get properties :modes))
 875         (colorizer (plist-get properties :colorizer))
 876         (scopifier (plist-get properties :scopifier))
 877         (command (plist-get properties :command)))
 878     (when (null modes)
 879       (error "No mode defined for dispatch"))
 880     (when (not (or colorizer
 881                    scopifier
 882                    command))
 883       (error "No colorizer, scopifier or command defined for dispatch"))
 884     (puthash symbol properties context-coloring-dispatch-hash-table)
 885     (dolist (mode modes)
 886       (puthash mode properties context-coloring-mode-hash-table))))
 887
 888
 889 ;;; Colorization
 890
 891 (defvar context-coloring-colorize-hook nil
 892   "Hooks to run after coloring a buffer.")
 893
 894 (defun context-coloring-colorize (&optional callback)
 895   "Color the current buffer by function context.
 896
 897 Invoke CALLBACK when complete; see `context-coloring-dispatch'."
 898   (interactive)
 899   (context-coloring-dispatch
 900    (lambda ()
 901      (when callback (funcall callback))
 902      (run-hooks 'context-coloring-colorize-hook))))
 903
 904 (defvar-local context-coloring-changed nil
 905   "Indication that the buffer has changed recently, which implies
 906 that it should be colored again by
 907 `context-coloring-colorize-idle-timer' if that timer is being
 908 used.")
 909
 910 (defun context-coloring-change-function (_start _end _length)
 911   "Register a change so that a buffer can be colorized soon."
 912   ;; Tokenization is obsolete if there was a change.
 913   (context-coloring-kill-scopifier)
 914   (setq context-coloring-changed t))
 915
 916 (defun context-coloring-maybe-colorize (buffer)
 917   "Colorize the current buffer if it has changed."
 918   (when (and (eq buffer (current-buffer))
 919              context-coloring-changed)
 920     (setq context-coloring-changed nil)
 921     (context-coloring-colorize)))
 922
 923
 924 ;;; Versioning
 925
 926 (defun context-coloring-parse-version (string)
 927   "Extract segments of a version STRING into a list.  \"v1.0.0\"
 928 produces (1 0 0), \"19700101\" produces (19700101), etc."
 929   (let (version)
 930     (while (string-match "[0-9]+" string)
 931       (setq version (append version
 932                             (list (string-to-number (match-string 0 string)))))
 933       (setq string (substring string (match-end 0))))
 934     version))
 935
 936 (defun context-coloring-check-version (expected actual)
 937   "Check that version EXPECTED is less than or equal to ACTUAL."
 938   (let ((expected (context-coloring-parse-version expected))
 939         (actual (context-coloring-parse-version actual))
 940         (continue t)
 941         (acceptable t))
 942     (while (and continue expected)
 943       (let ((an-expected (car expected))
 944             (an-actual (car actual)))
 945         (cond
 946          ((> an-actual an-expected)
 947           (setq acceptable t)
 948           (setq continue nil))
 949          ((< an-actual an-expected)
 950           (setq acceptable nil)
 951           (setq continue nil))))
 952       (setq expected (cdr expected))
 953       (setq actual (cdr actual)))
 954     acceptable))
 955
 956 (defvar context-coloring-check-scopifier-version-hook nil
 957   "Hooks to run after checking the scopifier version.")
 958
 959 (defun context-coloring-check-scopifier-version (&optional callback)
 960   "Asynchronously invoke CALLBACK with a predicate indicating
 961 whether the current scopifier version satisfies the minimum
 962 version number required for the current major mode."
 963   (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
 964     (when dispatch
 965       (let ((version (plist-get dispatch :version))
 966             (command (plist-get dispatch :command)))
 967         (context-coloring-scopify-shell-command
 968          (context-coloring-join (list command "--version") " ")
 969          (lambda (output)
 970            (if (context-coloring-check-version version output)
 971                (progn
 972                  (when callback (funcall callback t)))
 973              (when callback (funcall callback nil)))
 974            (run-hooks 'context-coloring-check-scopifier-version-hook)))))))
 975
 976
 977 ;;; Themes
 978
 979 (defvar context-coloring-theme-hash-table (make-hash-table :test 'eq)
 980   "Map theme names to theme properties.")
 981
 982 (defun context-coloring-theme-p (theme)
 983   "Return t if THEME is defined, nil otherwise."
 984   (and (gethash theme context-coloring-theme-hash-table)))
 985
 986 (defconst context-coloring-level-face-regexp
 987   "context-coloring-level-\\([[:digit:]]+\\)-face"
 988   "Extract a level from a face.")
 989
 990 (defvar context-coloring-originally-set-theme-hash-table
 991   (make-hash-table :test 'eq)
 992   "Cache custom themes who originally set their own
 993   `context-coloring-level-N-face' faces.")
 994
 995 (defun context-coloring-theme-originally-set-p (theme)
 996   "Return t if there is a `context-coloring-level-N-face'
 997 originally set for THEME, nil otherwise."
 998   (let (originally-set)
 999     (cond
1000      ;; `setq' might return a non-nil value for the sake of this `cond'.
1001      ((setq
1002        originally-set
1003        (gethash
1004         theme
1005         context-coloring-originally-set-theme-hash-table))
1006       (eq originally-set 'yes))
1007      (t
1008       (let* ((settings (get theme 'theme-settings))
1009              (tail settings)
1010              found)
1011         (while (and tail (not found))
1012           (and (eq (nth 0 (car tail)) 'theme-face)
1013                (string-match
1014                 context-coloring-level-face-regexp
1015                 (symbol-name (nth 1 (car tail))))
1016                (setq found t))
1017           (setq tail (cdr tail)))
1018         found)))))
1019
1020 (defun context-coloring-cache-originally-set (theme originally-set)
1021   "Remember if THEME had colors originally set for it.  If
1022 ORIGINALLY-SET is non-nil, it did, otherwise it didn't."
1023   ;; Caching whether a theme was originally set is kind of dirty, but we have to
1024   ;; do it to remember the past state of the theme.  There are probably some
1025   ;; edge cases where caching will be an issue, but they are probably rare.
1026   (puthash
1027    theme
1028    (if originally-set 'yes 'no)
1029    context-coloring-originally-set-theme-hash-table))
1030
1031 (defun context-coloring-warn-theme-originally-set (theme)
1032   "Warn the user that the colors for THEME are already originally
1033 set."
1034   (warn "Context coloring colors for theme `%s' are already defined" theme))
1035
1036 (defun context-coloring-theme-highest-level (theme)
1037   "Return the highest level N of a face like
1038 `context-coloring-level-N-face' set for THEME, or `-1' if there
1039 is none."
1040   (let* ((settings (get theme 'theme-settings))
1041          (tail settings)
1042          face-string
1043          number
1044          (found -1))
1045     (while tail
1046       (and (eq (nth 0 (car tail)) 'theme-face)
1047            (setq face-string (symbol-name (nth 1 (car tail))))
1048            (string-match
1049             context-coloring-level-face-regexp
1050             face-string)
1051            (setq number (string-to-number
1052                          (substring face-string
1053                                     (match-beginning 1)
1054                                     (match-end 1))))
1055            (> number found)
1056            (setq found number))
1057       (setq tail (cdr tail)))
1058     found))
1059
1060 (defun context-coloring-apply-theme (theme)
1061   "Apply THEME's properties to its respective custom theme,
1062 which must already exist and which *should* already be enabled."
1063   (let* ((properties (gethash theme context-coloring-theme-hash-table))
1064          (colors (plist-get properties :colors))
1065          (level -1))
1066     ;; Only clobber when we have to.
1067     (when (custom-theme-enabled-p theme)
1068       (setq context-coloring-maximum-face (- (length colors) 1)))
1069     (apply
1070      'custom-theme-set-faces
1071      theme
1072      (mapcar
1073       (lambda (color)
1074         (setq level (+ level 1))
1075         `(,(context-coloring-level-face level) ((t (:foreground ,color)))))
1076       colors))))
1077
1078 (defun context-coloring-define-theme (theme &rest properties)
1079   "Define a context theme named THEME for coloring scope levels.
1080
1081 PROPERTIES is a property list specifiying the following details:
1082
1083 `:aliases': List of symbols of other custom themes that these
1084 colors are applicable to.
1085
1086 `:colors': List of colors that this context theme uses.
1087
1088 `:override': If non-nil, this context theme is intentionally
1089 overriding colors set by a custom theme.  Don't set this non-nil
1090 unless there is a custom theme you want to use which sets
1091 `context-coloring-level-N-face' faces that you want to replace.
1092
1093 `:recede': If non-nil, this context theme should not apply its
1094 colors if a custom theme already sets
1095 `context-coloring-level-N-face' faces.  This option is
1096 optimistic; set this non-nil if you would rather confer the duty
1097 of picking colors to a custom theme author (if / when he ever
1098 gets around to it).
1099
1100 By default, context themes will always override custom themes,
1101 even if those custom themes set `context-coloring-level-N-face'
1102 faces.  If a context theme does override a custom theme, a
1103 warning will be raised, at which point you may want to enable the
1104 `:override' option, or just delete your context theme and opt to
1105 use your custom theme's author's colors instead.
1106
1107 Context themes only work for the custom theme with the highest
1108 precedence, i.e. the car of `custom-enabled-themes'."
1109   (let ((aliases (plist-get properties :aliases))
1110         (override (plist-get properties :override))
1111         (recede (plist-get properties :recede)))
1112     (dolist (name (append `(,theme) aliases))
1113       (puthash name properties context-coloring-theme-hash-table)
1114       (when (custom-theme-p name)
1115         (let ((originally-set (context-coloring-theme-originally-set-p name)))
1116           (context-coloring-cache-originally-set name originally-set)
1117           ;; In the particular case when you innocently define colors that a
1118           ;; custom theme originally set, warn.  Arguably this only has to be
1119           ;; done at enable time, but it is probably more useful to do it at
1120           ;; definition time for prompter feedback.
1121           (when (and originally-set
1122                      (not recede)
1123                      (not override))
1124             (context-coloring-warn-theme-originally-set name))
1125           ;; Set (or overwrite) colors.
1126           (when (not (and originally-set
1127                           recede))
1128             (context-coloring-apply-theme name)))))))
1129
1130 (defun context-coloring-enable-theme (theme)
1131   "Apply THEME if its colors are not already set, else just set
1132 `context-coloring-maximum-face' to the correct value for THEME."
1133   (let* ((properties (gethash theme context-coloring-theme-hash-table))
1134          (recede (plist-get properties :recede))
1135          (override (plist-get properties :override)))
1136     (cond
1137      (recede
1138       (let ((highest-level (context-coloring-theme-highest-level theme)))
1139         (cond
1140          ;; This can be true whether originally set by a custom theme or by a
1141          ;; context theme.
1142          ((> highest-level -1)
1143           (setq context-coloring-maximum-face highest-level))
1144          ;; It is possible that the corresponding custom theme did not exist at
1145          ;; the time of defining this context theme, and in that case the above
1146          ;; condition proves the custom theme did not originally set any faces,
1147          ;; so we have license to apply the context theme for the first time
1148          ;; here.
1149          (t
1150           (context-coloring-apply-theme theme)))))
1151      (t
1152       (let ((originally-set (context-coloring-theme-originally-set-p theme)))
1153         ;; Cache now in case the context theme was defined after the custom
1154         ;; theme.
1155         (context-coloring-cache-originally-set theme originally-set)
1156         (when (and originally-set
1157                    (not override))
1158           (context-coloring-warn-theme-originally-set theme))
1159         (context-coloring-apply-theme theme))))))
1160
1161 (defadvice enable-theme (after context-coloring-enable-theme (theme) activate)
1162   "Enable colors for context themes just-in-time."
1163   (when (and (not (eq theme 'user)) ; Called internally by `enable-theme'.
1164              (custom-theme-p theme) ; Guard against non-existent themes.
1165              (context-coloring-theme-p theme))
1166     (when (= (length custom-enabled-themes) 1)
1167       ;; Cache because we can't reliably figure it out in reverse.
1168       (setq context-coloring-original-maximum-face
1169             context-coloring-maximum-face))
1170     (context-coloring-enable-theme theme)))
1171
1172 (defadvice disable-theme (after context-coloring-disable-theme (theme) activate)
1173   "Update `context-coloring-maximum-face'."
1174   (when (custom-theme-p theme) ; Guard against non-existent themes.
1175     (let ((enabled-theme (car custom-enabled-themes)))
1176       (if (context-coloring-theme-p enabled-theme)
1177           (progn
1178             (context-coloring-enable-theme enabled-theme))
1179         ;; Assume we are back to no theme; act as if nothing ever happened.
1180         ;; This is still prone to intervention, but rather extraordinarily.
1181         (setq context-coloring-maximum-face
1182               context-coloring-original-maximum-face)))))
1183
1184 (context-coloring-define-theme
1185  'ample
1186  :recede t
1187  :colors '("#bdbdb3"
1188            "#baba36"
1189            "#6aaf50"
1190            "#5180b3"
1191            "#ab75c3"
1192            "#cd7542"
1193            "#df9522"
1194            "#454545"))
1195
1196 (context-coloring-define-theme
1197  'anti-zenburn
1198  :recede t
1199  :colors '("#232333"
1200            "#6c1f1c"
1201            "#401440"
1202            "#0f2050"
1203            "#205070"
1204            "#336c6c"
1205            "#23733c"
1206            "#6b400c"
1207            "#603a60"
1208            "#2f4070"
1209            "#235c5c"))
1210
1211 (context-coloring-define-theme
1212  'grandshell
1213  :recede t
1214  :colors '("#bebebe"
1215            "#5af2ee"
1216            "#b2baf6"
1217            "#f09fff"
1218            "#efc334"
1219            "#f6df92"
1220            "#acfb5a"
1221            "#888888"))
1222
1223 (context-coloring-define-theme
1224  'leuven
1225  :recede t
1226  :colors '("#333333"
1227            "#0000ff"
1228            "#6434a3"
1229            "#ba36a5"
1230            "#d0372d"
1231            "#036a07"
1232            "#006699"
1233            "#006fe0"
1234            "#808080"))
1235
1236 (context-coloring-define-theme
1237  'monokai
1238  :recede t
1239  :colors '("#f8f8f2"
1240            "#66d9ef"
1241            "#a1efe4"
1242            "#a6e22e"
1243            "#e6db74"
1244            "#fd971f"
1245            "#f92672"
1246            "#fd5ff0"
1247            "#ae81ff"))
1248
1249 (context-coloring-define-theme
1250  'solarized
1251  :recede t
1252  :aliases '(solarized-light
1253             solarized-dark
1254             sanityinc-solarized-light
1255             sanityinc-solarized-dark)
1256  :colors '("#839496"
1257            "#268bd2"
1258            "#2aa198"
1259            "#859900"
1260            "#b58900"
1261            "#cb4b16"
1262            "#dc322f"
1263            "#d33682"
1264            "#6c71c4"
1265            "#69b7f0"
1266            "#69cabf"
1267            "#b4c342"
1268            "#deb542"
1269            "#f2804f"
1270            "#ff6e64"
1271            "#f771ac"
1272            "#9ea0e5"))
1273
1274 (context-coloring-define-theme
1275  'spacegray
1276  :recede t
1277  :colors '("#ffffff"
1278            "#89aaeb"
1279            "#c189eb"
1280            "#bf616a"
1281            "#dca432"
1282            "#ebcb8b"
1283            "#b4eb89"
1284            "#89ebca"))
1285
1286 (context-coloring-define-theme
1287  'tango
1288  :recede t
1289  :colors '("#2e3436"
1290            "#346604"
1291            "#204a87"
1292            "#5c3566"
1293            "#a40000"
1294            "#b35000"
1295            "#c4a000"
1296            "#8ae234"
1297            "#8cc4ff"
1298            "#ad7fa8"
1299            "#ef2929"
1300            "#fcaf3e"
1301            "#fce94f"))
1302
1303 (context-coloring-define-theme
1304  'zenburn
1305  :recede t
1306  :colors '("#dcdccc"
1307            "#93e0e3"
1308            "#bfebbf"
1309            "#f0dfaf"
1310            "#dfaf8f"
1311            "#cc9393"
1312            "#dc8cc3"
1313            "#94bff3"
1314            "#9fc59f"
1315            "#d0bf8f"
1316            "#dca3a3"))
1317
1318
1319 ;;; Change detection
1320
1321 (defvar-local context-coloring-colorize-idle-timer nil
1322   "The currently-running idle timer.")
1323
1324 (defcustom context-coloring-delay 0.25
1325   "Delay between a buffer update and colorization.
1326
1327 Increase this if your machine is high-performing.  Decrease it if
1328 it ain't.
1329
1330 Supported modes: `js-mode', `js3-mode', `emacs-lisp-mode'"
1331   :group 'context-coloring)
1332
1333 (defun context-coloring-setup-idle-change-detection ()
1334   "Setup idle change detection."
1335   (add-hook
1336    'after-change-functions 'context-coloring-change-function nil t)
1337   (add-hook
1338    'kill-buffer-hook 'context-coloring-teardown-idle-change-detection nil t)
1339   (setq context-coloring-colorize-idle-timer
1340         (run-with-idle-timer
1341          context-coloring-delay
1342          t
1343          'context-coloring-maybe-colorize
1344          (current-buffer))))
1345
1346 (defun context-coloring-teardown-idle-change-detection ()
1347   "Teardown idle change detection."
1348   (context-coloring-kill-scopifier)
1349   (when context-coloring-colorize-idle-timer
1350     (cancel-timer context-coloring-colorize-idle-timer))
1351   (remove-hook
1352    'kill-buffer-hook 'context-coloring-teardown-idle-change-detection t)
1353   (remove-hook
1354    'after-change-functions 'context-coloring-change-function t))
1355
1356
1357 ;;; Built-in dispatches
1358
1359 (context-coloring-define-dispatch
1360  'javascript-node
1361  :modes '(js-mode js3-mode)
1362  :executable "scopifier"
1363  :command "scopifier"
1364  :version "v1.1.1")
1365
1366 (context-coloring-define-dispatch
1367  'javascript-js2
1368  :modes '(js2-mode)
1369  :colorizer 'context-coloring-js2-colorize
1370  :setup
1371  (lambda ()
1372    (add-hook 'js2-post-parse-callbacks 'context-coloring-colorize nil t))
1373  :teardown
1374  (lambda ()
1375    (remove-hook 'js2-post-parse-callbacks 'context-coloring-colorize t)))
1376
1377 (context-coloring-define-dispatch
1378  'emacs-lisp
1379  :modes '(emacs-lisp-mode)
1380  :colorizer 'context-coloring-elisp-colorize-buffer
1381  :setup 'context-coloring-setup-idle-change-detection
1382  :teardown 'context-coloring-teardown-idle-change-detection)
1383
1384 (defun context-coloring-dispatch (&optional callback)
1385   "Determine the optimal track for scopification / coloring of
1386 the current buffer, then execute it.
1387
1388 Invoke CALLBACK when complete.  It is invoked synchronously for
1389 elisp tracks, and asynchronously for shell command tracks."
1390   (let* ((dispatch (context-coloring-get-dispatch-for-mode major-mode))
1391          (colorizer (plist-get dispatch :colorizer))
1392          (scopifier (plist-get dispatch :scopifier))
1393          (command (plist-get dispatch :command))
1394          interrupted-p)
1395     (cond
1396      ((or colorizer scopifier)
1397       (setq interrupted-p
1398             (catch 'interrupted
1399               (cond
1400                (colorizer
1401                 (funcall colorizer))
1402                (scopifier
1403                 (context-coloring-apply-tokens (funcall scopifier))))))
1404       (cond
1405        (interrupted-p
1406         (setq context-coloring-changed t))
1407        (t
1408         (when callback (funcall callback)))))
1409      (command
1410       (context-coloring-scopify-and-colorize command callback)))))
1411
1412
1413 ;;; Minor mode
1414
1415 ;;;###autoload
1416 (define-minor-mode context-coloring-mode
1417   "Context-based code coloring, inspired by Douglas Crockford."
1418   nil " Context" nil
1419   (if (not context-coloring-mode)
1420       (progn
1421         (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
1422           (when dispatch
1423             (let ((command (plist-get dispatch :command))
1424                   (teardown (plist-get dispatch :teardown)))
1425               (when command
1426                 (context-coloring-teardown-idle-change-detection))
1427               (when teardown
1428                 (funcall teardown)))))
1429         (font-lock-mode)
1430         (jit-lock-mode t))
1431
1432     ;; Font lock is incompatible with this mode; the converse is also true.
1433     (font-lock-mode 0)
1434     (jit-lock-mode nil)
1435
1436     ;; ...but we do use font-lock functions here.
1437     (font-lock-set-defaults)
1438
1439     ;; Safely change the valye of this function as necessary.
1440     (make-local-variable 'font-lock-syntactic-face-function)
1441
1442     (let ((dispatch (context-coloring-get-dispatch-for-mode major-mode)))
1443       (if dispatch
1444           (progn
1445             (let ((command (plist-get dispatch :command))
1446                   (version (plist-get dispatch :version))
1447                   (executable (plist-get dispatch :executable))
1448                   (setup (plist-get dispatch :setup))
1449                   (colorize-initially-p t))
1450               (when command
1451                 ;; Shell commands recolor on change, idly.
1452                 (cond
1453                  ((and executable
1454                        (null (executable-find executable)))
1455                   (message "Executable \"%s\" not found" executable)
1456                   (setq colorize-initially-p nil))
1457                  (version
1458                   (context-coloring-check-scopifier-version
1459                    (lambda (sufficient-p)
1460                      (if sufficient-p
1461                          (progn
1462                            (context-coloring-setup-idle-change-detection)
1463                            (context-coloring-colorize))
1464                        (message "Update to the minimum version of \"%s\" (%s)"
1465                                 executable version))))
1466                   (setq colorize-initially-p nil))
1467                  (t
1468                   (context-coloring-setup-idle-change-detection))))
1469               (when setup
1470                 (funcall setup))
1471               ;; Colorize once initially.
1472               (when colorize-initially-p
1473                 (let ((context-coloring-parse-interruptable-p nil))
1474                   (context-coloring-colorize)))))
1475         (when (null dispatch)
1476           (message "Context coloring is not available for this major mode"))))))
1477
1478 (provide 'context-coloring)
1479
1480 ;;; context-coloring.el ends here