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

Richard M. Stallman's avatar
Richard M. Stallman committed
3
;; Copyright (C) 1986, 87, 92, 94, 95, 96, 1997 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

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

root's avatar
root committed
9 10 11 12 13 14
;; 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
15
;; the Free Software Foundation; either version 2, or (at your option)
root's avatar
root committed
16 17 18 19 20 21 22 23
;; 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
24 25 26
;; 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
27

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

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

Erik Naggum's avatar
Erik Naggum committed
33 34 35 36
;; Load this library and do M-x server-edit to enable Emacs as a server.
;; Emacs runs the program ../arch-lib/emacsserver as a subprocess
;; 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
37

Erik Naggum's avatar
Erik Naggum committed
38 39 40 41
;; 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
42

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

Erik Naggum's avatar
Erik Naggum committed
45 46 47 48 49
;; 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
50

Erik Naggum's avatar
Erik Naggum committed
51 52 53 54
;; 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
55

Erik Naggum's avatar
Erik Naggum committed
56 57
;; 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
58

Erik Naggum's avatar
Erik Naggum committed
59 60
;; 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
61

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

Erik Naggum's avatar
Erik Naggum committed
65 66 67 68 69
;; 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
70

Erik Naggum's avatar
Erik Naggum committed
71 72 73 74
;; 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
75 76

;;; Code:
root's avatar
root committed
77

