;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2021 Pierre Langlois <pierre.langlois@gmx.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 packages tree-sitter)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (guix build-system cargo)
  #:use-module (guix build-system gnu)
  #:use-module (guix build-system node)
  #:use-module (guix git-download)
  #:use-module (guix packages)
  #:use-module (guix utils)
  #:use-module (gnu packages crates-graphics)
  #:use-module (gnu packages crates-io)
  #:use-module (gnu packages node-xyz))

(define-public tree-sitter
  (package
    (name "tree-sitter")
    (version "0.19.5")
    (source
      (origin
        (method git-fetch)
        (uri (git-reference
              (url "https://github.com/tree-sitter/tree-sitter")
              (commit (string-append "v" version))))
        (file-name (git-file-name name version))
        (sha256
         (base32
          "1qmb0sva28zv6r3c3j7xs9pc8bpwwhkb9vxxndw2zbdn9wkvmbmn"))))
    (build-system gnu-build-system)
    (arguments
     `(#:tests? #f   ;; No check target.
       #:phases
       (modify-phases %standard-phases
         (delete 'configure)
         (add-before 'build 'set-cc
           (lambda _
             (setenv "CC" ,(cc-for-target))))
         (replace 'install
           (lambda* (#:key outputs #:allow-other-keys)
             (let* ((out (assoc-ref outputs "out"))
                    (lib (string-append out "/lib")))
               (setenv "PREFIX" out)
               (invoke "make" "install")))))))
    (home-page "https://tree-sitter.github.io/tree-sitter/")
    (synopsis "Incremental parsing system for programming tools")
    (description "Tree-sitter is a parser generator tool and an incremental
parsing library.  It can build a concrete syntax tree for a source file and
efficiently update the syntax tree as the source file is edited.

Tree-sitter aims to be:

@enumerate
@item General enough to parse any programming language.
@item Fast enough to parse on every keystroke in a text editor.
@item Robust enough to provide useful results even in the presence of syntax
errors.
@item Dependency-free so that the runtime library (which is written in pure C)
can be embedded in any application.
@end enumerate

This package includes the @code{libtree-sitter} runtime library.")
    (license license:expat)))

(define-public tree-sitter-cli
  (package (inherit tree-sitter)
    (name "tree-sitter-cli")
    (build-system cargo-build-system)
    (arguments
     `(;; Running test requires downloading fixtures, see the
       ;; script/fetch-fixtures script.
       #:tests? #f
       ;; FIXME: Installing the sources for the tree-sitter Rust bindings
       ;; doesn't work out of the box due to tree-sitter having multiple
       ;; Rust packages in the same repository (bindings and CLI).
       #:install-source? #f
       #:cargo-inputs
       (("rust-ansi-term" ,rust-ansi-term-0.12)
        ("rust-atty" ,rust-atty-0.2)
        ("rust-clap" ,rust-clap-2)
        ("rust-difference" ,rust-difference-2)
        ("rust-dirs" ,rust-dirs-3)
        ("rust-html-escape" ,rust-html-escape-0.2)
        ("rust-libloading" ,rust-libloading-0.7)
        ("rust-smallbitvec" ,rust-smallbitvec-2)
        ("rust-spin" ,rust-spin-0.7)
        ("rust-tiny-http" ,rust-tiny-http-0.8)
        ("rust-walkdir" ,rust-walkdir-2)
        ("rust-webbrowser" ,rust-webbrowser-0.5)
        ("rust-which" ,rust-which-4))
       #:phases
       (modify-phases %standard-phases
         (add-after 'unpack 'delete-cargo.lock
           (lambda _ (delete-file "Cargo.lock")))
         (replace 'install
           (lambda* (#:key outputs #:allow-other-keys)
             (let* ((out (assoc-ref outputs "out"))
                    (bin (string-append out "/bin"))
                    (lib (string-append out "/lib")))
               (mkdir-p bin)
               (install-file "target/release/tree-sitter" bin)))))))
    (synopsis "Incremental parsing system for programming tools")
    (description "Tree-sitter is a parser generator tool and an incremental
parsing library.  It can build a concrete syntax tree for a source file and
efficiently update the syntax tree as the source file is edited.

Tree-sitter aims to be:

@enumerate
@item General enough to parse any programming language.
@item Fast enough to parse on every keystroke in a text editor.
@item Robust enough to provide useful results even in the presence of syntax
errors.
@item Dependency-free so that the runtime library (which is written in pure C)
can be embedded in any application.
@end enumerate

This package includes the @command{tree-sitter} command-line tool.")
    (license license:expat)))

(define-public tree-sitter-c
  (package
    (name "tree-sitter-c")
    (version "0.19.0")
    (source
      (origin
        (method git-fetch)
        (uri (git-reference
              (url "https://github.com/tree-sitter/tree-sitter-c")
              (commit (string-append "v" version))))
        (file-name (git-file-name name version))
        (sha256
         (base32
          "1diys8yigvhm4ppbmp3a473yxjg2d5lk11y0ay7qprcz7233lakv"))))
    (build-system node-build-system)
    (native-inputs
     `(("tree-sitter-cli" ,tree-sitter-cli)
       ("node-nan" ,node-nan)))
    (arguments
     `(#:phases
       (modify-phases %standard-phases
         ;; tree-sitter-cli is listed as a Node.js dependency, however the
         ;; node tree-sitter-cli package is just a wrapper which downloads a
         ;; tree-sitter binary, see
         ;; https://github.com/tree-sitter/tree-sitter/tree/master/cli/npm
         ;; Instead we remove it as a dependency so that we can use our own
         ;; tree-sitter package.
         (add-after 'unpack 'fix-configure
           (lambda _
             (with-atomic-file-replacement "package.json"
               (lambda (in out)
                 (use-modules ((guix build json)))
                 (let ((package-meta (read-json in)))
                   (assoc-remove! (assoc-ref package-meta "devDependencies")
                                  "tree-sitter-cli")
                   (write-json package-meta out))))))
         (add-before 'build 'set-cc
           (lambda _
             (setenv "CC" ,(cc-for-target))))
         (add-before 'build 'make-files-writable
           (lambda _
             (for-each make-file-writable (find-files "src" ".*"))))
         (add-after 'install 'install-native-lib
           (lambda* (#:key outputs #:allow-other-keys)
             (let ((lib (string-append (assoc-ref outputs "out")
                                       "/lib/tree-sitter")))
               ;; Invoking `tree-sitter test' loads the grammar which
               ;; compiles it to a .so binary that we install.
               (invoke "tree-sitter" "test")
               (mkdir-p lib)
               (copy-recursively (string-append (getenv "HOME")
                                                "/.tree-sitter/bin")
                                 lib)))))))
    (home-page "https://github.com/tree-sitter/tree-sitter-c")
    (synopsis "Tree-sitter C grammar")
    (description
      "This package provides a C grammar for the Tree-sitter library.")
    (license license:expat)))

(define-public tree-sitter-cpp
  (package (inherit tree-sitter-c)
    (name "tree-sitter-cpp")
    (version "0.19.0")
    (source
      (origin
        (method git-fetch)
        (uri (git-reference
              (url "https://github.com/tree-sitter/tree-sitter-cpp")
              (commit (string-append "v" version))))
        (file-name (git-file-name name version))
        (sha256
         (base32
          "08ywv6n80sa541rr08bqz4zyg7byvjcabp68lvxmcahjk8xzcgwk"))))
    (native-inputs
     `(("tree-sitter-cli" ,tree-sitter-cli)
       ("tree-sitter-c" ,tree-sitter-c)
       ("node-nan" ,node-nan)))
    (home-page "https://github.com/tree-sitter/tree-sitter-cpp")
    (synopsis "Tree-sitter C++ grammar")
    (description
      "This package provides a C++ grammar for the Tree-sitter library.")
    (license license:expat)))

(define-public tree-sitter-bash
  (package (inherit tree-sitter-c)
    (name "tree-sitter-bash")
    (version "0.19.0")
    (source
      (origin
        (method git-fetch)
        (uri (git-reference
              (url "https://github.com/tree-sitter/tree-sitter-bash")
              (commit (string-append "v" version))))
        (file-name (git-file-name name version))
        (sha256
         (base32
          "18c030bb65r50i6z37iy7jb9z9i8i36y7b08dbc9bchdifqsijs5"))))
    (native-inputs
     `(("tree-sitter-cli" ,tree-sitter-cli)
       ("node-nan" ,node-nan)))
    (arguments
     (substitute-keyword-arguments (package-arguments tree-sitter-c)
      ((#:phases phases)
       `(modify-phases ,phases
          ;; The `prebuild' dependency is a way to intercept the build step
          ;; and download a prebuilt binary instead.  If we remove it then the
          ;; buid system falls back to building from source.
          (add-after 'unpack 'remove-prebuild-dependency
            (lambda _
              (with-atomic-file-replacement "package.json"
                (lambda (in out)
                  (use-modules ((guix build json)))
                  (let ((package-meta (read-json in)))
                    (assoc-remove! (assoc-ref package-meta "dependencies")
                                   "prebuild-install")
                    (assoc-remove! (assoc-ref package-meta "devDependencies")
                                   "prebuild")
                    (write-json package-meta out))))))))))
    (home-page "https://github.com/tree-sitter/tree-sitter-bash")
    (synopsis "Tree-sitter Bash grammar")
    (description
      "This package provides a Bash grammar for the Tree-sitter library.")
    (license license:expat)))

(define-public tree-sitter-css
  (package (inherit tree-sitter-c)
    (name "tree-sitter-css")
    (version "0.19.0")
    (source
      (origin
        (method git-fetch)
        (uri (git-reference
              (url "https://github.com/tree-sitter/tree-sitter-css")
              (commit (string-append "v" version))))
        (file-name (git-file-name name version))
        (sha256
         (base32
          "014jrlgi7zfza9g38hsr4vlbi8964i5p7iglaih6qmzaiml7bja2"))))
    (home-page "https://github.com/tree-sitter/tree-sitter-css")
    (synopsis "Tree-sitter CSS grammar")
    (description
      "This package provides a CSS grammar for the Tree-sitter library.")
    (license license:expat)))

(define-public tree-sitter-go
  (package (inherit tree-sitter-c)
    (name "tree-sitter-go")
    (version "0.19.1")
    (source
      (origin
        (method git-fetch)
        (uri (git-reference
              (url "https://github.com/tree-sitter/tree-sitter-go")
              (commit (string-append "v" version))))
        (file-name (git-file-name name version))
        (sha256
         (base32
          "0nxs47vd2fc2fr0qlxq496y852rwg39flhg334s7dlyq7d3lcx4x"))))
    (arguments
     (substitute-keyword-arguments (package-arguments tree-sitter-c)
      ((#:phases phases)
       `(modify-phases ,phases
         ;; The parse-example script tries to clone git repositories.
         (add-after 'unpack 'remove-parse-example
           (lambda _
             (substitute* "package.json"
               ((" && script\\/parse-examples") ""))))))))
    (home-page "https://github.com/tree-sitter/tree-sitter-go")
    (synopsis "Tree-sitter Go grammar")
    (description
      "This package provides a Golang grammar for the Tree-sitter library.")
    (license license:expat)))