;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2022 Mathieu Othacehe <othacehe@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 (gnu compression)
  #:use-module (guix gexp)
  #:use-module (guix ui)
  #:use-module ((gnu packages compression) #:hide (zip))
  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-9)
  #:use-module (ice-9 match)
  #:export (compressor
            compressor?
            compressor-name
            compressor-extension
            compressor-command
            %compressors
            lookup-compressor))

;; Type of a compression tool.
(define-record-type <compressor>
  (compressor name extension command)
  compressor?
  (name       compressor-name)      ;string (e.g., "gzip")
  (extension  compressor-extension) ;string (e.g., ".lz")
  (command    compressor-command))  ;gexp (e.g., #~(list "/gnu/store/…/gzip"
                                    ;                    "-9n" ))

(define %compressors
  ;; Available compression tools.
  (list (compressor "gzip"  ".gz"
                    #~(list #+(file-append gzip "/bin/gzip") "-9n"))
        (compressor "lzip"  ".lz"
                    #~(list #+(file-append lzip "/bin/lzip") "-9"))
        (compressor "xz"    ".xz"
                    #~(append (list #+(file-append xz "/bin/xz")
                                    "-e")
                              (%xz-parallel-args)))
        (compressor "bzip2" ".bz2"
                    #~(list #+(file-append bzip2 "/bin/bzip2") "-9"))
        (compressor "zstd" ".zst"
                    ;; The default level 3 compresses better than gzip in a
                    ;; fraction of the time, while the highest level 19
                    ;; (de)compresses more slowly and worse than xz.
                    #~(list #+(file-append zstd "/bin/zstd") "-3"))
        (compressor "none" "" #f)))

(define (lookup-compressor name)
  "Return the compressor object called NAME.  Error out if it could not be
found."
  (or (find (match-lambda
              (($ <compressor> name*)
               (string=? name* name)))
            %compressors)
      (leave (G_ "~a: compressor not found~%") name)))
es would use (guix grafts) just to access '%graft?' and
related bindings, which are now in (guix store).

* gnu/ci.scm,
guix/gexp.scm,
guix/lint.scm,
guix/scripts.scm,
guix/scripts/archive.scm,
guix/scripts/build.scm,
guix/scripts/challenge.scm,
guix/scripts/deploy.scm,
guix/scripts/environment.scm,
guix/scripts/home.scm,
guix/scripts/pack.scm,
guix/scripts/package.scm,
guix/scripts/pull.scm,
guix/scripts/size.scm,
guix/scripts/system.scm,
guix/scripts/weather.scm,
tests/builders.scm,
tests/channels.scm,
tests/cpan.scm,
tests/derivations.scm,
tests/gexp.scm,
tests/graph.scm,
tests/guix-daemon.sh,
tests/monads.scm,
tests/pack.scm,
tests/packages.scm,
tests/profiles.scm,
tests/system.scm: Remove #:use-module (guix grafts).
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2022-07-01 23:29:16 +0200'>2022-07-01</span></td><td><a href='/guix/commit/tests/graph.scm?id=bee2c369fa2a3d51e6a1218d1b1a0ee86528674a'>tests: Adjust 'guix graph' test to latest OCaml changes.</a><span class='msg-avail'>...<span class='msg-tooltip'>* tests/graph.scm ("reverse bag DAG"): Adjust to latest OCaml changes by
looking at dune/ocaml-camomile/ocaml-utop.
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2022-02-05 08:02:30 +0100'>2022-02-05</span></td><td><a href='/guix/commit/tests/graph.scm?id=45082b9a8c12af285f4386538fc7acc4668cb11c'>tests: Assert that cyclic graphs can be produced.</a><span class='msg-avail'>...<span class='msg-tooltip'>* tests/graph.scm ("package DAG, oops it was a cycle"): New test.
</span></span></td><td>Liliana Marie Prikler</td></tr>
<tr><td><span title='2021-09-21 15:15:52 +0200'>2021-09-21</span></td><td><a href='/guix/commit/tests/graph.scm?id=5b32ad4f6f555d305659cee825879df075b06331'>graph: Add '--max-depth'.</a><span class='msg-avail'>...<span class='msg-tooltip'>* guix/graph.scm (export-graph): Add #:max-depth and honor it, adding
'depths' argument to 'loop'.
* guix/scripts/graph.scm (%options, show-help): Add '--max-depth'.
(%default-options): Add 'max-depth'.
(guix-graph): Pass #:max-depth to 'export-graph'.
* tests/graph.scm ("package DAG, limited depth"): New test.
* doc/guix.texi (Invoking guix graph): Document it.
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2020-10-20 16:30:15 +0200'>2020-10-20</span></td><td><a href='/guix/commit/tests/graph.scm?id=a9fd59dbd2d32e08c9479ac026b99b5c1dbbb0db'>graph: Adjust test for recent OCaml changes.</a><span class='msg-avail'>...<span class='msg-tooltip'>This is a followup to 339177956affdc471832750a3805b74356487e93.

* tests/graph.scm ("reverse bag DAG"): Look for "ocaml4.07-dune" rather
than "dune".
</span></span></td><td>Ludovic Courtès</td></tr>