;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2021 Liliana Prikler <liliana.prikler@gmail.com>
;;; Copyright © 2021 Sarah Morgensen <iskarian@mgsn.dev>
;;;
;;; 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 packages zig)
  #:use-module (guix packages)
  #:use-module (guix git-download)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (guix build-system cmake)
  #:use-module (gnu packages)
  #:use-module (gnu packages llvm))

(define-public zig
  (package
    (name "zig")
    (version "0.8.1")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/ziglang/zig.git")
             (commit version)))
       (file-name (git-file-name name version))
       (sha256
        (base32 "147qx7xgj0r353wh5ragzn6kmm1vrf31i8038z3zqwjnqqgqxi6c"))
       (patches
        (search-patches
         "zig-use-explicit-paths.patch"))))
    (build-system cmake-build-system)
    ;; Zig uses Clang and LLVM libraries, and (may) use LLVM to compile along
    ;; with GCC.
    (inputs
     `(("clang" ,clang-12)
       ("lld" ,lld-12)
       ("llvm" ,llvm-12)))
    (native-inputs
     `(("llvm" ,llvm-12)))
    (arguments
     `(#:configure-flags
       (list ,@(if (%current-target-system)
                   (string-append "-DZIG_TARGET_TRIPLE="
                                  (%current-target-system))
                   '()))
       #:tests? #f ;;; XXX: tests result in a FileNotFound
       #:phases
       (modify-phases %standard-phases
         (add-after 'unpack 'save-unpack-dir
           (lambda _
             ;; HACK: Passing unpacked source directory to 'check phase.
             (setenv "ZIG_SOURCE_DIR" (getcwd))
             #t))
         (add-after 'configure 'set-home
           (lambda _
             (setenv "HOME" (getcwd))    ; zig writes to $HOME/.cache
             #t))
         (delete 'check)
         (add-after 'install 'check
           (lambda* (#:key outputs tests? #:allow-other-keys)
             (when tests?
               (with-directory-excursion (getenv "ZIG_SOURCE_DIR")
                 (invoke (string-append (assoc-ref outputs "out") "/bin/zig")
                         "build" "test"))))))))
    (native-search-paths
     (list
      (search-path-specification
       (variable "ZIG_INCLUDE_DIRS")
       ;; XXX: It doesn't seem as though Zig can distinguish between C and C++
       ;;      include paths, so provide both.
       (files '("include/c++" "include")))
      (search-path-specification
       (variable "ZIG_LIB_DIRS")
       (files '("lib" "lib64")))))
    (synopsis "General purpose programming language and toolchain")
    (description "Zig is a general-purpose programming language and
toolchain.  Among other features it provides
@itemize
@item an Optional type instead of null pointers,
@item manual memory management,
@item generic data structures and functions,
@item compile-time reflection and compile-time code execution,
@item integration with C using zig as a C compiler, and
@item concurrency via async functions.
@end itemize")
    (home-page "https://github.com/ziglang/zig")
    (license license:expat)))