server.el 30 KB
Newer Older
1
;;; server.el --- Lisp code for GNU Emacs running as server process
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1986,87,92,94,95,96,97,98,99,2000,01,02,03,2004
4
;;	 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Author: William Sommerfeld <wesommer@athena.mit.edu>
Richard M. Stallman's avatar
Richard M. Stallman committed
7
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
8
;; Keywords: processes
Eric S. Raymond's avatar
Eric S. Raymond committed
9

root's avatar
root committed
10 11 12 13 14 15
;; Changes by peck@sun.com and by rms.

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
16
;; the Free Software Foundation; either version 2, or (at your option)
root's avatar
root committed
17 18 19 20 21 22 23 24
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
25 26 27
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
root's avatar
root committed
28

Eric S. Raymond's avatar
Eric S. Raymond committed
29
;;; Commentary:
root's avatar
root committed
30

Erik Naggum's avatar
Erik Naggum committed
31 32
;; This Lisp code is run in Emacs when it is to operate as
;; a server for other processes.
root's avatar
root committed
33

Erik Naggum's avatar
Erik Naggum committed
34
;; Load this library and do M-x server-edit to enable Emacs as a server.
35 36 37
;; Emacs opens up a socket for communication with clients.  If there are no
;; client buffers to edit, server-edit acts like (switch-to-buffer
;; (other-buffer))
root's avatar
root committed
38

Erik Naggum's avatar
Erik Naggum committed
39 40 41 42
;; When some other program runs "the editor" to edit a file,
;; "the editor" can be the Emacs client program ../lib-src/emacsclient.
;; This program transmits the file names to Emacs through
;; the server subprocess, and Emacs visits them and lets you edit them.
root's avatar
root committed
43

Erik Naggum's avatar
Erik Naggum committed
44
;; Note that any number of clients may dispatch files to emacs to be edited.
root's avatar
root committed
45

Erik Naggum's avatar
Erik Naggum committed
46
;; When you finish editing a Server buffer, again call server-edit
47 48
;; to mark that buffer as done for the client and switch to the next
;; Server buffer.  When all the buffers for a client have been edited
Erik Naggum's avatar
Erik Naggum committed
49
;; and exited with server-edit, the client "editor" will return
50
;; to the program that invoked it.
root's avatar
root committed
51

Erik Naggum's avatar
Erik Naggum committed
52 53 54 55
;; Your editing commands and Emacs's display output go to and from
;; the terminal in the usual way.  Thus, server operation is possible
;; only when Emacs can talk to the terminal at the time you invoke
;; the client.  This is possible in four cases:
root's avatar
root committed
56

Erik Naggum's avatar
Erik Naggum committed
57 58
;; 1. On a window system, where Emacs runs in one window and the
;; program that wants to use "the editor" runs in another.
root's avatar
root committed
59

Erik Naggum's avatar
Erik Naggum committed
60 61
;; 2. On a multi-terminal system, where Emacs runs on one terminal and the
;; program that wants to use "the editor" runs on another.
root's avatar
root committed
62

Erik Naggum's avatar
Erik Naggum committed
63 64
;; 3. When the program that wants to use "the editor" is running
;; as a subprocess of Emacs.
root's avatar
root committed
65

Erik Naggum's avatar
Erik Naggum committed
66 67 68 69 70
;; 4. On a system with job control, when Emacs is suspended, the program
;; that wants to use "the editor" will stop and display
;; "Waiting for Emacs...".  It can then be suspended, and Emacs can be
;; brought into the foreground for editing.  When done editing, Emacs is
;; suspended again, and the client program is brought into the foreground.
root's avatar
root committed
71

72 73
;; The buffer local variable "server-buffer-clients" lists
;; the clients who are waiting for this buffer to be edited.
Erik Naggum's avatar
Erik Naggum committed
74 75
;; The global variable "server-clients" lists all the waiting clients,
;; and which files are yet to be edited for each.
Eric S. Raymond's avatar
Eric S. Raymond committed
76 77

;;; Code:
78 79 80

