eval-reg.el 8.01 KB
Newer Older
1
;;; eval-reg.el --- Redefine eval-region, and subrs that use it, in Lisp
Daniel LaLiberte's avatar
Daniel LaLiberte committed
2

Erik Naggum's avatar
Erik Naggum committed
3
;; Copyright (C) 1994, 1996 Daniel LaLiberte
Daniel LaLiberte's avatar
Daniel LaLiberte committed
4

Daniel LaLiberte's avatar
Daniel LaLiberte committed
5 6 7
;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
;; Keywords: lisp

Daniel LaLiberte's avatar
Daniel LaLiberte committed
8
;; This file is part of GNU Emacs.
Daniel LaLiberte's avatar
Daniel LaLiberte committed
9 10 11

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Daniel LaLiberte's avatar
Daniel LaLiberte committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Daniel LaLiberte's avatar
Daniel LaLiberte committed
13 14 15 16 17 18 19 20 21
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
Erik Naggum's avatar
Erik Naggum committed
22 23
;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Daniel LaLiberte's avatar
Daniel LaLiberte committed
24

Erik Naggum's avatar
Erik Naggum committed
25
;;; Commentary:
Daniel LaLiberte's avatar
Daniel LaLiberte committed
26

Erik Naggum's avatar
Erik Naggum committed
27 28 29 30 31 32
;; eval-region, eval-buffer, and eval-current-buffer are redefined in
;; Lisp to allow customizations by Lisp code.  eval-region calls
;; `read', `eval', and `prin1', so Lisp replacements of these
;; functions will affect eval-region and anything else that calls it.
;; eval-buffer and eval-current-buffer are redefined in Lisp to call
;; eval-region on the buffer.  
Daniel LaLiberte's avatar
Daniel LaLiberte committed
33

Erik Naggum's avatar
Erik Naggum committed
34 35 36
;; Because of dynamic binding, all local variables are protected from
;; being seen by eval by giving them funky names.  But variables in
;; routines that call eval-region are similarly exposed.
Daniel LaLiberte's avatar
Daniel LaLiberte committed
37

Erik Naggum's avatar
Erik Naggum committed
38 39 40
;; Perhaps this should be one of several files in an `elisp' package
;; that replaces Emacs Lisp subroutines with Lisp versions of the
;; same.
Daniel LaLiberte's avatar
Daniel LaLiberte committed
41

Erik Naggum's avatar
Erik Naggum committed
42 43 44 45 46
;; Eval-region may be installed, after loading, by calling:
;; (elisp-eval-region-install).  Installation can be undone with:
;; (elisp-eval-region-uninstall).

;;; Code:
Daniel LaLiberte's avatar
Daniel LaLiberte committed
47 48 49 50 51

'(defpackage "elisp-eval-region"
   (:nicknames "elisp")
   (:use "elisp")
   (:export
52 53
    elisp-eval-region-install
    elisp-eval-region-uninstall
Daniel LaLiberte's avatar
Daniel LaLiberte committed
54 55
    elisp-eval-region-level
    with-elisp-eval-region
Daniel LaLiberte's avatar
Daniel LaLiberte committed
56 57 58
    eval-region
    eval-buffer
    eval-current-buffer
Daniel LaLiberte's avatar
Daniel LaLiberte committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
    ))
'(in-package elisp-eval-region)

;; Save standard versions.
(if (not (fboundp 'original-eval-region))
    (defalias 'original-eval-region (symbol-function 'eval-region)))
(if (not (fboundp 'original-eval-buffer))
    (defalias 'original-eval-buffer 
	  (if (fboundp 'eval-buffer)  ;; only in Emacs 19
	      (symbol-function 'eval-buffer)
	    'undefined)))
(if (not (fboundp 'original-eval-current-buffer))
    (defalias 'original-eval-current-buffer
	  (symbol-function 'eval-current-buffer)))

(defvar elisp-eval-region-level 0
75 76 77
  "If the value is 0, use the original version of `elisp-eval-region'.
Callers of `elisp-eval-region' should increment `elisp-eval-region-level'
while the Lisp version should be used.  Installing `elisp-eval-region'
Daniel LaLiberte's avatar
Daniel LaLiberte committed
78 79
increments it once, and uninstalling decrements it.")

80 81 82
;; Installing and uninstalling should always be used in pairs, 
;; or just install once and never uninstall. 
(defun elisp-eval-region-install ()
Daniel LaLiberte's avatar
Daniel LaLiberte committed
83 84 85 86 87 88
  (interactive)
  (defalias 'eval-region 'elisp-eval-region)
  (defalias 'eval-buffer 'elisp-eval-buffer)
  (defalias 'eval-current-buffer 'elisp-eval-current-buffer)
  (setq elisp-eval-region-level (1+ elisp-eval-region-level)))

89
(defun elisp-eval-region-uninstall ()
Daniel LaLiberte's avatar
Daniel LaLiberte committed
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
  (interactive)
  (if (> 1 elisp-eval-region-level)
      (setq elisp-eval-region-level (1- elisp-eval-region-level))
    (setq elisp-eval-region-level 0)
    (defalias 'eval-region (symbol-function 'original-eval-region))
    (defalias 'eval-buffer (symbol-function 'original-eval-buffer))
    (defalias 'eval-current-buffer 
      (symbol-function 'original-eval-current-buffer))
    ))

(put 'with-elisp-eval-region 'lisp-indent-function 1)
(put 'with-elisp-eval-region 'lisp-indent-hook 1)
(put 'with-elisp-eval-region 'edebug-form-spec t)

(defmacro with-elisp-eval-region (flag &rest body)
105
  "If FLAG is nil, decrement `eval-region-level' while executing BODY.
