Mercurial > emacs
view lisp/emacs-lisp/trace.el @ 89943:4c90ffeb71c5
Revision: miles@gnu.org--gnu-2004/emacs--unicode--0--patch-15
Merge from emacs--cvs-trunk--0
Patches applied:
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-218
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-220
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-221
Restore deleted tagline in etc/TUTORIAL.ru
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-222
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-228
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-229
Remove TeX output files from the archive
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-230
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-247
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-248
src/lisp.h (CYCLE_CHECK): Macro moved from xfaces.c
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-249
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-256
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-258
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-263
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-264
Update from CVS: lispref/display.texi: emacs -> Emacs.
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-265
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-274
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-275
Update from CVS: man/makefile.w32-in: Revert last change
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-276
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-295
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-296
Allow restarting an existing debugger session that's exited
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-297
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-299
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-300
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-327
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-328
Update from CVS: src/.gdbinit (xsymbol): Fix last change.
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-329
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-344
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-345
Tweak source regexps so that building in place won't cause problems
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-346
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-351
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-352
Update from CVS: lisp/flymake.el: New file.
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-353
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-361
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-362
Support " [...]" style defaults in minibuffer-electric-default-mode
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-363
(read-number): Use canonical format for default in prompt.
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-364
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-367
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-368
Improve display-supports-face-attributes-p on non-ttys
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-369
Rewrite face-differs-from-default-p
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-370
Move `display-supports-face-attributes-p' entirely into C code
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-371
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-372
Simplify face-differs-from-default-p; don't consider :stipple.
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-373
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-374
(tty_supports_face_attributes_p): Ensure attributes differ from default
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-375
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-376
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-377
(Fdisplay_supports_face_attributes_p): Work around bootstrapping problem
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-378
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-380
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-381
Face merging cleanups
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-382
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-384
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-385
src/xfaces.c (push_named_merge_point): Return 0 if a cycle is detected
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-386
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-395
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-396
Tweak arch tagging to make build/install-in-place less annoying
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-397
Work around vc-arch problems when building eshell
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-398
Tweak permissions
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-399
Tweak directory permissions
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-400
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-401
More build-in-place tweaking of arch tagging
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-402
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-403
Yet more build-in-place tweaking of arch tagging
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-404
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-409
Update from CVS
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-410
Make sure image types are initialized for lookup too
* miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-411
- miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-416
Update from CVS
author | Miles Bader <miles@gnu.org> |
---|---|
date | Mon, 28 Jun 2004 07:56:49 +0000 |
parents | 68c22ea6027c |
children | e4694597cbf4 |
line wrap: on
line source
;;; trace.el --- tracing facility for Emacs Lisp functions ;; Copyright (C) 1993 Free Software Foundation, Inc. ;; Author: Hans Chalupsky <hans@cs.buffalo.edu> ;; Maintainer: FSF ;; Created: 15 Dec 1992 ;; Keywords: tools, lisp ;; This file is part of GNU Emacs. ;; 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 ;; the Free Software Foundation; either version 2, or (at your option) ;; 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 the ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, ;; Boston, MA 02111-1307, USA. ;; LCD Archive Entry: ;; trace|Hans Chalupsky|hans@cs.buffalo.edu| ;; Tracing facility for Emacs Lisp functions| ;; 1993/05/18 00:41:16|2.0|~/packages/trace.el.Z| ;;; Commentary: ;; Introduction: ;; ============= ;; A simple trace package that utilizes advice.el. It generates trace ;; information in a Lisp-style fashion and inserts it into a trace output ;; buffer. Tracing can be done in the background (or silently) so that ;; generation of trace output won't interfere with what you are currently ;; doing. ;; Requirement: ;; ============ ;; trace.el needs advice.el version 2.0 or later which you can get from the ;; same place from where you got trace.el. ;; Restrictions: ;; ============= ;; - Traced subrs when called interactively will always show nil as the ;; value of their arguments. ;; - Only functions/macros/subrs that are called via their function cell will ;; generate trace output, hence, you won't get trace output for: ;; + Subrs called directly from other subrs/C-code ;; + Compiled calls to subrs that have special byte-codes associated ;; with them (e.g., car, cdr, ...) ;; + Macros that were expanded during compilation ;; - All the restrictions that apply to advice.el ;; Installation: ;; ============= ;; Put this file together with advice.el (version 2.0 or later) somewhere ;; into your Emacs `load-path', byte-compile it/them for efficiency, and ;; put the following autoload declarations into your .emacs ;; ;; (autoload 'trace-function "trace" "Trace a function" t) ;; (autoload 'trace-function-background "trace" "Trace a function" t) ;; ;; or explicitly load it with (require 'trace) or (load "trace"). ;; Usage: ;; ====== ;; - To trace a function say `M-x trace-function' which will ask you for the ;; name of the function/subr/macro to trace, as well as for the buffer ;; into which trace output should go. ;; - If you want to trace a function that switches buffers or does other ;; display oriented stuff use `M-x trace-function-background' which will ;; generate the trace output silently in the background without popping ;; up windows and doing other irritating stuff. ;; - To untrace a function say `M-x untrace-function'. ;; - To untrace all currently traced functions say `M-x untrace-all'. ;; Examples: ;; ========= ;; ;; (defun fact (n) ;; (if (= n 0) 1 ;; (* n (fact (1- n))))) ;; fact ;; ;; (trace-function 'fact) ;; fact ;; ;; Now, evaluating this... ;; ;; (fact 4) ;; 24 ;; ;; ...will generate the following in *trace-buffer*: ;; ;; 1 -> fact: n=4 ;; | 2 -> fact: n=3 ;; | | 3 -> fact: n=2 ;; | | | 4 -> fact: n=1 ;; | | | | 5 -> fact: n=0 ;; | | | | 5 <- fact: 1 ;; | | | 4 <- fact: 1 ;; | | 3 <- fact: 2 ;; | 2 <- fact: 6 ;; 1 <- fact: 24 ;; ;; ;; (defun ack (x y z) ;; (if (= x 0) ;; (+ y z) ;; (if (and (<= x 2) (= z 0)) ;; (1- x) ;; (if (and (> x 2) (= z 0)) ;; y ;; (ack (1- x) y (ack x y (1- z))))))) ;; ack ;; ;; (trace-function 'ack) ;; ack ;; ;; Try this for some interesting trace output: ;; ;; (ack 3 3 1) ;; 27 ;; ;; ;; The following does something similar to the functionality of the package ;; log-message.el by Robert Potter, which is giving you a chance to look at ;; messages that might have whizzed by too quickly (you won't see subr ;; generated messages though): ;; ;; (trace-function-background 'message "*Message Log*") ;;; Change Log: ;; Revision 2.0 1993/05/18 00:41:16 hans ;; * Adapted for advice.el 2.0; it now also works ;; for GNU Emacs-19 and Lemacs ;; * Separate function `trace-function-background' ;; * Separate pieces of advice for foreground and background tracing ;; * Less insane handling of interactive trace buffer specification ;; * String arguments and values are now printed properly ;; ;; Revision 1.1 1992/12/15 22:45:15 hans ;; * Created, first public release ;;; Code: (require 'advice) (defgroup trace nil "Tracing facility for Emacs Lisp functions" :prefix "trace-" :group 'lisp) ;;;###autoload (defcustom trace-buffer "*trace-output*" "*Trace output will by default go to that buffer." :type 'string :group 'trace) ;; Current level of traced function invocation: (defvar trace-level 0) ;; Semi-cryptic name used for a piece of trace advice: (defvar trace-advice-name 'trace-function\ ) ;; Used to separate new trace output from previous traced runs: (defvar trace-separator (format "%s\n" (make-string 70 ?=))) (defun trace-entry-message (function level argument-bindings) ;; Generates a string that describes that FUNCTION has been entered at ;; trace LEVEL with ARGUMENT-BINDINGS. (format "%s%s%d -> %s: %s\n" (mapconcat 'char-to-string (make-string (1- level) ?|) " ") (if (> level 1) " " "") level function (mapconcat (function (lambda (binding) (concat (symbol-name (ad-arg-binding-field binding 'name)) "=" ;; do this so we'll see strings: (prin1-to-string (ad-arg-binding-field binding 'value))))) argument-bindings " "))) (defun trace-exit-message (function level value) ;; Generates a string that describes that FUNCTION has been exited at ;; trace LEVEL and that it returned VALUE. (format "%s%s%d <- %s: %s\n" (mapconcat 'char-to-string (make-string (1- level) ?|) " ") (if (> level 1) " " "") level function ;; do this so we'll see strings: (prin1-to-string value))) (defun trace-make-advice (function buffer background) ;; Builds the piece of advice to be added to FUNCTION's advice info ;; so that it will generate the proper trace output in BUFFER ;; (quietly if BACKGROUND is t). (ad-make-advice trace-advice-name nil t (cond (background `(advice lambda () (let ((trace-level (1+ trace-level)) (trace-buffer (get-buffer-create ,buffer))) (save-excursion (set-buffer trace-buffer) (goto-char (point-max)) ;; Insert a separator from previous trace output: (if (= trace-level 1) (insert trace-separator)) (insert (trace-entry-message ',function trace-level ad-arg-bindings))) ad-do-it (save-excursion (set-buffer trace-buffer) (goto-char (point-max)) (insert (trace-exit-message ',function trace-level ad-return-value)))))) (t `(advice lambda () (let ((trace-level (1+ trace-level)) (trace-buffer (get-buffer-create ,buffer))) (pop-to-buffer trace-buffer) (goto-char (point-max)) ;; Insert a separator from previous trace output: (if (= trace-level 1) (insert trace-separator)) (insert (trace-entry-message ',function trace-level ad-arg-bindings)) ad-do-it (pop-to-buffer trace-buffer) (goto-char (point-max)) (insert (trace-exit-message ',function trace-level ad-return-value)))))))) (defun trace-function-internal (function buffer background) ;; Adds trace advice for FUNCTION and activates it. (ad-add-advice function (trace-make-advice function (or buffer trace-buffer) background) 'around 'last) (ad-activate function nil)) (defun trace-is-traced (function) (ad-find-advice function 'around trace-advice-name)) ;;;###autoload (defun trace-function (function &optional buffer) "Traces FUNCTION with trace output going to BUFFER. For every call of FUNCTION Lisp-style trace messages that display argument and return values will be inserted into BUFFER. This function generates the trace advice for FUNCTION and activates it together with any other advice there might be!! The trace BUFFER will popup whenever FUNCTION is called. Do not use this to trace functions that switch buffers or do any other display oriented stuff, use `trace-function-background' instead." (interactive (list (intern (completing-read "Trace function: " obarray 'fboundp t)) (read-buffer "Output to buffer: " trace-buffer))) (trace-function-internal function buffer nil)) ;;;###autoload (defun trace-function-background (function &optional buffer) "Traces FUNCTION with trace output going quietly to BUFFER. For every call of FUNCTION Lisp-style trace messages that display argument and return values will be inserted into BUFFER. This function generates the trace advice for FUNCTION and activates it together with any other advice there might be!! Trace output will quietly go to BUFFER without changing the window or buffer configuration at all." (interactive (list (intern (completing-read "Trace function in background: " obarray 'fboundp t)) (read-buffer "Output to buffer: " trace-buffer))) (trace-function-internal function buffer t)) (defun untrace-function (function) "Untraces FUNCTION and possibly activates all remaining advice. Activation is performed with `ad-update', hence remaining advice will get activated only if the advice of FUNCTION is currently active. If FUNCTION was not traced this is a noop." (interactive (list (ad-read-advised-function "Untrace function: " 'trace-is-traced))) (cond ((trace-is-traced function) (ad-remove-advice function 'around trace-advice-name) (ad-update function)))) (defun untrace-all () "Untraces all currently traced functions." (interactive) (ad-do-advised-functions (function) (untrace-function function))) (provide 'trace) ;;; arch-tag: cfd170a7-4932-4331-8c8b-b7151942e5a1 ;;; trace.el ends here