server.el 17.3 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.

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1986, 1987, 1992, 1994, 1995 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>
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Keywords: processes
Eric S. Raymond's avatar
Eric S. Raymond committed
7

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

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

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

Erik Naggum's avatar
Erik Naggum committed
32 33 34 35
;; 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
36

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

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

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

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

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

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

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

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

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

;;; Code:
root's avatar
root committed
76

77
(defvar server-program (expand-file-name "emacsserver" exec-directory)
78
  "*The program to use as the edit server.")
root's avatar
root committed
79 80

(defvar server-visit-hook nil
81 82 83
  "*List of hooks to call when visiting a file for the Emacs server.")

(defvar server-switch-hook nil
root's avatar
root committed
84 85
  "*List of hooks to call when switching to a buffer for the Emacs server.")

86 87 88
(defvar server-done-hook nil
  "*List of hooks to call when done editing a buffer for the Emacs server.")

root's avatar
root committed
89 90 91
(defvar server-process nil 
  "the current server process")

92 93
(defvar server-previous-string "")

root's avatar
root committed
94 95
(defvar server-clients nil
  "List of current server clients.
96
Each element is (CLIENTID BUFFERS...) where CLIENTID is a string
root's avatar
root committed
97 98 99 100 101
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.")
102
(make-variable-buffer-local 'server-buffer-clients)
root's avatar
root committed
103 104 105
;; Changing major modes should not erase this local.
(put 'server-buffer-clients 'permanent-local t)

106 107 108 109 110
(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.")

root's avatar
root committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
(defvar server-temp-file-regexp "^/tmp/Re\\|/draft$"
  "*Regexp which should match filenames of temporary files
which are deleted and reused after each edit
by the programs that invoke the emacs server.")

(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))
126 127
	(insert (current-time-string) " " string)
	(or (bolp) (newline)))))
root's avatar
root committed
128 129 130 131 132 133 134

