summaryrefslogtreecommitdiff
path: root/guix/monad-repl.scm
blob: d6b39112b774acf73601e033ab5437593f8a3792 (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2014-2016, 2022-2023 Ludovic Courtès <ludo@gnu.org>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (guix monad-repl)
  #:use-module (guix store)
  #:use-module (guix monads)
  #:use-module (guix utils)
  #:use-module (guix packages)
  #:autoload   (guix build-system) (bag)
  #:use-module (guix status)
  #:autoload   (guix gexp) (gexp gexp? lower-gexp lowered-gexp-sexp lower-object)
  #:use-module ((guix derivations)
                #:select (derivation?
                          derivation->output-paths built-derivations))
  #:autoload   (guix read-print) (pretty-print-with-comments)
  #:use-module (ice-9 match)
  #:autoload   (ice-9 pretty-print) (pretty-print)
  #:use-module (system repl repl)
  #:use-module (system repl common)
  #:use-module (system repl command)
  #:use-module (system base language)
  #:use-module (system base compile)
  #:use-module (srfi srfi-26)
  #:export (run-in-store
            enter-store-monad))

;;; Comment:
;;;
;;; This modules provides a couple of REPL meta-commands that make it easier
;;; to work with monadic procedures in the store monad.
;;;
;;; Code:

(define* (monad-language monad run #:optional (name 'monad))
  "Return a language with a special evaluator that causes monadic values
 to be \"run\" in MONAD using procedure RUN."
  (let ((scheme (lookup-language 'scheme)))
    (define (evaluate-monadic-expression exp env)
      (let ((mvalue (compile exp #:to 'value #:env env)))
        (run mvalue)))

    (make-language #:name name
                   #:title "Monad"
                   #:reader (language-reader scheme)
                   #:compilers (language-compilers scheme)
                   #:decompilers (language-decompilers scheme)
                   #:evaluator evaluate-monadic-expression
                   #:printer (language-printer scheme)
                   #:make-default-environment
                   (language-make-default-environment scheme))))

(define* (default-guile-derivation store #:optional (system (%current-system)))
  "Return the derivation of the default "
  (package-derivation store (default-guile) system))

(define (store-monad-language store)
  "Return a compiler language for the store monad using STORE."
  (let ((guile (or (%guile-for-build)
                   (default-guile-derivation store))))
    (monad-language %store-monad
                    (cut run-with-store store <>
                         #:guile-for-build guile)
                    'store-monad)))

(define %build-verbosity
  ;; Current build verbosity level.
  1)

(define* (evaluate/print-with-store mvalue #:key build?)
  "Run monadic value MVALUE in the store monad and print its value."
  (with-store store
    (set-build-options store
                       #:print-build-trace #t
                       #:print-extended-build-trace? #t
                       #:multiplexed-build-output? #t)
    (with-status-verbosity %build-verbosity
      (let* ((guile  (or (%guile-for-build)
                         (default-guile-derivation store)))
             (values (run-with-store store
                       (if build?
                           (mlet %store-monad ((obj mvalue))
                             (if (derivation? obj)
                                 (mbegin %store-monad
                                   (built-derivations (list obj))
                                   (return
                                    (match (derivation->output-paths obj)
                                      (((_ . files) ...) files))))
                                 (return (list obj))))
                           (mlet %store-monad ((obj mvalue))
                             (return (list obj))))
                       #:guile-for-build guile)))
        (for-each (lambda (value)
                    (run-hook before-print-hook value)
                    (pretty-print value))
                  values)))))

(define-meta-command ((run-in-store guix) repl (form))
  "run-in-store EXP
Run EXP through the store monad."
  (evaluate/print-with-store (repl-eval repl form)))

(define-meta-command ((verbosity guix) repl (level))
  "verbosity LEVEL
Change build verbosity to LEVEL."
  (set! %build-verbosity (repl-eval repl level)))

(define-meta-command ((lower guix) repl (form))
  "lower OBJECT
Lower OBJECT into a derivation or store file and return it."
  (evaluate/print-with-store (lower-object (repl-eval repl form))))

(define-meta-command ((build guix) repl (form))
  "build OBJECT
Lower OBJECT and build it, returning its output file name(s)."
  (evaluate/print-with-store (lower-object (repl-eval repl form))
                             #:build? #t))

(define-meta-command ((enter-store-monad guix) repl)
  "enter-store-monad
Enter a REPL for values in the store monad."
  (with-store store
    (let ((new (make-repl (store-monad-language store))))
      ;; Force interpretation so that our specially-crafted language evaluator
      ;; is actually used.
      (repl-option-set! new 'interp #t)
      (run-repl new))))


;;;
;;; Viewing package arguments.
;;;

(define (keyword-argument-value args keyword default)
  "Return the value associated with KEYWORD in ARGS, a keyword/value sequence,
or DEFAULT if KEYWORD is missing from ARGS."
  (let loop ((args args))
    (match args
      (()
       default)
      ((kw value rest ...)
       (if (eq? kw keyword)
           value
           (loop rest))))))

(define (package-argument-command repl form keyword default)
  "Implement a command that display KEYWORD, a keyword such as #:phases, in
the arguments of the package FORM evaluates to.  Return DEFAULT is KEYWORD is
missing from those arguments."
  (match (repl-eval repl form)
    ((? package? package)
     (let* ((bag* (bag
                    (inherit (package->bag package))
                    (build (lambda* (name inputs #:rest args)
                             (with-monad %store-monad
                               (return (keyword-argument-value args keyword
                                                               default))))))))
       (define phases
         (parameterize ((%graft? #f))
           (with-store store
             (set-build-options store
                                #:print-build-trace #t
                                #:print-extended-build-trace? #t
                                #:multiplexed-build-output? #t)
             (run-with-store store
               (mlet %store-monad ((exp (bag->derivation bag*)))
                 (if (gexp? exp)
                     (mlet %store-monad ((gexp (lower-gexp exp)))
                       (return (lowered-gexp-sexp gexp)))
                     (return exp)))))))

       (run-hook before-print-hook phases)
       (let ((column (port-column (current-output-port))))
         (pretty-print-with-comments (current-output-port) phases
                                     #:indent column)
         (newline (current-output-port)))))
    (_
     (format #t ";; ERROR: This command only accepts package records.~%"))))

(define-meta-command ((phases guix) repl (form))
  "phases
Return the build phases of the package defined by FORM."
  (package-argument-command repl form #:phases #~%standard-phases))

(define-meta-command ((configure-flags guix) repl (form))
  "configure-flags
Return the configure flags of the package defined by FORM."
  (package-argument-command repl form #:configure-flags #~'()))

(define-meta-command ((make-flags guix) repl (form))
  "make-flags
Return the make flags of the package defined by FORM."
  (package-argument-command repl form #:make-flags #~'()))