[PATCH 2/5] emacs: Introduce REPL operation type.

[PATCH 2/5] emacs: Introduce REPL operation type.

[Alex Kost]

[-- Attachment #1: Type: text/plain, Size: 82 bytes --]

This is an auxiliary commit for a “pull” operation added in a later patch.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0002-emacs-Introduce-REPL-operation-type.patch --]
[-- Type: text/x-diff, Size: 2932 bytes --]

From ef04333314fbe738d18d33b23a67dc47c8e75dbb Mon Sep 17 00:00:00 2001
From: Alex Kost <alezost@gmail.com>
Date: Mon, 20 Oct 2014 23:18:13 +0400
Subject: [PATCH 2/5] emacs: Introduce REPL operation type.

* emacs/guix-backend.el (guix-repl-operation-type): New variable.
  (guix-repl-output-filter): Run type hooks after performing an operation.
  (guix-eval-read): Add 'operation-type' argument.
---
 emacs/guix-backend.el | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

diff --git a/emacs/guix-backend.el b/emacs/guix-backend.el
index d37d9d4..ddc106f 100644
--- a/emacs/guix-backend.el
+++ b/emacs/guix-backend.el
@@ -133,6 +133,9 @@ This REPL is used for receiving information only if
 This internal variable is used to distinguish Guix operations
 from operations performed in Guix REPL by a user.")
 
+(defvar guix-repl-operation-type nil
+  "Type of the current operation performed by `guix-eval-in-repl'.")
+
 (defun guix-repl-operation-success-message ()
   "Message telling about successful Guix operation."
   (message "Guix operation has been performed."))
