lisp/hi-lock.el

   1 ;;; hi-lock.el --- minor mode for interactive automatic highlighting
   2
   3 ;; Copyright (C) 2000-2012 Free Software Foundation, Inc.
   4
   5 ;; Author: David M. Koppelman <koppel@ece.lsu.edu>
   6 ;; Keywords: faces, minor-mode, matching, display
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24 ;;
  25 ;;  With the hi-lock commands text matching interactively entered
  26 ;;  regexp's can be highlighted.  For example, `M-x highlight-regexp
  27 ;;  RET clearly RET RET' will highlight all occurrences of `clearly'
  28 ;;  using a yellow background face.  New occurrences of `clearly' will
  29 ;;  be highlighted as they are typed.  `M-x unhighlight-regexp RET'
  30 ;;  will remove the highlighting.  Any existing face can be used for
  31 ;;  highlighting and a set of appropriate faces is provided.  The
  32 ;;  regexps can be written into the current buffer in a form that will
  33 ;;  be recognized the next time the corresponding file is read (when
  34 ;;  file patterns is turned on).
  35 ;;
  36 ;;  Applications:
  37 ;;
  38 ;;    In program source code highlight a variable to quickly see all
  39 ;;    places it is modified or referenced:
  40 ;;    M-x highlight-regexp ground_contact_switches_closed RET RET
  41 ;;
  42 ;;    In a shell or other buffer that is showing lots of program
  43 ;;    output, highlight the parts of the output you're interested in:
  44 ;;    M-x highlight-regexp Total execution time [0-9]+ RET hi-blue-b RET
  45 ;;
  46 ;;    In buffers displaying tables, highlight the lines you're interested in:
  47 ;;    M-x highlight-lines-matching-regexp January 2000 RET hi-black-b RET
  48 ;;
  49 ;;    When writing text, highlight personal cliches.  This can be
  50 ;;    amusing.
  51 ;;    M-x highlight-phrase as can be seen RET RET
  52 ;;
  53 ;;  Setup:
  54 ;;
  55 ;;    Put the following code in your init file.  This turns on
  56 ;;    hi-lock mode and adds a "Regexp Highlighting" entry
  57 ;;    to the edit menu.
  58 ;;
  59 ;;    (global-hi-lock-mode 1)
  60 ;;
  61 ;;    To enable the use of patterns found in files (presumably placed
  62 ;;    there by hi-lock) include the following in your init file:
  63 ;;
  64 ;;    (setq hi-lock-file-patterns-policy 'ask)
  65 ;;
  66 ;;    If you get tired of being asked each time a file is loaded replace
  67 ;;    `ask' with a function that returns t if patterns should be read.
  68 ;;
  69 ;;    You might also want to bind the hi-lock commands to more
  70 ;;    finger-friendly sequences:
  71
  72 ;;    (define-key hi-lock-map "\C-z\C-h" 'highlight-lines-matching-regexp)
  73 ;;    (define-key hi-lock-map "\C-zi" 'hi-lock-find-patterns)
  74 ;;    (define-key hi-lock-map "\C-zh" 'highlight-regexp)
  75 ;;    (define-key hi-lock-map "\C-zp" 'highlight-phrase)
  76 ;;    (define-key hi-lock-map "\C-zr" 'unhighlight-regexp)
  77 ;;    (define-key hi-lock-map "\C-zb" 'hi-lock-write-interactive-patterns))
  78
  79 ;;    See the documentation for hi-lock-mode `C-h f hi-lock-mode' for
  80 ;;    additional instructions.
  81
  82 ;; Sample file patterns:
  83
  84 ; Hi-lock: (("^;;; .*" (0 (quote hi-black-hb) t)))
  85 ; Hi-lock: ( ("make-variable-buffer-\\(local\\)" (0 font-lock-keyword-face)(1 'italic append)))))
  86 ; Hi-lock: end
  87
  88 ;;; Code:
  89
  90 (require 'font-lock)
  91
  92 (defgroup hi-lock nil
  93   "Interactively add and remove font-lock patterns for highlighting text."
  94   :link '(custom-manual "(emacs)Highlight Interactively")
  95   :group 'font-lock)
  96
  97 (defcustom hi-lock-file-patterns-range 10000
  98   "Limit of search in a buffer for hi-lock patterns.
  99 When a file is visited and hi-lock mode is on, patterns starting
 100 up to this limit are added to font-lock's patterns.  See documentation
 101 of functions `hi-lock-mode' and `hi-lock-find-patterns'."
 102   :type 'integer
 103   :group 'hi-lock)
 104
 105 (defcustom hi-lock-highlight-range 200000
 106   "Size of area highlighted by hi-lock when font-lock not active.
 107 Font-lock is not active in buffers that do their own highlighting,
 108 such as the buffer created by `list-colors-display'.  In those buffers
 109 hi-lock patterns will only be applied over a range of
 110 `hi-lock-highlight-range' characters.  If font-lock is active then
 111 highlighting will be applied throughout the buffer."
 112   :type 'integer
 113   :group 'hi-lock)
 114
 115 (defcustom hi-lock-exclude-modes
 116   '(rmail-mode mime/viewer-mode gnus-article-mode)
 117   "List of major modes in which hi-lock will not run.
 118 For security reasons since font lock patterns can specify function
 119 calls."
 120   :type '(repeat symbol)
 121   :group 'hi-lock)
 122
 123 (defcustom hi-lock-file-patterns-policy 'ask
 124   "Specify when hi-lock should use patterns found in file.
 125 If `ask', prompt when patterns found in buffer; if bound to a function,
 126 use patterns when function returns t (function is called with patterns
 127 as first argument); if nil or `never' or anything else, don't use file
 128 patterns."
 129   :type '(choice (const :tag "Do not use file patterns" never)
 130                  (const :tag "Ask about file patterns" ask)
 131                  (function :tag "Function to check file patterns"))
 132   :group 'hi-lock
 133   :version "22.1")
 134
 135 ;; It can have a function value.
 136 (put 'hi-lock-file-patterns-policy 'risky-local-variable t)
 137
 138 (defgroup hi-lock-faces nil
 139   "Faces for hi-lock."
 140   :group 'hi-lock
 141   :group 'faces)
 142
 143 (defface hi-yellow
 144   '((((min-colors 88) (background dark))
 145      (:background "yellow1" :foreground "black"))
 146     (((background dark)) (:background "yellow" :foreground "black"))
 147     (((min-colors 88)) (:background "yellow1"))
 148     (t (:background "yellow")))
 149   "Default face for hi-lock mode."
 150   :group 'hi-lock-faces)
 151
 152 (defface hi-pink
 153   '((((background dark)) (:background "pink" :foreground "black"))
 154     (t (:background "pink")))
 155   "Face for hi-lock mode."
 156   :group 'hi-lock-faces)
 157
 158 (defface hi-green
 159   '((((min-colors 88) (background dark))
 160      (:background "green1" :foreground "black"))
 161     (((background dark)) (:background "green" :foreground "black"))
 162     (((min-colors 88)) (:background "green1"))
 163     (t (:background "green")))
 164   "Face for hi-lock mode."
 165   :group 'hi-lock-faces)
 166
 167 (defface hi-blue
 168   '((((background dark)) (:background "light blue" :foreground "black"))
 169     (t (:background "light blue")))
 170   "Face for hi-lock mode."
 171   :group 'hi-lock-faces)
 172
 173 (defface hi-black-b
 174   '((t (:weight bold)))
 175   "Face for hi-lock mode."
 176   :group 'hi-lock-faces)
 177
 178 (defface hi-blue-b
 179   '((((min-colors 88)) (:weight bold :foreground "blue1"))
 180     (t (:weight bold :foreground "blue")))
 181   "Face for hi-lock mode."
 182   :group 'hi-lock-faces)
 183
 184 (defface hi-green-b
 185   '((((min-colors 88)) (:weight bold :foreground "green1"))
 186     (t (:weight bold :foreground "green")))
 187   "Face for hi-lock mode."
 188   :group 'hi-lock-faces)
 189
 190 (defface hi-red-b
 191   '((((min-colors 88)) (:weight bold :foreground "red1"))
 192     (t (:weight bold :foreground "red")))
 193   "Face for hi-lock mode."
 194   :group 'hi-lock-faces)
 195
 196 (defface hi-black-hb
 197   '((t (:weight bold :height 1.67 :inherit variable-pitch)))
 198   "Face for hi-lock mode."
 199   :group 'hi-lock-faces)
 200
 201 (defvar hi-lock-file-patterns nil
 202   "Patterns found in file for hi-lock.  Should not be changed.")
 203
 204 (defvar hi-lock-interactive-patterns nil
 205   "Patterns provided to hi-lock by user.  Should not be changed.")
 206
 207 (define-obsolete-variable-alias 'hi-lock-face-history
 208                                 'hi-lock-face-defaults "23.1")
 209 (defvar hi-lock-face-defaults
 210   '("hi-yellow" "hi-pink" "hi-green" "hi-blue" "hi-black-b"
 211     "hi-blue-b" "hi-red-b" "hi-green-b" "hi-black-hb")
 212   "Default faces for hi-lock interactive functions.")
 213
 214 ;;(dolist (f hi-lock-face-defaults)
 215 ;;  (unless (facep f) (error "%s not a face" f)))
 216
 217 (define-obsolete-variable-alias 'hi-lock-regexp-history
 218                                 'regexp-history
 219                                 "23.1")
 220
 221 (defvar hi-lock-file-patterns-prefix "Hi-lock"
 222   "Search target for finding hi-lock patterns at top of file.")
 223
 224 (defvar hi-lock-archaic-interface-message-used nil
 225   "True if user alerted that `global-hi-lock-mode' is now the global switch.
 226 Earlier versions of hi-lock used `hi-lock-mode' as the global switch;
 227 the message is issued if it appears that `hi-lock-mode' is used assuming
 228 that older functionality.  This variable avoids multiple reminders.")
 229
 230 (defvar hi-lock-archaic-interface-deduce nil
 231   "If non-nil, sometimes assume that `hi-lock-mode' means `global-hi-lock-mode'.
 232 Assumption is made if `hi-lock-mode' used in the *scratch* buffer while
 233 a library is being loaded.")
 234
 235 (make-variable-buffer-local 'hi-lock-interactive-patterns)
 236 (put 'hi-lock-interactive-patterns 'permanent-local t)
 237 (make-variable-buffer-local 'hi-lock-file-patterns)
 238 (put 'hi-lock-file-patterns 'permanent-local t)
 239
 240 (defvar hi-lock-menu
 241   (let ((map (make-sparse-keymap "Hi Lock")))
 242     (define-key-after map [highlight-regexp]
 243       '(menu-item "Highlight Regexp..." highlight-regexp
 244         :help "Highlight text matching PATTERN (a regexp)."))
 245
 246     (define-key-after map [highlight-phrase]
 247       '(menu-item "Highlight Phrase..." highlight-phrase
 248         :help "Highlight text matching PATTERN (a regexp processed to match phrases)."))
 249
 250     (define-key-after map [highlight-lines-matching-regexp]
 251       '(menu-item "Highlight Lines..." highlight-lines-matching-regexp
 252         :help "Highlight lines containing match of PATTERN (a regexp)."))
 253
 254     (define-key-after map [unhighlight-regexp]
 255       '(menu-item "Remove Highlighting..." unhighlight-regexp
 256         :help "Remove previously entered highlighting pattern."
 257         :enable hi-lock-interactive-patterns))
 258
 259     (define-key-after map [hi-lock-write-interactive-patterns]
 260       '(menu-item "Patterns to Buffer" hi-lock-write-interactive-patterns
 261         :help "Insert interactively added REGEXPs into buffer at point."
 262         :enable hi-lock-interactive-patterns))
 263
 264     (define-key-after map [hi-lock-find-patterns]
 265       '(menu-item "Patterns from Buffer" hi-lock-find-patterns
 266         :help "Use patterns (if any) near top of buffer."))
 267     map)
 268   "Menu for hi-lock mode.")
 269
 270 (defvar hi-lock-map
 271   (let ((map (make-sparse-keymap "Hi Lock")))
 272     (define-key map "\C-xwi" 'hi-lock-find-patterns)
 273     (define-key map "\C-xwl" 'highlight-lines-matching-regexp)
 274     (define-key map "\C-xwp" 'highlight-phrase)
 275     (define-key map "\C-xwh" 'highlight-regexp)
 276     (define-key map "\C-xwr" 'unhighlight-regexp)
 277     (define-key map "\C-xwb" 'hi-lock-write-interactive-patterns)
 278     map)
 279   "Key map for hi-lock.")
 280
 281 ;; Visible Functions
 282
 283 ;;;###autoload
 284 (define-minor-mode hi-lock-mode
 285   "Toggle selective highlighting of patterns (Hi Lock mode).
 286 With a prefix argument ARG, enable Hi Lock mode if ARG is
 287 positive, and disable it otherwise.  If called from Lisp, enable
 288 the mode if ARG is omitted or nil.
 289
 290 Hi Lock mode is automatically enabled when you invoke any of the
 291 highlighting commands listed below, such as \\[highlight-regexp].
 292 To enable Hi Lock mode in all buffers, use `global-hi-lock-mode'
 293 or add (global-hi-lock-mode 1) to your init file.
 294
 295 In buffers where Font Lock mode is enabled, patterns are
 296 highlighted using font lock.  In buffers where Font Lock mode is
 297 disabled, patterns are applied using overlays; in this case, the
 298 highlighting will not be updated as you type.
 299
 300 When Hi Lock mode is enabled, a \"Regexp Highlighting\" submenu
 301 is added to the \"Edit\" menu.  The commands in the submenu,
 302 which can be called interactively, are:
 303
 304 \\[highlight-regexp] REGEXP FACE
 305   Highlight matches of pattern REGEXP in current buffer with FACE.
 306
 307 \\[highlight-phrase] PHRASE FACE
 308   Highlight matches of phrase PHRASE in current buffer with FACE.
 309   (PHRASE can be any REGEXP, but spaces will be replaced by matches
 310   to whitespace and initial lower-case letters will become case insensitive.)
 311
 312 \\[highlight-lines-matching-regexp] REGEXP FACE
 313   Highlight lines containing matches of REGEXP in current buffer with FACE.
 314
 315 \\[unhighlight-regexp] REGEXP
 316   Remove highlighting on matches of REGEXP in current buffer.
 317
 318 \\[hi-lock-write-interactive-patterns]
 319   Write active REGEXPs into buffer as comments (if possible).  They may
 320   be read the next time file is loaded or when the \\[hi-lock-find-patterns] command
 321   is issued.  The inserted regexps are in the form of font lock keywords.
 322   (See `font-lock-keywords'.)  They may be edited and re-loaded with \\[hi-lock-find-patterns],
 323   any valid `font-lock-keywords' form is acceptable.  When a file is
 324   loaded the patterns are read if `hi-lock-file-patterns-policy' is
 325   'ask and the user responds y to the prompt, or if
 326   `hi-lock-file-patterns-policy' is bound to a function and that
 327   function returns t.
 328
 329 \\[hi-lock-find-patterns]
 330   Re-read patterns stored in buffer (in the format produced by \\[hi-lock-write-interactive-patterns]).
 331
 332 When hi-lock is started and if the mode is not excluded or patterns
 333 rejected, the beginning of the buffer is searched for lines of the
 334 form:
 335   Hi-lock: FOO
 336
 337 where FOO is a list of patterns.  The patterns must start before
 338 position \(number of characters into buffer)
 339 `hi-lock-file-patterns-range'.  Patterns will be read until
 340 Hi-lock: end is found.  A mode is excluded if it's in the list
 341 `hi-lock-exclude-modes'."
 342   :group 'hi-lock
 343   :lighter (:eval (if (or hi-lock-interactive-patterns
 344                           hi-lock-file-patterns)
 345                       " Hi" ""))
 346   :global nil
 347   :keymap hi-lock-map
 348   (when (and (equal (buffer-name) "*scratch*")
 349              load-in-progress
 350              (not (called-interactively-p 'interactive))
 351              (not hi-lock-archaic-interface-message-used))
 352     (setq hi-lock-archaic-interface-message-used t)
 353     (if hi-lock-archaic-interface-deduce
 354         (global-hi-lock-mode hi-lock-mode)
 355       (warn
 356        "Possible archaic use of (hi-lock-mode).
 357 Use (global-hi-lock-mode 1) in .emacs to enable hi-lock for all buffers,
 358 use (hi-lock-mode 1) for individual buffers.  For compatibility with Emacs
 359 versions before 22 use the following in your init file:
 360
 361         (if (functionp 'global-hi-lock-mode)
 362             (global-hi-lock-mode 1)
 363           (hi-lock-mode 1))
 364 ")))
 365   (if hi-lock-mode
 366       ;; Turned on.
 367       (progn
 368         (define-key-after menu-bar-edit-menu [hi-lock]
 369           (cons "Regexp Highlighting" hi-lock-menu))
 370         (hi-lock-find-patterns)
 371         (add-hook 'font-lock-mode-hook 'hi-lock-font-lock-hook nil t))
 372     ;; Turned off.
 373     (when (or hi-lock-interactive-patterns
 374               hi-lock-file-patterns)
 375       (when hi-lock-interactive-patterns
 376         (font-lock-remove-keywords nil hi-lock-interactive-patterns)
 377         (setq hi-lock-interactive-patterns nil))
 378       (when hi-lock-file-patterns
 379         (font-lock-remove-keywords nil hi-lock-file-patterns)
 380         (setq hi-lock-file-patterns nil))
 381       (remove-overlays nil nil 'hi-lock-overlay t)
 382       (when font-lock-fontified (font-lock-fontify-buffer)))
 383     (define-key-after menu-bar-edit-menu [hi-lock] nil)
 384     (remove-hook 'font-lock-mode-hook 'hi-lock-font-lock-hook t)))
 385
 386 ;;;###autoload
 387 (define-globalized-minor-mode global-hi-lock-mode
 388   hi-lock-mode turn-on-hi-lock-if-enabled
 389   :group 'hi-lock)
 390
 391 (defun turn-on-hi-lock-if-enabled ()
 392   (setq hi-lock-archaic-interface-message-used t)
 393   (unless (memq major-mode hi-lock-exclude-modes)
 394     (hi-lock-mode 1)))
 395
 396 ;;;###autoload
 397 (defalias 'highlight-lines-matching-regexp 'hi-lock-line-face-buffer)
 398 ;;;###autoload
 399 (defun hi-lock-line-face-buffer (regexp &optional face)
 400   "Set face of all lines containing a match of REGEXP to FACE.
 401 Interactively, prompt for REGEXP then FACE, using a buffer-local
 402 history list for REGEXP and a global history list for FACE.
 403
 404 If Font Lock mode is enabled in the buffer, it is used to
 405 highlight REGEXP.  If Font Lock mode is disabled, overlays are
 406 used for highlighting; in this case, the highlighting will not be
 407 updated as you type."
 408   (interactive
 409    (list
 410     (hi-lock-regexp-okay
 411      (read-regexp "Regexp to highlight line" (car regexp-history)))
 412     (hi-lock-read-face-name)))
 413   (or (facep face) (setq face 'hi-yellow))
 414   (unless hi-lock-mode (hi-lock-mode 1))
 415   (hi-lock-set-pattern
 416    ;; The \\(?:...\\) grouping construct ensures that a leading ^, +, * or ?
 417    ;; or a trailing $ in REGEXP will be interpreted correctly.
 418    (concat "^.*\\(?:" regexp "\\).*$") face))
 419
 420
 421 ;;;###autoload
 422 (defalias 'highlight-regexp 'hi-lock-face-buffer)
 423 ;;;###autoload
 424 (defun hi-lock-face-buffer (regexp &optional face)
 425   "Set face of each match of REGEXP to FACE.
 426 Interactively, prompt for REGEXP then FACE, using a buffer-local
 427 history list for REGEXP and a global history list for FACE.
 428
 429 If Font Lock mode is enabled in the buffer, it is used to
 430 highlight REGEXP.  If Font Lock mode is disabled, overlays are
 431 used for highlighting; in this case, the highlighting will not be
 432 updated as you type."
 433   (interactive
 434    (list
 435     (hi-lock-regexp-okay
 436      (read-regexp "Regexp to highlight" (car regexp-history)))
 437     (hi-lock-read-face-name)))
 438   (or (facep face) (setq face 'hi-yellow))
 439   (unless hi-lock-mode (hi-lock-mode 1))
 440   (hi-lock-set-pattern regexp face))
 441
 442 ;;;###autoload
 443 (defalias 'highlight-phrase 'hi-lock-face-phrase-buffer)
 444 ;;;###autoload
 445 (defun hi-lock-face-phrase-buffer (regexp &optional face)
 446   "Set face of each match of phrase REGEXP to FACE.
 447 Whitespace in REGEXP converted to arbitrary whitespace and initial
 448 lower-case letters made case insensitive.
 449
 450 If Font Lock mode is enabled in the buffer, it is used to
 451 highlight REGEXP.  If Font Lock mode is disabled, overlays are
 452 used for highlighting; in this case, the highlighting will not be
 453 updated as you type."
 454   (interactive
 455    (list
 456     (hi-lock-regexp-okay
 457      (hi-lock-process-phrase
 458       (read-regexp "Phrase to highlight" (car regexp-history))))
 459     (hi-lock-read-face-name)))
 460   (or (facep face) (setq face 'hi-yellow))
 461   (unless hi-lock-mode (hi-lock-mode 1))
 462   (hi-lock-set-pattern regexp face))
 463
 464 (declare-function x-popup-menu "menu.c" (position menu))
 465
 466 ;;;###autoload
 467 (defalias 'unhighlight-regexp 'hi-lock-unface-buffer)
 468 ;;;###autoload
 469 (defun hi-lock-unface-buffer (regexp)
 470   "Remove highlighting of each match to REGEXP set by hi-lock.
 471 Interactively, prompt for REGEXP, accepting only regexps
 472 previously inserted by hi-lock interactive functions."
 473   (interactive
 474    (if (and (display-popup-menus-p)
 475             (listp last-nonmenu-event)
 476             use-dialog-box)
 477        (catch 'snafu
 478          (or
 479           (x-popup-menu
 480            t
 481            (cons
 482             `keymap
 483             (cons "Select Pattern to Unhighlight"
 484                   (mapcar (lambda (pattern)
 485                             (list (car pattern)
 486                                   (format
 487                                    "%s (%s)" (car pattern)
 488                                    (symbol-name
 489                                     (car
 490                                      (cdr (car (cdr (car (cdr pattern))))))))
 491                                   (cons nil nil)
 492                                   (car pattern)))
 493                           hi-lock-interactive-patterns))))
 494           ;; If the user clicks outside the menu, meaning that they
 495           ;; change their mind, x-popup-menu returns nil, and
 496           ;; interactive signals a wrong number of arguments error.
 497           ;; To prevent that, we return an empty string, which will
 498           ;; effectively disable the rest of the function.
 499           (throw 'snafu '(""))))
 500      (let ((history-list (mapcar (lambda (p) (car p))
 501                                  hi-lock-interactive-patterns)))
 502        (unless hi-lock-interactive-patterns
 503          (error "No highlighting to remove"))
 504        (list
 505         (completing-read "Regexp to unhighlight: "
 506                          hi-lock-interactive-patterns nil t
 507                          (car (car hi-lock-interactive-patterns))
 508                          (cons 'history-list 1))))))
 509   (let ((keyword (assoc regexp hi-lock-interactive-patterns)))
 510     (when keyword
 511       (font-lock-remove-keywords nil (list keyword))
 512       (setq hi-lock-interactive-patterns
 513             (delq keyword hi-lock-interactive-patterns))
 514       (remove-overlays
 515        nil nil 'hi-lock-overlay-regexp (hi-lock-string-serialize regexp))
 516       (when font-lock-fontified (font-lock-fontify-buffer)))))
 517
 518 ;;;###autoload
 519 (defun hi-lock-write-interactive-patterns ()
 520   "Write interactively added patterns, if any, into buffer at point.
 521
 522 Interactively added patterns are those normally specified using
 523 `highlight-regexp' and `highlight-lines-matching-regexp'; they can
 524 be found in variable `hi-lock-interactive-patterns'."
 525   (interactive)
 526   (if (null hi-lock-interactive-patterns)
 527       (error "There are no interactive patterns"))
 528   (let ((beg (point)))
 529     (mapc
 530      (lambda (pattern)
 531        (insert (format "%s: (%s)\n"
 532                        hi-lock-file-patterns-prefix
 533                        (prin1-to-string pattern))))
 534      hi-lock-interactive-patterns)
 535     (comment-region beg (point)))
 536   (when (> (point) hi-lock-file-patterns-range)
 537     (warn "Inserted keywords not close enough to top of file")))
 538
 539 ;; Implementation Functions
 540
 541 (defun hi-lock-process-phrase (phrase)
 542   "Convert regexp PHRASE to a regexp that matches phrases.
 543
 544 Blanks in PHRASE replaced by regexp that matches arbitrary whitespace
 545 and initial lower-case letters made case insensitive."
 546   (let ((mod-phrase nil))
 547     (setq mod-phrase
 548           (replace-regexp-in-string
 549            "\\<[a-z]" (lambda (m) (format "[%s%s]" (upcase m) m)) phrase))
 550     (setq mod-phrase
 551           (replace-regexp-in-string
 552            "\\s-+" "[ \t\n]+" mod-phrase nil t))))
 553
 554 (defun hi-lock-regexp-okay (regexp)
 555   "Return REGEXP if it appears suitable for a font-lock pattern.
 556
 557 Otherwise signal an error.  A pattern that matches the null string is
 558 not suitable."
 559   (if (string-match regexp "")
 560       (error "Regexp cannot match an empty string")
 561     regexp))
 562
 563 (defun hi-lock-read-face-name ()
 564   "Read face name from minibuffer with completion and history."
 565   (intern (completing-read
 566            "Highlight using face: "
 567            obarray 'facep t
 568            (cons (car hi-lock-face-defaults)
 569                  (let ((prefix
 570                         (try-completion
 571                          (substring (car hi-lock-face-defaults) 0 1)
 572                          hi-lock-face-defaults)))
 573                    (if (and (stringp prefix)
 574                             (not (equal prefix (car hi-lock-face-defaults))))
 575                        (length prefix) 0)))
 576            'face-name-history
 577            (cdr hi-lock-face-defaults))))
 578
 579 (defun hi-lock-set-pattern (regexp face)
 580   "Highlight REGEXP with face FACE."
 581   (let ((pattern (list regexp (list 0 (list 'quote face) t))))
 582     (unless (member pattern hi-lock-interactive-patterns)
 583       (push pattern hi-lock-interactive-patterns)
 584       (if font-lock-mode
 585           (progn
 586             (font-lock-add-keywords nil (list pattern) t)
 587             (font-lock-fontify-buffer))
 588         (let* ((serial (hi-lock-string-serialize regexp))
 589                (range-min (- (point) (/ hi-lock-highlight-range 2)))
 590                (range-max (+ (point) (/ hi-lock-highlight-range 2)))
 591                (search-start
 592                 (max (point-min)
 593                      (- range-min (max 0 (- range-max (point-max))))))
 594                (search-end
 595                 (min (point-max)
 596                      (+ range-max (max 0 (- (point-min) range-min))))))
 597           (save-excursion
 598             (goto-char search-start)
 599             (while (re-search-forward regexp search-end t)
 600               (let ((overlay (make-overlay (match-beginning 0) (match-end 0))))
 601                 (overlay-put overlay 'hi-lock-overlay t)
 602                 (overlay-put overlay 'hi-lock-overlay-regexp serial)
 603                 (overlay-put overlay 'face face))
 604               (goto-char (match-end 0)))))))))
 605
 606 (defun hi-lock-set-file-patterns (patterns)
 607   "Replace file patterns list with PATTERNS and refontify."
 608   (when (or hi-lock-file-patterns patterns)
 609     (font-lock-remove-keywords nil hi-lock-file-patterns)
 610     (setq hi-lock-file-patterns patterns)
 611     (font-lock-add-keywords nil hi-lock-file-patterns t)
 612     (font-lock-fontify-buffer)))
 613
 614 (defun hi-lock-find-patterns ()
 615   "Find patterns in current buffer for hi-lock."
 616   (interactive)
 617   (unless (memq major-mode hi-lock-exclude-modes)
 618     (let ((all-patterns nil)
 619           (target-regexp (concat "\\<" hi-lock-file-patterns-prefix ":")))
 620       (save-excursion
 621         (save-restriction
 622           (widen)
 623           (goto-char (point-min))
 624           (re-search-forward target-regexp
 625                              (+ (point) hi-lock-file-patterns-range) t)
 626           (beginning-of-line)
 627           (while (and (re-search-forward target-regexp (+ (point) 100) t)
 628                       (not (looking-at "\\s-*end")))
 629             (condition-case nil
 630                 (setq all-patterns (append (read (current-buffer)) all-patterns))
 631               (error (message "Invalid pattern list expression at %d"
 632                               (line-number-at-pos)))))))
 633       (when (and all-patterns
 634                  hi-lock-mode
 635                  (cond
 636                   ((eq this-command 'hi-lock-find-patterns) t)
 637                   ((functionp hi-lock-file-patterns-policy)
 638                    (funcall hi-lock-file-patterns-policy all-patterns))
 639                   ((eq hi-lock-file-patterns-policy 'ask)
 640                    (y-or-n-p "Add patterns from this buffer to hi-lock? "))
 641                   (t nil)))
 642         (hi-lock-set-file-patterns all-patterns)
 643         (if (called-interactively-p 'interactive)
 644             (message "Hi-lock added %d patterns." (length all-patterns)))))))
 645
 646 (defun hi-lock-font-lock-hook ()
 647   "Add hi-lock patterns to font-lock's."
 648   (when font-lock-fontified
 649     (font-lock-add-keywords nil hi-lock-file-patterns t)
 650     (font-lock-add-keywords nil hi-lock-interactive-patterns t)))
 651
 652 (defvar hi-lock-string-serialize-hash
 653   (make-hash-table :test 'equal)
 654   "Hash table used to assign unique numbers to strings.")
 655
 656 (defvar hi-lock-string-serialize-serial 1
 657   "Number assigned to last new string in call to `hi-lock-string-serialize'.
 658 A string is considered new if it had not previously been used in a call to
 659 `hi-lock-string-serialize'.")
 660
 661 (defun hi-lock-string-serialize (string)
 662   "Return unique serial number for STRING."
 663   (interactive)
 664   (let ((val (gethash string hi-lock-string-serialize-hash)))
 665     (if val val
 666       (puthash string
 667                (setq hi-lock-string-serialize-serial
 668                      (1+ hi-lock-string-serialize-serial))
 669                hi-lock-string-serialize-hash)
 670       hi-lock-string-serialize-serial)))
 671
 672 (defun hi-lock-unload-function ()
 673   "Unload the Hi-Lock library."
 674   (global-hi-lock-mode -1)
 675   ;; continue standard unloading
 676   nil)
 677
 678 (provide 'hi-lock)
 679
 680 ;;; hi-lock.el ends here