|
38412
|
1 ;;; server.el --- Lisp code for GNU Emacs running as server process
|
|
658
|
2
|
|
64762
|
3 ;; Copyright (C) 1986, 1987, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
|
|
|
4 ;; 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
|
|
844
|
5
|
|
787
|
6 ;; Author: William Sommerfeld <wesommer@athena.mit.edu>
|
|
17970
|
7 ;; Maintainer: FSF
|
|
814
|
8 ;; Keywords: processes
|
|
787
|
9
|
|
|
10 ;; Changes by peck@sun.com and by rms.
|
|
|
11
|
|
50
|
12 ;; This file is part of GNU Emacs.
|
|
|
13
|
|
|
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
|
|
|
15 ;; it under the terms of the GNU General Public License as published by
|
|
807
|
16 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
50
|
17 ;; any later version.
|
|
|
18
|
|
|
19 ;; GNU Emacs is distributed in the hope that it will be useful,
|
|
|
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
22 ;; GNU General Public License for more details.
|
|
|
23
|
|
|
24 ;; You should have received a copy of the GNU General Public License
|
|
14169
|
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
|
|
64091
|
26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
|
27 ;; Boston, MA 02110-1301, USA.
|
|
50
|
28
|
|
787
|
29 ;;; Commentary:
|
|
50
|
30
|
|
14169
|
31 ;; This Lisp code is run in Emacs when it is to operate as
|
|
|
32 ;; a server for other processes.
|
|
50
|
33
|
|
14169
|
34 ;; Load this library and do M-x server-edit to enable Emacs as a server.
|
|
47645
|
35 ;; Emacs opens up a socket for communication with clients. If there are no
|
|
|
36 ;; client buffers to edit, server-edit acts like (switch-to-buffer
|
|
|
37 ;; (other-buffer))
|
|
50
|
38
|
|
14169
|
39 ;; When some other program runs "the editor" to edit a file,
|
|
|
40 ;; "the editor" can be the Emacs client program ../lib-src/emacsclient.
|
|
|
41 ;; This program transmits the file names to Emacs through
|
|
|
42 ;; the server subprocess, and Emacs visits them and lets you edit them.
|
|
50
|
43
|
|
14169
|
44 ;; Note that any number of clients may dispatch files to emacs to be edited.
|
|
50
|
45
|
|
14169
|
46 ;; When you finish editing a Server buffer, again call server-edit
|
|
49206
|
47 ;; to mark that buffer as done for the client and switch to the next
|
|
|
48 ;; Server buffer. When all the buffers for a client have been edited
|
|
14169
|
49 ;; and exited with server-edit, the client "editor" will return
|
|
49206
|
50 ;; to the program that invoked it.
|
|
50
|
51
|
|
14169
|
52 ;; Your editing commands and Emacs's display output go to and from
|
|
|
53 ;; the terminal in the usual way. Thus, server operation is possible
|
|
|
54 ;; only when Emacs can talk to the terminal at the time you invoke
|
|
|
55 ;; the client. This is possible in four cases:
|
|
50
|
56
|
|
14169
|
57 ;; 1. On a window system, where Emacs runs in one window and the
|
|
|
58 ;; program that wants to use "the editor" runs in another.
|
|
50
|
59
|
|
14169
|
60 ;; 2. On a multi-terminal system, where Emacs runs on one terminal and the
|
|
|
61 ;; program that wants to use "the editor" runs on another.
|
|
50
|
62
|
|
14169
|
63 ;; 3. When the program that wants to use "the editor" is running
|
|
|
64 ;; as a subprocess of Emacs.
|
|
50
|
65
|
|
14169
|
66 ;; 4. On a system with job control, when Emacs is suspended, the program
|
|
|
67 ;; that wants to use "the editor" will stop and display
|
|
|
68 ;; "Waiting for Emacs...". It can then be suspended, and Emacs can be
|
|
|
69 ;; brought into the foreground for editing. When done editing, Emacs is
|
|
|
70 ;; suspended again, and the client program is brought into the foreground.
|
|
50
|
71
|
|
49206
|
72 ;; The buffer local variable "server-buffer-clients" lists
|
|
|
73 ;; the clients who are waiting for this buffer to be edited.
|
|
14169
|
74 ;; The global variable "server-clients" lists all the waiting clients,
|
|
|
75 ;; and which files are yet to be edited for each.
|
|
787
|
76
|
|
|
77 ;;; Code:
|
|
47517
|
78
|
|
|
79 (eval-when-compile (require 'cl))
|
|
|
80
|
|
19418
|
81 (defgroup server nil
|
|
|
82 "Emacs running as a server process."
|
|
|
83 :group 'external)
|
|
50
|
84
|
|
47612
|
85 (defcustom server-visit-hook nil
|
|
|
86 "*Hook run when visiting a file for the Emacs server."
|
|
19418
|
87 :group 'server
|
|
47612
|
88 :type 'hook)
|
|
50
|
89
|
|
19418
|
90 (defcustom server-switch-hook nil
|
|
47612
|
91 "*Hook run when switching to a buffer for the Emacs server."
|
|
19418
|
92 :group 'server
|
|
47612
|
93 :type 'hook)
|
|
19418
|
94
|
|
|
95 (defcustom server-done-hook nil
|
|
47612
|
96 "*Hook run when done editing a buffer for the Emacs server."
|
|
19418
|
97 :group 'server
|
|
47612
|
98 :type 'hook)
|
|
7597
|
99
|
|
49206
|
100 (defvar server-process nil
|
|
|
101 "The current server process.")
|
|
50
|
102
|
|
|
103 (defvar server-clients nil
|
|
|
104 "List of current server clients.
|
|
7736
|
105 Each element is (CLIENTID BUFFERS...) where CLIENTID is a string
|
|
50
|
106 that can be given to the server process to identify a client.
|
|
|
107 When a buffer is marked as \"done\", it is removed from this list.")
|
|
|
108
|
|
|
109 (defvar server-buffer-clients nil
|
|
38010
|
110 "List of client ids for clients requesting editing of current buffer.")
|
|
6176
|
111 (make-variable-buffer-local 'server-buffer-clients)
|
|
50
|
112 ;; Changing major modes should not erase this local.
|
|
|
113 (put 'server-buffer-clients 'permanent-local t)
|
|
|
114
|
|
49267
|
115 (defcustom server-window nil
|
|
|
116 "*Specification of the window to use for selecting Emacs server buffers.
|
|
3661
|
117 If nil, use the selected window.
|
|
49267
|
118 If it is a function, it should take one argument (a buffer) and
|
|
|
119 display and select it. A common value is `pop-to-buffer'.
|
|
|
120 If it is a window, use that.
|
|
48123
|
121 If it is a frame, use the frame's selected window.
|
|
49267
|
122
|
|
|
123 It is not meaningful to set this to a specific frame or window with Custom.
|
|
|
124 Only programs can do so."
|
|
|
125 :group 'server
|
|
59996
|
126 :version "22.1"
|
|
49267
|
127 :type '(choice (const :tag "Use selected window"
|
|
|
128 :match (lambda (widget value)
|
|
|
129 (not (functionp value)))
|
|
|
130 nil)
|
|
|
131 (function-item :tag "Use pop-to-buffer" pop-to-buffer)
|
|
|
132 (function :tag "Other function")))
|
|
3661
|
133
|
|
19418
|
134 (defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
|
|
49267
|
135 "*Regexp matching names of temporary files.
|
|
|
136 These are deleted and reused after each edit by the programs that
|
|
|
137 invoke the Emacs server."
|
|
19418
|
138 :group 'server
|
|
|
139 :type 'regexp)
|
|
50
|
140
|
|
31008
|
141 (defcustom server-kill-new-buffers t
|
|
|
142 "*Whether to kill buffers when done with them.
|
|
|
143 If non-nil, kill a buffer unless it already existed before editing
|
|
49206
|
144 it with Emacs server. If nil, kill only buffers as specified by
|
|
31008
|
145 `server-temp-file-regexp'.
|
|
|
146 Please note that only buffers are killed that still have a client,
|
|
|
147 i.e. buffers visited which \"emacsclient --no-wait\" are never killed in
|
|
|
148 this way."
|
|
|
149 :group 'server
|
|
|
150 :type 'boolean
|
|
|
151 :version "21.1")
|
|
|
152
|
|
50
|
153 (or (assq 'server-buffer-clients minor-mode-alist)
|
|
|
154 (setq minor-mode-alist (cons '(server-buffer-clients " Server") minor-mode-alist)))
|
|
|
155
|
|
31008
|
156 (defvar server-existing-buffer nil
|
47524
95ba2ac51138
(server-done): Fix harmlessly wrong arg to save-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
157 "Non-nil means the buffer existed before the server was asked to visit it.
|
40915
e26c1e76e1ca
(server-buffer-done): Test of server-existing-buffer was backwards.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
158 This means that the server should not kill the buffer when you say you
|
47524
95ba2ac51138
(server-done): Fix harmlessly wrong arg to save-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
159 are done with it in the server.")
|
|
31008
|
160 (make-variable-buffer-local 'server-existing-buffer)
|
|
|
161
|
|
54357
|
162 (defvar server-name "server")
|
|
|
163
|
|
|
164 (defvar server-socket-dir
|
|
|
165 (format "/tmp/emacs%d" (user-uid)))
|
|
47612
|
166
|
|
47517
|
167 (defun server-log (string &optional client)
|
|
49267
|
168 "If a *server* buffer exists, write STRING to it for logging purposes."
|
|
50
|
169 (if (get-buffer "*server*")
|
|
47517
|
170 (with-current-buffer "*server*"
|
|
50
|
171 (goto-char (point-max))
|
|
47517
|
172 (insert (current-time-string)
|
|
47612
|
173 (if client (format " %s:" client) " ")
|
|
47517
|
174 string)
|
|
13468
|
175 (or (bolp) (newline)))))
|
|
50
|
176
|
|
|
177 (defun server-sentinel (proc msg)
|
|
48123
|
178 (let ((client (assq proc server-clients)))
|
|
47612
|
179 ;; Remove PROC from the list of clients.
|
|
48123
|
180 (when client
|
|
|
181 (setq server-clients (delq client server-clients))
|
|
|
182 (dolist (buf (cdr client))
|
|
|
183 (with-current-buffer buf
|
|
|
184 ;; Remove PROC from the clients of each buffer.
|
|
|
185 (setq server-buffer-clients (delq proc server-buffer-clients))
|
|
|
186 ;; Kill the buffer if necessary.
|
|
|
187 (when (and (null server-buffer-clients)
|
|
|
188 (or (and server-kill-new-buffers
|
|
|
189 (not server-existing-buffer))
|
|
|
190 (server-temp-file-p)))
|
|
|
191 (kill-buffer (current-buffer)))))))
|
|
47612
|
192 (server-log (format "Status changed to %s" (process-status proc)) proc))
|
|
|
193
|
|
47645
|
194 (defun server-select-display (display)
|
|
|
195 ;; If the current frame is on `display' we're all set.
|
|
|
196 (unless (equal (frame-parameter (selected-frame) 'display) display)
|
|
|
197 ;; Otherwise, look for an existing frame there and select it.
|
|
|
198 (dolist (frame (frame-list))
|
|
|
199 (when (equal (frame-parameter frame 'display) display)
|
|
|
200 (select-frame frame)))
|
|
|
201 ;; If there's no frame on that display yet, create a dummy one
|
|
|
202 ;; and select it.
|
|
|
203 (unless (equal (frame-parameter (selected-frame) 'display) display)
|
|
|
204 (select-frame
|
|
|
205 (make-frame-on-display
|
|
|
206 display
|
|
|
207 ;; This frame is only there in place of an actual "current display"
|
|
|
208 ;; setting, so we want it to be as unobtrusive as possible. That's
|
|
|
209 ;; what the invisibility is for. The minibuffer setting is so that
|
|
|
210 ;; we don't end up displaying a buffer in it (which noone would
|
|
|
211 ;; notice).
|
|
|
212 '((visibility . nil) (minibuffer . only)))))))
|
|
|
213
|
|
47612
|
214 (defun server-unquote-arg (arg)
|
|
|
215 (replace-regexp-in-string
|
|
|
216 "&." (lambda (s)
|
|
|
217 (case (aref s 1)
|
|
|
218 (?& "&")
|
|
|
219 (?- "-")
|
|
|
220 (?n "\n")
|
|
|
221 (t " ")))
|
|
|
222 arg t t))
|
|
50
|
223
|
50567
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
224 (defun server-ensure-safe-dir (dir)
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
225 "Make sure DIR is a directory with no race-condition issues.
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
226 Creates the directory if necessary and makes sure:
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
227 - there's no symlink involved
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
228 - it's owned by us
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
229 - it's not readable/writable by anybody else."
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
230 (setq dir (directory-file-name dir))
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
231 (let ((attrs (file-attributes dir)))
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
232 (unless attrs
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
233 (letf (((default-file-modes) ?\700)) (make-directory dir))
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
234 (setq attrs (file-attributes dir)))
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
235 ;; Check that it's safe for use.
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
236 (unless (and (eq t (car attrs)) (eq (nth 2 attrs) (user-uid))
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
237 (zerop (logand ?\077 (file-modes dir))))
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
238 (error "The directory %s is unsafe" dir))))
|
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
239
|
|
256
|
240 ;;;###autoload
|
|
50
|
241 (defun server-start (&optional leave-dead)
|
|
|
242 "Allow this Emacs process to be a server for client processes.
|
|
|
243 This starts a server communications subprocess through which
|
|
|
244 client \"editors\" can send your editing commands to this Emacs job.
|
|
7855
|
245 To use the server, set up the program `emacsclient' in the
|
|
50
|
246 Emacs distribution as your standard \"editor\".
|
|
|
247
|
|
|
248 Prefix arg means just kill any existing server communications subprocess."
|
|
|
249 (interactive "P")
|
50567
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
250 ;; Make sure there is a safe directory in which to place the socket.
|
|
54357
|
251 (server-ensure-safe-dir server-socket-dir)
|
|
50
|
252 ;; kill it dead!
|
|
52045
|
253 (if server-process
|
|
|
254 (condition-case () (delete-process server-process) (error nil)))
|
|
16789
|
255 ;; Delete the socket files made by previous server invocations.
|
|
54357
|
256 (condition-case ()
|
|
|
257 (delete-file (expand-file-name server-name server-socket-dir))
|
|
|
258 (error nil))
|
|
16789
|
259 ;; If this Emacs already had a server, clear out associated status.
|
|
50
|
260 (while server-clients
|
|
|
261 (let ((buffer (nth 1 (car server-clients))))
|
|
|
262 (server-buffer-done buffer)))
|
|
47517
|
263 (unless leave-dead
|
|
50
|
264 (if server-process
|
|
|
265 (server-log (message "Restarting server")))
|
|
50568
|
266 (letf (((default-file-modes) ?\700))
|
|
|
267 (setq server-process
|
|
|
268 (make-network-process
|
|
|
269 :name "server" :family 'local :server t :noquery t
|
|
54357
|
270 :service (expand-file-name server-name server-socket-dir)
|
|
50568
|
271 :sentinel 'server-sentinel :filter 'server-process-filter
|
|
|
272 ;; We must receive file names without being decoded.
|
|
|
273 ;; Those are decoded by server-process-filter according
|
|
|
274 ;; to file-name-coding-system.
|
|
|
275 :coding 'raw-text)))))
|
|
49267
|
276
|
|
|
277 ;;;###autoload
|
|
|
278 (define-minor-mode server-mode
|
|
|
279 "Toggle Server mode.
|
|
|
280 With ARG, turn Server mode on if ARG is positive, off otherwise.
|
|
|
281 Server mode runs a process that accepts commands from the
|
|
|
282 `emacsclient' program. See `server-start' and Info node `Emacs server'."
|
|
|
283 :global t
|
|
|
284 :group 'server
|
|
59996
|
285 :version "22.1"
|
|
49267
|
286 ;; Fixme: Should this check for an existing server socket and do
|
|
|
287 ;; nothing if there is one (for multiple Emacs sessions)?
|
|
|
288 (server-start (not server-mode)))
|
|
50
|
289
|
|
|
290 (defun server-process-filter (proc string)
|
|
49267
|
291 "Process a request from the server to edit some files.
|
|
|
292 PROC is the server process. Format of STRING is \"PATH PATH PATH... \\n\"."
|
|
47612
|
293 (server-log string proc)
|
|
49686
|
294 (let ((prev (process-get proc 'previous-string)))
|
|
|
295 (when prev
|
|
|
296 (setq string (concat prev string))
|
|
|
297 (process-put proc 'previous-string nil)))
|
|
10281
|
298 ;; If the input is multiple lines,
|
|
|
299 ;; process each line individually.
|
|
|
300 (while (string-match "\n" string)
|
|
|
301 (let ((request (substring string 0 (match-beginning 0)))
|
|
24474
|
302 (coding-system (and default-enable-multibyte-characters
|
|
|
303 (or file-name-coding-system
|
|
|
304 default-file-name-coding-system)))
|
|
47645
|
305 client nowait eval
|
|
50
|
306 (files nil)
|
|
38462
|
307 (lineno 1)
|
|
54431
|
308 (tmp-frame nil) ; Sometimes used to embody the selected display.
|
|
38462
|
309 (columnno 0))
|
|
10281
|
310 ;; Remove this line from STRING.
|
|
47612
|
311 (setq string (substring string (match-end 0)))
|
|
|
312 (setq client (cons proc nil))
|
|
|
313 (while (string-match "[^ ]* " request)
|
50567
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
314 (let ((arg (substring request (match-beginning 0) (1- (match-end 0)))))
|
|
47612
|
315 (setq request (substring request (match-end 0)))
|
|
|
316 (cond
|
|
|
317 ((equal "-nowait" arg) (setq nowait t))
|
50567
1b32397dd4e2
(server-socket-name): Use new safe location for socket.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
318 ((equal "-eval" arg) (setq eval t))
|
|
47645
|
319 ((and (equal "-display" arg) (string-match "\\([^ ]*\\) " request))
|
|
|
320 (let ((display (server-unquote-arg (match-string 1 request))))
|
|
|
321 (setq request (substring request (match-end 0)))
|
|
|
322 (condition-case err
|
|
54431
|
323 (setq tmp-frame (server-select-display display))
|
|
47645
|
324 (error (process-send-string proc (nth 1 err))
|
|
|
325 (setq request "")))))
|
|
47612
|
326 ;; ARG is a line number option.
|
|
|
327 ((string-match "\\`\\+[0-9]+\\'" arg)
|
|
62402
|
328 (setq lineno (string-to-number (substring arg 1))))
|
|
47612
|
329 ;; ARG is line number:column option.
|
|
|
330 ((string-match "\\`+\\([0-9]+\\):\\([0-9]+\\)\\'" arg)
|
|
62402
|
331 (setq lineno (string-to-number (match-string 1 arg))
|
|
|
332 columnno (string-to-number (match-string 2 arg))))
|
|
47612
|
333 (t
|
|
|
334 ;; Undo the quoting that emacsclient does
|
|
|
335 ;; for certain special characters.
|
|
|
336 (setq arg (server-unquote-arg arg))
|
|
|
337 ;; Now decode the file name if necessary.
|
|
|
338 (if coding-system
|
|
|
339 (setq arg (decode-coding-string arg coding-system)))
|
|
47645
|
340 (if eval
|
|
|
341 (let ((v (eval (car (read-from-string arg)))))
|
|
|
342 (when v
|
|
|
343 (with-temp-buffer
|
|
|
344 (let ((standard-output (current-buffer)))
|
|
|
345 (pp v)
|
|
57379
|
346 ;; Suppress the error rose when the pipe to PROC is closed.
|
|
|
347 (condition-case err
|
|
|
348 (process-send-region proc (point-min) (point-max))
|
|
59220
|
349 (file-error nil)
|
|
|
350 (error nil))
|
|
57379
|
351 ))))
|
|
47645
|
352 ;; ARG is a file name.
|
|
|
353 ;; Collapse multiple slashes to single slashes.
|
|
|
354 (setq arg (command-line-normalize-file-name arg))
|
|
|
355 (push (list arg lineno columnno) files))
|
|
47612
|
356 (setq lineno 1)
|
|
|
357 (setq columnno 0)))))
|
|
|
358 (when files
|
|
|
359 (run-hooks 'pre-command-hook)
|
|
|
360 (server-visit-files files client nowait)
|
|
|
361 (run-hooks 'post-command-hook))
|
|
|
362 ;; CLIENT is now a list (CLIENTNUM BUFFERS...)
|
|
|
363 (if (null (cdr client))
|
|
|
364 ;; This client is empty; get rid of it immediately.
|
|
|
365 (progn
|
|
|
366 (delete-process proc)
|
|
|
367 (server-log "Close empty client" proc))
|
|
|
368 ;; We visited some buffer for this client.
|
|
|
369 (or nowait (push client server-clients))
|
|
49206
|
370 (unless (or isearch-mode (minibufferp))
|
|
49187
|
371 (server-switch-buffer (nth 1 client))
|
|
|
372 (run-hooks 'server-switch-hook)
|
|
|
373 (unless nowait
|
|
65582
|
374 (message "%s" (substitute-command-keys
|
|
54431
|
375 "When done with a buffer, type \\[server-edit]")))))
|
|
|
376 ;; Avoid preserving the connection after the last real frame is deleted.
|
|
|
377 (if tmp-frame (delete-frame tmp-frame))))
|
|
10281
|
378 ;; Save for later any partial line that remains.
|
|
47612
|
379 (when (> (length string) 0)
|
|
49686
|
380 (process-put proc 'previous-string string)))
|
|
50
|
381
|
|
46907
|
382 (defun server-goto-line-column (file-line-col)
|
|
|
383 (goto-line (nth 1 file-line-col))
|
|
|
384 (let ((column-number (nth 2 file-line-col)))
|
|
|
385 (if (> column-number 0)
|
|
|
386 (move-to-column (1- column-number)))))
|
|
|
387
|
|
15956
|
388 (defun server-visit-files (files client &optional nowait)
|
|
47645
|
389 "Find FILES and return the list CLIENT with the buffers nconc'd.
|
|
38462
|
390 FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
|
|
15956
|
391 NOWAIT non-nil means this client is not waiting for the results,
|
|
|
392 so don't mark these buffers specially, just visit them normally."
|
|
7736
|
393 ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
|
|
47645
|
394 (let ((last-nonmenu-event t) client-record)
|
|
4500
|
395 ;; Restore the current buffer afterward, but not using save-excursion,
|
|
|
396 ;; because we don't want to save point in this buffer
|
|
|
397 ;; if it happens to be one of those specified by the server.
|
|
47645
|
398 (save-current-buffer
|
|
|
399 (dolist (file files)
|
|
|
400 ;; If there is an existing buffer modified or the file is
|
|
|
401 ;; modified, revert it. If there is an existing buffer with
|
|
|
402 ;; deleted file, offer to write it.
|
|
|
403 (let* ((filen (car file))
|
|
|
404 (obuf (get-file-buffer filen)))
|
|
|
405 (push filen file-name-history)
|
|
|
406 (if (and obuf (set-buffer obuf))
|
|
|
407 (progn
|
|
|
408 (cond ((file-exists-p filen)
|
|
|
409 (if (not (verify-visited-file-modtime obuf))
|
|
|
410 (revert-buffer t nil)))
|
|
|
411 (t
|
|
|
412 (if (y-or-n-p
|
|
|
413 (concat "File no longer exists: "
|
|
|
414 filen
|
|
|
415 ", write buffer to file? "))
|
|
|
416 (write-file filen))))
|
|
|
417 (setq server-existing-buffer t)
|
|
|
418 (server-goto-line-column file))
|
|
|
419 (set-buffer (find-file-noselect filen))
|
|
|
420 (server-goto-line-column file)
|
|
|
421 (run-hooks 'server-visit-hook)))
|
|
|
422 (unless nowait
|
|
|
423 ;; When the buffer is killed, inform the clients.
|
|
|
424 (add-hook 'kill-buffer-hook 'server-kill-buffer nil t)
|
|
|
425 (push (car client) server-buffer-clients))
|
|
|
426 (push (current-buffer) client-record)))
|
|
50
|
427 (nconc client client-record)))
|
|
|
428
|
|
17712
|
429 (defun server-buffer-done (buffer &optional for-killing)
|
|
50
|
430 "Mark BUFFER as \"done\" for its client(s).
|
|
10961
|
431 This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED).
|
|
|
432 NEXT-BUFFER is another server buffer, as a suggestion for what to select next,
|
|
47517
|
433 or nil. KILLED is t if we killed BUFFER (typically, because it was visiting
|
|
|
434 a temp file).
|
|
|
435 FOR-KILLING if non-nil indicates that we are called from `kill-buffer'."
|
|
47612
|
436 (let ((next-buffer nil)
|
|
10961
|
437 (killed nil)
|
|
50
|
438 (old-clients server-clients))
|
|
|
439 (while old-clients
|
|
|
440 (let ((client (car old-clients)))
|
|
47517
|
441 (or next-buffer
|
|
50
|
442 (setq next-buffer (nth 1 (memq buffer client))))
|
|
|
443 (delq buffer client)
|
|
10281
|
444 ;; Delete all dead buffers from CLIENT.
|
|
|
445 (let ((tail client))
|
|
|
446 (while tail
|
|
|
447 (and (bufferp (car tail))
|
|
|
448 (null (buffer-name (car tail)))
|
|
|
449 (delq (car tail) client))
|
|
|
450 (setq tail (cdr tail))))
|
|
50
|
451 ;; If client now has no pending buffers,
|
|
|
452 ;; tell it that it is done, and forget it entirely.
|
|
47612
|
453 (unless (cdr client)
|
|
|
454 (delete-process (car client))
|
|
|
455 (server-log "Close" (car client))
|
|
50
|
456 (setq server-clients (delq client server-clients))))
|
|
|
457 (setq old-clients (cdr old-clients)))
|
|
10281
|
458 (if (and (bufferp buffer) (buffer-name buffer))
|
|
21941
|
459 ;; We may or may not kill this buffer;
|
|
|
460 ;; if we do, do not call server-buffer-done recursively
|
|
|
461 ;; from kill-buffer-hook.
|
|
|
462 (let ((server-kill-buffer-running t))
|
|
48123
|
463 (with-current-buffer buffer
|
|
7597
|
464 (setq server-buffer-clients nil)
|
|
|
465 (run-hooks 'server-done-hook))
|
|
21941
|
466 ;; Notice whether server-done-hook killed the buffer.
|
|
|
467 (if (null (buffer-name buffer))
|
|
|
468 (setq killed t)
|
|
|
469 ;; Don't bother killing or burying the buffer
|
|
|
470 ;; when we are called from kill-buffer.
|
|
|
471 (unless for-killing
|
|
31008
|
472 (when (and (not killed)
|
|
|
473 server-kill-new-buffers
|
40915
e26c1e76e1ca
(server-buffer-done): Test of server-existing-buffer was backwards.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
474 (with-current-buffer buffer
|
e26c1e76e1ca
(server-buffer-done): Test of server-existing-buffer was backwards.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
475 (not server-existing-buffer)))
|
|
31008
|
476 (setq killed t)
|
|
34685
|
477 (bury-buffer buffer)
|
|
31008
|
478 (kill-buffer buffer))
|
|
|
479 (unless killed
|
|
|
480 (if (server-temp-file-p buffer)
|
|
|
481 (progn
|
|
|
482 (kill-buffer buffer)
|
|
|
483 (setq killed t))
|
|
|
484 (bury-buffer buffer)))))))
|
|
10961
|
485 (list next-buffer killed)))
|
|
50
|
486
|
|
48123
|
487 (defun server-temp-file-p (&optional buffer)
|
|
50
|
488 "Return non-nil if BUFFER contains a file considered temporary.
|
|
|
489 These are files whose names suggest they are repeatedly
|
|
|
490 reused to pass information to another program.
|
|
|
491
|
|
|
492 The variable `server-temp-file-regexp' controls which filenames
|
|
|
493 are considered temporary."
|
|
|
494 (and (buffer-file-name buffer)
|
|
|
495 (string-match server-temp-file-regexp (buffer-file-name buffer))))
|
|
|
496
|
|
|
497 (defun server-done ()
|
|
1540
|
498 "Offer to save current buffer, mark it as \"done\" for clients.
|
|
40972
|
499 This kills or buries the buffer, then returns a list
|
|
|
500 of the form (NEXT-BUFFER KILLED). NEXT-BUFFER is another server buffer,
|
|
|
501 as a suggestion for what to select next, or nil.
|
|
|
502 KILLED is t if we killed BUFFER, which happens if it was created
|
|
|
503 specifically for the clients and did not exist before their request for it."
|
|
48123
|
504 (when server-buffer-clients
|
|
|
505 (if (server-temp-file-p)
|
|
|
506 ;; For a temp file, save, and do make a non-numeric backup
|
|
|
507 ;; (unless make-backup-files is nil).
|
|
|
508 (let ((version-control nil)
|
|
|
509 (buffer-backed-up nil))
|
|
|
510 (save-buffer))
|
|
|
511 (if (and (buffer-modified-p)
|
|
|
512 buffer-file-name
|
|
|
513 (y-or-n-p (concat "Save file " buffer-file-name "? ")))
|
|
|
514 (save-buffer)))
|
|
|
515 (server-buffer-done (current-buffer))))
|
|
6176
|
516
|
|
9883
|
517 ;; Ask before killing a server buffer.
|
|
|
518 ;; It was suggested to release its client instead,
|
|
|
519 ;; but I think that is dangerous--the client would proceed
|
|
|
520 ;; using whatever is on disk in that file. -- rms.
|
|
6993
|
521 (defun server-kill-buffer-query-function ()
|
|
|
522 (or (not server-buffer-clients)
|
|
|
523 (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
|
|
|
524 (buffer-name (current-buffer))))))
|
|
|
525
|
|
6176
|
526 (add-hook 'kill-buffer-query-functions
|
|
6993
|
527 'server-kill-buffer-query-function)
|
|
6176
|
528
|
|
6993
|
529 (defun server-kill-emacs-query-function ()
|
|
7736
|
530 (let (live-client
|
|
|
531 (tail server-clients))
|
|
|
532 ;; See if any clients have any buffers that are still alive.
|
|
|
533 (while tail
|
|
|
534 (if (memq t (mapcar 'stringp (mapcar 'buffer-name (cdr (car tail)))))
|
|
|
535 (setq live-client t))
|
|
|
536 (setq tail (cdr tail)))
|
|
|
537 (or (not live-client)
|
|
|
538 (yes-or-no-p "Server buffers still have clients; exit anyway? "))))
|
|
6993
|
539
|
|
|
540 (add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
|
|
17712
|
541
|
|
18049
|
542 (defvar server-kill-buffer-running nil
|
|
21941
|
543 "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
|
|
18049
|
544
|
|
17712
|
545 (defun server-kill-buffer ()
|
|
18049
|
546 ;; Prevent infinite recursion if user has made server-done-hook
|
|
|
547 ;; call kill-buffer.
|
|
|
548 (or server-kill-buffer-running
|
|
21941
|
549 (and server-buffer-clients
|
|
|
550 (let ((server-kill-buffer-running t))
|
|
|
551 (when server-process
|
|
|
552 (server-buffer-done (current-buffer) t))))))
|
|
50
|
553
|
|
|
554 (defun server-edit (&optional arg)
|
|
|
555 "Switch to next server editing buffer; say \"Done\" for current buffer.
|
|
|
556 If a server buffer is current, it is marked \"done\" and optionally saved.
|
|
40972
|
557 The buffer is also killed if it did not exist before the clients asked for it.
|
|
50
|
558 When all of a client's buffers are marked as \"done\", the client is notified.
|
|
|
559
|
|
|
560 Temporary files such as MH <draft> files are always saved and backed up,
|
|
4096
|
561 no questions asked. (The variable `make-backup-files', if nil, still
|
|
|
562 inhibits a backup; you can set it locally in a particular buffer to
|
|
|
563 prevent a backup for it.) The variable `server-temp-file-regexp' controls
|
|
50
|
564 which filenames are considered temporary.
|
|
|
565
|
|
49206
|
566 If invoked with a prefix argument, or if there is no server process running,
|
|
50
|
567 starts server process and that is all. Invoked by \\[server-edit]."
|
|
|
568 (interactive "P")
|
|
|
569 (if (or arg
|
|
|
570 (not server-process)
|
|
|
571 (memq (process-status server-process) '(signal exit)))
|
|
|
572 (server-start nil)
|
|
10961
|
573 (apply 'server-switch-buffer (server-done))))
|
|
50
|
574
|
|
11329
|
575 (defun server-switch-buffer (&optional next-buffer killed-one)
|
|
50
|
576 "Switch to another buffer, preferably one that has a client.
|
|
|
577 Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
|
|
10961
|
578 ;; KILLED-ONE is t in a recursive call
|
|
|
579 ;; if we have already killed one temp-file server buffer.
|
|
|
580 ;; This means we should avoid the final "switch to some other buffer"
|
|
|
581 ;; since we've already effectively done that.
|
47524
95ba2ac51138
(server-done): Fix harmlessly wrong arg to save-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
582 (if (null next-buffer)
|
95ba2ac51138
(server-done): Fix harmlessly wrong arg to save-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
583 (if server-clients
|
95ba2ac51138
(server-done): Fix harmlessly wrong arg to save-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
584 (server-switch-buffer (nth 1 (car server-clients)) killed-one)
|
|
47612
|
585 (unless (or killed-one (window-dedicated-p (selected-window)))
|
|
48069
|
586 (switch-to-buffer (other-buffer))
|
|
|
587 (message "No server buffers remain to edit")))
|
47524
95ba2ac51138
(server-done): Fix harmlessly wrong arg to save-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
588 (if (not (buffer-name next-buffer))
|
95ba2ac51138
(server-done): Fix harmlessly wrong arg to save-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
589 ;; If NEXT-BUFFER is a dead buffer, remove the server records for it
|
|
50
|
590 ;; and try the next surviving server buffer.
|
47524
95ba2ac51138
(server-done): Fix harmlessly wrong arg to save-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
591 (apply 'server-switch-buffer (server-buffer-done next-buffer))
|
95ba2ac51138
(server-done): Fix harmlessly wrong arg to save-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
592 ;; OK, we know next-buffer is live, let's display and select it.
|
|
48123
|
593 (if (functionp server-window)
|
|
|
594 (funcall server-window next-buffer)
|
|
|
595 (let ((win (get-buffer-window next-buffer 0)))
|
|
|
596 (if (and win (not server-window))
|
|
|
597 ;; The buffer is already displayed: just reuse the window.
|
|
|
598 (let ((frame (window-frame win)))
|
|
|
599 (if (eq (frame-visible-p frame) 'icon)
|
|
|
600 (raise-frame frame))
|
|
|
601 (select-window win)
|
|
|
602 (set-buffer next-buffer))
|
|
|
603 ;; Otherwise, let's find an appropriate window.
|
|
|
604 (cond ((and (windowp server-window)
|
|
|
605 (window-live-p server-window))
|
|
|
606 (select-window server-window))
|
|
|
607 ((framep server-window)
|
|
|
608 (if (not (frame-live-p server-window))
|
|
|
609 (setq server-window (make-frame)))
|
|
|
610 (select-window (frame-selected-window server-window))))
|
|
|
611 (if (window-minibuffer-p (selected-window))
|
|
|
612 (select-window (next-window nil 'nomini 0)))
|
|
|
613 ;; Move to a non-dedicated window, if we have one.
|
|
|
614 (when (window-dedicated-p (selected-window))
|
|
|
615 (select-window
|
|
|
616 (get-window-with-predicate
|
|
|
617 (lambda (w)
|
|
|
618 (and (not (window-dedicated-p w))
|
|
|
619 (equal (frame-parameter (window-frame w) 'display)
|
|
|
620 (frame-parameter (selected-frame) 'display))))
|
|
|
621 'nomini 'visible (selected-window))))
|
|
|
622 (condition-case nil
|
|
|
623 (switch-to-buffer next-buffer)
|
|
|
624 ;; After all the above, we might still have ended up with
|
|
|
625 ;; a minibuffer/dedicated-window (if there's no other).
|
|
|
626 (error (pop-to-buffer next-buffer)))))))))
|
|
50
|
627
|
64372
5cedf2e32893
Bind "C-x #" in a way that works even if C-x is redefined to a command key,
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
628 (define-key ctl-x-map "#" 'server-edit)
|
|
42140
|
629
|
|
|
630 (defun server-unload-hook ()
|
|
49267
|
631 (server-start t)
|
|
42140
|
632 (remove-hook 'kill-buffer-query-functions 'server-kill-buffer-query-function)
|
|
|
633 (remove-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
|
|
|
634 (remove-hook 'kill-buffer-hook 'server-kill-buffer))
|
|
57543
|
635
|
|
|
636 (add-hook 'server-unload-hook 'server-unload-hook)
|
|
1079
|
637
|
|
|
638 (provide 'server)
|
|
658
|
639
|
|
52401
|
640 ;;; arch-tag: 1f7ecb42-f00a-49f8-906d-61995d84c8d6
|
|
658
|
641 ;;; server.el ends here
|
