From patchwork Sun Jan 24 10:51:23 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Leo Prikler X-Patchwork-Id: 26599 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id C0B9027BC1A; Sun, 24 Jan 2021 10:53:11 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H4,RCVD_IN_MSPIKE_WL,SPF_HELO_PASS, T_DKIM_INVALID,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 688A227BC19 for ; Sun, 24 Jan 2021 10:53:10 +0000 (GMT) Received: from localhost ([::1]:58142 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1l3d13-0003Ip-Ko for patchwork@mira.cbaines.net; Sun, 24 Jan 2021 05:53:09 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:37624) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1l3d0w-0003IP-JQ for guix-patches@gnu.org; Sun, 24 Jan 2021 05:53:02 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:52535) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1l3d0w-0004tf-C7 for guix-patches@gnu.org; Sun, 24 Jan 2021 05:53:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1l3d0w-00007Q-B7 for guix-patches@gnu.org; Sun, 24 Jan 2021 05:53:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#46053] [PATCH v2] build-system: Add renpy-build-system. References: <6bf051d15833939d09f190d11cdbbf7954fdc3c0.camel@student.tugraz.at> In-Reply-To: <6bf051d15833939d09f190d11cdbbf7954fdc3c0.camel@student.tugraz.at> Resent-From: Leo Prikler Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 24 Jan 2021 10:53:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 46053 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 46053@debbugs.gnu.org Received: via spool by 46053-submit@debbugs.gnu.org id=B46053.1611485529361 (code B ref 46053); Sun, 24 Jan 2021 10:53:02 +0000 Received: (at 46053) by debbugs.gnu.org; 24 Jan 2021 10:52:09 +0000 Received: from localhost ([127.0.0.1]:35843 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1l3d04-00005l-A9 for submit@debbugs.gnu.org; Sun, 24 Jan 2021 05:52:08 -0500 Received: from mailrelay.tugraz.at ([129.27.2.202]:55054) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1l3d02-00005b-4n for 46053@debbugs.gnu.org; Sun, 24 Jan 2021 05:52:07 -0500 Received: from localhost.localdomain (217-149-173-242.nat.highway.telekom.at [217.149.173.242]) by mailrelay.tugraz.at (Postfix) with ESMTPSA id 4DNqZ95mGQz1LBCm; Sun, 24 Jan 2021 11:52:01 +0100 (CET) DKIM-Filter: OpenDKIM Filter v2.11.0 mailrelay.tugraz.at 4DNqZ95mGQz1LBCm DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tugraz.at; s=mailrelay; t=1611485522; bh=tANXfrfnp/shQTroYlPUw/QPhfb6ib8QwRom5vrvDRo=; h=From:To:Cc:Subject:Date:From; b=On2EOZEbMOcKOwcMHqhfYcU/Nl7BO+tRTDZ0UfWPfMUfuS1i2UjSi/O4IZ7W+AFUx /dYR+66dll6MuYqgOGKnX7TysxADYbnbTKY7U253wDpj8fAZlY2W/HYEJzYSOCV4AE +ElcbFpaMMY5dymsti8tIdR7mdbh7VZTpmuHBU3g= From: Leo Prikler Date: Sun, 24 Jan 2021 11:51:23 +0100 Message-Id: <20210124105122.9409-1-leo.prikler@student.tugraz.at> X-Mailer: git-send-email 2.30.0 MIME-Version: 1.0 X-TUG-Backscatter-control: bt4lQm5Tva3SBgCuw0EnZw X-Scanned-By: MIMEDefang 2.74 on 129.27.10.117 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches * guix/build/renpy-build-system.scm: New file. * guix/build-system/renpy.scm: New file. * Makefile.am (MODULES): Add them here. * doc/guix.texi (Build Systems): Document renpy-build-system. --- Makefile.am | 2 + doc/guix.texi | 13 +++ guix/build-system/renpy.scm | 131 ++++++++++++++++++++++++++++++ guix/build/renpy-build-system.scm | 99 ++++++++++++++++++++++ 4 files changed, 245 insertions(+) create mode 100644 guix/build-system/renpy.scm create mode 100644 guix/build/renpy-build-system.scm diff --git a/Makefile.am b/Makefile.am index 8a8133d669..c2d71ca5be 100644 --- a/Makefile.am +++ b/Makefile.am @@ -150,6 +150,7 @@ MODULES = \ guix/build-system/node.scm \ guix/build-system/perl.scm \ guix/build-system/python.scm \ + guix/build-system/renpy.scm \ guix/build-system/ocaml.scm \ guix/build-system/qt.scm \ guix/build-system/waf.scm \ @@ -205,6 +206,7 @@ MODULES = \ guix/build/ocaml-build-system.scm \ guix/build/qt-build-system.scm \ guix/build/r-build-system.scm \ + guix/build/renpy-build-system.scm \ guix/build/rakudo-build-system.scm \ guix/build/ruby-build-system.scm \ guix/build/scons-build-system.scm \ diff --git a/doc/guix.texi b/doc/guix.texi index 4a20b3b902..f44bf29963 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -7779,6 +7779,19 @@ passes flags specified by the @code{#:make-maker-flags} or Which Perl package is used can be specified with @code{#:perl}. @end defvr +@defvr {Scheme Variable} renpy-build-system +This variable is exported by @code{(guix build-system renpy)}. It implements +the more or less standard build procedure used by Ren'py games, which consists +of loading @code{#:game} once, thereby creating bytecode for it. + +It further creates a wrapper script in @code{bin/} and a desktop entry in +@code{share/applications}, both of which can be used to launch the game. + +Which Ren'py package is used can be specified with @code{#:renpy}. +Games can also be installed in outputs other than ``out'' by using +@code{#:output}. +@end defvr + @defvr {Scheme Variable} qt-build-system This variable is exported by @code{(guix build-system qt)}. It is intended for use with applications using Qt or KDE. diff --git a/guix/build-system/renpy.scm b/guix/build-system/renpy.scm new file mode 100644 index 0000000000..35edc0056d --- /dev/null +++ b/guix/build-system/renpy.scm @@ -0,0 +1,131 @@ +;;; GNU Guix --- Functional package management for GNU +;;; Copyright © 2021 Leo Prikler +;;; +;;; 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 . + +(define-module (guix build-system renpy) + #:use-module (guix store) + #:use-module (guix utils) + #:use-module (guix memoization) + #:use-module (guix packages) + #:use-module (guix derivations) + #:use-module (guix search-paths) + #:use-module (guix build-system) + #:use-module (guix build-system gnu) + #:use-module (ice-9 match) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-26) + #:export (%renpy-build-system-modules + default-renpy + renpy-build + renpy-build-system)) + +(define (default-renpy) + "Return the default Ren'py package." + ;; Lazily resolve the binding to avoid a circular dependency. + (let ((module (resolve-interface '(gnu packages game-development)))) + (module-ref module 'renpy))) + +(define %renpy-build-system-modules + ;; Build-side modules imported by default. + `((guix build renpy-build-system) + (guix build json) + (guix build python-build-system) + ,@%gnu-build-system-modules)) + +(define* (lower name + #:key source inputs native-inputs outputs system target + (renpy (default-renpy)) + #:allow-other-keys + #:rest arguments) + "Return a bag for NAME." + (define private-keywords + '(#:source #:target #:renpy #:inputs #:native-inputs)) + + (and (not target) ;XXX: no cross-compilation + (bag + (name name) + (system system) + (host-inputs `(,@(if source + `(("source" ,source)) + '()) + ,@inputs + + ;; Keep the standard inputs of 'gnu-build-system'. + ,@(standard-packages))) + (build-inputs `(("renpy" ,renpy) + ,@native-inputs)) + (outputs outputs) + (build renpy-build) + (arguments (strip-keyword-arguments private-keywords arguments))))) + +(define* (renpy-build store name inputs + #:key + (phases '(@ (guix build renpy-build-system) + %standard-phases)) + (configure-flags ''()) + (outputs '("out")) + (output "out") + (game "game") + (search-paths '()) + (system (%current-system)) + (guile #f) + (imported-modules %renpy-build-system-modules) + (modules '((guix build renpy-build-system) + (guix build utils)))) + "Build SOURCE using RENPY, and with INPUTS." + (define builder + `(begin + (use-modules ,@modules) + (renpy-build #:name ,name + #:source ,(match (assoc-ref inputs "source") + (((? derivation? source)) + (derivation->output-path source)) + ((source) + source) + (source + source)) + #:configure-flags ,configure-flags + #:system ,system + #:phases ,phases + #:outputs %outputs + #:output ,output + #:game ,game + #:search-paths ',(map search-path-specification->sexp + search-paths) + #:inputs %build-inputs))) + + (define guile-for-build + (match guile + ((? package?) + (package-derivation store guile system #:graft? #f)) + (#f ; the default + (let* ((distro (resolve-interface '(gnu packages commencement))) + (guile (module-ref distro 'guile-final))) + (package-derivation store guile system #:graft? #f))))) + + (build-expression->derivation store name builder + #:inputs inputs + #:system system + #:modules imported-modules + #:outputs outputs + #:guile-for-build guile-for-build)) + +(define renpy-build-system + (build-system + (name 'renpy) + (description "The Ren'py build system") + (lower lower))) diff --git a/guix/build/renpy-build-system.scm b/guix/build/renpy-build-system.scm new file mode 100644 index 0000000000..464fc97b13 --- /dev/null +++ b/guix/build/renpy-build-system.scm @@ -0,0 +1,99 @@ +;;; GNU Guix --- Functional package management for GNU +;;; Copyright © 2021 Leo Prikler +;;; +;;; 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 . + +(define-module (guix build renpy-build-system) + #:use-module ((guix build gnu-build-system) #:prefix gnu:) + #:use-module ((guix build python-build-system) #:prefix python:) + #:use-module (guix build json) + #:use-module (guix build utils) + #:use-module (ice-9 match) + #:use-module (ice-9 ftw) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-26) + #:export (%standard-phases + renpy-build)) + +(define* (build #:key game #:allow-other-keys) + (for-each make-file-writable + (find-files game (lambda (pred stat) + (eq? (stat:type stat) 'directory)))) + (invoke "renpy" + "--json-dump" (string-append game "/renpy-build.json") + game + ;; should be "compile", but renpy wants to compile itself really + ;; badly if we do + "quit") + #t) + +(define* (install #:key outputs game (output "out") #:allow-other-keys) + (let* ((out (assoc-ref outputs output)) + (json-dump (call-with-input-file (string-append game + "/renpy-build.json") + read-json)) + (build (assoc-ref json-dump "build")) + (executable-name (assoc-ref build "executable_name")) + (directory-name (assoc-ref build "directory_name"))) + (let ((launcher (string-append out "/bin/" executable-name)) + (data (string-append out "/share/renpy/" directory-name))) + (mkdir-p (string-append out "/bin")) + (copy-recursively game data) + ;; We don't actually want the metadata to be dumped in the output + ;; directory + (delete-file (string-append data "/renpy-build.json")) + (call-with-output-file launcher + (lambda (port) + (format port "#!~a~%~a ~a \"$@\"" + (which "bash") + (which "renpy") + data))) + (chmod launcher #o755))) + #t) + +(define* (install-desktop-file #:key outputs game (output "out") + #:allow-other-keys) + (let* ((out (assoc-ref outputs output)) + (json-dump (call-with-input-file (string-append game + "/renpy-build.json") + read-json)) + (build (assoc-ref json-dump "build")) + (directory-name (assoc-ref build "directory_name")) + (executable-name (assoc-ref build "executable_name"))) + (make-desktop-entry-file + (string-append out "/share/applications/" executable-name ".desktop") + #:name (assoc-ref json-dump "name") + #:generic-name (assoc-ref build "display_name") + #:exec (string-append (which "renpy") " " + out "/share/renpy/" directory-name) + #:categories '("Game" "Visual Novel"))) + #t) + +(define %standard-phases + (modify-phases gnu:%standard-phases + (add-after 'unpack 'enable-bytecode-determinism + (assoc-ref python:%standard-phases 'enable-bytecode-determinism)) + (delete 'bootstrap) + (delete 'configure) + (replace 'build build) + (delete 'check) + (replace 'install install) + (add-after 'install 'install-desktop-file install-desktop-file))) + +(define* (renpy-build #:key inputs (phases %standard-phases) + #:allow-other-keys #:rest args) + "Build the given Ren'py package, applying all of PHASES in order." + (apply gnu:gnu-build #:inputs inputs #:phases phases args))