server.el 25.7 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,2003
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.")

Karoly Lorentey's avatar
Karoly Lorentey committed
109 110 111 112 113 114 115
(defvar server-frames nil
  "List of current server frames.
Each element is (CLIENTID FRAME) where CLIENTID is a string
that can be given to the server process to identify a client.
When all the buffers of the client are marked as \"done\", 
the frame is deleted.")

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

Dave Love's avatar
Dave Love committed
122 123
(defcustom server-window nil
  "*Specification of the window to use for selecting Emacs server buffers.
124
If nil, use the selected window.
125
If it is a function, it should take one argument (a buffer) and
Dave Love's avatar
Dave Love committed
126 127 128 129 130 131 132 133 134 135 136 137 138 139
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")))
140

Richard M. Stallman's avatar
Richard M. Stallman committed
141
(defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
Dave Love's avatar
Dave Love committed
142 143 144
  "*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
145 146
  :group 'server
  :type 'regexp)
root's avatar
root committed
147

148 149 150
(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
151
it with Emacs server.  If nil, kill only buffers as specified by
152 153 154 155 156 157 158 159
`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
160 161 162
(or (assq 'server-buffer-clients minor-mode-alist)
    (setq minor-mode-alist (cons '(server-buffer-clients " Server") minor-mode-alist)))

163
(defvar server-existing-buffer nil
164
  "Non-nil means the buffer existed before the server was asked to visit it.
165
This means that the server should not kill the buffer when you say you
166
are done with it in the server.")
167 168
(make-variable-buffer-local 'server-existing-buffer)

169
(defvar server-socket-name
170
  (format "/tmp/emacs%d-%s/server" (user-uid)
171
	  (substring (system-name) 0 (string-match "\\." (system-name)))))
172

173
(defun server-log (string &optional client)
Dave Love's avatar
Dave Love committed
174
  "If a *server* buffer exists, write STRING to it for logging purposes."
root's avatar
root committed
175
  (if (get-buffer "*server*")
176
      (with-current-buffer "*server*"
root's avatar
root committed
177
	(goto-char (point-max))
178
	(insert (current-time-string)
179
		(if client (format " %s:" client) " ")
180
		string)
181
	(or (bolp) (newline)))))
root's avatar
root committed
182 183

(defun server-sentinel (proc msg)
184
  (let ((client (assq proc server-clients)))
185
    ;; Remove PROC from the list of clients.
186 187
    (when client
      (setq server-clients (delq client server-clients))
188 189 190
      (let ((frame (assq (car client) server-frames)))
	(setq server-frames (delq frame server-frames))
	(when (frame-live-p (cadr frame)) (delete-frame (cadr frame))))
191 192 193 194 195 196 197 198 199 200
      (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)))))))
201 202
  (server-log (format "Status changed to %s" (process-status proc)) proc))

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
(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)))))))

223 224 225 226 227 228 229 230 231
(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
232

233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
(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
249
;;;###autoload
root's avatar
root committed
250 251 252 253
(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
254
To use the server, set up the program `emacsclient' in the
root's avatar
root committed
255 256 257 258
Emacs distribution as your standard \"editor\".

Prefix arg means just kill any existing server communications subprocess."
  (interactive "P")
259 260
  ;; 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
261
  ;; kill it dead!
262 263
  (if server-process
      (condition-case () (delete-process server-process) (error nil)))
264
  ;; Delete the socket files made by previous server invocations.
265
  (condition-case () (delete-file server-socket-name) (error nil))
266
  ;; If this Emacs already had a server, clear out associated status.
root's avatar
root committed
267 268 269
  (while server-clients
    (let ((buffer (nth 1 (car server-clients))))
      (server-buffer-done buffer)))
270
  (unless leave-dead
root's avatar
root committed
271 272
    (if server-process
	(server-log (message "Restarting server")))
Stefan Monnier's avatar
Stefan Monnier committed
273 274 275 276 277 278 279 280 281 282
    (letf (((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)))))
Dave Love's avatar
Dave Love committed
283 284 285 286 287 288 289 290 291 292 293 294 295

;;;###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
296 297

(defun server-process-filter (proc string)
Dave Love's avatar
Dave Love committed
298 299
  "Process a request from the server to edit some files.
PROC is the server process.  Format of STRING is \"PATH PATH PATH... \\n\"."
300
  (server-log string proc)
301 302 303 304
  (let ((prev (process-get proc 'previous-string)))
    (when prev
      (setq string (concat prev string))
      (process-put proc 'previous-string nil)))
305 306 307 308
  ;; If the input is multiple lines,
  ;; process each line individually.
  (while (string-match "\n" string)
    (let ((request (substring string 0 (match-beginning 0)))
309 310 311
	  (coding-system (and default-enable-multibyte-characters
			      (or file-name-coding-system
				  default-file-name-coding-system)))
312
	  client nowait eval
root's avatar
root committed
313
	  (files nil)
314 315
	  (lineno 1)
	  (columnno 0))
316
      ;; Remove this line from STRING.
317 318 319
      (setq string (substring string (match-end 0)))
      (setq client (cons proc nil))
      (while (string-match "[^ ]* " request)
320
	(let ((arg (substring request (match-beginning 0) (1- (match-end 0)))))
321 322 323
	  (setq request (substring request (match-end 0)))
	  (cond
	   ((equal "-nowait" arg) (setq nowait t))
324
	   ((equal "-eval" arg) (setq eval t))
325 326 327 328 329 330 331
	   ((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 "")))))
332
	   ;; Open a new frame at the client.  ARG is the name of the pseudo tty.
333 334 335 336 337
	   ((and (equal "-pty" arg) (string-match "\\([^ ]*\\) \\([^ ]*\\) " request))
	    (let ((pty (server-unquote-arg (match-string 1 request)))
		  (type (server-unquote-arg (match-string 2 request))))
	      (setq request (substring request (match-end 0)))
	      (condition-case err
338
		  (let ((frame (make-terminal-frame `((tty . ,pty) (tty-type . ,type)))))
Karoly Lorentey's avatar
Karoly Lorentey committed
339 340
		    (setq server-frames (cons (list (car client) frame) server-frames))
		    (sit-for 0)
341 342
		    (process-send-string proc (concat (number-to-string (emacs-pid)) "\n"))
		    (select-frame frame))
343 344
		(error (process-send-string proc (nth 1 err))
		       (setq request "")))))
345 346 347 348 349 350 351 352 353 354 355 356 357 358
	   ;; 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)))
359
	    (if eval
360 361 362 363 364 365 366 367 368
		(condition-case err
		    (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))))))
		  (error (process-send-string proc (concat "*Error* " (error-message-string err)))))

369 370 371 372
	      ;; 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))
373 374 375 376 377 378 379 380 381 382
	    (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
383 384 385
	    (let ((frame (assq (car client) server-frames)))
	      (setq server-frames (delq frame server-frames))
	      (when (frame-live-p (cadr frame)) (delete-frame (cadr frame))))
386 387 388 389
	    (delete-process proc)
	    (server-log "Close empty client" proc))
	;; We visited some buffer for this client.
	(or nowait (push client server-clients))
390
	(unless (or isearch-mode (minibufferp))
391 392 393 394 395
	  (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]")))))))
396
  ;; Save for later any partial line that remains.
397
  (when (> (length string) 0)
398
    (process-put proc 'previous-string string)))
root's avatar
root committed
399

400 401 402 403 404 405
(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)))))

406
(defun server-visit-files (files client &optional nowait)
407
  "Find FILES and return the list CLIENT with the buffers nconc'd.
408
FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
409 410
NOWAIT non-nil means this client is not waiting for the results,
so don't mark these buffers specially, just visit them normally."
411
  ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
412
  (let ((last-nonmenu-event t) client-record)
413 414 415
    ;; 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.
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
    (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
445 446
    (nconc client client-record)))

447
(defun server-buffer-done (buffer &optional for-killing)
root's avatar
root committed
448
  "Mark BUFFER as \"done\" for its client(s).
449 450
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,
451 452 453
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'."
454
  (let ((next-buffer nil)
455
	(killed nil)
root's avatar
root committed
456 457 458
	(old-clients server-clients))
    (while old-clients
      (let ((client (car old-clients)))
459
	(or next-buffer
root's avatar
root committed
460 461
	    (setq next-buffer (nth 1 (memq buffer client))))
	(delq buffer client)
462 463 464 465 466 467 468
	;; 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
469 470
	;; If client now has no pending buffers,
	;; tell it that it is done, and forget it entirely.
471
	(unless (cdr client)
472 473 474
	  (let ((frame (assq (car client) server-frames)))
	    (setq server-frames (delq frame server-frames))
	    (when (frame-live-p (cadr frame)) (delete-frame (cadr frame))))
475 476
	  (delete-process (car client))
	  (server-log "Close" (car client))
root's avatar
root committed
477 478
	  (setq server-clients (delq client server-clients))))
      (setq old-clients (cdr old-clients)))
479
    (if (and (bufferp buffer) (buffer-name buffer))
480 481 482 483
	;; 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))
484
	  (with-current-buffer buffer
485 486
	    (setq server-buffer-clients nil)
	    (run-hooks 'server-done-hook))
487 488 489 490 491 492
	  ;; 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
493 494
	      (when (and (not killed)
			 server-kill-new-buffers
495 496
			 (with-current-buffer buffer
			   (not server-existing-buffer)))
497
		(setq killed t)
498
		(bury-buffer buffer)
499 500 501 502 503 504 505
		(kill-buffer buffer))
	      (unless killed
		(if (server-temp-file-p buffer)
		    (progn
		      (kill-buffer buffer)
		      (setq killed t))
		  (bury-buffer buffer)))))))
506
    (list next-buffer killed)))
root's avatar
root committed
507

508
(defun server-temp-file-p (&optional buffer)
root's avatar
root committed
509 510 511 512 513 514 515 516 517 518
  "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
519
  "Offer to save current buffer, mark it as \"done\" for clients.
520 521 522 523 524
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."
525 526 527 528 529 530 531 532 533 534 535 536
  (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))))
537

Richard M. Stallman's avatar
Richard M. Stallman committed
538 539 540 541
;; 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.
542 543 544 545 546
(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))))))

547
(add-hook 'kill-buffer-query-functions
548 549 550
 	  'server-kill-buffer-query-function)

(defun server-kill-emacs-query-function ()
551 552 553 554 555 556 557 558 559
  (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? "))))
560 561

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

563
(defvar server-kill-buffer-running nil
564
  "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
565

566
(defun server-kill-buffer ()
567 568 569
  ;; Prevent infinite recursion if user has made server-done-hook
  ;; call kill-buffer.
  (or server-kill-buffer-running
570 571 572 573
      (and server-buffer-clients
	   (let ((server-kill-buffer-running t))
	     (when server-process
	       (server-buffer-done (current-buffer) t))))))
root's avatar
root committed
574 575 576 577

(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.
578
The buffer is also killed if it did not exist before the clients asked for it.
root's avatar
root committed
579 580 581
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,
582 583 584
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
585 586
which filenames are considered temporary.

587
If invoked with a prefix argument, or if there is no server process running,
root's avatar
root committed
588 589 590 591 592 593
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)
594
    (apply 'server-switch-buffer (server-done))))
root's avatar
root committed
595

596
(defun server-switch-buffer (&optional next-buffer killed-one)
root's avatar
root committed
597 598
  "Switch to another buffer, preferably one that has a client.
Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
599 600 601 602
  ;; 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.
603 604 605
  (if (null next-buffer)
      (if server-clients
	  (server-switch-buffer (nth 1 (car server-clients)) killed-one)
606
	(unless (or killed-one (window-dedicated-p (selected-window)))
607 608
	  (switch-to-buffer (other-buffer))
	  (message "No server buffers remain to edit")))
609 610
    (if (not (buffer-name next-buffer))
	;; If NEXT-BUFFER is a dead buffer, remove the server records for it
root's avatar
root committed
611
	;; and try the next surviving server buffer.
612 613
	(apply 'server-switch-buffer (server-buffer-done next-buffer))
      ;; OK, we know next-buffer is live, let's display and select it.
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
      (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
648 649

(global-set-key "\C-x#" 'server-edit)
650 651

(defun server-unload-hook ()
Dave Love's avatar
Dave Love committed
652
  (server-start t)
653 654 655
  (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
656 657

(provide 'server)
Eric S. Raymond's avatar
Eric S. Raymond committed
658

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