path: root/gnu.scm
blob: f139531ef3ecf56a790ae73934e2d91016c1aba4 (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
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2014, 2015, 2016, 2017, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2015 Joshua S. Grant <jgrant@parenthetical.io>
;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@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 (gnu)
  #:use-module (guix i18n)
  #:use-module (guix diagnostics)
  #:use-module (srfi srfi-34)
  #:use-module (srfi srfi-35)
  #:use-module (ice-9 match)
  #:use-module (guix packages)
  #:use-module (gnu packages)
  #:use-module (gnu services)
  #:export (use-package-modules
            use-service-modules
            use-system-modules))

;;; Commentary:
;;;
;;; This composite module re-exports core parts the (gnu …) public modules.
;;;
;;; Code:

(eval-when (eval load compile)
  (begin
    (define %public-modules
      '((gnu system)
        (gnu system mapped-devices)
        (gnu system file-systems)
        (gnu bootloader)
        (gnu bootloader grub)
        (gnu system keyboard)
        (gnu system pam)
        (gnu system shadow)                       ; 'user-account'
        (gnu system linux-initrd)
        (gnu system nss)
        (gnu services)
        (gnu services base)
        (gnu packages)
        (gnu packages base)
        (guix gexp)))                             ; so gexps can be used

    (for-each (let ((i (module-public-interface (current-module))))
                (lambda (m)
                  (module-use! i (resolve-interface m))))
              %public-modules)))

