1 ###############################################################################
3 # Name : build variable calculator #
4 # Author : Chris Koeritz #
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 #
12 # bash ~/feisty_meow/scripts/generator/build_variables.sh #
14 # which will establish a new shell containing all the variables, or you can #
15 # 'source' the script like so: #
17 # build_vars=~/feisty_meow/scripts/generator/build_variables.sh #
18 # source $build_vars $build_vars #
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. #
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 ###############################################################################
35 # prerequisites for this script:
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.
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.
47 # get the most important bits first; the directory this script lives in and
54 # helpful build function zone.
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/'
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/'
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
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
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
94 BUILD_SCRIPTS_DIR="$(echo $BUILD_SCRIPTS_DIR | tr '\\\\' '/' )"
95 echo post tr buildscriptsdir is $BUILD_SCRIPTS_DIR
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"
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
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'
113 if [ ! -z "$IS_UNIX" ]; then export OPERATING_SYSTEM=UNIX;
114 elif [ ! -z "$IS_DOS" ]; then export OPERATING_SYSTEM=WIN32;
116 # the system is unknown, so we give up on guessing.
117 export OPERATING_SYSTEM=unknown
119 if [ ! -z "$SHELL_DEBUG" ]; then
120 echo "[OS is \"$OPERATING_SYSTEM\"]"
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
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.
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"
142 # new style repository is a level above the build hierarchy.
143 export REPOSITORY_DIR="$(echo "$BUILDING_HIERARCHY" | sed -e 's/\(.*\)\/[^\/]*/\1/')"
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")"
152 if [ ! -z "$SHELL_DEBUG" ]; then
153 echo "[REPOSITORY_DIR is $REPOSITORY_DIR]"
156 # new BUILD_TOP variable points at the utter top-most level of any files
157 # in the building hierarchy.
158 if [ -d "$REPOSITORY_DIR/../../build" ]; then
159 export BUILD_TOP="$REPOSITORY_DIR/../.."
161 # this is actually just a guess.
162 export BUILD_TOP="$REPOSITORY_DIR"
165 # this variable points at a folder where we store most of the generated products
166 # of the build. these tend to be the things that will be used for packaging into
167 # different types of products.
168 export PRODUCTION_DIR="$BUILD_TOP/production"
170 # we define a log file storage area that can be relied on by the build.
171 export LOGS_DIR="$PRODUCTION_DIR/logs"
172 if [ ! -d "$LOGS_DIR" ]; then
176 # hook clam into the compilation system.
179 /usr/bin/make -I "$CLAM_DIR" $*
184 # debugging area where we say what we think we know.
186 #echo scripts: $BUILD_SCRIPTS_DIR
187 #echo build tools hier: $BUILDING_HIERARCHY
188 #echo this tool: $THIS_TOOL_NAME
189 #echo repository: $REPOSITORY_DIR
190 #echo clam: $CLAM_DIR
191 #echo makeflags: $MAKEFLAGS
195 # test out our computed variables to make sure they look right.
196 pushd / &>/dev/null # jump to the root so relative paths are caught.
198 # first the scripts directory; do we find this script there?
199 if [ ! -f "$BUILD_SCRIPTS_DIR/$THIS_TOOL_NAME" ]; then
200 echo "This script cannot locate the proper build folders. The crucial path"
201 echo "variable seems to be '$BUILD_SCRIPTS_DIR', which"
202 echo "does not seem to contain '$THIS_TOOL_NAME' (this"
203 echo "script's apparent name)."
206 # next the clam directory; is the main variables file present there?
207 if [ ! -f "$CLAM_DIR/variables.def" ]; then
208 echo "The clam directory could not be located under our build tools hierarchy."
209 echo "Please examine the configuration and make sure that this script is in a"
210 echo "directory that resides at the same height as the 'clam' directory."
213 # now compute some more paths with a bit of "heuristics" for where we can
214 # find the source code.
215 export TOOL_SOURCES="$REPOSITORY_DIR/core/tools"
216 if [ ! -d "$TOOL_SOURCES/dependency_tool" -o ! -d "$TOOL_SOURCES/clam_tools" ]; then
217 if [ ! -d "$TOOL_SOURCES/dependency_tool" -o ! -d "$TOOL_SOURCES/clam_tools" ]; then
218 echo "This script cannot locate the tool source code folder. This is where the"
219 echo "dependency_tool and clam_tools folders are expected to be."
223 # where we store the binaries used for building the rest of the code base.
224 export BINARY_DIR="$PRODUCTION_DIR/clam_bin"
225 # the final destination for the new binaries which provide the hoople
226 # build with all the apps it needs to get going.
227 export TARGETS_DIR="$PRODUCTION_DIR/binaries"
228 # targets directory is meaningful to clam, which will use it for output.
229 export INTERMEDIATE_EXE_DIR="$TARGETS_DIR"
230 # where we are building the apps before they get promoted.
232 export WASTE_DIR="$PRODUCTION_DIR/waste"
233 if [ ! -d "$WASTE_DIR" ]; then
234 mkdir -p "$WASTE_DIR"
236 export TEMPORARIES_DIR="$WASTE_DIR/temporaries"
237 if [ ! -d "$TEMPORARIES_DIR" ]; then
238 mkdir -p "$TEMPORARIES_DIR"
241 # calculate which build ini file to use.
242 export BUILD_PARAMETER_FILE="$PRODUCTION_DIR/feisty_meow_config.ini"
243 if [ ! -f "$BUILD_PARAMETER_FILE" ]; then
244 echo "Cannot find a useful build configuration file."
247 # pick the executable's file ending based on the platform.
248 if [ "$OPERATING_SYSTEM" == "UNIX" ]; then export EXE_ENDING=;
249 elif [ "$OPERATING_SYSTEM" == "WIN32" ]; then export EXE_ENDING=.exe;
251 echo "The OPERATING_SYSTEM variable is unset or unknown. Bailing out."
254 # we should have established our internal variables now, so let's try
256 export PATH=$BINARY_DIR:$PATH
258 # load up the helper variables for visual studio on winders.
259 if [ "$OPERATING_SYSTEM" == "WIN32" ]; then
260 source "$BUILD_SCRIPTS_DIR/vis_stu_vars.sh"
262 export LD_LIBRARY_PATH="$TARGETS_DIR"
265 popd &>/dev/null # checking is over, jump back to the starting point.
267 ############################################################################
269 # at this point, all the build related variables should be valid.
271 if [ -z "$INCLUDED_FROM_BOOTSTRAP" \
272 -a -z "$PARM_1" ]; then
273 # we are running as a stand-alone script, so we stay resident with our
274 # current set of variables.
278 ############################################################################