Trivial typo.
[bpt/emacs.git] / lisp / server.el
CommitLineData
55535639 1;;; server.el --- Lisp code for GNU Emacs running as server process
c88ab9ce 2
0d30b337 3;; Copyright (C) 1986, 1987, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
aaef169d 4;; 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
6d74b528 5
630cc463 6;; Author: William Sommerfeld <wesommer@athena.mit.edu>
e4874521 7;; Maintainer: FSF
d7b4d18f 8;; Keywords: processes
630cc463 9
9ae0f972 10;; Changes by peck@sun.com and by rms.
11
12;; This file is part of GNU Emacs.
13
14;; GNU Emacs is free software; you can redistribute it and/or modify
15;; it under the terms of the GNU General Public License as published by
e5167999 16;; the Free Software Foundation; either version 2, or (at your option)
9ae0f972 17;; any later version.
18
19;; GNU Emacs is distributed in the hope that it will be useful,
20;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22;; GNU General Public License for more details.
23
24;; You should have received a copy of the GNU General Public License
b578f267 25;; along with GNU Emacs; see the file COPYING. If not, write to the
086add15
LK
26;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27;; Boston, MA 02110-1301, USA.
9ae0f972 28
630cc463 29;;; Commentary:
9ae0f972 30
b578f267
EN
31;; This Lisp code is run in Emacs when it is to operate as
32;; a server for other processes.
9ae0f972 33
b578f267 34;; Load this library and do M-x server-edit to enable Emacs as a server.
44a56b29
SM
35;; Emacs opens up a socket for communication with clients. If there are no
36;; client buffers to edit, server-edit acts like (switch-to-buffer
37;; (other-buffer))
9ae0f972 38
b578f267
EN
39;; When some other program runs "the editor" to edit a file,
40;; "the editor" can be the Emacs client program ../lib-src/emacsclient.
41;; This program transmits the file names to Emacs through
42;; the server subprocess, and Emacs visits them and lets you edit them.
9ae0f972 43
b578f267 44;; Note that any number of clients may dispatch files to emacs to be edited.
9ae0f972 45
b578f267 46;; When you finish editing a Server buffer, again call server-edit
64f51134
JPW
47;; to mark that buffer as done for the client and switch to the next
48;; Server buffer. When all the buffers for a client have been edited
b578f267 49;; and exited with server-edit, the client "editor" will return
64f51134 50;; to the program that invoked it.
9ae0f972 51
b578f267
EN
52;; Your editing commands and Emacs's display output go to and from
53;; the terminal in the usual way. Thus, server operation is possible
54;; only when Emacs can talk to the terminal at the time you invoke
55;; the client. This is possible in four cases:
9ae0f972 56
b578f267
EN
57;; 1. On a window system, where Emacs runs in one window and the
58;; program that wants to use "the editor" runs in another.
9ae0f972 59
b578f267
EN
60;; 2. On a multi-terminal system, where Emacs runs on one terminal and the
61;; program that wants to use "the editor" runs on another.
9ae0f972 62
b578f267
EN
63;; 3. When the program that wants to use "the editor" is running
64;; as a subprocess of Emacs.
9ae0f972 65
b578f267
EN
66;; 4. On a system with job control, when Emacs is suspended, the program
67;; that wants to use "the editor" will stop and display
68;; "Waiting for Emacs...". It can then be suspended, and Emacs can be
69;; brought into the foreground for editing. When done editing, Emacs is
70;; suspended again, and the client program is brought into the foreground.
9ae0f972 71
64f51134
JPW
72;; The buffer local variable "server-buffer-clients" lists
73;; the clients who are waiting for this buffer to be edited.
b578f267
EN
74;; The global variable "server-clients" lists all the waiting clients,
75;; and which files are yet to be edited for each.
630cc463
ER
76
77;;; Code:
8b3e840e
SM
78
79(eval-when-compile (require 'cl))
80
ab1c7f35
RS
81(defgroup server nil
82 "Emacs running as a server process."
83 :group 'external)
84
ab1c7f35 85(defcustom server-visit-hook nil
0c851d78 86 "*Hook run when visiting a file for the Emacs server."
ab1c7f35 87 :group 'server
0c851d78 88 :type 'hook)
ab1c7f35
RS
89
90(defcustom server-switch-hook nil
0c851d78 91 "*Hook run when switching to a buffer for the Emacs server."
ab1c7f35 92 :group 'server
0c851d78 93 :type 'hook)
ab1c7f35
RS
94
95(defcustom server-done-hook nil
0c851d78 96 "*Hook run when done editing a buffer for the Emacs server."
ab1c7f35 97 :group 'server
0c851d78 98 :type 'hook)
f9b3ef88 99
64f51134
JPW
100(defvar server-process nil
101 "The current server process.")
9ae0f972 102
103(defvar server-clients nil
104 "List of current server clients.
e82e73c2 105Each element is (CLIENTID BUFFERS...) where CLIENTID is a string
9ae0f972 106that can be given to the server process to identify a client.
107When a buffer is marked as \"done\", it is removed from this list.")
108
109(defvar server-buffer-clients nil
b5a9911c 110 "List of client ids for clients requesting editing of current buffer.")
faf931a8 111(make-variable-buffer-local 'server-buffer-clients)
9ae0f972 112;; Changing major modes should not erase this local.
113(put 'server-buffer-clients 'permanent-local t)
114
33186f32
DL
115(defcustom server-window nil
116 "*Specification of the window to use for selecting Emacs server buffers.
ec40ed9f 117If nil, use the selected window.
408784a7 118If it is a function, it should take one argument (a buffer) and
33186f32
DL
119display and select it. A common value is `pop-to-buffer'.
120If it is a window, use that.
121If it is a frame, use the frame's selected window.
122
123It is not meaningful to set this to a specific frame or window with Custom.
124Only programs can do so."
125 :group 'server
bf247b6e 126 :version "22.1"
33186f32
DL
127 :type '(choice (const :tag "Use selected window"
128 :match (lambda (widget value)
129 (not (functionp value)))
130 nil)
131 (function-item :tag "Use pop-to-buffer" pop-to-buffer)
132 (function :tag "Other function")))
ec40ed9f 133
ab1c7f35 134(defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
33186f32
DL
135 "*Regexp matching names of temporary files.
136These are deleted and reused after each edit by the programs that
137invoke the Emacs server."
ab1c7f35
RS
138 :group 'server
139 :type 'regexp)
9ae0f972 140
c6a117f0
GM
141(defcustom server-kill-new-buffers t
142 "*Whether to kill buffers when done with them.
143If non-nil, kill a buffer unless it already existed before editing
64f51134 144it with Emacs server. If nil, kill only buffers as specified by
c6a117f0
GM
145`server-temp-file-regexp'.
146Please note that only buffers are killed that still have a client,
147i.e. buffers visited which \"emacsclient --no-wait\" are never killed in
148this way."
149 :group 'server
150 :type 'boolean
151 :version "21.1")
152
9ae0f972 153(or (assq 'server-buffer-clients minor-mode-alist)
154 (setq minor-mode-alist (cons '(server-buffer-clients " Server") minor-mode-alist)))
155
c6a117f0 156(defvar server-existing-buffer nil
ca0c7250 157 "Non-nil means the buffer existed before the server was asked to visit it.
4dd04714 158This means that the server should not kill the buffer when you say you
ca0c7250 159are done with it in the server.")
c6a117f0
GM
160(make-variable-buffer-local 'server-existing-buffer)
161
03ae35cf
SM
162(defvar server-name "server")
163
164(defvar server-socket-dir
165 (format "/tmp/emacs%d" (user-uid)))
0c851d78 166
8b3e840e 167(defun server-log (string &optional client)
33186f32 168 "If a *server* buffer exists, write STRING to it for logging purposes."
9ae0f972 169 (if (get-buffer "*server*")
8b3e840e 170 (with-current-buffer "*server*"
9ae0f972 171 (goto-char (point-max))
8b3e840e 172 (insert (current-time-string)
0c851d78 173 (if client (format " %s:" client) " ")
8b3e840e 174 string)
74c20cd3 175 (or (bolp) (newline)))))
9ae0f972 176
177(defun server-sentinel (proc msg)
408784a7 178 (let ((client (assq proc server-clients)))
0c851d78 179 ;; Remove PROC from the list of clients.
408784a7
SM
180 (when client
181 (setq server-clients (delq client server-clients))
182 (dolist (buf (cdr client))
183 (with-current-buffer buf
184 ;; Remove PROC from the clients of each buffer.
185 (setq server-buffer-clients (delq proc server-buffer-clients))
186 ;; Kill the buffer if necessary.
187 (when (and (null server-buffer-clients)
188 (or (and server-kill-new-buffers
189 (not server-existing-buffer))
190 (server-temp-file-p)))
191 (kill-buffer (current-buffer)))))))
cbfc02e4
RF
192 ;; If this is a new client process, set the query-on-exit flag to nil
193 ;; for this process (it isn't inherited from the server process).
194 (when (and (eq (process-status proc) 'open)
195 (process-query-on-exit-flag proc))
196 (set-process-query-on-exit-flag proc nil))
0c851d78
SM
197 (server-log (format "Status changed to %s" (process-status proc)) proc))
198
44a56b29
SM
199(defun server-select-display (display)
200 ;; If the current frame is on `display' we're all set.
201 (unless (equal (frame-parameter (selected-frame) 'display) display)
202 ;; Otherwise, look for an existing frame there and select it.
203 (dolist (frame (frame-list))
204 (when (equal (frame-parameter frame 'display) display)
205 (select-frame frame)))
206 ;; If there's no frame on that display yet, create a dummy one
207 ;; and select it.
208 (unless (equal (frame-parameter (selected-frame) 'display) display)
209 (select-frame
210 (make-frame-on-display
211 display
212 ;; This frame is only there in place of an actual "current display"
213 ;; setting, so we want it to be as unobtrusive as possible. That's
214 ;; what the invisibility is for. The minibuffer setting is so that
215 ;; we don't end up displaying a buffer in it (which noone would
216 ;; notice).
217 '((visibility . nil) (minibuffer . only)))))))
218
0c851d78
SM
219(defun server-unquote-arg (arg)
220 (replace-regexp-in-string
221 "&." (lambda (s)
222 (case (aref s 1)
223 (?& "&")
224 (?- "-")
225 (?n "\n")
226 (t " ")))
227 arg t t))
9ae0f972 228
724629d2
SM
229(defun server-ensure-safe-dir (dir)
230 "Make sure DIR is a directory with no race-condition issues.
231Creates the directory if necessary and makes sure:
232- there's no symlink involved
233- it's owned by us
234- it's not readable/writable by anybody else."
235 (setq dir (directory-file-name dir))
236 (let ((attrs (file-attributes dir)))
237 (unless attrs
238 (letf (((default-file-modes) ?\700)) (make-directory dir))
239 (setq attrs (file-attributes dir)))
240 ;; Check that it's safe for use.
241 (unless (and (eq t (car attrs)) (eq (nth 2 attrs) (user-uid))
242 (zerop (logand ?\077 (file-modes dir))))
243 (error "The directory %s is unsafe" dir))))
244
7229064d 245;;;###autoload
9ae0f972 246(defun server-start (&optional leave-dead)
247 "Allow this Emacs process to be a server for client processes.
248This starts a server communications subprocess through which
249client \"editors\" can send your editing commands to this Emacs job.
42bbacdf 250To use the server, set up the program `emacsclient' in the
9ae0f972 251Emacs distribution as your standard \"editor\".
252
253Prefix arg means just kill any existing server communications subprocess."
254 (interactive "P")
724629d2 255 ;; Make sure there is a safe directory in which to place the socket.
03ae35cf 256 (server-ensure-safe-dir server-socket-dir)
9ae0f972 257 ;; kill it dead!
60f8ea53
JPW
258 (if server-process
259 (condition-case () (delete-process server-process) (error nil)))
c1148e39 260 ;; Delete the socket files made by previous server invocations.
03ae35cf
SM
261 (condition-case ()
262 (delete-file (expand-file-name server-name server-socket-dir))
263 (error nil))
c1148e39 264 ;; If this Emacs already had a server, clear out associated status.
9ae0f972 265 (while server-clients
266 (let ((buffer (nth 1 (car server-clients))))
267 (server-buffer-done buffer)))
8b3e840e 268 (unless leave-dead
9ae0f972 269 (if server-process
270 (server-log (message "Restarting server")))
e5576936
SM
271 (letf (((default-file-modes) ?\700))
272 (setq server-process
273 (make-network-process
274 :name "server" :family 'local :server t :noquery t
03ae35cf 275 :service (expand-file-name server-name server-socket-dir)
e5576936
SM
276 :sentinel 'server-sentinel :filter 'server-process-filter
277 ;; We must receive file names without being decoded.
278 ;; Those are decoded by server-process-filter according
279 ;; to file-name-coding-system.
280 :coding 'raw-text)))))
33186f32
DL
281
282;;;###autoload
283(define-minor-mode server-mode
284 "Toggle Server mode.
285With ARG, turn Server mode on if ARG is positive, off otherwise.
286Server mode runs a process that accepts commands from the
287`emacsclient' program. See `server-start' and Info node `Emacs server'."
288 :global t
289 :group 'server
bf247b6e 290 :version "22.1"
33186f32
DL
291 ;; Fixme: Should this check for an existing server socket and do
292 ;; nothing if there is one (for multiple Emacs sessions)?
293 (server-start (not server-mode)))
9ae0f972 294\f
9ae0f972 295(defun server-process-filter (proc string)
33186f32
DL
296 "Process a request from the server to edit some files.
297PROC is the server process. Format of STRING is \"PATH PATH PATH... \\n\"."
0c851d78 298 (server-log string proc)
3f7ef08e
SM
299 (let ((prev (process-get proc 'previous-string)))
300 (when prev
301 (setq string (concat prev string))
302 (process-put proc 'previous-string nil)))
68469f74
RS
303 ;; If the input is multiple lines,
304 ;; process each line individually.
305 (while (string-match "\n" string)
306 (let ((request (substring string 0 (match-beginning 0)))
6b7430a8
KH
307 (coding-system (and default-enable-multibyte-characters
308 (or file-name-coding-system
309 default-file-name-coding-system)))
44a56b29 310 client nowait eval
9ae0f972 311 (files nil)
8c493570 312 (lineno 1)
5b421c81 313 (tmp-frame nil) ; Sometimes used to embody the selected display.
8c493570 314 (columnno 0))
68469f74 315 ;; Remove this line from STRING.
0c851d78
SM
316 (setq string (substring string (match-end 0)))
317 (setq client (cons proc nil))
318 (while (string-match "[^ ]* " request)
724629d2 319 (let ((arg (substring request (match-beginning 0) (1- (match-end 0)))))
0c851d78
SM
320 (setq request (substring request (match-end 0)))
321 (cond
322 ((equal "-nowait" arg) (setq nowait t))
724629d2 323 ((equal "-eval" arg) (setq eval t))
44a56b29
SM
324 ((and (equal "-display" arg) (string-match "\\([^ ]*\\) " request))
325 (let ((display (server-unquote-arg (match-string 1 request))))
326 (setq request (substring request (match-end 0)))
327 (condition-case err
5b421c81 328 (setq tmp-frame (server-select-display display))
44a56b29
SM
329 (error (process-send-string proc (nth 1 err))
330 (setq request "")))))
0c851d78
SM
331 ;; ARG is a line number option.
332 ((string-match "\\`\\+[0-9]+\\'" arg)
027a4b6b 333 (setq lineno (string-to-number (substring arg 1))))
0c851d78
SM
334 ;; ARG is line number:column option.
335 ((string-match "\\`+\\([0-9]+\\):\\([0-9]+\\)\\'" arg)
027a4b6b
JB
336 (setq lineno (string-to-number (match-string 1 arg))
337 columnno (string-to-number (match-string 2 arg))))
0c851d78
SM
338 (t
339 ;; Undo the quoting that emacsclient does
340 ;; for certain special characters.
341 (setq arg (server-unquote-arg arg))
342 ;; Now decode the file name if necessary.
343 (if coding-system
344 (setq arg (decode-coding-string arg coding-system)))
44a56b29 345 (if eval
c6ce06a6
AS
346 (let* (errorp
347 (v (condition-case errobj
348 (eval (car (read-from-string arg)))
349 (error (setq errorp t) errobj))))
44a56b29
SM
350 (when v
351 (with-temp-buffer
352 (let ((standard-output (current-buffer)))
c6ce06a6 353 (if errorp (princ "error: "))
44a56b29 354 (pp v)
9afed9b1
MY
355 ;; Suppress the error rose when the pipe to PROC is closed.
356 (condition-case err
357 (process-send-region proc (point-min) (point-max))
51b4073a
MY
358 (file-error nil)
359 (error nil))
9afed9b1 360 ))))
44a56b29
SM
361 ;; ARG is a file name.
362 ;; Collapse multiple slashes to single slashes.
363 (setq arg (command-line-normalize-file-name arg))
364 (push (list arg lineno columnno) files))
0c851d78
SM
365 (setq lineno 1)
366 (setq columnno 0)))))
367 (when files
368 (run-hooks 'pre-command-hook)
369 (server-visit-files files client nowait)
370 (run-hooks 'post-command-hook))
371 ;; CLIENT is now a list (CLIENTNUM BUFFERS...)
372 (if (null (cdr client))
373 ;; This client is empty; get rid of it immediately.
374 (progn
375 (delete-process proc)
376 (server-log "Close empty client" proc))
377 ;; We visited some buffer for this client.
378 (or nowait (push client server-clients))
64f51134 379 (unless (or isearch-mode (minibufferp))
cf1175df
RS
380 (server-switch-buffer (nth 1 client))
381 (run-hooks 'server-switch-hook)
382 (unless nowait
8a26c165 383 (message "%s" (substitute-command-keys
5b421c81
SM
384 "When done with a buffer, type \\[server-edit]")))))
385 ;; Avoid preserving the connection after the last real frame is deleted.
386 (if tmp-frame (delete-frame tmp-frame))))
68469f74 387 ;; Save for later any partial line that remains.
0c851d78 388 (when (> (length string) 0)
3f7ef08e 389 (process-put proc 'previous-string string)))
9ae0f972 390
6b98185f
RS
391(defun server-goto-line-column (file-line-col)
392 (goto-line (nth 1 file-line-col))
393 (let ((column-number (nth 2 file-line-col)))
394 (if (> column-number 0)
395 (move-to-column (1- column-number)))))
396
dfa35e6b 397(defun server-visit-files (files client &optional nowait)
44a56b29 398 "Find FILES and return the list CLIENT with the buffers nconc'd.
8c493570 399FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
dfa35e6b
RS
400NOWAIT non-nil means this client is not waiting for the results,
401so don't mark these buffers specially, just visit them normally."
e82e73c2 402 ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
44a56b29 403 (let ((last-nonmenu-event t) client-record)
3a0ce849
RS
404 ;; Restore the current buffer afterward, but not using save-excursion,
405 ;; because we don't want to save point in this buffer
406 ;; if it happens to be one of those specified by the server.
44a56b29
SM
407 (save-current-buffer
408 (dolist (file files)
409 ;; If there is an existing buffer modified or the file is
410 ;; modified, revert it. If there is an existing buffer with
411 ;; deleted file, offer to write it.
412 (let* ((filen (car file))
413 (obuf (get-file-buffer filen)))
c398358a 414 (add-to-history 'file-name-history filen)
44a56b29
SM
415 (if (and obuf (set-buffer obuf))
416 (progn
417 (cond ((file-exists-p filen)
418 (if (not (verify-visited-file-modtime obuf))
419 (revert-buffer t nil)))
420 (t
421 (if (y-or-n-p
422 (concat "File no longer exists: "
423 filen
424 ", write buffer to file? "))
425 (write-file filen))))
426 (setq server-existing-buffer t)
427 (server-goto-line-column file))
428 (set-buffer (find-file-noselect filen))
429 (server-goto-line-column file)
430 (run-hooks 'server-visit-hook)))
431 (unless nowait
432 ;; When the buffer is killed, inform the clients.
433 (add-hook 'kill-buffer-hook 'server-kill-buffer nil t)
434 (push (car client) server-buffer-clients))
435 (push (current-buffer) client-record)))
9ae0f972 436 (nconc client client-record)))
437\f
b392bac9 438(defun server-buffer-done (buffer &optional for-killing)
9ae0f972 439 "Mark BUFFER as \"done\" for its client(s).
9184aafb
RS
440This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED).
441NEXT-BUFFER is another server buffer, as a suggestion for what to select next,
8b3e840e
SM
442or nil. KILLED is t if we killed BUFFER (typically, because it was visiting
443a temp file).
444FOR-KILLING if non-nil indicates that we are called from `kill-buffer'."
0c851d78 445 (let ((next-buffer nil)
9184aafb 446 (killed nil)
9ae0f972 447 (old-clients server-clients))
448 (while old-clients
449 (let ((client (car old-clients)))
8b3e840e 450 (or next-buffer
9ae0f972 451 (setq next-buffer (nth 1 (memq buffer client))))
452 (delq buffer client)
68469f74
RS
453 ;; Delete all dead buffers from CLIENT.
454 (let ((tail client))
455 (while tail
456 (and (bufferp (car tail))
457 (null (buffer-name (car tail)))
458 (delq (car tail) client))
459 (setq tail (cdr tail))))
9ae0f972 460 ;; If client now has no pending buffers,
461 ;; tell it that it is done, and forget it entirely.
0c851d78
SM
462 (unless (cdr client)
463 (delete-process (car client))
464 (server-log "Close" (car client))
9ae0f972 465 (setq server-clients (delq client server-clients))))
466 (setq old-clients (cdr old-clients)))
68469f74 467 (if (and (bufferp buffer) (buffer-name buffer))
599f9a5c
RS
468 ;; We may or may not kill this buffer;
469 ;; if we do, do not call server-buffer-done recursively
470 ;; from kill-buffer-hook.
471 (let ((server-kill-buffer-running t))
408784a7 472 (with-current-buffer buffer
f9b3ef88
RS
473 (setq server-buffer-clients nil)
474 (run-hooks 'server-done-hook))
599f9a5c
RS
475 ;; Notice whether server-done-hook killed the buffer.
476 (if (null (buffer-name buffer))
477 (setq killed t)
478 ;; Don't bother killing or burying the buffer
479 ;; when we are called from kill-buffer.
480 (unless for-killing
c6a117f0
GM
481 (when (and (not killed)
482 server-kill-new-buffers
4dd04714
RS
483 (with-current-buffer buffer
484 (not server-existing-buffer)))
c6a117f0 485 (setq killed t)
3d2a0e0b 486 (bury-buffer buffer)
c6a117f0
GM
487 (kill-buffer buffer))
488 (unless killed
489 (if (server-temp-file-p buffer)
490 (progn
491 (kill-buffer buffer)
492 (setq killed t))
493 (bury-buffer buffer)))))))
9184aafb 494 (list next-buffer killed)))
9ae0f972 495
408784a7 496(defun server-temp-file-p (&optional buffer)
9ae0f972 497 "Return non-nil if BUFFER contains a file considered temporary.
498These are files whose names suggest they are repeatedly
499reused to pass information to another program.
500
501The variable `server-temp-file-regexp' controls which filenames
502are considered temporary."
503 (and (buffer-file-name buffer)
504 (string-match server-temp-file-regexp (buffer-file-name buffer))))
505
506(defun server-done ()
cc9875f9 507 "Offer to save current buffer, mark it as \"done\" for clients.
ed9ae328
RS
508This kills or buries the buffer, then returns a list
509of the form (NEXT-BUFFER KILLED). NEXT-BUFFER is another server buffer,
510as a suggestion for what to select next, or nil.
511KILLED is t if we killed BUFFER, which happens if it was created
512specifically for the clients and did not exist before their request for it."
408784a7
SM
513 (when server-buffer-clients
514 (if (server-temp-file-p)
515 ;; For a temp file, save, and do make a non-numeric backup
516 ;; (unless make-backup-files is nil).
517 (let ((version-control nil)
518 (buffer-backed-up nil))
519 (save-buffer))
520 (if (and (buffer-modified-p)
521 buffer-file-name
522 (y-or-n-p (concat "Save file " buffer-file-name "? ")))
523 (save-buffer)))
524 (server-buffer-done (current-buffer))))
faf931a8 525
71207de2
RS
526;; Ask before killing a server buffer.
527;; It was suggested to release its client instead,
528;; but I think that is dangerous--the client would proceed
529;; using whatever is on disk in that file. -- rms.
03d78665
RS
530(defun server-kill-buffer-query-function ()
531 (or (not server-buffer-clients)
532 (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
533 (buffer-name (current-buffer))))))
534
faf931a8 535(add-hook 'kill-buffer-query-functions
03d78665
RS
536 'server-kill-buffer-query-function)
537
538(defun server-kill-emacs-query-function ()
e82e73c2
RS
539 (let (live-client
540 (tail server-clients))
541 ;; See if any clients have any buffers that are still alive.
542 (while tail
543 (if (memq t (mapcar 'stringp (mapcar 'buffer-name (cdr (car tail)))))
544 (setq live-client t))
545 (setq tail (cdr tail)))
546 (or (not live-client)
547 (yes-or-no-p "Server buffers still have clients; exit anyway? "))))
03d78665
RS
548
549(add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
b392bac9 550
fb873cfc 551(defvar server-kill-buffer-running nil
599f9a5c 552 "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
fb873cfc 553
b392bac9 554(defun server-kill-buffer ()
fb873cfc
RS
555 ;; Prevent infinite recursion if user has made server-done-hook
556 ;; call kill-buffer.
557 (or server-kill-buffer-running
599f9a5c
RS
558 (and server-buffer-clients
559 (let ((server-kill-buffer-running t))
560 (when server-process
561 (server-buffer-done (current-buffer) t))))))
9ae0f972 562\f
563(defun server-edit (&optional arg)
564 "Switch to next server editing buffer; say \"Done\" for current buffer.
565If a server buffer is current, it is marked \"done\" and optionally saved.
ed9ae328 566The buffer is also killed if it did not exist before the clients asked for it.
9ae0f972 567When all of a client's buffers are marked as \"done\", the client is notified.
568
569Temporary files such as MH <draft> files are always saved and backed up,
991298c3
RS
570no questions asked. (The variable `make-backup-files', if nil, still
571inhibits a backup; you can set it locally in a particular buffer to
572prevent a backup for it.) The variable `server-temp-file-regexp' controls
9ae0f972 573which filenames are considered temporary.
574
64f51134 575If invoked with a prefix argument, or if there is no server process running,
9ae0f972 576starts server process and that is all. Invoked by \\[server-edit]."
9ae0f972 577 (interactive "P")
578 (if (or arg
579 (not server-process)
580 (memq (process-status server-process) '(signal exit)))
581 (server-start nil)
9184aafb 582 (apply 'server-switch-buffer (server-done))))
9ae0f972 583
98a4349c 584(defun server-switch-buffer (&optional next-buffer killed-one)
9ae0f972 585 "Switch to another buffer, preferably one that has a client.
586Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
9184aafb
RS
587 ;; KILLED-ONE is t in a recursive call
588 ;; if we have already killed one temp-file server buffer.
589 ;; This means we should avoid the final "switch to some other buffer"
590 ;; since we've already effectively done that.
ca0c7250
SM
591 (if (null next-buffer)
592 (if server-clients
593 (server-switch-buffer (nth 1 (car server-clients)) killed-one)
0c851d78 594 (unless (or killed-one (window-dedicated-p (selected-window)))
90ee5627
RS
595 (switch-to-buffer (other-buffer))
596 (message "No server buffers remain to edit")))
ca0c7250
SM
597 (if (not (buffer-name next-buffer))
598 ;; If NEXT-BUFFER is a dead buffer, remove the server records for it
9ae0f972 599 ;; and try the next surviving server buffer.
ca0c7250
SM
600 (apply 'server-switch-buffer (server-buffer-done next-buffer))
601 ;; OK, we know next-buffer is live, let's display and select it.
408784a7
SM
602 (if (functionp server-window)
603 (funcall server-window next-buffer)
604 (let ((win (get-buffer-window next-buffer 0)))
605 (if (and win (not server-window))
606 ;; The buffer is already displayed: just reuse the window.
607 (let ((frame (window-frame win)))
608 (if (eq (frame-visible-p frame) 'icon)
609 (raise-frame frame))
610 (select-window win)
611 (set-buffer next-buffer))
612 ;; Otherwise, let's find an appropriate window.
613 (cond ((and (windowp server-window)
614 (window-live-p server-window))
615 (select-window server-window))
616 ((framep server-window)
617 (if (not (frame-live-p server-window))
618 (setq server-window (make-frame)))
619 (select-window (frame-selected-window server-window))))
620 (if (window-minibuffer-p (selected-window))
621 (select-window (next-window nil 'nomini 0)))
622 ;; Move to a non-dedicated window, if we have one.
623 (when (window-dedicated-p (selected-window))
624 (select-window
625 (get-window-with-predicate
626 (lambda (w)
627 (and (not (window-dedicated-p w))
628 (equal (frame-parameter (window-frame w) 'display)
629 (frame-parameter (selected-frame) 'display))))
630 'nomini 'visible (selected-window))))
631 (condition-case nil
632 (switch-to-buffer next-buffer)
633 ;; After all the above, we might still have ended up with
634 ;; a minibuffer/dedicated-window (if there's no other).
635 (error (pop-to-buffer next-buffer)))))))))
9ae0f972 636
772c5eb7 637(define-key ctl-x-map "#" 'server-edit)
df4e8a11
DL
638
639(defun server-unload-hook ()
33186f32 640 (server-start t)
df4e8a11
DL
641 (remove-hook 'kill-buffer-query-functions 'server-kill-buffer-query-function)
642 (remove-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
643 (remove-hook 'kill-buffer-hook 'server-kill-buffer))
3bb38bc2
RS
644
645(add-hook 'server-unload-hook 'server-unload-hook)
16c15321
RM
646\f
647(provide 'server)
c88ab9ce 648
ab5796a9 649;;; arch-tag: 1f7ecb42-f00a-49f8-906d-61995d84c8d6
c88ab9ce 650;;; server.el ends here