Richard M. Stallman's avatar
Richard M. Stallman committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
(defgroup server nil
  "Emacs running as a server process."
  :group 'external)

(defcustom server-program (expand-file-name "emacsserver" exec-directory)
  "*The program to use as the edit server."
  :group 'server
  :type 'string)

(defcustom server-visit-hook nil
  "*List of hooks to call when visiting a file for the Emacs server."
  :group 'server
  :type '(repeat function))

(defcustom server-switch-hook nil
  "*List of hooks to call when switching to a buffer for the Emacs server."
  :group 'server
  :type '(repeat function))

(defcustom server-done-hook nil
  "*List of hooks to call when done editing a buffer for the Emacs server."
  :group 'server
  :type '(repeat function))
101

root's avatar
root committed
102 103 104
(defvar server-process nil 
  "the current server process")

105 106
(defvar server-previous-string "")

root's avatar
root committed
107 108
(defvar server-clients nil
  "List of current server clients.
109
Each element is (CLIENTID BUFFERS...) where CLIENTID is a string
root's avatar
root committed
110 111 112 113 114
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
  "List of clientids for clients requesting editing of current buffer.")
115
(make-variable-buffer-local 'server-buffer-clients)
root's avatar
root committed
116 117 118
;; Changing major modes should not erase this local.
(put 'server-buffer-clients 'permanent-local t)

119 120 121 122 123
(defvar server-window nil
  "*The window to use for selecting Emacs server buffers.
If nil, use the selected window.
If it is a frame, use the frame's selected window.")

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
Richard M. Stallman's avatar
Richard M. Stallman committed
127 128 129
by the programs that invoke the emacs server."
  :group 'server
  :type 'regexp)
root's avatar
root committed
130 131 132 133 134 135 136 137 138 139 140

(or (assq 'server-buffer-clients minor-mode-alist)
    (setq minor-mode-alist (cons '(server-buffer-clients " Server") minor-mode-alist)))

;; If a *server* buffer exists,
;; write STRING to it for logging purposes.
(defun server-log (string)
  (if (get-buffer "*server*")
      (save-excursion
	(set-buffer "*server*")
	(goto-char (point-max))
141 142
	(insert (current-time-string) " " string)
	(or (bolp) (newline)))))
root's avatar
root committed
143 144 145 146 147 148 149

(defun server-sentinel (proc msg)
  (cond ((eq (process-status proc) 'exit)
	 (server-log (message "Server subprocess exited")))
	((eq (process-status proc) 'signal)
	 (server-log (message "Server subprocess killed")))))

Roland McGrath's avatar
Roland McGrath committed
150
;;;###autoload
root's avatar
root committed
151 152 153 154
(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
155
To use the server, set up the program `emacsclient' in the
root's avatar
root committed
156 157 158 159 160 161 162 163 164
Emacs distribution as your standard \"editor\".

Prefix arg means just kill any existing server communications subprocess."
  (interactive "P")
  ;; kill it dead!
  (if server-process
      (progn
	(set-process-sentinel server-process nil)
	(condition-case () (delete-process server-process) (error nil))))
165
  ;; Delete the socket files made by previous server invocations.
166 167
  (let* ((sysname (system-name))
	 (dot-index (string-match "\\." sysname)))
168 169 170
    (condition-case ()
	(delete-file (format "~/.emacs-server-%s" sysname))
      (error nil))
171 172 173 174 175 176
    (condition-case ()
	(delete-file (format "/tmp/esrv%d-%s" (user-uid) sysname))
      (error nil))
    ;; In case the server file name was made with a domainless hostname,
    ;; try deleting that name too.
    (if dot-index
177 178 179 180 181 182 183 184
	(let ((shortname (substring sysname 0 dot-index)))
	  (condition-case ()
	      (delete-file (format "~/.emacs-server-%s" shortname))
	    (error nil))
	  (condition-case ()
	      (delete-file (format "/tmp/esrv%d-%s" (user-uid) shortname))
	    (error nil)))))
  ;; If this Emacs already had a server, clear out associated status.
root's avatar
root committed
185 186 187 188 189 190 191
  (while server-clients
    (let ((buffer (nth 1 (car server-clients))))
      (server-buffer-done buffer)))
  (if leave-dead
      nil
    (if server-process
	(server-log (message "Restarting server")))
192 193 194 195
    ;; Using a pty is wasteful, and the separate session causes
    ;; annoyance sometimes (some systems kill idle sessions).
    (let ((process-connection-type nil))
      (setq server-process (start-process "server" nil server-program)))
root's avatar
root committed
196 197
    (set-process-sentinel server-process 'server-sentinel)
    (set-process-filter server-process 'server-process-filter)
198 199 200 201
    ;; We must receive file names without being decoded.  Those are
    ;; decoded by server-process-filter accoding to
    ;; file-name-coding-system.
    (set-process-coding-system server-process 'raw-text 'raw-text)
root's avatar
root committed
202 203 204 205 206 207
    (process-kill-without-query server-process)))

;Process a request from the server to edit some files.
;Format of STRING is "Client: CLIENTID PATH PATH PATH... \n"
(defun server-process-filter (proc string)
  (server-log string)
208
  (setq string (concat server-previous-string string))
209 210 211 212
  ;; If the input is multiple lines,
  ;; process each line individually.
  (while (string-match "\n" string)
    (let ((request (substring string 0 (match-beginning 0)))
213 214 215
	  (coding-system (and default-enable-multibyte-characters
			      (or file-name-coding-system
				  default-file-name-coding-system)))
216
	  client nowait
root's avatar
root committed
217 218
	  (files nil)
	  (lineno 1))
219 220
      ;; Remove this line from STRING.
      (setq string (substring string (match-end 0)))	  
221
      (if (string-match "^Error: " request)
222
	  (message "Server error: %s" (substring request (match-end 0)))
223
	(if (string-match "^Client: " request)
224 225 226 227 228 229
	    (progn
	      (setq request (substring request (match-end 0)))
	      (setq client (list (substring request 0 (string-match " " request))))
	      (setq request (substring request (match-end 0)))
	      (while (string-match "[^ ]+ " request)
		(let ((arg
230 231
		       (substring request (match-beginning 0) (1- (match-end 0))))
		      (pos 0))
232
		  (setq request (substring request (match-end 0)))
233 234 235 236 237 238 239 240
		  (if (string-match "\\`-nowait" arg)
		      (setq nowait t)
		    (if (string-match "\\`\\+[0-9]+\\'" arg)
			;; ARG is a line number option.
			(setq lineno (read (substring arg 1)))
		      ;; ARG is a file name.
		      ;; Collapse multiple slashes to single slashes.
		      (setq arg (command-line-normalize-file-name arg))
241 242
		      ;; Undo the quoting that emacsclient does
		      ;; for certain special characters.
243
		      (while (string-match "&." arg pos)
244 245
			(setq pos (1+ (match-beginning 0)))
			(let ((nextchar (aref arg pos)))
246 247
			  (cond ((= nextchar ?&)
				 (setq arg (replace-match "&" t t arg)))
248 249 250 251
				((= nextchar ?-)
				 (setq arg (replace-match "-" t t arg)))
				(t
				 (setq arg (replace-match " " t t arg))))))
252 253 254
		      ;; Now decode the file name if necessary.
		      (if coding-system
			  (setq arg (decode-coding-string arg coding-system)))
255 256 257 258 259
		      (setq files
			    (cons (list arg lineno)
				  files))
		      (setq lineno 1)))))
	      (server-visit-files files client nowait)
260
	      ;; CLIENT is now a list (CLIENTNUM BUFFERS...)
261 262
	      (or nowait
		  (setq server-clients (cons client server-clients)))
263 264 265 266
	      (server-switch-buffer (nth 1 client))
	      (run-hooks 'server-switch-hook)
	      (message (substitute-command-keys
			"When done with a buffer, type \\[server-edit]")))))))
267 268
  ;; Save for later any partial line that remains.
  (setq server-previous-string string))
root's avatar
root committed
269

270
(defun server-visit-files (files client &optional nowait)
root's avatar
root committed
271
  "Finds FILES and returns the list CLIENT with the buffers nconc'd.
272 273 274
FILES is an alist whose elements are (FILENAME LINENUMBER).
NOWAIT non-nil means this client is not waiting for the results,
so don't mark these buffers specially, just visit them normally."
275 276
  ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
  (let (client-record (last-nonmenu-event t) (obuf (current-buffer)))
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
    ;; 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.
    (unwind-protect
	(while 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 (car files)))
		 (obuf (get-file-buffer filen)))
	    (if (and obuf (set-buffer obuf))
		(if (file-exists-p filen)
		    (if (or (not (verify-visited-file-modtime obuf))
			    (buffer-modified-p obuf))
			(revert-buffer t nil))
		  (if (y-or-n-p
		       (concat "File no longer exists: "
			       filen
			       ", write buffer to file? "))
		      (write-file filen)))
	      (set-buffer (find-file-noselect filen))
	      (run-hooks 'server-visit-hook)))
	  (goto-line (nth 1 (car files)))
300 301 302
	  (if (not nowait)
	      (setq server-buffer-clients
		    (cons (car client) server-buffer-clients)))
303 304 305
	  (setq client-record (cons (current-buffer) client-record))
	  (setq files (cdr files)))
      (set-buffer obuf))
root's avatar
root committed
306 307
    (nconc client client-record)))

308
(defun server-buffer-done (buffer &optional for-killing)
root's avatar
root committed
309
  "Mark BUFFER as \"done\" for its client(s).
310 311
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,
312 313
or nil.  KILLED is t if we killed BUFFER
\(typically, because it was visiting a temp file)."
root's avatar
root committed
314 315
  (let ((running (eq (process-status server-process) 'run))
	(next-buffer nil)
316
	(killed nil)
317
	(first t)
root's avatar
root committed
318 319 320 321 322 323
	(old-clients server-clients))
    (while old-clients
      (let ((client (car old-clients)))
	(or next-buffer 
	    (setq next-buffer (nth 1 (memq buffer client))))
	(delq buffer client)
324 325 326 327 328 329 330
	;; 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
331 332 333 334 335
	;; If client now has no pending buffers,
	;; tell it that it is done, and forget it entirely.
	(if (cdr client) nil
	  (if running
	      (progn
336 337
		;; Don't send emacsserver two commands in close succession.
		;; It cannot handle that.
338 339 340 341 342
		(or first (sit-for 1))
		(setq first nil)
		(send-string server-process 
			     (format "Close: %s Done\n" (car client)))
		(server-log (format "Close: %s Done\n" (car client)))))
root's avatar
root committed
343 344
	  (setq server-clients (delq client server-clients))))
      (setq old-clients (cdr old-clients)))
345
    (if (and (bufferp buffer) (buffer-name buffer))
346 347 348 349
	;; 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))
350 351
	  (save-excursion
	    (set-buffer buffer)
352 353
	    (setq server-buffer-clients nil)
	    (run-hooks 'server-done-hook))
354 355 356 357 358 359
	  ;; 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
360 361 362
	      (if (server-temp-file-p buffer)
		  (progn (kill-buffer buffer)
			 (setq killed t))
363
		(bury-buffer buffer))))))
364
    (list next-buffer killed)))
root's avatar
root committed
365 366 367 368 369 370 371 372 373 374 375 376

(defun server-temp-file-p (buffer)
  "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
377
  "Offer to save current buffer, mark it as \"done\" for clients.
378 379
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,
380 381
or nil.  KILLED is t if we killed BUFFER
\(typically, because it was visiting a temp file)."
root's avatar
root committed
382 383
  (let ((buffer (current-buffer)))
    (if server-buffer-clients
384
	(progn
root's avatar
root committed
385
 	  (if (server-temp-file-p buffer)
386 387 388 389
	      ;; 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))
390
		(save-buffer))
root's avatar
root committed
391
	    (if (and (buffer-modified-p)
392
		     buffer-file-name
root's avatar
root committed
393 394
		     (y-or-n-p (concat "Save file " buffer-file-name "? ")))
		(save-buffer buffer)))
395
	  (server-buffer-done buffer)))))
396

Richard M. Stallman's avatar
Richard M. Stallman committed
397 398 399 400
;; 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.
401 402 403 404 405
(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))))))

