guix/utils.scm

   1 ;;; GNU Guix --- Functional package management for GNU
   2 ;;; Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018 Ludovic Courtès <ludo@gnu.org>
   3 ;;; Copyright © 2013, 2014, 2015 Mark H Weaver <mhw@netris.org>
   4 ;;; Copyright © 2014 Eric Bavier <bavier@member.fsf.org>
   5 ;;; Copyright © 2014 Ian Denhardt <ian@zenhack.net>
   6 ;;; Copyright © 2016 Mathieu Lirzin <mthl@gnu.org>
   7 ;;; Copyright © 2015 David Thompson <davet@gnu.org>
   8 ;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@gmail.com>
   9 ;;; Copyright © 2018 Marius Bakke <mbakke@fastmail.com>
  10 ;;;
  11 ;;; This file is part of GNU Guix.
  12 ;;;
  13 ;;; GNU Guix is free software; you can redistribute it and/or modify it
  14 ;;; under the terms of the GNU General Public License as published by
  15 ;;; the Free Software Foundation; either version 3 of the License, or (at
  16 ;;; your option) any later version.
  17 ;;;
  18 ;;; GNU Guix is distributed in the hope that it will be useful, but
  19 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;;; GNU General Public License for more details.
  22 ;;;
  23 ;;; You should have received a copy of the GNU General Public License
  24 ;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
  25
  26 (define-module (guix utils)
  27   #:use-module (guix config)
  28   #:use-module (srfi srfi-1)
  29   #:use-module (srfi srfi-9)
  30   #:use-module (srfi srfi-11)
  31   #:use-module (srfi srfi-26)
  32   #:use-module (srfi srfi-35)
  33   #:use-module (srfi srfi-39)
  34   #:use-module (ice-9 binary-ports)
  35   #:use-module (ice-9 ftw)
  36   #:autoload   (rnrs io ports) (make-custom-binary-input-port)
  37   #:use-module ((rnrs bytevectors) #:select (bytevector-u8-set!))
  38   #:use-module (guix memoization)
  39   #:use-module ((guix build utils) #:select (dump-port mkdir-p delete-file-recursively))
  40   #:use-module ((guix build syscalls) #:select (mkdtemp! fdatasync))
  41   #:use-module (ice-9 format)
  42   #:autoload   (ice-9 popen)  (open-pipe*)
  43   #:autoload   (ice-9 rdelim) (read-line)
  44   #:use-module (ice-9 regex)
  45   #:use-module (ice-9 match)
  46   #:use-module (ice-9 format)
  47   #:use-module ((ice-9 iconv) #:prefix iconv:)
  48   #:use-module (system foreign)
  49   #:re-export (memoize)         ; for backwards compatibility
  50   #:export (strip-keyword-arguments
  51             default-keyword-arguments
  52             substitute-keyword-arguments
  53             ensure-keyword-arguments
  54
  55             current-source-directory
  56
  57             <location>
  58             location
  59             location?
  60             location-file
  61             location-line
  62             location-column
  63             source-properties->location
  64             location->source-properties
  65
  66             &error-location
  67             error-location?
  68             error-location
  69
  70             &fix-hint
  71             fix-hint?
  72             condition-fix-hint
  73
  74             nix-system->gnu-triplet
  75             gnu-triplet->nix-system
  76             %current-system
  77             %current-target-system
  78             package-name->name+version
  79             target-mingw?
  80             target-arm32?
  81             target-64bit?
  82             version-compare
  83             version>?
  84             version>=?
  85             version-prefix
  86             version-major+minor
  87             version-major
  88             guile-version>?
  89             version-prefix?
  90             string-replace-substring
  91             arguments-from-environment-variable
  92             file-extension
  93             file-sans-extension
  94             compressed-file?
  95             switch-symlinks
  96             call-with-temporary-output-file
  97             call-with-temporary-directory
  98             with-atomic-file-output
  99
 100             config-directory
 101             cache-directory
 102
 103             readlink*
 104             edit-expression
 105
 106             filtered-port
 107             compressed-port
 108             decompressed-port
 109             call-with-decompressed-port
 110             compressed-output-port
 111             call-with-compressed-output-port
 112             canonical-newline-port))
 113
 114 \f
 115 ;;;
 116 ;;; Filtering & pipes.
 117 ;;;
 118
 119 (define (filtered-port command input)
 120   "Return an input port where data drained from INPUT is filtered through
 121 COMMAND (a list).  In addition, return a list of PIDs that the caller must
 122 wait.  When INPUT is a file port, it must be unbuffered; otherwise, any
 123 buffered data is lost."
 124   (let loop ((input input)
 125              (pids  '()))
 126     (if (file-port? input)
 127         (match (pipe)
 128           ((in . out)
 129            (match (primitive-fork)
 130              (0
 131               (dynamic-wind
 132                 (const #f)
 133                 (lambda ()
 134                   (close-port in)
 135                   (close-port (current-input-port))
 136                   (dup2 (fileno input) 0)
 137                   (close-port (current-output-port))
 138                   (dup2 (fileno out) 1)
 139                   (catch 'system-error
 140                     (lambda ()
 141                       (apply execl (car command) command))
 142                     (lambda args
 143                       (format (current-error-port)
 144                               "filtered-port: failed to execute '~{~a ~}': ~a~%"
 145                               command (strerror (system-error-errno args))))))
 146                 (lambda ()
 147                   (primitive-_exit 1))))
 148              (child
 149               (close-port out)
 150               (values in (cons child pids))))))
 151
 152         ;; INPUT is not a file port, so fork just for the sake of tunneling it
 153         ;; through a file port.
 154         (match (pipe)
 155           ((in . out)
 156            (match (primitive-fork)
 157              (0
 158               (dynamic-wind
 159                 (const #t)
 160                 (lambda ()
 161                   (close-port in)
 162                   (dump-port input out))
 163                 (lambda ()
 164                   (close-port input)
 165                   (false-if-exception (close out))
 166                   (primitive-_exit 0))))
 167              (child
 168               (close-port input)
 169               (close-port out)
 170               (loop in (cons child pids)))))))))
 171
 172 (define (decompressed-port compression input)
 173   "Return an input port where INPUT is decompressed according to COMPRESSION,
 174 a symbol such as 'xz."
 175   (match compression
 176     ((or #f 'none) (values input '()))
 177     ('bzip2        (filtered-port `(,%bzip2 "-dc") input))
 178     ('xz           (filtered-port `(,%xz "-dc") input))
 179     ('gzip         (filtered-port `(,%gzip "-dc") input))
 180     (else          (error "unsupported compression scheme" compression))))
 181
 182 (define (compressed-port compression input)
 183   "Return an input port where INPUT is decompressed according to COMPRESSION,
 184 a symbol such as 'xz."
 185   (match compression
 186     ((or #f 'none) (values input '()))
 187     ('bzip2        (filtered-port `(,%bzip2 "-c") input))
 188     ('xz           (filtered-port `(,%xz "-c") input))
 189     ('gzip         (filtered-port `(,%gzip "-c") input))
 190     (else          (error "unsupported compression scheme" compression))))
 191
 192 (define (call-with-decompressed-port compression port proc)
 193   "Call PROC with a wrapper around PORT, a file port, that decompresses data
 194 read from PORT according to COMPRESSION, a symbol such as 'xz."
 195   (let-values (((decompressed pids)
 196                 (decompressed-port compression port)))
 197     (dynamic-wind
 198       (const #f)
 199       (lambda ()
 200         (proc decompressed))
 201       (lambda ()
 202         (close-port decompressed)
 203         (unless (every (compose zero? cdr waitpid) pids)
 204           (error "decompressed-port failure" pids))))))
 205
 206 (define (filtered-output-port command output)
 207   "Return an output port.  Data written to that port is filtered through
 208 COMMAND and written to OUTPUT, an output file port.  In addition, return a
 209 list of PIDs to wait for.  OUTPUT must be unbuffered; otherwise, any buffered
 210 data is lost."
 211   (match (pipe)
 212     ((in . out)
 213      (match (primitive-fork)
 214        (0
 215         (dynamic-wind
 216           (const #f)
 217           (lambda ()
 218             (close-port out)
 219             (close-port (current-input-port))
 220             (dup2 (fileno in) 0)
 221             (close-port (current-output-port))
 222             (dup2 (fileno output) 1)
 223             (catch 'system-error
 224               (lambda ()
 225                 (apply execl (car command) command))
 226               (lambda args
 227                 (format (current-error-port)
 228                         "filtered-output-port: failed to execute '~{~a ~}': ~a~%"
 229                         command (strerror (system-error-errno args))))))
 230           (lambda ()
 231             (primitive-_exit 1))))
 232        (child
 233         (close-port in)
 234         (values out (list child)))))))
 235
 236 (define* (compressed-output-port compression output
 237                                  #:key (options '()))
 238   "Return an output port whose input is compressed according to COMPRESSION,
 239 a symbol such as 'xz, and then written to OUTPUT.  In addition return a list
 240 of PIDs to wait for.  OPTIONS is a list of strings passed to the compression
 241 program--e.g., '(\"--fast\")."
 242   (match compression
 243     ((or #f 'none) (values output '()))
 244     ('bzip2        (filtered-output-port `(,%bzip2 "-c" ,@options) output))
 245     ('xz           (filtered-output-port `(,%xz "-c" ,@options) output))
 246     ('gzip         (filtered-output-port `(,%gzip "-c" ,@options) output))
 247     (else          (error "unsupported compression scheme" compression))))
 248
 249 (define* (call-with-compressed-output-port compression port proc
 250                                            #:key (options '()))
 251   "Call PROC with a wrapper around PORT, a file port, that compresses data
 252 that goes to PORT according to COMPRESSION, a symbol such as 'xz.  OPTIONS is
 253 a list of command-line arguments passed to the compression program."
 254   (let-values (((compressed pids)
 255                 (compressed-output-port compression port
 256                                         #:options options)))
 257     (dynamic-wind
 258       (const #f)
 259       (lambda ()
 260         (proc compressed))
 261       (lambda ()
 262         (close-port compressed)
 263         (unless (every (compose zero? cdr waitpid) pids)
 264           (error "compressed-output-port failure" pids))))))
 265
 266 (define* (edit-expression source-properties proc #:key (encoding "UTF-8"))
 267   "Edit the expression specified by SOURCE-PROPERTIES using PROC, which should
 268 be a procedure that takes the original expression in string and returns a new
 269 one.  ENCODING will be used to interpret all port I/O, it default to UTF-8.
 270 This procedure returns #t on success."
 271   (with-fluids ((%default-port-encoding encoding))
 272     (let* ((file   (assq-ref source-properties 'filename))
 273            (line   (assq-ref source-properties 'line))
 274            (column (assq-ref source-properties 'column))
 275            (in     (open-input-file file))
 276            ;; The start byte position of the expression.
 277            (start  (begin (while (not (and (= line (port-line in))
 278                                            (= column (port-column in))))
 279                             (when (eof-object? (read-char in))
 280                               (error (format #f "~a: end of file~%" in))))
 281                           (ftell in)))
 282            ;; The end byte position of the expression.
 283            (end    (begin (read in) (ftell in))))
 284       (seek in 0 SEEK_SET) ; read from the beginning of the file.
 285       (let* ((pre-bv  (get-bytevector-n in start))
 286              ;; The expression in string form.
 287              (str     (iconv:bytevector->string
 288                        (get-bytevector-n in (- end start))
 289                        (port-encoding in)))
 290              (post-bv (get-bytevector-all in))
 291              (str*    (proc str)))
 292         ;; Verify the edited expression is still a scheme expression.
 293         (call-with-input-string str* read)
 294         ;; Update the file with edited expression.
 295         (with-atomic-file-output file
 296           (lambda (out)
 297             (put-bytevector out pre-bv)
 298             (display str* out)
 299             ;; post-bv maybe the end-of-file object.
 300             (when (not (eof-object? post-bv))
 301               (put-bytevector out post-bv))
 302             #t))))))
 303
 304 \f
 305 ;;;
 306 ;;; Keyword arguments.
 307 ;;;
 308
 309 (define (strip-keyword-arguments keywords args)
 310   "Remove all of the keyword arguments listed in KEYWORDS from ARGS."
 311   (let loop ((args   args)
 312              (result '()))
 313     (match args
 314       (()
 315        (reverse result))
 316       (((? keyword? kw) arg . rest)
 317        (loop rest
 318              (if (memq kw keywords)
 319                  result
 320                  (cons* arg kw result))))
 321       ((head . tail)
 322        (loop tail (cons head result))))))
 323
 324 (define (default-keyword-arguments args defaults)
 325   "Return ARGS augmented with any keyword/value from DEFAULTS for
 326 keywords not already present in ARGS."
 327   (let loop ((defaults defaults)
 328              (args     args))
 329     (match defaults
 330       ((kw value rest ...)
 331        (loop rest
 332              (if (memq kw args)
 333                  args
 334                  (cons* kw value args))))
 335       (()
 336        args))))
 337
 338 (define-syntax collect-default-args
 339   (syntax-rules ()
 340     ((_)
 341      '())
 342     ((_ (_ _) rest ...)
 343      (collect-default-args rest ...))
 344     ((_ (kw _ dflt) rest ...)
 345      (cons* kw dflt (collect-default-args rest ...)))))
 346
 347 (define-syntax substitute-keyword-arguments
 348   (syntax-rules ()
 349     "Return a new list of arguments where the value for keyword arg KW is
 350 replaced by EXP.  EXP is evaluated in a context where VAR is bound to the
 351 previous value of the keyword argument, or DFLT if given."
 352     ((_ original-args ((kw var dflt ...) exp) ...)
 353      (let loop ((args (default-keyword-arguments
 354                         original-args
 355                         (collect-default-args (kw var dflt ...) ...)))
 356                 (before '()))
 357        (match args
 358          ((kw var rest (... ...))
 359           (loop rest (cons* exp kw before)))
 360          ...
 361          ((x rest (... ...))
 362           (loop rest (cons x before)))
 363          (()
 364           (reverse before)))))))
 365
 366 (define (delkw kw lst)
 367   "Remove KW and its associated value from LST, a keyword/value list such
 368 as '(#:foo 1 #:bar 2)."
 369   (let loop ((lst    lst)
 370              (result '()))
 371     (match lst
 372       (()
 373        (reverse result))
 374       ((kw? value rest ...)
 375        (if (eq? kw? kw)
 376            (append (reverse result) rest)
 377            (loop rest (cons* value kw? result)))))))
 378
 379 (define (ensure-keyword-arguments args kw/values)
 380   "Force the keywords arguments KW/VALUES in the keyword argument list ARGS.
 381 For instance:
 382
 383   (ensure-keyword-arguments '(#:foo 2) '(#:foo 2))
 384   => (#:foo 2)
 385
 386   (ensure-keyword-arguments '(#:foo 2) '(#:bar 3))
 387   => (#:foo 2 #:bar 3)
 388
 389   (ensure-keyword-arguments '(#:foo 2) '(#:bar 3 #:foo 42))
 390   => (#:foo 42 #:bar 3)
 391 "
 392   (let loop ((args      args)
 393              (kw/values kw/values)
 394              (result    '()))
 395     (match args
 396       (()
 397        (append (reverse result) kw/values))
 398       ((kw value rest ...)
 399        (match (memq kw kw/values)
 400          ((_ value . _)
 401           (loop rest (delkw kw kw/values) (cons* value kw result)))
 402          (#f
 403           (loop rest kw/values (cons* value kw result))))))))
 404
 405 \f
 406 ;;;
 407 ;;; System strings.
 408 ;;;
 409
 410 (define* (nix-system->gnu-triplet
 411           #:optional (system (%current-system)) (vendor "unknown"))
 412   "Return a guess of the GNU triplet corresponding to Nix system
 413 identifier SYSTEM."
 414   (match system
 415     ("armhf-linux"
 416      (string-append "arm-" vendor "-linux-gnueabihf"))
 417     (_
 418      (let* ((dash (string-index system #\-))
 419             (arch (substring system 0 dash))
 420             (os   (substring system (+ 1 dash))))
 421        (string-append arch
 422                       "-" vendor "-"
 423                       (if (string=? os "linux")
 424                           "linux-gnu"
 425                           os))))))
 426
 427 (define (gnu-triplet->nix-system triplet)
 428   "Return the Nix system type corresponding to TRIPLET, a GNU triplet as
 429 returned by `config.guess'."
 430   (let ((triplet (cond ((string-match "^i[345]86-(.*)$" triplet)
 431                         =>
 432                         (lambda (m)
 433                           (string-append "i686-" (match:substring m 1))))
 434                        (else triplet))))
 435     (cond ((string-match "^arm[^-]*-([^-]+-)?linux-gnueabihf" triplet)
 436            "armhf-linux")
 437           ((string-match "^([^-]+)-([^-]+-)?linux-gnu.*" triplet)
 438            =>
 439            (lambda (m)
 440              ;; Nix omits `-gnu' for GNU/Linux.
 441              (string-append (match:substring m 1) "-linux")))
 442           ((string-match "^([^-]+)-([^-]+-)?([[:alpha:]]+)([0-9]+\\.?)*$" triplet)
 443            =>
 444            (lambda (m)
 445              ;; Nix strip the version number from names such as `gnu0.3',
 446              ;; `darwin10.2.0', etc., and always strips the vendor part.
 447              (string-append (match:substring m 1) "-"
 448                             (match:substring m 3))))
 449           (else triplet))))
 450
 451 (define %current-system
 452   ;; System type as expected by Nix, usually ARCHITECTURE-KERNEL.
 453   ;; By default, this is equal to (gnu-triplet->nix-system %host-type).
 454   (make-parameter %system))
 455
 456 (define %current-target-system
 457   ;; Either #f or a GNU triplet representing the target system we are
 458   ;; cross-building to.
 459   (make-parameter #f))
 460
 461 (define* (package-name->name+version spec
 462                                      #:optional (delimiter #\@))
 463   "Given SPEC, a package name like \"foo@0.9.1b\", return two values: \"foo\"
 464 and \"0.9.1b\".  When the version part is unavailable, SPEC and #f are
 465 returned.  Both parts must not contain any '@'.  Optionally, DELIMITER can be
 466 a character other than '@'."
 467   (match (string-rindex spec delimiter)
 468     (#f  (values spec #f))
 469     (idx (values (substring spec 0 idx)
 470                  (substring spec (1+ idx))))))
 471
 472 (define* (target-mingw? #:optional (target (%current-target-system)))
 473   (and target
 474        (string-suffix? "-mingw32" target)))
 475
 476 (define (target-arm32?)
 477   (string-prefix? "arm" (or (%current-target-system) (%current-system))))
 478
 479 (define (target-64bit?)
 480   (let ((system (or (%current-target-system) (%current-system))))
 481     (any (cut string-prefix? <> system) '("x86_64" "aarch64" "mips64" "ppc64"))))
 482
 483 (define version-compare
 484   (let ((strverscmp
 485          (let ((sym (or (dynamic-func "strverscmp" (dynamic-link))
 486                         (error "could not find `strverscmp' (from GNU libc)"))))
 487            (pointer->procedure int sym (list '* '*)))))
 488     (lambda (a b)
 489       "Return '> when A denotes a newer version than B,
 490 '< when A denotes a older version than B,
 491 or '= when they denote equal versions."
 492       (let ((result (strverscmp (string->pointer a) (string->pointer b))))
 493         (cond ((positive? result) '>)
 494               ((negative? result) '<)
 495               (else '=))))))
 496
 497 (define (version-prefix version-string num-parts)
 498   "Truncate version-string to the first num-parts components of the version.
 499 For example, (version-prefix \"2.1.47.4.23\" 3) returns \"2.1.47\""
 500   (string-join (take (string-split version-string #\.) num-parts) "."))
 501
 502
 503 (define (version-major+minor version-string)
 504   "Return \"<major>.<minor>\", where major and minor are the major and
 505 minor version numbers from version-string."
 506   (version-prefix version-string 2))
 507
 508 (define (version-major version-string)
 509   "Return the major version number as string from the version-string."
 510   (version-prefix version-string 1))
 511
 512 (define (version>? a b)
 513   "Return #t when A denotes a version strictly newer than B."
 514   (eq? '> (version-compare a b)))
 515
 516 (define (version>=? a b)
 517   "Return #t when A denotes a version newer or equal to B."
 518   (case (version-compare a b)
 519     ((> =) #t)
 520     (else #f)))
 521
 522 (define (guile-version>? str)
 523   "Return #t if the running Guile version is greater than STR."
 524   ;; Note: Using (version>? (version) "2.0.5") or similar doesn't work,
 525   ;; because the result of (version) can have a prefix, like "2.0.5-deb1".
 526   (version>? (string-append (major-version) "."
 527                             (minor-version) "."
 528                             (micro-version))
 529              str))
 530
 531 (define version-prefix?
 532   (let ((not-dot (char-set-complement (char-set #\.))))
 533     (lambda (v1 v2)
 534       "Return true if V1 is a version prefix of V2:
 535
 536   (version-prefix? \"4.1\" \"4.16.2\") => #f
 537   (version-prefix? \"4.1\" \"4.1.2\") => #t
 538 "
 539       (define (list-prefix? lst1 lst2)
 540         (match lst1
 541           (() #t)
 542           ((head1 tail1 ...)
 543            (match lst2
 544              (() #f)
 545              ((head2 tail2 ...)
 546               (and (equal? head1 head2)
 547                    (list-prefix? tail1 tail2)))))))
 548
 549       (list-prefix? (string-tokenize v1 not-dot)
 550                     (string-tokenize v2 not-dot)))))
 551
 552 (define (file-extension file)
 553   "Return the extension of FILE or #f if there is none."
 554   (let ((dot (string-rindex file #\.)))
 555     (and dot (substring file (+ 1 dot) (string-length file)))))
 556
 557 (define (file-sans-extension file)
 558   "Return the substring of FILE without its extension, if any."
 559   (let ((dot (string-rindex file #\.)))
 560     (if dot
 561         (substring file 0 dot)
 562         file)))
 563
 564 (define (compressed-file? file)
 565   "Return true if FILE denotes a compressed file."
 566   (->bool (member (file-extension file)
 567                   '("gz" "bz2" "xz" "lz" "lzma" "tgz" "tbz2" "zip"))))
 568
 569 (define (switch-symlinks link target)
 570   "Atomically switch LINK, a symbolic link, to point to TARGET.  Works
 571 both when LINK already exists and when it does not."
 572   (let ((pivot (string-append link ".new")))
 573     (symlink target pivot)
 574     (rename-file pivot link)))
 575
 576 (define* (string-replace-substring str substr replacement
 577                                    #:optional
 578                                    (start 0)
 579                                    (end (string-length str)))
 580   "Replace all occurrences of SUBSTR in the START--END range of STR by
 581 REPLACEMENT."
 582   (match (string-length substr)
 583     (0
 584      (error "string-replace-substring: empty substring"))
 585     (substr-length
 586      (let loop ((start  start)
 587                 (pieces (list (substring str 0 start))))
 588        (match (string-contains str substr start end)
 589          (#f
 590           (string-concatenate-reverse
 591            (cons (substring str start) pieces)))
 592          (index
 593           (loop (+ index substr-length)
 594                 (cons* replacement
 595                        (substring str start index)
 596                        pieces))))))))
 597
 598 (define (arguments-from-environment-variable variable)
 599   "Retrieve value of environment variable denoted by string VARIABLE in the
 600 form of a list of strings (`char-set:graphic' tokens) suitable for consumption
 601 by `args-fold', if VARIABLE is defined, otherwise return an empty list."
 602   (let ((env (getenv variable)))
 603     (if env
 604         (string-tokenize env char-set:graphic)
 605         '())))
 606
 607 (define (call-with-temporary-output-file proc)
 608   "Call PROC with a name of a temporary file and open output port to that
 609 file; close the file and delete it when leaving the dynamic extent of this
 610 call."
 611   (let* ((directory (or (getenv "TMPDIR") "/tmp"))
 612          (template  (string-append directory "/guix-file.XXXXXX"))
 613          (out       (mkstemp! template)))
 614     (dynamic-wind
 615       (lambda ()
 616         #t)
 617       (lambda ()
 618         (proc template out))
 619       (lambda ()
 620         (false-if-exception (close out))
 621         (false-if-exception (delete-file template))))))
 622
 623 (define (call-with-temporary-directory proc)
 624   "Call PROC with a name of a temporary directory; close the directory and
 625 delete it when leaving the dynamic extent of this call."
 626   (let* ((directory (or (getenv "TMPDIR") "/tmp"))
 627          (template  (string-append directory "/guix-directory.XXXXXX"))
 628          (tmp-dir   (mkdtemp! template)))
 629     (dynamic-wind
 630       (const #t)
 631       (lambda ()
 632         (proc tmp-dir))
 633       (lambda ()
 634         (false-if-exception (delete-file-recursively tmp-dir))))))
 635
 636 (define (with-atomic-file-output file proc)
 637   "Call PROC with an output port for the file that is going to replace FILE.
 638 Upon success, FILE is atomically replaced by what has been written to the
 639 output port, and PROC's result is returned."
 640   (let* ((template (string-append file ".XXXXXX"))
 641          (out      (mkstemp! template)))
 642     (with-throw-handler #t
 643       (lambda ()
 644         (let ((result (proc out)))
 645           (fdatasync out)
 646           (close-port out)
 647           (rename-file template file)
 648           result))
 649       (lambda (key . args)
 650         (false-if-exception (delete-file template))
 651         (close-port out)))))
 652
 653 (define* (xdg-directory variable suffix #:key (ensure? #t))
 654   "Return the name of the XDG directory that matches VARIABLE and SUFFIX,
 655 after making sure that it exists if ENSURE? is true.  VARIABLE is an
 656 environment variable name like \"XDG_CONFIG_HOME\"; SUFFIX is a suffix like
 657 \"/.config\".  Honor the XDG specs,
 658 <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>."
 659   (let ((dir (and=> (or (getenv variable)
 660                         (and=> (or (getenv "HOME")
 661                                    (passwd:dir (getpwuid (getuid))))
 662                                (cut string-append <> suffix)))
 663                     (cut string-append <> "/guix"))))
 664     (when ensure?
 665       (mkdir-p dir))
 666     dir))
 667
 668 (define config-directory
 669   (cut xdg-directory "XDG_CONFIG_HOME" "/.config" <...>))
 670
 671 (define cache-directory
 672   (cut xdg-directory "XDG_CACHE_HOME" "/.cache" <...>))
 673
 674 (define (readlink* file)
 675   "Call 'readlink' until the result is not a symlink."
 676   (define %max-symlink-depth 50)
 677
 678   (let loop ((file  file)
 679              (depth 0))
 680     (define (absolute target)
 681       (if (absolute-file-name? target)
 682           target
 683           (string-append (dirname file) "/" target)))
 684
 685     (if (>= depth %max-symlink-depth)
 686         file
 687         (call-with-values
 688             (lambda ()
 689               (catch 'system-error
 690                 (lambda ()
 691                   (values #t (readlink file)))
 692                 (lambda args
 693                   (let ((errno (system-error-errno args)))
 694                     (if (or (= errno EINVAL))
 695                         (values #f file)
 696                         (apply throw args))))))
 697           (lambda (success? target)
 698             (if success?
 699                 (loop (absolute target) (+ depth 1))
 700                 file))))))
 701
 702 (define (canonical-newline-port port)
 703   "Return an input port that wraps PORT such that all newlines consist
 704   of a single carriage return."
 705   (define (get-position)
 706     (if (port-has-port-position? port) (port-position port) #f))
 707   (define (set-position! position)
 708     (if (port-has-set-port-position!? port)
 709         (set-port-position! position port)
 710         #f))
 711   (define (close) (close-port port))
 712   (define (read! bv start n)
 713     (let loop ((count 0)
 714                (byte (get-u8 port)))
 715       (cond ((eof-object? byte) count)
 716             ((= count (- n 1))
 717              (bytevector-u8-set! bv (+ start count) byte)
 718              n)
 719             ;; XXX: consume all LFs even if not followed by CR.
 720             ((eqv? byte (char->integer #\return)) (loop count (get-u8 port)))
 721             (else
 722              (bytevector-u8-set! bv (+ start count) byte)
 723              (loop (+ count 1) (get-u8 port))))))
 724   (make-custom-binary-input-port "canonical-newline-port"
 725                                  read!
 726                                  get-position
 727                                  set-position!
 728                                  close))
 729 \f
 730 ;;;
 731 ;;; Source location.
 732 ;;;
 733
 734 (define absolute-dirname
 735   ;; Memoize to avoid repeated 'stat' storms from 'search-path'.
 736   (mlambda (file)
 737     "Return the absolute name of the directory containing FILE, or #f upon
 738 failure."
 739     (match (search-path %load-path file)
 740       (#f #f)
 741       ((? string? file)
 742        ;; If there are relative names in %LOAD-PATH, FILE can be relative and
 743        ;; needs to be canonicalized.
 744        (if (string-prefix? "/" file)
 745            (dirname file)
 746            (canonicalize-path (dirname file)))))))
 747
 748 (define-syntax current-source-directory
 749   (lambda (s)
 750     "Return the absolute name of the current directory, or #f if it could not
 751 be determined."
 752     (syntax-case s ()
 753       ((_)
 754        (match (assq 'filename (or (syntax-source s) '()))
 755          (('filename . (? string? file-name))
 756           ;; If %FILE-PORT-NAME-CANONICALIZATION is 'relative, then FILE-NAME
 757           ;; can be relative.  In that case, we try to find out at run time
 758           ;; the absolute file name by looking at %LOAD-PATH; doing this at
 759           ;; run time rather than expansion time is necessary to allow files
 760           ;; to be moved on the file system.
 761           (cond ((not file-name)
 762                  #f)                ;raising an error would upset Geiser users
 763                 ((string-prefix? "/" file-name)
 764                  (dirname file-name))
 765                 (else
 766                  #`(absolute-dirname #,file-name))))
 767          (#f
 768           #f))))))
 769
 770 ;; A source location.
 771 (define-record-type <location>
 772   (make-location file line column)
 773   location?
 774   (file          location-file)                   ; file name
 775   (line          location-line)                   ; 1-indexed line
 776   (column        location-column))                ; 0-indexed column
 777
 778 (define (location file line column)
 779   "Return the <location> object for the given FILE, LINE, and COLUMN."
 780   (and line column file
 781        (make-location file line column)))
 782
 783 (define (source-properties->location loc)
 784   "Return a location object based on the info in LOC, an alist as returned
 785 by Guile's `source-properties', `frame-source', `current-source-location',
 786 etc."
 787   ;; In accordance with the GCS, start line and column numbers at 1.  Note
 788   ;; that unlike LINE and `port-column', COL is actually 1-indexed here...
 789   (match loc
 790     ((('line . line) ('column . col) ('filename . file)) ;common case
 791      (and file line col
 792           (make-location file (+ line 1) col)))
 793     (#f
 794      #f)
 795     (_
 796      (let ((file (assq-ref loc 'filename))
 797            (line (assq-ref loc 'line))
 798            (col  (assq-ref loc 'column)))
 799        (location file (and line (+ line 1)) col)))))
 800
 801 (define (location->source-properties loc)
 802   "Return the source property association list based on the info in LOC,
 803 a location object."
 804   `((line     . ,(and=> (location-line loc) 1-))
 805     (column   . ,(location-column loc))
 806     (filename . ,(location-file loc))))
 807
 808 (define-condition-type &error-location &error
 809   error-location?
 810   (location  error-location))                     ;<location>
 811
 812 (define-condition-type &fix-hint &condition
 813   fix-hint?
 814   (hint condition-fix-hint))                      ;string
 815
 816 ;;; Local Variables:
 817 ;;; eval: (put 'call-with-progress-reporter 'scheme-indent-function 1)
 818 ;;; End: