-;;; 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, 87, 92, 94, 95, 96, 97, 98, 99, 2000, 2001
+;; Free Software Foundation, Inc.
;; Author: William Sommerfeld <wesommer@athena.mit.edu>
;; Maintainer: FSF
;;; Code:
\f
-(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.")
-
-(defvar server-switch-hook nil
- "*List of hooks to call when switching to a buffer for the Emacs server.")
-
-(defvar server-done-hook nil
- "*List of hooks to call when done editing a buffer for the Emacs server.")
+(defgroup server nil
+ "Emacs running as a server process."
+ :group 'external)
+
+(defcustom server-program (expand-file-name "emacsserver" exec-directory)
+ "*The program to use as the edit server."
+ :group 'server
+ :type 'string)
+
+(defcustom server-visit-hook nil
+ "*List of hooks to call when visiting a file for the Emacs server."
+ :group 'server
+ :type '(repeat function))
+
+(defcustom server-switch-hook nil
+ "*List of hooks to call when switching to a buffer for the Emacs server."
+ :group 'server
+ :type '(repeat function))
+
+(defcustom server-done-hook nil
+ "*List of hooks to call when done editing a buffer for the Emacs server."
+ :group 'server
+ :type '(repeat function))
(defvar server-process nil
- "the current server process")
+ "The current server process")
(defvar server-previous-string "")
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)
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$"
+(defcustom 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.")
+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)))
+(defvar server-existing-buffer nil
+ "Non-nil means a buffer existed before the Emacs server was asked visit it.
+This means that the server should not kill the buffer when you say you
+are done with it in the server. This variable is local in each buffer
+where it is set.")
+(make-variable-buffer-local 'server-existing-buffer)
+
;; If a *server* buffer exists,
;; write STRING to it for logging purposes.
(defun server-log (string)
(setq server-process (start-process "server" nil server-program)))
(set-process-sentinel server-process 'server-sentinel)
(set-process-filter server-process 'server-process-filter)
+ ;; We must receive file names without being decoded. Those are
+ ;; decoded by server-process-filter accoding to
+ ;; file-name-coding-system.
+ (set-process-coding-system server-process 'raw-text 'raw-text)
(process-kill-without-query server-process)))
\f
;Process a request from the server to edit some files.
;; process each line individually.
(while (string-match "\n" string)
(let ((request (substring string 0 (match-beginning 0)))
+ (coding-system (and default-enable-multibyte-characters
+ (or file-name-coding-system
+ default-file-name-coding-system)))
client nowait
(files nil)
- (lineno 1))
+ (lineno 1)
+ (columnno 0))
;; Remove this line from STRING.
(setq string (substring string (match-end 0)))
(if (string-match "^Error: " request)
(setq request (substring request (match-end 0)))
(if (string-match "\\`-nowait" arg)
(setq nowait t)
- (if (string-match "\\`\\+[0-9]+\\'" arg)
- ;; ARG is a line number option.
- (setq lineno (read (substring arg 1)))
+ (cond
+ ;; ARG is a line number option.
+ ((string-match "\\`\\+[0-9]+\\'" arg)
+ (setq lineno (string-to-int (substring arg 1))))
+ ;; ARG is line number:column option.
+ ((string-match "\\`+\\([0-9]+\\):\\([0-9]+\\)\\'" arg)
+ (setq lineno (string-to-int (match-string 1 arg))
+ columnno (string-to-int (match-string 2 arg))))
+ (t
;; ARG is a file name.
;; Collapse multiple slashes to single slashes.
(setq arg (command-line-normalize-file-name arg))
(setq arg (replace-match "-" t t arg)))
(t
(setq arg (replace-match " " t t arg))))))
+ ;; Now decode the file name if necessary.
+ (if coding-system
+ (setq arg (decode-coding-string arg coding-system)))
(setq files
- (cons (list arg lineno)
+ (cons (list arg lineno columnno)
files))
- (setq lineno 1)))))
+ (setq lineno 1)
+ (setq columnno 0))))))
+ (run-hooks 'pre-command-hook)
(server-visit-files files client nowait)
+ (run-hooks 'post-command-hook)
;; CLIENT is now a list (CLIENTNUM BUFFERS...)
- (or nowait
- (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
+ (send-string server-process
+ (format "Close: %s Done\n" (car client)))
+ (server-log (format "Close empty client: %s Done\n" (car client))))
+ ;; We visited some buffer for this client.
+ (or nowait
+ (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]"))))))))
;; Save for later any partial line that remains.
(setq server-previous-string string))
(defun server-visit-files (files client &optional nowait)
"Finds FILES and returns the list CLIENT with the buffers nconc'd.
-FILES is an alist whose elements are (FILENAME LINENUMBER).
+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.
;; 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.
+ ;; 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)))
+ (push filen file-name-history)
(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)))
+ (progn
+ (cond ((file-exists-p filen)
+ (if (or (not (verify-visited-file-modtime obuf))
+ (buffer-modified-p 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)
+ (goto-line (nth 1 (car files))))
(set-buffer (find-file-noselect filen))
+ (goto-line (nth 1 (car files)))
+ (let ((column-number (nth 2 (car files))))
+ (when (> column-number 0)
+ (move-to-column (1- column-number))))
(run-hooks 'server-visit-hook)))
- (goto-line (nth 1 (car files)))
(if (not nowait)
(setq server-buffer-clients
(cons (car client) server-buffer-clients)))
"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)."
+or nil. KILLED is t if we killed BUFFER
+\(typically, because it was visiting a temp file)."
(let ((running (eq (process-status server-process) 'run))
(next-buffer nil)
(killed nil)
(setq server-clients (delq client server-clients))))
(setq old-clients (cdr old-clients)))
(if (and (bufferp buffer) (buffer-name buffer))
- (progn
+ ;; 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))
(save-excursion
(set-buffer buffer)
(setq server-buffer-clients nil)
(run-hooks 'server-done-hook))
- (if for-killing
- (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-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)."
+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."
(let ((buffer (current-buffer)))
(if server-buffer-clients
(progn
(add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
(defvar server-kill-buffer-running nil
- "Non-nil while `server-kill-buffer' is running.")
+ "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
;; When a buffer is killed, inform the clients.
(add-hook 'kill-buffer-hook 'server-kill-buffer)
;; Prevent infinite recursion if user has made server-done-hook
;; call kill-buffer.
(or server-kill-buffer-running
- (let ((server-kill-buffer-running t))
- (when server-process
- (server-buffer-done (current-buffer) t)))))
+ (and server-buffer-clients
+ (let ((server-kill-buffer-running t))
+ (when server-process
+ (server-buffer-done (current-buffer) t))))))
\f
(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 <draft> files are always saved and backed up,
(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))))
+ (when (window-dedicated-p (selected-window))
+ (select-window (get-window-with-predicate
+ (lambda (w) (not (window-dedicated-p w)))
+ 'nomini 'visible (selected-window))))
(set-window-dedicated-p (selected-window) nil)
(if next-buffer
(if (and (bufferp next-buffer)
(switch-to-buffer (other-buffer))))))
(global-set-key "\C-x#" 'server-edit)
+
+(defun server-unload-hook ()
+ (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))
\f
(provide 'server)