server.el 41.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, 1987, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4
;;   2001, 2002, 2003, 2004, 2005, 2006 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
;; Changes by peck@sun.com and by rms.
11
;; Overhaul by Karoly Lorentey <lorentey@elte.hu> for multi-tty support.
root's avatar
root committed
12 13 14 15 16

;; 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
17
;; the Free Software Foundation; either version 2, or (at your option)
root's avatar
root committed
18 19 20 21 22 23 24 25
;; 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
26
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
27 28
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
root's avatar
root committed
29

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

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

Erik Naggum's avatar
Erik Naggum committed
35
;; Load this library and do M-x server-edit to enable Emacs as a server.
36 37 38
;; 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
39

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

Karoly Lorentey's avatar
Karoly Lorentey committed
45
;; Note that any number of clients may dispatch files to Emacs to be edited.
root's avatar
root committed
46

Erik Naggum's avatar
Erik Naggum committed
47
;; When you finish editing a Server buffer, again call server-edit
48 49
;; 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
50
;; and exited with server-edit, the client "editor" will return
51
;; to the program that invoked it.
root's avatar
root committed
52

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

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

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

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

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

73 74
;; 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
75 76
;; 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
77 78

;;; Code:
79 80 81

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

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

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

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

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

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

(defvar server-clients nil
  "List of current server clients.
Karoly Lorentey's avatar
Karoly Lorentey committed
106 107
Each element is (PROC PROPERTIES...) where PROC is a process object,
and PROPERTIES is an association list of client properties.")
Karoly Lorentey's avatar
Karoly Lorentey committed
108

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

Dave Love's avatar
Dave Love committed
115 116
(defcustom server-window nil
  "*Specification of the window to use for selecting Emacs server buffers.
117
If nil, use the selected window.
118
If it is a function, it should take one argument (a buffer) and
Dave Love's avatar
Dave Love committed
119 120 121 122 123 124 125
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
126
  :version "22.1"
Dave Love's avatar
Dave Love committed
127 128 129 130 131 132
  :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")))
133

Richard M. Stallman's avatar
Richard M. Stallman committed
134
(defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
Dave Love's avatar
Dave Love committed
135 136 137
  "*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
138 139
  :group 'server
  :type 'regexp)
root's avatar
root committed
140

141 142 143
(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
144
it with Emacs server.  If nil, kill only buffers as specified by
145 146 147 148 149 150 151 152
`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
153 154 155
(or (assq 'server-buffer-clients minor-mode-alist)
    (setq minor-mode-alist (cons '(server-buffer-clients " Server") minor-mode-alist)))

156
(defvar server-existing-buffer nil
157
  "Non-nil means the buffer existed before the server was asked to visit it.
158
This means that the server should not kill the buffer when you say you
159
are done with it in the server.")
160 161
(make-variable-buffer-local 'server-existing-buffer)

Stefan Monnier's avatar
Stefan Monnier committed
162 163
(defvar server-name "server")

164 165 166
(defvar server-socket-dir nil
  "The directory in which to place the server socket.
Initialized by `server-start'.")
167

Karoly Lorentey's avatar
Karoly Lorentey committed
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
(defun server-client (proc)
  "Return the Emacs client corresponding to PROC.
PROC must be a process object.
The car of the result is PROC; the cdr is an association list.
See `server-client-get' and `server-client-set'."
  (assq proc server-clients))

(defun server-client-get (client property)
  "Get the value of PROPERTY in CLIENT.
CLIENT may be a process object, or a client returned by `server-client'.
Return nil if CLIENT has no such property."
  (or (listp client) (setq client (server-client client)))
  (cdr (assq property (cdr client))))

(defun server-client-set (client property value)
  "Set the PROPERTY to VALUE in CLIENT, and return VALUE.
CLIENT may be a process object, or a client returned by `server-client'."
  (let (p proc)
    (if (listp client)
	(setq proc (car client))
      (setq proc client
	    client (server-client client)))
    (setq p (assq property client))
    (cond
     (p (setcdr p value))
     (client (setcdr client (cons (cons property value) (cdr client))))
     (t (setq server-clients
	      `((,proc (,property . ,value)) . ,server-clients))))
    value))

(defun server-clients-with (property value)
  "Return a list of clients with PROPERTY set to VALUE."
  (let (result)
    (dolist (client server-clients result)
      (when (equal value (server-client-get client property))
	(setq result (cons (car client) result))))))

(defun server-add-client (proc)
  "Create a client for process PROC, if it doesn't already have one.
New clients have no properties."
  (unless (server-client proc)
    (setq server-clients (cons (cons proc nil)
			       server-clients))))

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
(defun server-getenv-from (env variable)
  "Get the value of VARIABLE in ENV.
VARIABLE should be a string.  Value is nil if VARIABLE is
undefined in ENV.  Otherwise, value is a string.

ENV should be in the same format as `process-environment'."
  (let (entry result)
    (while (and env (null result))
      (setq entry (car env)
	    env (cdr env))
      (if (and (> (length entry) (length variable))
	       (eq ?= (aref entry (length variable)))
	       (equal variable (substring entry 0 (length variable))))
	  (setq result (substring entry (+ (length variable) 1)))))
    result))

(defmacro server-with-environment (env vars &rest body)
  "Evaluate BODY with environment variables VARS set to those in ENV.
230 231
The environment variables are then restored to their previous values.

232 233
VARS should be a list of strings.
ENV should be in the same format as `process-environment'."
234 235 236 237 238 239
  (declare (indent 2))
  (let ((oldvalues (make-symbol "oldvalues"))
	(var (make-symbol "var"))
	(value (make-symbol "value"))
	(pair (make-symbol "pair")))
    `(let (,oldvalues)
240 241
       (dolist (,var ,vars)
	 (let ((,value (server-getenv-from ,env ,var)))
242 243 244 245 246 247 248
	   (setq ,oldvalues (cons (cons ,var (getenv ,var)) ,oldvalues))
	   (setenv ,var ,value)))
       (unwind-protect
	   (progn ,@body)
	 (dolist (,pair ,oldvalues)
	   (setenv (car ,pair) (cdr ,pair)))))))

249
(defun server-delete-client (client &optional noframe)
250
  "Delete CLIENT, including its buffers, terminals and frames.
251
If NOFRAME is non-nil, let the frames live.  (To be used from
252 253 254
`delete-frame-functions'.)"
  (server-log (concat "server-delete-client" (if noframe " noframe"))
	      client)
Karoly Lorentey's avatar
Karoly Lorentey committed
255 256 257 258 259 260 261
  ;; Force a new lookup of client (prevents infinite recursion).
  (setq client (server-client
		(if (listp client) (car client) client)))
  (let ((proc (car client))
	(buffers (server-client-get client 'buffers)))
    (when client

262
      ;; Kill the client's buffers.
Karoly Lorentey's avatar
Karoly Lorentey committed
263
      (dolist (buf buffers)
264 265 266
	(when (buffer-live-p buf)
	  (with-current-buffer buf
	    ;; Kill the buffer if necessary.
267 268
	    (when (and (equal server-buffer-clients
			      (list proc))
269 270
		       (or (and server-kill-new-buffers
				(not server-existing-buffer))
271 272 273 274 275 276 277 278 279 280
			   (server-temp-file-p))
		       (not (buffer-modified-p)))
	      (let (flag)
		(unwind-protect
		    (progn (setq server-buffer-clients nil)
			   (kill-buffer (current-buffer))
			   (setq flag t))
		  (unless flag
		    ;; Restore clients if user pressed C-g in `kill-buffer'.
		    (setq server-buffer-clients (list proc)))))))))
Karoly Lorentey's avatar
Karoly Lorentey committed
281

282 283 284 285 286 287 288 289 290 291
      ;; Delete the client's frames.
      (unless noframe
	(dolist (frame (frame-list))
	  (when (and (frame-live-p frame)
		     (equal proc (frame-parameter frame 'client)))
	    ;; Prevent `server-handle-delete-frame' from calling us
	    ;; recursively.
	    (set-frame-parameter frame 'client nil)
	    (delete-frame frame))))

292 293
      (setq server-clients (delq client server-clients))

Karoly Lorentey's avatar
Karoly Lorentey committed
294
      ;; Delete the client's tty.
295 296 297
      (let ((terminal (server-client-get client 'terminal)))
	(when (eq (terminal-live-p terminal) t)
	  (delete-terminal terminal)))
Karoly Lorentey's avatar
Karoly Lorentey committed
298 299 300 301 302 303 304

      ;; Delete the client's process.
      (if (eq (process-status (car client)) 'open)
	  (delete-process (car client)))

      (server-log "Deleted" proc))))

305
(defun server-log (string &optional client)
Karoly Lorentey's avatar
Karoly Lorentey committed
306 307 308
  "If a *server* buffer exists, write STRING to it for logging purposes.
If CLIENT is non-nil, add a description of it to the logged
message."
root's avatar
root committed
309
  (if (get-buffer "*server*")
310
      (with-current-buffer "*server*"
root's avatar
root committed
311
	(goto-char (point-max))
312
	(insert (current-time-string)
Karoly Lorentey's avatar
Karoly Lorentey committed
313 314 315 316
		(cond
		 ((null client) " ")
		 ((listp client) (format " %s: " (car client)))
		 (t (format " %s: " client)))
317
		string)
318
	(or (bolp) (newline)))))
root's avatar
root committed
319 320

(defun server-sentinel (proc msg)
Karoly Lorentey's avatar
Karoly Lorentey committed
321
  "The process sentinel for Emacs server connections."
322 323 324 325 326
  ;; If this is a new client process, set the query-on-exit flag to nil
  ;; for this process (it isn't inherited from the server process).
  (when (and (eq (process-status proc) 'open)
	     (process-query-on-exit-flag proc))
    (set-process-query-on-exit-flag proc nil))
Karoly Lorentey's avatar
Karoly Lorentey committed
327 328
  (server-log (format "Status changed to %s: %s" (process-status proc) msg) proc)
  (server-delete-client proc))
329

330 331
(defun server-handle-delete-frame (frame)
  "Delete the client connection when the emacsclient frame is deleted."
Karoly Lorentey's avatar
Karoly Lorentey committed
332
  (let ((proc (frame-parameter frame 'client)))
333 334
    (when (and (frame-live-p frame)
	       proc
335
	       ;; See if this is the last frame for this client.
336
	       (>= 1 (let ((frame-num 0))
337
		      (dolist (f (frame-list))
338 339 340
			(when (eq proc (frame-parameter f 'client))
			  (setq frame-num (1+ frame-num))))
		      frame-num)))
Karoly Lorentey's avatar
Karoly Lorentey committed
341
      (server-log (format "server-handle-delete-frame, frame %s" frame) proc)
342
      (server-delete-client proc 'noframe)))) ; Let delete-frame delete the frame later.
Karoly Lorentey's avatar
Karoly Lorentey committed
343

344
(defun server-handle-suspend-tty (terminal)
Karoly Lorentey's avatar
Karoly Lorentey committed
345
  "Notify the emacsclient process to suspend itself when its tty device is suspended."
346 347
  (dolist (proc (server-clients-with 'terminal terminal))
    (server-log (format "server-handle-suspend-tty, terminal %s" terminal) proc)
Karoly Lorentey's avatar
Karoly Lorentey committed
348
    (condition-case err
349
	(server-send-string proc "-suspend \n")
Karoly Lorentey's avatar
Karoly Lorentey committed
350
      (file-error (condition-case nil (server-delete-client proc) (error nil))))))
351

352
(defun server-unquote-arg (arg)
353 354
  "Remove &-quotation from ARG.
See `server-quote-arg' and `server-process-filter'."
355 356 357 358 359 360 361 362
  (replace-regexp-in-string
   "&." (lambda (s)
	  (case (aref s 1)
	    (?& "&")
	    (?- "-")
	    (?n "\n")
	    (t " ")))
   arg t t))
root's avatar
root committed
363

364
(defun server-quote-arg (arg)
Karoly Lorentey's avatar
Karoly Lorentey committed
365
  "In ARG, insert a & before each &, each space, each newline, and -.
366
Change spaces to underscores, too, so that the return value never
367 368 369
contains a space.

See `server-unquote-arg' and `server-process-filter'."
370 371 372 373 374 375 376 377 378
  (replace-regexp-in-string
   "[-&\n ]" (lambda (s)
	       (case (aref s 0)
		 (?& "&&")
		 (?- "&-")
		 (?\n "&n")
		 (?\s "&_")))
   arg t t))

379 380 381 382 383
(defun server-send-string (proc string)
  "A wrapper around `proc-send-string' for logging."
  (server-log (concat "Sent " string) proc)
  (process-send-string proc string))

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
(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
400
;;;###autoload
root's avatar
root committed
401 402 403
(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
Karoly Lorentey's avatar
Karoly Lorentey committed
404 405
client \"editors\" can send your editing commands to this Emacs
job.  To use the server, set up the program `emacsclient' in the
root's avatar
root committed
406 407
Emacs distribution as your standard \"editor\".

Karoly Lorentey's avatar
Karoly Lorentey committed
408 409
Prefix arg LEAVE-DEAD means just kill any existing server
communications subprocess."
root's avatar
root committed
410
  (interactive "P")
411 412 413 414 415 416 417 418 419 420
  (when (or
	 (not server-clients)
	 (yes-or-no-p
	  "The current server still has clients; delete them? "))
    ;; It is safe to get the user id now.
    (setq server-socket-dir (or server-socket-dir
				(format "/tmp/emacs%d" (user-uid))))
    ;; Make sure there is a safe directory in which to place the socket.
    (server-ensure-safe-dir server-socket-dir)
    ;; kill it dead!
root's avatar
root committed
421
    (if server-process
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
	(condition-case () (delete-process server-process) (error nil)))
    ;; Delete the socket files made by previous server invocations.
    (condition-case ()
	(delete-file (expand-file-name server-name server-socket-dir))
      (error nil))
    ;; If this Emacs already had a server, clear out associated status.
    (while server-clients
      (server-delete-client (car server-clients)))
    (if leave-dead
	(progn
	  (server-log (message "Server stopped"))
	  (setq server-process nil))
      (if server-process
	  (server-log (message "Restarting server"))
	(server-log (message "Starting server")))
      (letf (((default-file-modes) ?\700))
	(add-hook 'suspend-tty-functions 'server-handle-suspend-tty)
	(add-hook 'delete-frame-functions 'server-handle-delete-frame)
	(add-hook 'kill-buffer-query-functions 'server-kill-buffer-query-function)
	(add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
	(setq server-process
	      (make-network-process
	       :name "server" :family 'local :server t :noquery t
	       :service (expand-file-name server-name server-socket-dir)
	       :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
451 452 453 454 455 456 457 458 459

;;;###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
460
  :version "22.1"
Dave Love's avatar
Dave Love committed
461 462 463
  ;; 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
464 465

(defun server-process-filter (proc string)
Dave Love's avatar
Dave Love committed
466
  "Process a request from the server to edit some files.
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
PROC is the server process.  STRING consists of a sequence of
commands prefixed by a dash.  Some commands have arguments; these
are &-quoted and need to be decoded by `server-unquote-arg'.  The
filter parses and executes these commands.

To illustrate the protocol, here is an example command that
emacsclient sends to create a new X frame (note that the whole
sequence is sent on a single line):

	-version 21.3.50 xterm
	-env HOME /home/lorentey
	-env DISPLAY :0.0
	... lots of other -env commands
	-display :0.0
	-window-system

The server normally sends back the single command `-good-version'
as a response.

The following commands are accepted by the server:

`-version CLIENT-VERSION'
  Check version numbers between server and client, and signal an
  error if there is a mismatch.  The server replies with
  `-good-version' to confirm the match.

493
`-env NAME=VALUE'
494 495
  An environment variable on the client side.

496 497 498
`-dir DIRNAME'
  The current working directory of the client process.

499 500 501
`-current-frame'
  Forbid the creation of new frames.

502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
`-nowait'
  Request that the next frame created should not be
  associated with this client.

`-display DISPLAY'
  Set the display name to open X frames on.

`-position LINE[:COLUMN]'
  Go to the given line and column number
  in the next file opened.

`-file FILENAME'
  Load the given file in the current frame.

`-eval EXPR'
  Evaluate EXPR as a Lisp expression and return the
  result in -print commands.

`-window-system'
  Open a new X frame.

`-tty DEVICENAME TYPE'
  Open a new tty frame at the client.

`-suspend'
  Suspend this tty frame.  The client sends this string in
  response to SIGTSTP and SIGTTOU.  The server must cease all I/O
  on this tty until it gets a -resume command.

531 532 533 534 535
`-resume'
  Resume this tty frame. The client sends this string when it
  gets the SIGCONT signal and it is the foreground process on its
  controlling tty.

536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
`-ignore COMMENT'
  Do nothing, but put the comment in the server
  log.  Useful for debugging.


The following commands are accepted by the client:

`-good-version'
  Signals a version match between the client and the server.

`-emacs-pid PID'
  Describes the process id of the Emacs process;
  used to forward window change signals to it.

`-window-system-unsupported'
  Signals that the server does not
  support creating X frames; the client must try again with a tty
  frame.

`-print STRING'
  Print STRING on stdout.  Used to send values
  returned by -eval.

`-error DESCRIPTION'
  Signal an error (but continue processing).

`-suspend'
  Suspend this terminal, i.e., stop the client process.  Sent
  when the user presses C-z."
  (server-log (concat "Received " string) proc)
566 567 568 569
  (let ((prev (process-get proc 'previous-string)))
    (when prev
      (setq string (concat prev string))
      (process-put proc 'previous-string nil)))
570
  (condition-case err
571
      (progn
Karoly Lorentey's avatar
Karoly Lorentey committed
572
	(server-add-client proc)
573 574 575 576 577 578 579
	;; If the input is multiple lines,
	;; process each line individually.
	(while (string-match "\n" string)
	  (let ((request (substring string 0 (match-beginning 0)))
		(coding-system (and default-enable-multibyte-characters
				    (or file-name-coding-system
					default-file-name-coding-system)))
Karoly Lorentey's avatar
Karoly Lorentey committed
580
		(client (server-client proc))
581
		current-frame
Karoly Lorentey's avatar
Karoly Lorentey committed
582 583
		nowait ; t if emacsclient does not want to wait for us.
		frame ; The frame that was opened for the client (if any).
584
		display		     ; Open the frame on this display.
585
		dontkill       ; t if the client should not be killed.
586
		env
587
		dir
588 589 590 591 592
		(files nil)
		(lineno 1)
		(columnno 0))
	    ;; Remove this line from STRING.
	    (setq string (substring string (match-end 0)))
Karoly Lorentey's avatar
Karoly Lorentey committed
593
	    (while (string-match " *[^ ]* " request)
594 595 596
	      (let ((arg (substring request (match-beginning 0) (1- (match-end 0)))))
		(setq request (substring request (match-end 0)))
		(cond
Karoly Lorentey's avatar
Karoly Lorentey committed
597 598 599 600
		 ;; -version CLIENT-VERSION:
		 ;; Check version numbers, signal an error if there is a mismatch.
		 ((and (equal "-version" arg)
		       (string-match "\\([0-9.]+\\) " request))
601
		  (let* ((client-version (match-string 1 request))
Karoly Lorentey's avatar
Karoly Lorentey committed
602 603
			 (truncated-emacs-version
			  (substring emacs-version 0 (length client-version))))
604 605 606
		    (setq request (substring request (match-end 0)))
		    (if (equal client-version truncated-emacs-version)
			(progn
607
			  (server-send-string proc "-good-version \n")
Karoly Lorentey's avatar
Karoly Lorentey committed
608 609 610 611
			  (server-client-set client 'version client-version))
		      (error (concat "Version mismatch: Emacs is "
				     truncated-emacs-version
				     ", emacsclient is " client-version)))))
612

Karoly Lorentey's avatar
Karoly Lorentey committed
613
		 ;; -nowait:  Emacsclient won't wait for a result.
614 615
		 ((equal "-nowait" arg) (setq nowait t))

616 617 618
		 ;; -current-frame:  Don't create frames.
		 ((equal "-current-frame" arg) (setq current-frame t))

Karoly Lorentey's avatar
Karoly Lorentey committed
619
		 ;; -display DISPLAY:
620
		 ;; Open X frames on the given display instead of the default.
621 622 623 624
		 ((and (equal "-display" arg) (string-match "\\([^ ]*\\) " request))
		  (setq display (match-string 1 request)
			request (substring request (match-end 0))))

Karoly Lorentey's avatar
Karoly Lorentey committed
625
		 ;; -window-system:  Open a new X frame.
626
		 ((equal "-window-system" arg)
Karoly Lorentey's avatar
Karoly Lorentey committed
627
		  (unless (server-client-get client 'version)
628
		    (error "Protocol error; make sure to use the correct version of emacsclient"))
629 630 631
		  (unless current-frame
		    (if (fboundp 'x-create-frame)
			(let ((params (if nowait
632 633 634
					  ;; Flag frame as client-created, but use a dummy client.
					  ;; This will prevent the frame from being deleted when
					  ;; emacsclient quits while also preventing
635
					  ;; `server-save-buffers-kill-terminal' from unexpectedly
636
					  ;; killing emacs on that frame.
637 638
					  (list (cons 'client 'nowait) (cons 'environment env))
					(list (cons 'client proc) (cons 'environment env)))))
639 640
			  (setq frame (make-frame-on-display
				       (or display
641
					   (frame-parameter nil 'display)
642 643 644 645 646 647 648 649 650 651 652
					   (getenv "DISPLAY")
					   (error "Please specify display"))
				       params))
			  (server-log (format "%s created" frame) proc)
			  ;; XXX We need to ensure the parameters are
			  ;; really set because Emacs forgets unhandled
			  ;; initialization parameters for X frames at
			  ;; the moment.
			  (modify-frame-parameters frame params)
			  (select-frame frame)
			  (server-client-set client 'frame frame)
653
			  (server-client-set client 'terminal (frame-terminal frame))
654 655 656

			  ;; Display *scratch* by default.
			  (switch-to-buffer (get-buffer-create "*scratch*") 'norecord)
657
			  (if dir (setq default-directory dir))
658

659 660 661 662 663
			  (setq dontkill t))
		      ;; This emacs does not support X.
		      (server-log "Window system unsupported" proc)
		      (server-send-string proc "-window-system-unsupported \n")
		      (setq dontkill t))))
Karoly Lorentey's avatar
Karoly Lorentey committed
664 665

		 ;; -resume:  Resume a suspended tty frame.
666
		 ((equal "-resume" arg)
667
		  (let ((terminal (server-client-get client 'terminal)))
668
		    (setq dontkill t)
669 670
		    (when (eq (terminal-live-p terminal) t)
		      (resume-tty terminal))))
671

Karoly Lorentey's avatar
Karoly Lorentey committed
672 673 674
		 ;; -suspend:  Suspend the client's frame.  (In case we
		 ;; get out of sync, and a C-z sends a SIGTSTP to
		 ;; emacsclient.)
675
		 ((equal "-suspend" arg)
676
		  (let ((terminal (server-client-get client 'terminal)))
677
		    (setq dontkill t)
678 679
		    (when (eq (terminal-live-p terminal) t)
		      (suspend-tty terminal))))
680

Karoly Lorentey's avatar
Karoly Lorentey committed
681 682
		 ;; -ignore COMMENT:  Noop; useful for debugging emacsclient.
		 ;; (The given comment appears in the server log.)
683 684 685 686
		 ((and (equal "-ignore" arg) (string-match "\\([^ ]*\\) " request))
		  (setq dontkill t
			request (substring request (match-end 0))))

Karoly Lorentey's avatar
Karoly Lorentey committed
687
		 ;; -tty DEVICE-NAME TYPE:  Open a new tty frame at the client.
688 689 690 691
		 ((and (equal "-tty" arg) (string-match "\\([^ ]*\\) \\([^ ]*\\) " request))
		  (let ((tty (server-unquote-arg (match-string 1 request)))
			(type (server-unquote-arg (match-string 2 request))))
		    (setq request (substring request (match-end 0)))
Karoly Lorentey's avatar
Karoly Lorentey committed
692 693
		    (unless (server-client-get client 'version)
		      (error "Protocol error; make sure you use the correct version of emacsclient"))
694
		    (unless current-frame
695 696 697 698 699 700 701
		      (server-with-environment env
			  '("LANG" "LC_CTYPE" "LC_ALL"
			    ;; For tgetent(3); list according to ncurses(3).
			    "BAUDRATE" "COLUMNS" "ESCDELAY" "HOME" "LINES"
			    "NCURSES_ASSUMED_COLORS" "NCURSES_NO_PADDING"
			    "NCURSES_NO_SETBUF" "TERM" "TERMCAP" "TERMINFO"
			    "TERMINFO_DIRS" "TERMPATH")
702 703 704
			(setq frame (make-frame-on-tty tty type
						       ;; Ignore nowait here; we always need to clean
						       ;; up opened ttys when the client dies.
705 706
						       `((client . ,proc)
							 (environment . ,env)))))
707 708
		      (select-frame frame)
		      (server-client-set client 'frame frame)
709 710
		      (server-client-set client 'tty (terminal-name frame))
		      (server-client-set client 'terminal (frame-terminal frame))
711

712 713
		      ;; Display *scratch* by default.
		      (switch-to-buffer (get-buffer-create "*scratch*") 'norecord)
714
		      (if dir (setq default-directory dir))
715

716 717 718
		      ;; Reply with our pid.
		      (server-send-string proc (concat "-emacs-pid " (number-to-string (emacs-pid)) "\n"))
		      (setq dontkill t))))
Karoly Lorentey's avatar
Karoly Lorentey committed
719 720

		 ;; -position LINE:  Go to the given line in the next file.
721
		 ((and (equal "-position" arg) (string-match "\\(\\+[0-9]+\\) " request))
722 723
		  (setq lineno (string-to-number (substring (match-string 1 request) 1))
			request (substring request (match-end 0))))
724

Karoly Lorentey's avatar
Karoly Lorentey committed
725
		 ;; -position LINE:COLUMN:  Set point to the given position in the next file.
726
		 ((and (equal "-position" arg) (string-match "\\+\\([0-9]+\\):\\([0-9]+\\) " request))
727 728
		  (setq lineno (string-to-number (match-string 1 request))
			columnno (string-to-number (match-string 2 request))
729
			request (substring request (match-end 0))))
730

Karoly Lorentey's avatar
Karoly Lorentey committed
731
		 ;; -file FILENAME:  Load the given file.
732 733 734 735 736 737
		 ((and (equal "-file" arg) (string-match "\\([^ ]+\\) " request))
		  (let ((file (server-unquote-arg (match-string 1 request))))
		    (setq request (substring request (match-end 0)))
		    (if coding-system
			(setq file (decode-coding-string file coding-system)))
		    (setq file (command-line-normalize-file-name file))
738 739
		    (push (list file lineno columnno) files)
		    (server-log (format "New file: %s (%d:%d)" file lineno columnno) proc))
740 741 742
		  (setq lineno 1
			columnno 0))

Karoly Lorentey's avatar
Karoly Lorentey committed
743
		 ;; -eval EXPR:  Evaluate a Lisp expression.
744 745 746 747 748 749
		 ((and (equal "-eval" arg) (string-match "\\([^ ]+\\) " request))
		  (let ((expr (server-unquote-arg (match-string 1 request))))
		    (setq request (substring request (match-end 0)))
		    (if coding-system
			(setq expr (decode-coding-string expr coding-system)))
		    (let ((v (eval (car (read-from-string expr)))))
Karoly Lorentey's avatar
Karoly Lorentey committed
750
		      (when (and (not frame) v)
751 752 753
			(with-temp-buffer
			  (let ((standard-output (current-buffer)))
			    (pp v)
754 755 756 757 758
			    (server-send-string
			     proc (format "-print %s\n"
					  (server-quote-arg
					   (buffer-substring-no-properties (point-min)
									   (point-max)))))))))
759 760 761
		    (setq lineno 1
			  columnno 0)))

762 763 764
		 ;; -env NAME=VALUE:  An environment variable.
		 ((and (equal "-env" arg) (string-match "\\([^ ]+\\) " request))
		  (let ((var (server-unquote-arg (match-string 1 request))))
765
		    ;; XXX Variables should be encoded as in getenv/setenv.
Karoly Lorentey's avatar
Karoly Lorentey committed
766
		    (setq request (substring request (match-end 0)))
767
		    (setq env (cons var env))))
Karoly Lorentey's avatar
Karoly Lorentey committed
768

769 770 771 772 773 774 775 776
		 ;; -dir DIRNAME:  The cwd of the emacsclient process.
		 ((and (equal "-dir" arg) (string-match "\\([^ ]+\\) " request))
		  (setq dir (server-unquote-arg (match-string 1 request)))
		  (setq request (substring request (match-end 0)))
		  (if coding-system
		      (setq dir (decode-coding-string dir coding-system)))
		  (setq dir (command-line-normalize-file-name dir)))

777 778 779
		 ;; Unknown command.
		 (t (error "Unknown command: %s" arg)))))

780 781 782 783 784 785
	    (let (buffers)
	      (when files
		(run-hooks 'pre-command-hook)
		(setq buffers (server-visit-files files client nowait))
		(run-hooks 'post-command-hook))

786 787
	      (when frame
		(with-selected-frame frame
788
		  (display-startup-echo-area-message)
789
		  (unless inhibit-splash-screen
790 791 792 793 794 795 796 797 798
		    (condition-case err
			;; This looks scary because `fancy-splash-screens'
			;; will call `recursive-edit' from a process filter.
			;; However, that should be safe to do now.
			(display-splash-screen)
		      ;; `recursive-edit' will throw an error if Emacs is
		      ;; already doing a recursive edit elsewhere.  Catch it
		      ;; here so that we can finish normally.
		      (error nil)))))
799

800 801 802 803 804 805 806 807 808 809 810 811 812 813
	      ;; Delete the client if necessary.
	      (cond
	       (nowait
		;; Client requested nowait; return immediately.
		(server-log "Close nowait client" proc)
		(server-delete-client proc))
	       ((and (not dontkill) (null buffers))
		;; This client is empty; get rid of it immediately.
		(server-log "Close empty client" proc)
		(server-delete-client proc)))
	      (cond
	       ((or isearch-mode (minibufferp))
		nil)
	       ((and frame (null buffers))
814 815
		(message "%s" (substitute-command-keys
			       "When done with this frame, type \\[delete-frame]")))
816 817 818 819
	       ((not (null buffers))
		(server-switch-buffer (car buffers))
		(run-hooks 'server-switch-hook)
		(unless nowait
820 821
		  (message "%s" (substitute-command-keys
				 "When done with a buffer, type \\[server-edit]"))))))))
822

823 824 825 826 827
	;; Save for later any partial line that remains.
	(when (> (length string) 0)
	  (process-put proc 'previous-string string)))
    ;; condition-case
    (error (ignore-errors
828
	     (server-send-string
829
	      proc (concat "-error " (server-quote-arg (error-message-string err))))
830 831 832
	     (setq string "")
	     (server-log (error-message-string err) proc)
	     (delete-process proc)))))
root's avatar
root committed
833

834
(defun server-goto-line-column (file-line-col)
Karoly Lorentey's avatar
Karoly Lorentey committed
835 836 837
  "Move point to the position indicated in FILE-LINE-COL.
FILE-LINE-COL should be a three-element list as described in
`server-visit-files'."
838 839 840 841 842
  (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)))))

843
(defun server-visit-files (files client &optional nowait)
844
  "Find FILES and return a list of buffers created.
845
FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
Karoly Lorentey's avatar
Karoly Lorentey committed
846
CLIENT is the client that requested this operation.
847 848
NOWAIT non-nil means this client is not waiting for the results,
so don't mark these buffers specially, just visit them normally."
849
  ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
850
  (let ((last-nonmenu-event t) client-record)
851 852 853
    ;; 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.
854 855 856 857 858 859 860
    (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)))
861
	  (add-to-history 'file-name-history filen)
862 863 864 865 866 867 868
	  (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
Karoly Lorentey's avatar
Karoly Lorentey committed
869
			    (concat "File no longer exists: " filen
870 871
				    ", write buffer to file? "))
			   (write-file filen))))
872 873
		(unless server-buffer-clients
		  (setq server-existing-buffer t))
874 875 876 877 878 879 880
		(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)
881 882 883 884 885 886 887
	  (push (car client) server-buffer-clients))
	(push (current-buffer) client-record)))
    (unless nowait
      (server-client-set
       client 'buffers
       (nconc (server-client-get client 'buffers) client-record)))
    client-record))
root's avatar
root committed
888

889
(defun server-buffer-done (buffer &optional for-killing)
root's avatar
root committed
890
  "Mark BUFFER as \"done\" for its client(s).
891 892
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,
893 894 895
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'."
896
  (let ((next-buffer nil)
Karoly Lorentey's avatar
Karoly Lorentey committed
897 898 899
	(killed nil))
    (dolist (client server-clients)
      (let ((buffers (server-client-get client 'buffers)))
900
	(or next-buffer
Karoly Lorentey's avatar
Karoly Lorentey committed
901 902 903 904 905 906 907 908 909 910 911 912 913 914
	    (setq next-buffer (nth 1 (memq buffer buffers))))
	(when buffers			; Ignore bufferless clients.
	  (setq buffers (delq buffer buffers))
	  ;; Delete all dead buffers from CLIENT.
	  (dolist (b buffers)
	    (and (bufferp b)
		 (not (buffer-live-p b))
		 (setq buffers (delq b buffers))))
	  (server-client-set client 'buffers buffers)
	  ;; If client now has no pending buffers,
	  ;; tell it that it is done, and forget it entirely.
	  (unless buffers
	    (server-log "Close" client)
	    (server-delete-client client)))))
915
    (if (and (bufferp buffer) (buffer-name buffer))
916 917 918 919
	;; 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))
920
	  (with-current-buffer buffer
921 922
	    (setq server-buffer-clients nil)
	    (run-hooks 'server-done-hook))
923 924 925 926 927 928
	  ;; 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
929 930
	      (when (and (not killed)
			 server-kill-new-buffers
931 932
			 (with-current-buffer buffer
			   (not server-existing-buffer)))
933
		(setq killed t)
934
		(bury-buffer buffer)
935 936 937 938 939 940 941
		(kill-buffer buffer))
	      (unless killed
		(if (server-temp-file-p buffer)
		    (progn
		      (kill-buffer buffer)
		      (setq killed t))
		  (bury-buffer buffer)))))))
942
    (list next-buffer killed)))
root's avatar
root committed
943

944
(defun server-temp-file-p (&optional buffer)
root's avatar
root committed
945 946 947 948 949 950 951 952 953 954
  "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
955
  "Offer to save current buffer, mark it as \"done\" for clients.
956 957 958 959 960
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."
961 962 963 964 965 966 967 968 969 970 971 972
  (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))))
973

Richard M. Stallman's avatar
Richard M. Stallman committed
974 975 976 977
;; 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.
978
(defun server-kill-buffer-query-function ()
Karoly Lorentey's avatar
Karoly Lorentey committed
979
  "Ask before killing a server buffer."
980
  (or (not server-buffer-clients)
981 982
      (let ((res t))
	(dolist (proc server-buffer-clients res)
Karoly Lorentey's avatar
Karoly Lorentey committed
983 984 985
	  (let ((client (server-client proc)))
	    (when (and client (eq (process-status proc) 'open))
	      (setq res nil)))))
986 987 988 989
      (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
			   (buffer-name (current-buffer))))))

(defun server-kill-emacs-query-function ()
990
  "Ask before exiting Emacs it has live clients."
Karoly Lorentey's avatar
Karoly Lorentey committed
991 992 993 994 995 996 997
  (or (not server-clients)
      (let (live-client)
	(dolist (client server-clients live-client)
	  (if (memq t (mapcar 'buffer-live-p (server-client-get
					      client 'buffers)))
	      (setq live-client t))))
      (yes-or-no-p "This Emacs session has clients; exit anyway? ")))
998

999
(defvar server-kill-buffer-running nil
1000
  "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
1001