updated to support 6 digits instead of 4.
[feisty_meow.git] / 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 # here is where we compute the locations for the build's pieces, based on
36 # where this script is located.  we currently assume that the build scripts
37 # like this one are at the same height in the hierarchy as the clam scripts
38 # that are used in the bootstrapping process.
39
40 # get the most important bits first; the directory this script lives in and
41 # the script's name.
42 PARM_0="$0"
43 PARM_1="$1"
44
45 ##############
46
47 # helpful build function zone.
48
49 source $FEISTY_MEOW_SCRIPTS/core/functions.sh
50
51 ##############
52
53 # perform some calculations to get the right paths from our parameters.
54 if [ ! -z "$PARM_1" ]; then
55   # use the first real parameter since this is probably the 'source' version.
56   export BUILD_SCRIPTS_DIR="$(dirname "$PARM_1")"
57   THIS_TOOL_NAME="$(basename "$PARM_1")"
58 else
59   # use the zeroth parameter, since we know nothing more about our name.
60   export BUILD_SCRIPTS_DIR="$(dirname "$PARM_0")"
61   THIS_TOOL_NAME="$(basename "$PARM_0")"
62 fi
63 BUILD_SCRIPTS_DIR="$(cd $(echo $BUILD_SCRIPTS_DIR | tr '\\\\' '/' ); \pwd)"
64
65 # figure out the other paths based on where we found this script.
66 export BUILDING_HIERARCHY="$(echo "$BUILD_SCRIPTS_DIR" | sed -e 's/\(.*\)\/[^\/]*/\1/')"
67 export CLAM_DIR="$(cd $BUILD_SCRIPTS_DIR/../clam ; \pwd)"
68 # synonym to make other builds happy.
69 export BUILDER_DIR="$BUILDING_HIERARCHY"
70
71 # guess the current platform.
72 IS_UNIX=$(uname | grep -i linux)
73 if [ -z "$IS_UNIX" ]; then IS_UNIX=$(uname | grep -i unix); fi
74 if [ -z "$IS_UNIX" ]; then IS_UNIX=$(uname | grep -i darwin); fi
75 IS_DOS=$(uname | grep -i ming)
76 if [ -z "$IS_DOS" ]; then IS_DOS=$(uname | grep -i cygwin); fi
77
78 # set some clam parameters for compilation.  if the script can't guess the
79 # right configuration, then you will need to set them in the last 'else'
80 # below.
81 if [ ! -z "$IS_UNIX" ]; then export OPERATING_SYSTEM=UNIX;
82 elif [ ! -z "$IS_DOS" ]; then export OPERATING_SYSTEM=WIN32;
83 else
84   # the system is unknown, so we give up on guessing.
85   export OPERATING_SYSTEM=unknown
86 fi
87 if [ ! -z "$SHELL_DEBUG" ]; then
88   echo "[OS is \"$OPERATING_SYSTEM\"]"
89 fi
90
91 if [ ! -z "$SHELL_DEBUG" ]; then
92   echo "[FEISTY_MEOW_DIR is $FEISTY_MEOW_DIR]"
93 fi
94
95 # new BUILD_TOP variable points at the utter top-most level of any files
96 # in the building hierarchy.
97 export BUILD_TOP="$FEISTY_MEOW_DIR"
98
99 # this variable points at a folder where we store most of the generated products
100 # of the build.  these tend to be the things that will be used for packaging into
101 # different types of products.
102 export PRODUCTION_DIR="$BUILD_TOP/production"
103
104 # we define a log file storage area that can be relied on by the build.
105 export LOGS_DIR="$PRODUCTION_DIR/logs"
106 if [ ! -d "$LOGS_DIR" ]; then
107   mkdir -p "$LOGS_DIR"
108 fi
109
110 # hook clam into the compilation system.
111 function make()
112 {
113   /usr/bin/make -I "$CLAM_DIR" $*
114 }
115
116 ##############
117
118 # debugging area where we say what we think we know.
119
120 #echo scripts: $BUILD_SCRIPTS_DIR
121 #echo build tools hier: $BUILDING_HIERARCHY
122 #echo this tool: $THIS_TOOL_NAME
123 #echo repository: $FEISTY_MEOW_DIR
124 #echo clam: $CLAM_DIR
125 #echo makeflags: $MAKEFLAGS
126
127 ##############
128
129 # test out our computed variables to make sure they look right.
130 pushd / &>/dev/null # jump to the root so relative paths are caught.
131
132 # flag for whether any checks have failed.
133 got_bad=
134
135 # first the scripts directory; do we find this script there?
136 if [ ! -f "$BUILD_SCRIPTS_DIR/$THIS_TOOL_NAME" ]; then
137   echo "This script cannot locate the proper build folders.  The crucial path"
138   echo "variable seems to be '$BUILD_SCRIPTS_DIR', which"
139   echo "does not seem to contain '$THIS_TOOL_NAME' (this"
140   echo "script's apparent name)."
141   got_bad=1
142 fi
143
144 # next the clam directory; is the main variables file present there?
145 if [ -z "$got_bad" -a ! -f "$CLAM_DIR/variables.def" ]; then
146   echo "The clam directory could not be located under our build tools hierarchy."
147   echo "Please examine the configuration and make sure that this script is in a"
148   echo "directory that resides at the same height as the 'clam' directory."
149   got_bad=1
150 fi
151
152 # now compute some more paths with a bit of "heuristics" for where we can
153 # find the source code.
154 export TOOL_SOURCES="$FEISTY_MEOW_DIR/nucleus/tools"
155 if [ -z "$got_bad" -a ! -d "$TOOL_SOURCES/dependency_tool" -o ! -d "$TOOL_SOURCES/clam_tools" ]; then
156   echo "This script cannot locate the tool source code folder.  This is where the"
157   echo "dependency_tool and clam_tools folders are expected to be."
158   got_bad=1
159 fi
160
161 ############################
162   
163 # we only run the rest of the script if we know we didn't have some kind of
164 # bad thing happen earlier.
165 if [ -z "$got_bad" ]; then
166
167   # where we store the binaries used for building the rest of the code base.
168   export BINARY_DIR="$PRODUCTION_DIR/clam_bin"
169     # the final destination for the new binaries which provide the hoople
170     # build with all the apps it needs to get going.
171   export TARGETS_DIR="$PRODUCTION_DIR/binaries"
172     # targets directory is meaningful to clam, which will use it for output.
173   export INTERMEDIATE_EXE_DIR="$TARGETS_DIR"
174     # where we are building the apps before they get promoted.
175
176   export WASTE_DIR="$PRODUCTION_DIR/waste"
177   if [ ! -d "$WASTE_DIR" ]; then
178     mkdir -p "$WASTE_DIR"
179   fi
180   export TEMPORARIES_DIR="$WASTE_DIR/temporaries"
181   if [ ! -d "$TEMPORARIES_DIR" ]; then
182     mkdir -p "$TEMPORARIES_DIR"
183   fi
184   
185   # calculate which build ini file to use.
186   export BUILD_PARAMETER_FILE="$PRODUCTION_DIR/feisty_meow_config.ini"
187   if [ ! -f "$BUILD_PARAMETER_FILE" ]; then
188     echo "Cannot find a useful build configuration file."
189   fi
190   
191   # pick the executable's file ending based on the platform.
192   if [ "$OPERATING_SYSTEM" == "UNIX" ]; then export EXE_ENDING=;
193   elif [ "$OPERATING_SYSTEM" == "WIN32" ]; then export EXE_ENDING=.exe;
194   else
195     echo "The OPERATING_SYSTEM variable is unset or unknown.  Bailing out."
196   fi
197   
198   # we should have established our internal variables now, so let's try
199   # using them.
200   export PATH=$BINARY_DIR:$PATH
201   
202   # load up the helper variables for visual studio on winders.
203   if [ "$OPERATING_SYSTEM" == "WIN32" ]; then
204     source "$BUILD_SCRIPTS_DIR/vis_stu_vars.sh"
205   else
206     export LD_LIBRARY_PATH="$TARGETS_DIR"
207   fi
208   
209   popd &>/dev/null # checking is over, jump back to the starting point.
210   
211   ############################
212   
213   # at this point, all the build related variables should be valid.
214   
215   if [ -z "$INCLUDED_FROM_BOOTSTRAP" \
216       -a -z "$PARM_1" ]; then
217     # we are running as a stand-alone script, so we stay resident with our
218     # current set of variables.
219     bash
220   fi
221
222 fi
223