InfoMagic Source Code 1993 July/THE_SOURCE_CODE_CD_ROM.iso/languages/elisp/misc/server-num.el

Text File | 1990-07-22 | 15.7 KB | 632 lines

;From ark1!nems!mimsy!haven!udel!wuarchive!gem.mps.ohio-state.edu!tut.cis.ohio-state.edu!att.att.com!ho5cad!msb Fri Oct 27 08:55:32 1989
;Article 331 of gnu.emacs.bug
;Path: ark1!nems!mimsy!haven!udel!wuarchive!gem.mps.ohio-state.edu!tut.cis.ohio-state.edu!att.att.com!ho5cad!msb
;From ho5cad![e-mail]
;Newsgroups: gnu.emacs.bug
;Subject: emacsclient.c & server.el
;Message-ID: <[e-mail]>
;Date: 26 Oct 89 18:25:00 GMT
;Sender: [e-mail]
;Reply-To: [e-mail] (Mike Balenger)
;Distribution: gnu
;Organization: GNUs Not Usenet
;Lines: 379
;
;
;(insert (emacs-version))
;GNU Emacs 18.55.1 of Sun Aug 27 1989 on ho5cad (usg-unix-v)
;
;
;If I invoke emacsclient with the following arguments,
;    +20 .profile +30 /etc/passwd .env
;
;On a SysV machine, emacsclient effectively sends
;    $PWD/+20 $PWD/.profile $PWD/+30 /etc/passwd $PWD/.env
;
;but on a BSD machine, emacsclient effectively sends
;    +20 $PWD/.profile +30 /etc/passwd $PWD/.env
;
;That is, the BSD main() is smart enough to recognize the difference
;between filename arguments and line number arguments, and prefix only
;(non-absolute) filenames with the current working directory.
;
;The fact that emacsclient handles line numbers is strange, since
;server.el doesn't handle them.  There was a posting that I call
;server_num.el which does handle the \+[0-9]+ regexp recognition of
;line numbers.  I have included a copy of it, in case you didn't catch
;it on the way through.  It is a minor change to the server.el code.
;Server_num.el was apparently written by someone working on a SysV
;machine, because the regexp was looking for /\+[0-9]+, that is a
;leading "/" before the "+".
;
;Removing the "/" from the regep, and fixing the previous difference in
;emacsclient will allow the two packages to work together on either
;system.
;
;There was also another annoyance in the revert-buffer function of the
;server.el such that second and subsequent emacsclient requests for the
;same file would require user input to revert the file.  That behavior
;is changed in the enclosed server_num.el
;
;A request for a future enhancement -- could you add code to have the
;server-edit do a kill-buffer on the current buffer.  This action
;should be based on a prefix argument, since I don't always want this
;action.
;
;I have EDITOR set to emacsclient.  At some times, this creates a lot
;of /tmp/$$ files from stuff like mailers, MR entry tools, and DB
;update tools.  In these cases, the temporary files and their backup
;files are useless trash after finishing the file modification with
;C-#.  Having them stick around clutters up emacs buffers, AND the file
;system.  The application removes them, but emacs comes along later and
;auto-saves them and the backup versions of them.
;
;At other times, I have files brought into buffers from a code
;searching tool, or more(1).  In this case, it would be nice to have
;the files stick around, and have normal auto-saving, since these are
;"REAL" files.  The other ones were "TEMPORARY" files.
;
;If you have any questions about this, please call me (collect) or send
;E-mail.
;
;Thanks,
;Mike Balenger
;----------------------------------------------------------------------
;<cute quote>            Michael S. Balenger             [phone]
;<cute disclaimer>       AT&T Bell Labs
;                        Room 1L-405
;[e-mail]      Crawfords Corner Road
;att!ho5cad!msb          Holmdel, NJ   07733
;
;================================================================
;begin server_num.el
;================================================================
;;From [e-mail] Fri Aug  5 09:36:45 1988
;;From: [e-mail] (Ilhamuddin Ahmed)
;;Newsgroups: comp.emacs
;;Subject: Emacsclient taking line-number as an argument
;;Keywords: emacsclient, arguments
;;Date: 4 Aug 88 22:27:07 GMT
;;Reply-To: [e-mail] (Ilhamuddin Ahmed)
;;Organization: MIT Laboratory for Computer Science
;;
;;
;;I sent a message before saying I had an emacs lisp code which allows
;;emacsclient to take linenumber as an argument. Well, at first I posted
;;about 6 of them directly but there seems to be a pretty high demand so I
;;am posting it to the net.
;;
;;                        - Ilham
;;
;;
;;==============================================================================
;;
;;            \\\!///             From  :   Ilhamuddin Ahmed
;;             _   _              UUCP  :   {backbone}!mit-eddie!athena!ilham
;;           ( Q   Q )            Arpa  :   [e-mail]
;; ---,,,,-------U-------,,,,---  USnail:   MIT Laboratory for Computer Science
;;                                          545 Technology Square, Room 213
;;            HELLO!!!                      Cambridge, MA 02139.
;; -----------------------------  Phone :   [phone]
;;
;;==============================================================================



