New directory
[bpt/emacs.git] / lisp / emacs-lisp / elp.el
index 42dc1bc..01544e3 100644 (file)
@@ -1,11 +1,11 @@
 ;;; elp.el --- Emacs Lisp Profiler
 
-;; Copyright (C) 1994,1995,1997,1998 Free Software Foundation, Inc.
+;; Copyright (C) 1994,1995,1997,1998, 2001 Free Software Foundation, Inc.
 
-;; Author:        1994-1998 Barry A. Warsaw
-;; Maintainer:    FSF
-;; Created:       26-Feb-1994
-;; Keywords:      debugging lisp tools
+;; Author: Barry A. Warsaw
+;; Maintainer: FSF
+;; Created: 26-Feb-1994
+;; Keywords: debugging lisp tools
 
 ;; This file is part of GNU Emacs.
 
@@ -38,7 +38,7 @@
 ;; elp-reset-all.
 ;;
 ;; You can also instrument all functions in a package, provided that
-;; the package follows the GNU coding standard of a common textural
+;; the package follows the GNU coding standard of a common textual
 ;; prefix.  Use M-x elp-instrument-package for this.
 ;;
 ;; If you want to sort the results, set elp-sort-by-function to some
@@ -177,7 +177,7 @@ functions will be displayed."
   :group 'elp)
 
 (defcustom elp-recycle-buffers-p t
-  "*Nil says to not recycle the `elp-results-buffer'.
+  "*nil says to not recycle the `elp-results-buffer'.
 In other words, a new unique buffer is create every time you run
 \\[elp-results]."
   :type 'boolean
@@ -204,6 +204,20 @@ This variable is set by the master function.")
 (defvar elp-master nil
   "Master function symbol.")
 
+(defvar elp-not-profilable
+  '(elp-wrapper elp-elapsed-time error call-interactively apply current-time interactive-p)
+  "List of functions that cannot be profiled.
+Those functions are used internally by the profiling code and profiling
+them would thus lead to infinite recursion.")
+
+(defun elp-not-profilable-p (fun)
+  (or (memq fun elp-not-profilable)
+      (keymapp fun)
+      (condition-case nil
+         (when (subrp (symbol-function fun))
+           (eq 'unevalled (cdr (subr-arity (symbol-function fun)))))
+       (error nil))))
+
 \f
 ;;;###autoload
 (defun elp-instrument-function (funsym)
@@ -222,6 +236,9 @@ FUNSYM must be a symbol of a defined function."
   (let* ((funguts (symbol-function funsym))
         (infovec (vector 0 0 funguts))
         (newguts '(lambda (&rest args))))
+    ;; We cannot profile functions used internally during profiling.
+    (when (elp-not-profilable-p funsym)
+      (error "ELP cannot profile the function: %s" funsym))
     ;; we cannot profile macros
     (and (eq (car-safe funguts) 'macro)
         (error "ELP cannot profile macro: %s" funsym))
@@ -237,13 +254,11 @@ FUNSYM must be a symbol of a defined function."
     ;; put rest of newguts together
     (if (commandp funsym)
        (setq newguts (append newguts '((interactive)))))
-    (setq newguts (append newguts (list
-                                  (list 'elp-wrapper
-                                        (list 'quote funsym)
-                                        (list 'and
-                                              '(interactive-p)
-                                              (not (not (commandp funsym))))
-                                        'args))))
+    (setq newguts (append newguts `((elp-wrapper
+                                    (quote ,funsym)
+                                    ,(when (commandp funsym)
+                                       '(interactive-p))
+                                    args))))
     ;; to record profiling times, we set the symbol's function
     ;; definition so that it runs the elp-wrapper function with the
     ;; function symbol as an argument.  We place the old function
@@ -266,15 +281,21 @@ FUNSYM must be a symbol of a defined function."
     ;; put the info vector on the property list
     (put funsym elp-timer-info-property infovec)
 
-    ;; set the symbol's new profiling function definition to run
-    ;; elp-wrapper
-    (fset funsym newguts)
+    ;; Set the symbol's new profiling function definition to run
+    ;; elp-wrapper.
+    (let ((advice-info (get funsym 'ad-advice-info)))
+      (if advice-info
+         (progn
+           ;; If function is advised, don't let Advice change
+           ;; its definition from under us during the `fset'.
+           (put funsym 'ad-advice-info nil)
+           (fset funsym newguts)
+           (put funsym 'ad-advice-info advice-info))
+       (fset funsym newguts)))
 
     ;; add this function to the instrumentation list
-    (or (memq funsym elp-all-instrumented-list)
-       (setq elp-all-instrumented-list
-             (cons funsym elp-all-instrumented-list)))
-    ))
+    (unless (memq funsym elp-all-instrumented-list)
+      (push funsym elp-all-instrumented-list))))
 
 (defun elp-restore-function (funsym)
   "Restore an instrumented function to its original definition.
@@ -323,17 +344,17 @@ For example, to instrument all ELP functions, do the following:
 
     \\[elp-instrument-package] RET elp- RET"
   (interactive "sPrefix of package to instrument: ")
+  (if (zerop (length prefix))
+      (error "Instrumenting all Emacs functions would render Emacs unusable"))
   (elp-instrument-list
    (mapcar
     'intern
     (all-completions
      prefix obarray
-     (function
-      (lambda (sym)
-       (and (fboundp sym)
-            (not (memq (car-safe (symbol-function sym)) '(autoload macro))))
-       ))
-     ))))
+     (lambda (sym)
+       (and (fboundp sym)
+           (not (or (memq (car-safe (symbol-function sym)) '(autoload macro))
+                    (elp-not-profilable-p sym)))))))))
 
 (defun elp-restore-list (&optional list)
   "Restore the original definitions for all functions in `elp-function-list'.
@@ -353,7 +374,7 @@ Use optional LIST if provided instead."
   (interactive "aFunction to reset: ")
   (let ((info (get funsym elp-timer-info-property)))
     (or info
-       (error "%s is not instrumented for profiling." funsym))
+       (error "%s is not instrumented for profiling" funsym))
     (aset info 0 0)                    ;reset call counter
     (aset info 1 0.0)                  ;reset total time
     ;; don't muck with aref 2 as that is the old symbol definition
@@ -408,7 +429,7 @@ original definition, use \\[elp-restore-function] or \\[elp-restore-all]."
         (func (aref info 2))
         result)
     (or func
-       (error "%s is not instrumented for profiling." funsym))
+       (error "%s is not instrumented for profiling" funsym))
     (if (not elp-record-p)
        ;; when not recording, just call the original function symbol
        ;; and return the results.
@@ -582,4 +603,4 @@ displayed."
 \f
 (provide 'elp)
 
-;; elp.el ends here
+;;; elp.el ends here