Fix old entry.
[emacs.git] / lisp / server.el
blobf8c405b13058243b3a97097ae942ff9e43513cad
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, 2008 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.
11 ;; Overhaul by Karoly Lorentey <lorentey@elte.hu> for multi-tty support.
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;;; Commentary:
30 ;; This Lisp code is run in Emacs when it is to operate as
31 ;; a server for other processes.
33 ;; Load this library and do M-x server-edit to enable Emacs as a server.
34 ;; Emacs opens up a socket for communication with clients. If there are no
35 ;; client buffers to edit, server-edit acts like (switch-to-buffer
36 ;; (other-buffer))
38 ;; When some other program runs "the editor" to edit a file,
39 ;; "the editor" can be the Emacs client program ../lib-src/emacsclient.
40 ;; This program transmits the file names to Emacs through
41 ;; the server subprocess, and Emacs visits them and lets you edit them.
43 ;; Note that any number of clients may dispatch files to Emacs to be edited.
45 ;; When you finish editing a Server buffer, again call server-edit
46 ;; to mark that buffer as done for the client and switch to the next
47 ;; Server buffer. When all the buffers for a client have been edited
48 ;; and exited with server-edit, the client "editor" will return
49 ;; to the program that invoked it.
51 ;; Your editing commands and Emacs's display output go to and from
52 ;; the terminal in the usual way. Thus, server operation is possible
53 ;; only when Emacs can talk to the terminal at the time you invoke
54 ;; the client. This is possible in four cases:
56 ;; 1. On a window system, where Emacs runs in one window and the
57 ;; program that wants to use "the editor" runs in another.
59 ;; 2. On a multi-terminal system, where Emacs runs on one terminal and the
60 ;; program that wants to use "the editor" runs on another.
62 ;; 3. When the program that wants to use "the editor" is running
63 ;; as a subprocess of Emacs.
65 ;; 4. On a system with job control, when Emacs is suspended, the program
66 ;; that wants to use "the editor" will stop and display
67 ;; "Waiting for Emacs...". It can then be suspended, and Emacs can be
68 ;; brought into the foreground for editing. When done editing, Emacs is
69 ;; suspended again, and the client program is brought into the foreground.
71 ;; The buffer local variable "server-buffer-clients" lists
72 ;; the clients who are waiting for this buffer to be edited.
73 ;; The global variable "server-clients" lists all the waiting clients,
74 ;; and which files are yet to be edited for each.
76 ;; Todo:
78 ;; - handle command-line-args-left.
79 ;; - move most of the args processing and decision making from emacsclient.c
80 ;; to here.
81 ;; - fix up handling of the client's environment (place it in the terminal?).
83 ;;; Code:
85 (eval-when-compile (require 'cl))
87 (defgroup server nil
88 "Emacs running as a server process."
89 :group 'external)
91 (defcustom server-use-tcp nil
92 "If non-nil, use TCP sockets instead of local sockets."
93 :set #'(lambda (sym val)
94 (unless (featurep 'make-network-process '(:family local))
95 (setq val t)
96 (unless load-in-progress
97 (message "Local sockets unsupported, using TCP sockets")))
98 (when val (random t))
99 (set-default sym val))
100 :group 'server
101 :type 'boolean
102 :version "22.1")
104 (defcustom server-host nil
105 "The name or IP address to use as host address of the server process.
106 If set, the server accepts remote connections; otherwise it is local."
107 :group 'server
108 :type '(choice
109 (string :tag "Name or IP address")
110 (const :tag "Local" nil))
111 :version "22.1")
112 (put 'server-host 'risky-local-variable t)
114 (defcustom server-auth-dir (locate-user-emacs-file "server/")
115 "Directory for server authentication files."
116 :group 'server
117 :type 'directory
118 :version "22.1")
119 (put 'server-auth-dir 'risky-local-variable t)
121 (defcustom server-raise-frame t
122 "If non-nil, raise frame when switching to a buffer."
123 :group 'server
124 :type 'boolean
125 :version "22.1")
127 (defcustom server-visit-hook nil
128 "Hook run when visiting a file for the Emacs server."
129 :group 'server
130 :type 'hook)
132 (defcustom server-switch-hook nil
133 "Hook run when switching to a buffer for the Emacs server."
134 :group 'server
135 :type 'hook)
137 (defcustom server-done-hook nil
138 "Hook run when done editing a buffer for the Emacs server."
139 :group 'server
140 :type 'hook)
142 (defvar server-process nil
143 "The current server process.")
145 (defvar server-clients nil
146 "List of current server clients.
147 Each element is a process.")
149 (defvar server-buffer-clients nil
150 "List of client processes requesting editing of current buffer.")
151 (make-variable-buffer-local 'server-buffer-clients)
152 ;; Changing major modes should not erase this local.
153 (put 'server-buffer-clients 'permanent-local t)
155 (defcustom server-window nil
156 "Specification of the window to use for selecting Emacs server buffers.
157 If nil, use the selected window.
158 If it is a function, it should take one argument (a buffer) and
159 display and select it. A common value is `pop-to-buffer'.
160 If it is a window, use that.
161 If it is a frame, use the frame's selected window.
163 It is not meaningful to set this to a specific frame or window with Custom.
164 Only programs can do so."
165 :group 'server
166 :version "22.1"
167 :type '(choice (const :tag "Use selected window"
168 :match (lambda (widget value)
169 (not (functionp value)))
170 nil)
171 (function-item :tag "Display in new frame" switch-to-buffer-other-frame)
172 (function-item :tag "Use pop-to-buffer" pop-to-buffer)
173 (function :tag "Other function")))
175 (defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
176 "Regexp matching names of temporary files.
177 These are deleted and reused after each edit by the programs that
178 invoke the Emacs server."
179 :group 'server
180 :type 'regexp)
182 (defcustom server-kill-new-buffers t
183 "Whether to kill buffers when done with them.
184 If non-nil, kill a buffer unless it already existed before editing
185 it with the Emacs server. If nil, kill only buffers as specified by
186 `server-temp-file-regexp'.
187 Please note that only buffers that still have a client are killed,
188 i.e. buffers visited with \"emacsclient --no-wait\" are never killed
189 in this way."
190 :group 'server
191 :type 'boolean
192 :version "21.1")
194 (or (assq 'server-buffer-clients minor-mode-alist)
195 (push '(server-buffer-clients " Server") minor-mode-alist))
197 (defvar server-existing-buffer nil
198 "Non-nil means the buffer existed before the server was asked to visit it.
199 This means that the server should not kill the buffer when you say you
200 are done with it in the server.")
201 (make-variable-buffer-local 'server-existing-buffer)
203 (defvar server-name "server")
205 (defvar server-socket-dir
206 (and (featurep 'make-network-process '(:family local))
207 (format "%s/emacs%d" (or (getenv "TMPDIR") "/tmp") (user-uid)))
208 "The directory in which to place the server socket.
209 If local sockets are not supported, this is nil.")
211 (defun server-clients-with (property value)
212 "Return a list of clients with PROPERTY set to VALUE."
213 (let (result)
214 (dolist (proc server-clients result)
215 (when (equal value (process-get proc property))
216 (push proc result)))))
218 (defun server-add-client (proc)
219 "Create a client for process PROC, if it doesn't already have one.
220 New clients have no properties."
221 (add-to-list 'server-clients proc))
223 (defmacro server-with-environment (env vars &rest body)
224 "Evaluate BODY with environment variables VARS set to those in ENV.
225 The environment variables are then restored to their previous values.
227 VARS should be a list of strings.
228 ENV should be in the same format as `process-environment'."
229 (declare (indent 2))
230 (let ((var (make-symbol "var"))
231 (value (make-symbol "value")))
232 `(let ((process-environment process-environment))
233 (dolist (,var ,vars)
234 (let ((,value (getenv-internal ,var ,env)))
235 (push (if (null ,value)
236 ,var
237 (concat ,var "=" ,value))
238 process-environment)))
239 (progn ,@body))))
241 (defun server-delete-client (proc &optional noframe)
242 "Delete PROC, including its buffers, terminals and frames.
243 If NOFRAME is non-nil, let the frames live.
244 Updates `server-clients'."
245 (server-log (concat "server-delete-client" (if noframe " noframe")) proc)
246 ;; Force a new lookup of client (prevents infinite recursion).
247 (when (memq proc server-clients)
248 (let ((buffers (process-get proc 'buffers)))
250 ;; Kill the client's buffers.
251 (dolist (buf buffers)
252 (when (buffer-live-p buf)
253 (with-current-buffer buf
254 ;; Kill the buffer if necessary.
255 (when (and (equal server-buffer-clients
256 (list proc))
257 (or (and server-kill-new-buffers
258 (not server-existing-buffer))
259 (server-temp-file-p))
260 (not (buffer-modified-p)))
261 (let (flag)
262 (unwind-protect
263 (progn (setq server-buffer-clients nil)
264 (kill-buffer (current-buffer))
265 (setq flag t))
266 (unless flag
267 ;; Restore clients if user pressed C-g in `kill-buffer'.
268 (setq server-buffer-clients (list proc)))))))))
270 ;; Delete the client's frames.
271 (unless noframe
272 (dolist (frame (frame-list))
273 (when (and (frame-live-p frame)
274 (equal proc (frame-parameter frame 'client)))
275 ;; Prevent `server-handle-delete-frame' from calling us
276 ;; recursively.
277 (set-frame-parameter frame 'client nil)
278 (delete-frame frame))))
280 (setq server-clients (delq proc server-clients))
282 ;; Delete the client's tty.
283 (let ((terminal (process-get proc 'terminal)))
284 ;; Only delete the terminal if it is non-nil.
285 (when (and terminal (eq (terminal-live-p terminal) t))
286 (delete-terminal terminal)))
288 ;; Delete the client's process.
289 (if (eq (process-status proc) 'open)
290 (delete-process proc))
292 (server-log "Deleted" proc))))
294 (defvar server-log-time-function 'current-time-string
295 "Function to generate timestamps for `server-buffer'.")
297 (defconst server-buffer " *server*"
298 "Buffer used internally by Emacs's server.
299 One use is to log the I/O for debugging purposes (see `server-log'),
300 the other is to provide a current buffer in which the process filter can
301 safely let-bind buffer-local variables like `default-directory'.")
303 (defvar server-log nil
304 "If non-nil, log the server's inputs and outputs in the `server-buffer'.")
306 (defun server-log (string &optional client)
307 "If `server-log' is non-nil, log STRING to `server-buffer'.
308 If CLIENT is non-nil, add a description of it to the logged message."
309 (when server-log
310 (with-current-buffer (get-buffer-create server-buffer)
311 (goto-char (point-max))
312 (insert (funcall server-log-time-function)
313 (cond
314 ((null client) " ")
315 ((listp client) (format " %s: " (car client)))
316 (t (format " %s: " client)))
317 string)
318 (or (bolp) (newline)))))
320 (defun server-sentinel (proc msg)
321 "The process sentinel for Emacs server connections."
322 ;; If this is a new client process, set the query-on-exit flag to nil
323 ;; for this process (it isn't inherited from the server process).
324 (when (and (eq (process-status proc) 'open)
325 (process-query-on-exit-flag proc))
326 (set-process-query-on-exit-flag proc nil))
327 ;; Delete the associated connection file, if applicable.
328 ;; Although there's no 100% guarantee that the file is owned by the
329 ;; running Emacs instance, server-start uses server-running-p to check
330 ;; for possible servers before doing anything, so it *should* be ours.
331 (and (process-contact proc :server)
332 (eq (process-status proc) 'closed)
333 (ignore-errors (delete-file (process-get proc :server-file))))
334 (server-log (format "Status changed to %s: %s" (process-status proc) msg) proc)
335 (server-delete-client proc))
337 (defun server-select-display (display)
338 ;; If the current frame is on `display' we're all set.
339 ;; Similarly if we are unable to open frames on other displays, there's
340 ;; nothing more we can do.
341 (unless (or (not (fboundp 'make-frame-on-display))
342 (equal (frame-parameter (selected-frame) 'display) display))
343 ;; Otherwise, look for an existing frame there and select it.
344 (dolist (frame (frame-list))
345 (when (equal (frame-parameter frame 'display) display)
346 (select-frame frame)))
347 ;; If there's no frame on that display yet, create and select one.
348 (unless (equal (frame-parameter (selected-frame) 'display) display)
349 (let* ((buffer (generate-new-buffer " *server-dummy*"))
350 (frame (make-frame-on-display
351 display
352 ;; Make it display (and remember) some dummy buffer, so
353 ;; we can detect later if the frame is in use or not.
354 `((server-dummy-buffer . ,buffer)
355 ;; This frame may be deleted later (see
356 ;; server-unselect-display) so we want it to be as
357 ;; unobtrusive as possible.
358 (visibility . nil)))))
359 (select-frame frame)
360 (set-window-buffer (selected-window) buffer)
361 frame))))
363 (defun server-unselect-display (frame)
364 (when (frame-live-p frame)
365 ;; If the temporary frame is in use (displays something real), make it
366 ;; visible. If not (which can happen if the user's customizations call
367 ;; pop-to-buffer etc.), delete it to avoid preserving the connection after
368 ;; the last real frame is deleted.
369 (if (and (eq (frame-first-window frame)
370 (next-window (frame-first-window frame) 'nomini))
371 (eq (window-buffer (frame-first-window frame))
372 (frame-parameter frame 'server-dummy-buffer)))
373 ;; The temp frame still only shows one buffer, and that is the
374 ;; internal temp buffer.
375 (delete-frame frame)
376 (set-frame-parameter frame 'visibility t))
377 (kill-buffer (frame-parameter frame 'server-dummy-buffer))
378 (set-frame-parameter frame 'server-dummy-buffer nil)))
380 (defun server-handle-delete-frame (frame)
381 "Delete the client connection when the emacsclient frame is deleted.
382 \(To be used from `delete-frame-functions'.)"
383 (let ((proc (frame-parameter frame 'client)))
384 (when (and (frame-live-p frame)
385 proc
386 ;; See if this is the last frame for this client.
387 (>= 1 (let ((frame-num 0))
388 (dolist (f (frame-list))
389 (when (eq proc (frame-parameter f 'client))
390 (setq frame-num (1+ frame-num))))
391 frame-num)))
392 (server-log (format "server-handle-delete-frame, frame %s" frame) proc)
393 (server-delete-client proc 'noframe)))) ; Let delete-frame delete the frame later.
395 (defun server-handle-suspend-tty (terminal)
396 "Notify the emacsclient process to suspend itself when its tty device is suspended."
397 (dolist (proc (server-clients-with 'terminal terminal))
398 (server-log (format "server-handle-suspend-tty, terminal %s" terminal) proc)
399 (condition-case err
400 (server-send-string proc "-suspend \n")
401 (file-error ;The pipe/socket was closed.
402 (ignore-errors (server-delete-client proc))))))
404 (defun server-unquote-arg (arg)
405 "Remove &-quotation from ARG.
406 See `server-quote-arg' and `server-process-filter'."
407 (replace-regexp-in-string
408 "&." (lambda (s)
409 (case (aref s 1)
410 (?& "&")
411 (?- "-")
412 (?n "\n")
413 (t " ")))
414 arg t t))
416 (defun server-quote-arg (arg)
417 "In ARG, insert a & before each &, each space, each newline, and -.
418 Change spaces to underscores, too, so that the return value never
419 contains a space.
421 See `server-unquote-arg' and `server-process-filter'."
422 (replace-regexp-in-string
423 "[-&\n ]" (lambda (s)
424 (case (aref s 0)
425 (?& "&&")
426 (?- "&-")
427 (?\n "&n")
428 (?\s "&_")))
429 arg t t))
431 (defun server-send-string (proc string)
432 "A wrapper around `process-send-string' for logging."
433 (server-log (concat "Sent " string) proc)
434 (process-send-string proc string))
436 (defun server-ensure-safe-dir (dir)
437 "Make sure DIR is a directory with no race-condition issues.
438 Creates the directory if necessary and makes sure:
439 - there's no symlink involved
440 - it's owned by us
441 - it's not readable/writable by anybody else."
442 (setq dir (directory-file-name dir))
443 (let ((attrs (file-attributes dir)))
444 (unless attrs
445 (letf (((default-file-modes) ?\700)) (make-directory dir t))
446 (setq attrs (file-attributes dir)))
447 ;; Check that it's safe for use.
448 (unless (and (eq t (car attrs)) (eql (nth 2 attrs) (user-uid))
449 (or (eq system-type 'windows-nt)
450 (zerop (logand ?\077 (file-modes dir)))))
451 (error "The directory %s is unsafe" dir))))
453 ;;;###autoload
454 (defun server-start (&optional leave-dead)
455 "Allow this Emacs process to be a server for client processes.
456 This starts a server communications subprocess through which
457 client \"editors\" can send your editing commands to this Emacs
458 job. To use the server, set up the program `emacsclient' in the
459 Emacs distribution as your standard \"editor\".
461 Optional argument LEAVE-DEAD (interactively, a prefix arg) means just
462 kill any existing server communications subprocess.
464 If a server is already running, the server is not started.
465 To force-start a server, do \\[server-force-delete] and then
466 \\[server-start]."
467 (interactive "P")
468 (when (or
469 (not server-clients)
470 (yes-or-no-p
471 "The current server still has clients; delete them? "))
472 (let* ((server-dir (if server-use-tcp server-auth-dir server-socket-dir))
473 (server-file (expand-file-name server-name server-dir)))
474 (when server-process
475 ;; kill it dead!
476 (ignore-errors (delete-process server-process)))
477 ;; Delete the socket files made by previous server invocations.
478 (if (not (eq t (server-running-p server-name)))
479 ;; Remove any leftover socket or authentication file
480 (ignore-errors (delete-file server-file))
481 (setq server-mode nil) ;; already set by the minor mode code
482 (display-warning 'server
483 (format "Emacs server named %S already running" server-name)
484 :warning)
485 (setq leave-dead t))
486 ;; If this Emacs already had a server, clear out associated status.
487 (while server-clients
488 (server-delete-client (car server-clients)))
489 ;; Now any previous server is properly stopped.
490 (if leave-dead
491 (progn
492 (unless (eq t leave-dead) (server-log (message "Server stopped")))
493 (setq server-process nil))
494 ;; Make sure there is a safe directory in which to place the socket.
495 (server-ensure-safe-dir server-dir)
496 (when server-process
497 (server-log (message "Restarting server")))
498 (letf (((default-file-modes) ?\700))
499 (add-hook 'suspend-tty-functions 'server-handle-suspend-tty)
500 (add-hook 'delete-frame-functions 'server-handle-delete-frame)
501 (add-hook 'kill-buffer-query-functions 'server-kill-buffer-query-function)
502 (add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
503 (add-hook 'kill-emacs-hook (lambda () (server-mode -1))) ;Cleanup upon exit.
504 (setq server-process
505 (apply #'make-network-process
506 :name server-name
507 :server t
508 :noquery t
509 :sentinel 'server-sentinel
510 :filter 'server-process-filter
511 ;; We must receive file names without being decoded.
512 ;; Those are decoded by server-process-filter according
513 ;; to file-name-coding-system. Also don't get
514 ;; confused by CRs since we don't quote them.
515 :coding 'raw-text-unix
516 ;; The other args depend on the kind of socket used.
517 (if server-use-tcp
518 (list :family nil
519 :service t
520 :host (or server-host 'local)
521 :plist '(:authenticated nil))
522 (list :family 'local
523 :service server-file
524 :plist '(:authenticated t)))))
525 (unless server-process (error "Could not start server process"))
526 (process-put server-process :server-file server-file)
527 (when server-use-tcp
528 (let ((auth-key
529 (loop
530 ;; The auth key is a 64-byte string of random chars in the
531 ;; range `!'..`~'.
532 for i below 64
533 collect (+ 33 (random 94)) into auth
534 finally return (concat auth))))
535 (process-put server-process :auth-key auth-key)
536 (with-temp-file server-file
537 (set-buffer-multibyte nil)
538 (setq buffer-file-coding-system 'no-conversion)
539 (insert (format-network-address
540 (process-contact server-process :local))
541 " " (int-to-string (emacs-pid))
542 "\n" auth-key)))))))))
544 ;;;###autoload
545 (defun server-force-delete (&optional name)
546 "Unconditionally delete connection file for server NAME.
547 If server is running, it is first stopped.
548 NAME defaults to `server-name'. With argument, ask for NAME."
549 (interactive
550 (list (if current-prefix-arg
551 (read-string "Server name: " nil nil server-name))))
552 (when server-mode (with-temp-message nil (server-mode -1)))
553 (let ((file (expand-file-name (or name server-name)
554 (if server-use-tcp
555 server-auth-dir
556 server-socket-dir))))
557 (condition-case nil
558 (progn
559 (delete-file file)
560 (message "Connection file %S deleted" file))
561 (file-error
562 (message "No connection file %S" file)))))
564 (defun server-running-p (&optional name)
565 "Test whether server NAME is running.
567 Return values:
568 nil the server is definitely not running.
569 t the server seems to be running.
570 something else we cannot determine whether it's running without using
571 commands which may have to wait for a long time."
572 (interactive
573 (list (if current-prefix-arg
574 (read-string "Server name: " nil nil server-name))))
575 (unless name (setq name server-name))
576 (condition-case nil
577 (if server-use-tcp
578 (with-temp-buffer
579 (insert-file-contents-literally (expand-file-name name server-auth-dir))
580 (or (and (looking-at "127\.0\.0\.1:[0-9]+ \\([0-9]+\\)")
581 (assq 'comm
582 (system-process-attributes
583 (string-to-number (match-string 1))))
585 :other))
586 (delete-process
587 (make-network-process
588 :name "server-client-test" :family 'local :server nil :noquery t
589 :service (expand-file-name name server-socket-dir)))
591 (file-error nil)))
593 ;;;###autoload
594 (define-minor-mode server-mode
595 "Toggle Server mode.
596 With ARG, turn Server mode on if ARG is positive, off otherwise.
597 Server mode runs a process that accepts commands from the
598 `emacsclient' program. See `server-start' and Info node `Emacs server'."
599 :global t
600 :group 'server
601 :version "22.1"
602 ;; Fixme: Should this check for an existing server socket and do
603 ;; nothing if there is one (for multiple Emacs sessions)?
604 (server-start (not server-mode)))
606 (defun server-eval-and-print (expr proc)
607 "Eval EXPR and send the result back to client PROC."
608 (let ((v (eval (car (read-from-string expr)))))
609 (when (and v proc)
610 (with-temp-buffer
611 (let ((standard-output (current-buffer)))
612 (pp v)
613 (let ((text (buffer-substring-no-properties
614 (point-min) (point-max))))
615 (server-send-string
616 proc (format "-print %s\n"
617 (server-quote-arg text)))))))))
619 (defun server-create-tty-frame (tty type proc)
620 (add-to-list 'frame-inherited-parameters 'client)
621 (let ((frame
622 (server-with-environment (process-get proc 'env)
623 '("LANG" "LC_CTYPE" "LC_ALL"
624 ;; For tgetent(3); list according to ncurses(3).
625 "BAUDRATE" "COLUMNS" "ESCDELAY" "HOME" "LINES"
626 "NCURSES_ASSUMED_COLORS" "NCURSES_NO_PADDING"
627 "NCURSES_NO_SETBUF" "TERM" "TERMCAP" "TERMINFO"
628 "TERMINFO_DIRS" "TERMPATH"
629 ;; rxvt wants these
630 "COLORFGBG" "COLORTERM")
631 (make-frame-on-tty tty type
632 ;; Ignore nowait here; we always need to
633 ;; clean up opened ttys when the client dies.
634 `((client . ,proc)
635 ;; This is a leftover from an earlier
636 ;; attempt at making it possible for process
637 ;; run in the server process to use the
638 ;; environment of the client process.
639 ;; It has no effect now and to make it work
640 ;; we'd need to decide how to make
641 ;; process-environment interact with client
642 ;; envvars, and then to change the
643 ;; C functions `child_setup' and
644 ;; `getenv_internal' accordingly.
645 (environment . ,(process-get proc 'env)))))))
647 ;; ttys don't use the `display' parameter, but callproc.c does to set
648 ;; the DISPLAY environment on subprocesses.
649 (set-frame-parameter frame 'display
650 (getenv-internal "DISPLAY" (process-get proc 'env)))
651 (select-frame frame)
652 (process-put proc 'frame frame)
653 (process-put proc 'terminal (frame-terminal frame))
655 ;; Display *scratch* by default.
656 (switch-to-buffer (get-buffer-create "*scratch*") 'norecord)
658 ;; Reply with our pid.
659 (server-send-string proc (concat "-emacs-pid "
660 (number-to-string (emacs-pid)) "\n"))
661 frame))
663 (defun server-create-window-system-frame (display nowait proc)
664 (add-to-list 'frame-inherited-parameters 'client)
665 (if (not (fboundp 'make-frame-on-display))
666 (progn
667 ;; This emacs does not support X.
668 (server-log "Window system unsupported" proc)
669 (server-send-string proc "-window-system-unsupported \n")
670 nil)
671 ;; Flag frame as client-created, but use a dummy client.
672 ;; This will prevent the frame from being deleted when
673 ;; emacsclient quits while also preventing
674 ;; `server-save-buffers-kill-terminal' from unexpectedly
675 ;; killing emacs on that frame.
676 (let* ((params `((client . ,(if nowait 'nowait proc))
677 ;; This is a leftover, see above.
678 (environment . ,(process-get proc 'env))))
679 (frame (make-frame-on-display
680 (or display
681 (frame-parameter nil 'display)
682 (getenv "DISPLAY")
683 (error "Please specify display"))
684 params)))
685 (server-log (format "%s created" frame) proc)
686 (select-frame frame)
687 (process-put proc 'frame frame)
688 (process-put proc 'terminal (frame-terminal frame))
690 ;; Display *scratch* by default.
691 (switch-to-buffer (get-buffer-create "*scratch*") 'norecord)
692 frame)))
694 (defun server-goto-toplevel (proc)
695 (condition-case nil
696 ;; If we're running isearch, we must abort it to allow Emacs to
697 ;; display the buffer and switch to it.
698 (dolist (buffer (buffer-list))
699 (with-current-buffer buffer
700 (when (bound-and-true-p isearch-mode)
701 (isearch-cancel))))
702 ;; Signaled by isearch-cancel.
703 (quit (message nil)))
704 (when (> (recursion-depth) 0)
705 ;; We're inside a minibuffer already, so if the emacs-client is trying
706 ;; to open a frame on a new display, we might end up with an unusable
707 ;; frame because input from that display will be blocked (until exiting
708 ;; the minibuffer). Better exit this minibuffer right away.
709 ;; Similarly with recursive-edits such as the splash screen.
710 (run-with-timer 0 nil (lexical-let ((proc proc))
711 (lambda () (server-execute-continuation proc))))
712 (top-level)))
714 ;; We use various special properties on process objects:
715 ;; - `env' stores the info about the environment of the emacsclient process.
716 ;; - `continuation' is a no-arg function that we need to execute. It contains
717 ;; commands we wanted to execute in some earlier invocation of the process
718 ;; filter but that we somehow were unable to process at that time
719 ;; (e.g. because we first need to throw to the toplevel).
721 (defun server-execute-continuation (proc)
722 (let ((continuation (process-get proc 'continuation)))
723 (process-put proc 'continuation nil)
724 (if continuation (ignore-errors (funcall continuation)))))
726 (defun* server-process-filter (proc string)
727 "Process a request from the server to edit some files.
728 PROC is the server process. STRING consists of a sequence of
729 commands prefixed by a dash. Some commands have arguments;
730 these are &-quoted and need to be decoded by `server-unquote-arg'.
731 The filter parses and executes these commands.
733 To illustrate the protocol, here is an example command that
734 emacsclient sends to create a new X frame (note that the whole
735 sequence is sent on a single line):
737 -env HOME=/home/lorentey
738 -env DISPLAY=:0.0
739 ... lots of other -env commands
740 -display :0.0
741 -window-system
743 The following commands are accepted by the server:
745 `-auth AUTH-STRING'
746 Authenticate the client using the secret authentication string
747 AUTH-STRING.
749 `-env NAME=VALUE'
750 An environment variable on the client side.
752 `-dir DIRNAME'
753 The current working directory of the client process.
755 `-current-frame'
756 Forbid the creation of new frames.
758 `-nowait'
759 Request that the next frame created should not be
760 associated with this client.
762 `-display DISPLAY'
763 Set the display name to open X frames on.
765 `-position LINE[:COLUMN]'
766 Go to the given line and column number
767 in the next file opened.
769 `-file FILENAME'
770 Load the given file in the current frame.
772 `-eval EXPR'
773 Evaluate EXPR as a Lisp expression and return the
774 result in -print commands.
776 `-window-system'
777 Open a new X frame.
779 `-tty DEVICENAME TYPE'
780 Open a new tty frame at the client.
782 `-suspend'
783 Suspend this tty frame. The client sends this string in
784 response to SIGTSTP and SIGTTOU. The server must cease all I/O
785 on this tty until it gets a -resume command.
787 `-resume'
788 Resume this tty frame. The client sends this string when it
789 gets the SIGCONT signal and it is the foreground process on its
790 controlling tty.
792 `-ignore COMMENT'
793 Do nothing, but put the comment in the server log.
794 Useful for debugging.
797 The following commands are accepted by the client:
799 `-emacs-pid PID'
800 Describes the process id of the Emacs process;
801 used to forward window change signals to it.
803 `-window-system-unsupported'
804 Signals that the server does not support creating X frames;
805 the client must try again with a tty frame.
807 `-print STRING'
808 Print STRING on stdout. Used to send values
809 returned by -eval.
811 `-error DESCRIPTION'
812 Signal an error (but continue processing).
814 `-suspend'
815 Suspend this terminal, i.e., stop the client process.
816 Sent when the user presses C-z."
817 (server-log (concat "Received " string) proc)
818 ;; First things first: let's check the authentication
819 (unless (process-get proc :authenticated)
820 (if (and (string-match "-auth \\([!-~]+\\)\n?" string)
821 (equal (match-string 1 string) (process-get proc :auth-key)))
822 (progn
823 (setq string (substring string (match-end 0)))
824 (process-put proc :authenticated t)
825 (server-log "Authentication successful" proc))
826 (server-log "Authentication failed" proc)
827 (server-send-string
828 proc (concat "-error " (server-quote-arg "Authentication failed")))
829 (delete-process proc)
830 ;; We return immediately
831 (return-from server-process-filter)))
832 (let ((prev (process-get proc 'previous-string)))
833 (when prev
834 (setq string (concat prev string))
835 (process-put proc 'previous-string nil)))
836 (condition-case err
837 (progn
838 (server-add-client proc)
839 (if (not (string-match "\n" string))
840 ;; Save for later any partial line that remains.
841 (when (> (length string) 0)
842 (process-put proc 'previous-string string))
844 ;; In earlier versions of server.el (where we used an `emacsserver'
845 ;; process), there could be multiple lines. Nowadays this is not
846 ;; supported any more.
847 (assert (eq (match-end 0) (length string)))
848 (let ((request (substring string 0 (match-beginning 0)))
849 (coding-system (and default-enable-multibyte-characters
850 (or file-name-coding-system
851 default-file-name-coding-system)))
852 nowait ; t if emacsclient does not want to wait for us.
853 frame ; The frame that was opened for the client (if any).
854 display ; Open the frame on this display.
855 dontkill ; t if the client should not be killed.
856 commands
858 use-current-frame
859 tty-name ;nil, `window-system', or the tty name.
860 tty-type ;string.
861 files
862 filepos
863 command-line-args-left
864 arg)
865 ;; Remove this line from STRING.
866 (setq string (substring string (match-end 0)))
867 (setq command-line-args-left
868 (mapcar 'server-unquote-arg (split-string request " " t)))
869 (while (setq arg (pop command-line-args-left))
870 (cond
871 ;; -version CLIENT-VERSION: obsolete at birth.
872 ((and (equal "-version" arg) command-line-args-left)
873 (pop command-line-args-left))
875 ;; -nowait: Emacsclient won't wait for a result.
876 ((equal "-nowait" arg) (setq nowait t))
878 ;; -current-frame: Don't create frames.
879 ((equal "-current-frame" arg) (setq use-current-frame t))
881 ;; -display DISPLAY:
882 ;; Open X frames on the given display instead of the default.
883 ((and (equal "-display" arg) command-line-args-left)
884 (setq display (pop command-line-args-left))
885 (if (zerop (length display)) (setq display nil)))
887 ;; -window-system: Open a new X frame.
888 ((equal "-window-system" arg)
889 (setq dontkill t)
890 (setq tty-name 'window-system))
892 ;; -resume: Resume a suspended tty frame.
893 ((equal "-resume" arg)
894 (lexical-let ((terminal (process-get proc 'terminal)))
895 (setq dontkill t)
896 (push (lambda ()
897 (when (eq (terminal-live-p terminal) t)
898 (resume-tty terminal)))
899 commands)))
901 ;; -suspend: Suspend the client's frame. (In case we
902 ;; get out of sync, and a C-z sends a SIGTSTP to
903 ;; emacsclient.)
904 ((equal "-suspend" arg)
905 (lexical-let ((terminal (process-get proc 'terminal)))
906 (setq dontkill t)
907 (push (lambda ()
908 (when (eq (terminal-live-p terminal) t)
909 (suspend-tty terminal)))
910 commands)))
912 ;; -ignore COMMENT: Noop; useful for debugging emacsclient.
913 ;; (The given comment appears in the server log.)
914 ((and (equal "-ignore" arg) command-line-args-left
915 (setq dontkill t)
916 (pop command-line-args-left)))
918 ;; -tty DEVICE-NAME TYPE: Open a new tty frame at the client.
919 ((and (equal "-tty" arg)
920 (cdr command-line-args-left))
921 (setq tty-name (pop command-line-args-left)
922 tty-type (pop command-line-args-left)
923 dontkill (or dontkill
924 (not use-current-frame))))
926 ;; -position LINE[:COLUMN]: Set point to the given
927 ;; position in the next file.
928 ((and (equal "-position" arg)
929 command-line-args-left
930 (string-match "\\+\\([0-9]+\\)\\(?::\\([0-9]+\\)\\)?"
931 (car command-line-args-left)))
932 (setq arg (pop command-line-args-left))
933 (setq filepos
934 (cons (string-to-number (match-string 1 arg))
935 (string-to-number (or (match-string 2 arg) "")))))
937 ;; -file FILENAME: Load the given file.
938 ((and (equal "-file" arg)
939 command-line-args-left)
940 (let ((file (pop command-line-args-left)))
941 (if coding-system
942 (setq file (decode-coding-string file coding-system)))
943 (setq file (command-line-normalize-file-name file))
944 (push (cons file filepos) files)
945 (server-log (format "New file: %s %s"
946 file (or filepos "")) proc))
947 (setq filepos nil))
949 ;; -eval EXPR: Evaluate a Lisp expression.
950 ((and (equal "-eval" arg)
951 command-line-args-left)
952 (if use-current-frame
953 (setq use-current-frame 'always))
954 (lexical-let ((expr (pop command-line-args-left)))
955 (if coding-system
956 (setq expr (decode-coding-string expr coding-system)))
957 (push (lambda () (server-eval-and-print expr proc))
958 commands)
959 (setq filepos nil)))
961 ;; -env NAME=VALUE: An environment variable.
962 ((and (equal "-env" arg) command-line-args-left)
963 (let ((var (pop command-line-args-left)))
964 ;; XXX Variables should be encoded as in getenv/setenv.
965 (process-put proc 'env
966 (cons var (process-get proc 'env)))))
968 ;; -dir DIRNAME: The cwd of the emacsclient process.
969 ((and (equal "-dir" arg) command-line-args-left)
970 (setq dir (pop command-line-args-left))
971 (if coding-system
972 (setq dir (decode-coding-string dir coding-system)))
973 (setq dir (command-line-normalize-file-name dir)))
975 ;; Unknown command.
976 (t (error "Unknown command: %s" arg))))
978 (setq frame
979 (cond
980 ((and use-current-frame
981 (or (eq use-current-frame 'always)
982 ;; We can't use the Emacs daemon's
983 ;; terminal frame.
984 (not (and (daemonp)
985 (= (length (frame-list)) 1)
986 (eq (selected-frame)
987 terminal-frame)))))
988 (setq tty-name nil tty-type nil)
989 (if display (server-select-display display)))
990 ((eq tty-name 'window-system)
991 (server-create-window-system-frame display nowait proc))
992 ;; When resuming on a tty, tty-name is nil.
993 (tty-name
994 (server-create-tty-frame tty-name tty-type proc))))
996 (process-put
997 proc 'continuation
998 (lexical-let ((proc proc)
999 (files files)
1000 (nowait nowait)
1001 (commands commands)
1002 (dontkill dontkill)
1003 (frame frame)
1004 (dir dir)
1005 (tty-name tty-name))
1006 (lambda ()
1007 (with-current-buffer (get-buffer-create server-buffer)
1008 ;; Use the same cwd as the emacsclient, if possible, so
1009 ;; relative file names work correctly, even in `eval'.
1010 (let ((default-directory
1011 (if (and dir (file-directory-p dir))
1012 dir default-directory)))
1013 (server-execute proc files nowait commands
1014 dontkill frame tty-name))))))
1016 (when (or frame files)
1017 (server-goto-toplevel proc))
1019 (server-execute-continuation proc))))
1020 ;; condition-case
1021 (error (server-return-error proc err))))
1023 (defun server-execute (proc files nowait commands dontkill frame tty-name)
1024 (condition-case err
1025 (let* ((buffers
1026 (when files
1027 (run-hooks 'pre-command-hook)
1028 (prog1 (server-visit-files files proc nowait)
1029 (run-hooks 'post-command-hook)))))
1031 (mapc 'funcall (nreverse commands))
1033 ;; Delete the client if necessary.
1034 (cond
1035 (nowait
1036 ;; Client requested nowait; return immediately.
1037 (server-log "Close nowait client" proc)
1038 (server-delete-client proc))
1039 ((and (not dontkill) (null buffers))
1040 ;; This client is empty; get rid of it immediately.
1041 (server-log "Close empty client" proc)
1042 (server-delete-client proc)))
1043 (cond
1044 ((or isearch-mode (minibufferp))
1045 nil)
1046 ((and frame (null buffers))
1047 (message "%s" (substitute-command-keys
1048 "When done with this frame, type \\[delete-frame]")))
1049 ((not (null buffers))
1050 (server-switch-buffer (car buffers) nil (cdr (car files)))
1051 (run-hooks 'server-switch-hook)
1052 (unless nowait
1053 (message "%s" (substitute-command-keys
1054 "When done with a buffer, type \\[server-edit]")))))
1055 (when (and frame (null tty-name))
1056 (server-unselect-display frame)))
1057 (error (server-return-error proc err))))
1059 (defun server-return-error (proc err)
1060 (ignore-errors
1061 (server-send-string
1062 proc (concat "-error " (server-quote-arg
1063 (error-message-string err))))
1064 (server-log (error-message-string err) proc)
1065 (delete-process proc)))
1067 (defun server-goto-line-column (line-col)
1068 "Move point to the position indicated in LINE-COL.
1069 LINE-COL should be a pair (LINE . COL)."
1070 (when line-col
1071 (goto-line (car line-col))
1072 (let ((column-number (cdr line-col)))
1073 (when (> column-number 0)
1074 (move-to-column (1- column-number))))))
1076 (defun server-visit-files (files proc &optional nowait)
1077 "Find FILES and return a list of buffers created.
1078 FILES is an alist whose elements are (FILENAME . FILEPOS)
1079 where FILEPOS can be nil or a pair (LINENUMBER . COLUMNNUMBER).
1080 PROC is the client that requested this operation.
1081 NOWAIT non-nil means this client is not waiting for the results,
1082 so don't mark these buffers specially, just visit them normally."
1083 ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
1084 (let ((last-nonmenu-event t) client-record)
1085 ;; Restore the current buffer afterward, but not using save-excursion,
1086 ;; because we don't want to save point in this buffer
1087 ;; if it happens to be one of those specified by the server.
1088 (save-current-buffer
1089 (dolist (file files)
1090 ;; If there is an existing buffer modified or the file is
1091 ;; modified, revert it. If there is an existing buffer with
1092 ;; deleted file, offer to write it.
1093 (let* ((minibuffer-auto-raise (or server-raise-frame
1094 minibuffer-auto-raise))
1095 (filen (car file))
1096 (obuf (get-file-buffer filen)))
1097 (add-to-history 'file-name-history filen)
1098 (if (null obuf)
1099 (set-buffer (find-file-noselect filen))
1100 (set-buffer obuf)
1101 (cond ((file-exists-p filen)
1102 (when (not (verify-visited-file-modtime obuf))
1103 (revert-buffer t nil)))
1105 (when (y-or-n-p
1106 (concat "File no longer exists: " filen
1107 ", write buffer to file? "))
1108 (write-file filen))))
1109 (unless server-buffer-clients
1110 (setq server-existing-buffer t)))
1111 (server-goto-line-column (cdr file))
1112 (run-hooks 'server-visit-hook))
1113 (unless nowait
1114 ;; When the buffer is killed, inform the clients.
1115 (add-hook 'kill-buffer-hook 'server-kill-buffer nil t)
1116 (push proc server-buffer-clients))
1117 (push (current-buffer) client-record)))
1118 (unless nowait
1119 (process-put proc 'buffers
1120 (nconc (process-get proc 'buffers) client-record)))
1121 client-record))
1123 (defun server-buffer-done (buffer &optional for-killing)
1124 "Mark BUFFER as \"done\" for its client(s).
1125 This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED).
1126 NEXT-BUFFER is another server buffer, as a suggestion for what to select next,
1127 or nil. KILLED is t if we killed BUFFER (typically, because it was visiting
1128 a temp file).
1129 FOR-KILLING if non-nil indicates that we are called from `kill-buffer'."
1130 (let ((next-buffer nil)
1131 (killed nil))
1132 (dolist (proc server-clients)
1133 (let ((buffers (process-get proc 'buffers)))
1134 (or next-buffer
1135 (setq next-buffer (nth 1 (memq buffer buffers))))
1136 (when buffers ; Ignore bufferless clients.
1137 (setq buffers (delq buffer buffers))
1138 ;; Delete all dead buffers from PROC.
1139 (dolist (b buffers)
1140 (and (bufferp b)
1141 (not (buffer-live-p b))
1142 (setq buffers (delq b buffers))))
1143 (process-put proc 'buffers buffers)
1144 ;; If client now has no pending buffers,
1145 ;; tell it that it is done, and forget it entirely.
1146 (unless buffers
1147 (server-log "Close" proc)
1148 (if for-killing
1149 ;; `server-delete-client' might delete the client's
1150 ;; frames, which might change the current buffer. We
1151 ;; don't want that (bug#640).
1152 (save-current-buffer
1153 (server-delete-client proc))
1154 (server-delete-client proc))))))
1155 (when (and (bufferp buffer) (buffer-name buffer))
1156 ;; We may or may not kill this buffer;
1157 ;; if we do, do not call server-buffer-done recursively
1158 ;; from kill-buffer-hook.
1159 (let ((server-kill-buffer-running t))
1160 (with-current-buffer buffer
1161 (setq server-buffer-clients nil)
1162 (run-hooks 'server-done-hook))
1163 ;; Notice whether server-done-hook killed the buffer.
1164 (if (null (buffer-name buffer))
1165 (setq killed t)
1166 ;; Don't bother killing or burying the buffer
1167 ;; when we are called from kill-buffer.
1168 (unless for-killing
1169 (when (and (not killed)
1170 server-kill-new-buffers
1171 (with-current-buffer buffer
1172 (not server-existing-buffer)))
1173 (setq killed t)
1174 (bury-buffer buffer)
1175 (kill-buffer buffer))
1176 (unless killed
1177 (if (server-temp-file-p buffer)
1178 (progn
1179 (kill-buffer buffer)
1180 (setq killed t))
1181 (bury-buffer buffer)))))))
1182 (list next-buffer killed)))
1184 (defun server-temp-file-p (&optional buffer)
1185 "Return non-nil if BUFFER contains a file considered temporary.
1186 These are files whose names suggest they are repeatedly
1187 reused to pass information to another program.
1189 The variable `server-temp-file-regexp' controls which filenames
1190 are considered temporary."
1191 (and (buffer-file-name buffer)
1192 (string-match-p server-temp-file-regexp (buffer-file-name buffer))))
1194 (defun server-done ()
1195 "Offer to save current buffer, mark it as \"done\" for clients.
1196 This kills or buries the buffer, then returns a list
1197 of the form (NEXT-BUFFER KILLED). NEXT-BUFFER is another server buffer,
1198 as a suggestion for what to select next, or nil.
1199 KILLED is t if we killed BUFFER, which happens if it was created
1200 specifically for the clients and did not exist before their request for it."
1201 (when server-buffer-clients
1202 (if (server-temp-file-p)
1203 ;; For a temp file, save, and do make a non-numeric backup
1204 ;; (unless make-backup-files is nil).
1205 (let ((version-control nil)
1206 (buffer-backed-up nil))
1207 (save-buffer))
1208 (when (and (buffer-modified-p)
1209 buffer-file-name
1210 (y-or-n-p (concat "Save file " buffer-file-name "? ")))
1211 (save-buffer)))
1212 (server-buffer-done (current-buffer))))
1214 ;; Ask before killing a server buffer.
1215 ;; It was suggested to release its client instead,
1216 ;; but I think that is dangerous--the client would proceed
1217 ;; using whatever is on disk in that file. -- rms.
1218 (defun server-kill-buffer-query-function ()
1219 "Ask before killing a server buffer."
1220 (or (not server-buffer-clients)
1221 (let ((res t))
1222 (dolist (proc server-buffer-clients res)
1223 (when (and (memq proc server-clients)
1224 (eq (process-status proc) 'open))
1225 (setq res nil))))
1226 (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
1227 (buffer-name (current-buffer))))))
1229 (defun server-kill-emacs-query-function ()
1230 "Ask before exiting Emacs if it has live clients."
1231 (or (not server-clients)
1232 (let (live-client)
1233 (dolist (proc server-clients live-client)
1234 (when (memq t (mapcar 'buffer-live-p (process-get
1235 proc 'buffers)))
1236 (setq live-client t))))
1237 (yes-or-no-p "This Emacs session has clients; exit anyway? ")))
1239 (defvar server-kill-buffer-running nil
1240 "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
1242 (defun server-kill-buffer ()
1243 "Remove the current buffer from its clients' buffer list.
1244 Designed to be added to `kill-buffer-hook'."
1245 ;; Prevent infinite recursion if user has made server-done-hook
1246 ;; call kill-buffer.
1247 (or server-kill-buffer-running
1248 (and server-buffer-clients
1249 (let ((server-kill-buffer-running t))
1250 (when server-process
1251 (server-buffer-done (current-buffer) t))))))
1253 (defun server-edit (&optional arg)
1254 "Switch to next server editing buffer; say \"Done\" for current buffer.
1255 If a server buffer is current, it is marked \"done\" and optionally saved.
1256 The buffer is also killed if it did not exist before the clients asked for it.
1257 When all of a client's buffers are marked as \"done\", the client is notified.
1259 Temporary files such as MH <draft> files are always saved and backed up,
1260 no questions asked. (The variable `make-backup-files', if nil, still
1261 inhibits a backup; you can set it locally in a particular buffer to
1262 prevent a backup for it.) The variable `server-temp-file-regexp' controls
1263 which filenames are considered temporary.
1265 If invoked with a prefix argument, or if there is no server process running,
1266 starts server process and that is all. Invoked by \\[server-edit]."
1267 (interactive "P")
1268 (cond
1269 ((or arg
1270 (not server-process)
1271 (memq (process-status server-process) '(signal exit)))
1272 (server-mode 1))
1273 (server-clients (apply 'server-switch-buffer (server-done)))
1274 (t (message "No server editing buffers exist"))))
1276 (defun server-switch-buffer (&optional next-buffer killed-one filepos)
1277 "Switch to another buffer, preferably one that has a client.
1278 Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it.
1280 KILLED-ONE is t in a recursive call if we have already killed one
1281 temp-file server buffer. This means we should avoid the final
1282 \"switch to some other buffer\" since we've already effectively
1283 done that.
1285 FILEPOS specifies a new buffer position for NEXT-BUFFER, if we
1286 visit NEXT-BUFFER in an existing window. If non-nil, it should
1287 be a cons cell (LINENUMBER . COLUMNNUMBER)."
1288 (if (null next-buffer)
1289 (progn
1290 (let ((rest server-clients))
1291 (while (and rest (not next-buffer))
1292 (let ((proc (car rest)))
1293 ;; Only look at frameless clients, or those in the selected
1294 ;; frame.
1295 (when (or (not (process-get proc 'frame))
1296 (eq (process-get proc 'frame) (selected-frame)))
1297 (setq next-buffer (car (process-get proc 'buffers))))
1298 (setq rest (cdr rest)))))
1299 (and next-buffer (server-switch-buffer next-buffer killed-one))
1300 (unless (or next-buffer killed-one (window-dedicated-p (selected-window)))
1301 ;; (switch-to-buffer (other-buffer))
1302 (message "No server buffers remain to edit")))
1303 (if (not (buffer-live-p next-buffer))
1304 ;; If NEXT-BUFFER is a dead buffer, remove the server records for it
1305 ;; and try the next surviving server buffer.
1306 (apply 'server-switch-buffer (server-buffer-done next-buffer))
1307 ;; OK, we know next-buffer is live, let's display and select it.
1308 (if (functionp server-window)
1309 (funcall server-window next-buffer)
1310 (let ((win (get-buffer-window next-buffer 0)))
1311 (if (and win (not server-window))
1312 ;; The buffer is already displayed: just reuse the
1313 ;; window. If FILEPOS is non-nil, use it to replace the
1314 ;; window's own value of point.
1315 (progn
1316 (select-window win)
1317 (set-buffer next-buffer)
1318 (when filepos
1319 (server-goto-line-column filepos)))
1320 ;; Otherwise, let's find an appropriate window.
1321 (cond ((window-live-p server-window)
1322 (select-window server-window))
1323 ((framep server-window)
1324 (unless (frame-live-p server-window)
1325 (setq server-window (make-frame)))
1326 (select-window (frame-selected-window server-window))))
1327 (when (window-minibuffer-p (selected-window))
1328 (select-window (next-window nil 'nomini 0)))
1329 ;; Move to a non-dedicated window, if we have one.
1330 (when (window-dedicated-p (selected-window))
1331 (select-window
1332 (get-window-with-predicate
1333 (lambda (w)
1334 (and (not (window-dedicated-p w))
1335 (equal (frame-terminal (window-frame w))
1336 (frame-terminal (selected-frame)))))
1337 'nomini 'visible (selected-window))))
1338 (condition-case nil
1339 (switch-to-buffer next-buffer)
1340 ;; After all the above, we might still have ended up with
1341 ;; a minibuffer/dedicated-window (if there's no other).
1342 (error (pop-to-buffer next-buffer)))))))
1343 (when server-raise-frame
1344 (select-frame-set-input-focus (window-frame (selected-window))))))
1346 ;;;###autoload
1347 (defun server-save-buffers-kill-terminal (proc &optional arg)
1348 ;; Called from save-buffers-kill-terminal in files.el.
1349 "Offer to save each buffer, then kill PROC.
1351 With ARG non-nil, silently save all file-visiting buffers, then kill.
1353 If emacsclient was started with a list of filenames to edit, then
1354 only these files will be asked to be saved."
1355 ;; save-buffers-kill-terminal occasionally calls us with proc set
1356 ;; to `nowait' (comes from the value of the `client' frame parameter).
1357 (when (processp proc)
1358 (let ((buffers (process-get proc 'buffers)))
1359 ;; If client is bufferless, emulate a normal Emacs session
1360 ;; exit and offer to save all buffers. Otherwise, offer to
1361 ;; save only the buffers belonging to the client.
1362 (save-some-buffers arg
1363 (if buffers
1364 (lambda () (memq (current-buffer) buffers))
1366 (server-delete-client proc))))
1368 (define-key ctl-x-map "#" 'server-edit)
1370 (defun server-unload-function ()
1371 "Unload the server library."
1372 (server-mode -1)
1373 (substitute-key-definition 'server-edit nil ctl-x-map)
1374 (save-current-buffer
1375 (dolist (buffer (buffer-list))
1376 (set-buffer buffer)
1377 (remove-hook 'kill-buffer-hook 'server-kill-buffer t)))
1378 ;; continue standard unloading
1379 nil)
1382 (provide 'server)
1384 ;; arch-tag: 1f7ecb42-f00a-49f8-906d-61995d84c8d6
1385 ;;; server.el ends here