406
(add-hook 'kill-buffer-query-functions
407 408 409
 	  'server-kill-buffer-query-function)

(defun server-kill-emacs-query-function ()
410 411 412 413 414 415 416 417 418
  (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? "))))
419 420

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

422
(defvar server-kill-buffer-running nil
423
  "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
424

425 426 427
;; When a buffer is killed, inform the clients.
(add-hook 'kill-buffer-hook 'server-kill-buffer)
(defun server-kill-buffer ()
428 429 430
  ;; Prevent infinite recursion if user has made server-done-hook
  ;; call kill-buffer.
  (or server-kill-buffer-running
431 432 433 434
      (and server-buffer-clients
	   (let ((server-kill-buffer-running t))
	     (when server-process
	       (server-buffer-done (current-buffer) t))))))
root's avatar
root committed
435 436 437 438 439 440 441

(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.
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,
442 443 444
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
445 446 447 448 449 450 451 452 453
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)
454
    (apply 'server-switch-buffer (server-done))))
root's avatar
root committed
455

456
(defun server-switch-buffer (&optional next-buffer killed-one)
root's avatar
root committed
457 458
  "Switch to another buffer, preferably one that has a client.
Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
459 460 461 462
  ;; 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.
463 464
  (cond ((and (windowp server-window)
	      (window-live-p server-window))
465 466
	 (select-window server-window))
	((framep server-window)
467 468
	 (if (not (frame-live-p server-window))
	     (setq server-window (make-frame)))
469
	 (select-window (frame-selected-window server-window))))
470
  (if (window-minibuffer-p (selected-window))
471 472 473 474 475 476 477
      (select-window (next-window nil 'nomini 0)))
  ;; Move to a non-dedicated window, if we have one.
  (let ((last-window (previous-window nil 'nomini 0)))
    (while (and (window-dedicated-p (selected-window))
		(not (eq last-window (selected-window))))
      (select-window (next-window nil 'nomini 0))))
  (set-window-dedicated-p (selected-window) nil)
root's avatar
root committed
478 479 480 481 482 483 484
  (if next-buffer
      (if (and (bufferp next-buffer)
	       (buffer-name next-buffer))
	  (switch-to-buffer next-buffer)
	;; If NEXT-BUFFER is a dead buffer,
	;; remove the server records for it
	;; and try the next surviving server buffer.
485 486
	(apply 'server-switch-buffer
	       (server-buffer-done next-buffer)))
root's avatar
root committed
487
    (if server-clients
488 489 490
	(server-switch-buffer (nth 1 (car server-clients)) killed-one)
      (if (not killed-one)
	  (switch-to-buffer (other-buffer))))))
root's avatar
root committed
491 492

(global-set-key "\C-x#" 'server-edit)
Roland McGrath's avatar
Roland McGrath committed
493 494

(provide 'server)
Eric S. Raymond's avatar
Eric S. Raymond committed
495 496

;;; server.el ends here