1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
;;; xcb-debug.el --- Debugging helpers for XELB -*- lexical-binding: t -*-
;; Copyright (C) 2018-2024 Free Software Foundation, Inc.
;; Author: Adrián Medraño Calvo <adrian@medranocalvo.com>
;; 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 3 of the License, 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. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; This module collects functions that help in debugging XELB.
;;; Code:
(defvar xcb-debug:buffer "*XELB-DEBUG*" "Buffer to write debug messages to.")
(defvar xcb-debug:backtrace-start-frame 5
"From which frame to start collecting backtraces.")
(defvar xcb-debug:log-time-function #'xcb-debug:log-uptime
"Function used for generating timestamps in XELB debug logs.
Here are some predefined candidates:
`xcb-debug:log-uptime': Display the uptime of this Emacs instance.
`xcb-debug:log-time': Display time of day.
`nil': Disable timestamp.")
(defun xcb-debug:log-uptime ()
"Add uptime to XELB debug logs."
(emacs-uptime "[%.2h:%.2m:%.2s] "))
(defun xcb-debug:log-time ()
"Add time of day to XELB debug logs."
(format-time-string "[%T] "))
(defun xcb-debug:-call-stack ()
"Return the current call stack frames."
(let (frames frame
;; No need to acount for our setq, while, let, ...
(index xcb-debug:backtrace-start-frame))
(while (setq frame (backtrace-frame index))
(push frame frames)
(cl-incf index))
(cl-remove-if-not 'car frames)))
(defmacro xcb-debug:compile-time-function-name ()
"Get the name of outermost definition at expansion time."
(let* ((frame (cl-find-if
(lambda (frame)
(ignore-errors
(let ((clause (car (cl-third frame))))
(or (equal clause 'defalias)
(equal clause 'cl-defmethod)))))
(reverse (xcb-debug:-call-stack))))
(defn (cl-third frame))
(deftype (car defn)))
(cl-case deftype
((defalias) (symbol-name (cl-cadadr defn)))
((cl-defmethod) (symbol-name (cadr defn)))
(t "<unknown function>"))))
(defmacro xcb-debug:-with-debug-buffer (&rest forms)
"Evaluate FORMS making sure `xcb-debug:buffer' is correctly updated."
`(with-current-buffer (xcb-debug:-get-buffer)
(let (windows-eob)
;; Note windows whose point is at EOB.
(dolist (w (get-buffer-window-list (current-buffer) t 'nomini))
(when (and (window-live-p w)
(= (window-point w) (point-max)))
(push w windows-eob)))
(save-excursion
(goto-char (point-max))
,@forms)
;; Restore point.
(dolist (w windows-eob)
(set-window-point w (point-max))))))
(defun xcb-debug:message (format-string &rest objects)
"Print a message to `xcb-debug:buffer'.
The FORMAT-STRING argument follows the speficies how to print each of
the passed OBJECTS. See `format' for details."
(xcb-debug:-with-debug-buffer
(insert (apply #'format format-string objects))))
(defmacro xcb-debug:backtrace ()
"Print a backtrace to the `xcb-debug:buffer'."
'(xcb-debug:-with-debug-buffer
(let ((standard-output (xcb-debug:-get-buffer)))
(backtrace))))
(defmacro xcb-debug:backtrace-on-error (&rest forms)
"Evaluate FORMS. Printing a backtrace if an error is signaled."
`(let ((debug-on-error t)
(debugger (lambda (&rest _) (xcb-debug:backtrace))))
,@forms))
(defun xcb-debug:-get-buffer ()
"Get or create `xcb-debug:buffer'."
(let ((buffer (get-buffer xcb-debug:buffer)))
(unless buffer
(setq buffer (get-buffer-create xcb-debug:buffer))
(buffer-disable-undo buffer))
buffer))
(defun xcb-debug:clear ()
"Clear the debug buffer."
(interactive)
(xcb-debug:-with-debug-buffer
(erase-buffer)))
(defun xcb-debug:mark ()
"Insert a mark in the debug buffer."
(interactive)
(xcb-debug:-with-debug-buffer
(insert " \n")))
(provide 'xcb-debug)
;;; xcb-debug.el ends here
|