(eval-when-compile (require 'cl))

Richard M. Stallman's avatar
Richard M. Stallman committed
81 82 83 84 85
(defgroup server nil
  "Emacs running as a server process."
  :group 'external)

(defcustom server-visit-hook nil
86
  "*Hook run when visiting a file for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
87
  :group 'server
88
  :type 'hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
89 90

(defcustom server-switch-hook nil
91
  "*Hook run when switching to a buffer for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
92
  :group 'server
93
  :type 'hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
94 95

(defcustom server-done-hook nil
96
  "*Hook run when done editing a buffer for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
97
  :group 'server
98
  :type 'hook)
99

100 101
(defvar server-process nil
  "The current server process.")
root's avatar
root committed
102 103 104

(defvar server-clients nil
  "List of current server clients.
105
Each element is (CLIENTID BUFFERS...) where CLIENTID is a string
root's avatar
root committed
106 107 108
that can be given to the server process to identify a client.
When a buffer is marked as \"done\", it is removed from this list.")

109 110 111
(defvar server-ttys nil
  "List of current terminal devices used by the server.
Each element is (CLIENTID TTY) where CLIENTID is a string
Karoly Lorentey's avatar
Karoly Lorentey committed
112
that can be given to the server process to identify a client.
113
TTY is the name of the tty device.
114 115 116 117 118 119 120 121 122 123 124 125

When all frames on the device are deleted, the server quits the
connection to the client, and vice versa.")

(defvar server-frames nil
  "List of current window-system frames used by the server.
Each element is (CLIENTID FRAME) where CLIENTID is a string
that can be given to the server process to identify a client.
FRAME is the frame that was opened by the client.

When the frame is deleted, the server closes the connection to
the client, and vice versa.")
Karoly Lorentey's avatar
Karoly Lorentey committed
126

root's avatar
root committed
127
(defvar server-buffer-clients nil
128
  "List of client ids for clients requesting editing of current buffer.")
129
(make-variable-buffer-local 'server-buffer-clients)
root's avatar
root committed
130 131 132
;; Changing major modes should not erase this local.
(put 'server-buffer-clients 'permanent-local t)

Dave Love's avatar
Dave Love committed
133 134
(defcustom server-window nil
  "*Specification of the window to use for selecting Emacs server buffers.
135
If nil, use the selected window.
136
If it is a function, it should take one argument (a buffer) and
Dave Love's avatar
Dave Love committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150
display and select it.  A common value is `pop-to-buffer'.
If it is a window, use that.
If it is a frame, use the frame's selected window.

It is not meaningful to set this to a specific frame or window with Custom.
Only programs can do so."
  :group 'server
  :version "21.4"
  :type '(choice (const :tag "Use selected window"
			:match (lambda (widget value)
				 (not (functionp value)))
			nil)
		 (function-item :tag "Use pop-to-buffer" pop-to-buffer)
		 (function :tag "Other function")))
151

Richard M. Stallman's avatar
Richard M. Stallman committed
152
(defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
Dave Love's avatar
Dave Love committed
153 154 155
  "*Regexp matching names of temporary files.
These are deleted and reused after each edit by the programs that
invoke the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
156 157
  :group 'server
  :type 'regexp)
root's avatar
root committed
158

159 160 161
(defcustom server-kill-new-buffers t
  "*Whether to kill buffers when done with them.
If non-nil, kill a buffer unless it already existed before editing
162
it with Emacs server.  If nil, kill only buffers as specified by
163 164 165 166 167 168 169 170
`server-temp-file-regexp'.
Please note that only buffers are killed that still have a client,
i.e. buffers visited which \"emacsclient --no-wait\" are never killed in
this way."
  :group 'server
  :type 'boolean
  :version "21.1")

root's avatar
root committed
171 172 173
(or (assq 'server-buffer-clients minor-mode-alist)
    (setq minor-mode-alist (cons '(server-buffer-clients " Server") minor-mode-alist)))

174
(defvar server-existing-buffer nil
175
  "Non-nil means the buffer existed before the server was asked to visit it.
176
This means that the server should not kill the buffer when you say you
177
are done with it in the server.")
178 179
(make-variable-buffer-local 'server-existing-buffer)

180
(defvar server-socket-name
181
  (format "/tmp/emacs%d/server" (user-uid)))
182

183
(defun server-log (string &optional client)
Dave Love's avatar
Dave Love committed
184
  "If a *server* buffer exists, write STRING to it for logging purposes."
root's avatar
root committed
185
  (if (get-buffer "*server*")
186
      (with-current-buffer "*server*"
root's avatar
root committed
187
	(goto-char (point-max))
188
	(insert (current-time-string)
189
		(if client (format " %s:" client) " ")
190
		string)
191
	(or (bolp) (newline)))))
root's avatar
root committed
192

193 194 195 196 197 198 199 200
(defun server-tty-live-p (tty)
  "Return non-nil if the tty device named TTY has a live frame."
  (let (result)
    (dolist (frame (frame-list) result)
      (when (and (eq (frame-live-p frame) t)
		 (equal (frame-tty-name frame) tty))
	(setq result t)))))

root's avatar
root committed
201
(defun server-sentinel (proc msg)
202
  (let ((client (assq proc server-clients)))
203
    ;; Remove PROC from the list of clients.
204 205 206 207 208 209 210 211 212 213 214
    (when client
      (setq server-clients (delq client server-clients))
      (dolist (buf (cdr client))
	(with-current-buffer buf
	  ;; Remove PROC from the clients of each buffer.
	  (setq server-buffer-clients (delq proc server-buffer-clients))
	  ;; Kill the buffer if necessary.
	  (when (and (null server-buffer-clients)
		     (or (and server-kill-new-buffers
			      (not server-existing-buffer))
			 (server-temp-file-p)))
215
	    (kill-buffer (current-buffer)))))
216 217 218 219 220
      (let ((tty (assq (car client) server-ttys)))
	(when tty
	  (setq server-ttys (delq tty server-ttys))
	  (when (server-tty-live-p (cadr tty))
	    (delete-tty (cadr tty)))))))
221 222
  (server-log (format "Status changed to %s" (process-status proc)) proc))

223
(defun server-handle-delete-tty (tty)
224
  "Delete the client connection when the emacsclient terminal device is closed."
225
  (dolist (entry server-ttys)
226
    (let ((proc (nth 0 entry))
227 228
	  (term (nth 1 entry)))
      (when (equal term tty)
229
	(let ((client (assq proc server-clients)))
230
	  (setq server-ttys (delq entry server-ttys))
231 232 233 234 235
	  (delete-process (car client))
	  (when (assq proc server-clients)
	    ;; This seems to be necessary to handle
	    ;; `emacsclient -t -e '(delete-frame)'' correctly.
	    (setq server-clients (delq client server-clients))))))))
236

237 238 239 240 241 242 243 244 245 246 247 248 249 250
(defun server-handle-delete-frame (frame)
  "Delete the client connection when the emacsclient frame is deleted."
  (dolist (entry server-frames)
    (let ((proc (nth 0 entry))
	  (f (nth 1 entry)))
      (when (equal frame f)
	(let ((client (assq proc server-clients)))
	  (setq server-frames (delq entry server-frames))
	  (delete-process (car client))
	  (when (assq proc server-clients)
	    ;; This seems to be necessary to handle
	    ;; `emacsclient -t -e '(delete-frame)'' correctly.
	    (setq server-clients (delq client server-clients))))))))

251 252 253 254 255 256 257 258 259 260 261
(defun server-select-display (display)
  ;; If the current frame is on `display' we're all set.
  (unless (equal (frame-parameter (selected-frame) 'display) display)
    ;; Otherwise, look for an existing frame there and select it.
    (dolist (frame (frame-list))
      (when (equal (frame-parameter frame 'display) display)
	(select-frame frame)))
    ;; If there's no frame on that display yet, create a dummy one
    ;; and select it.
    (unless (equal (frame-parameter (selected-frame) 'display) display)
      (select-frame
262
       (make-frame-on-display display)))))
263 264 265 266 267
	;; This frame is only there in place of an actual "current display"
	;; setting, so we want it to be as unobtrusive as possible.  That's
	;; what the invisibility is for.  The minibuffer setting is so that
	;; we don't end up displaying a buffer in it (which noone would
	;; notice).
268 269
        ;; XXX I have found this behaviour to be surprising and annoying. -- Lorentey
	;; '((visibility . nil) (minibuffer . only)))))))
270

271 272 273 274 275 276 277 278 279
(defun server-unquote-arg (arg)
  (replace-regexp-in-string
   "&." (lambda (s)
	  (case (aref s 1)
	    (?& "&")
	    (?- "-")
	    (?n "\n")
	    (t " ")))
   arg t t))
root's avatar
root committed
280

281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
(defun server-ensure-safe-dir (dir)
  "Make sure DIR is a directory with no race-condition issues.
Creates the directory if necessary and makes sure:
- there's no symlink involved
- it's owned by us
- it's not readable/writable by anybody else."
  (setq dir (directory-file-name dir))
  (let ((attrs (file-attributes dir)))
    (unless attrs
      (letf (((default-file-modes) ?\700)) (make-directory dir))
      (setq attrs (file-attributes dir)))
    ;; Check that it's safe for use.
    (unless (and (eq t (car attrs)) (eq (nth 2 attrs) (user-uid))
		 (zerop (logand ?\077 (file-modes dir))))
      (error "The directory %s is unsafe" dir))))

Roland McGrath's avatar
Roland McGrath committed
297
;;;###autoload
root's avatar
root committed
298 299 300 301
(defun server-start (&optional leave-dead)
  "Allow this Emacs process to be a server for client processes.
This starts a server communications subprocess through which
client \"editors\" can send your editing commands to this Emacs job.
Richard M. Stallman's avatar
Richard M. Stallman committed
302
To use the server, set up the program `emacsclient' in the
root's avatar
root committed
303 304 305 306
Emacs distribution as your standard \"editor\".

Prefix arg means just kill any existing server communications subprocess."
  (interactive "P")
307 308
  ;; Make sure there is a safe directory in which to place the socket.
  (server-ensure-safe-dir (file-name-directory server-socket-name))
root's avatar
root committed
309
  ;; kill it dead!
310 311
  (if server-process
      (condition-case () (delete-process server-process) (error nil)))
312
  ;; Delete the socket files made by previous server invocations.
313
  (condition-case () (delete-file server-socket-name) (error nil))
314
  ;; If this Emacs already had a server, clear out associated status.
root's avatar
root committed
315 316 317
  (while server-clients
    (let ((buffer (nth 1 (car server-clients))))
      (server-buffer-done buffer)))
318
  ;; Delete any remaining opened frames of the previous server.
319 320 321 322
  (while server-ttys
    (let ((tty (cadar server-ttys)))
      (setq server-ttys (cdr server-ttys))
      (when (server-tty-live-p tty) (delete-tty tty))))
323
  (unless leave-dead
root's avatar
root committed
324 325
    (if server-process
	(server-log (message "Restarting server")))
Stefan Monnier's avatar
Stefan Monnier committed
326
    (letf (((default-file-modes) ?\700))
327
      (add-to-list 'delete-tty-after-functions 'server-handle-delete-tty)
328
      (add-to-list 'delete-frame-functions 'server-handle-delete-frame)
Stefan Monnier's avatar
Stefan Monnier committed
329 330 331 332 333 334 335 336 337
      (setq server-process
	    (make-network-process
	     :name "server" :family 'local :server t :noquery t
	     :service server-socket-name
	     :sentinel 'server-sentinel :filter 'server-process-filter
	     ;; We must receive file names without being decoded.
	     ;; Those are decoded by server-process-filter according
	     ;; to file-name-coding-system.
	     :coding 'raw-text)))))
Dave Love's avatar
Dave Love committed
338 339 340 341 342 343 344 345 346 347 348 349 350

;;;###autoload
(define-minor-mode server-mode
  "Toggle Server mode.
With ARG, turn Server mode on if ARG is positive, off otherwise.
Server mode runs a process that accepts commands from the
`emacsclient' program.  See `server-start' and Info node `Emacs server'."
  :global t
  :group 'server
  :version "21.4"
  ;; Fixme: Should this check for an existing server socket and do
  ;; nothing if there is one (for multiple Emacs sessions)?
  (server-start (not server-mode)))
root's avatar
root committed
351 352

(defun server-process-filter (proc string)
Dave Love's avatar
Dave Love committed
353 354
  "Process a request from the server to edit some files.
PROC is the server process.  Format of STRING is \"PATH PATH PATH... \\n\"."
355
  (server-log string proc)
356 357 358 359
  (let ((prev (process-get proc 'previous-string)))
    (when prev
      (setq string (concat prev string))
      (process-put proc 'previous-string nil)))
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
  (condition-case err
      ;; If the input is multiple lines,
      ;; process each line individually.
      (while (string-match "\n" string)
	(let ((request (substring string 0 (match-beginning 0)))
	      (coding-system (and default-enable-multibyte-characters
				  (or file-name-coding-system
				      default-file-name-coding-system)))
	      client nowait eval newframe display version-checked
	      registered	; t if the client is already added to server-clients.
	      (files nil)
	      (lineno 1)
	      (columnno 0))
	  ;; Remove this line from STRING.
	  (setq string (substring string (match-end 0)))
	  (setq client (cons proc nil))
	  (while (string-match "[^ ]* " request)
	    (let ((arg (substring request (match-beginning 0) (1- (match-end 0)))))
378
	      (setq request (substring request (match-end 0)))
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
	      (cond
	       ;; Check version numbers.
	       ((and (equal "-version" arg) (string-match "\\([0-9.]+\\) " request))
		(let* ((client-version (match-string 1 request))
		       (truncated-emacs-version (substring emacs-version 0 (length client-version))))
		  (setq request (substring request (match-end 0)))
		  (if (equal client-version truncated-emacs-version)
		      (progn
			(process-send-string proc "-good-version \n")
			(setq version-checked t))
		    (error (concat "Version mismatch: Emacs is " truncated-emacs-version ", emacsclient is " client-version)))))

	       ((equal "-nowait" arg) (setq nowait t))
	       ((equal "-eval" arg) (setq eval t))

	       ((and (equal "-display" arg) (string-match "\\([^ ]*\\) " request))
		(setq display (match-string 1 request)
		      request (substring request (match-end 0))))

	       ;; Open a new X frame.
	       ((equal "-window-system" arg)
		(unless version-checked
		  (error "Protocol error; make sure to use the correct version of emacsclient"))
		(let ((frame (make-frame-on-display
			      (or display
				  (frame-parameter nil 'display)
				  (getenv "DISPLAY")
				  (error "Please specify display")))))
		  (push (list proc frame) server-frames)
		  (select-frame frame)
		  ;; This makes sure that `emacsclient -w -e '(delete-frame)'' works right.
		  (push client server-clients)
		  (setq registered t
			newframe t)))

	       ;; Open a new tty frame at the client.  ARG is the name of the pseudo tty.
	       ((and (equal "-tty" arg) (string-match "\\([^ ]*\\) \\([^ ]*\\) " request))
		(let ((tty (server-unquote-arg (match-string 1 request)))
		      (type (server-unquote-arg (match-string 2 request))))
		  (setq request (substring request (match-end 0)))
		  (unless version-checked
		    (error "Protocol error; make sure to use the correct version of emacsclient"))
		  (let ((frame (make-frame-on-tty tty type)))
		    (push (list (car client) (frame-tty-name frame)) server-ttys)
		    (process-send-string proc (concat "-emacs-pid " (number-to-string (emacs-pid)) "\n"))
		    (select-frame frame)
		    ;; This makes sure that `emacsclient -t -e '(delete-frame)'' works right.
		    (push client server-clients)
		    (setq registered t
			  newframe t))))

	       ;; ARG is a line number option.
	       ((string-match "\\`\\+[0-9]+\\'" arg)
		(setq lineno (string-to-int (substring arg 1))))

	       ;; ARG is line number:column option.
	       ((string-match "\\`\\+\\([0-9]+\\):\\([0-9]+\\)\\'" arg)
		(setq lineno (string-to-int (match-string 1 arg))
		      columnno (string-to-int (match-string 2 arg))))

	       ;; ARG is a filename or a Lisp expression.
	       (t
		;; Undo the quoting that emacsclient does
		;; for certain special characters.
		(setq arg (server-unquote-arg arg))
		;; Now decode the file name if necessary.
		(if coding-system
		    (setq arg (decode-coding-string arg coding-system)))
		(unless version-checked
		  (error "Protocol error; make sure to use the correct version of emacsclient"))
		(if eval
		    ;; ARG is a Lisp expression.
		    (let ((v (eval (car (read-from-string arg)))))
		      (when (and (not newframe) v)
			(with-temp-buffer
			  (let ((standard-output (current-buffer)))
			    (pp v)
			    (process-send-string proc "-print ")
			    (process-send-region proc (point-min) (point-max))))))
		  ;; ARG is a file name.
		  ;; Collapse multiple slashes to single slashes.
		  (setq arg (command-line-normalize-file-name arg))
		  (push (list arg lineno columnno) files))
		(setq lineno 1)
		(setq columnno 0)))))

	  (if (not version-checked)
	      (error "Protocol error; make sure to use the correct version of emacsclient")
	    (when files
	      (run-hooks 'pre-command-hook)
	      (server-visit-files files client nowait)
	      (run-hooks 'post-command-hook))
	    ;; CLIENT is now a list (CLIENTNUM BUFFERS...)
	    (if (and (not newframe) (null (cdr client)))
		;; This client is empty; get rid of it immediately.
		(progn
		  (delete-process proc)
		  (server-log "Close empty client" proc))
	      ;; We visited some buffer for this client.
	      (or nowait registered (push client server-clients))
	      (unless (or isearch-mode (minibufferp))
		(if (and newframe (null (cdr client)))
		    (message (substitute-command-keys
			      "When done with this frame, type \\[delete-frame]"))
		  (server-switch-buffer (nth 1 client))
		  (run-hooks 'server-switch-hook)
		  (unless nowait
		    (message (substitute-command-keys
			      "When done with a buffer, type \\[server-edit]"))))))))
	;; Save for later any partial line that remains.
	(when (> (length string) 0)
	  (process-put proc 'previous-string string)))
    ;; condition-case
    (error (ignore-errors
	     (process-send-string
	      proc (concat "-error " (error-message-string err)))
	     (setq string "")
	     (server-log (error-message-string err) proc)
	     (delete-process proc)))))
root's avatar
root committed
498

499 500 501 502 503 504
(defun server-goto-line-column (file-line-col)
  (goto-line (nth 1 file-line-col))
  (let ((column-number (nth 2 file-line-col)))
    (if (> column-number 0)
	(move-to-column (1- column-number)))))

505
(defun server-visit-files (files client &optional nowait)
506
  "Find FILES and return the list CLIENT with the buffers nconc'd.
507
FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
508 509
NOWAIT non-nil means this client is not waiting for the results,
so don't mark these buffers specially, just visit them normally."
510
  ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
511
  (let ((last-nonmenu-event t) client-record)
512 513 514
    ;; Restore the current buffer afterward, but not using save-excursion,
    ;; because we don't want to save point in this buffer
    ;; if it happens to be one of those specified by the server.
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
    (save-current-buffer
      (dolist (file files)
	;; If there is an existing buffer modified or the file is
	;; modified, revert it.  If there is an existing buffer with
	;; deleted file, offer to write it.
	(let* ((filen (car file))
	       (obuf (get-file-buffer filen)))
	  (push filen file-name-history)
	  (if (and obuf (set-buffer obuf))
	      (progn
		(cond ((file-exists-p filen)
		       (if (not (verify-visited-file-modtime obuf))
			   (revert-buffer t nil)))
		      (t
		       (if (y-or-n-p
			    (concat "File no longer exists: "
				    filen
				    ", write buffer to file? "))
			   (write-file filen))))
		(setq server-existing-buffer t)
		(server-goto-line-column file))
	    (set-buffer (find-file-noselect filen))
	    (server-goto-line-column file)
	    (run-hooks 'server-visit-hook)))
	(unless nowait
	  ;; When the buffer is killed, inform the clients.
	  (add-hook 'kill-buffer-hook 'server-kill-buffer nil t)
	  (push (car client) server-buffer-clients))
	(push (current-buffer) client-record)))
root's avatar
root committed
544 545
    (nconc client client-record)))

546
(defun server-buffer-done (buffer &optional for-killing)
root's avatar
root committed
547
  "Mark BUFFER as \"done\" for its client(s).
548 549
This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED).
NEXT-BUFFER is another server buffer, as a suggestion for what to select next,
550 551 552
or nil.  KILLED is t if we killed BUFFER (typically, because it was visiting
a temp file).
FOR-KILLING if non-nil indicates that we are called from `kill-buffer'."
553
  (let ((next-buffer nil)
554
	(killed nil)
root's avatar
root committed
555 556 557
	(old-clients server-clients))
    (while old-clients
      (let ((client (car old-clients)))
558
	(or next-buffer
root's avatar
root committed
559 560
	    (setq next-buffer (nth 1 (memq buffer client))))
	(delq buffer client)
561 562 563 564 565 566 567
	;; Delete all dead buffers from CLIENT.
	(let ((tail client))
	  (while tail
	    (and (bufferp (car tail))
		 (null (buffer-name (car tail)))
		 (delq (car tail) client))
	    (setq tail (cdr tail))))
root's avatar
root committed
568 569
	;; If client now has no pending buffers,
	;; tell it that it is done, and forget it entirely.
570
	(unless (cdr client)
571 572 573 574 575 576 577 578 579 580 581
	  (let ((tty (cadr (assq (car client) server-ttys)))
		(frame (cadr (assq (car client) server-frames))))
	    (cond
	     ;; Be careful, if we delete the process before the
	     ;; tty, then the terminal modes will not be restored
	     ;; correctly.
	     (tty (delete-tty tty))
	     (frame (delete-frame frame))
	     (t (delete-process (car client))
		(server-log "Close" (car client))
		(setq server-clients (delq client server-clients)))))))
root's avatar
root committed
582
      (setq old-clients (cdr old-clients)))
583
    (if (and (bufferp buffer) (buffer-name buffer))
584 585 586 587
	;; We may or may not kill this buffer;
	;; if we do, do not call server-buffer-done recursively
	;; from kill-buffer-hook.
	(let ((server-kill-buffer-running t))
588
	  (with-current-buffer buffer
589 590
	    (setq server-buffer-clients nil)
	    (run-hooks 'server-done-hook))
591 592 593 594 595 596
	  ;; Notice whether server-done-hook killed the buffer.
	  (if (null (buffer-name buffer))
	      (setq killed t)
	    ;; Don't bother killing or burying the buffer
	    ;; when we are called from kill-buffer.
	    (unless for-killing
597 598
	      (when (and (not killed)
			 server-kill-new-buffers
599 600
			 (with-current-buffer buffer
			   (not server-existing-buffer)))
601
		(setq killed t)
602
		(bury-buffer buffer)
603 604 605 606 607 608 609
		(kill-buffer buffer))
	      (unless killed
		(if (server-temp-file-p buffer)
		    (progn
		      (kill-buffer buffer)
		      (setq killed t))
		  (bury-buffer buffer)))))))
610
    (list next-buffer killed)))
root's avatar
root committed
611

612
(defun server-temp-file-p (&optional buffer)
root's avatar
root committed
613 614 615 616 617 618 619 620 621 622
  "Return non-nil if BUFFER contains a file considered temporary.
These are files whose names suggest they are repeatedly
reused to pass information to another program.

The variable `server-temp-file-regexp' controls which filenames
are considered temporary."
  (and (buffer-file-name buffer)
       (string-match server-temp-file-regexp (buffer-file-name buffer))))

(defun server-done ()
Christopher Zaborsky's avatar
Christopher Zaborsky committed
623
  "Offer to save current buffer, mark it as \"done\" for clients.
624 625 626 627 628
This kills or buries the buffer, then returns a list
of the form (NEXT-BUFFER KILLED).  NEXT-BUFFER is another server buffer,
as a suggestion for what to select next, or nil.
KILLED is t if we killed BUFFER, which happens if it was created
specifically for the clients and did not exist before their request for it."
629 630 631 632 633 634 635 636 637 638 639 640
  (when server-buffer-clients
    (if (server-temp-file-p)
	;; For a temp file, save, and do make a non-numeric backup
	;; (unless make-backup-files is nil).
	(let ((version-control nil)
	      (buffer-backed-up nil))
	  (save-buffer))
      (if (and (buffer-modified-p)
	       buffer-file-name
	       (y-or-n-p (concat "Save file " buffer-file-name "? ")))
	  (save-buffer)))
    (server-buffer-done (current-buffer))))
641

Richard M. Stallman's avatar
Richard M. Stallman committed
642 643 644 645
;; Ask before killing a server buffer.
;; It was suggested to release its client instead,
;; but I think that is dangerous--the client would proceed
;; using whatever is on disk in that file. -- rms.
646 647
(defun server-kill-buffer-query-function ()
  (or (not server-buffer-clients)
648 649 650 651 652
      (let ((res t))
	(dolist (proc server-buffer-clients res)
	  (setq proc (assq proc server-clients))
	  (when (and proc (eq (process-status (car proc)) 'open))
	    (setq res nil))))
653 654 655
      (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
			   (buffer-name (current-buffer))))))

656
(add-hook 'kill-buffer-query-functions
657 658 659
 	  'server-kill-buffer-query-function)

(defun server-kill-emacs-query-function ()
660 661 662 663 664 665 666 667 668
  (let (live-client
	(tail server-clients))
    ;; See if any clients have any buffers that are still alive.
    (while tail
      (if (memq t (mapcar 'stringp (mapcar 'buffer-name (cdr (car tail)))))
	  (setq live-client t))
      (setq tail (cdr tail)))
    (or (not live-client)
	(yes-or-no-p "Server buffers still have clients; exit anyway? "))))
669 670

(add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
671

672
(defvar server-kill-buffer-running nil
673
  "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
674

675
(defun server-kill-buffer ()
676 677 678
  ;; Prevent infinite recursion if user has made server-done-hook
  ;; call kill-buffer.
  (or server-kill-buffer-running
679 680 681 682
      (and server-buffer-clients
	   (let ((server-kill-buffer-running t))
	     (when server-process
	       (server-buffer-done (current-buffer) t))))))
root's avatar
root committed
683 684 685 686

(defun server-edit (&optional arg)
  "Switch to next server editing buffer; say \"Done\" for current buffer.
If a server buffer is current, it is marked \"done\" and optionally saved.
687
The buffer is also killed if it did not exist before the clients asked for it.
root's avatar
root committed
688 689 690
When all of a client's buffers are marked as \"done\", the client is notified.

Temporary files such as MH <draft> files are always saved and backed up,
691 692 693
no questions asked.  (The variable `make-backup-files', if nil, still
inhibits a backup; you can set it locally in a particular buffer to
prevent a backup for it.)  The variable `server-temp-file-regexp' controls
root's avatar
root committed
694 695
which filenames are considered temporary.

696
If invoked with a prefix argument, or if there is no server process running,
root's avatar
root committed
697 698 699 700 701 702
starts server process and that is all.  Invoked by \\[server-edit]."
  (interactive "P")
  (if (or arg
	  (not server-process)
	  (memq (process-status server-process) '(signal exit)))
      (server-start nil)
703
    (apply 'server-switch-buffer (server-done))))
root's avatar
root committed
704

705
(defun server-switch-buffer (&optional next-buffer killed-one)
root's avatar
root committed
706 707
  "Switch to another buffer, preferably one that has a client.
Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
708 709 710 711
  ;; KILLED-ONE is t in a recursive call
  ;; if we have already killed one temp-file server buffer.
  ;; This means we should avoid the final "switch to some other buffer"
  ;; since we've already effectively done that.
712 713
  (if (null next-buffer)
      (if server-clients
714 715
	  (let ((buffer (nth 1 (car server-clients))))
	    (and buffer (server-switch-buffer buffer killed-one)))
716
	(unless (or killed-one (window-dedicated-p (selected-window)))
717 718
	  (switch-to-buffer (other-buffer))
	  (message "No server buffers remain to edit")))
719 720
    (if (not (buffer-name next-buffer))
	;; If NEXT-BUFFER is a dead buffer, remove the server records for it
root's avatar
root committed
721
	;; and try the next surviving server buffer.
722 723
	(apply 'server-switch-buffer (server-buffer-done next-buffer))
      ;; OK, we know next-buffer is live, let's display and select it.
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
      (if (functionp server-window)
	  (funcall server-window next-buffer)
	(let ((win (get-buffer-window next-buffer 0)))
	  (if (and win (not server-window))
	      ;; The buffer is already displayed: just reuse the window.
	      (let ((frame (window-frame win)))
		(if (eq (frame-visible-p frame) 'icon)
		    (raise-frame frame))
		(select-window win)
		(set-buffer next-buffer))
	    ;; Otherwise, let's find an appropriate window.
	    (cond ((and (windowp server-window)
			(window-live-p server-window))
		   (select-window server-window))
		  ((framep server-window)
		   (if (not (frame-live-p server-window))
		       (setq server-window (make-frame)))
		   (select-window (frame-selected-window server-window))))
	    (if (window-minibuffer-p (selected-window))
		(select-window (next-window nil 'nomini 0)))
	    ;; Move to a non-dedicated window, if we have one.
	    (when (window-dedicated-p (selected-window))
	      (select-window
	       (get-window-with-predicate
		(lambda (w)
		  (and (not (window-dedicated-p w))
		       (equal (frame-parameter (window-frame w) 'display)
			      (frame-parameter (selected-frame) 'display))))
		'nomini 'visible (selected-window))))
	    (condition-case nil
		(switch-to-buffer next-buffer)
	      ;; After all the above, we might still have ended up with
	      ;; a minibuffer/dedicated-window (if there's no other).
	      (error (pop-to-buffer next-buffer)))))))))
root's avatar
root committed
758 759

(global-set-key "\C-x#" 'server-edit)
760 761

(defun server-unload-hook ()
Dave Love's avatar
Dave Love committed
762
  (server-start t)
763 764 765
  (remove-hook 'kill-buffer-query-functions 'server-kill-buffer-query-function)
  (remove-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
  (remove-hook 'kill-buffer-hook 'server-kill-buffer))
Roland McGrath's avatar
Roland McGrath committed
766 767

(provide 'server)
Eric S. Raymond's avatar
Eric S. Raymond committed
768

Miles Bader's avatar
Miles Bader committed
769
;;; arch-tag: 1f7ecb42-f00a-49f8-906d-61995d84c8d6
Eric S. Raymond's avatar
Eric S. Raymond committed
770
;;; server.el ends here