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
|
% Copyright (C) 2024 Eric Ludlam (and others)
% This program 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.
% This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
classdef EmacsServer < handle
% Class EMACSSERVER - Support a TCP connection to an Emacs server.
% Collects input from Emacs, and runs commands.
% Sends commands to Emacs from MATLAB if needed.
%
properties
% True to send Emacs Stack info as the user steps through the debugger.
FollowStack = false;
end
properties (Access='protected')
tcpclient;
timer;
end
methods
function ES = EmacsServer()
% Construct the Emacs Server. Create the TCP client and
ES.tcpclient = tcpclient('localhost', 32475);
if isempty(ES.tcpclient)
delete(ES);
error('Unable to connect to Emacs.');
end
ES.timer = timer('Name','Emacs NetShell timer', ...
'TimerFcn', {@watch_emacs ES}, ...
'Period', 3,...
'BusyMode', 'drop',...
'ErrorFcn', {@drop_emacs ES},...
'ExecutionMode', 'fixedSpacing');
start(ES.timer);
ES.SendCommand('init');
end
function delete(ES)
try
stop(ES.timer);
end
delete(ES.tcpclient);
delete(ES.timer);
end
function SendCommand(ES, cmd, data)
% Commands have 2 parts, the COMMAND and DATA.
% COMMAND is sent to emacs followed by a newline. This should be a single
% word. SendCommand adds the newline.
% DATA can be any string.
% The full command is terminated by a NULL -> uint8(0)
write(ES.tcpclient, uint8([ cmd newline]));
if nargin > 2 && ~isempty(data)
write(ES.tcpclient, uint8(data));
end
write(ES.tcpclient, uint8(0));
end
function SendEval(ES, lispform)
% Send the LISPFFORM for Emacs to evaluate.
ES.SendCommand('eval', lispform);
end
end
properties (Access='protected')
accumulator = '';
end
methods (Access='protected')
function ReadCommand(ES)
msg = char(read(ES.tcpclient));
ES.accumulator = [ ES.accumulator msg ];
while ~isempty(ES.accumulator)
k = strfind(ES.accumulator, char(0));
if isempty(k)
% No complete commands. Exit.
disp(['partial accumulation: ' ES.accumulator]);
return;
end
datamsg = ES.accumulator(1:k(1)-1);
ES.accumulator = ES.accumulator(k(1)+1:end);
% Now peal the datamsg into it's constituant parts.
cr = strfind(datamsg, newline);
if isempty(cr)
cmd = datamsg;
data = '';
else
cmd = datamsg(1:cr(1)-1);
data = datamsg(cr(1)+1:end);
end
ES.ExecuteRemoteCommand(cmd, data);
end
end
function ExecuteRemoteCommand(ES, cmd, data)
% When we recieve a command from Emacs, eval it.
switch cmd
case 'nowledge'
disp('Acknowledgement recieved.');
case 'ack'
disp('Ack Recieved. Sending ack back.');
ES.SendCommand('nowledge');
case 'eval'
try
disp(['>> ' data]);
evalin('base',data);
catch ERR
disp(ERR.message);
ES.SendCommand('error', ERR.message);
end
case 'evalc'
disp('Evalc request.');
try
OUT = evalc(data);
catch ERR
OUT = ERR.message;
end
if ~isempty(OUT)
ES.SendCommand('output',uint8(OUT));
else
disp('No output');
end
otherwise
disp('Unknown command from Emacs');
end
end
end
end
function watch_emacs(~, ~, ES)
% Timer Callback Function:
% Watch for bytes available from the Emacs network connection, and act on any events.
ba = ES.tcpclient.BytesAvailable;
if ba > 0
ES.ReadCommand();
else
% Nothing recieved
%disp('No Luv from Emacs');
% Check if we are still alive. We can only do that with a
% write- so send an empty message.
try
write(ES.tcpclient, 0);
catch
disp('Connection to Emacs lost. Shutting down net server');
delete(ES);
end
end
if ES.FollowStack
es = getappdata(groot, 'EmacsStack');
[ST, I] = dbstack('-completenames');
es.updateEmacs(ST, I);
end
end
function drop_emacs(~, ~, ES)
% If the timer throws an error, then shutdown.
delete(ES);
disp('Error in timer, dropping connection to Emacs.');
end
|
