From: Austin Clements Date: Sat, 1 Jun 2013 00:40:04 +0000 (+2000) Subject: [PATCH v3 2/6] emacs: Utilities to manage asynchronous notmuch processes X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=70704c36dc525e3c7701b9ff03675eceb0ac195d;p=notmuch-archives.git [PATCH v3 2/6] emacs: Utilities to manage asynchronous notmuch processes --- diff --git a/33/57a84d89e4db1d1ff9c7969f14f15ea8738aae b/33/57a84d89e4db1d1ff9c7969f14f15ea8738aae new file mode 100644 index 000000000..7c7624884 --- /dev/null +++ b/33/57a84d89e4db1d1ff9c7969f14f15ea8738aae @@ -0,0 +1,196 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id D84CC431FDE + for ; Fri, 31 May 2013 17:40:45 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id gv0mi8ebGuU3 for ; + Fri, 31 May 2013 17:40:41 -0700 (PDT) +Received: from dmz-mailsec-scanner-1.mit.edu (dmz-mailsec-scanner-1.mit.edu + [18.9.25.12]) + by olra.theworths.org (Postfix) with ESMTP id 576E0429E38 + for ; Fri, 31 May 2013 17:40:25 -0700 (PDT) +X-AuditID: 1209190c-b7f566d000004c69-62-51a942f82a60 +Received: from mailhub-auth-1.mit.edu ( [18.9.21.35]) + by dmz-mailsec-scanner-1.mit.edu (Symantec Messaging Gateway) with SMTP + id 56.73.19561.8F249A15; Fri, 31 May 2013 20:40:24 -0400 (EDT) +Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) + by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id r510eD8R008173; + Fri, 31 May 2013 20:40:13 -0400 +Received: from drake.dyndns.org (c-76-21-105-205.hsd1.ca.comcast.net + [76.21.105.205]) (authenticated bits=0) + (User authenticated as amdragon@ATHENA.MIT.EDU) + by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r510e9ve020941 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Fri, 31 May 2013 20:40:12 -0400 +Received: from amthrax by drake.dyndns.org with local (Exim 4.77) + (envelope-from ) + id 1UiZrd-0003QR-CA; Fri, 31 May 2013 20:40:09 -0400 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH v3 2/6] emacs: Utilities to manage asynchronous notmuch + processes +Date: Fri, 31 May 2013 20:40:04 -0400 +Message-Id: <1370047208-12785-3-git-send-email-amdragon@mit.edu> +X-Mailer: git-send-email 1.7.10.4 +In-Reply-To: <1370047208-12785-1-git-send-email-amdragon@mit.edu> +References: <1370047208-12785-1-git-send-email-amdragon@mit.edu> +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFjrGIsWRmVeSWpSXmKPExsUixCmqrPvDaWWgwaG/Fhar5/JYXL85k9ni + zcp5rA7MHjtn3WX3OPx1IYvHs1W3mAOYo7hsUlJzMstSi/TtErgyGqZZF3zSqmhcNJG1gXGZ + UhcjJ4eEgInEvkO/WSFsMYkL99azdTFycQgJ7GOUWL3mFjuEs5FR4uyka8wQzmkmiZtbZ0KV + zWWUmPXgKQtIP5uAhsS2/csZQWwRAWmJnXdng81lFoiT2DLlP1hcWCBQYnPHGTYQm0VAVeLz + m7dgcV4BB4nXDR/YIO5QlOh+NgHM5hRwlDh/9R8ziC0EVPP4xEnmCYz8CxgZVjHKpuRW6eYm + ZuYUpybrFicn5uWlFuka6uVmluilppRuYgQHlyTPDsY3B5UOMQpwMCrx8HasWhEoxJpYVlyZ + e4hRkoNJSZR3tuPKQCG+pPyUyozE4oz4otKc1OJDjBIczEoivPlzgMp5UxIrq1KL8mFS0hws + SuK8l1Nu+gsJpCeWpGanphakFsFkZTg4lCR41YBRJCRYlJqeWpGWmVOCkGbi4AQZzgM03A2k + hre4IDG3ODMdIn+KUVFKnDcIJCEAksgozYPrhUX/K0ZxoFeEIdp5gIkDrvsV0GAmoMFPrJeD + DC5JREhJNTDW72CzW3V85Zq9Pp94DEwUzwR6fjMU+jev8/Rz1ys7lqf6KO6tW7q/6/Tc3AN5 + yyYX8vh1OpusyVgYsHiuSKn8npKLX6IPdahtEvznc5H5VL1vn47G1fmt07qk/zStKJ109+PW + tX3df14pf34y3ezd1x27/xbvirtlUNHP91Rh8fQi/U9LjnxOUWIpzkg01GIuKk4EADmM0hjZ AgAA +Cc: tomi.ollila@iki.fi +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sat, 01 Jun 2013 00:40:46 -0000 + +This provides a new notmuch-lib utility to start an asynchronous +notmuch process that handles redirecting of stderr and checking of the +exit status. This is similar to `notmuch-call-notmuch-json', but for +asynchronous processes (and it leaves output processing to the +caller). +--- + emacs/notmuch-lib.el | 77 +++++++++++++++++++++++++++++++++++++++++++++++--- + 1 file changed, 73 insertions(+), 4 deletions(-) + +diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el +index 59b1ce3..a206808 100644 +--- a/emacs/notmuch-lib.el ++++ b/emacs/notmuch-lib.el +@@ -383,18 +383,21 @@ signaled error. This function does not return." + (error "%s" (concat msg (when extra + " (see *Notmuch errors* for more details)")))) + +-(defun notmuch-check-async-exit-status (proc msg) ++(defun notmuch-check-async-exit-status (proc msg &optional command err-file) + "If PROC exited abnormally, pop up an error buffer and signal an error. + + This is a wrapper around `notmuch-check-exit-status' for + asynchronous process sentinels. PROC and MSG must be the +-arguments passed to the sentinel." ++arguments passed to the sentinel. COMMAND and ERR-FILE, if ++provided, are passed to `notmuch-check-exit-status'. If COMMAND ++is not provided, it is taken from `process-command'." + (let ((exit-status + (case (process-status proc) + ((exit) (process-exit-status proc)) + ((signal) msg)))) + (when exit-status +- (notmuch-check-exit-status exit-status (process-command proc))))) ++ (notmuch-check-exit-status exit-status (or command (process-command proc)) ++ nil err-file)))) + + (defun notmuch-check-exit-status (exit-status command &optional output err-file) + "If EXIT-STATUS is non-zero, pop up an error buffer and signal an error. +@@ -448,7 +451,7 @@ You may need to restart Emacs or upgrade your notmuch package.")) + )))) + + (defun notmuch-call-notmuch-json (&rest args) +- "Invoke `notmuch-command' with `args' and return the parsed JSON output. ++ "Invoke `notmuch-command' with ARGS and return the parsed JSON output. + + The returned output will represent objects using property lists + and arrays as lists. If notmuch exits with a non-zero status, +@@ -469,6 +472,72 @@ an error." + (json-read))) + (delete-file err-file))))) + ++(defun notmuch-start-notmuch (name buffer sentinel &rest args) ++ "Start and return an asynchronous notmuch command. ++ ++This starts and returns an asynchronous process running ++`notmuch-command' with ARGS. The exit status is checked via ++`notmuch-check-async-exit-status'. Output written to stderr is ++redirected and displayed when the process exits (even if the ++process exits successfully). NAME and BUFFER are the same as in ++`start-process'. SENTINEL is a process sentinel function to call ++when the process exits, or nil for none. The caller must *not* ++invoke `set-process-sentinel' directly on the returned process, ++as that will interfere with the handling of stderr and the exit ++status." ++ ++ ;; There is no way (as of Emacs 24.3) to capture stdout and stderr ++ ;; separately for asynchronous processes, or even to redirect stderr ++ ;; to a file, so we use a trivial shell wrapper to send stderr to a ++ ;; temporary file and clean things up in the sentinel. ++ (let* ((err-file (make-temp-file "nmerr")) ++ ;; Use a pipe ++ (process-connection-type nil) ++ ;; Find notmuch using Emacs' `exec-path' ++ (command (or (executable-find notmuch-command) ++ (error "command not found: %s" notmuch-command))) ++ (proc (apply #'start-process name buffer ++ "/bin/sh" "-c" ++ "exec 2>\"$1\"; shift; exec \"$0\" \"$@\"" ++ command err-file args))) ++ (process-put proc 'err-file err-file) ++ (process-put proc 'sub-sentinel sentinel) ++ (process-put proc 'real-command (cons notmuch-command args)) ++ (set-process-sentinel proc #'notmuch-start-notmuch-sentinel) ++ proc)) ++ ++(defun notmuch-start-notmuch-sentinel (proc event) ++ (let ((err-file (process-get proc 'err-file)) ++ (sub-sentinel (process-get proc 'sub-sentinel)) ++ (real-command (process-get proc 'real-command))) ++ (condition-case err ++ (progn ++ ;; Invoke the sub-sentinel, if any ++ (when sub-sentinel ++ (funcall sub-sentinel proc event)) ++ ;; Check the exit status. This will signal an error if the ++ ;; exit status is non-zero. ++ (notmuch-check-async-exit-status proc event real-command err-file) ++ ;; If that didn't signal an error, then any error output was ++ ;; really warning output. Show warnings, if any. ++ (let ((warnings ++ (with-temp-buffer ++ (unless (= (second (insert-file-contents err-file)) 0) ++ (end-of-line) ++ ;; Show first line; stuff remaining lines in the ++ ;; errors buffer. ++ (let ((l1 (buffer-substring (point-min) (point)))) ++ (skip-chars-forward "\n") ++ (cons l1 (unless (eobp) ++ (buffer-substring (point) (point-max))))))))) ++ (when warnings ++ (notmuch-logged-error (car warnings) (cdr warnings))))) ++ (error ++ ;; Emacs behaves strangely if an error escapes from a sentinel, ++ ;; so turn errors into messages. ++ (message "%s" (error-message-string err)))) ++ (ignore-errors (delete-file err-file)))) ++ + ;; This variable is used only buffer local, but it needs to be + ;; declared globally first to avoid compiler warnings. + (defvar notmuch-show-process-crypto nil) +-- +1.7.10.4 +