cygclass/waf.cygclass

   1 ################################################################################
   2 #
   3 # waf.cygclass - functions for building Waf-based packages
   4 #
   5 # Part of cygport - Cygwin packaging application
   6 # Copyright (C) 2006-2020 Cygport authors
   7 # Provided by the Cygwin project <https://cygwin.com/>
   8 #
   9 # cygport is free software: you can redistribute it and/or modify
  10 # it under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation, either version 3 of the License, or
  12 # (at your option) any later version.
  13 #
  14 # cygport is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with cygport.  If not, see <https://www.gnu.org/licenses/>.
  21 #
  22 ################################################################################
  23
  24 #****h* Cygclasses/waf.cygclass
  25 #  SYNOPSIS
  26 #  inherit waf
  27 #  DESCRIPTION
  28 #  Waf is a general-purpose build system written in Python used by XMMS2, a
  29 #  few GTK+ programs, and some other projects.  The build system is provided
  30 #  by a bundled 'waf' script in the top source directory, and is driven
  31 #  by a 'wscript' file in the top source directory and 'wscript_build' files
  32 #  in subdirectories, both of which are also written in Python.
  33 #  NOTE
  34 #  Previous versions uses to allow use of a system installed waf.  This is no
  35 #  longer supported, as waf does not have a stable API and is therefore not
  36 #  feasibly used in this way.  Fortunately, by now most packages do include
  37 #  a recent enough waf to build properly with at most only patches to 'wscript'
  38 #  and/or 'wscript_build' files.
  39 #  REQUIRES
  40 #  python
  41 #****
  42
  43 # cross-compiling is not (yet?) supported
  44 __cross_compiling_error
  45
  46 #****d* waf.cygclass/WAF
  47 #  DESCRIPTION
  48 #  Path to the Waf command.
  49 #****
  50 WAF="./waf"
  51
  52
  53 #****C* waf.cygclass/waf_compile
  54 #  SYNOPSIS
  55 #  waf_compile [OPTIONS]
  56 #  DESCRIPTION
  57 #  Runs 'waf configure' to configure the package, followed by 'waf build' to
  58 #  compile it.  WAF_CONFIGURE_FLAGS and WAF_BUILD_FLAGS can be defined to pass
  59 #  additional arguments to the configure and build commands, respectively.
  60 #  Any arguments to waf_compile are passed as configure flags to the 'waf
  61 #  configure' command.  waf_compile must be run from the directory containing
  62 #  'wscript'.
  63 #****
  64 waf_compile() {
  65         if [ ! -e wscript ]
  66         then
  67                 error "waf_compile: wscript: file not found"
  68         fi
  69
  70 #****v* waf_compile/WAF_CONFIGURE_FLAGS
  71 #  DESCRIPTION
  72 #  String containing additional arguments to pass to 'waf configure'.
  73 #****
  74         ${WAF} configure \
  75                 --prefix=$(__host_prefix) \
  76                 ${WAF_CONFIGURE_FLAGS} ${@} \
  77                 || error "waf configure failed"
  78
  79 #****v* waf_compile/WAF_BUILD_FLAGS
  80 #  DESCRIPTION
  81 #  String containing additional arguments to pass to 'waf build'.
  82 #****
  83         ${WAF} build ${_nproc} ${WAF_BUILD_FLAGS} || error "waf build failed"
  84 }
  85
  86 #****T* waf.cygclass/waf_test
  87 #  DESCRIPTION
  88 #  Runs the package's test suite with 'waf check'.  WAF_TEST_FLAGS can be
  89 #  defined to pass additional arguments to the check command.  Any arguments
  90 #  to waf_test are passed as well. waf_test must be run from the directory
  91 #  containing 'wscript'.
  92 #****
  93 waf_test() {
  94         if [ ! -e wscript ]
  95         then
  96                 error "waf_install: wscript: file not found"
  97         fi
  98
  99 #****v* waf_test/WAF_TEST_FLAGS
 100 #  DESCRIPTION
 101 #  String containing additional arguments to pass to 'waf check'.
 102 #****
 103         ${WAF} check -k ${WAF_TEST_FLAGS} ${@} || true
 104 }
 105
 106 #****I* waf.cygclass/waf_install
 107 #  DESCRIPTION
 108 #  Installs the package into $D with 'waf install'.  WAF_INSTALL_FLAGS can be
 109 #  defined to pass additional arguments to the install command.  Any arguments
 110 #  to waf_install are passed as well. waf_install must be run from the directory
 111 #  containing 'wscript'.
 112 #****
 113 waf_install() {
 114         if [ ! -e wscript ]
 115         then
 116                 error "waf_install: wscript: file not found"
 117         fi
 118
 119 #****v* waf_install/WAF_INSTALL_FLAGS
 120 #  DESCRIPTION
 121 #  String containing additional arguments to pass to 'waf install'.
 122 #****
 123         ${WAF} install --destdir=${D} ${WAF_INSTALL_FLAGS} ${@} || error "waf install failed"
 124 }
 125
 126 #****o* waf.cygclass/src_compile (waf)
 127 #  DEFINITION
 128 src_compile() {
 129         lndirs
 130         cd ${B}
 131         waf_compile
 132 }
 133 #****
 134
 135 #****o* waf.cygclass/src_install (waf)
 136 #  DEFINITION
 137 src_install() {
 138         cd ${B}
 139         waf_install
 140 }
 141 #****
 142
 143 readonly -f waf_compile waf_test waf_install