stopped allowing ampersands in file names, added documentation lines.
[feisty_meow.git] / scripts / generator / bootstrap_build.sh
1 ##############
2 #  Name   : initial setup script for HOOPLE
3 #  Author : Chris Koeritz
4 #  Purpose:
5 #    This script can bootstrap the HOOPLE libraries from a state where none   #
6 #  of the required binaries are built yet.  It will build the tools that the  #
7 #  CLAM system and HOOPLE need to get a build done.  Then the script builds   #
8 #  the whole source tree as a test of the code's overall health.              #
9 ##############
10 # Copyright (c) 2004-$now By Author.  This program is free software; you can  #
11 # redistribute it and/or modify it under the terms of the GNU General Public  #
12 # License as published by the Free Software Foundation; either version 2 of   #
13 # the License or (at your option) any later version.  This is online at:      #
14 #     http://www.fsf.org/copyleft/gpl.html                                    #
15 # Please send any updates to: fred@gruntose.com                               #
16 ##############
17
18 # prerequisites for this script:
19 #
20 # (1) the script should be run with a full path, so that it can decide where
21 #     it lives with minimal fuss.
22 # (2) on windows, the unix tools bin directory should already be in the path
23 #     so that tools like dirname are already available.  use msys or cygwin
24 #     at your discretion and your own risk.
25
26 # make sure we know how to find our bash bins.
27 export PATH=/bin:$PATH
28
29 # signals that we're doing a fresh build to the variables script.
30 export INCLUDED_FROM_BOOTSTRAP=true
31
32 # pull in our build variables using the path to this script.
33 export BUILD_SCRIPTS_DIR="$( \cd "$(\dirname "$0")" && \pwd )"
34 #echo build scripts dir initial value: $BUILD_SCRIPTS_DIR
35 BUILD_SCRIPTS_DIR="$(echo $BUILD_SCRIPTS_DIR | tr '\\\\' '/' )"
36 #echo build scripts dir after chewing: $BUILD_SCRIPTS_DIR
37
38 # load in feisty meow basic scripts, if not already loaded.
39 if [ -z "$FEISTY_MEOW_SCRIPTS_LOADED" ]; then
40   bash "$BUILD_SCRIPTS_DIR/../core/bootstrap_shells.sh"
41   source "$BUILD_SCRIPTS_DIR/../core/launch_feisty_meow.sh"
42 fi
43
44 source "$FEISTY_MEOW_SCRIPTS/core/functions.sh"
45
46 # translate to dos format if there's a cygdrive in there; otherwise microsoft's tools
47 # will hose up completely due to unknown paths.
48 export FEISTY_MEOW_DIR="$(unix_to_dos_path $FEISTY_MEOW_DIR)"
49
50 # load in build variables based on our deduced paths.
51 source "$BUILD_SCRIPTS_DIR/build_variables.sh" "$BUILD_SCRIPTS_DIR/build_variables.sh"
52
53 ##############
54
55 # creates the directory for our binaries and gives it a reasonable paths configuration.
56 function prepare_binaries_dir()
57 {
58   # we'll store binaries here from the bootstrap process.
59   if [ ! -d "$BINARY_DIR" ]; then
60     echo "creating binary dir now in $BINARY_DIR"
61     mkdir "$BINARY_DIR"
62   fi
63   if [ ! -f "$BINARY_DIR/paths.ini" ]; then
64     echo "copied paths.ini to binary dir."
65     cp "$PRODUCTION_DIR/paths.ini" "$BINARY_DIR"
66   fi
67 }
68
69 ##############
70
71 # turn off sounds to avoid running the sound player that's not been built yet.
72 unset CLAM_ERROR_SOUND
73 unset CLAM_FINISH_SOUND
74
75 ##############
76
77 echo "Build bootstrap process has started."
78
79 # preconditions for the build process...
80
81 # set up our output directories etc.
82 prepare_binaries_dir
83
84 # set a flag for this process so we can omit certain compilations as necessary.
85 export BOOT_STRAPPING=true
86
87 # enable this macro to get a much noisier build.
88 #export BE_NOISY=NOISY=t
89
90 ##############
91
92 # these default flags turn off unnecessary support when we're rebuilding the
93 # minimal toolset needed for a successful build of hoople.
94 declare -a BUILD_DEFAULTS=( "BOOT_STRAPPING=t" "OPTIMIZE=t" "REBUILD=t" "DEBUG=" )
95   # bootstrapping is always turned on for this particular script.
96   # we also always optimize these builds and turn off the debug flag.
97   # rebuild ensures that the new apps are made fresh: "REBUILD=t"
98   #   it can be turned off when the build bootstrapper is being tested.
99   # noisy can be added to spew lots of text: "NOISY=t"
100   #   this can help with compilation issues by showing all the flags.
101
102 function make_code {
103   make $* $BE_NOISY ${BUILD_DEFAULTS[@]}
104   if [ $? != 0 ]; then
105     echo "Failed to make on: $*"
106     exit 2323
107   fi
108 }
109
110 # removes pcdos eol from any scripts.  that assumes that the bootstrap script
111 # itself isn't polluted with them.
112 function strip_cr {
113   ctrl_m=$'\015'
114   for i in $*; do
115     tempgrep="$(mktemp "$TEMPORARIES_DIR/tempgrep.XXXXXX")"
116     grep -l "$ctrl_m" "$i" >$tempgrep
117     if [ ! -z "$(cat $tempgrep)" ]; then
118       temp="$(mktemp "$TEMPORARIES_DIR/tempsed.XXXXXX")"
119       sed -e "s/$ctrl_m$//" <$i >$temp
120       mv -f $temp $i
121     fi
122     rm "$tempgrep"
123   done
124 }
125
126 # the promote function moves a file from the exe directory into the build's
127 # bin directory.  it performs the copy step and makes the file executable.
128 # the original name should just be the root of the filename without any
129 # extension.
130 # NOTE: this depends on the operating system having been chosen above!
131 if [ "$OPERATING_SYSTEM" = "UNIX" ]; then
132   function promote {
133     prepare_binaries_dir
134
135     if [ ! -f "$INTERMEDIATE_EXE_DIR/$1" ]; then
136       echo "Failed to build the application $1--quitting now."
137       exit 1892
138     fi
139     cp "$INTERMEDIATE_EXE_DIR/$1" "$BINARY_DIR/$1"
140     strip "$BINARY_DIR/$1"
141     chmod 755 "$BINARY_DIR/$1"
142   }
143 elif [ "$OPERATING_SYSTEM" = "WIN32" ]; then
144   function promote {
145     prepare_binaries_dir
146
147     if [ ! -f "$INTERMEDIATE_EXE_DIR/$1.exe" ]; then
148       echo "Failed to build the application $1.exe--quitting now."
149       exit 1892
150     fi
151     cp "$INTERMEDIATE_EXE_DIR/$1.exe" "$BINARY_DIR"
152     chmod 755 "$BINARY_DIR/$1.exe"
153   }
154 else
155   echo "The OPERATING_SYSTEM variable is unset or unknown.  Bailing out."
156   exit 1822
157 fi
158
159 ##############
160
161 # start the actual build process now...
162
163 # recreate our useful waste directories and other things...
164 source "$BUILD_SCRIPTS_DIR/build_variables.sh" "$BUILD_SCRIPTS_DIR/build_variables.sh"
165
166 # clean out any current contents.
167 bash "$BUILD_SCRIPTS_DIR/whack_build.sh" clean
168
169 # make this again so no one gets cranky.
170 mkdir -p "$LOGS_DIR"
171
172 toolset_names=(makedep value_tagger version_stamper vsts_version_fixer write_build_config short_path sleep_ms zap_process playsound create_guid)
173
174 if [ -z "$SAVE_BINARIES" ]; then
175   for i in ${toolset_names[*]}; do
176     whack_name="$BINARY_DIR/$i$EXE_ENDING"
177 #echo removing "$whack_name"
178     rm -f "$whack_name"
179   done
180 fi
181
182 # make the clam shell scripts executable.
183 chmod 755 "$CLAM_DIR"/*.sh
184 chmod 755 "$CLAM_DIR"/cpp/*.sh
185 #chmod 755 "$CLAM_DIR"/csharp/*.sh
186
187 # rebuild the dependency tool.  needed by everything, pretty much, but
188 # since it's from the xfree project, it doesn't need any of our libraries.
189 if [ ! -f "$BINARY_DIR/makedep$EXE_ENDING" ]; then
190   pushd "$TOOL_SOURCES/dependency_tool" &>/dev/null
191   make_code pre_compilation NO_DEPS=t OMIT_VERSIONS=t
192   make_code NO_DEPS=t OMIT_VERSIONS=t
193   if [ ! -f "$INTERMEDIATE_EXE_DIR/makedep$EXE_ENDING" ]; then
194     echo ""
195     echo ""
196     echo "The build of the makedep tool has failed.  Unknown causes...  Argh."
197     echo ""
198     exit 1820
199   fi
200   # make the tool available for the rest of the build.
201   promote makedep
202   popd &>/dev/null
203 fi
204
205 # rebuild the version tools and other support apps.
206 if [ ! -f "$BINARY_DIR/value_tagger$EXE_ENDING" \
207     -o ! -f "$BINARY_DIR/version_stamper$EXE_ENDING" \
208     -o ! -f "$BINARY_DIR/vsts_version_fixer$EXE_ENDING" \
209     -o ! -f "$BINARY_DIR/write_build_config$EXE_ENDING" ]; then
210   pushd "$TOOL_SOURCES/clam_tools" &>/dev/null
211   make_code pre_compilation OMIT_VERSIONS=t
212   make_code OMIT_VERSIONS=t
213
214 #hmmm: really this should check all the expected apps.
215 #      nice to just have an array of the things built by this guy.
216   if [ ! -f "$INTERMEDIATE_EXE_DIR/version_stamper$EXE_ENDING" ]; then
217     echo ""
218     echo ""
219     echo "The build of the version_stamper tool has failed.  Unknown causes...  Argh."
220     echo ""
221     exit 1821
222   fi
223
224   promote value_tagger # tool scrambles through headers to standardize outcomes.
225   promote version_stamper  # used for version stamping.
226   promote vsts_version_fixer  # used for version stamping.
227   promote write_build_config  # creates a header of build-specific config info.
228
229   popd &>/dev/null
230 fi
231
232 # build a few other utilities.
233 if [ ! -f "$BINARY_DIR/short_path$EXE_ENDING" \
234     -o ! -f "$BINARY_DIR/sleep_ms$EXE_ENDING" \
235     -o ! -f "$BINARY_DIR/create_guid$EXE_ENDING" \
236     -o ! -f "$BINARY_DIR/zap_process$EXE_ENDING" \
237     -o ! -f "$BINARY_DIR/playsound$EXE_ENDING" ]; then
238   pushd "$TOOL_SOURCES/simple_utilities" &>/dev/null
239   make_code pre_compilation OMIT_VERSIONS=t
240   make_code OMIT_VERSIONS=t
241
242   promote create_guid  # globally unique ID creator.
243   promote playsound  # sound playback tool.
244   promote short_path  # provides short path names for exes on windows.
245   promote sleep_ms  # sleep tool is used in some scripts.
246   promote zap_process  # kills a process in the task list.
247
248   popd &>/dev/null
249 fi
250
251 echo "The build binaries have been re-created (or were already present)."
252
253 # we won't do the full build if they told us to just do the bootstrap.
254 if [ -z "$JUST_BOOTSTRAP_APPS" ]; then
255   echo Cleaning up the temporary files that were built.
256   bash "$BUILD_SCRIPTS_DIR/whack_build.sh" clean
257
258   # recreate our useful junk directories...
259   mkdir -p "$WASTE_DIR"
260   mkdir -p "$TEMPORARIES_DIR"
261   mkdir -p "$LOGS_DIR"
262
263   echo Now starting a normal build of the repository source code.
264   pushd "$FEISTY_MEOW_DIR" &>/dev/null
265   unset BUILD_DEFAULTS
266   declare -a BUILD_DEFAULTS=( "BOOT_STRAPPING=" "OPTIMIZE=t" "DEBUG=t" "REBUILD=t" )
267   make_code
268
269   popd &>/dev/null
270 fi
271