|
658
|
1 ;;; server.el --- Lisp code for GNU Emacs running as server process.
|
|
|
2
|
|
7300
|
3 ;; Copyright (C) 1986, 1987, 1992, 1994 Free Software Foundation, Inc.
|
|
844
|
4
|
|
787
|
5 ;; Author: William Sommerfeld <wesommer@athena.mit.edu>
|
|
814
|
6 ;; Keywords: processes
|
|
787
|
7
|
|
|
8 ;; Changes by peck@sun.com and by rms.
|
|
|
9
|
|
50
|
10 ;; This file is part of GNU Emacs.
|
|
|
11
|
|
|
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
|
|
|
13 ;; it under the terms of the GNU General Public License as published by
|
|
807
|
14 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
50
|
15 ;; any later version.
|
|
|
16
|
|
|
17 ;; GNU Emacs is distributed in the hope that it will be useful,
|
|
|
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
20 ;; GNU General Public License for more details.
|
|
|
21
|
|
|
22 ;; You should have received a copy of the GNU General Public License
|
|
|
23 ;; along with GNU Emacs; see the file COPYING. If not, write to
|
|
|
24 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
|
25
|
|
787
|
26 ;;; Commentary:
|
|
50
|
27
|
|
|
28 ;;; This Lisp code is run in Emacs when it is to operate as
|
|
|
29 ;;; a server for other processes.
|
|
|
30
|
|
|
31 ;;; Load this library and do M-x server-edit to enable Emacs as a server.
|
|
445
|
32 ;;; Emacs runs the program ../arch-lib/emacsserver as a subprocess
|
|
50
|
33 ;;; for communication with clients. If there are no client buffers to edit,
|
|
|
34 ;;; server-edit acts like (switch-to-buffer (other-buffer))
|
|
|
35
|
|
|
36 ;;; When some other program runs "the editor" to edit a file,
|
|
445
|
37 ;;; "the editor" can be the Emacs client program ../lib-src/emacsclient.
|
|
50
|
38 ;;; This program transmits the file names to Emacs through
|
|
|
39 ;;; the server subprocess, and Emacs visits them and lets you edit them.
|
|
|
40
|
|
|
41 ;;; Note that any number of clients may dispatch files to emacs to be edited.
|
|
|
42
|
|
|
43 ;;; When you finish editing a Server buffer, again call server-edit
|
|
|
44 ;;; to mark that buffer as done for the client and switch to the next
|
|
|
45 ;;; Server buffer. When all the buffers for a client have been edited
|
|
|
46 ;;; and exited with server-edit, the client "editor" will return
|
|
|
47 ;;; to the program that invoked it.
|
|
|
48
|
|
|
49 ;;; Your editing commands and Emacs's display output go to and from
|
|
|
50 ;;; the terminal in the usual way. Thus, server operation is possible
|
|
|
51 ;;; only when Emacs can talk to the terminal at the time you invoke
|
|
|
52 ;;; the client. This is possible in four cases:
|
|
|
53
|
|
|
54 ;;; 1. On a window system, where Emacs runs in one window and the
|
|
|
55 ;;; program that wants to use "the editor" runs in another.
|
|
|
56
|
|
|
57 ;;; 2. On a multi-terminal system, where Emacs runs on one terminal and the
|
|
|
58 ;;; program that wants to use "the editor" runs on another.
|
|
|
59
|
|
|
60 ;;; 3. When the program that wants to use "the editor" is running
|
|
|
61 ;;; as a subprocess of Emacs.
|
|
|
62
|
|
|
63 ;;; 4. On a system with job control, when Emacs is suspended, the program
|
|
|
64 ;;; that wants to use "the editor" will stop and display
|
|
|
65 ;;; "Waiting for Emacs...". It can then be suspended, and Emacs can be
|
|
|
66 ;;; brought into the foreground for editing. When done editing, Emacs is
|
|
|
67 ;;; suspended again, and the client program is brought into the foreground.
|
|
|
68
|
|
|
69 ;;; The buffer local variable "server-buffer-clients" lists
|
|
|
70 ;;; the clients who are waiting for this buffer to be edited.
|
|
|
71 ;;; The global variable "server-clients" lists all the waiting clients,
|
|
|
72 ;;; and which files are yet to be edited for each.
|
|
787
|
73
|
|
|
74 ;;; Code:
|
|
50
|
75
|
|
6176
|
76 (defvar server-program (expand-file-name "emacsserver" exec-directory)
|
|
5749
|
77 "*The program to use as the edit server.")
|
|
50
|
78
|
|
|
79 (defvar server-visit-hook nil
|
|
2866
|
80 "*List of hooks to call when visiting a file for the Emacs server.")
|
|
|
81
|
|
|
82 (defvar server-switch-hook nil
|
|
50
|
83 "*List of hooks to call when switching to a buffer for the Emacs server.")
|
|
|
84
|
|
7597
|
85 (defvar server-done-hook nil
|
|
|
86 "*List of hooks to call when done editing a buffer for the Emacs server.")
|
|
|
87
|
|
50
|
88 (defvar server-process nil
|
|
|
89 "the current server process")
|
|
|
90
|
|
138
|
91 (defvar server-previous-string "")
|
|
|
92
|
|
50
|
93 (defvar server-clients nil
|
|
|
94 "List of current server clients.
|
|
7736
|
95 Each element is (CLIENTID BUFFERS...) where CLIENTID is a string
|
|
50
|
96 that can be given to the server process to identify a client.
|
|
|
97 When a buffer is marked as \"done\", it is removed from this list.")
|
|
|
98
|
|
|
99 (defvar server-buffer-clients nil
|
|
|
100 "List of clientids for clients requesting editing of current buffer.")
|
|
6176
|
101 (make-variable-buffer-local 'server-buffer-clients)
|
|
50
|
102 ;; Changing major modes should not erase this local.
|
|
|
103 (put 'server-buffer-clients 'permanent-local t)
|
|
|
104
|
|
3661
|
105 (defvar server-window nil
|
|
|
106 "*The window to use for selecting Emacs server buffers.
|
|
|
107 If nil, use the selected window.
|
|
|
108 If it is a frame, use the frame's selected window.")
|
|
|
109
|
|
50
|
110 (defvar server-temp-file-regexp "^/tmp/Re\\|/draft$"
|
|
|
111 "*Regexp which should match filenames of temporary files
|
|
|
112 which are deleted and reused after each edit
|
|
|
113 by the programs that invoke the emacs server.")
|
|
|
114
|
|
|
115 (or (assq 'server-buffer-clients minor-mode-alist)
|
|
|
116 (setq minor-mode-alist (cons '(server-buffer-clients " Server") minor-mode-alist)))
|
|
|
117
|
|
|
118 ;; If a *server* buffer exists,
|
|
|
119 ;; write STRING to it for logging purposes.
|
|
|
120 (defun server-log (string)
|
|
|
121 (if (get-buffer "*server*")
|
|
|
122 (save-excursion
|
|
|
123 (set-buffer "*server*")
|
|
|
124 (goto-char (point-max))
|
|
|
125 (insert string)
|
|
|
126 (or (bobp) (newline)))))
|
|
|
127
|
|
|
128 (defun server-sentinel (proc msg)
|
|
|
129 (cond ((eq (process-status proc) 'exit)
|
|
|
130 (server-log (message "Server subprocess exited")))
|
|
|
131 ((eq (process-status proc) 'signal)
|
|
|
132 (server-log (message "Server subprocess killed")))))
|
|
|
133
|
|
256
|
134 ;;;###autoload
|
|
50
|
135 (defun server-start (&optional leave-dead)
|
|
|
136 "Allow this Emacs process to be a server for client processes.
|
|
|
137 This starts a server communications subprocess through which
|
|
|
138 client \"editors\" can send your editing commands to this Emacs job.
|
|
7855
|
139 To use the server, set up the program `emacsclient' in the
|
|
50
|
140 Emacs distribution as your standard \"editor\".
|
|
|
141
|
|
|
142 Prefix arg means just kill any existing server communications subprocess."
|
|
|
143 (interactive "P")
|
|
|
144 ;; kill it dead!
|
|
|
145 (if server-process
|
|
|
146 (progn
|
|
|
147 (set-process-sentinel server-process nil)
|
|
|
148 (condition-case () (delete-process server-process) (error nil))))
|
|
|
149 (condition-case () (delete-file "~/.emacs_server") (error nil))
|
8202
80350a95921a
(server-start): Try both possible socket file names for the file to delete.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
150 (condition-case ()
|
80350a95921a
(server-start): Try both possible socket file names for the file to delete.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
151 (delete-file (format "/tmp/esrv%d-%s" (user-uid) (system-name)))
|
80350a95921a
(server-start): Try both possible socket file names for the file to delete.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
152 (error nil))
|
|
50
|
153 ;; If we already had a server, clear out associated status.
|
|
|
154 (while server-clients
|
|
|
155 (let ((buffer (nth 1 (car server-clients))))
|
|
|
156 (server-buffer-done buffer)))
|
|
|
157 (if leave-dead
|
|
|
158 nil
|
|
|
159 (if server-process
|
|
|
160 (server-log (message "Restarting server")))
|
|
|
161 (setq server-process (start-process "server" nil server-program))
|
|
|
162 (set-process-sentinel server-process 'server-sentinel)
|
|
|
163 (set-process-filter server-process 'server-process-filter)
|
|
|
164 (process-kill-without-query server-process)))
|
|
|
165
|
|
|
166 ;Process a request from the server to edit some files.
|
|
|
167 ;Format of STRING is "Client: CLIENTID PATH PATH PATH... \n"
|
|
|
168 (defun server-process-filter (proc string)
|
|
|
169 (server-log string)
|
|
138
|
170 (setq string (concat server-previous-string string))
|
|
|
171 (if (not (and (eq ?\n (aref string (1- (length string))))
|
|
|
172 (eq 0 (string-match "Client: " string))))
|
|
|
173 ;; If input is not complete, save it for later.
|
|
|
174 (setq server-previous-string string)
|
|
|
175 ;; If it is complete, process it now, and discard what was saved.
|
|
50
|
176 (setq string (substring string (match-end 0)))
|
|
138
|
177 (setq server-previous-string "")
|
|
50
|
178 (let ((client (list (substring string 0 (string-match " " string))))
|
|
|
179 (files nil)
|
|
|
180 (lineno 1))
|
|
|
181 (setq string (substring string (match-end 0)))
|
|
|
182 (while (string-match "[^ ]+ " string)
|
|
|
183 (let ((arg
|
|
|
184 (substring string (match-beginning 0) (1- (match-end 0)))))
|
|
|
185 (setq string (substring string (match-end 0)))
|
|
|
186 (if (string-match "\\`\\+[0-9]+\\'" arg)
|
|
|
187 (setq lineno (read (substring arg 1)))
|
|
|
188 (setq files
|
|
|
189 (cons (list arg lineno)
|
|
|
190 files))
|
|
|
191 (setq lineno 1))))
|
|
|
192 (server-visit-files files client)
|
|
|
193 ;; CLIENT is now a list (CLIENTNUM BUFFERS...)
|
|
|
194 (setq server-clients (cons client server-clients))
|
|
3746
|
195 (server-switch-buffer (nth 1 client))
|
|
2866
|
196 (run-hooks 'server-switch-hook)
|
|
50
|
197 (message (substitute-command-keys
|
|
|
198 "When done with a buffer, type \\[server-edit].")))))
|
|
|
199
|
|
|
200 (defun server-visit-files (files client)
|
|
|
201 "Finds FILES and returns the list CLIENT with the buffers nconc'd.
|
|
|
202 FILES is an alist whose elements are (FILENAME LINENUMBER)."
|
|
7736
|
203 ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
|
|
|
204 (let (client-record (last-nonmenu-event t) (obuf (current-buffer)))
|
|
4500
|
205 ;; Restore the current buffer afterward, but not using save-excursion,
|
|
|
206 ;; because we don't want to save point in this buffer
|
|
|
207 ;; if it happens to be one of those specified by the server.
|
|
|
208 (unwind-protect
|
|
|
209 (while files
|
|
|
210 ;; If there is an existing buffer modified or the file is modified,
|
|
|
211 ;; revert it.
|
|
|
212 ;; If there is an existing buffer with deleted file, offer to write it.
|
|
|
213 (let* ((filen (car (car files)))
|
|
|
214 (obuf (get-file-buffer filen)))
|
|
|
215 (if (and obuf (set-buffer obuf))
|
|
|
216 (if (file-exists-p filen)
|
|
|
217 (if (or (not (verify-visited-file-modtime obuf))
|
|
|
218 (buffer-modified-p obuf))
|
|
|
219 (revert-buffer t nil))
|
|
|
220 (if (y-or-n-p
|
|
|
221 (concat "File no longer exists: "
|
|
|
222 filen
|
|
|
223 ", write buffer to file? "))
|
|
|
224 (write-file filen)))
|
|
|
225 (set-buffer (find-file-noselect filen))
|
|
|
226 (run-hooks 'server-visit-hook)))
|
|
|
227 (goto-line (nth 1 (car files)))
|
|
|
228 (setq server-buffer-clients (cons (car client) server-buffer-clients))
|
|
|
229 (setq client-record (cons (current-buffer) client-record))
|
|
|
230 (setq files (cdr files)))
|
|
|
231 (set-buffer obuf))
|
|
50
|
232 (nconc client client-record)))
|
|
|
233
|
|
|
234 (defun server-buffer-done (buffer)
|
|
|
235 "Mark BUFFER as \"done\" for its client(s).
|
|
|
236 Buries the buffer, and returns another server buffer
|
|
|
237 as a suggestion for what to select next."
|
|
|
238 (let ((running (eq (process-status server-process) 'run))
|
|
|
239 (next-buffer nil)
|
|
|
240 (old-clients server-clients))
|
|
|
241 (while old-clients
|
|
|
242 (let ((client (car old-clients)))
|
|
|
243 (or next-buffer
|
|
|
244 (setq next-buffer (nth 1 (memq buffer client))))
|
|
|
245 (delq buffer client)
|
|
|
246 ;; If client now has no pending buffers,
|
|
|
247 ;; tell it that it is done, and forget it entirely.
|
|
|
248 (if (cdr client) nil
|
|
|
249 (if running
|
|
|
250 (progn
|
|
|
251 (send-string server-process
|
|
|
252 (format "Close: %s Done\n" (car client)))
|
|
|
253 (server-log (format "Close: %s Done\n" (car client)))))
|
|
|
254 (setq server-clients (delq client server-clients))))
|
|
|
255 (setq old-clients (cdr old-clients)))
|
|
|
256 (if (buffer-name buffer)
|
|
6176
|
257 (progn
|
|
|
258 (save-excursion
|
|
|
259 (set-buffer buffer)
|
|
7597
|
260 (setq server-buffer-clients nil)
|
|
|
261 (run-hooks 'server-done-hook))
|
|
7553
|
262 (if (server-temp-file-p buffer)
|
|
|
263 (kill-buffer buffer)
|
|
|
264 (bury-buffer buffer))))
|
|
50
|
265 next-buffer))
|
|
|
266
|
|
|
267 (defun server-temp-file-p (buffer)
|
|
|
268 "Return non-nil if BUFFER contains a file considered temporary.
|
|
|
269 These are files whose names suggest they are repeatedly
|
|
|
270 reused to pass information to another program.
|
|
|
271
|
|
|
272 The variable `server-temp-file-regexp' controls which filenames
|
|
|
273 are considered temporary."
|
|
|
274 (and (buffer-file-name buffer)
|
|
|
275 (string-match server-temp-file-regexp (buffer-file-name buffer))))
|
|
|
276
|
|
|
277 (defun server-done ()
|
|
1540
|
278 "Offer to save current buffer, mark it as \"done\" for clients.
|
|
|
279 Then bury it, and return a suggested buffer to select next."
|
|
50
|
280 (let ((buffer (current-buffer)))
|
|
|
281 (if server-buffer-clients
|
|
7553
|
282 (progn
|
|
50
|
283 (if (server-temp-file-p buffer)
|
|
4096
|
284 ;; For a temp file, save, and do make a non-numeric backup
|
|
|
285 ;; (unless make-backup-files is nil).
|
|
|
286 (let ((version-control nil)
|
|
|
287 (buffer-backed-up nil))
|
|
7553
|
288 (save-buffer))
|
|
50
|
289 (if (and (buffer-modified-p)
|
|
|
290 (y-or-n-p (concat "Save file " buffer-file-name "? ")))
|
|
|
291 (save-buffer buffer)))
|
|
7553
|
292 (server-buffer-done buffer)))))
|
|
6176
|
293
|
|
|
294 ;; If a server buffer is killed, release its client.
|
|
|
295 ;; I'm not sure this is really a good idea--do you want the client
|
|
|
296 ;; to proceed using whatever is on disk in that file?
|
|
6993
|
297 (defun server-kill-buffer-query-function ()
|
|
|
298 (or (not server-buffer-clients)
|
|
|
299 (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
|
|
|
300 (buffer-name (current-buffer))))))
|
|
|
301
|
|
6176
|
302 (add-hook 'kill-buffer-query-functions
|
|
6993
|
303 'server-kill-buffer-query-function)
|
|
6176
|
304
|
|
6993
|
305 (defun server-kill-emacs-query-function ()
|
|
7736
|
306 (let (live-client
|
|
|
307 (tail server-clients))
|
|
|
308 ;; See if any clients have any buffers that are still alive.
|
|
|
309 (while tail
|
|
|
310 (if (memq t (mapcar 'stringp (mapcar 'buffer-name (cdr (car tail)))))
|
|
|
311 (setq live-client t))
|
|
|
312 (setq tail (cdr tail)))
|
|
|
313 (or (not live-client)
|
|
|
314 (yes-or-no-p "Server buffers still have clients; exit anyway? "))))
|
|
6993
|
315
|
|
|
316 (add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
|
|
50
|
317
|
|
|
318 (defun server-edit (&optional arg)
|
|
|
319 "Switch to next server editing buffer; say \"Done\" for current buffer.
|
|
|
320 If a server buffer is current, it is marked \"done\" and optionally saved.
|
|
|
321 When all of a client's buffers are marked as \"done\", the client is notified.
|
|
|
322
|
|
|
323 Temporary files such as MH <draft> files are always saved and backed up,
|
|
4096
|
324 no questions asked. (The variable `make-backup-files', if nil, still
|
|
|
325 inhibits a backup; you can set it locally in a particular buffer to
|
|
|
326 prevent a backup for it.) The variable `server-temp-file-regexp' controls
|
|
50
|
327 which filenames are considered temporary.
|
|
|
328
|
|
|
329 If invoked with a prefix argument, or if there is no server process running,
|
|
|
330 starts server process and that is all. Invoked by \\[server-edit]."
|
|
|
331
|
|
|
332 (interactive "P")
|
|
|
333 (if (or arg
|
|
|
334 (not server-process)
|
|
|
335 (memq (process-status server-process) '(signal exit)))
|
|
|
336 (server-start nil)
|
|
|
337 (server-switch-buffer (server-done))))
|
|
|
338
|
|
|
339 (defun server-switch-buffer (next-buffer)
|
|
|
340 "Switch to another buffer, preferably one that has a client.
|
|
|
341 Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
|
|
3661
|
342 (cond ((windowp server-window)
|
|
|
343 (select-window server-window))
|
|
|
344 ((framep server-window)
|
|
|
345 (select-window (frame-selected-window server-window))))
|
|
6182
|
346 (if (window-minibuffer-p (selected-window))
|
|
|
347 (select-window (next-window nil 'nomini t)))
|
|
50
|
348 (if next-buffer
|
|
|
349 (if (and (bufferp next-buffer)
|
|
|
350 (buffer-name next-buffer))
|
|
|
351 (switch-to-buffer next-buffer)
|
|
|
352 ;; If NEXT-BUFFER is a dead buffer,
|
|
|
353 ;; remove the server records for it
|
|
|
354 ;; and try the next surviving server buffer.
|
|
|
355 (server-switch-buffer
|
|
|
356 (server-buffer-done next-buffer)))
|
|
|
357 (if server-clients
|
|
|
358 (server-switch-buffer (nth 1 (car server-clients)))
|
|
|
359 (switch-to-buffer (other-buffer)))))
|
|
|
360
|
|
|
361 (global-set-key "\C-x#" 'server-edit)
|
|
1079
|
362
|
|
|
363 (provide 'server)
|
|
658
|
364
|
|
|
365 ;;; server.el ends here
|
