X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/98a4349ced3fe72635dc03ba49da3e1a9424b54e..0bfd44c1806f9e589f79e9bc8f4b2a5aab7e4df3:/lisp/server.el diff --git a/lisp/server.el b/lisp/server.el index aa870b0e7b..befcd22ad3 100644 --- a/lisp/server.el +++ b/lisp/server.el @@ -1,8 +1,10 @@ -;;; server.el --- Lisp code for GNU Emacs running as server process. +;;; server.el --- Lisp code for GNU Emacs running as server process -;; Copyright (C) 1986, 1987, 1992, 1994, 1995 Free Software Foundation, Inc. +;; Copyright (C) 1986, 1987, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000, +;; 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. ;; Author: William Sommerfeld +;; Maintainer: FSF ;; Keywords: processes ;; Changes by peck@sun.com and by rms. @@ -20,75 +22,83 @@ ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License -;; along with GNU Emacs; see the file COPYING. If not, write to -;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. +;; along with GNU Emacs; see the file COPYING. If not, write to the +;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. ;;; Commentary: -;;; This Lisp code is run in Emacs when it is to operate as -;;; a server for other processes. +;; This Lisp code is run in Emacs when it is to operate as +;; a server for other processes. -;;; Load this library and do M-x server-edit to enable Emacs as a server. -;;; Emacs runs the program ../arch-lib/emacsserver as a subprocess -;;; for communication with clients. If there are no client buffers to edit, -;;; server-edit acts like (switch-to-buffer (other-buffer)) +;; Load this library and do M-x server-edit to enable Emacs as a server. +;; 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)) -;;; 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. +;; 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. -;;; Note that any number of clients may dispatch files to emacs to be edited. +;; Note that any number of clients may dispatch files to emacs to be edited. -;;; When you finish editing a Server buffer, again call server-edit -;;; to mark that buffer as done for the client and switch to the next -;;; Server buffer. When all the buffers for a client have been edited -;;; and exited with server-edit, the client "editor" will return -;;; to the program that invoked it. +;; When you finish editing a Server buffer, again call server-edit +;; to mark that buffer as done for the client and switch to the next +;; Server buffer. When all the buffers for a client have been edited +;; and exited with server-edit, the client "editor" will return +;; to the program that invoked it. -;;; 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: +;; 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: -;;; 1. On a window system, where Emacs runs in one window and the -;;; program that wants to use "the editor" runs in another. +;; 1. On a window system, where Emacs runs in one window and the +;; program that wants to use "the editor" runs in another. -;;; 2. On a multi-terminal system, where Emacs runs on one terminal and the -;;; program that wants to use "the editor" runs on another. +;; 2. On a multi-terminal system, where Emacs runs on one terminal and the +;; program that wants to use "the editor" runs on another. -;;; 3. When the program that wants to use "the editor" is running -;;; as a subprocess of Emacs. +;; 3. When the program that wants to use "the editor" is running +;; as a subprocess of Emacs. -;;; 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. +;; 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. -;;; The buffer local variable "server-buffer-clients" lists -;;; the clients who are waiting for this buffer to be edited. -;;; The global variable "server-clients" lists all the waiting clients, -;;; and which files are yet to be edited for each. +;; The buffer local variable "server-buffer-clients" lists +;; the clients who are waiting for this buffer to be edited. +;; The global variable "server-clients" lists all the waiting clients, +;; and which files are yet to be edited for each. ;;; Code: - -(defvar server-program (expand-file-name "emacsserver" exec-directory) - "*The program to use as the edit server.") -(defvar server-visit-hook nil - "*List of hooks to call when visiting a file for the Emacs server.") +(eval-when-compile (require 'cl)) + +(defgroup server nil + "Emacs running as a server process." + :group 'external) -(defvar server-switch-hook nil - "*List of hooks to call when switching to a buffer for the Emacs server.") +(defcustom server-visit-hook nil + "*Hook run when visiting a file for the Emacs server." + :group 'server + :type 'hook) -(defvar server-done-hook nil - "*List of hooks to call when done editing a buffer for the Emacs server.") +(defcustom server-switch-hook nil + "*Hook run when switching to a buffer for the Emacs server." + :group 'server + :type 'hook) -(defvar server-process nil - "the current server process") +(defcustom server-done-hook nil + "*Hook run when done editing a buffer for the Emacs server." + :group 'server + :type 'hook) -(defvar server-previous-string "") +(defvar server-process nil + "The current server process.") (defvar server-clients nil "List of current server clients. @@ -97,39 +107,140 @@ that can be given to the server process to identify a client. When a buffer is marked as \"done\", it is removed from this list.") (defvar server-buffer-clients nil - "List of clientids for clients requesting editing of current buffer.") + "List of client ids for clients requesting editing of current buffer.") (make-variable-buffer-local 'server-buffer-clients) ;; Changing major modes should not erase this local. (put 'server-buffer-clients 'permanent-local t) -(defvar server-window nil - "*The window to use for selecting Emacs server buffers. +(defcustom server-window nil + "*Specification of the window to use for selecting Emacs server buffers. If nil, use the selected window. -If it is a frame, use the frame's selected window.") - -(defvar server-temp-file-regexp "^/tmp/Re\\|/draft$" - "*Regexp which should match filenames of temporary files -which are deleted and reused after each edit -by the programs that invoke the emacs server.") +If it is a function, it should take one argument (a buffer) and +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 + :version "22.1" + :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"))) + +(defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$" + "*Regexp matching names of temporary files. +These are deleted and reused after each edit by the programs that +invoke the Emacs server." + :group 'server + :type 'regexp) + +(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 +it with Emacs server. If nil, kill only buffers as specified by +`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") (or (assq 'server-buffer-clients minor-mode-alist) (setq minor-mode-alist (cons '(server-buffer-clients " Server") minor-mode-alist))) -;; If a *server* buffer exists, -;; write STRING to it for logging purposes. -(defun server-log (string) +(defvar server-existing-buffer nil + "Non-nil means the buffer existed before the server was asked to visit it. +This means that the server should not kill the buffer when you say you +are done with it in the server.") +(make-variable-buffer-local 'server-existing-buffer) + +(defvar server-name "server") + +(defvar server-socket-dir + (format "/tmp/emacs%d" (user-uid))) + +(defun server-log (string &optional client) + "If a *server* buffer exists, write STRING to it for logging purposes." (if (get-buffer "*server*") - (save-excursion - (set-buffer "*server*") + (with-current-buffer "*server*" (goto-char (point-max)) - (insert string) - (or (bobp) (newline))))) + (insert (current-time-string) + (if client (format " %s:" client) " ") + string) + (or (bolp) (newline))))) (defun server-sentinel (proc msg) - (cond ((eq (process-status proc) 'exit) - (server-log (message "Server subprocess exited"))) - ((eq (process-status proc) 'signal) - (server-log (message "Server subprocess killed"))))) + (let ((client (assq proc server-clients))) + ;; Remove PROC from the list of clients. + (when client + (setq server-clients (delq client server-clients)) + (dolist (buf (cdr client)) + (with-current-buffer buf + ;; Remove PROC from the clients of each buffer. + (setq server-buffer-clients (delq proc server-buffer-clients)) + ;; Kill the buffer if necessary. + (when (and (null server-buffer-clients) + (or (and server-kill-new-buffers + (not server-existing-buffer)) + (server-temp-file-p))) + (kill-buffer (current-buffer))))))) + ;; 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)) + (server-log (format "Status changed to %s" (process-status proc)) proc)) + +(defun server-select-display (display) + ;; If the current frame is on `display' we're all set. + (unless (equal (frame-parameter (selected-frame) 'display) display) + ;; Otherwise, look for an existing frame there and select it. + (dolist (frame (frame-list)) + (when (equal (frame-parameter frame 'display) display) + (select-frame frame))) + ;; If there's no frame on that display yet, create a dummy one + ;; and select it. + (unless (equal (frame-parameter (selected-frame) 'display) display) + (select-frame + (make-frame-on-display + display + ;; This frame is only there in place of an actual "current display" + ;; setting, so we want it to be as unobtrusive as possible. That's + ;; what the invisibility is for. The minibuffer setting is so that + ;; we don't end up displaying a buffer in it (which noone would + ;; notice). + '((visibility . nil) (minibuffer . only))))))) + +(defun server-unquote-arg (arg) + (replace-regexp-in-string + "&." (lambda (s) + (case (aref s 1) + (?& "&") + (?- "-") + (?n "\n") + (t " "))) + arg t t)) + +(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)))) ;;;###autoload (defun server-start (&optional leave-dead) @@ -141,115 +252,202 @@ Emacs distribution as your standard \"editor\". Prefix arg means just kill any existing server communications subprocess." (interactive "P") + ;; Make sure there is a safe directory in which to place the socket. + (server-ensure-safe-dir server-socket-dir) ;; kill it dead! (if server-process - (progn - (set-process-sentinel server-process nil) - (condition-case () (delete-process server-process) (error nil)))) - (condition-case () (delete-file "~/.emacs_server") (error nil)) + (condition-case () (delete-process server-process) (error nil))) + ;; Delete the socket files made by previous server invocations. (condition-case () - (delete-file (format "/tmp/esrv%d-%s" (user-uid) (system-name))) + (delete-file (expand-file-name server-name server-socket-dir)) (error nil)) - ;; If we already had a server, clear out associated status. + ;; If this Emacs already had a server, clear out associated status. (while server-clients (let ((buffer (nth 1 (car server-clients)))) (server-buffer-done buffer))) - (if leave-dead - nil + (unless leave-dead (if server-process (server-log (message "Restarting server"))) - ;; Using a pty is wasteful, and the separate session causes - ;; annoyance sometimes (some systems kill idle sessions). - (let ((process-connection-type nil)) - (setq server-process (start-process "server" nil server-program))) - (set-process-sentinel server-process 'server-sentinel) - (set-process-filter server-process 'server-process-filter) - (process-kill-without-query server-process))) + (letf (((default-file-modes) ?\700)) + (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))))) + +;;;###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 + :version "22.1" + ;; 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))) -;Process a request from the server to edit some files. -;Format of STRING is "Client: CLIENTID PATH PATH PATH... \n" (defun server-process-filter (proc string) - (server-log string) - (setq string (concat server-previous-string string)) + "Process a request from the server to edit some files. +PROC is the server process. Format of STRING is \"PATH PATH PATH... \\n\"." + (server-log string proc) + (let ((prev (process-get proc 'previous-string))) + (when prev + (setq string (concat prev string)) + (process-put proc 'previous-string nil))) ;; If the input is multiple lines, ;; process each line individually. (while (string-match "\n" string) (let ((request (substring string 0 (match-beginning 0))) - client + (coding-system (and default-enable-multibyte-characters + (or file-name-coding-system + default-file-name-coding-system))) + client nowait eval (files nil) - (lineno 1)) + (lineno 1) + (tmp-frame nil) ; Sometimes used to embody the selected display. + (columnno 0)) ;; Remove this line from STRING. - (setq string (substring string (match-end 0))) - (if (string-match "^Client: " request) - (setq request (substring request (match-end 0)))) - (setq client (list (substring request 0 (string-match " " request)))) - (setq request (substring request (match-end 0))) - (while (string-match "[^ ]+ " request) - (let ((arg - (substring request (match-beginning 0) (1- (match-end 0))))) + (setq string (substring string (match-end 0))) + (setq client (cons proc nil)) + (while (string-match "[^ ]* " request) + (let ((arg (substring request (match-beginning 0) (1- (match-end 0))))) (setq request (substring request (match-end 0))) - (if (string-match "\\`\\+[0-9]+\\'" arg) - (setq lineno (read (substring arg 1))) - (setq files - (cons (list arg lineno) - files)) - (setq lineno 1)))) - (server-visit-files files client) + (cond + ((equal "-nowait" arg) (setq nowait t)) + ((equal "-eval" arg) (setq eval t)) + ((and (equal "-display" arg) (string-match "\\([^ ]*\\) " request)) + (let ((display (server-unquote-arg (match-string 1 request)))) + (setq request (substring request (match-end 0))) + (condition-case err + (setq tmp-frame (server-select-display display)) + (error (process-send-string proc (nth 1 err)) + (setq request ""))))) + ;; ARG is a line number option. + ((string-match "\\`\\+[0-9]+\\'" arg) + (setq lineno (string-to-number (substring arg 1)))) + ;; ARG is line number:column option. + ((string-match "\\`+\\([0-9]+\\):\\([0-9]+\\)\\'" arg) + (setq lineno (string-to-number (match-string 1 arg)) + columnno (string-to-number (match-string 2 arg)))) + (t + ;; Undo the quoting that emacsclient does + ;; for certain special characters. + (setq arg (server-unquote-arg arg)) + ;; Now decode the file name if necessary. + (if coding-system + (setq arg (decode-coding-string arg coding-system))) + (if eval + (let* (errorp + (v (condition-case errobj + (eval (car (read-from-string arg))) + (error (setq errorp t) errobj)))) + (when v + (with-temp-buffer + (let ((standard-output (current-buffer))) + (if errorp (princ "error: ")) + (pp v) + ;; Suppress the error rose when the pipe to PROC is closed. + (condition-case err + (process-send-region proc (point-min) (point-max)) + (file-error nil) + (error nil)) + )))) + ;; ARG is a file name. + ;; Collapse multiple slashes to single slashes. + (setq arg (command-line-normalize-file-name arg)) + (push (list arg lineno columnno) files)) + (setq lineno 1) + (setq columnno 0))))) + (when files + (run-hooks 'pre-command-hook) + (server-visit-files files client nowait) + (run-hooks 'post-command-hook)) ;; CLIENT is now a list (CLIENTNUM BUFFERS...) - (setq server-clients (cons client server-clients)) - (server-switch-buffer (nth 1 client)) - (run-hooks 'server-switch-hook) - (message (substitute-command-keys - "When done with a buffer, type \\[server-edit].")))) + (if (null (cdr client)) + ;; This client is empty; get rid of it immediately. + (progn + (delete-process proc) + (server-log "Close empty client" proc)) + ;; We visited some buffer for this client. + (or nowait (push client server-clients)) + (unless (or isearch-mode (minibufferp)) + (server-switch-buffer (nth 1 client)) + (run-hooks 'server-switch-hook) + (unless nowait + (message "%s" (substitute-command-keys + "When done with a buffer, type \\[server-edit]"))))) + ;; Avoid preserving the connection after the last real frame is deleted. + (if tmp-frame (delete-frame tmp-frame)))) ;; Save for later any partial line that remains. - (setq server-previous-string string)) - -(defun server-visit-files (files client) - "Finds FILES and returns the list CLIENT with the buffers nconc'd. -FILES is an alist whose elements are (FILENAME LINENUMBER)." + (when (> (length string) 0) + (process-put proc 'previous-string string))) + +(defun server-goto-line-column (file-line-col) + (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))))) + +(defun server-visit-files (files client &optional nowait) + "Find FILES and return the list CLIENT with the buffers nconc'd. +FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER). +NOWAIT non-nil means this client is not waiting for the results, +so don't mark these buffers specially, just visit them normally." ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries. - (let (client-record (last-nonmenu-event t) (obuf (current-buffer))) + (let ((last-nonmenu-event t) client-record) ;; Restore the current buffer afterward, but not using save-excursion, ;; because we don't want to save point in this buffer ;; if it happens to be one of those specified by the server. - (unwind-protect - (while files - ;; If there is an existing buffer modified or the file is modified, - ;; revert it. - ;; If there is an existing buffer with deleted file, offer to write it. - (let* ((filen (car (car files))) - (obuf (get-file-buffer filen))) - (if (and obuf (set-buffer obuf)) - (if (file-exists-p filen) - (if (or (not (verify-visited-file-modtime obuf)) - (buffer-modified-p obuf)) - (revert-buffer t nil)) - (if (y-or-n-p - (concat "File no longer exists: " - filen - ", write buffer to file? ")) - (write-file filen))) - (set-buffer (find-file-noselect filen)) - (run-hooks 'server-visit-hook))) - (goto-line (nth 1 (car files))) - (setq server-buffer-clients (cons (car client) server-buffer-clients)) - (setq client-record (cons (current-buffer) client-record)) - (setq files (cdr files))) - (set-buffer obuf)) + (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))) + (push filen file-name-history) + (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 + (concat "File no longer exists: " + filen + ", write buffer to file? ")) + (write-file filen)))) + (setq server-existing-buffer t) + (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) + (push (car client) server-buffer-clients)) + (push (current-buffer) client-record))) (nconc client client-record))) -(defun server-buffer-done (buffer) +(defun server-buffer-done (buffer &optional for-killing) "Mark BUFFER as \"done\" for its client(s). This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED). NEXT-BUFFER is another server buffer, as a suggestion for what to select next, -or nil. KILLED is t if we killed BUFFER (because it was a temp file)." - (let ((running (eq (process-status server-process) 'run)) - (next-buffer nil) +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'." + (let ((next-buffer nil) (killed nil) (old-clients server-clients)) (while old-clients (let ((client (car old-clients))) - (or next-buffer + (or next-buffer (setq next-buffer (nth 1 (memq buffer client)))) (delq buffer client) ;; Delete all dead buffers from CLIENT. @@ -261,30 +459,41 @@ or nil. KILLED is t if we killed BUFFER (because it was a temp file)." (setq tail (cdr tail)))) ;; If client now has no pending buffers, ;; tell it that it is done, and forget it entirely. - (if (cdr client) nil - (if running - (progn - (send-string server-process - (format "Close: %s Done\n" (car client))) - (server-log (format "Close: %s Done\n" (car client))) - ;; Don't send emacsserver two commands in close succession. - ;; It cannot handle that. - (sit-for 1))) + (unless (cdr client) + (delete-process (car client)) + (server-log "Close" (car client)) (setq server-clients (delq client server-clients)))) (setq old-clients (cdr old-clients))) (if (and (bufferp buffer) (buffer-name buffer)) - (progn - (save-excursion - (set-buffer buffer) + ;; 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)) + (with-current-buffer buffer (setq server-buffer-clients nil) (run-hooks 'server-done-hook)) - (if (server-temp-file-p buffer) - (progn (kill-buffer buffer) - (setq killed t)) - (bury-buffer buffer)))) + ;; 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 + (when (and (not killed) + server-kill-new-buffers + (with-current-buffer buffer + (not server-existing-buffer))) + (setq killed t) + (bury-buffer buffer) + (kill-buffer buffer)) + (unless killed + (if (server-temp-file-p buffer) + (progn + (kill-buffer buffer) + (setq killed t)) + (bury-buffer buffer))))))) (list next-buffer killed))) -(defun server-temp-file-p (buffer) +(defun server-temp-file-p (&optional buffer) "Return non-nil if BUFFER contains a file considered temporary. These are files whose names suggest they are repeatedly reused to pass information to another program. @@ -296,22 +505,23 @@ are considered temporary." (defun server-done () "Offer to save current buffer, mark it as \"done\" for clients. -This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED). -NEXT-BUFFER is another server buffer, as a suggestion for what to select next, -or nil. KILLED is t if we killed the BUFFER (because it was a temp file)." - (let ((buffer (current-buffer))) - (if server-buffer-clients - (progn - (if (server-temp-file-p buffer) - ;; 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) - (y-or-n-p (concat "Save file " buffer-file-name "? "))) - (save-buffer buffer))) - (server-buffer-done buffer))))) +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." + (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)))) ;; Ask before killing a server buffer. ;; It was suggested to release its client instead, @@ -337,10 +547,23 @@ or nil. KILLED is t if we killed the BUFFER (because it was a temp file)." (yes-or-no-p "Server buffers still have clients; exit anyway? ")))) (add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function) + +(defvar server-kill-buffer-running nil + "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.") + +(defun server-kill-buffer () + ;; Prevent infinite recursion if user has made server-done-hook + ;; call kill-buffer. + (or server-kill-buffer-running + (and server-buffer-clients + (let ((server-kill-buffer-running t)) + (when server-process + (server-buffer-done (current-buffer) t)))))) (defun server-edit (&optional arg) "Switch to next server editing buffer; say \"Done\" for current buffer. If a server buffer is current, it is marked \"done\" and optionally saved. +The buffer is also killed if it did not exist before the clients asked for it. When all of a client's buffers are marked as \"done\", the client is notified. Temporary files such as MH files are always saved and backed up, @@ -349,7 +572,7 @@ inhibits a backup; you can set it locally in a particular buffer to prevent a backup for it.) The variable `server-temp-file-regexp' controls which filenames are considered temporary. -If invoked with a prefix argument, or if there is no server process running, +If invoked with a prefix argument, or if there is no server process running, starts server process and that is all. Invoked by \\[server-edit]." (interactive "P") (if (or arg @@ -365,37 +588,63 @@ Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it." ;; if we have already killed one temp-file server buffer. ;; This means we should avoid the final "switch to some other buffer" ;; since we've already effectively done that. - (cond ((and (windowp server-window) - (window-live-p server-window)) - (select-window server-window)) - ((framep server-window) - (if (not (frame-live-p server-window)) - (setq server-window (make-frame))) - (select-window (frame-selected-window server-window)))) - (if (window-minibuffer-p (selected-window)) - (select-window (next-window nil 'nomini 0))) - ;; Move to a non-dedicated window, if we have one. - (let ((last-window (previous-window nil 'nomini 0))) - (while (and (window-dedicated-p (selected-window)) - (not (eq last-window (selected-window)))) - (select-window (next-window nil 'nomini 0)))) - (set-window-dedicated-p (selected-window) nil) - (if next-buffer - (if (and (bufferp next-buffer) - (buffer-name next-buffer)) - (switch-to-buffer next-buffer) - ;; If NEXT-BUFFER is a dead buffer, - ;; remove the server records for it + (if (null next-buffer) + (if server-clients + (server-switch-buffer (nth 1 (car server-clients)) killed-one) + (unless (or killed-one (window-dedicated-p (selected-window))) + (switch-to-buffer (other-buffer)) + (message "No server buffers remain to edit"))) + (if (not (buffer-name next-buffer)) + ;; If NEXT-BUFFER is a dead buffer, remove the server records for it ;; and try the next surviving server buffer. - (apply 'server-switch-buffer - (server-buffer-done next-buffer))) - (if server-clients - (server-switch-buffer (nth 1 (car server-clients)) killed-one) - (if (not killed-one) - (switch-to-buffer (other-buffer)))))) - -(global-set-key "\C-x#" 'server-edit) + (apply 'server-switch-buffer (server-buffer-done next-buffer)) + ;; OK, we know next-buffer is live, let's display and select it. + (if (functionp server-window) + (funcall server-window next-buffer) + (let ((win (get-buffer-window next-buffer 0))) + (if (and win (not server-window)) + ;; The buffer is already displayed: just reuse the window. + (let ((frame (window-frame win))) + (if (eq (frame-visible-p frame) 'icon) + (raise-frame frame)) + (select-window win) + (set-buffer next-buffer)) + ;; Otherwise, let's find an appropriate window. + (cond ((and (windowp server-window) + (window-live-p server-window)) + (select-window server-window)) + ((framep server-window) + (if (not (frame-live-p server-window)) + (setq server-window (make-frame))) + (select-window (frame-selected-window server-window)))) + (if (window-minibuffer-p (selected-window)) + (select-window (next-window nil 'nomini 0))) + ;; Move to a non-dedicated window, if we have one. + (when (window-dedicated-p (selected-window)) + (select-window + (get-window-with-predicate + (lambda (w) + (and (not (window-dedicated-p w)) + (equal (frame-parameter (window-frame w) 'display) + (frame-parameter (selected-frame) 'display)))) + 'nomini 'visible (selected-window)))) + (condition-case nil + (switch-to-buffer next-buffer) + ;; After all the above, we might still have ended up with + ;; a minibuffer/dedicated-window (if there's no other). + (error (pop-to-buffer next-buffer))))))))) + +(define-key ctl-x-map "#" 'server-edit) + +(defun server-unload-hook () + (server-start t) + (remove-hook 'kill-buffer-query-functions 'server-kill-buffer-query-function) + (remove-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function) + (remove-hook 'kill-buffer-hook 'server-kill-buffer)) + +(add-hook 'server-unload-hook 'server-unload-hook) (provide 'server) +;;; arch-tag: 1f7ecb42-f00a-49f8-906d-61995d84c8d6 ;;; server.el ends here