blob: 747bf682afbbc2cb4608b0e72f28871994101363 (
plain) (
blame)
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
136
137
138
139
140
141
142
143
144
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
;;; rudel-debug.el --- Debugging functions for Rudel
;;
;; Copyright (C) 2009 Jan Moringen
;;
;; Author: Jan Moringen <scymtym@users.sourceforge.net>
;; Keywords: Rudel, debugging
;; X-RCS: $Id:$
;;
;; This file is part of Rudel.
;;
;; Rudel 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.
;;
;; Rudel 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 rudel. If not, see <http://www.gnu.org/licenses>.
;;; Commentary:
;;
;; Debugging functions for Rudel.
;;; History:
;;
;; 0.1 - Initial revision.
;;; Code:
;;
(require 'data-debug)
(require 'eieio-datadebug)
(require 'rudel-util)
;;; Customization
;;
(defgroup rudel-debug nil
"Customization options related to Rudel's debugging functions."
:group 'rudel)
(defface rudel-debug-sent-data-face
'((default (:background "orange")))
"Face used for sent data."
:group 'rudel-debug)
(defface rudel-debug-received-data-face
'((default (:background "light sky blue")))
"Face used for received (but not yet processed) data."
:group 'rudel-debug)
(defface rudel-debug-received-processed-data-face
'((default (:background "DeepSkyBlue1")))
"Face used for received data after processing."
:group 'rudel-debug)
(defface rudel-debug-state-face
'((default (:background "light gray")))
"Face used when indicating state changes."
:group 'rudel-debug)
(defface rudel-debug-special-face
'((default (:background "light sea green")))
"Face used for additional information."
:group 'rudel-debug)
(defvar rudel-debug-tag-faces
'((:sent . (rudel-debug-sent-data-face "< "))
(:received . (rudel-debug-received-data-face "> "))
(:received-processed . (rudel-debug-received-processed-data-face ">> "))
(:state . (rudel-debug-state-face "| "))
(:special . (rudel-debug-special-face "; ")))
"Associate tag to faces and prefixes.")
;;; Data debug functions
;;
(defun rudel-adebug-session ()
"Analyze current session in data debug buffer."
(interactive)
;; Make sure we have a session.
(unless rudel-current-session
(error "No active Rudel session"))
(with-current-buffer (data-debug-new-buffer "RUDEL-SESSION")
(data-debug-insert-thing rudel-current-session "# " "")))
(defun rudel-adebug-server (server)
"Analyze server in data debug buffer."
(interactive)
(with-current-buffer (data-debug-new-buffer "RUDEL-SERVER")
(data-debug-insert-thing server "# " "")))
;;; Advice stuff
;;
(defadvice rudel-join-session (after rudel-debug last activate)
"Run data-debug inspection on newly created session objects."
(require 'rudel-debug)
(rudel-adebug-session))
(defadvice rudel-host-session (after rudel-debug last activate)
"Run data-debug inspection on newly created server objects."
(require 'rudel-debug)
(rudel-adebug-server ad-return-value))
;;; Network functions
;;
(defun rudel-suspend-session-socket ()
"Suspend the socket associated to the current session."
(interactive)
;; Make sure we have a session.
(unless rudel-current-session
(error "No active Rudel session"))
(with-slots (connection) rudel-current-session
(with-slots (socket) connection
(stop-process socket))))
(defun rudel-resume-session-socket ()
"Resume the socket associated to the current session."
(interactive)
;; Make sure we have a session.
(unless rudel-current-session
(error "No active Rudel session"))
(with-slots (connection) rudel-current-session
(with-slots (socket) connection
(continue-process socket))))
;;; Reset functions
;;
(defun rudel-kill-processes ()
"TODO"
(interactive)
(mapc #'delete-process (process-list)))
(defun rudel-reset ()
"TODO"
(interactive)
(dolist (buffer (buffer-list))
(with-current-buffer buffer
(when rudel-buffer-document
(setq rudel-buffer-document nil))))
(rudel-kill-processes)
(setq rudel-current-session nil))
;;; Socket debugging
;;
(defmethod rudel-state-change :before ((this rudel-socket-owner)
state message)
"Print STATE and MESSAGE to debug stream."
(with-slots (socket) this
(rudel-debug-stream-insert
(rudel-debug-stream-name socket)
:state
(format "connection state changed to %s: \"%s\""
(upcase (symbol-name state))
;; MESSAGE ends with a newline; remove it
(substring message 0 -1))))
)
;;; Utility functions
;;
(defun rudel-debug-stream-name (socket)
"Return debug stream name for SOCKET."
(process-name socket))
(defun rudel-debug-stream-insert (stream tag data &optional object)
"Insert DATA and possibly OBJECT into stream using TAG as style."
(let* ((buffer-name (format "*%s stream*" stream))
(buffer (or (get-buffer buffer-name)
(data-debug-new-buffer buffer-name)))
(appearance (cdr (assoc tag rudel-debug-tag-faces)))
(face (when appearance
(or (nth 0 appearance)
'default)))
(prefix (or (nth 1 appearance)
"")))
(save-excursion
(set-buffer buffer)
(goto-char 0)
(insert prefix
(propertize data 'face face)
(if (string= (substring data -1) "\n")
"" "\n"))
(when object
(data-debug-insert-thing object prefix ""))))
)
(provide 'rudel-debug)
;;; rudel-debug.el ends here
|
