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