Commit | Line | Data |
---|---|---|
c88ab9ce ER |
1 | ;;; server.el --- Lisp code for GNU Emacs running as server process. |
2 | ||
f8c25f1b | 3 | ;; Copyright (C) 1986, 1987, 1992, 1994, 1995 Free Software Foundation, Inc. |
6d74b528 | 4 | |
630cc463 | 5 | ;; Author: William Sommerfeld <wesommer@athena.mit.edu> |
d7b4d18f | 6 | ;; Keywords: processes |
630cc463 | 7 | |
9ae0f972 | 8 | ;; Changes by peck@sun.com and by rms. |
9 | ||
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 | |
e5167999 | 14 | ;; the Free Software Foundation; either version 2, or (at your option) |
9ae0f972 | 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 | ||
630cc463 | 26 | ;;; Commentary: |
9ae0f972 | 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. | |
87855006 | 32 | ;;; Emacs runs the program ../arch-lib/emacsserver as a subprocess |
9ae0f972 | 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, | |
87855006 | 37 | ;;; "the editor" can be the Emacs client program ../lib-src/emacsclient. |
9ae0f972 | 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. | |
630cc463 ER |
73 | |
74 | ;;; Code: | |
9ae0f972 | 75 | \f |
faf931a8 | 76 | (defvar server-program (expand-file-name "emacsserver" exec-directory) |
f0e70117 | 77 | "*The program to use as the edit server.") |
9ae0f972 | 78 | |
79 | (defvar server-visit-hook nil | |
1b7899a5 JB |
80 | "*List of hooks to call when visiting a file for the Emacs server.") |
81 | ||
82 | (defvar server-switch-hook nil | |
9ae0f972 | 83 | "*List of hooks to call when switching to a buffer for the Emacs server.") |
84 | ||
f9b3ef88 RS |
85 | (defvar server-done-hook nil |
86 | "*List of hooks to call when done editing a buffer for the Emacs server.") | |
87 | ||
9ae0f972 | 88 | (defvar server-process nil |
89 | "the current server process") | |
90 | ||
b53d289e RS |
91 | (defvar server-previous-string "") |
92 | ||
9ae0f972 | 93 | (defvar server-clients nil |
94 | "List of current server clients. | |
e82e73c2 | 95 | Each element is (CLIENTID BUFFERS...) where CLIENTID is a string |
9ae0f972 | 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.") | |
faf931a8 | 101 | (make-variable-buffer-local 'server-buffer-clients) |
9ae0f972 | 102 | ;; Changing major modes should not erase this local. |
103 | (put 'server-buffer-clients 'permanent-local t) | |
104 | ||
ec40ed9f RS |
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 | ||
9ae0f972 | 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 | ||
9ae0f972 | 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 | ||
7229064d | 134 | ;;;###autoload |
9ae0f972 | 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. | |
42bbacdf | 139 | To use the server, set up the program `emacsclient' in the |
9ae0f972 | 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)) | |
e89da28d RS |
150 | (condition-case () |
151 | (delete-file (format "/tmp/esrv%d-%s" (user-uid) (system-name))) | |
152 | (error nil)) | |
9ae0f972 | 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"))) | |
838cd60d RS |
161 | ;; Using a pty is wasteful, and the separate session causes |
162 | ;; annoyance sometimes (some systems kill idle sessions). | |
163 | (let ((process-connection-type nil)) | |
164 | (setq server-process (start-process "server" nil server-program))) | |
9ae0f972 | 165 | (set-process-sentinel server-process 'server-sentinel) |
166 | (set-process-filter server-process 'server-process-filter) | |
167 | (process-kill-without-query server-process))) | |
168 | \f | |
169 | ;Process a request from the server to edit some files. | |
170 | ;Format of STRING is "Client: CLIENTID PATH PATH PATH... \n" | |
171 | (defun server-process-filter (proc string) | |
172 | (server-log string) | |
b53d289e | 173 | (setq string (concat server-previous-string string)) |
68469f74 RS |
174 | ;; If the input is multiple lines, |
175 | ;; process each line individually. | |
176 | (while (string-match "\n" string) | |
177 | (let ((request (substring string 0 (match-beginning 0))) | |
178 | client | |
9ae0f972 | 179 | (files nil) |
180 | (lineno 1)) | |
68469f74 RS |
181 | ;; Remove this line from STRING. |
182 | (setq string (substring string (match-end 0))) | |
183 | (if (string-match "^Client: " request) | |
184 | (setq request (substring request (match-end 0)))) | |
185 | (setq client (list (substring request 0 (string-match " " request)))) | |
186 | (setq request (substring request (match-end 0))) | |
187 | (while (string-match "[^ ]+ " request) | |
9ae0f972 | 188 | (let ((arg |
68469f74 RS |
189 | (substring request (match-beginning 0) (1- (match-end 0))))) |
190 | (setq request (substring request (match-end 0))) | |
9ae0f972 | 191 | (if (string-match "\\`\\+[0-9]+\\'" arg) |
192 | (setq lineno (read (substring arg 1))) | |
193 | (setq files | |
194 | (cons (list arg lineno) | |
195 | files)) | |
196 | (setq lineno 1)))) | |
197 | (server-visit-files files client) | |
198 | ;; CLIENT is now a list (CLIENTNUM BUFFERS...) | |
199 | (setq server-clients (cons client server-clients)) | |
01906bca | 200 | (server-switch-buffer (nth 1 client)) |
1b7899a5 | 201 | (run-hooks 'server-switch-hook) |
9ae0f972 | 202 | (message (substitute-command-keys |
68469f74 RS |
203 | "When done with a buffer, type \\[server-edit].")))) |
204 | ;; Save for later any partial line that remains. | |
205 | (setq server-previous-string string)) | |
9ae0f972 | 206 | |
207 | (defun server-visit-files (files client) | |
208 | "Finds FILES and returns the list CLIENT with the buffers nconc'd. | |
209 | FILES is an alist whose elements are (FILENAME LINENUMBER)." | |
e82e73c2 RS |
210 | ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries. |
211 | (let (client-record (last-nonmenu-event t) (obuf (current-buffer))) | |
3a0ce849 RS |
212 | ;; Restore the current buffer afterward, but not using save-excursion, |
213 | ;; because we don't want to save point in this buffer | |
214 | ;; if it happens to be one of those specified by the server. | |
215 | (unwind-protect | |
216 | (while files | |
217 | ;; If there is an existing buffer modified or the file is modified, | |
218 | ;; revert it. | |
219 | ;; If there is an existing buffer with deleted file, offer to write it. | |
220 | (let* ((filen (car (car files))) | |
221 | (obuf (get-file-buffer filen))) | |
222 | (if (and obuf (set-buffer obuf)) | |
223 | (if (file-exists-p filen) | |
224 | (if (or (not (verify-visited-file-modtime obuf)) | |
225 | (buffer-modified-p obuf)) | |
226 | (revert-buffer t nil)) | |
227 | (if (y-or-n-p | |
228 | (concat "File no longer exists: " | |
229 | filen | |
230 | ", write buffer to file? ")) | |
231 | (write-file filen))) | |
232 | (set-buffer (find-file-noselect filen)) | |
233 | (run-hooks 'server-visit-hook))) | |
234 | (goto-line (nth 1 (car files))) | |
235 | (setq server-buffer-clients (cons (car client) server-buffer-clients)) | |
236 | (setq client-record (cons (current-buffer) client-record)) | |
237 | (setq files (cdr files))) | |
238 | (set-buffer obuf)) | |
9ae0f972 | 239 | (nconc client client-record))) |
240 | \f | |
241 | (defun server-buffer-done (buffer) | |
242 | "Mark BUFFER as \"done\" for its client(s). | |
9184aafb RS |
243 | This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED). |
244 | NEXT-BUFFER is another server buffer, as a suggestion for what to select next, | |
245 | or nil. KILLED is t if we killed BUFFER (because it was a temp file)." | |
9ae0f972 | 246 | (let ((running (eq (process-status server-process) 'run)) |
247 | (next-buffer nil) | |
9184aafb | 248 | (killed nil) |
9ae0f972 | 249 | (old-clients server-clients)) |
250 | (while old-clients | |
251 | (let ((client (car old-clients))) | |
252 | (or next-buffer | |
253 | (setq next-buffer (nth 1 (memq buffer client)))) | |
254 | (delq buffer client) | |
68469f74 RS |
255 | ;; Delete all dead buffers from CLIENT. |
256 | (let ((tail client)) | |
257 | (while tail | |
258 | (and (bufferp (car tail)) | |
259 | (null (buffer-name (car tail))) | |
260 | (delq (car tail) client)) | |
261 | (setq tail (cdr tail)))) | |
9ae0f972 | 262 | ;; If client now has no pending buffers, |
263 | ;; tell it that it is done, and forget it entirely. | |
264 | (if (cdr client) nil | |
265 | (if running | |
266 | (progn | |
267 | (send-string server-process | |
268 | (format "Close: %s Done\n" (car client))) | |
68469f74 RS |
269 | (server-log (format "Close: %s Done\n" (car client))) |
270 | ;; Don't send emacsserver two commands in close succession. | |
271 | ;; It cannot handle that. | |
272 | (sit-for 1))) | |
9ae0f972 | 273 | (setq server-clients (delq client server-clients)))) |
274 | (setq old-clients (cdr old-clients))) | |
68469f74 | 275 | (if (and (bufferp buffer) (buffer-name buffer)) |
faf931a8 RS |
276 | (progn |
277 | (save-excursion | |
278 | (set-buffer buffer) | |
f9b3ef88 RS |
279 | (setq server-buffer-clients nil) |
280 | (run-hooks 'server-done-hook)) | |
c58bf9ae | 281 | (if (server-temp-file-p buffer) |
9184aafb RS |
282 | (progn (kill-buffer buffer) |
283 | (setq killed t)) | |
c58bf9ae | 284 | (bury-buffer buffer)))) |
9184aafb | 285 | (list next-buffer killed))) |
9ae0f972 | 286 | |
287 | (defun server-temp-file-p (buffer) | |
288 | "Return non-nil if BUFFER contains a file considered temporary. | |
289 | These are files whose names suggest they are repeatedly | |
290 | reused to pass information to another program. | |
291 | ||
292 | The variable `server-temp-file-regexp' controls which filenames | |
293 | are considered temporary." | |
294 | (and (buffer-file-name buffer) | |
295 | (string-match server-temp-file-regexp (buffer-file-name buffer)))) | |
296 | ||
297 | (defun server-done () | |
cc9875f9 | 298 | "Offer to save current buffer, mark it as \"done\" for clients. |
9184aafb RS |
299 | This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED). |
300 | NEXT-BUFFER is another server buffer, as a suggestion for what to select next, | |
301 | or nil. KILLED is t if we killed the BUFFER (because it was a temp file)." | |
9ae0f972 | 302 | (let ((buffer (current-buffer))) |
303 | (if server-buffer-clients | |
c58bf9ae | 304 | (progn |
9ae0f972 | 305 | (if (server-temp-file-p buffer) |
991298c3 RS |
306 | ;; For a temp file, save, and do make a non-numeric backup |
307 | ;; (unless make-backup-files is nil). | |
308 | (let ((version-control nil) | |
309 | (buffer-backed-up nil)) | |
c58bf9ae | 310 | (save-buffer)) |
9ae0f972 | 311 | (if (and (buffer-modified-p) |
312 | (y-or-n-p (concat "Save file " buffer-file-name "? "))) | |
313 | (save-buffer buffer))) | |
c58bf9ae | 314 | (server-buffer-done buffer))))) |
faf931a8 | 315 | |
71207de2 RS |
316 | ;; Ask before killing a server buffer. |
317 | ;; It was suggested to release its client instead, | |
318 | ;; but I think that is dangerous--the client would proceed | |
319 | ;; using whatever is on disk in that file. -- rms. | |
03d78665 RS |
320 | (defun server-kill-buffer-query-function () |
321 | (or (not server-buffer-clients) | |
322 | (yes-or-no-p (format "Buffer `%s' still has clients; kill it? " | |
323 | (buffer-name (current-buffer)))))) | |
324 | ||
faf931a8 | 325 | (add-hook 'kill-buffer-query-functions |
03d78665 RS |
326 | 'server-kill-buffer-query-function) |
327 | ||
328 | (defun server-kill-emacs-query-function () | |
e82e73c2 RS |
329 | (let (live-client |
330 | (tail server-clients)) | |
331 | ;; See if any clients have any buffers that are still alive. | |
332 | (while tail | |
333 | (if (memq t (mapcar 'stringp (mapcar 'buffer-name (cdr (car tail))))) | |
334 | (setq live-client t)) | |
335 | (setq tail (cdr tail))) | |
336 | (or (not live-client) | |
337 | (yes-or-no-p "Server buffers still have clients; exit anyway? ")))) | |
03d78665 RS |
338 | |
339 | (add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function) | |
9ae0f972 | 340 | \f |
341 | (defun server-edit (&optional arg) | |
342 | "Switch to next server editing buffer; say \"Done\" for current buffer. | |
343 | If a server buffer is current, it is marked \"done\" and optionally saved. | |
344 | When all of a client's buffers are marked as \"done\", the client is notified. | |
345 | ||
346 | Temporary files such as MH <draft> files are always saved and backed up, | |
991298c3 RS |
347 | no questions asked. (The variable `make-backup-files', if nil, still |
348 | inhibits a backup; you can set it locally in a particular buffer to | |
349 | prevent a backup for it.) The variable `server-temp-file-regexp' controls | |
9ae0f972 | 350 | which filenames are considered temporary. |
351 | ||
352 | If invoked with a prefix argument, or if there is no server process running, | |
353 | starts server process and that is all. Invoked by \\[server-edit]." | |
9ae0f972 | 354 | (interactive "P") |
355 | (if (or arg | |
356 | (not server-process) | |
357 | (memq (process-status server-process) '(signal exit))) | |
358 | (server-start nil) | |
9184aafb | 359 | (apply 'server-switch-buffer (server-done)))) |
9ae0f972 | 360 | |
9184aafb | 361 | (defun server-switch-buffer (next-buffer &optional killed-one) |
9ae0f972 | 362 | "Switch to another buffer, preferably one that has a client. |
363 | Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it." | |
9184aafb RS |
364 | ;; KILLED-ONE is t in a recursive call |
365 | ;; if we have already killed one temp-file server buffer. | |
366 | ;; This means we should avoid the final "switch to some other buffer" | |
367 | ;; since we've already effectively done that. | |
396e0e6a RS |
368 | (cond ((and (windowp server-window) |
369 | (window-live-p server-window)) | |
ec40ed9f RS |
370 | (select-window server-window)) |
371 | ((framep server-window) | |
396e0e6a RS |
372 | (if (not (frame-live-p server-window)) |
373 | (setq server-window (make-frame))) | |
ec40ed9f | 374 | (select-window (frame-selected-window server-window)))) |
e5ccf0c1 | 375 | (if (window-minibuffer-p (selected-window)) |
02a8d137 RS |
376 | (select-window (next-window nil 'nomini 0))) |
377 | ;; Move to a non-dedicated window, if we have one. | |
378 | (let ((last-window (previous-window nil 'nomini 0))) | |
379 | (while (and (window-dedicated-p (selected-window)) | |
380 | (not (eq last-window (selected-window)))) | |
381 | (select-window (next-window nil 'nomini 0)))) | |
382 | (set-window-dedicated-p (selected-window) nil) | |
9ae0f972 | 383 | (if next-buffer |
384 | (if (and (bufferp next-buffer) | |
385 | (buffer-name next-buffer)) | |
386 | (switch-to-buffer next-buffer) | |
387 | ;; If NEXT-BUFFER is a dead buffer, | |
388 | ;; remove the server records for it | |
389 | ;; and try the next surviving server buffer. | |
9184aafb RS |
390 | (apply 'server-switch-buffer |
391 | (server-buffer-done next-buffer))) | |
9ae0f972 | 392 | (if server-clients |
9184aafb RS |
393 | (server-switch-buffer (nth 1 (car server-clients)) killed-one) |
394 | (if (not killed-one) | |
395 | (switch-to-buffer (other-buffer)))))) | |
9ae0f972 | 396 | |
397 | (global-set-key "\C-x#" 'server-edit) | |
16c15321 RM |
398 | \f |
399 | (provide 'server) | |
c88ab9ce ER |
400 | |
401 | ;;; server.el ends here |