1 ;;; server.el --- Lisp code for GNU Emacs running as server process
3 ;; Copyright (C) 1986, 1987, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
6 ;; Author: William Sommerfeld <wesommer@athena.mit.edu>
10 ;; Changes by peck@sun.com and by rms.
12 ;; This file is part of GNU Emacs.
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
16 ;; the Free Software Foundation; either version 2, or (at your option)
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.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27 ;; Boston, MA 02110-1301, USA.
31 ;; This Lisp code is run in Emacs when it is to operate as
32 ;; a server for other processes.
34 ;; Load this library and do M-x server-edit to enable Emacs as a server.
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
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.
44 ;; Note that any number of clients may dispatch files to emacs to be edited.
46 ;; When you finish editing a Server buffer, again call server-edit
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
49 ;; and exited with server-edit, the client "editor" will return
50 ;; to the program that invoked it.
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:
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.
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.
63 ;; 3. When the program that wants to use "the editor" is running
64 ;; as a subprocess of Emacs.
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.
72 ;; The buffer local variable "server-buffer-clients" lists
73 ;; the clients who are waiting for this buffer to be edited.
74 ;; The global variable "server-clients" lists all the waiting clients,
75 ;; and which files are yet to be edited for each.
79 (eval-when-compile (require 'cl
))
82 "Emacs running as a server process."
85 (defcustom server-visit-hook nil
86 "*Hook run when visiting a file for the Emacs server."
90 (defcustom server-switch-hook nil
91 "*Hook run when switching to a buffer for the Emacs server."
95 (defcustom server-done-hook nil
96 "*Hook run when done editing a buffer for the Emacs server."
100 (defvar server-process nil
101 "The current server process.")
103 (defvar server-clients nil
104 "List of current server clients.
105 Each element is (CLIENTID BUFFERS...) where CLIENTID is a string
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.")
109 (defvar server-buffer-clients nil
110 "List of client ids for clients requesting editing of current buffer.")
111 (make-variable-buffer-local 'server-buffer-clients
)
112 ;; Changing major modes should not erase this local.
113 (put 'server-buffer-clients
'permanent-local t
)
115 (defcustom server-window nil
116 "*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
119 display and select it. A common value is `pop-to-buffer'.
120 If it is a window, use that.
121 If it is a frame, use the frame's selected window.
123 It is not meaningful to set this to a specific frame or window with Custom.
124 Only programs can do so."
127 :type
'(choice (const :tag
"Use selected window"
128 :match
(lambda (widget value
)
129 (not (functionp value
)))
131 (function-item :tag
"Use pop-to-buffer" pop-to-buffer
)
132 (function :tag
"Other function")))
134 (defcustom server-temp-file-regexp
"^/tmp/Re\\|/draft$"
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."
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
144 it with Emacs server. If nil, kill only buffers as specified by
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
153 (or (assq 'server-buffer-clients minor-mode-alist
)
154 (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 (make-variable-buffer-local 'server-existing-buffer
)
162 (defvar server-name
"server")
164 (defvar server-socket-dir
165 (format "/tmp/emacs%d" (user-uid)))
167 (defun server-log (string &optional client
)
168 "If a *server* buffer exists, write STRING to it for logging purposes."
169 (if (get-buffer "*server*")
170 (with-current-buffer "*server*"
171 (goto-char (point-max))
172 (insert (current-time-string)
173 (if client
(format " %s:" client
) " ")
175 (or (bolp) (newline)))))
177 (defun server-sentinel (proc msg
)
178 (let ((client (assq proc server-clients
)))
179 ;; Remove PROC from the list of clients.
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)))))))
192 ;; If this is a new client process, set the query-on-exit flag to nil
193 ;; for this process (it isn't inherited from the server process).
194 (when (and (eq (process-status proc
) 'open
)
195 (process-query-on-exit-flag proc
))
196 (set-process-query-on-exit-flag proc nil
))
197 (server-log (format "Status changed to %s" (process-status proc
)) proc
))
199 (defun server-select-display (display)
200 ;; If the current frame is on `display' we're all set.
201 (unless (equal (frame-parameter (selected-frame) 'display
) display
)
202 ;; Otherwise, look for an existing frame there and select it.
203 (dolist (frame (frame-list))
204 (when (equal (frame-parameter frame
'display
) display
)
205 (select-frame frame
)))
206 ;; If there's no frame on that display yet, create a dummy one
208 (unless (equal (frame-parameter (selected-frame) 'display
) display
)
210 (make-frame-on-display
212 ;; This frame is only there in place of an actual "current display"
213 ;; setting, so we want it to be as unobtrusive as possible. That's
214 ;; what the invisibility is for. The minibuffer setting is so that
215 ;; we don't end up displaying a buffer in it (which noone would
217 '((visibility . nil
) (minibuffer . only
)))))))
219 (defun server-unquote-arg (arg)
220 (replace-regexp-in-string
229 (defun server-ensure-safe-dir (dir)
230 "Make sure DIR is a directory with no race-condition issues.
231 Creates the directory if necessary and makes sure:
232 - there's no symlink involved
234 - it's not readable/writable by anybody else."
235 (setq dir
(directory-file-name dir
))
236 (let ((attrs (file-attributes dir
)))
238 (letf (((default-file-modes) ?
\700)) (make-directory dir
))
239 (setq attrs
(file-attributes dir
)))
240 ;; Check that it's safe for use.
241 (unless (and (eq t
(car attrs
)) (eq (nth 2 attrs
) (user-uid))
242 (zerop (logand ?
\077 (file-modes dir
))))
243 (error "The directory %s is unsafe" dir
))))
246 (defun server-start (&optional leave-dead
)
247 "Allow this Emacs process to be a server for client processes.
248 This starts a server communications subprocess through which
249 client \"editors\" can send your editing commands to this Emacs job.
250 To use the server, set up the program `emacsclient' in the
251 Emacs distribution as your standard \"editor\".
253 Prefix arg means just kill any existing server communications subprocess."
257 (condition-case () (delete-process server-process
) (error nil
)))
258 ;; Delete the socket files made by previous server invocations.
260 (delete-file (expand-file-name server-name server-socket-dir
))
262 ;; If this Emacs already had a server, clear out associated status.
263 (while server-clients
264 (let ((buffer (nth 1 (car server-clients
))))
265 (server-buffer-done buffer
)))
266 ;; Now any previous server is properly stopped.
268 ;; Make sure there is a safe directory in which to place the socket.
269 (server-ensure-safe-dir server-socket-dir
)
271 (server-log (message "Restarting server")))
272 (letf (((default-file-modes) ?
\700))
274 (make-network-process
275 :name
"server" :family
'local
:server t
:noquery t
276 :service
(expand-file-name server-name server-socket-dir
)
277 :sentinel
'server-sentinel
:filter
'server-process-filter
278 ;; We must receive file names without being decoded.
279 ;; Those are decoded by server-process-filter according
280 ;; to file-name-coding-system.
281 :coding
'raw-text
)))))
284 (define-minor-mode server-mode
286 With ARG, turn Server mode on if ARG is positive, off otherwise.
287 Server mode runs a process that accepts commands from the
288 `emacsclient' program. See `server-start' and Info node `Emacs server'."
292 ;; Fixme: Should this check for an existing server socket and do
293 ;; nothing if there is one (for multiple Emacs sessions)?
294 (server-start (not server-mode
)))
296 (defun server-process-filter (proc string
)
297 "Process a request from the server to edit some files.
298 PROC is the server process. Format of STRING is \"PATH PATH PATH... \\n\"."
299 (server-log string proc
)
300 (let ((prev (process-get proc
'previous-string
)))
302 (setq string
(concat prev string
))
303 (process-put proc
'previous-string nil
)))
304 ;; If the input is multiple lines,
305 ;; process each line individually.
306 (while (string-match "\n" string
)
307 (let ((request (substring string
0 (match-beginning 0)))
308 (coding-system (and default-enable-multibyte-characters
309 (or file-name-coding-system
310 default-file-name-coding-system
)))
314 (tmp-frame nil
) ; Sometimes used to embody the selected display.
316 ;; Remove this line from STRING.
317 (setq string
(substring string
(match-end 0)))
318 (setq client
(cons proc nil
))
319 (while (string-match "[^ ]* " request
)
320 (let ((arg (substring request
(match-beginning 0) (1- (match-end 0)))))
321 (setq request
(substring request
(match-end 0)))
323 ((equal "-nowait" arg
) (setq nowait t
))
324 ((equal "-eval" arg
) (setq eval t
))
325 ((and (equal "-display" arg
) (string-match "\\([^ ]*\\) " request
))
326 (let ((display (server-unquote-arg (match-string 1 request
))))
327 (setq request
(substring request
(match-end 0)))
329 (setq tmp-frame
(server-select-display display
))
330 (error (process-send-string proc
(nth 1 err
))
331 (setq request
"")))))
332 ;; ARG is a line number option.
333 ((string-match "\\`\\+[0-9]+\\'" arg
)
334 (setq lineno
(string-to-number (substring arg
1))))
335 ;; ARG is line number:column option.
336 ((string-match "\\`+\\([0-9]+\\):\\([0-9]+\\)\\'" arg
)
337 (setq lineno
(string-to-number (match-string 1 arg
))
338 columnno
(string-to-number (match-string 2 arg
))))
340 ;; Undo the quoting that emacsclient does
341 ;; for certain special characters.
342 (setq arg
(server-unquote-arg arg
))
343 ;; Now decode the file name if necessary.
345 (setq arg
(decode-coding-string arg coding-system
)))
348 (v (condition-case errobj
349 (eval (car (read-from-string arg
)))
350 (error (setq errorp t
) errobj
))))
353 (let ((standard-output (current-buffer)))
354 (if errorp
(princ "error: "))
356 ;; Suppress the error rose when the pipe to PROC is closed.
358 (process-send-region proc
(point-min) (point-max))
362 ;; ARG is a file name.
363 ;; Collapse multiple slashes to single slashes.
364 (setq arg
(command-line-normalize-file-name arg
))
365 (push (list arg lineno columnno
) files
))
367 (setq columnno
0)))))
369 (run-hooks 'pre-command-hook
)
370 (server-visit-files files client nowait
)
371 (run-hooks 'post-command-hook
))
372 ;; CLIENT is now a list (CLIENTNUM BUFFERS...)
373 (if (null (cdr client
))
374 ;; This client is empty; get rid of it immediately.
376 (delete-process proc
)
377 (server-log "Close empty client" proc
))
378 ;; We visited some buffer for this client.
379 (or nowait
(push client server-clients
))
380 (unless (or isearch-mode
(minibufferp))
381 (server-switch-buffer (nth 1 client
))
382 (run-hooks 'server-switch-hook
)
384 (message "%s" (substitute-command-keys
385 "When done with a buffer, type \\[server-edit]")))))
386 ;; Avoid preserving the connection after the last real frame is deleted.
387 (if tmp-frame
(delete-frame tmp-frame
))))
388 ;; Save for later any partial line that remains.
389 (when (> (length string
) 0)
390 (process-put proc
'previous-string string
)))
392 (defun server-goto-line-column (file-line-col)
393 (goto-line (nth 1 file-line-col
))
394 (let ((column-number (nth 2 file-line-col
)))
395 (if (> column-number
0)
396 (move-to-column (1- column-number
)))))
398 (defun server-visit-files (files client
&optional nowait
)
399 "Find FILES and return the list CLIENT with the buffers nconc'd.
400 FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
401 NOWAIT non-nil means this client is not waiting for the results,
402 so don't mark these buffers specially, just visit them normally."
403 ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
404 (let ((last-nonmenu-event t
) client-record
)
405 ;; Restore the current buffer afterward, but not using save-excursion,
406 ;; because we don't want to save point in this buffer
407 ;; if it happens to be one of those specified by the server.
410 ;; If there is an existing buffer modified or the file is
411 ;; modified, revert it. If there is an existing buffer with
412 ;; deleted file, offer to write it.
413 (let* ((filen (car file
))
414 (obuf (get-file-buffer filen
)))
415 (add-to-history 'file-name-history filen
)
416 (if (and obuf
(set-buffer obuf
))
418 (cond ((file-exists-p filen
)
419 (if (not (verify-visited-file-modtime obuf
))
420 (revert-buffer t nil
)))
423 (concat "File no longer exists: "
425 ", write buffer to file? "))
426 (write-file filen
))))
427 (setq server-existing-buffer t
)
428 (server-goto-line-column file
))
429 (set-buffer (find-file-noselect filen
))
430 (server-goto-line-column file
)
431 (run-hooks 'server-visit-hook
)))
433 ;; When the buffer is killed, inform the clients.
434 (add-hook 'kill-buffer-hook
'server-kill-buffer nil t
)
435 (push (car client
) server-buffer-clients
))
436 (push (current-buffer) client-record
)))
437 (nconc client client-record
)))
439 (defun server-buffer-done (buffer &optional for-killing
)
440 "Mark BUFFER as \"done\" for its client(s).
441 This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED).
442 NEXT-BUFFER is another server buffer, as a suggestion for what to select next,
443 or nil. KILLED is t if we killed BUFFER (typically, because it was visiting
445 FOR-KILLING if non-nil indicates that we are called from `kill-buffer'."
446 (let ((next-buffer nil
)
448 (old-clients server-clients
))
450 (let ((client (car old-clients
)))
452 (setq next-buffer
(nth 1 (memq buffer client
))))
454 ;; Delete all dead buffers from CLIENT.
457 (and (bufferp (car tail
))
458 (null (buffer-name (car tail
)))
459 (delq (car tail
) client
))
460 (setq tail
(cdr tail
))))
461 ;; If client now has no pending buffers,
462 ;; tell it that it is done, and forget it entirely.
464 (delete-process (car client
))
465 (server-log "Close" (car client
))
466 (setq server-clients
(delq client server-clients
))))
467 (setq old-clients
(cdr old-clients
)))
468 (if (and (bufferp buffer
) (buffer-name buffer
))
469 ;; We may or may not kill this buffer;
470 ;; if we do, do not call server-buffer-done recursively
471 ;; from kill-buffer-hook.
472 (let ((server-kill-buffer-running t
))
473 (with-current-buffer buffer
474 (setq server-buffer-clients nil
)
475 (run-hooks 'server-done-hook
))
476 ;; Notice whether server-done-hook killed the buffer.
477 (if (null (buffer-name buffer
))
479 ;; Don't bother killing or burying the buffer
480 ;; when we are called from kill-buffer.
482 (when (and (not killed
)
483 server-kill-new-buffers
484 (with-current-buffer buffer
485 (not server-existing-buffer
)))
488 (kill-buffer buffer
))
490 (if (server-temp-file-p buffer
)
494 (bury-buffer buffer
)))))))
495 (list next-buffer killed
)))
497 (defun server-temp-file-p (&optional buffer
)
498 "Return non-nil if BUFFER contains a file considered temporary.
499 These are files whose names suggest they are repeatedly
500 reused to pass information to another program.
502 The variable `server-temp-file-regexp' controls which filenames
503 are considered temporary."
504 (and (buffer-file-name buffer
)
505 (string-match server-temp-file-regexp
(buffer-file-name buffer
))))
507 (defun server-done ()
508 "Offer to save current buffer, mark it as \"done\" for clients.
509 This kills or buries the buffer, then returns a list
510 of the form (NEXT-BUFFER KILLED). NEXT-BUFFER is another server buffer,
511 as a suggestion for what to select next, or nil.
512 KILLED is t if we killed BUFFER, which happens if it was created
513 specifically for the clients and did not exist before their request for it."
514 (when server-buffer-clients
515 (if (server-temp-file-p)
516 ;; For a temp file, save, and do make a non-numeric backup
517 ;; (unless make-backup-files is nil).
518 (let ((version-control nil
)
519 (buffer-backed-up nil
))
521 (if (and (buffer-modified-p)
523 (y-or-n-p (concat "Save file " buffer-file-name
"? ")))
525 (server-buffer-done (current-buffer))))
527 ;; Ask before killing a server buffer.
528 ;; It was suggested to release its client instead,
529 ;; but I think that is dangerous--the client would proceed
530 ;; using whatever is on disk in that file. -- rms.
531 (defun server-kill-buffer-query-function ()
532 (or (not server-buffer-clients
)
533 (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
534 (buffer-name (current-buffer))))))
536 (add-hook 'kill-buffer-query-functions
537 'server-kill-buffer-query-function
)
539 (defun server-kill-emacs-query-function ()
541 (tail server-clients
))
542 ;; See if any clients have any buffers that are still alive.
544 (if (memq t
(mapcar 'stringp
(mapcar 'buffer-name
(cdr (car tail
)))))
545 (setq live-client t
))
546 (setq tail
(cdr tail
)))
547 (or (not live-client
)
548 (yes-or-no-p "Server buffers still have clients; exit anyway? "))))
550 (add-hook 'kill-emacs-query-functions
'server-kill-emacs-query-function
)
552 (defvar server-kill-buffer-running nil
553 "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
555 (defun server-kill-buffer ()
556 ;; Prevent infinite recursion if user has made server-done-hook
558 (or server-kill-buffer-running
559 (and server-buffer-clients
560 (let ((server-kill-buffer-running t
))
562 (server-buffer-done (current-buffer) t
))))))
564 (defun server-edit (&optional arg
)
565 "Switch to next server editing buffer; say \"Done\" for current buffer.
566 If a server buffer is current, it is marked \"done\" and optionally saved.
567 The buffer is also killed if it did not exist before the clients asked for it.
568 When all of a client's buffers are marked as \"done\", the client is notified.
570 Temporary files such as MH <draft> files are always saved and backed up,
571 no questions asked. (The variable `make-backup-files', if nil, still
572 inhibits a backup; you can set it locally in a particular buffer to
573 prevent a backup for it.) The variable `server-temp-file-regexp' controls
574 which filenames are considered temporary.
576 If invoked with a prefix argument, or if there is no server process running,
577 starts server process and that is all. Invoked by \\[server-edit]."
582 (memq (process-status server-process
) '(signal exit
)))
584 (server-clients (apply 'server-switch-buffer
(server-done)))
585 (t (message "No server editing buffers exist"))))
587 (defun server-switch-buffer (&optional next-buffer killed-one
)
588 "Switch to another buffer, preferably one that has a client.
589 Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
590 ;; KILLED-ONE is t in a recursive call
591 ;; if we have already killed one temp-file server buffer.
592 ;; This means we should avoid the final "switch to some other buffer"
593 ;; since we've already effectively done that.
594 (if (null next-buffer
)
596 (server-switch-buffer (nth 1 (car server-clients
)) killed-one
)
597 (unless (or killed-one
(window-dedicated-p (selected-window)))
598 (switch-to-buffer (other-buffer))
599 (message "No server buffers remain to edit")))
600 (if (not (buffer-name next-buffer
))
601 ;; If NEXT-BUFFER is a dead buffer, remove the server records for it
602 ;; and try the next surviving server buffer.
603 (apply 'server-switch-buffer
(server-buffer-done next-buffer
))
604 ;; OK, we know next-buffer is live, let's display and select it.
605 (if (functionp server-window
)
606 (funcall server-window next-buffer
)
607 (let ((win (get-buffer-window next-buffer
0)))
608 (if (and win
(not server-window
))
609 ;; The buffer is already displayed: just reuse the window.
610 (let ((frame (window-frame win
)))
611 (if (eq (frame-visible-p frame
) 'icon
)
614 (set-buffer next-buffer
))
615 ;; Otherwise, let's find an appropriate window.
616 (cond ((and (windowp server-window
)
617 (window-live-p server-window
))
618 (select-window server-window
))
619 ((framep server-window
)
620 (if (not (frame-live-p server-window
))
621 (setq server-window
(make-frame)))
622 (select-window (frame-selected-window server-window
))))
623 (if (window-minibuffer-p (selected-window))
624 (select-window (next-window nil
'nomini
0)))
625 ;; Move to a non-dedicated window, if we have one.
626 (when (window-dedicated-p (selected-window))
628 (get-window-with-predicate
630 (and (not (window-dedicated-p w
))
631 (equal (frame-parameter (window-frame w
) 'display
)
632 (frame-parameter (selected-frame) 'display
))))
633 'nomini
'visible
(selected-window))))
635 (switch-to-buffer next-buffer
)
636 ;; After all the above, we might still have ended up with
637 ;; a minibuffer/dedicated-window (if there's no other).
638 (error (pop-to-buffer next-buffer
)))))))))
640 (define-key ctl-x-map
"#" 'server-edit
)
642 (defun server-unload-hook ()
644 (remove-hook 'kill-buffer-query-functions
'server-kill-buffer-query-function
)
645 (remove-hook 'kill-emacs-query-functions
'server-kill-emacs-query-function
)
646 (remove-hook 'kill-buffer-hook
'server-kill-buffer
))
648 (add-hook 'kill-emacs-hook
(lambda () (server-mode -
1))) ;Cleanup upon exit.
649 (add-hook 'server-unload-hook
'server-unload-hook
)
653 ;; arch-tag: 1f7ecb42-f00a-49f8-906d-61995d84c8d6
654 ;;; server.el ends here