server.el 22.9 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, 2001
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 47 48 49 50
;; When you finish editing a Server buffer, again call server-edit
;; 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 
;; and exited with server-edit, the client "editor" will return
;; 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

Erik Naggum's avatar
Erik Naggum committed
72 73 74 75
;; The buffer local variable "server-buffer-clients" lists 
;; the clients who are waiting for this buffer to be edited.  
;; 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

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

103
(defvar server-previous-strings nil)
104

root's avatar
root committed
105 106
(defvar server-clients nil
  "List of current server clients.
107
Each element is (CLIENTID BUFFERS...) where CLIENTID is a string
root's avatar
root committed
108 109 110 111
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.")

(defvar server-buffer-clients nil
112
  "List of client ids for clients requesting editing of current buffer.")
113
(make-variable-buffer-local 'server-buffer-clients)
root's avatar
root committed
114 115 116
;; Changing major modes should not erase this local.
(put 'server-buffer-clients 'permanent-local t)

117 118 119
(defvar server-window nil
  "*The window to use for selecting Emacs server buffers.
If nil, use the selected window.
120 121 122
If it is a frame, use the frame's selected window.
If it is a function, it should take one argument (a buffer) and
display and select it.  A common value is `pop-to-buffer'.")
123

Richard M. Stallman's avatar
Richard M. Stallman committed
124
(defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
root's avatar
root committed
125 126
  "*Regexp which should match filenames of temporary files
which are deleted and reused after each edit
127
by the programs that invoke the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
128 129
  :group 'server
  :type 'regexp)
root's avatar
root committed
130

131 132 133 134 135 136 137 138 139 140 141 142
(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
it with Emacs server. If nil, kill only buffers as specified by
`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
143 144 145
(or (assq 'server-buffer-clients minor-mode-alist)
    (setq minor-mode-alist (cons '(server-buffer-clients " Server") minor-mode-alist)))

146
(defvar server-existing-buffer nil
147
  "Non-nil means the buffer existed before the server was asked to visit it.
148
This means that the server should not kill the buffer when you say you
149
are done with it in the server.")
150 151
(make-variable-buffer-local 'server-existing-buffer)

152
(defvar server-socket-name
153 154
  (format "/tmp/esrv%d-%s" (user-uid)
	  (substring (system-name) 0 (string-match "\\." (system-name)))))
155

root's avatar
root committed
156 157
;; If a *server* buffer exists,
;; write STRING to it for logging purposes.
158
(defun server-log (string &optional client)
root's avatar
root committed
159
  (if (get-buffer "*server*")
160
      (with-current-buffer "*server*"
root's avatar
root committed
161
	(goto-char (point-max))
162
	(insert (current-time-string)
163
		(if client (format " %s:" client) " ")
164
		string)
165
	(or (bolp) (newline)))))
root's avatar
root committed
166 167

(defun server-sentinel (proc msg)
168 169 170
  ;; Purge server-previous-strings of the now irrelevant entry.
  (setq server-previous-strings
	(delq (assq proc server-previous-strings) server-previous-strings))
171
  (let ((client (assq proc server-clients)))
172
    ;; Remove PROC from the list of clients.
173 174 175 176 177 178 179 180 181 182 183 184
    (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)))
	    (kill-buffer (current-buffer)))))))
185 186
  (server-log (format "Status changed to %s" (process-status proc)) proc))

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
(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
       (make-frame-on-display
	display
	;; 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).
	'((visibility . nil) (minibuffer . only)))))))

207 208 209 210 211 212 213 214 215
(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
216

Roland McGrath's avatar
Roland McGrath committed
217
;;;###autoload
root's avatar
root committed
218 219 220 221
(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
222
To use the server, set up the program `emacsclient' in the
root's avatar
root committed
223 224 225 226 227
Emacs distribution as your standard \"editor\".

Prefix arg means just kill any existing server communications subprocess."
  (interactive "P")
  ;; kill it dead!
228
  (condition-case () (delete-process server-process) (error nil))
229
  ;; Delete the socket files made by previous server invocations.
230
  (condition-case () (delete-file server-socket-name) (error nil))
231
  ;; If this Emacs already had a server, clear out associated status.
root's avatar
root committed
232 233 234
  (while server-clients
    (let ((buffer (nth 1 (car server-clients))))
      (server-buffer-done buffer)))
235
  (unless leave-dead
root's avatar
root committed
236 237
    (if server-process
	(server-log (message "Restarting server")))
238 239 240 241 242 243 244 245 246 247 248 249 250 251
    (let ((umask (default-file-modes)))
      (unwind-protect
	  (progn
	    (set-default-file-modes ?\700)
	    (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)))
	(set-default-file-modes umask)))))
root's avatar
root committed
252 253

;Process a request from the server to edit some files.
254
;Format of STRING is "PATH PATH PATH... \n"
root's avatar
root committed
255
(defun server-process-filter (proc string)
256 257 258 259 260
  (server-log string proc)
  (let ((ps (assq proc server-previous-strings)))
    (when (cdr ps)
      (setq string (concat (cdr ps) string))
      (setcdr ps nil)))
261 262 263 264
  ;; If the input is multiple lines,
  ;; process each line individually.
  (while (string-match "\n" string)
    (let ((request (substring string 0 (match-beginning 0)))
265 266 267
	  (coding-system (and default-enable-multibyte-characters
			      (or file-name-coding-system
				  default-file-name-coding-system)))
268
	  client nowait eval
root's avatar
root committed
269
	  (files nil)
270 271
	  (lineno 1)
	  (columnno 0))
272
      ;; Remove this line from STRING.
273 274 275 276 277 278 279 280
      (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))))
	      (pos 0))
	  (setq request (substring request (match-end 0)))
	  (cond
	   ((equal "-nowait" arg) (setq nowait t))
281 282
;;; This is not safe unless we make sure other users can't send commands.
;;;	   ((equal "-eval" arg) (setq eval t))
283 284 285 286 287 288 289
	   ((and (equal "-display" arg) (string-match "\\([^ ]*\\) " request))
	    (let ((display (server-unquote-arg (match-string 1 request))))
	      (setq request (substring request (match-end 0)))
	      (condition-case err
		  (server-select-display display)
		(error (process-send-string proc (nth 1 err))
		       (setq request "")))))
290 291 292 293 294 295 296 297 298 299 300 301 302 303
	   ;; 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))))
	   (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)))
304 305 306 307 308 309 310 311 312 313 314
	    (if eval
		(let ((v (eval (car (read-from-string arg)))))
		  (when v
		    (with-temp-buffer
		      (let ((standard-output (current-buffer)))
			(pp v)
			(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))
315 316 317 318 319 320 321 322 323 324 325 326 327 328
	    (setq lineno 1)
	    (setq columnno 0)))))
      (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 (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 (push client server-clients))
329 330 331 332 333 334
	(unless (or isearch-mode (minibuffer-active))
	  (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]")))))))
335
  ;; Save for later any partial line that remains.
336 337 338 339
  (when (> (length string) 0)
    (let ((ps (assq proc server-previous-strings)))
      (if ps (setcdr ps string)
	(push (cons proc string) server-previous-strings)))))
root's avatar
root committed
340

341 342 343 344 345 346
(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)))))

347
(defun server-visit-files (files client &optional nowait)
348
  "Find FILES and return the list CLIENT with the buffers nconc'd.
349
FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
350 351
NOWAIT non-nil means this client is not waiting for the results,
so don't mark these buffers specially, just visit them normally."
352
  ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
353
  (let ((last-nonmenu-event t) client-record)
354 355 356
    ;; 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.
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
    (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
386 387
    (nconc client client-record)))

388
(defun server-buffer-done (buffer &optional for-killing)
root's avatar
root committed
389
  "Mark BUFFER as \"done\" for its client(s).
390 391
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,
392 393 394
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'."
395
  (let ((next-buffer nil)
396
	(killed nil)
root's avatar
root committed
397 398 399
	(old-clients server-clients))
    (while old-clients
      (let ((client (car old-clients)))
400
	(or next-buffer
root's avatar
root committed
401 402
	    (setq next-buffer (nth 1 (memq buffer client))))
	(delq buffer client)
403 404 405 406 407 408 409
	;; 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
410 411
	;; If client now has no pending buffers,
	;; tell it that it is done, and forget it entirely.
412 413 414
	(unless (cdr client)
	  (delete-process (car client))
	  (server-log "Close" (car client))
root's avatar
root committed
415 416
	  (setq server-clients (delq client server-clients))))
      (setq old-clients (cdr old-clients)))
417
    (if (and (bufferp buffer) (buffer-name buffer))
418 419 420 421
	;; 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))
422
	  (with-current-buffer buffer
423 424
	    (setq server-buffer-clients nil)
	    (run-hooks 'server-done-hook))
425 426 427 428 429 430
	  ;; 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
431 432
	      (when (and (not killed)
			 server-kill-new-buffers
433 434
			 (with-current-buffer buffer
			   (not server-existing-buffer)))
435
		(setq killed t)
436
		(bury-buffer buffer)
437 438 439 440 441 442 443
		(kill-buffer buffer))
	      (unless killed
		(if (server-temp-file-p buffer)
		    (progn
		      (kill-buffer buffer)
		      (setq killed t))
		  (bury-buffer buffer)))))))
444
    (list next-buffer killed)))
root's avatar
root committed
445

446
(defun server-temp-file-p (&optional buffer)
root's avatar
root committed
447 448 449 450 451 452 453 454 455 456
  "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
457
  "Offer to save current buffer, mark it as \"done\" for clients.
458 459 460 461 462
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."
463 464 465 466 467 468 469 470 471 472 473 474
  (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))))
475

Richard M. Stallman's avatar
Richard M. Stallman committed
476 477 478 479
;; 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.
480 481 482 483 484
(defun server-kill-buffer-query-function ()
  (or (not server-buffer-clients)
      (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
			   (buffer-name (current-buffer))))))

485
(add-hook 'kill-buffer-query-functions
486 487 488
 	  'server-kill-buffer-query-function)

(defun server-kill-emacs-query-function ()
489 490 491 492 493 494 495 496 497
  (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? "))))
498 499

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

501
(defvar server-kill-buffer-running nil
502
  "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
503

504
(defun server-kill-buffer ()
505 506 507
  ;; Prevent infinite recursion if user has made server-done-hook
  ;; call kill-buffer.
  (or server-kill-buffer-running
508 509 510 511
      (and server-buffer-clients
	   (let ((server-kill-buffer-running t))
	     (when server-process
	       (server-buffer-done (current-buffer) t))))))
root's avatar
root committed
512 513 514 515

(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.
516
The buffer is also killed if it did not exist before the clients asked for it.
root's avatar
root committed
517 518 519
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,
520 521 522
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
523 524 525 526 527 528 529 530 531
which filenames are considered temporary.

If invoked with a prefix argument, or if there is no server process running, 
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)
532
    (apply 'server-switch-buffer (server-done))))
root's avatar
root committed
533

534
(defun server-switch-buffer (&optional next-buffer killed-one)
root's avatar
root committed
535 536
  "Switch to another buffer, preferably one that has a client.
Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
537 538 539 540
  ;; 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.
541 542 543
  (if (null next-buffer)
      (if server-clients
	  (server-switch-buffer (nth 1 (car server-clients)) killed-one)
544
	(unless (or killed-one (window-dedicated-p (selected-window)))
545 546
	  (switch-to-buffer (other-buffer))
	  (message "No server buffers remain to edit")))
547 548
    (if (not (buffer-name next-buffer))
	;; If NEXT-BUFFER is a dead buffer, remove the server records for it
root's avatar
root committed
549
	;; and try the next surviving server buffer.
550 551
	(apply 'server-switch-buffer (server-buffer-done next-buffer))
      ;; OK, we know next-buffer is live, let's display and select it.
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
      (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
586 587

(global-set-key "\C-x#" 'server-edit)
588 589 590 591 592

(defun server-unload-hook ()
  (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
593 594

(provide 'server)
Eric S. Raymond's avatar
Eric S. Raymond committed
595 596

;;; server.el ends here