@@ -232,7 +235,16 @@ This is a replacement for `geiser-repl--output-filter'."
     (geiser-autodoc--disinhibit-autodoc)
     (when guix-repl-operation-p
       (setq guix-repl-operation-p nil)
-      (run-hooks 'guix-after-repl-operation-hook)))
+      (run-hooks 'guix-after-repl-operation-hook)
+      ;; Run hooks specific to the current operation type.
+      (when guix-repl-operation-type
+        (let ((type-hook (intern
+                          (concat "guix-after-"
+                                  (symbol-name guix-repl-operation-type)
+                                  "-hook"))))
+          (setq guix-repl-operation-type nil)
+          (and (boundp type-hook)
+               (run-hooks type-hook))))))
    ((string-match geiser-guile--debugger-prompt-regexp str)
     (setq guix-repl-operation-p nil)
     (geiser-con--connection-set-debugging geiser-repl--connection
@@ -317,12 +329,17 @@ Return elisp expression of the first result value of evaluation."
          (replace-regexp-in-string
           "#t" "t" (car (guix-eval str wrap))))))
 
-(defun guix-eval-in-repl (str &optional operation-buffer)
+(defun guix-eval-in-repl (str &optional operation-buffer operation-type)
   "Switch to Guix REPL and evaluate STR with guile expression there.
 If OPERATION-BUFFER is non-nil, it should be a buffer from which
-the current operation was performed."
+the current operation was performed.
+
+If OPERATION-TYPE is non-nil, it should be a symbol.  After
+successful executing of the current operation,
+`guix-after-OPERATION-TYPE-hook' is called."
   (run-hooks 'guix-before-repl-operation-hook)
   (setq guix-repl-operation-p t
+        guix-repl-operation-type operation-type
         guix-operation-buffer operation-buffer)
   (let ((repl (guix-get-repl-buffer)))
     (with-current-buffer repl
-- 
2.1.2

Re: [PATCH 2/5] emacs: Introduce REPL operation type.

[Ludovic Courtès]

Alex Kost <alezost@gmail.com> skribis:

> This is an auxiliary commit for a “pull” operation added in a later patch.
>
>
> From ef04333314fbe738d18d33b23a67dc47c8e75dbb Mon Sep 17 00:00:00 2001
> From: Alex Kost <alezost@gmail.com>
> Date: Mon, 20 Oct 2014 23:18:13 +0400
> Subject: [PATCH 2/5] emacs: Introduce REPL operation type.
>
> * emacs/guix-backend.el (guix-repl-operation-type): New variable.
>   (guix-repl-output-filter): Run type hooks after performing an operation.
>   (guix-eval-read): Add 'operation-type' argument.

[...]

> +(defvar guix-repl-operation-type nil
> +  "Type of the current operation performed by `guix-eval-in-repl'.")

Could you write something about the valid values it may take and their
meaning?

Otherwise LGTM.

Ludo’.

Re: [PATCH 2/5] emacs: Introduce REPL operation type.

[Alex Kost]

Ludovic Courtès (2014-10-26 21:37 +0300) wrote:

> Alex Kost <alezost@gmail.com> skribis:
>
>> This is an auxiliary commit for a “pull” operation added in a later patch.
>>
>>
>> From ef04333314fbe738d18d33b23a67dc47c8e75dbb Mon Sep 17 00:00:00 2001
>> From: Alex Kost <alezost@gmail.com>
>> Date: Mon, 20 Oct 2014 23:18:13 +0400
>> Subject: [PATCH 2/5] emacs: Introduce REPL operation type.
>>
>> * emacs/guix-backend.el (guix-repl-operation-type): New variable.
>>   (guix-repl-output-filter): Run type hooks after performing an operation.
>>   (guix-eval-read): Add 'operation-type' argument.
>
> [...]
>
>> +(defvar guix-repl-operation-type nil
>> +  "Type of the current operation performed by `guix-eval-in-repl'.")
>
> Could you write something about the valid values it may take and their
> meaning?
>
> Otherwise LGTM.

It's an internal variable set by ‘guix-eval-in-repl’.

The point of an “operation type” is to run some specialized actions
after finishing a REPL operation (e.g., to refresh buffers after ‘pull’
operation).

If there is ‘guix-after-foo-hook’ variable and ‘guix-eval-in-repl’ is
called with ‘foo’ operation-type, the hooks from that var will be called
after executing ‘foo’ operation.

Currently only ‘pull’ operation type is used, so ‘guix-after-pull-hook’
is called after a pull operation.

Re: [PATCH 2/5] emacs: Introduce REPL operation type.

[Ludovic Courtès]

Alex Kost <alezost@gmail.com> skribis:

> Ludovic Courtès (2014-10-26 21:37 +0300) wrote:
>
>> Alex Kost <alezost@gmail.com> skribis:
>>
>>> This is an auxiliary commit for a “pull” operation added in a later patch.
>>>
>>>
>>> From ef04333314fbe738d18d33b23a67dc47c8e75dbb Mon Sep 17 00:00:00 2001
>>> From: Alex Kost <alezost@gmail.com>
>>> Date: Mon, 20 Oct 2014 23:18:13 +0400
>>> Subject: [PATCH 2/5] emacs: Introduce REPL operation type.
>>>
>>> * emacs/guix-backend.el (guix-repl-operation-type): New variable.
>>>   (guix-repl-output-filter): Run type hooks after performing an operation.
>>>   (guix-eval-read): Add 'operation-type' argument.
>>
>> [...]
>>
>>> +(defvar guix-repl-operation-type nil
>>> +  "Type of the current operation performed by `guix-eval-in-repl'.")
>>
>> Could you write something about the valid values it may take and their
>> meaning?

Sorry, I meant as comment in the docstring above.  :-)

>> Otherwise LGTM.
>
> It's an internal variable set by ‘guix-eval-in-repl’.
>
> The point of an “operation type” is to run some specialized actions
> after finishing a REPL operation (e.g., to refresh buffers after ‘pull’
> operation).
>
> If there is ‘guix-after-foo-hook’ variable and ‘guix-eval-in-repl’ is
> called with ‘foo’ operation-type, the hooks from that var will be called
> after executing ‘foo’ operation.
>
> Currently only ‘pull’ operation type is used, so ‘guix-after-pull-hook’
> is called after a pull operation.

OK, thanks.  Feel free to commit with the explanation folded into the
docstring.

Ludo’.