cygclass/ant.cygclass

   1 ################################################################################
   2 #
   3 # ant.cygclass - functions for building Java packages with Ant
   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 #****ih* Cygclasses/ant.cygclass
  25 #  SYNOPSIS
  26 #  inherit ant
  27 #  DESCRIPTION
  28 #  Apache Ant is a build system written in Java and used in many Java projects.
  29 #  The build is controlled by a single XML file, named 'build.xml' by default,
  30 #  which specifies the targets to be built, the commands to build them, and the
  31 #  options which may be given to control the build.
  32 #
  33 #  Ant includes support for a number of commands (called tasks), including
  34 #  compiling and executing Java code, generating documentation, downloading
  35 #  files, de/compressing archives, and running testsuites.  Third-party Ant
  36 #  tasks also exist to support additional commands.
  37 #
  38 #  This cygclass builds packages which use the Ant build system.
  39 #  INHERITS
  40 #  java.cygclass
  41 #  REQUIRES
  42 #  ant
  43 #****
  44
  45 inherit java
  46
  47 check_prog_req ant
  48
  49 #****id* ant.cygclass/ANT
  50 #  DESCRIPTION
  51 #  Absolute path to the Ant build tool.
  52 #****
  53 ANT=/usr/bin/ant
  54
  55 #****id* ant.cygclass/ANT_HOME
  56 #  DESCRIPTION
  57 #  Root datadir for the Ant build tool.  This definition is exported to the
  58 #  build environment.
  59 #****
  60 export ANT_HOME=/usr/share/ant
  61
  62 #****iv* ant.cygclass/ANT_OPTS
  63 #  DESCRIPTION
  64 #  Options for the Ant build tool to pass to the Java runtime, e.g. -Xmx.
  65 #  This definition is exported to the build environment.
  66 #****
  67 export ANT_OPTS
  68
  69 #****iv* ant.cygclass/ANT_BUILD_XML
  70 #  DESCRIPTION
  71 #  Name or relative path of the Ant build file.  This need only be defined
  72 #  if it is not build.xml (the default).
  73 #****
  74
  75 #****iC* ant.cygclass/cygant
  76 #  SYNOPSIS
  77 #  cygant [OPTIONS]
  78 #  DESCRIPTION
  79 #  Runs Ant with the given options, if any.
  80 #****
  81 cygant() {
  82         local fileargs task taskpath
  83
  84         if [ ! -e ${ANT_BUILD_XML:-build.xml} ]
  85         then
  86                 error "Ant build.xml file not found"
  87         fi
  88
  89         for task in ${ANT_TASKS//,/ }
  90         do
  91                 case ${task} in
  92                         oro|regexp)     taskpath+=${JAVA_DIR}/jakarta-${task}.jar: ;;
  93                         *)              taskpath+=${JAVA_DIR}/${task}.jar: ;;
  94                 esac
  95         done
  96         taskpath+=${JAVA_DIR}/xalan.jar:${JAVA_DIR}/xercesImpl.jar:${JAVA_DIR}/xml-apis.jar:${CLASSPATH}
  97
  98         if defined ANT_BUILD_XML
  99         then
 100                 fileargs="-f ${ANT_BUILD_XML}"
 101         fi
 102
 103         JAVACMD=${JAVA} \
 104         /usr/bin/ant -lib ${taskpath} ${fileargs} ${@} || error "ant build failed"
 105 }
 106
 107 #****iI* ant.cygclass/doanttask
 108 #  SYNOPSIS
 109 #  doanttask JAR_FILE [JAR_FILE] ...
 110 #  DESCRIPTION
 111 #  Installs the given .jar file(s) into the Ant task directory.
 112 #****
 113 doanttask() {
 114         local _insinto_tmp=${_insinto_dir}
 115
 116         insinto ${ANT_HOME}/lib
 117         doins ${@}
 118
 119         _insinto_dir=${_insinto_tmp}
 120 }
 121
 122 #****iv* ant.cygclass/ANT_BUILD_ARGS
 123 #  DESCRIPTION
 124 #  Arguments to pass to the Ant build command if this src_compile is used.
 125 #****
 126 #****iv* ant.cygclass/ANT_BUILD_TARGETS
 127 #  DESCRIPTION
 128 #  Target(s) to be built during the Ant build command if this src_compile is used.
 129 #****
 130
 131 #****io* ant.cygclass/src_compile (ant)
 132 #  DEFINITION
 133 src_compile() {
 134         lndirs
 135         cd ${B}
 136         cygant ${ANT_BUILD_ARGS} ${ANT_BUILD_TARGETS}
 137 }
 138 #****
 139
 140 #****iv* ant.cygclass/ANT_TEST_ARGS
 141 #  DESCRIPTION
 142 #  Arguments to pass to Ant during testing if this src_test is used.
 143 #****
 144 #****iv* ant.cygclass/ANT_TEST_TARGETS
 145 #  DESCRIPTION
 146 #  Target(s) to be built to run the testsuite if this src_test is used.
 147 #****
 148
 149 #****io* ant.cygclass/src_test (ant)
 150 #  DEFINITION
 151 src_test() {
 152         cd ${B}
 153         ANT_TASKS="${ANT_TASKS} junit" cygant ${ANT_TEST_ARGS} ${ANT_TEST_TARGETS:-test}
 154 }
 155 #****
 156
 157 #****iv* ant.cygclass/ANT_INSTALL_JARS
 158 #  DESCRIPTION
 159 #  Relative paths of .jar files to be installed by ant_install.
 160 #****
 161 #****iv* ant.cygclass/ANT_INSTALL_JAVADOC
 162 #  DESCRIPTION
 163 #  Relative paths of javadoc directories to be installed by ant_install.
 164 #****
 165 #****iv* ant.cygclass/ANT_INSTALL_TASKS
 166 #  DESCRIPTION
 167 #  Relative paths of Ant task .jar files to be installed by ant_install.
 168 #****
 169 #****iv* ant.cygclass/ANT_INSTALL_WRAPPERS
 170 #  SYNOPSIS
 171 #  ANT_INSTALL_WRAPPERS="name1,name1.jar[,main.class1] name2,name2.jar[,main.class2] ..."
 172 #  DESCRIPTION
 173 #  Comma-delineated set of arguments to pass to java_wrapper.  Multiple
 174 #  wrappers can be created by separating the argument sets with spaces.
 175 #****
 176
 177 #****iI* ant.cygclass/ant_install
 178 #  SYNOPSIS
 179 #  ant_install
 180 #  DESCRIPTION
 181 #  Installs the files and directories specified by ANT_INSTALL_JARS,
 182 #  ANT_INSTALL_JAVADOC, and/or ANT_INSTALL_TASKS, at least one of which
 183 #  must be defined.
 184 #****
 185 ant_install() {
 186         local wrap
 187
 188         if ! defined ANT_INSTALL_JARS && ! defined ANT_INSTALL_JAVADOC && ! defined ANT_INSTALL_TASKS
 189         then
 190                 error "ant_install: ANT_INSTALL_* all undefined; nothing to install"
 191         fi
 192
 193         if defined ANT_INSTALL_JARS
 194         then
 195                 dojar ${ANT_INSTALL_JARS}
 196         fi
 197         if defined ANT_INSTALL_JAVADOC
 198         then
 199                 dojavadoc ${ANT_INSTALL_JAVADOC}
 200         fi
 201         if defined ANT_INSTALL_TASKS
 202         then
 203                 doanttask ${ANT_INSTALL_TASKS}
 204         fi
 205
 206         for wrap in ${ANT_INSTALL_WRAPPERS}
 207         do
 208                 java_wrapper ${wrap//,/ }
 209         done
 210 }
 211
 212 #****io* ant.cygclass/src_install (ant)
 213 #  DEFINITION
 214 src_install() {
 215         cd ${B}
 216         ant_install
 217 }
 218 #****
 219
 220 readonly -f cygant doanttask ant_install