Daniel LaLiberte's avatar
Daniel LaLiberte committed
106
The effect of decrementing all the way to zero is that `eval-region'
107
will use the original `eval-region', which may be the Emacs subr or some
Daniel LaLiberte's avatar
Daniel LaLiberte committed
108
previous redefinition.  Before calling this macro, this package should
109
already have been installed, using `elisp-eval-region-install', which
Daniel LaLiberte's avatar
Daniel LaLiberte committed
110
increments the count once.  So if another package still requires the
111
Lisp version of the code, the count will still be non-zero.
Daniel LaLiberte's avatar
Daniel LaLiberte committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132

The count is not bound locally by this macro, so changes by BODY to
its value will not be lost."
  (` (let ((elisp-code (function (lambda () (,@ body)))))
       (if (not (, flag))
	   (unwind-protect
	       (progn
		 (setq elisp-eval-region-level (1- elisp-eval-region-level))
		 (funcall elisp-code))
	     (setq elisp-eval-region-level (1+ elisp-eval-region-level)))
	 (funcall elisp-code)))))


(defun elisp-eval-region (elisp-start elisp-end &optional elisp-output)
  "Execute the region as Lisp code.
When called from programs, expects two arguments,
giving starting and ending indices in the current buffer
of the text to be executed.
Programs can pass third argument PRINTFLAG which controls printing of output:
nil means discard it; anything else is stream for print.

133
This version, from `eval-reg.el', allows Lisp customization of read,
Daniel LaLiberte's avatar
Daniel LaLiberte committed
134 135
eval, and the printer."

Karl Heuer's avatar
Karl Heuer committed
136
  ;; Because this doesn't narrow to the region, one other difference 
Daniel LaLiberte's avatar
Daniel LaLiberte committed
137 138 139 140 141 142 143
  ;; concerns inserting whitespace after the expression being evaluated.

  (interactive "r")
  (if (= 0 elisp-eval-region-level)
      (original-eval-region elisp-start elisp-end elisp-output)
    (let ((elisp-pnt (point))
	  (elisp-buf (current-buffer));; Outside buffer
Karl Heuer's avatar
Karl Heuer committed
144
	  (elisp-inside-buf (current-buffer));; Buffer current while evalling
Daniel LaLiberte's avatar
Daniel LaLiberte committed
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
	  ;; Mark the end because it may move.
	  (elisp-end-marker (set-marker (make-marker) elisp-end))
	  elisp-form
	  elisp-val)
      (goto-char elisp-start)
      (elisp-skip-whitespace)
      (while (< (point) elisp-end-marker)
	(setq elisp-form (read elisp-buf))

	(let ((elisp-current-buffer (current-buffer)))
	  ;; Restore the inside current-buffer.
	  (set-buffer elisp-inside-buf)
	  (setq elisp-val (eval elisp-form))
	  ;; Remember current buffer for next time.
	  (setq elisp-inside-buf (current-buffer))
	  ;; Should this be protected?
	  (set-buffer elisp-current-buffer))

	(if elisp-output
	    (let ((standard-output (or elisp-output t)))
	      (setq values (cons elisp-val values))
	      (if (eq standard-output t)
		  (prin1 elisp-val)
		(princ "\n")
		(prin1 elisp-val)
		(princ "\n")
		)))
	(goto-char (min (max elisp-end-marker (point))
			(progn (elisp-skip-whitespace) (point))))
	)				; while
      (if elisp-output nil
	;; like save-excursion recovery, but done only if no error occurs
	;; but mark is not restored
	(set-buffer elisp-buf)
	(goto-char elisp-pnt))
      nil)))


(defun elisp-skip-whitespace ()
  ;; Leave point before the next token, skipping white space and comments.
  (skip-chars-forward " \t\r\n\f")
  (while (= (following-char) ?\;)
    (skip-chars-forward "^\n\r")  ; skip the comment
    (skip-chars-forward " \t\r\n\f")))


(defun elisp-eval-current-buffer (&optional elisp-output)
  "Execute the current buffer as Lisp code.
Programs can pass argument PRINTFLAG which controls printing of output:
nil means discard it; anything else is stream for print.

196
This version calls `eval-region' on the whole buffer."
Daniel LaLiberte's avatar
Daniel LaLiberte committed
197 198 199 200 201
  ;; The standard eval-current-buffer doesn't use eval-region.
  (interactive)
  (eval-region (point-min) (point-max) elisp-output))


202
(defun elisp-eval-buffer (&optional elisp-bufname elisp-printflag filename)
Daniel LaLiberte's avatar
Daniel LaLiberte committed
203 204 205 206
  "Execute BUFFER as Lisp code.  Use current buffer if BUFFER is nil.
Programs can pass argument PRINTFLAG which controls printing of
output: nil means discard it; anything else is stream for print.

207 208 209
The argument FILENAME is accepted and ignored, just to avoid
crashes.

210
This version calls `eval-region' on the whole buffer."
Daniel LaLiberte's avatar
Daniel LaLiberte committed
211 212 213 214 215 216 217 218 219
  (interactive)
  (if (null elisp-bufname)
      (setq elisp-bufname (current-buffer)))
  (save-excursion
    (set-buffer (or (get-buffer elisp-bufname) 
		    (error "No such buffer: %s" elisp-bufname)))
    (eval-region (point-min) (point-max) elisp-printflag)))


220
(provide 'eval-reg)
Daniel LaLiberte's avatar
Daniel LaLiberte committed
221

Richard M. Stallman's avatar
Richard M. Stallman committed
222
;;; eval-reg.el ends here