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
| | ;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2015-2016, 2019-2022 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2015 Mathieu Lirzin <mthl@gnu.org>
;;; Copyright © 2020, 2021 Simon Tournier <zimon.toutoune@gmail.com>
;;;
;;; 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 scripts edit)
#:use-module (guix ui)
#:use-module (guix scripts)
#:use-module (guix store)
#:use-module ((guix scripts build) #:select (%standard-build-options))
#:use-module ((guix diagnostics)
#:select (location-file location-line))
#:use-module (gnu packages)
#:use-module (srfi srfi-1)
#:use-module (srfi srfi-37)
#:export (%editor
spawn-editor
guix-edit))
(define %options
(list (find (lambda (option)
(member "load-path" (option-names option)))
%standard-build-options)
(option '(#\h "help") #f #f
(lambda args
(show-help)
(exit 0)))
(option '(#\V "version") #f #f
(lambda args
(show-version-and-exit "guix edit")))))
(define (show-help)
(display (G_ "Usage: guix edit PACKAGE...
Start $VISUAL or $EDITOR to edit the definitions of PACKAGE...\n"))
(newline)
(display (G_ "
-L, --load-path=DIR prepend DIR to the package module search path"))
(newline)
(display (G_ "
-h, --help display this help and exit"))
(display (G_ "
-V, --version display version information and exit"))
(newline)
(show-bug-report-information))
(define %editor
;; Nano is sensible default, as it is installed by base system.
;; For development, user can set custom value for $EDITOR.
(make-parameter (or (getenv "VISUAL") (getenv "EDITOR") "nano")))
(define (search-path* path file)
"Like 'search-path' but exit if FILE is not found."
(let ((absolute-file-name (search-path path file)))
(unless absolute-file-name
;; Shouldn't happen unless somebody fiddled with the 'location' field.
(leave (G_ "file '~a' not found in search path ~s~%")
file path))
absolute-file-name))
(define (spawn-editor locations specs)
"Spawn (%editor) to edit the code at LOCATIONS, a list of <location>
records, and exit."
(let ((location->location-specification
(lambda (location)
"Return the location specification for LOCATION for a typical
editor command line. As a side-effect, if the LOCATION is a store path,
leave with an error message."
(list (string-append "+"
(number->string
(location-line location)))
(let ((path (search-path* %load-path (location-file location))))
(if (store-path? path)
(leave (G_ " '~a' is not directly editable.~%
Hint: Try 'guix contrib edit ~a' in order to prepare a Guix development environment
in your home directory and edit it there.~%")
path (string-join specs " "))
path))))))
(catch 'system-error
(lambda ()
(let ((file-names (append-map location->location-specification
locations)))
;; Use `system' instead of `exec' in order to sanely handle
;; possible command line arguments in %EDITOR.
(exit (system (string-join (cons (%editor) file-names))))))
(lambda args
(let ((errno (system-error-errno args)))
(leave (G_ "failed to launch '~a': ~a~%")
(%editor) (strerror errno)))))))
\f
(define-command (guix-edit . args)
(category packaging)
(synopsis "view and edit package definitions")
(define (parse-arguments)
;; Return the list of package names.
(parse-command-line args %options (list (list))
#:build-options? #f
#:argument-handler cons))
(with-error-handling
(let* ((specs (reverse (parse-arguments)))
(locations (map specification->location specs)))
(when (null? specs)
(leave (G_ "no packages specified, nothing to edit~%")))
(spawn-editor locations (parse-arguments)))))
|