;; server.el     (emacsclient +number filename)
;;

;; Michael Platoff
;; Siemens Research and Technology Labs
;; 105 College Road East
;; Princeton, NJ 08540-6668
;; [phone]
;; EMAIL: [e-mail]
;;        {allegra,princeton}!siemens!cadillac.siemens.com!map

;; Lisp code for GNU Emacs running as server process.
;; Copyright (C) 1986, 1987 Free Software Foundation, Inc.
;; Author William Sommerfeld, [e-mail].
;; Changes by [e-mail] and by rms.

;; This file is part of GNU Emacs.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY.  No author or distributor
;; accepts responsibility to anyone for the consequences of using it
;; or for whether it serves any particular purpose or works at all,
;; unless he says so in writing.  Refer to the GNU Emacs General Public
;; License for full details.

;; Everyone is granted permission to copy, modify and redistribute
;; GNU Emacs, but only under the conditions described in the
;; GNU Emacs General Public License.   A copy of this license is
;; supposed to have been given to you along with GNU Emacs so you
;; can know your rights and responsibilities.  It should be in a
;; file named COPYING.  Among other things, the copyright notice
;; and this notice must be preserved on all copies.


;;; 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 ../etc/server as a subprocess
;;; 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 ../etc/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.

;;; 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 two cases:

;;; 1. On a window system, where Emacs runs in one window and the
;;; program that wants to use "the editor" runs in another.

;;; 2. When the program that wants to use "the editor" is running
;;; as a subprocess of Emacs.

;;; 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.




























































(defvar server-program "server"
  "*The program to use as the edit server")

(defvar server-process nil
  "the current server process")

