Trivial changes
[bpt/emacs.git] / lisp / server.el
CommitLineData
55535639 1;;; server.el --- Lisp code for GNU Emacs running as server process
c88ab9ce 2
724629d2 3;; Copyright (C) 1986,87,92,94,95,96,97,98,99,2000,01,02,2003
0f5f7c3e 4;; 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
EN
25;; along with GNU Emacs; see the file COPYING. If not, write to the
26;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27;; Boston, MA 02111-1307, 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
126 :version "21.4"
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
0c851d78 162(defvar server-socket-name
724629d2 163 (format "/tmp/emacs%d-%s/server" (user-uid)
15d40fa4 164 (substring (system-name) 0 (string-match "\\." (system-name)))))
0c851d78 165
8b3e840e 166(defun server-log (string &optional client)
33186f32 167 "If a *server* buffer exists, write STRING to it for logging purposes."
9ae0f972 168 (if (get-buffer "*server*")
8b3e840e 169 (with-current-buffer "*server*"
9ae0f972 170 (goto-char (point-max))
8b3e840e 171 (insert (current-time-string)
0c851d78 172 (if client (format " %s:" client) " ")
8b3e840e 173 string)
74c20cd3 174 (or (bolp) (newline)))))
9ae0f972 175
176(defun server-sentinel (proc msg)
408784a7 177 (let ((client (assq proc server-clients)))
0c851d78 178 ;; Remove PROC from the list of clients.
408784a7
SM
179 (when client
180 (setq server-clients (delq client server-clients))
181 (dolist (buf (cdr client))
182 (with-current-buffer buf
183 ;; Remove PROC from the clients of each buffer.
184 (setq server-buffer-clients (delq proc server-buffer-clients))
185 ;; Kill the buffer if necessary.
186 (when (and (null server-buffer-clients)
187 (or (and server-kill-new-buffers
188 (not server-existing-buffer))
189 (server-temp-file-p)))
190 (kill-buffer (current-buffer)))))))
0c851d78
SM
191 (server-log (format "Status changed to %s" (process-status proc)) proc))
192
44a56b29
SM
193(defun server-select-display (display)
194 ;; If the current frame is on `display' we're all set.
195 (unless (equal (frame-parameter (selected-frame) 'display) display)
196 ;; Otherwise, look for an existing frame there and select it.
197 (dolist (frame (frame-list))
198 (when (equal (frame-parameter frame 'display) display)
199 (select-frame frame)))
200 ;; If there's no frame on that display yet, create a dummy one
201 ;; and select it.
202 (unless (equal (frame-parameter (selected-frame) 'display) display)
203 (select-frame
204 (make-frame-on-display
205 display
206 ;; This frame is only there in place of an actual "current display"
207 ;; setting, so we want it to be as unobtrusive as possible. That's
208 ;; what the invisibility is for. The minibuffer setting is so that
209 ;; we don't end up displaying a buffer in it (which noone would
210 ;; notice).
211 '((visibility . nil) (minibuffer . only)))))))
212
0c851d78
SM
213(defun server-unquote-arg (arg)
214 (replace-regexp-in-string
215 "&." (lambda (s)
216 (case (aref s 1)
217 (?& "&")
218 (?- "-")
219 (?n "\n")
220 (t " ")))
221 arg t t))
9ae0f972 222
724629d2
SM
223(defun server-ensure-safe-dir (dir)
224 "Make sure DIR is a directory with no race-condition issues.
225Creates the directory if necessary and makes sure:
226- there's no symlink involved
227- it's owned by us
228- it's not readable/writable by anybody else."
229 (setq dir (directory-file-name dir))
230 (let ((attrs (file-attributes dir)))
231 (unless attrs
232 (letf (((default-file-modes) ?\700)) (make-directory dir))
233 (setq attrs (file-attributes dir)))
234 ;; Check that it's safe for use.
235 (unless (and (eq t (car attrs)) (eq (nth 2 attrs) (user-uid))
236 (zerop (logand ?\077 (file-modes dir))))
237 (error "The directory %s is unsafe" dir))))
238
7229064d 239;;;###autoload
9ae0f972 240(defun server-start (&optional leave-dead)
241 "Allow this Emacs process to be a server for client processes.
242This starts a server communications subprocess through which
243client \"editors\" can send your editing commands to this Emacs job.
42bbacdf 244To use the server, set up the program `emacsclient' in the
9ae0f972 245Emacs distribution as your standard \"editor\".
246
247Prefix arg means just kill any existing server communications subprocess."
248 (interactive "P")
724629d2
SM
249 ;; Make sure there is a safe directory in which to place the socket.
250 (server-ensure-safe-dir (file-name-directory server-socket-name))
9ae0f972 251 ;; kill it dead!
60f8ea53
JPW
252 (if server-process
253 (condition-case () (delete-process server-process) (error nil)))
c1148e39 254 ;; Delete the socket files made by previous server invocations.
0c851d78 255 (condition-case () (delete-file server-socket-name) (error nil))
c1148e39 256 ;; If this Emacs already had a server, clear out associated status.
9ae0f972 257 (while server-clients
258 (let ((buffer (nth 1 (car server-clients))))
259 (server-buffer-done buffer)))
8b3e840e 260 (unless leave-dead
9ae0f972 261 (if server-process
262 (server-log (message "Restarting server")))
e5576936
SM
263 (letf (((default-file-modes) ?\700))
264 (setq server-process
265 (make-network-process
266 :name "server" :family 'local :server t :noquery t
267 :service server-socket-name
268 :sentinel 'server-sentinel :filter 'server-process-filter
269 ;; We must receive file names without being decoded.
270 ;; Those are decoded by server-process-filter according
271 ;; to file-name-coding-system.
272 :coding 'raw-text)))))
33186f32
DL
273
274;;;###autoload
275(define-minor-mode server-mode
276 "Toggle Server mode.
277With ARG, turn Server mode on if ARG is positive, off otherwise.
278Server mode runs a process that accepts commands from the
279`emacsclient' program. See `server-start' and Info node `Emacs server'."
280 :global t
281 :group 'server
282 :version "21.4"
283 ;; Fixme: Should this check for an existing server socket and do
284 ;; nothing if there is one (for multiple Emacs sessions)?
285 (server-start (not server-mode)))
9ae0f972 286\f
9ae0f972 287(defun server-process-filter (proc string)
33186f32
DL
288 "Process a request from the server to edit some files.
289PROC is the server process. Format of STRING is \"PATH PATH PATH... \\n\"."
0c851d78 290 (server-log string proc)
3f7ef08e
SM
291 (let ((prev (process-get proc 'previous-string)))
292 (when prev
293 (setq string (concat prev string))
294 (process-put proc 'previous-string nil)))
68469f74
RS
295 ;; If the input is multiple lines,
296 ;; process each line individually.
297 (while (string-match "\n" string)
298 (let ((request (substring string 0 (match-beginning 0)))
6b7430a8
KH
299 (coding-system (and default-enable-multibyte-characters
300 (or file-name-coding-system
301 default-file-name-coding-system)))
44a56b29 302 client nowait eval
9ae0f972 303 (files nil)
8c493570
GM
304 (lineno 1)
305 (columnno 0))
68469f74 306 ;; Remove this line from STRING.
0c851d78
SM
307 (setq string (substring string (match-end 0)))
308 (setq client (cons proc nil))
309 (while (string-match "[^ ]* " request)
724629d2 310 (let ((arg (substring request (match-beginning 0) (1- (match-end 0)))))
0c851d78
SM
311 (setq request (substring request (match-end 0)))
312 (cond
313 ((equal "-nowait" arg) (setq nowait t))
724629d2 314 ((equal "-eval" arg) (setq eval t))
44a56b29
SM
315 ((and (equal "-display" arg) (string-match "\\([^ ]*\\) " request))
316 (let ((display (server-unquote-arg (match-string 1 request))))
317 (setq request (substring request (match-end 0)))
318 (condition-case err
319 (server-select-display display)
320 (error (process-send-string proc (nth 1 err))
321 (setq request "")))))
6548cf00 322 ;; Open a new frame at the client. ARG is the name of the pseudo tty.
9628b887
KL
323 ((and (equal "-pty" arg) (string-match "\\([^ ]*\\) \\([^ ]*\\) " request))
324 (let ((pty (server-unquote-arg (match-string 1 request)))
325 (type (server-unquote-arg (match-string 2 request))))
326 (setq request (substring request (match-end 0)))
327 (condition-case err
8303ba32
KL
328 (let ((frame (make-terminal-frame `((tty . ,pty) (tty-type . ,type)))))
329 (process-send-string proc (concat (number-to-string (emacs-pid)) "\n"))
330 (select-frame frame))
9628b887
KL
331 (error (process-send-string proc (nth 1 err))
332 (setq request "")))))
0c851d78
SM
333 ;; ARG is a line number option.
334 ((string-match "\\`\\+[0-9]+\\'" arg)
335 (setq lineno (string-to-int (substring arg 1))))
336 ;; ARG is line number:column option.
337 ((string-match "\\`+\\([0-9]+\\):\\([0-9]+\\)\\'" arg)
338 (setq lineno (string-to-int (match-string 1 arg))
339 columnno (string-to-int (match-string 2 arg))))
340 (t
341 ;; Undo the quoting that emacsclient does
342 ;; for certain special characters.
343 (setq arg (server-unquote-arg arg))
344 ;; Now decode the file name if necessary.
345 (if coding-system
346 (setq arg (decode-coding-string arg coding-system)))
44a56b29 347 (if eval
fca177d4
KL
348 (condition-case err
349 (let ((v (eval (car (read-from-string arg)))))
350 (when v
351 (with-temp-buffer
352 (let ((standard-output (current-buffer)))
353 (pp v)
354 (process-send-region proc (point-min) (point-max))))))
355 (error (process-send-string proc (concat "*Error* " (error-message-string err)))))
356
44a56b29
SM
357 ;; ARG is a file name.
358 ;; Collapse multiple slashes to single slashes.
359 (setq arg (command-line-normalize-file-name arg))
360 (push (list arg lineno columnno) files))
0c851d78
SM
361 (setq lineno 1)
362 (setq columnno 0)))))
363 (when files
364 (run-hooks 'pre-command-hook)
365 (server-visit-files files client nowait)
366 (run-hooks 'post-command-hook))
367 ;; CLIENT is now a list (CLIENTNUM BUFFERS...)
368 (if (null (cdr client))
369 ;; This client is empty; get rid of it immediately.
370 (progn
371 (delete-process proc)
372 (server-log "Close empty client" proc))
373 ;; We visited some buffer for this client.
374 (or nowait (push client server-clients))
64f51134 375 (unless (or isearch-mode (minibufferp))
cf1175df
RS
376 (server-switch-buffer (nth 1 client))
377 (run-hooks 'server-switch-hook)
378 (unless nowait
379 (message (substitute-command-keys
380 "When done with a buffer, type \\[server-edit]")))))))
68469f74 381 ;; Save for later any partial line that remains.
0c851d78 382 (when (> (length string) 0)
3f7ef08e 383 (process-put proc 'previous-string string)))
9ae0f972 384
6b98185f
RS
385(defun server-goto-line-column (file-line-col)
386 (goto-line (nth 1 file-line-col))
387 (let ((column-number (nth 2 file-line-col)))
388 (if (> column-number 0)
389 (move-to-column (1- column-number)))))
390
dfa35e6b 391(defun server-visit-files (files client &optional nowait)
44a56b29 392 "Find FILES and return the list CLIENT with the buffers nconc'd.
8c493570 393FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
dfa35e6b
RS
394NOWAIT non-nil means this client is not waiting for the results,
395so don't mark these buffers specially, just visit them normally."
e82e73c2 396 ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
44a56b29 397 (let ((last-nonmenu-event t) client-record)
3a0ce849
RS
398 ;; Restore the current buffer afterward, but not using save-excursion,
399 ;; because we don't want to save point in this buffer
400 ;; if it happens to be one of those specified by the server.
44a56b29
SM
401 (save-current-buffer
402 (dolist (file files)
403 ;; If there is an existing buffer modified or the file is
404 ;; modified, revert it. If there is an existing buffer with
405 ;; deleted file, offer to write it.
406 (let* ((filen (car file))
407 (obuf (get-file-buffer filen)))
408 (push filen file-name-history)
409 (if (and obuf (set-buffer obuf))
410 (progn
411 (cond ((file-exists-p filen)
412 (if (not (verify-visited-file-modtime obuf))
413 (revert-buffer t nil)))
414 (t
415 (if (y-or-n-p
416 (concat "File no longer exists: "
417 filen
418 ", write buffer to file? "))
419 (write-file filen))))
420 (setq server-existing-buffer t)
421 (server-goto-line-column file))
422 (set-buffer (find-file-noselect filen))
423 (server-goto-line-column file)
424 (run-hooks 'server-visit-hook)))
425 (unless nowait
426 ;; When the buffer is killed, inform the clients.
427 (add-hook 'kill-buffer-hook 'server-kill-buffer nil t)
428 (push (car client) server-buffer-clients))
429 (push (current-buffer) client-record)))
9ae0f972 430 (nconc client client-record)))
431\f
b392bac9 432(defun server-buffer-done (buffer &optional for-killing)
9ae0f972 433 "Mark BUFFER as \"done\" for its client(s).
9184aafb
RS
434This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED).
435NEXT-BUFFER is another server buffer, as a suggestion for what to select next,
8b3e840e
SM
436or nil. KILLED is t if we killed BUFFER (typically, because it was visiting
437a temp file).
438FOR-KILLING if non-nil indicates that we are called from `kill-buffer'."
0c851d78 439 (let ((next-buffer nil)
9184aafb 440 (killed nil)
9ae0f972 441 (old-clients server-clients))
442 (while old-clients
443 (let ((client (car old-clients)))
8b3e840e 444 (or next-buffer
9ae0f972 445 (setq next-buffer (nth 1 (memq buffer client))))
446 (delq buffer client)
68469f74
RS
447 ;; Delete all dead buffers from CLIENT.
448 (let ((tail client))
449 (while tail
450 (and (bufferp (car tail))
451 (null (buffer-name (car tail)))
452 (delq (car tail) client))
453 (setq tail (cdr tail))))
9ae0f972 454 ;; If client now has no pending buffers,
455 ;; tell it that it is done, and forget it entirely.
0c851d78
SM
456 (unless (cdr client)
457 (delete-process (car client))
458 (server-log "Close" (car client))
9ae0f972 459 (setq server-clients (delq client server-clients))))
460 (setq old-clients (cdr old-clients)))
68469f74 461 (if (and (bufferp buffer) (buffer-name buffer))
599f9a5c
RS
462 ;; We may or may not kill this buffer;
463 ;; if we do, do not call server-buffer-done recursively
464 ;; from kill-buffer-hook.
465 (let ((server-kill-buffer-running t))
408784a7 466 (with-current-buffer buffer
f9b3ef88
RS
467 (setq server-buffer-clients nil)
468 (run-hooks 'server-done-hook))
599f9a5c
RS
469 ;; Notice whether server-done-hook killed the buffer.
470 (if (null (buffer-name buffer))
471 (setq killed t)
472 ;; Don't bother killing or burying the buffer
473 ;; when we are called from kill-buffer.
474 (unless for-killing
c6a117f0
GM
475 (when (and (not killed)
476 server-kill-new-buffers
4dd04714
RS
477 (with-current-buffer buffer
478 (not server-existing-buffer)))
c6a117f0 479 (setq killed t)
3d2a0e0b 480 (bury-buffer buffer)
c6a117f0
GM
481 (kill-buffer buffer))
482 (unless killed
483 (if (server-temp-file-p buffer)
484 (progn
485 (kill-buffer buffer)
486 (setq killed t))
487 (bury-buffer buffer)))))))
9184aafb 488 (list next-buffer killed)))
9ae0f972 489
408784a7 490(defun server-temp-file-p (&optional buffer)
9ae0f972 491 "Return non-nil if BUFFER contains a file considered temporary.
492These are files whose names suggest they are repeatedly
493reused to pass information to another program.
494
495The variable `server-temp-file-regexp' controls which filenames
496are considered temporary."
497 (and (buffer-file-name buffer)
498 (string-match server-temp-file-regexp (buffer-file-name buffer))))
499
500(defun server-done ()
cc9875f9 501 "Offer to save current buffer, mark it as \"done\" for clients.
ed9ae328
RS
502This kills or buries the buffer, then returns a list
503of the form (NEXT-BUFFER KILLED). NEXT-BUFFER is another server buffer,
504as a suggestion for what to select next, or nil.
505KILLED is t if we killed BUFFER, which happens if it was created
506specifically for the clients and did not exist before their request for it."
408784a7
SM
507 (when server-buffer-clients
508 (if (server-temp-file-p)
509 ;; For a temp file, save, and do make a non-numeric backup
510 ;; (unless make-backup-files is nil).
511 (let ((version-control nil)
512 (buffer-backed-up nil))
513 (save-buffer))
514 (if (and (buffer-modified-p)
515 buffer-file-name
516 (y-or-n-p (concat "Save file " buffer-file-name "? ")))
517 (save-buffer)))
518 (server-buffer-done (current-buffer))))
faf931a8 519
71207de2
RS
520;; Ask before killing a server buffer.
521;; It was suggested to release its client instead,
522;; but I think that is dangerous--the client would proceed
523;; using whatever is on disk in that file. -- rms.
03d78665
RS
524(defun server-kill-buffer-query-function ()
525 (or (not server-buffer-clients)
526 (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
527 (buffer-name (current-buffer))))))
528
faf931a8 529(add-hook 'kill-buffer-query-functions
03d78665
RS
530 'server-kill-buffer-query-function)
531
532(defun server-kill-emacs-query-function ()
e82e73c2
RS
533 (let (live-client
534 (tail server-clients))
535 ;; See if any clients have any buffers that are still alive.
536 (while tail
537 (if (memq t (mapcar 'stringp (mapcar 'buffer-name (cdr (car tail)))))
538 (setq live-client t))
539 (setq tail (cdr tail)))
540 (or (not live-client)
541 (yes-or-no-p "Server buffers still have clients; exit anyway? "))))
03d78665
RS
542
543(add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
b392bac9 544
fb873cfc 545(defvar server-kill-buffer-running nil
599f9a5c 546 "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
fb873cfc 547
b392bac9 548(defun server-kill-buffer ()
fb873cfc
RS
549 ;; Prevent infinite recursion if user has made server-done-hook
550 ;; call kill-buffer.
551 (or server-kill-buffer-running
599f9a5c
RS
552 (and server-buffer-clients
553 (let ((server-kill-buffer-running t))
554 (when server-process
555 (server-buffer-done (current-buffer) t))))))
9ae0f972 556\f
557(defun server-edit (&optional arg)
558 "Switch to next server editing buffer; say \"Done\" for current buffer.
559If a server buffer is current, it is marked \"done\" and optionally saved.
ed9ae328 560The buffer is also killed if it did not exist before the clients asked for it.
9ae0f972 561When all of a client's buffers are marked as \"done\", the client is notified.
562
563Temporary files such as MH <draft> files are always saved and backed up,
991298c3
RS
564no questions asked. (The variable `make-backup-files', if nil, still
565inhibits a backup; you can set it locally in a particular buffer to
566prevent a backup for it.) The variable `server-temp-file-regexp' controls
9ae0f972 567which filenames are considered temporary.
568
64f51134 569If invoked with a prefix argument, or if there is no server process running,
9ae0f972 570starts server process and that is all. Invoked by \\[server-edit]."
9ae0f972 571 (interactive "P")
572 (if (or arg
573 (not server-process)
574 (memq (process-status server-process) '(signal exit)))
575 (server-start nil)
9184aafb 576 (apply 'server-switch-buffer (server-done))))
9ae0f972 577
98a4349c 578(defun server-switch-buffer (&optional next-buffer killed-one)
9ae0f972 579 "Switch to another buffer, preferably one that has a client.
580Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
9184aafb
RS
581 ;; KILLED-ONE is t in a recursive call
582 ;; if we have already killed one temp-file server buffer.
583 ;; This means we should avoid the final "switch to some other buffer"
584 ;; since we've already effectively done that.
ca0c7250
SM
585 (if (null next-buffer)
586 (if server-clients
587 (server-switch-buffer (nth 1 (car server-clients)) killed-one)
0c851d78 588 (unless (or killed-one (window-dedicated-p (selected-window)))
90ee5627
RS
589 (switch-to-buffer (other-buffer))
590 (message "No server buffers remain to edit")))
ca0c7250
SM
591 (if (not (buffer-name next-buffer))
592 ;; If NEXT-BUFFER is a dead buffer, remove the server records for it
9ae0f972 593 ;; and try the next surviving server buffer.
ca0c7250
SM
594 (apply 'server-switch-buffer (server-buffer-done next-buffer))
595 ;; OK, we know next-buffer is live, let's display and select it.
408784a7
SM
596 (if (functionp server-window)
597 (funcall server-window next-buffer)
598 (let ((win (get-buffer-window next-buffer 0)))
599 (if (and win (not server-window))
600 ;; The buffer is already displayed: just reuse the window.
601 (let ((frame (window-frame win)))
602 (if (eq (frame-visible-p frame) 'icon)
603 (raise-frame frame))
604 (select-window win)
605 (set-buffer next-buffer))
606 ;; Otherwise, let's find an appropriate window.
607 (cond ((and (windowp server-window)
608 (window-live-p server-window))
609 (select-window server-window))
610 ((framep server-window)
611 (if (not (frame-live-p server-window))
612 (setq server-window (make-frame)))
613 (select-window (frame-selected-window server-window))))
614 (if (window-minibuffer-p (selected-window))
615 (select-window (next-window nil 'nomini 0)))
616 ;; Move to a non-dedicated window, if we have one.
617 (when (window-dedicated-p (selected-window))
618 (select-window
619 (get-window-with-predicate
620 (lambda (w)
621 (and (not (window-dedicated-p w))
622 (equal (frame-parameter (window-frame w) 'display)
623 (frame-parameter (selected-frame) 'display))))
624 'nomini 'visible (selected-window))))
625 (condition-case nil
626 (switch-to-buffer next-buffer)
627 ;; After all the above, we might still have ended up with
628 ;; a minibuffer/dedicated-window (if there's no other).
629 (error (pop-to-buffer next-buffer)))))))))
9ae0f972 630
631(global-set-key "\C-x#" 'server-edit)
df4e8a11
DL
632
633(defun server-unload-hook ()
33186f32 634 (server-start t)
df4e8a11
DL
635 (remove-hook 'kill-buffer-query-functions 'server-kill-buffer-query-function)
636 (remove-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
637 (remove-hook 'kill-buffer-hook 'server-kill-buffer))
16c15321
RM
638\f
639(provide 'server)
c88ab9ce 640
ab5796a9 641;;; arch-tag: 1f7ecb42-f00a-49f8-906d-61995d84c8d6
c88ab9ce 642;;; server.el ends here