;;; 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)))
='2018-05-28 13:24:19 +0200'>2018-05-28</span></td><td><a href='/guix/commit/gnu/tests.scm?id=9ceeca0880248eee8c2796f5e6ebc172b95277f7'>system: Remove uses of the 'title' field of &lt;file-system&gt;.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-02-19 22:04:11 +0100'>2018-02-19</span></td><td><a href='/guix/commit/gnu/tests.scm?id=27a2c9c3e071fdb380c2f4f389b7cf4008dc75f7'>marionette: Use QEMU's "VM channel" mechanism.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-01-09 20:02:26 +0100'>2018-01-09</span></td><td><a href='/guix/commit/gnu/tests.scm?id=16d78a8f7207271e662d9152150b0cf790492373'>tests: marionette-operating-system: Add initrd parameter and kernel-arguments.</a><span class='msg-avail'>...</span></td><td>Danny Milosavljevic</td></tr>
<tr><td><span title='2017-12-06 15:02:24 +0100'>2017-12-06</span></td><td><a href='/guix/commit/gnu/tests.scm?id=fdfdecdb7ebfd05b4ae66cc5140078dbfc10fc35'>gnu, doc, tests: Use ‘bootloader-configuration’ everywhere.</a><span class='msg-avail'>...</span></td><td>Tobias Geerinckx-Rice</td></tr>
<tr><td><span title='2017-08-23 22:23:19 +0200'>2017-08-23</span></td><td><a href='/guix/commit/gnu/tests.scm?id=045ebb3e58d74c75f39ce47380045d3cd00359c3'>gnu: bootloader: Deprecate "device" field in favor of "target".</a><span class='msg-avail'>...</span></td><td>Andy Wingo</td></tr>
<tr><td><span title='2017-05-16 14:41:01 +0200'>2017-05-16</span></td><td><a href='/guix/commit/gnu/tests.scm?id=b09a8da4a2e50845a297e041762f3ff9e649c047'>bootloader: Add extlinux support.</a><span class='msg-avail'>...</span></td><td>Mathieu Othacehe</td></tr>
<tr><td><span title='2017-05-04 18:05:05 +0200'>2017-05-04</span></td><td><a href='/guix/commit/gnu/tests.scm?id=67d84d6335ae84ac7c217061570e6b968060073c'>tests: Use 'fold-module-public-variables' for discovery.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-05-03 23:50:15 +0200'>2017-05-03</span></td><td><a href='/guix/commit/gnu/tests.scm?id=cd903ef7871170d3c4eced45418459d293ef48a7'>Add (guix discovery).</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-04-01 00:45:18 +0200'>2017-04-01</span></td><td><a href='/guix/commit/gnu/tests.scm?id=892d9089a88abaa2ef1127f16308d03f4f08a4ce'>tests: Introduce 'simple-operating-system' and use it.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2016-07-12 22:47:08 +0200'>2016-07-12</span></td><td><a href='/guix/commit/gnu/tests.scm?id=a91c3fc727ba90d8c9b91f67fb672da2e6b877ad'>services: &lt;shepherd-service&gt; no longer has an 'imported-modules' field.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2016-06-27 21:41:38 +0200'>2016-06-27</span></td><td><a href='/guix/commit/gnu/tests.scm?id=037f9e07cd03d6894a6b5fc9a252c34d3b163962'>tests: 'marionette-service-type' nows takes a &lt;marionette-configuration&gt;.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2016-06-20 23:50:46 +0200'>2016-06-20</span></td><td><a href='/guix/commit/gnu/tests.scm?id=98b65b5ff6b1dea0ad58b0f47dd163c32d0cbf6e'>tests: Add a mechanism to describe and discover system tests.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2016-06-20 23:50:46 +0200'>2016-06-20</span></td><td><a href='/guix/commit/gnu/tests.scm?id=94b4274d0dc5768bac255980c7e785bd3dff261f'>tests: Add system installation test.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2016-06-20 00:52:53 +0200'>2016-06-20</span></td><td><a href='/guix/commit/gnu/tests.scm?id=ca7a68ebeb5039883cd43b6165ba1915b0974a41'>tests: Fix list of exports in (gnu tests).</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2016-05-04 23:35:55 +0200'>2016-05-04</span></td><td><a href='/guix/commit/gnu/tests.scm?id=957afcae3cded622f4260385f69b40dbdcaade9f'>Add (gnu tests) and (gnu build marionette).</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>