(defvar server-clients nil
  "List of current server clients.
Each element is (CLIENTID FILES...) where CLIENTID is a string
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.")

(make-variable-buffer-local 'server-buffer-clients)
(setq-default server-buffer-clients nil)
(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)
  (if (get-buffer "*server*")
      (save-excursion
    (set-buffer "*server*")
    (goto-char (point-max))
    (insert string)
    (or (bobp) (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")))))

(defun server-start (&optional leave-dead)
  "Allow this Emacs process to be a server for client processes.
This starts a server communications subprocess through which
client \"editors\" can send your editing commands to this Emacs job.
To use the server, set up the program `etc/emacsclient' in the
Emacs distribution as your standard \"editor\".

Prefix arg means just kill any existing server communications subprocess."
  (interactive "P")
  ;; 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))
  ;; If we 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
    (server-log (message "Restarting server"))
    (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)))




























































;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)
  (if (not (eq 0 (string-match "Client: " string)))
      nil
    (setq string (substring string (match-end 0)))
    (let ((client (list (substring string 0 (string-match " " string))))
      (filenames nil)
      (filename nil)
      (lineno nil))
      (setq string (substring string (match-end 0)))
      (while (string-match "[^ ]+ " string)
    (setq filename
          (substring string (match-beginning 0) (1- (match-end 0))))
    (if (string-match "/\\(\\+[0-9]+\\)" filename)
        (progn
          (setq lineno
            (string-to-int (substring filename (match-beginning 1))))
          (string-match "[^ ]* \\([^ ]+\\) " string)
          (setq filename (substring string
                    (match-beginning 1)
                    (match-end 1))))
      (setq lineno 1))
    (setq filenames
          (cons (list filename lineno)
            filenames))
    (setq string (substring string (match-end 0))))
      (server-visit-files filenames client)
      ;; CLIENT is now a list (CLIENTNUM BUFFERS...)
      (setq server-clients (cons client server-clients))
      (switch-to-buffer (nth 1 client))
      (message (substitute-command-keys
        "When done with a buffer, type \\[server-edit].")))))

(defun server-visit-files (filenames client)
  "Finds FILES and returns the list CLIENT with the buffers nconc'd."
  (let (client-record)
    (while filenames
      (save-excursion
    ;; If there is an existing buffer that's not modified, revert it.
    ;; If there is an existing buffer with deleted file, offer to write it.
     (let* ((filename (car (car filenames)))
           (lineno (car (cdr (car filenames))))
           (obuf (get-file-buffer filename)))
       (if (and obuf (set-buffer obuf))
           (if (file-exists-p filename)
           (if (buffer-modified-p obuf) nil
            (revert-buffer t t)) ; was t nil -- msb
         (if (y-or-n-p
              (concat "File no longer exists: "
                  filename
                  ", write buffer to file? "))
             (write-file filename)))
        (set-buffer (find-file-noselect filename))))
      (goto-line lineno)
      (setq server-buffer-clients (cons (car client) server-buffer-clients))
      (setq client-record (cons (current-buffer) client-record)))
        (setq filenames (cdr filenames)))
    (nconc client client-record)))




























































(defun server-buffer-done (buffer)
  "Mark BUFFER as \"done\" for its client(s).
Buries the buffer, and returns another server buffer
as a suggestion for what to select next."
  (let ((running (eq (process-status server-process) 'run))
    (next-buffer nil)
    (old-clients server-clients))
    (while old-clients
      (let ((client (car old-clients)))
    (or next-buffer
        (setq next-buffer (nth 1 (memq buffer client))))
    (delq buffer client)
    ;; 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)))))
      (setq server-clients (delq client server-clients))))
      (setq old-clients (cdr old-clients)))
    (if (buffer-name buffer)
    (save-excursion
      (set-buffer buffer)
      (setq server-buffer-clients nil)))
    (bury-buffer buffer)
    next-buffer))

(defun mh-draft-p (buffer)
  "Return non-nil if this BUFFER is an mh <draft> file.
Since MH deletes draft *BEFORE* it is edited, the server treats them specially."
 ;; This may not be appropriately robust for all cases.
  (string= (buffer-name buffer) "draft"))

(defun server-done ()
  "Offer to save current buffer, mark it as \"done\" for clients,
bury it, and return a suggested buffer to select next."
  (let ((buffer (current-buffer)))
    (if server-buffer-clients
    (progn
       (if (mh-draft-p buffer)
           (progn (save-buffer)
             (write-region (point-min) (point-max)
                   (concat buffer-file-name "~"))
             (kill-buffer buffer))
        (if (and (buffer-modified-p)
             (y-or-n-p (concat "Save file" buffer-file-name "? ")))
        (save-buffer buffer)))
      (server-buffer-done buffer)))))




























































(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.
MH <draft> files are always saved and backed up, no questions asked.
When all of a client's buffers are marked as \"done\", the client is notified.

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
      (not server-process)
      (memq (process-status server-process) '(signal exit)))
      (server-start nil)
    (server-switch-buffer (server-done))))

(defun server-switch-buffer (next-buffer)
  "Switch to another buffer, preferably one that has a client.
Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
  (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
    ;; and try the next surviving server buffer.
    (server-switch-buffer
     (server-buffer-done next-buffer)))
    (if server-clients
    (server-switch-buffer (nth 1 (car server-clients)))
      (switch-to-buffer (other-buffer)))))

(global-set-key "\C-x#" 'server-edit)