(define (%try-use-modules modules location make-hint)
  "Attempt to load all of MODULES.  Report errors as coming from LOCATION, a
<location> record, and use MAKE-HINT to produce a fix hint."
  (define (location->string loc)
    (match loc
      (#f "")
      (($ <location> file line column)
       (format #f "~a:~a:~a: " file line column))))

  (for-each (lambda (module)
              (catch 'misc-error
                (lambda ()
                  (process-use-modules `((,module))))
                (lambda _
                  (raise
                   (apply
                    make-compound-condition
                    (formatted-message (G_ "module ~a not found")
                                       module)
                    (condition
                     (&error-location (location location)))
                    (or (and=> (make-hint module) list)
                        '()))))))
            modules))

(define (package-module-hint module)
  (define last-name
    (match module
      ((_ ... last)
       (symbol->string last))))

  (match (find-packages-by-name last-name)
    (()
     (condition
      (&fix-hint
       (hint (G_ "\
You may use @command{guix package --show=foo | grep location} to search
for the location of package @code{foo}.
If you get the line @code{location: gnu/packages/bar.scm:174:2},
add @code{bar} to the @code{use-package-modules} form.")))))
    ((package _ ...)
     (condition
      (&fix-hint
       (hint (format #f (G_ "\
Try adding @code{(use-package-modules ~a)}.")
                     (basename (location-file (package-location package))
                               ".scm"))))))))

(define (service-module-hint module)
  (define last-name
    (match module
      ((_ ... last)
       last)))

  (match (lookup-service-types last-name)
    (()
     (condition
      (&fix-hint
       (hint (format #f (G_ "\
You may use @command{guix system search ~a} to search for a service
matching @code{~a}.
If you get the line @code{location: gnu/services/foo.scm:188:2},
add @code{foo} to the @code{use-service-modules} form.")
                     last-name last-name)))))
    ((package _ ...)
     (condition
      (&fix-hint
       (hint (format #f (G_ "\
Try adding @code{(use-service-modules ~a)}.")
                     (basename (location-file (service-type-location package))
                               ".scm"))))))))

(define-syntax-rule (try-use-modules hint modules ...)
  (eval-when (expand load eval)
    (%try-use-modules '(modules ...)
                      (source-properties->location
                       (current-source-location))
                      hint)))

(define-syntax-rule (use-package-modules module ...)
  (try-use-modules package-module-hint
                   (gnu packages module) ...))

(define-syntax-rule (use-service-modules module ...)
  (try-use-modules service-module-hint
                   (gnu services module) ...))

(define-syntax-rule (use-system-modules module ...)
  (try-use-modules (const #f)                     ;no hint
                   (gnu system module) ...))

;;; gnu.scm ends here
(const #t) (lambda () (resolve-module '(zstd) #t #f #:ensure #f)))) ;; This is actually in (guix store). (test-equal "store-path-package-name" "bash-4.2-p24" (store-path-package-name (string-append (%store-prefix) "/qvs2rj2ia5vci3wsdb7qvydrmacig4pg-bash-4.2-p24"))) (test-equal "canonical-newline-port" "This is a journey\nInto the sound\nA journey ...\n" (let ((port (open-string-input-port "This is a journey\r\nInto the sound\r\nA journey ...\n"))) (get-string-all (canonical-newline-port port)))) (test-equal "canonical-newline-port-1024" (string-concatenate (make-list 100 "0123456789abcde\n")) (let ((port (open-string-input-port (string-concatenate (make-list 100 "0123456789abcde\r\n"))))) (get-string-all (canonical-newline-port port)))) (test-equal "edit-expression" "(display \"GNU Guix\")\n(newline)\n" (begin (call-with-output-file temp-file (lambda (port) (display "(display \"xiuG UNG\")\n(newline)\n" port))) (edit-expression `((filename . ,temp-file) (line . 0) (column . 9)) string-reverse) (call-with-input-file temp-file get-string-all))) (test-equal "insert-expression" "(define-public package-1\n 'package)\n (define-public package-2\n 'package)\n" (begin (call-with-output-file temp-file (lambda (port) (display "(define-public package-2\n 'package)\n" port))) (insert-expression `((filename . ,temp-file) (line . 0) (column . 0)) `(define-public package-1 'package)) (call-with-input-file temp-file get-string-all))) (test-equal "find-definition-insertion-location" (list `((filename . ,temp-file) (line . 0) (column . 0)) `((filename . ,temp-file) (line . 5) (column . 0)) #f) (begin (call-with-output-file temp-file (lambda (port) (display "(define-public package-1\n 'foo)\n\n" port) (display "(define foo 'bar)\n\n" port) (display "(define-public package-2\n 'baz)\n" port))) (map (lambda (term) (find-definition-insertion-location temp-file term)) (list 'package 'package-1 'package-2)))) (test-equal "string-distance" '(0 1 1 5 5) (list (string-distance "hello" "hello") (string-distance "hello" "helo") (string-distance "helo" "hello") (string-distance "" "hello") (string-distance "hello" ""))) (test-equal "string-closest" '("hello" "hello" "helo" #f) (list (string-closest "hello" '("hello")) (string-closest "hello" '("helo" "hello" "halo")) (string-closest "hello" '("kikoo" "helo" "hihihi" "halo")) (string-closest "hello" '("aaaaa" "12345" "hellohello" "h")))) (test-equal "target-linux?" '(#t #f #f #t) (map target-linux? '("i686-linux-gnu" "i686-w64-mingw32" ;; Checking that "gnu" is present is not sufficient, ;; as GNU/Hurd exists. "i686-pc-gnu" ;; Some targets have a suffix. "arm-linux-gnueabihf"))) (test-equal "target-mingw?" '(#f #f #t) (map target-mingw? '("i686-linux-gnu" "i686-pc-gnu" "i686-w64-mingw32"))) (test-equal "target-x86-32?" '(#f #f #f #t #t #t #t #f) ;; These are (according to Wikipedia) two RISC architectures ;; by Intel and presumably not compatible with the x86-32 series. (map target-x86-32? '("i860-gnu" "i960-gnu" ;; This is a 16-bit architecture "i286-gnu" ;; These are part of the x86-32 series. "i386-gnu" "i486-gnu" "i586-gnu" "i686-gnu" ;; Maybe this one will exist some day, but not yet. "i786-gnu"))) (test-equal "target-x86-64?" '(#t #f #f #f) (map target-x86-64? `("x86_64-linux-gnu" "i386-linux-gnu" ;; Just because it includes "64" doesn't make it 64-bit. "aarch64-linux-gnu" ;; Note that (expt 2 109) in decimal notation starts with 64. ;; However, it isn't 32-bit. ,(format #f "x86_~a-linux-gnu" (expt 2 109))))) (test-equal "target-avr?" '(#t #t #t #f #f) (map target-avr? '("avr" "avr-unknown-none" ;; In addition LLVM also uses this form. "avr-unknown-unknown" ;; The AVR32 architecture also was made by Atmel/Microchip but it ;; does not resemble the AVR family, they aren't compatible in any ;; way. "avr32" "avr32-unknown-none"))) (test-end) (false-if-exception (delete-file temp-file))