scripts/generator/build_variables.sh

   1 ###############################################################################
   2 #                                                                             #
   3 #  Name   : build variable calculator                                         #
   4 #  Author : Chris Koeritz                                                     #
   5 #                                                                             #
   6 #  Purpose:                                                                   #
   7 #                                                                             #
   8 #    This script sets up all the variables needed by the HOOPLE system for    #
   9 #  building the source code.  It can either be run as a bash script directly  #
  10 #  like so:                                                                   #
  11 #                                                                             #
  12 #      bash ~/feisty_meow/scripts/generator/build_variables.sh                #
  13 #                                                                             #
  14 #  which will establish a new shell containing all the variables, or you can  #
  15 #  'source' the script like so:                                               #
  16 #                                                                             #
  17 #      build_vars=~/feisty_meow/scripts/generator/build_variables.sh          #
  18 #      source $build_vars $build_vars                                         #
  19 #                                                                             #
  20 #  to set all of the variables in your current shell.  The full path is       #
  21 #  necessary in these commands to allow the script to easily find itself.     #
  22 #  The 'source' version needs to be fed the actual path to the script         #
  23 #  because bash 'source' commands cause the first parameter (called $0) to    #
  24 #  be set to just the path to bash itself.                                    #
  25 #                                                                             #
  26 ###############################################################################
  27 # Copyright (c) 2004-$now By Author.  This program is free software; you can  #
  28 # redistribute it and/or modify it under the terms of the GNU General Public  #
  29 # License as published by the Free Software Foundation; either version 2 of   #
  30 # the License or (at your option) any later version.  This is online at:      #
  31 #     http://www.fsf.org/copyleft/gpl.html                                    #
  32 # Please send any updates to: fred@gruntose.com                               #
  33 ###############################################################################
  34
  35 # prerequisites for this script:
  36 #
  37 # (1) the script should be run with a full path, so that it can decide where
  38 #     it lives with minimal fuss.
  39 # (2) on windows, the msys bin directory should already be in the path so that
  40 #     tools like dirname are already available.
  41
  42 # here is where we compute the locations for the build's pieces, based on
  43 # where this script is located.  we currently assume that the build scripts
  44 # like this one are at the same height in the hierarchy as the clam scripts
  45 # that are used in the bootstrapping process.
  46
  47 # get the most important bits first; the directory this script lives in and
  48 # the script's name.
  49 PARM_0="$0"
  50 PARM_1="$1"
  51
  52 ##############
  53
  54 # helpful build function zone.
  55
  56 # switches from a /X/path form to an X:/ form.
  57 function msys_to_dos_path() {
  58   # we always remove dos slashes in favor of forward slashes.
  59   echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
  60 }
  61
  62 # switches from an X:/ form to an /X/path form.
  63 function dos_to_msys_path() {
  64   # we always remove dos slashes in favor of forward slashes.
  65   echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
  66 }
  67
  68 ###hmmm: move test suite out to the functions file in yeti, where the definitive versions
  69 #        of dos to msys etc live.
  70 # test suite for above functions.
  71 #echo this should go from msys to dos:
  72 #  prior='/c/bogart\dingle'
  73 #  latter=$(msys_to_dos_path "$prior")
  74 #  echo went from $prior to $latter
  75 #echo this should go from dos to msys:
  76 #  prior='D:\bogart\dingle'
  77 #  latter=$(dos_to_msys_path "$prior")
  78 #  echo went from $prior to $latter
  79
  80 ##############
  81
  82 # perform some calculations to get the right paths from our parameters.
  83 if [ ! -z "$PARM_1" ]; then
  84   # use the first real parameter since this is probably the 'source' version.
  85   export BUILD_SCRIPTS_DIR="$(dirname "$PARM_1")"
  86   THIS_TOOL_NAME="$(basename "$PARM_1")"
  87 echo sourced version buildscriptsdir is $BUILD_SCRIPTS_DIR
  88 else
  89   # use the zeroth parameter, since we know nothing more about our name.
  90   export BUILD_SCRIPTS_DIR="$(dirname "$PARM_0")"
  91   THIS_TOOL_NAME="$(basename "$PARM_0")"
  92 echo bashed version buildscriptsdir is $BUILD_SCRIPTS_DIR
  93 fi
  94 BUILD_SCRIPTS_DIR="$(echo $BUILD_SCRIPTS_DIR | tr '\\\\' '/' )"
  95 echo post tr buildscriptsdir is $BUILD_SCRIPTS_DIR
  96
  97 # figure out the other paths based on where we found this script.
  98 export BUILDING_HIERARCHY="$(echo "$BUILD_SCRIPTS_DIR" | sed -e 's/\(.*\)\/[^\/]*/\1/')"
  99 export CLAM_DIR="$BUILD_SCRIPTS_DIR/../clam"
 100 # synonym to make other builds happy.
 101 export BUILDER_DIR="$BUILDING_HIERARCHY"
 102
 103 # guess the current platform.
 104 IS_UNIX=$(uname | grep -i linux)
 105 if [ -z "$IS_UNIX" ]; then IS_UNIX=$(uname | grep -i unix); fi
 106 if [ -z "$IS_UNIX" ]; then IS_UNIX=$(uname | grep -i darwin); fi
 107 IS_DOS=$(uname | grep -i ming)
 108 if [ -z "$IS_DOS" ]; then IS_DOS=$(uname | grep -i cygwin); fi
 109
 110 # set some clam parameters for compilation.  if the script can't guess the
 111 # right configuration, then you will need to set them in the last 'else'
 112 # below.
 113 if [ ! -z "$IS_UNIX" ]; then export OPERATING_SYSTEM=UNIX;
 114 elif [ ! -z "$IS_DOS" ]; then export OPERATING_SYSTEM=WIN32;
 115 else
 116   # the system is unknown, so we give up on guessing.
 117   export OPERATING_SYSTEM=unknown
 118 fi
 119 if [ ! -z "$SHELL_DEBUG" ]; then
 120   echo "[OS is \"$OPERATING_SYSTEM\"]"
 121 fi
 122
 123 # the impact of always redoing the repository directory below means that we
 124 # will always expect the build scripts to be located within the build they're
 125 # building.  that's fundamentally broken for some usages.
 126 # but just using the existing repository directory is fundamentally broken
 127 # too, since then the build variables will never re-adapt to the repository
 128 # you want.
 129 # maybe just documentation; if you are changing your repository and the build
 130 # scripts are in the right place, then you should unset REPOSITORY_DIR.
 131 # we at least check that the folder still exists now too, but that's not exact
 132 # knowledge that it's still the right directory.
 133
 134 if [ -z "$REPOSITORY_DIR" -o ! -d "$REPOSITORY_DIR" ]; then
 135   # we create the variable repository dir, but we keep the idiotic dos form of
 136   # the path, because otherwise lots of bad things happens when passing the
 137   # folders around to visual studio commands that don't allow a space after them.
 138   if [ -d "$BUILDING_HIERARCHY/source" ]; then
 139     # old style repository is same height as building hierarchy.
 140     export REPOSITORY_DIR="$BUILDING_HIERARCHY"
 141   else
 142     # new style repository is a level above the build hierarchy.
 143     export REPOSITORY_DIR="$(echo "$BUILDING_HIERARCHY" | sed -e 's/\(.*\)\/[^\/]*/\1/')"
 144   fi
 145 fi
 146
 147 if [ "$OPERATING_SYSTEM" = "WIN32" ]; then
 148   # make sure repository dir looks right on windoze.
 149   export REPOSITORY_DIR="$(msys_to_dos_path "$REPOSITORY_DIR")"
 150 fi
 151
 152 if [ ! -z "$SHELL_DEBUG" ]; then
 153   echo "[REPOSITORY_DIR is $REPOSITORY_DIR]"
 154 fi
 155
 156 # new BUILD_TOP variable points at the utter top-most level of any files
 157 # in the building hierarchy.
 158 export BUILD_TOP="$REPOSITORY_DIR"
 159
 160 # this variable points at a folder where we store most of the generated products
 161 # of the build.  these tend to be the things that will be used for packaging into
 162 # different types of products.
 163 export PRODUCTION_DIR="$BUILD_TOP/production"
 164
 165 # we define a log file storage area that can be relied on by the build.
 166 export LOGS_DIR="$PRODUCTION_DIR/logs"
 167 if [ ! -d "$LOGS_DIR" ]; then
 168   mkdir -p "$LOGS_DIR"
 169 fi
 170
 171 # hook clam into the compilation system.
 172 function make()
 173 {
 174   /usr/bin/make -I "$CLAM_DIR" $*
 175 }
 176
 177 ##############
 178
 179 # debugging area where we say what we think we know.
 180
 181 #echo scripts: $BUILD_SCRIPTS_DIR
 182 #echo build tools hier: $BUILDING_HIERARCHY
 183 #echo this tool: $THIS_TOOL_NAME
 184 #echo repository: $REPOSITORY_DIR
 185 #echo clam: $CLAM_DIR
 186 #echo makeflags: $MAKEFLAGS
 187
 188 ##############
 189
 190 # test out our computed variables to make sure they look right.
 191 pushd / &>/dev/null # jump to the root so relative paths are caught.
 192
 193 # first the scripts directory; do we find this script there?
 194 if [ ! -f "$BUILD_SCRIPTS_DIR/$THIS_TOOL_NAME" ]; then
 195   echo "This script cannot locate the proper build folders.  The crucial path"
 196   echo "variable seems to be '$BUILD_SCRIPTS_DIR', which"
 197   echo "does not seem to contain '$THIS_TOOL_NAME' (this"
 198   echo "script's apparent name)."
 199 fi
 200
 201 # next the clam directory; is the main variables file present there?
 202 if [ ! -f "$CLAM_DIR/variables.def" ]; then
 203   echo "The clam directory could not be located under our build tools hierarchy."
 204   echo "Please examine the configuration and make sure that this script is in a"
 205   echo "directory that resides at the same height as the 'clam' directory."
 206 fi
 207
 208 # now compute some more paths with a bit of "heuristics" for where we can
 209 # find the source code.
 210 export TOOL_SOURCES="$REPOSITORY_DIR/core/tools"
 211 if [ ! -d "$TOOL_SOURCES/dependency_tool" -o ! -d "$TOOL_SOURCES/clam_tools" ]; then
 212   if [ ! -d "$TOOL_SOURCES/dependency_tool" -o ! -d "$TOOL_SOURCES/clam_tools" ]; then
 213     echo "This script cannot locate the tool source code folder.  This is where the"
 214     echo "dependency_tool and clam_tools folders are expected to be."
 215   fi
 216 fi
 217
 218 # where we store the binaries used for building the rest of the code base.
 219 export BINARY_DIR="$PRODUCTION_DIR/clam_bin"
 220   # the final destination for the new binaries which provide the hoople
 221   # build with all the apps it needs to get going.
 222 export TARGETS_DIR="$PRODUCTION_DIR/binaries"
 223   # targets directory is meaningful to clam, which will use it for output.
 224 export INTERMEDIATE_EXE_DIR="$TARGETS_DIR"
 225   # where we are building the apps before they get promoted.
 226
 227 export WASTE_DIR="$PRODUCTION_DIR/waste"
 228 if [ ! -d "$WASTE_DIR" ]; then
 229   mkdir -p "$WASTE_DIR"
 230 fi
 231 export TEMPORARIES_DIR="$WASTE_DIR/temporaries"
 232 if [ ! -d "$TEMPORARIES_DIR" ]; then
 233   mkdir -p "$TEMPORARIES_DIR"
 234 fi
 235
 236 # calculate which build ini file to use.
 237 export BUILD_PARAMETER_FILE="$PRODUCTION_DIR/feisty_meow_config.ini"
 238 if [ ! -f "$BUILD_PARAMETER_FILE" ]; then
 239   echo "Cannot find a useful build configuration file."
 240 fi
 241
 242 # pick the executable's file ending based on the platform.
 243 if [ "$OPERATING_SYSTEM" == "UNIX" ]; then export EXE_ENDING=;
 244 elif [ "$OPERATING_SYSTEM" == "WIN32" ]; then export EXE_ENDING=.exe;
 245 else
 246   echo "The OPERATING_SYSTEM variable is unset or unknown.  Bailing out."
 247 fi
 248
 249 # we should have established our internal variables now, so let's try
 250 # using them.
 251 export PATH=$BINARY_DIR:$PATH
 252
 253 # load up the helper variables for visual studio on winders.
 254 if [ "$OPERATING_SYSTEM" == "WIN32" ]; then
 255   source "$BUILD_SCRIPTS_DIR/vis_stu_vars.sh"
 256 else
 257   export LD_LIBRARY_PATH="$TARGETS_DIR"
 258 fi
 259
 260 popd &>/dev/null # checking is over, jump back to the starting point.
 261
 262 ############################################################################
 263
 264 # at this point, all the build related variables should be valid.
 265
 266 if [ -z "$INCLUDED_FROM_BOOTSTRAP" \
 267     -a -z "$PARM_1" ]; then
 268   # we are running as a stand-alone script, so we stay resident with our
 269   # current set of variables.
 270   bash
 271 fi
 272
 273 ############################################################################
 274