(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
135
;;;###autoload
root's avatar
root committed
136 137 138 139
(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
140
To use the server, set up the program `emacsclient' in the
root's avatar
root committed
141 142 143 144 145 146 147 148 149
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))))
150
  ;; Delete the socket files made by previous server invocations.
151 152
  (let* ((sysname (system-name))
	 (dot-index (string-match "\\." sysname)))
153 154 155
    (condition-case ()
	(delete-file (format "~/.emacs-server-%s" sysname))
      (error nil))
156 157 158 159 160 161
    (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
162 163 164 165 166 167 168 169
	(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
170 171 172 173 174 175 176
  (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")))
177 178 179 180
    ;; 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
181 182 183 184 185 186 187 188
    (set-process-sentinel server-process 'server-sentinel)
    (set-process-filter server-process 'server-process-filter)
    (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)
189
  (setq string (concat server-previous-string string))
190 191 192 193
  ;; If the input is multiple lines,
  ;; process each line individually.
  (while (string-match "\n" string)
    (let ((request (substring string 0 (match-beginning 0)))
194
	  client nowait
root's avatar
root committed
195 196
	  (files nil)
	  (lineno 1))
197 198
      ;; Remove this line from STRING.
      (setq string (substring string (match-end 0)))	  
199
      (if (string-match "^Error: " request)
200
	  (message "Server error: %s" (substring request (match-end 0)))
201
	(if (string-match "^Client: " request)
202 203 204 205 206 207 208 209
	    (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
		       (substring request (match-beginning 0) (1- (match-end 0)))))
		  (setq request (substring request (match-end 0)))
210 211 212 213 214 215 216 217
		  (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))
218 219 220
		      (setq pos 0)
		      ;; Undo the quoting that emacsclient does
		      ;; for certain special characters.
221
		      (while (string-match "&." arg pos)
222 223
			(setq pos (1+ (match-beginning 0)))
			(let ((nextchar (aref arg pos)))
224 225
			  (cond ((= nextchar ?&)
				 (setq arg (replace-match "&" t t arg)))
226 227 228 229
				((= nextchar ?-)
				 (setq arg (replace-match "-" t t arg)))
				(t
				 (setq arg (replace-match " " t t arg))))))
230 231 232 233 234
		      (setq files
			    (cons (list arg lineno)
				  files))
		      (setq lineno 1)))))
	      (server-visit-files files client nowait)
235
	      ;; CLIENT is now a list (CLIENTNUM BUFFERS...)
236 237
	      (or nowait
		  (setq server-clients (cons client server-clients)))
238 239 240 241
	      (server-switch-buffer (nth 1 client))
	      (run-hooks 'server-switch-hook)
	      (message (substitute-command-keys
			"When done with a buffer, type \\[server-edit]")))))))
242 243
  ;; Save for later any partial line that remains.
  (setq server-previous-string string))
root's avatar
root committed
244

245
(defun server-visit-files (files client &optional nowait)
root's avatar
root committed
246
  "Finds FILES and returns the list CLIENT with the buffers nconc'd.
247 248 249
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."
250 251
  ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
  (let (client-record (last-nonmenu-event t) (obuf (current-buffer)))
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    ;; 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)))
275 276 277
	  (if (not nowait)
	      (setq server-buffer-clients
		    (cons (car client) server-buffer-clients)))
278 279 280
	  (setq client-record (cons (current-buffer) client-record))
	  (setq files (cdr files)))
      (set-buffer obuf))
root's avatar
root committed
281 282 283 284
    (nconc client client-record)))

(defun server-buffer-done (buffer)
  "Mark BUFFER as \"done\" for its client(s).
285 286 287
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,
or nil.  KILLED is t if we killed BUFFER (because it was a temp file)."
root's avatar
root committed
288 289
  (let ((running (eq (process-status server-process) 'run))
	(next-buffer nil)
290
	(killed nil)
291
	(first t)
root's avatar
root committed
292 293 294 295 296 297
	(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)
298 299 300 301 302 303 304
	;; 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
305 306 307 308 309
	;; If client now has no pending buffers,
	;; tell it that it is done, and forget it entirely.
	(if (cdr client) nil
	  (if running
	      (progn
310 311
		;; Don't send emacsserver two commands in close succession.
		;; It cannot handle that.
312 313 314 315 316
		(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
317 318
	  (setq server-clients (delq client server-clients))))
      (setq old-clients (cdr old-clients)))
319
    (if (and (bufferp buffer) (buffer-name buffer))
320 321 322
	(progn
	  (save-excursion
	    (set-buffer buffer)
323 324
	    (setq server-buffer-clients nil)
	    (run-hooks 'server-done-hook))
325
	  (if (server-temp-file-p buffer)
326 327
	      (progn (kill-buffer buffer)
		     (setq killed t))
328
	    (bury-buffer buffer))))
329
    (list next-buffer killed)))
root's avatar
root committed
330 331 332 333 334 335 336 337 338 339 340 341

(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
342
  "Offer to save current buffer, mark it as \"done\" for clients.
343 344 345
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,
or nil.  KILLED is t if we killed the BUFFER (because it was a temp file)."
root's avatar
root committed
346 347
  (let ((buffer (current-buffer)))
    (if server-buffer-clients
348
	(progn
root's avatar
root committed
349
 	  (if (server-temp-file-p buffer)
350 351 352 353
	      ;; 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))
354
		(save-buffer))
root's avatar
root committed
355 356 357
	    (if (and (buffer-modified-p)
		     (y-or-n-p (concat "Save file " buffer-file-name "? ")))
		(save-buffer buffer)))
358
	  (server-buffer-done buffer)))))
359

Richard M. Stallman's avatar
Richard M. Stallman committed
360 361 362 363
;; 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.
364 365 366 367 368
(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))))))

369
(add-hook 'kill-buffer-query-functions
370 371 372
 	  'server-kill-buffer-query-function)

(defun server-kill-emacs-query-function ()
373 374 375 376 377 378 379 380 381
  (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? "))))
382 383

(add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
root's avatar
root committed
384 385 386 387 388 389 390

(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,
391 392 393
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
394 395 396 397 398 399 400 401 402
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)
403
    (apply 'server-switch-buffer (server-done))))
root's avatar
root committed
404

405
(defun server-switch-buffer (&optional next-buffer killed-one)
root's avatar
root committed
406 407
  "Switch to another buffer, preferably one that has a client.
Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
408 409 410 411
  ;; 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.
412 413
  (cond ((and (windowp server-window)
	      (window-live-p server-window))
414 415
	 (select-window server-window))
	((framep server-window)
416 417
	 (if (not (frame-live-p server-window))
	     (setq server-window (make-frame)))
418
	 (select-window (frame-selected-window server-window))))
419
  (if (window-minibuffer-p (selected-window))
420 421 422 423 424 425 426
      (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
427 428 429 430 431 432 433
  (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.
434 435
	(apply 'server-switch-buffer
	       (server-buffer-done next-buffer)))
root's avatar
root committed
436
    (if server-clients
437 438 439
	(server-switch-buffer (nth 1 (car server-clients)) killed-one)
      (if (not killed-one)
	  (switch-to-buffer (other-buffer))))))
root's avatar
root committed
440 441

(global-set-key "\C-x#" 'server-edit)
Roland McGrath's avatar
Roland McGrath committed
442 443

(provide 'server)
Eric S. Raymond's avatar
Eric S. Raymond committed
444 445

;;; server.el ends here