(match): Use yellow background on light-bg terminals.
[emacs.git] / lisp / server.el
blobf03c802bb7716bda36e7efa1552928ea7ed2a443
1 ;;; server.el --- Lisp code for GNU Emacs running as server process
3 ;; Copyright (C) 1986, 1987, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: William Sommerfeld <wesommer@athena.mit.edu>
7 ;; Maintainer: FSF
8 ;; Keywords: processes
10 ;; Changes by peck@sun.com and by rms.
12 ;; This file is part of GNU Emacs.
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
16 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; any later version.
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.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27 ;; Boston, MA 02110-1301, USA.
29 ;;; Commentary:
31 ;; This Lisp code is run in Emacs when it is to operate as
32 ;; a server for other processes.
34 ;; Load this library and do M-x server-edit to enable Emacs as a server.
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))
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.
44 ;; Note that any number of clients may dispatch files to emacs to be edited.
46 ;; When you finish editing a Server buffer, again call server-edit
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
49 ;; and exited with server-edit, the client "editor" will return
50 ;; to the program that invoked it.
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:
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.
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.
63 ;; 3. When the program that wants to use "the editor" is running
64 ;; as a subprocess of Emacs.
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.
72 ;; The buffer local variable "server-buffer-clients" lists
73 ;; the clients who are waiting for this buffer to be edited.
74 ;; The global variable "server-clients" lists all the waiting clients,
75 ;; and which files are yet to be edited for each.
77 ;;; Code:
79 (eval-when-compile (require 'cl))
81 (defgroup server nil
82 "Emacs running as a server process."
83 :group 'external)
85 (defcustom server-use-tcp nil
86 "If non-nil, use TCP sockets instead of local sockets."
87 :set #'(lambda (sym val)
88 (unless (featurep 'make-network-process '(:family local))
89 (setq val t)
90 (unless load-in-progress
91 (message "Local sockets unsupported, using TCP sockets")))
92 (when val (random t))
93 (set-default sym val))
94 :group 'server
95 :type 'boolean
96 :version "22.1")
98 (defcustom server-host nil
99 "The name or IP address to use as host address of the server process.
100 If set, the server accepts remote connections; otherwise it is local."
101 :group 'server
102 :type '(choice
103 (string :tag "Name or IP address")
104 (const :tag "Local" nil))
105 :version "22.1")
106 (put 'server-host 'risky-local-variable t)
108 (defcustom server-auth-dir "~/.emacs.d/server/"
109 "Directory for server authentication files."
110 :group 'server
111 :type 'directory
112 :version "22.1")
113 (put 'server-auth-dir 'risky-local-variable t)
115 (defcustom server-raise-frame t
116 "If non-nil, raise frame when switching to a buffer."
117 :group 'server
118 :type 'boolean
119 :version "22.1")
121 (defcustom server-visit-hook nil
122 "Hook run when visiting a file for the Emacs server."
123 :group 'server
124 :type 'hook)
126 (defcustom server-switch-hook nil
127 "Hook run when switching to a buffer for the Emacs server."
128 :group 'server
129 :type 'hook)
131 (defcustom server-done-hook nil
132 "Hook run when done editing a buffer for the Emacs server."
133 :group 'server
134 :type 'hook)
136 (defvar server-process nil
137 "The current server process.")
139 (defvar server-clients nil
140 "List of current server clients.
141 Each element is (CLIENTID BUFFERS...) where CLIENTID is a string
142 that can be given to the server process to identify a client.
143 When a buffer is marked as \"done\", it is removed from this list.")
145 (defvar server-buffer-clients nil
146 "List of client ids for clients requesting editing of current buffer.")
147 (make-variable-buffer-local 'server-buffer-clients)
148 ;; Changing major modes should not erase this local.
149 (put 'server-buffer-clients 'permanent-local t)
151 (defcustom server-window nil
152 "Specification of the window to use for selecting Emacs server buffers.
153 If nil, use the selected window.
154 If it is a function, it should take one argument (a buffer) and
155 display and select it. A common value is `pop-to-buffer'.
156 If it is a window, use that.
157 If it is a frame, use the frame's selected window.
159 It is not meaningful to set this to a specific frame or window with Custom.
160 Only programs can do so."
161 :group 'server
162 :version "22.1"
163 :type '(choice (const :tag "Use selected window"
164 :match (lambda (widget value)
165 (not (functionp value)))
166 nil)
167 (function-item :tag "Use pop-to-buffer" pop-to-buffer)
168 (function :tag "Other function")))
170 (defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
171 "Regexp matching names of temporary files.
172 These are deleted and reused after each edit by the programs that
173 invoke the Emacs server."
174 :group 'server
175 :type 'regexp)
177 (defcustom server-kill-new-buffers t
178 "Whether to kill buffers when done with them.
179 If non-nil, kill a buffer unless it already existed before editing
180 it with Emacs server. If nil, kill only buffers as specified by
181 `server-temp-file-regexp'.
182 Please note that only buffers are killed that still have a client,
183 i.e. buffers visited which \"emacsclient --no-wait\" are never killed in
184 this way."
185 :group 'server
186 :type 'boolean
187 :version "21.1")
189 (or (assq 'server-buffer-clients minor-mode-alist)
190 (push '(server-buffer-clients " Server") minor-mode-alist))
192 (defvar server-existing-buffer nil
193 "Non-nil means the buffer existed before the server was asked to visit it.
194 This means that the server should not kill the buffer when you say you
195 are done with it in the server.")
196 (make-variable-buffer-local 'server-existing-buffer)
198 (defvar server-name "server")
200 (defvar server-socket-dir
201 (format "/tmp/emacs%d" (user-uid)))
203 (defun server-log (string &optional client)
204 "If a *server* buffer exists, write STRING to it for logging purposes."
205 (when (get-buffer "*server*")
206 (with-current-buffer "*server*"
207 (goto-char (point-max))
208 (insert (current-time-string)
209 (if client (format " %s:" client) " ")
210 string)
211 (or (bolp) (newline)))))
213 (defun server-sentinel (proc msg)
214 (let ((client (assq proc server-clients)))
215 ;; Remove PROC from the list of clients.
216 (when client
217 (setq server-clients (delq client server-clients))
218 (dolist (buf (cdr client))
219 (with-current-buffer buf
220 ;; Remove PROC from the clients of each buffer.
221 (setq server-buffer-clients (delq proc server-buffer-clients))
222 ;; Kill the buffer if necessary.
223 (when (and (null server-buffer-clients)
224 (or (and server-kill-new-buffers
225 (not server-existing-buffer))
226 (server-temp-file-p)))
227 (kill-buffer (current-buffer)))))))
228 ;; If this is a new client process, set the query-on-exit flag to nil
229 ;; for this process (it isn't inherited from the server process).
230 (when (and (eq (process-status proc) 'open)
231 (process-query-on-exit-flag proc))
232 (set-process-query-on-exit-flag proc nil))
233 ;; Delete the associated connection file, if applicable.
234 ;; This is actually problematic: the file may have been overwritten by
235 ;; another Emacs server in the mean time, so it's not ours any more.
236 ;; (and (process-contact proc :server)
237 ;; (eq (process-status proc) 'closed)
238 ;; (ignore-errors (delete-file (process-get proc :server-file))))
239 (server-log (format "Status changed to %s" (process-status proc)) proc))
241 (defun server-select-display (display)
242 ;; If the current frame is on `display' we're all set.
243 (unless (equal (frame-parameter (selected-frame) 'display) display)
244 ;; Otherwise, look for an existing frame there and select it.
245 (dolist (frame (frame-list))
246 (when (equal (frame-parameter frame 'display) display)
247 (select-frame frame)))
248 ;; If there's no frame on that display yet, create and select one.
249 (unless (equal (frame-parameter (selected-frame) 'display) display)
250 (let* ((buffer (generate-new-buffer " *server-dummy*"))
251 (frame (make-frame-on-display
252 display
253 ;; Make it display (and remember) some dummy buffer, so
254 ;; we can detect later if the frame is in use or not.
255 `((server-dummmy-buffer . ,buffer)
256 ;; This frame may be deleted later (see
257 ;; server-unselect-display) so we want it to be as
258 ;; unobtrusive as possible.
259 (visibility . nil)))))
260 (select-frame frame)
261 (set-window-buffer (selected-window) buffer)))))
263 (defun server-unselect-display (frame)
264 ;; If the temporary frame is in use (displays something real), make it
265 ;; visible. If not (which can happen if the user's customizations call
266 ;; pop-to-buffer etc.), delete it to avoid preserving the connection after
267 ;; the last real frame is deleted.
268 (if (and (eq (frame-first-window frame)
269 (next-window (frame-first-window frame) 'nomini))
270 (eq (window-buffer (frame-first-window frame))
271 (frame-parameter frame 'server-dummy-buffer)))
272 ;; The temp frame still only shows one buffer, and that is the
273 ;; internal temp buffer.
274 (delete-frame frame)
275 (set-frame-parameter frame 'visibility t))
276 (kill-buffer (frame-parameter frame 'server-dummy-buffer))
277 (set-frame-parameter frame 'server-dummy-buffer nil))
279 (defun server-unquote-arg (arg)
280 (replace-regexp-in-string
281 "&." (lambda (s)
282 (case (aref s 1)
283 (?& "&")
284 (?- "-")
285 (?n "\n")
286 (t " ")))
287 arg t t))
289 (defun server-ensure-safe-dir (dir)
290 "Make sure DIR is a directory with no race-condition issues.
291 Creates the directory if necessary and makes sure:
292 - there's no symlink involved
293 - it's owned by us
294 - it's not readable/writable by anybody else."
295 (setq dir (directory-file-name dir))
296 (let ((attrs (file-attributes dir)))
297 (unless attrs
298 (letf (((default-file-modes) ?\700)) (make-directory dir t))
299 (setq attrs (file-attributes dir)))
300 ;; Check that it's safe for use.
301 (unless (and (eq t (car attrs)) (eql (nth 2 attrs) (user-uid))
302 (or (eq system-type 'windows-nt)
303 (zerop (logand ?\077 (file-modes dir)))))
304 (error "The directory %s is unsafe" dir))))
306 ;;;###autoload
307 (defun server-start (&optional leave-dead)
308 "Allow this Emacs process to be a server for client processes.
309 This starts a server communications subprocess through which
310 client \"editors\" can send your editing commands to this Emacs job.
311 To use the server, set up the program `emacsclient' in the
312 Emacs distribution as your standard \"editor\".
314 Optional argument LEAVE-DEAD (interactively, a prefix arg) means just
315 kill any existing server communications subprocess."
316 (interactive "P")
317 (when server-process
318 ;; kill it dead!
319 (ignore-errors (delete-process server-process)))
320 ;; If this Emacs already had a server, clear out associated status.
321 (while server-clients
322 (let ((buffer (nth 1 (car server-clients))))
323 (server-buffer-done buffer)))
324 ;; Now any previous server is properly stopped.
325 (unless leave-dead
326 (let* ((server-dir (if server-use-tcp server-auth-dir server-socket-dir))
327 (server-file (expand-file-name server-name server-dir)))
328 ;; Make sure there is a safe directory in which to place the socket.
329 (server-ensure-safe-dir server-dir)
330 ;; Remove any leftover socket or authentication file.
331 (ignore-errors (delete-file server-file))
332 (when server-process
333 (server-log (message "Restarting server")))
334 (letf (((default-file-modes) ?\700))
335 (setq server-process
336 (apply #'make-network-process
337 :name server-name
338 :server t
339 :noquery t
340 :sentinel 'server-sentinel
341 :filter 'server-process-filter
342 ;; We must receive file names without being decoded.
343 ;; Those are decoded by server-process-filter according
344 ;; to file-name-coding-system.
345 :coding 'raw-text
346 ;; The rest of the args depends on the kind of socket used.
347 (if server-use-tcp
348 (list :family nil
349 :service t
350 :host (or server-host 'local)
351 :plist '(:authenticated nil))
352 (list :family 'local
353 :service server-file
354 :plist '(:authenticated t)))))
355 (unless server-process (error "Could not start server process"))
356 (when server-use-tcp
357 (let ((auth-key
358 (loop
359 ;; The auth key is a 64-byte string of random chars in the
360 ;; range `!'..`~'.
361 for i below 64
362 collect (+ 33 (random 94)) into auth
363 finally return (concat auth))))
364 (process-put server-process :auth-key auth-key)
365 (with-temp-file server-file
366 (set-buffer-multibyte nil)
367 (setq buffer-file-coding-system 'no-conversion)
368 (insert (format-network-address
369 (process-contact server-process :local))
370 " " (int-to-string (emacs-pid))
371 "\n" auth-key))))))))
373 ;;;###autoload
374 (define-minor-mode server-mode
375 "Toggle Server mode.
376 With ARG, turn Server mode on if ARG is positive, off otherwise.
377 Server mode runs a process that accepts commands from the
378 `emacsclient' program. See `server-start' and Info node `Emacs server'."
379 :global t
380 :group 'server
381 :version "22.1"
382 ;; Fixme: Should this check for an existing server socket and do
383 ;; nothing if there is one (for multiple Emacs sessions)?
384 (server-start (not server-mode)))
386 (defun* server-process-filter (proc string)
387 "Process a request from the server to edit some files.
388 PROC is the server process. Format of STRING is \"PATH PATH PATH... \\n\"."
389 ;; First things first: let's check the authentication
390 (unless (process-get proc :authenticated)
391 (if (and (string-match "-auth \\(.*?\\)\n" string)
392 (equal (match-string 1 string) (process-get proc :auth-key)))
393 (progn
394 (setq string (substring string (match-end 0)))
395 (process-put proc :authenticated t)
396 (server-log "Authentication successful" proc))
397 (server-log "Authentication failed" proc)
398 (process-send-string proc "Authentication failed")
399 (delete-process proc)
400 ;; We return immediately
401 (return-from server-process-filter)))
402 (server-log string proc)
403 (let ((prev (process-get proc :previous-string)))
404 (when prev
405 (setq string (concat prev string))
406 (process-put proc :previous-string nil)))
407 (when (> (recursion-depth) 0)
408 ;; We're inside a minibuffer already, so if the emacs-client is trying
409 ;; to open a frame on a new display, we might end up with an unusable
410 ;; frame because input from that display will be blocked (until exiting
411 ;; the minibuffer). Better exit this minibuffer right away.
412 ;; Similarly with recursive-edits such as the splash screen.
413 (process-put proc :previous-string string)
414 (run-with-timer 0 nil (lexical-let ((proc proc))
415 (lambda () (server-process-filter proc ""))))
416 (top-level))
417 ;; If the input is multiple lines,
418 ;; process each line individually.
419 (while (string-match "\n" string)
420 (let ((request (substring string 0 (match-beginning 0)))
421 (coding-system (and default-enable-multibyte-characters
422 (or file-name-coding-system
423 default-file-name-coding-system)))
424 client nowait eval
425 (files nil)
426 (lineno 1)
427 (tmp-frame nil) ;; Sometimes used to embody the selected display.
428 (columnno 0))
429 ;; Remove this line from STRING.
430 (setq string (substring string (match-end 0)))
431 (setq client (cons proc nil))
432 (while (string-match "[^ ]* " request)
433 (let ((arg (substring request (match-beginning 0) (1- (match-end 0)))))
434 (setq request (substring request (match-end 0)))
435 (cond
436 ((equal "-nowait" arg) (setq nowait t))
437 ((equal "-eval" arg) (setq eval t))
438 ((and (equal "-display" arg) (string-match "\\([^ ]*\\) " request))
439 (let ((display (server-unquote-arg (match-string 1 request))))
440 (setq request (substring request (match-end 0)))
441 (condition-case err
442 (setq tmp-frame (server-select-display display))
443 (error (process-send-string proc (nth 1 err))
444 (setq request "")))))
445 ;; ARG is a line number option.
446 ((string-match "\\`\\+[0-9]+\\'" arg)
447 (setq lineno (string-to-number (substring arg 1))))
448 ;; ARG is line number:column option.
449 ((string-match "\\`+\\([0-9]+\\):\\([0-9]+\\)\\'" arg)
450 (setq lineno (string-to-number (match-string 1 arg))
451 columnno (string-to-number (match-string 2 arg))))
453 ;; Undo the quoting that emacsclient does
454 ;; for certain special characters.
455 (setq arg (server-unquote-arg arg))
456 ;; Now decode the file name if necessary.
457 (when coding-system
458 (setq arg (decode-coding-string arg coding-system)))
459 (if eval
460 (let* (errorp
461 (v (condition-case errobj
462 (eval (car (read-from-string arg)))
463 (error (setq errorp t) errobj))))
464 (when v
465 (with-temp-buffer
466 (let ((standard-output (current-buffer)))
467 (when errorp (princ "error: "))
468 (pp v)
469 (ignore-errors
470 (process-send-region proc (point-min) (point-max)))
471 ))))
472 ;; ARG is a file name.
473 ;; Collapse multiple slashes to single slashes.
474 (setq arg (command-line-normalize-file-name arg))
475 (push (list arg lineno columnno) files))
476 (setq lineno 1)
477 (setq columnno 0)))))
478 (when files
479 (run-hooks 'pre-command-hook)
480 (server-visit-files files client nowait)
481 (run-hooks 'post-command-hook))
482 ;; CLIENT is now a list (CLIENTNUM BUFFERS...)
483 (if (null (cdr client))
484 ;; This client is empty; get rid of it immediately.
485 (progn
486 (delete-process proc)
487 (server-log "Close empty client" proc))
488 ;; We visited some buffer for this client.
489 (or nowait (push client server-clients))
490 (unless (or isearch-mode (minibufferp))
491 (server-switch-buffer (nth 1 client))
492 (run-hooks 'server-switch-hook)
493 (unless nowait
494 (message "%s" (substitute-command-keys
495 "When done with a buffer, type \\[server-edit]")))))
496 (when (frame-live-p tmp-frame)
497 ;; Delete tmp-frame or make it visible depending on whether it's
498 ;; been used or not.
499 (server-unselect-display tmp-frame))))
500 ;; Save for later any partial line that remains.
501 (when (> (length string) 0)
502 (process-put proc :previous-string string)))
504 (defun server-goto-line-column (file-line-col)
505 (goto-line (nth 1 file-line-col))
506 (let ((column-number (nth 2 file-line-col)))
507 (when (> column-number 0)
508 (move-to-column (1- column-number)))))
510 (defun server-visit-files (files client &optional nowait)
511 "Find FILES and return the list CLIENT with the buffers nconc'd.
512 FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
513 NOWAIT non-nil means this client is not waiting for the results,
514 so don't mark these buffers specially, just visit them normally."
515 ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
516 (let ((last-nonmenu-event t) client-record)
517 ;; Restore the current buffer afterward, but not using save-excursion,
518 ;; because we don't want to save point in this buffer
519 ;; if it happens to be one of those specified by the server.
520 (save-current-buffer
521 (dolist (file files)
522 ;; If there is an existing buffer modified or the file is
523 ;; modified, revert it. If there is an existing buffer with
524 ;; deleted file, offer to write it.
525 (let* ((minibuffer-auto-raise (or server-raise-frame
526 minibuffer-auto-raise))
527 (filen (car file))
528 (obuf (get-file-buffer filen)))
529 (add-to-history 'file-name-history filen)
530 (if (and obuf (set-buffer obuf))
531 (progn
532 (cond ((file-exists-p filen)
533 (when (not (verify-visited-file-modtime obuf))
534 (revert-buffer t nil)))
536 (when (y-or-n-p
537 (concat "File no longer exists: "
538 filen
539 ", write buffer to file? "))
540 (write-file filen))))
541 (setq server-existing-buffer t)
542 (server-goto-line-column file))
543 (set-buffer (find-file-noselect filen))
544 (server-goto-line-column file)
545 (run-hooks 'server-visit-hook)))
546 (unless nowait
547 ;; When the buffer is killed, inform the clients.
548 (add-hook 'kill-buffer-hook 'server-kill-buffer nil t)
549 (push (car client) server-buffer-clients))
550 (push (current-buffer) client-record)))
551 (nconc client client-record)))
553 (defun server-buffer-done (buffer &optional for-killing)
554 "Mark BUFFER as \"done\" for its client(s).
555 This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED).
556 NEXT-BUFFER is another server buffer, as a suggestion for what to select next,
557 or nil. KILLED is t if we killed BUFFER (typically, because it was visiting
558 a temp file).
559 FOR-KILLING if non-nil indicates that we are called from `kill-buffer'."
560 (let ((next-buffer nil)
561 (killed nil)
562 (old-clients server-clients))
563 (while old-clients
564 (let ((client (car old-clients)))
565 (or next-buffer
566 (setq next-buffer (nth 1 (memq buffer client))))
567 (delq buffer client)
568 ;; Delete all dead buffers from CLIENT.
569 (let ((tail client))
570 (while tail
571 (and (bufferp (car tail))
572 (null (buffer-name (car tail)))
573 (delq (car tail) client))
574 (setq tail (cdr tail))))
575 ;; If client now has no pending buffers,
576 ;; tell it that it is done, and forget it entirely.
577 (unless (cdr client)
578 (delete-process (car client))
579 (server-log "Close" (car client))
580 (setq server-clients (delq client server-clients))))
581 (setq old-clients (cdr old-clients)))
582 (when (and (bufferp buffer) (buffer-name buffer))
583 ;; We may or may not kill this buffer;
584 ;; if we do, do not call server-buffer-done recursively
585 ;; from kill-buffer-hook.
586 (let ((server-kill-buffer-running t))
587 (with-current-buffer buffer
588 (setq server-buffer-clients nil)
589 (run-hooks 'server-done-hook))
590 ;; Notice whether server-done-hook killed the buffer.
591 (if (null (buffer-name buffer))
592 (setq killed t)
593 ;; Don't bother killing or burying the buffer
594 ;; when we are called from kill-buffer.
595 (unless for-killing
596 (when (and (not killed)
597 server-kill-new-buffers
598 (with-current-buffer buffer
599 (not server-existing-buffer)))
600 (setq killed t)
601 (bury-buffer buffer)
602 (kill-buffer buffer))
603 (unless killed
604 (if (server-temp-file-p buffer)
605 (progn
606 (kill-buffer buffer)
607 (setq killed t))
608 (bury-buffer buffer)))))))
609 (list next-buffer killed)))
611 (defun server-temp-file-p (&optional buffer)
612 "Return non-nil if BUFFER contains a file considered temporary.
613 These are files whose names suggest they are repeatedly
614 reused to pass information to another program.
616 The variable `server-temp-file-regexp' controls which filenames
617 are considered temporary."
618 (and (buffer-file-name buffer)
619 (string-match server-temp-file-regexp (buffer-file-name buffer))))
621 (defun server-done ()
622 "Offer to save current buffer, mark it as \"done\" for clients.
623 This kills or buries the buffer, then returns a list
624 of the form (NEXT-BUFFER KILLED). NEXT-BUFFER is another server buffer,
625 as a suggestion for what to select next, or nil.
626 KILLED is t if we killed BUFFER, which happens if it was created
627 specifically for the clients and did not exist before their request for it."
628 (when server-buffer-clients
629 (if (server-temp-file-p)
630 ;; For a temp file, save, and do make a non-numeric backup
631 ;; (unless make-backup-files is nil).
632 (let ((version-control nil)
633 (buffer-backed-up nil))
634 (save-buffer))
635 (when (and (buffer-modified-p)
636 buffer-file-name
637 (y-or-n-p (concat "Save file " buffer-file-name "? ")))
638 (save-buffer)))
639 (server-buffer-done (current-buffer))))
641 ;; Ask before killing a server buffer.
642 ;; It was suggested to release its client instead,
643 ;; but I think that is dangerous--the client would proceed
644 ;; using whatever is on disk in that file. -- rms.
645 (defun server-kill-buffer-query-function ()
646 (or (not server-buffer-clients)
647 (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
648 (buffer-name (current-buffer))))))
650 (add-hook 'kill-buffer-query-functions
651 'server-kill-buffer-query-function)
653 (defun server-kill-emacs-query-function ()
654 (let (live-client
655 (tail server-clients))
656 ;; See if any clients have any buffers that are still alive.
657 (while tail
658 (when (memq t (mapcar 'stringp (mapcar 'buffer-name (cdr (car tail)))))
659 (setq live-client t))
660 (setq tail (cdr tail)))
661 (or (not live-client)
662 (yes-or-no-p "Server buffers still have clients; exit anyway? "))))
664 (add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
666 (defvar server-kill-buffer-running nil
667 "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
669 (defun server-kill-buffer ()
670 ;; Prevent infinite recursion if user has made server-done-hook
671 ;; call kill-buffer.
672 (or server-kill-buffer-running
673 (and server-buffer-clients
674 (let ((server-kill-buffer-running t))
675 (when server-process
676 (server-buffer-done (current-buffer) t))))))
678 (defun server-edit (&optional arg)
679 "Switch to next server editing buffer; say \"Done\" for current buffer.
680 If a server buffer is current, it is marked \"done\" and optionally saved.
681 The buffer is also killed if it did not exist before the clients asked for it.
682 When all of a client's buffers are marked as \"done\", the client is notified.
684 Temporary files such as MH <draft> files are always saved and backed up,
685 no questions asked. (The variable `make-backup-files', if nil, still
686 inhibits a backup; you can set it locally in a particular buffer to
687 prevent a backup for it.) The variable `server-temp-file-regexp' controls
688 which filenames are considered temporary.
690 If invoked with a prefix argument, or if there is no server process running,
691 starts server process and that is all. Invoked by \\[server-edit]."
692 (interactive "P")
693 (cond
694 ((or arg
695 (not server-process)
696 (memq (process-status server-process) '(signal exit)))
697 (server-mode 1))
698 (server-clients (apply 'server-switch-buffer (server-done)))
699 (t (message "No server editing buffers exist"))))
701 (defun server-switch-buffer (&optional next-buffer killed-one)
702 "Switch to another buffer, preferably one that has a client.
703 Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
704 ;; KILLED-ONE is t in a recursive call
705 ;; if we have already killed one temp-file server buffer.
706 ;; This means we should avoid the final "switch to some other buffer"
707 ;; since we've already effectively done that.
708 (if (null next-buffer)
709 (if server-clients
710 (server-switch-buffer (nth 1 (car server-clients)) killed-one)
711 (unless (or killed-one (window-dedicated-p (selected-window)))
712 (switch-to-buffer (other-buffer))
713 (message "No server buffers remain to edit")))
714 (if (not (buffer-name next-buffer))
715 ;; If NEXT-BUFFER is a dead buffer, remove the server records for it
716 ;; and try the next surviving server buffer.
717 (apply 'server-switch-buffer (server-buffer-done next-buffer))
718 ;; OK, we know next-buffer is live, let's display and select it.
719 (if (functionp server-window)
720 (funcall server-window next-buffer)
721 (let ((win (get-buffer-window next-buffer 0)))
722 (if (and win (not server-window))
723 ;; The buffer is already displayed: just reuse the window.
724 (progn
725 (select-window win)
726 (set-buffer next-buffer))
727 ;; Otherwise, let's find an appropriate window.
728 (cond ((and (windowp server-window)
729 (window-live-p server-window))
730 (select-window server-window))
731 ((framep server-window)
732 (unless (frame-live-p server-window)
733 (setq server-window (make-frame)))
734 (select-window (frame-selected-window server-window))))
735 (when (window-minibuffer-p (selected-window))
736 (select-window (next-window nil 'nomini 0)))
737 ;; Move to a non-dedicated window, if we have one.
738 (when (window-dedicated-p (selected-window))
739 (select-window
740 (get-window-with-predicate
741 (lambda (w)
742 (and (not (window-dedicated-p w))
743 (equal (frame-parameter (window-frame w) 'display)
744 (frame-parameter (selected-frame) 'display))))
745 'nomini 'visible (selected-window))))
746 (condition-case nil
747 (switch-to-buffer next-buffer)
748 ;; After all the above, we might still have ended up with
749 ;; a minibuffer/dedicated-window (if there's no other).
750 (error (pop-to-buffer next-buffer)))))))
751 (when server-raise-frame
752 (select-frame-set-input-focus (window-frame (selected-window))))))
754 (define-key ctl-x-map "#" 'server-edit)
756 (defun server-unload-hook ()
757 (server-mode -1)
758 (remove-hook 'kill-buffer-query-functions 'server-kill-buffer-query-function)
759 (remove-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
760 (remove-hook 'kill-buffer-hook 'server-kill-buffer))
762 (add-hook 'kill-emacs-hook (lambda () (server-mode -1))) ;Cleanup upon exit.
763 (add-hook 'server-unload-hook 'server-unload-hook)
765 (provide 'server)
767 ;; arch-tag: 1f7ecb42-f00a-49f8-906d-61995d84c8d6
768 ;;; server.el ends here