X-Git-Url: https://code.delx.au/gnu-emacs-elpa/blobdiff_plain/5f6e9e79451c2c257678a099a796951a64f493a4..6ee448148df13dc0fa96e3cc3305fd00ea7c8be8:/packages/context-coloring/context-coloring.el diff --git a/packages/context-coloring/context-coloring.el b/packages/context-coloring/context-coloring.el index e5b5a73e5..fd7a81661 100644 --- a/packages/context-coloring/context-coloring.el +++ b/packages/context-coloring/context-coloring.el @@ -1,11 +1,11 @@ ;;; context-coloring.el --- Highlight by scope -*- lexical-binding: t; -*- -;; Copyright (C) 2014-2015 Free Software Foundation, Inc. +;; Copyright (C) 2014-2016 Free Software Foundation, Inc. ;; Author: Jackson Ray Hamilton -;; Version: 7.2.1 +;; Version: 8.0.1 ;; Keywords: convenience faces tools -;; Package-Requires: ((emacs "24.3") (js2-mode "20150713")) +;; Package-Requires: ((emacs "24.3")) ;; URL: https://github.com/jacksonrayhamilton/context-coloring ;; This file is part of GNU Emacs. @@ -34,8 +34,6 @@ ;;; Code: -(require 'js2-mode) - ;;; Utilities @@ -187,11 +185,6 @@ it ain't." :type 'float :group 'context-coloring) -(make-obsolete-variable - 'context-coloring-delay - 'context-coloring-default-delay - "6.4.0") - (defun context-coloring-cancel-timer (timer) "Cancel TIMER." (when timer @@ -241,12 +234,6 @@ it ain't." end `(face ,(context-coloring-bounded-level-face level)))) -(make-obsolete-variable - 'context-coloring-comments-and-strings - "use `context-coloring-syntactic-comments' and - `context-coloring-syntactic-strings' instead." - "6.1.0") - (defcustom context-coloring-syntactic-comments t "If non-nil, also color comments using `font-lock'." :type 'boolean @@ -265,9 +252,10 @@ it ain't." "Color a string according to STATE." (if (nth 3 state) font-lock-string-face nil)) -(defsubst context-coloring-colorize-comments-and-strings (&optional min max) +(defsubst context-coloring-colorize-comments-and-strings (&optional min max keywords-p) "Maybe color comments and strings in buffer from MIN to MAX. -MIN defaults to beginning of buffer. MAX defaults to end." +MIN defaults to beginning of buffer. MAX defaults to end. If +KEYWORDS-P is non-nil, also color keywords from MIN to MAX." (when (or context-coloring-syntactic-comments context-coloring-syntactic-strings) (let ((min (or min (point-min))) @@ -284,8 +272,7 @@ MIN defaults to beginning of buffer. MAX defaults to end." font-lock-syntactic-face-function)))) (save-excursion (font-lock-fontify-syntactically-region min max) - ;; TODO: Make configurable at the dispatch level. - (when (eq major-mode 'emacs-lisp-mode) + (when keywords-p (font-lock-fontify-keywords-region min max)))))) (defcustom context-coloring-initial-level 0 @@ -298,945 +285,17 @@ are scoped to a file (as in Node.js), set this to `1'." :group 'context-coloring) -;;; JavaScript colorization - -(defvar-local context-coloring-js2-scope-level-hash-table nil - "Associate `js2-scope' structures and with their scope - levels.") - -(defcustom context-coloring-javascript-block-scopes nil - "If non-nil, also color block scopes in the scope hierarchy in JavaScript. - -The block-scoped `let' and `const' are introduced in ES6. Enable -this for ES6 code; disable it elsewhere." - :type 'boolean - :safe #'booleanp - :group 'context-coloring) - -(make-obsolete-variable - 'context-coloring-js-block-scopes - 'context-coloring-javascript-block-scopes - "7.0.0") - -(defsubst context-coloring-js2-scope-level (scope initial) - "Return the level of SCOPE, starting from INITIAL." - (cond ((gethash scope context-coloring-js2-scope-level-hash-table)) - (t - (let ((level initial) - (current-scope scope) - enclosing-scope) - (while (and current-scope - (js2-node-parent current-scope) - (setq enclosing-scope - (js2-node-get-enclosing-scope current-scope))) - (when (or context-coloring-javascript-block-scopes - (let ((type (js2-scope-type current-scope))) - (or (= type js2-SCRIPT) - (= type js2-FUNCTION) - (= type js2-CATCH)))) - (setq level (+ level 1))) - (setq current-scope enclosing-scope)) - (puthash scope level context-coloring-js2-scope-level-hash-table))))) - -(defsubst context-coloring-js2-local-name-node-p (node) - "Determine if NODE represents a local variable." - (and (js2-name-node-p node) - (let ((parent (js2-node-parent node))) - (not (or (and (js2-object-prop-node-p parent) - (eq node (js2-object-prop-node-left parent))) - (and (js2-prop-get-node-p parent) - ;; For nested property lookup, the node on the left is a - ;; `js2-prop-get-node', so this always works. - (eq node (js2-prop-get-node-right parent)))))))) - -(defvar-local context-coloring-point-max nil - "Cached value of `point-max'.") - -(defsubst context-coloring-js2-colorize-node (node level) - "Color NODE with the color for LEVEL." - (let ((start (js2-node-abs-pos node))) - (context-coloring-colorize-region - start - (min - ;; End - (+ start (js2-node-len node)) - ;; Somes nodes (like the ast when there is an unterminated multiline - ;; comment) will stretch to the value of `point-max'. - context-coloring-point-max) - level))) - -(defun context-coloring-js2-colorize-ast () - "Color the buffer using the `js2-mode' abstract syntax tree." - ;; Reset the hash table; the old one could be obsolete. - (setq context-coloring-js2-scope-level-hash-table (make-hash-table :test #'eq)) - (setq context-coloring-point-max (point-max)) - (with-silent-modifications - (js2-visit-ast - js2-mode-ast - (lambda (node end-p) - (when (null end-p) - (cond - ((js2-scope-p node) - (context-coloring-js2-colorize-node - node - (context-coloring-js2-scope-level node context-coloring-initial-level))) - ((context-coloring-js2-local-name-node-p node) - (let* ((enclosing-scope (js2-node-get-enclosing-scope node)) - (defining-scope (js2-get-defining-scope - enclosing-scope - (js2-name-node-name node)))) - ;; The tree seems to be walked lexically, so an entire scope will - ;; be colored, including its name nodes, before they are reached. - ;; Coloring the nodes defined in that scope would be redundant, so - ;; don't do it. - (when (not (eq defining-scope enclosing-scope)) - (context-coloring-js2-colorize-node - node - ;; Use `0' as an initial level so global variables are always at - ;; the highest level (even if `context-coloring-initial-level' - ;; specifies an initial level for the rest of the code). - (context-coloring-js2-scope-level defining-scope 0)))))) - ;; The `t' indicates to search children. - t))) - (context-coloring-colorize-comments-and-strings))) - -(defconst context-coloring-node-comment-regexp - (concat - ;; Ensure the "//" or "/*" comment starts with the directive. - "\\(//[[:space:]]*\\|/\\*[[:space:]]*\\)" - ;; Support multiple directive formats. - "\\(" - ;; JSLint and JSHint support a JSON-like format. - "\\(jslint\\|jshint\\)[[:space:]].*?node:[[:space:]]*true" - "\\|" - ;; ESLint just specifies the option name. - "eslint-env[[:space:]].*?node" - "\\)") - "Match a comment body hinting at a Node.js program.") - -;; TODO: Add ES6 module detection. -(defun context-coloring-js2-top-level-local-p () - "Guess whether top-level variables are local. -For instance, the current file could be a Node.js program." - (or - ;; A shebang is a pretty obvious giveaway. - (string-equal - "node" - (save-excursion - (goto-char (point-min)) - (when (looking-at auto-mode-interpreter-regexp) - (match-string 2)))) - ;; Otherwise, perform static analysis. - (progn - (setq context-coloring-js2-scope-level-hash-table (make-hash-table :test #'eq)) - (catch 'node-program-p - (js2-visit-ast - js2-mode-ast - (lambda (node end-p) - (when (null end-p) - (when - (cond - ;; Infer based on inline linter configuration. - ((js2-comment-node-p node) - (string-match-p - context-coloring-node-comment-regexp - (js2-node-string node))) - ;; Infer based on the prescence of certain variables. - ((and (js2-name-node-p node) - (let ((parent (js2-node-parent node))) - (not (and (js2-object-prop-node-p parent) - (eq node (js2-object-prop-node-left parent)))))) - (let ((name (js2-name-node-name node)) - (parent (js2-node-parent node))) - (and - (cond - ;; Check whether this is "exports.something" or - ;; "module.exports". - ((js2-prop-get-node-p parent) - (and - (eq node (js2-prop-get-node-left parent)) - (or (string-equal name "exports") - (let* ((property (js2-prop-get-node-right parent)) - (property-name (js2-name-node-name property))) - (and (string-equal name "module") - (string-equal property-name "exports")))))) - ;; Check whether it's a "require('module')" call. - ((js2-call-node-p parent) - (or (string-equal name "require")))) - (let* ((enclosing-scope (js2-node-get-enclosing-scope node)) - (defining-scope (js2-get-defining-scope - enclosing-scope name))) - ;; The variable also must be global. - (null defining-scope)))))) - (throw 'node-program-p t)) - ;; The `t' indicates to search children. - t))) - ;; Default to returning nil from the catch body. - nil)))) - -(defcustom context-coloring-javascript-detect-top-level-scope t - "If non-nil, detect when to use file-level scope." - :type 'boolean - :group 'context-coloring) - -(defun context-coloring-js2-colorize () - "Color the buffer using the `js2-mode'." - (cond - ;; Increase the initial level if we should. - ((and context-coloring-javascript-detect-top-level-scope - (context-coloring-js2-top-level-local-p)) - (let ((context-coloring-initial-level 1)) - (context-coloring-js2-colorize-ast))) - (t - (context-coloring-js2-colorize-ast)))) - - -;;; Emacs Lisp colorization - -(defconst context-coloring-WORD-CODE 2) -(defconst context-coloring-SYMBOL-CODE 3) -(defconst context-coloring-OPEN-PARENTHESIS-CODE 4) -(defconst context-coloring-CLOSE-PARENTHESIS-CODE 5) -(defconst context-coloring-EXPRESSION-PREFIX-CODE 6) -(defconst context-coloring-STRING-QUOTE-CODE 7) -(defconst context-coloring-ESCAPE-CODE 9) -(defconst context-coloring-COMMENT-START-CODE 11) -(defconst context-coloring-COMMENT-END-CODE 12) - -(defconst context-coloring-OCTOTHORPE-CHAR (string-to-char "#")) -(defconst context-coloring-APOSTROPHE-CHAR (string-to-char "'")) -(defconst context-coloring-OPEN-PARENTHESIS-CHAR (string-to-char "(")) -(defconst context-coloring-COMMA-CHAR (string-to-char ",")) -(defconst context-coloring-AT-CHAR (string-to-char "@")) -(defconst context-coloring-BACKTICK-CHAR (string-to-char "`")) - -(defsubst context-coloring-get-syntax-code () - "Get the syntax code at point." - (syntax-class - ;; Faster version of `syntax-after': - (aref (syntax-table) (char-after (point))))) - -(defsubst context-coloring-forward-sws () - "Move forward through whitespace and comments." - (while (forward-comment 1))) - -(defsubst context-coloring-elisp-forward-sws () - "Move through whitespace and comments, coloring comments." - (let ((start (point))) - (context-coloring-forward-sws) - (context-coloring-colorize-comments-and-strings start (point)))) - -(defsubst context-coloring-elisp-forward-sexp () - "Skip/ignore missing sexps, coloring comments and strings." - (let ((start (point))) - (when (= (context-coloring-get-syntax-code) - context-coloring-EXPRESSION-PREFIX-CODE) - ;; `forward-sexp' does not skip an unfinished expression (e.g. when the - ;; name of a symbol or the parentheses of a list do not follow a single - ;; quote). - (forward-char)) - (condition-case nil - (forward-sexp) - (scan-error (context-coloring-forward-sws))) - (context-coloring-elisp-colorize-comments-and-strings-in-region - start (point)))) - -(defsubst context-coloring-exact-regexp (word) - "Create a regexp matching exactly WORD." - (concat "\\`" (regexp-quote word) "\\'")) - -(defsubst context-coloring-exact-or-regexp (words) - "Create a regexp matching any exact word in WORDS." - (context-coloring-join - (mapcar #'context-coloring-exact-regexp words) "\\|")) - -(defconst context-coloring-elisp-ignored-word-regexp - (context-coloring-join (list "\\`[-+]?[0-9]" - "\\`[&:].+" - (context-coloring-exact-or-regexp - '("t" "nil" "." "?"))) - "\\|") - "Match symbols that can't be bound as variables.") - -(defsubst context-coloring-elisp-identifier-p (syntax-code) - "Check if SYNTAX-CODE is an elisp identifier constituent." - (or (= syntax-code context-coloring-WORD-CODE) - (= syntax-code context-coloring-SYMBOL-CODE))) - -(defvar context-coloring-parse-interruptable-p t - "Set this to nil to force parse to continue until finished.") - -(defconst context-coloring-elisp-sexps-per-pause 350 - "Pause after this many iterations to check for user input. -If user input is pending, stop the parse. This makes for a -smoother user experience for large files. - -This number should trigger pausing at about 60 frames per -second.") - -(defvar context-coloring-elisp-sexp-count 0 - "Current number of sexps leading up to the next pause.") - -(defsubst context-coloring-elisp-increment-sexp-count () - "Maybe check if the user interrupted the current parse." - (setq context-coloring-elisp-sexp-count - (1+ context-coloring-elisp-sexp-count)) - (when (and (zerop (% context-coloring-elisp-sexp-count - context-coloring-elisp-sexps-per-pause)) - context-coloring-parse-interruptable-p - (input-pending-p)) - (throw 'interrupted t))) - -(defvar context-coloring-elisp-scope-stack '() - "List of scopes in the current parse.") - -(defsubst context-coloring-elisp-make-scope (level) - "Make a scope object for LEVEL." - (list - :level level - :variables '())) - -(defsubst context-coloring-elisp-scope-get-level (scope) - "Get the level of SCOPE object." - (plist-get scope :level)) - -(defsubst context-coloring-elisp-scope-add-variable (scope variable) - "Add to SCOPE a VARIABLE." - (plist-put scope :variables (cons variable (plist-get scope :variables)))) - -(defsubst context-coloring-elisp-scope-has-variable (scope variable) - "Check if SCOPE has VARIABLE." - (member variable (plist-get scope :variables))) - -(defsubst context-coloring-elisp-get-variable-level (variable) - "Return the level of VARIABLE, or 0 if it isn't found." - (let* ((scope-stack context-coloring-elisp-scope-stack) - scope - level) - (while (and scope-stack (not level)) - (setq scope (car scope-stack)) - (cond - ((context-coloring-elisp-scope-has-variable scope variable) - (setq level (context-coloring-elisp-scope-get-level scope))) - (t - (setq scope-stack (cdr scope-stack))))) - ;; Assume a global variable. - (or level 0))) - -(defsubst context-coloring-elisp-get-current-scope-level () - "Get the nesting level of the current scope." - (cond - ((car context-coloring-elisp-scope-stack) - (context-coloring-elisp-scope-get-level (car context-coloring-elisp-scope-stack))) - (t - 0))) - -(defsubst context-coloring-elisp-push-scope () - "Add a new scope to the bottom of the scope chain." - (push (context-coloring-elisp-make-scope - (1+ (context-coloring-elisp-get-current-scope-level))) - context-coloring-elisp-scope-stack)) - -(defsubst context-coloring-elisp-pop-scope () - "Remove the scope on the bottom of the scope chain." - (pop context-coloring-elisp-scope-stack)) - -(defsubst context-coloring-elisp-add-variable (variable) - "Add VARIABLE to the current scope." - (context-coloring-elisp-scope-add-variable - (car context-coloring-elisp-scope-stack) - variable)) - -(defsubst context-coloring-elisp-parse-bindable (callback) - "Parse the symbol at point. -If the symbol can be bound, invoke CALLBACK with it." - (let* ((arg-string (buffer-substring-no-properties - (point) - (progn (context-coloring-elisp-forward-sexp) - (point))))) - (when (not (string-match-p - context-coloring-elisp-ignored-word-regexp - arg-string)) - (funcall callback arg-string)))) - -(defun context-coloring-elisp-parse-let-varlist (type) - "Parse the list of variable initializers at point. -If TYPE is `let', all the variables are bound after all their -initializers are parsed; if TYPE is `let*', each variable is -bound immediately after its own initializer is parsed." - (let ((varlist '()) - syntax-code) - ;; Enter. - (forward-char) - (context-coloring-elisp-forward-sws) - (while (/= (setq syntax-code (context-coloring-get-syntax-code)) - context-coloring-CLOSE-PARENTHESIS-CODE) - (cond - ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE) - (forward-char) - (context-coloring-elisp-forward-sws) - (setq syntax-code (context-coloring-get-syntax-code)) - (when (context-coloring-elisp-identifier-p syntax-code) - (context-coloring-elisp-parse-bindable - (lambda (var) - (push var varlist))) - (context-coloring-elisp-forward-sws) - (setq syntax-code (context-coloring-get-syntax-code)) - (when (/= syntax-code context-coloring-CLOSE-PARENTHESIS-CODE) - (context-coloring-elisp-colorize-sexp))) - (context-coloring-elisp-forward-sws) - ;; Skip past the closing parenthesis. - (forward-char)) - ((context-coloring-elisp-identifier-p syntax-code) - (context-coloring-elisp-parse-bindable - (lambda (var) - (push var varlist)))) - (t - ;; Ignore artifacts. - (context-coloring-elisp-forward-sexp))) - (when (eq type 'let*) - (context-coloring-elisp-add-variable (pop varlist))) - (context-coloring-elisp-forward-sws)) - (when (eq type 'let) - (while varlist - (context-coloring-elisp-add-variable (pop varlist)))) - ;; Exit. - (forward-char))) - -(defun context-coloring-elisp-parse-arglist () - "Parse the list of function arguments at point." - (let (syntax-code) - ;; Enter. - (forward-char) - (context-coloring-elisp-forward-sws) - (while (/= (setq syntax-code (context-coloring-get-syntax-code)) - context-coloring-CLOSE-PARENTHESIS-CODE) - (cond - ((context-coloring-elisp-identifier-p syntax-code) - (context-coloring-elisp-parse-bindable - (lambda (arg) - (context-coloring-elisp-add-variable arg)))) - (t - ;; Ignore artifacts. - (context-coloring-elisp-forward-sexp))) - (context-coloring-elisp-forward-sws)) - ;; Exit. - (forward-char))) - -(defun context-coloring-elisp-skip-callee-name () - "Skip past the opening parenthesis and name of a function." - ;; Enter. - (forward-char) - (context-coloring-elisp-forward-sws) - ;; Skip past the function name. - (forward-sexp) - (context-coloring-elisp-forward-sws)) - -(defun context-coloring-elisp-colorize-scope (callback) - "Color the whole scope at point with its one color. -Handle a header in CALLBACK." - (let ((start (point)) - (end (progn (forward-sexp) - (point)))) - (context-coloring-elisp-push-scope) - ;; Splash the whole thing in one color. - (context-coloring-colorize-region - start - end - (context-coloring-elisp-get-current-scope-level)) - ;; Even if the parse is interrupted, this region should still be colored - ;; syntactically. - (context-coloring-elisp-colorize-comments-and-strings-in-region - start - end) - (goto-char start) - (context-coloring-elisp-skip-callee-name) - (funcall callback) - (context-coloring-elisp-colorize-region (point) (1- end)) - ;; Exit. - (forward-char) - (context-coloring-elisp-pop-scope))) - -(defun context-coloring-elisp-parse-header (callback) - "Parse a function header at point with CALLBACK." - (when (= (context-coloring-get-syntax-code) context-coloring-OPEN-PARENTHESIS-CODE) - (funcall callback))) - -(defun context-coloring-elisp-colorize-defun-like (callback) - "Color the defun-like function at point. -Parse the header with CALLBACK." - (context-coloring-elisp-colorize-scope - (lambda () - (when (context-coloring-elisp-identifier-p (context-coloring-get-syntax-code)) - ;; Color the defun's name with the top-level color. - (context-coloring-colorize-region - (point) - (progn (forward-sexp) - (point)) - 0) - (context-coloring-elisp-forward-sws) - (context-coloring-elisp-parse-header callback))))) - -(defun context-coloring-elisp-colorize-defun () - "Color the `defun' at point." - (context-coloring-elisp-colorize-defun-like - 'context-coloring-elisp-parse-arglist)) - -(defun context-coloring-elisp-colorize-defadvice () - "Color the `defadvice' at point." - (context-coloring-elisp-colorize-defun-like - (lambda () - (let (syntax-code) - ;; Enter. - (forward-char) - (context-coloring-elisp-forward-sws) - (while (/= (setq syntax-code (context-coloring-get-syntax-code)) - context-coloring-CLOSE-PARENTHESIS-CODE) - (cond - ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE) - (context-coloring-elisp-parse-arglist)) - (t - ;; Ignore artifacts. - (context-coloring-elisp-forward-sexp))) - (context-coloring-elisp-forward-sws)))))) - -(defun context-coloring-elisp-colorize-lambda-like (callback) - "Color the lambda-like function at point. -Parsing the header with CALLBACK." - (context-coloring-elisp-colorize-scope - (lambda () - (context-coloring-elisp-parse-header callback)))) - -(defun context-coloring-elisp-colorize-lambda () - "Color the `lambda' at point." - (context-coloring-elisp-colorize-lambda-like - 'context-coloring-elisp-parse-arglist)) - -(defun context-coloring-elisp-colorize-let () - "Color the `let' at point." - (context-coloring-elisp-colorize-lambda-like - (lambda () - (context-coloring-elisp-parse-let-varlist 'let)))) - -(defun context-coloring-elisp-colorize-let* () - "Color the `let*' at point." - (context-coloring-elisp-colorize-lambda-like - (lambda () - (context-coloring-elisp-parse-let-varlist 'let*)))) - -(defun context-coloring-elisp-colorize-macroexp-let2 () - "Color the `macroexp-let2' at point." - (let (syntax-code - variable) - (context-coloring-elisp-colorize-scope - (lambda () - (and - (progn - (setq syntax-code (context-coloring-get-syntax-code)) - (context-coloring-elisp-identifier-p syntax-code)) - (progn - (context-coloring-elisp-colorize-sexp) - (context-coloring-elisp-forward-sws) - (setq syntax-code (context-coloring-get-syntax-code)) - (context-coloring-elisp-identifier-p syntax-code)) - (progn - (context-coloring-elisp-parse-bindable - (lambda (parsed-variable) - (setq variable parsed-variable))) - (context-coloring-elisp-forward-sws) - (when variable - (context-coloring-elisp-add-variable variable)))))))) - -(defun context-coloring-elisp-colorize-cond () - "Color the `cond' at point." - (let (syntax-code) - (context-coloring-elisp-skip-callee-name) - (while (/= (setq syntax-code (context-coloring-get-syntax-code)) - context-coloring-CLOSE-PARENTHESIS-CODE) - (cond - ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE) - ;; Colorize inside the parens. - (let ((start (point))) - (forward-sexp) - (context-coloring-elisp-colorize-region - (1+ start) (1- (point))) - ;; Exit. - (forward-char))) - (t - ;; Ignore artifacts. - (context-coloring-elisp-forward-sexp))) - (context-coloring-elisp-forward-sws)) - ;; Exit. - (forward-char))) - -(defun context-coloring-elisp-colorize-condition-case () - "Color the `condition-case' at point." - (let (syntax-code - variable - case-pos - case-end) - (context-coloring-elisp-colorize-scope - (lambda () - (setq syntax-code (context-coloring-get-syntax-code)) - ;; Gracefully ignore missing variables. - (when (context-coloring-elisp-identifier-p syntax-code) - (context-coloring-elisp-parse-bindable - (lambda (parsed-variable) - (setq variable parsed-variable))) - (context-coloring-elisp-forward-sws)) - (context-coloring-elisp-colorize-sexp) - (context-coloring-elisp-forward-sws) - ;; Parse the handlers with the error variable in scope. - (when variable - (context-coloring-elisp-add-variable variable)) - (while (/= (setq syntax-code (context-coloring-get-syntax-code)) - context-coloring-CLOSE-PARENTHESIS-CODE) - (cond - ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE) - (setq case-pos (point)) - (context-coloring-elisp-forward-sexp) - (setq case-end (point)) - (goto-char case-pos) - ;; Enter. - (forward-char) - (context-coloring-elisp-forward-sws) - (setq syntax-code (context-coloring-get-syntax-code)) - (when (/= syntax-code context-coloring-CLOSE-PARENTHESIS-CODE) - ;; Skip the condition name(s). - (context-coloring-elisp-forward-sexp) - ;; Color the remaining portion of the handler. - (context-coloring-elisp-colorize-region - (point) - (1- case-end))) - ;; Exit. - (forward-char)) - (t - ;; Ignore artifacts. - (context-coloring-elisp-forward-sexp))) - (context-coloring-elisp-forward-sws)))))) - -(defun context-coloring-elisp-colorize-dolist () - "Color the `dolist' at point." - (let (syntax-code - (index 0)) - (context-coloring-elisp-colorize-scope - (lambda () - (setq syntax-code (context-coloring-get-syntax-code)) - (when (= syntax-code context-coloring-OPEN-PARENTHESIS-CODE) - (forward-char) - (context-coloring-elisp-forward-sws) - (while (/= (setq syntax-code (context-coloring-get-syntax-code)) - context-coloring-CLOSE-PARENTHESIS-CODE) - (cond - ((and - (or (= index 0) (= index 2)) - (context-coloring-elisp-identifier-p syntax-code)) - ;; Add the first or third name to the scope. - (context-coloring-elisp-parse-bindable - (lambda (variable) - (context-coloring-elisp-add-variable variable)))) - (t - ;; Color artifacts. - (context-coloring-elisp-colorize-sexp))) - (context-coloring-elisp-forward-sws) - (setq index (1+ index))) - ;; Exit. - (forward-char)))))) - -(defun context-coloring-elisp-colorize-quote () - "Color the `quote' at point." - (let* ((start (point)) - (end (progn (forward-sexp) - (point)))) - (context-coloring-colorize-region - start - end - (context-coloring-elisp-get-current-scope-level)) - (context-coloring-elisp-colorize-comments-and-strings-in-region start end))) - -(defvar context-coloring-elisp-callee-dispatch-hash-table - (let ((table (make-hash-table :test 'equal))) - (dolist (callee '("defun" "defun*" "defsubst" "defmacro" "cl-defun" "cl-defsubst" "cl-defmacro")) - (puthash callee #'context-coloring-elisp-colorize-defun table)) - (dolist (callee '("condition-case" "condition-case-unless-debug")) - (puthash callee #'context-coloring-elisp-colorize-condition-case table)) - (dolist (callee '("dolist" "dotimes")) - (puthash callee #'context-coloring-elisp-colorize-dolist table)) - (dolist (callee '("let" "gv-letplace")) - (puthash callee #'context-coloring-elisp-colorize-let table)) - (puthash "let*" #'context-coloring-elisp-colorize-let* table) - (puthash "macroexp-let2" #'context-coloring-elisp-colorize-macroexp-let2 table) - (puthash "lambda" #'context-coloring-elisp-colorize-lambda table) - (puthash "cond" #'context-coloring-elisp-colorize-cond table) - (puthash "defadvice" #'context-coloring-elisp-colorize-defadvice table) - (puthash "quote" #'context-coloring-elisp-colorize-quote table) - (puthash "backquote" #'context-coloring-elisp-colorize-backquote table) - table) - "Map function names to their coloring functions.") - -(defun context-coloring-elisp-colorize-parenthesized-sexp () - "Color the sexp enclosed by parenthesis at point." - (context-coloring-elisp-increment-sexp-count) - (let* ((start (point)) - (end (progn (forward-sexp) - (point))) - (syntax-code (progn (goto-char start) - (forward-char) - ;; Coloring is unnecessary here, it'll happen - ;; presently. - (context-coloring-forward-sws) - (context-coloring-get-syntax-code))) - dispatch-function) - ;; Figure out if the sexp is a special form. - (cond - ((and (context-coloring-elisp-identifier-p syntax-code) - (setq dispatch-function (gethash - (buffer-substring-no-properties - (point) - (progn (forward-sexp) - (point))) - context-coloring-elisp-callee-dispatch-hash-table))) - (goto-char start) - (funcall dispatch-function)) - ;; Not a special form; just colorize the remaining region. - (t - (context-coloring-colorize-region - start - end - (context-coloring-elisp-get-current-scope-level)) - (context-coloring-elisp-colorize-region (point) (1- end)) - (forward-char))))) - -(defun context-coloring-elisp-colorize-symbol () - "Color the symbol at point." - (context-coloring-elisp-increment-sexp-count) - (let* ((symbol-pos (point)) - (symbol-end (progn (forward-sexp) - (point))) - (symbol-string (buffer-substring-no-properties - symbol-pos - symbol-end))) - (cond - ((string-match-p context-coloring-elisp-ignored-word-regexp symbol-string)) - (t - (context-coloring-colorize-region - symbol-pos - symbol-end - (context-coloring-elisp-get-variable-level - symbol-string)))))) - -(defun context-coloring-elisp-colorize-backquote-form () - "Color the backquote form at point." - (let ((start (point)) - (end (progn (forward-sexp) - (point))) - char) - (goto-char start) - (while (> end (progn (forward-char) - (point))) - (setq char (char-after)) - (when (= char context-coloring-COMMA-CHAR) - (forward-char) - (when (= (char-after) context-coloring-AT-CHAR) - ;; If we don't do this "@" could be interpreted as a symbol. - (forward-char)) - (context-coloring-elisp-forward-sws) - (context-coloring-elisp-colorize-sexp))) - ;; We could probably do this as part of the above loop but it'd be - ;; repetitive. - (context-coloring-elisp-colorize-comments-and-strings-in-region - start end))) - -(defun context-coloring-elisp-colorize-backquote () - "Color the `backquote' at point." - (context-coloring-elisp-skip-callee-name) - (context-coloring-elisp-colorize-backquote-form) - ;; Exit. - (forward-char)) - -(defun context-coloring-elisp-colorize-expression-prefix () - "Color the expression prefix and expression at point. -It could be a quoted or backquoted expression." - (context-coloring-elisp-increment-sexp-count) - (cond - ((/= (char-after) context-coloring-BACKTICK-CHAR) - (context-coloring-elisp-forward-sexp)) - (t - (context-coloring-elisp-colorize-backquote-form)))) - -(defun context-coloring-elisp-colorize-comment () - "Color the comment at point." - (context-coloring-elisp-increment-sexp-count) - (context-coloring-elisp-forward-sws)) - -(defun context-coloring-elisp-colorize-string () - "Color the string at point." - (context-coloring-elisp-increment-sexp-count) - (let ((start (point))) - (forward-sexp) - (context-coloring-colorize-comments-and-strings start (point)))) - -;; Elisp has whitespace, words, symbols, open/close parenthesis, expression -;; prefix, string quote, comment starters/enders and escape syntax classes only. - -(defun context-coloring-elisp-colorize-sexp () - "Color the sexp at point." - (let ((syntax-code (context-coloring-get-syntax-code))) - (cond - ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE) - (context-coloring-elisp-colorize-parenthesized-sexp)) - ((context-coloring-elisp-identifier-p syntax-code) - (context-coloring-elisp-colorize-symbol)) - ((= syntax-code context-coloring-EXPRESSION-PREFIX-CODE) - (context-coloring-elisp-colorize-expression-prefix)) - ((= syntax-code context-coloring-STRING-QUOTE-CODE) - (context-coloring-elisp-colorize-string)) - ((= syntax-code context-coloring-ESCAPE-CODE) - (forward-char 2))))) - -(defun context-coloring-elisp-colorize-comments-and-strings-in-region (start end) - "Color comments and strings between START and END." - (let (syntax-code) - (goto-char start) - (while (> end (progn (skip-syntax-forward "^\"<\\" end) - (point))) - (setq syntax-code (context-coloring-get-syntax-code)) - (cond - ((= syntax-code context-coloring-STRING-QUOTE-CODE) - (context-coloring-elisp-colorize-string)) - ((= syntax-code context-coloring-COMMENT-START-CODE) - (context-coloring-elisp-colorize-comment)) - ((= syntax-code context-coloring-ESCAPE-CODE) - (forward-char 2)))))) - -(defun context-coloring-elisp-colorize-region (start end) - "Color everything between START and END." - (let (syntax-code) - (goto-char start) - (while (> end (progn (skip-syntax-forward "^w_('\"<\\" end) - (point))) - (setq syntax-code (context-coloring-get-syntax-code)) - (cond - ((= syntax-code context-coloring-OPEN-PARENTHESIS-CODE) - (context-coloring-elisp-colorize-parenthesized-sexp)) - ((context-coloring-elisp-identifier-p syntax-code) - (context-coloring-elisp-colorize-symbol)) - ((= syntax-code context-coloring-EXPRESSION-PREFIX-CODE) - (context-coloring-elisp-colorize-expression-prefix)) - ((= syntax-code context-coloring-STRING-QUOTE-CODE) - (context-coloring-elisp-colorize-string)) - ((= syntax-code context-coloring-COMMENT-START-CODE) - (context-coloring-elisp-colorize-comment)) - ((= syntax-code context-coloring-ESCAPE-CODE) - (forward-char 2)))))) - -(defun context-coloring-elisp-colorize-region-initially (start end) - "Begin coloring everything between START and END." - (setq context-coloring-elisp-sexp-count 0) - (setq context-coloring-elisp-scope-stack '()) - (let ((inhibit-point-motion-hooks t) - (case-fold-search nil) - ;; This is a recursive-descent parser, so give it a big stack. - (max-lisp-eval-depth (max max-lisp-eval-depth 3000)) - (max-specpdl-size (max max-specpdl-size 3000))) - (context-coloring-elisp-colorize-region start end))) - -(defun context-coloring-elisp-colorize-guard (callback) - "Silently color in CALLBACK." - (with-silent-modifications - (save-excursion - (condition-case nil - (funcall callback) - ;; Scan errors can happen virtually anywhere if parenthesis are - ;; unbalanced. Just swallow them. (`progn' for test coverage.) - (scan-error (progn)))))) - -(defun context-coloring-elisp-colorize () - "Color the current Emacs Lisp buffer." - (interactive) - (context-coloring-elisp-colorize-guard - (lambda () - (cond - ;; Just colorize the changed region. - (context-coloring-changed-p - (let* ( ;; Prevent `beginning-of-defun' from making poor assumptions. - (open-paren-in-column-0-is-defun-start nil) - ;; Seek the beginning and end of the previous and next - ;; offscreen defuns, so just enough is colored. - (start (progn (goto-char context-coloring-changed-start) - (while (and (< (point-min) (point)) - (pos-visible-in-window-p)) - (end-of-line 0)) - (beginning-of-defun) - (point))) - (end (progn (goto-char context-coloring-changed-end) - (while (and (> (point-max) (point)) - (pos-visible-in-window-p)) - (forward-line 1)) - (end-of-defun) - (point)))) - (context-coloring-elisp-colorize-region-initially start end) - ;; Fast coloring is nice, but if the code is not well-formed - ;; (e.g. an unclosed string literal is parsed at any time) then - ;; there could be leftover incorrectly-colored code offscreen. So - ;; do a clean sweep as soon as appropriate. - (context-coloring-schedule-coloring context-coloring-default-delay))) - (t - (context-coloring-elisp-colorize-region-initially (point-min) (point-max))))))) - - -;;; eval-expression colorization - -(defun context-coloring-eval-expression-match () - "Determine expression start in `eval-expression'." - (string-match "\\`Eval: " (buffer-string))) - -(defun context-coloring-eval-expression-colorize () - "Color the `eval-expression' minibuffer prompt as elisp." - (interactive) - (context-coloring-elisp-colorize-guard - (lambda () - (context-coloring-elisp-colorize-region-initially - (progn - (context-coloring-eval-expression-match) - (1+ (match-end 0))) - (point-max))))) - - ;;; Dispatch +;;;###autoload (defvar context-coloring-dispatch-hash-table (make-hash-table :test #'eq) - "Map dispatch strategy names to their property lists.") - -(defvar context-coloring-mode-hash-table (make-hash-table :test #'eq) - "Map major mode names to dispatch property lists.") - -(defvar context-coloring-dispatch-predicates '() - "Functions which may return a dispatch.") - -(defun context-coloring-get-current-dispatch () - "Return the first dispatch appropriate for the current state." - (let ((predicates context-coloring-dispatch-predicates) - (parent major-mode) - dispatch) - ;; Maybe a predicate will be satisfied and return a dispatch. - (while (and predicates - (not (setq dispatch (funcall (pop predicates)))))) - ;; If not, maybe a major mode (or a derivative) will define a dispatch. - (when (not dispatch) - (while (and parent - (not (setq dispatch (gethash parent context-coloring-mode-hash-table))) - (setq parent (get parent 'derived-mode-parent))))) - dispatch)) - -(defun context-coloring-define-dispatch (symbol &rest properties) - "Define a new dispatch named SYMBOL with PROPERTIES. + "Map dispatch strategy names to their property lists. A \"dispatch\" is a property list describing a strategy for coloring a buffer. -PROPERTIES must include one of `:modes' or `:predicate', and a -`:colorizer'. +Its properties must include one of `:modes' or `:predicate', and +a `:colorizer'. `:modes' - List of major modes this dispatch is valid for. @@ -1252,28 +311,48 @@ override `context-coloring-default-delay'. `context-coloring-mode' is enabled. `:teardown' - Arbitrary code to tear down this dispatch when -`context-coloring-mode' is disabled." - (let ((modes (plist-get properties :modes)) - (predicate (plist-get properties :predicate)) - (colorizer (plist-get properties :colorizer))) - (when (null (or modes predicate)) - (error "No mode or predicate defined for dispatch")) - (when (not colorizer) - (error "No colorizer defined for dispatch")) - (puthash symbol properties context-coloring-dispatch-hash-table) - (dolist (mode modes) - (puthash mode properties context-coloring-mode-hash-table)) - (when predicate - (push (lambda () - (when (funcall predicate) - properties)) context-coloring-dispatch-predicates)))) +`context-coloring-mode' is disabled.") + +(defun context-coloring-find-dispatch (predicate) + "Find the first dispatch satisfying PREDICATE." + (let (found) + (maphash + (lambda (_ dispatch) + (when (and (not found) + (funcall predicate dispatch)) + (setq found dispatch))) + context-coloring-dispatch-hash-table) + found)) + +(defun context-coloring-get-current-dispatch () + "Return the first dispatch appropriate for the current state." + (cond + ;; Maybe a predicate will be satisfied. + ((context-coloring-find-dispatch + (lambda (dispatch) + (let ((predicate (plist-get dispatch :predicate))) + (and predicate (funcall predicate)))))) + ;; If not, maybe a major mode (or a derivative) will. + ((context-coloring-find-dispatch + (lambda (dispatch) + (let ((modes (plist-get dispatch :modes)) + match) + (while (and modes (not match)) + (setq match (eq (pop modes) major-mode))) + match)))))) + +(defun context-coloring-before-colorize () + "Set up environment for colorization." + (context-coloring-update-maximum-face)) (defun context-coloring-dispatch () "Determine how to color the current buffer, and color it." (let* ((dispatch (context-coloring-get-current-dispatch)) (colorizer (plist-get dispatch :colorizer))) - (catch 'interrupted - (funcall colorizer)))) + (context-coloring-before-colorize) + (when colorizer + (catch 'interrupted + (funcall colorizer))))) ;;; Colorization @@ -1281,7 +360,6 @@ override `context-coloring-default-delay'. (defun context-coloring-colorize () "Color the current buffer by function context." (interactive) - (context-coloring-update-maximum-face) (context-coloring-dispatch)) (defun context-coloring-colorize-with-buffer (buffer) @@ -1292,42 +370,7 @@ override `context-coloring-default-delay'. (context-coloring-colorize)))) -;;; Built-in dispatches - -(context-coloring-define-dispatch - 'javascript - :modes '(js2-mode) - :colorizer #'context-coloring-js2-colorize - :setup - (lambda () - (add-hook 'js2-post-parse-callbacks #'context-coloring-colorize nil t)) - :teardown - (lambda () - (remove-hook 'js2-post-parse-callbacks #'context-coloring-colorize t))) - -(context-coloring-define-dispatch - 'emacs-lisp - :modes '(emacs-lisp-mode) - :colorizer #'context-coloring-elisp-colorize - :delay 0.016 ;; Thanks to lazy colorization this can be 60 frames per second. - :setup #'context-coloring-setup-idle-change-detection - :teardown #'context-coloring-teardown-idle-change-detection) - -;; `eval-expression-minibuffer-setup-hook' is not available in Emacs 24.3, so -;; the backwards-compatible recommendation is to use `minibuffer-setup-hook' and -;; rely on this predicate instead. -(defun context-coloring-eval-expression-predicate () - "Non-nil if the minibuffer is for `eval-expression'." - ;; Kinda better than checking `this-command', because `this-command' changes. - (context-coloring-eval-expression-match)) - -(context-coloring-define-dispatch - 'eval-expression - :predicate #'context-coloring-eval-expression-predicate - :colorizer #'context-coloring-eval-expression-colorize - :delay 0.016 - :setup #'context-coloring-setup-idle-change-detection - :teardown #'context-coloring-teardown-idle-change-detection) +;;; Minor mode (defvar context-coloring-ignore-unavailable-predicates (list @@ -1345,8 +388,8 @@ permissible.") (setq ignore-p (funcall (pop predicates)))) ignore-p)) - -;;; Minor mode +(defvar context-coloring-interruptable-p t + "When non-nil, coloring may be interrupted by user input.") ;;;###autoload (define-minor-mode context-coloring-mode @@ -1376,21 +419,20 @@ Feature inspired by Douglas Crockford." nil " Context" nil (cond (context-coloring-mode - ;; Font lock is incompatible with this mode; the converse is also true. - (font-lock-mode 0) - (jit-lock-mode nil) - ;; ...but we do use font-lock functions here. - (font-lock-set-defaults) - ;; Safely change the value of this function as necessary. - (make-local-variable 'font-lock-syntactic-face-function) (let ((dispatch (context-coloring-get-current-dispatch))) (cond (dispatch + ;; Font lock is incompatible with this mode; the converse is also true. + (font-lock-mode 0) + ;; ...but we do use font-lock functions here. + (font-lock-set-defaults) + ;; Safely change the value of this function as necessary. + (make-local-variable 'font-lock-syntactic-face-function) (let ((setup (plist-get dispatch :setup))) (when setup (funcall setup)) ;; Colorize once initially. - (let ((context-coloring-parse-interruptable-p nil)) + (let ((context-coloring-interruptable-p nil)) (context-coloring-colorize)))) ((not (context-coloring-ignore-unavailable-message-p)) (message "Context coloring is unavailable here"))))) @@ -1400,8 +442,7 @@ Feature inspired by Douglas Crockford." (let ((teardown (plist-get dispatch :teardown))) (when teardown (funcall teardown))))) - (font-lock-mode) - (jit-lock-mode t)))) + (turn-on-font-lock-if-desired)))) (provide 'context-coloring)