moving to a better name than FEISTY_MEOW_GENERATED for chewed scripts folder. too...
[feisty_meow.git] / scripts / core / variables.sh
1 #!/bin/bash
2
3 ##############
4
5 # variables script:
6 #   Defines the environment variables used by the personalized unix
7 #   environment.
8 # Author: Chris Koeritz
9
10 ##############
11
12 #hmmm: moved from functions.sh; does that hose everything up?
13
14   # defines a variable within the feisty meow environment and remembers that
15   # this is a new or modified definition.  if the feisty meow codebase is
16   # unloaded, then so are all the variables that were defined.
17   # this function always exports the variables it defines.
18   function define_yeti_variable()
19   {
20 # if variable exists already, save old value for restore,
21 # otherwise save null value for restore,
22 # have to handle unsetting if there was no prior value of one
23 # we newly defined.
24 # add variable name to a list of feisty defined variables.
25
26 #hmmm: first implem just sets it up and exports the variable.
27 #  i.e., this method always exports.
28 export "${@}" 
29
30
31 return 0
32   }
33
34
35 ##############
36
37 # this section should always run or bash will reset them on us.
38 # these need to be as minimal as possible.
39
40 # sets the main prompt to a simple default, with user@host.
41 define_yeti_variable PS1='\u@\h $ ';
42 # sets the history length and max file size so we can get some long history around here.
43 define_yeti_variable HISTSIZE=1000000
44 define_yeti_variable HISTFILESIZE=8000000
45
46 # make the TERM available to all sub-shells.
47 define_yeti_variable TERM
48   
49 ##############
50   
51 # we'll run this again only if we think it's needed.
52 if [ -z "$NECHUNG" ]; then
53
54   if [ ! -z "$SHELL_DEBUG" ]; then echo variables initialization begins...; fi
55   
56   ##############
57   
58   # start with some simpler things.
59   
60   define_yeti_variable SCRIPT_SYSTEM=feisty_meow
61   
62   # OS variable records the operating system we think we found.
63   if [ -z "$OS" ]; then
64     define_yeti_variable OS=UNIX
65   fi
66   define_yeti_variable IS_DARWIN=$(echo $OSTYPE | grep -i darwin)
67   
68   ##############
69
70   # guess the current platform.
71   IS_UNIX=$(uname | grep -i linux)
72   if [ -z "$IS_UNIX" ]; then IS_UNIX=$(uname | grep -i unix); fi
73   if [ -z "$IS_UNIX" ]; then IS_UNIX=$(uname | grep -i darwin); fi
74   IS_DOS=$(uname | grep -i ming)
75   if [ -z "$IS_DOS" ]; then IS_DOS=$(uname | grep -i cygwin); fi
76
77   # now if we're stuck in DOS, try to determine the type of system.
78   if [ ! -z "$IS_DOS" ]; then
79     # IS_MSYS will be non-empty if this is the msys toolset.  otherwise
80     # we assume that it's cygwin.
81     IS_MSYS=$(uname | grep -i ming)
82   fi
83
84   ##############
85   
86   # fallbacks to set crucial variables for feisty meow...
87   
88   # set the main root directory variable for the feisty meow codebase.
89   # this is only used for extreme failure modes, when the values were not
90   # pulled in from our auto-generated config.
91   if [ -z "$FEISTY_MEOW_DIR" ]; then
92     if [ -d "$HOME/feisty_meow" ]; then
93       define_yeti_variable FEISTY_MEOW_DIR="$HOME/feisty_meow"
94       define_yeti_variable FEISTY_MEOW_SCRIPTS="$FEISTY_MEOW_SCRIPTS"
95     fi
96   fi
97
98   # set up the top-level for all build creations and logs and such.
99   if [ -z "$GENERATED_DIR" ]; then
100     define_yeti_variable GENERATED_DIR="$TMP/generated-feisty_meow"
101   fi
102   if [ ! -d "$GENERATED_DIR" ]; then
103     mkdir -p "$GENERATED_DIR"
104   fi
105   # set up our effluent outsourcing valves.
106   if [ -z "$TEMPORARIES_DIR" ]; then
107     define_yeti_variable TEMPORARIES_DIR="$GENERATED_DIR/temporaries"
108   fi
109   if [ ! -d "$TEMPORARIES_DIR" ]; then
110     mkdir -p "$TEMPORARIES_DIR"
111   fi
112
113   # similarly, make sure we have someplace to look for our generated files, if
114   # we were not handed a value.
115   if [ -z "$FEISTY_MEOW_LOADING_DOCK" ]; then
116     # The generated scripts directory is where automatically generated files live.
117     # It is separate from the main body of the shell scripts in order to keep things from
118     # exploding.
119     define_yeti_variable FEISTY_MEOW_LOADING_DOCK=$HOME/.zz_feisty_loading
120   fi
121   
122   ##############
123   
124   # umask sets a permission mask for all file creations.
125   # this mask disallows writes by "group" and "others".
126   umask 022
127   # this mask disallows writes by the "group" and disallows "others" completely.
128   #umask 027
129
130   # ulimit sets user limits.  we set the maximum allowed core dump file size
131   # to zero, because it is obnoxious to see the core dumps from crashed
132   # programs lying around everywhere.
133   ulimit -c 0
134   
135   ##############
136   
137   # user variables, sort of...  if they haven't given themselves a name yet,
138   # then we will make one up for them.
139   
140   # define a default name, if one wasn't already set.
141   if [ -z "$NAME" ]; then
142     define_yeti_variable NAME='Unset Q. Namington, Fixley Your Name III'
143   fi
144   
145   ##############
146   
147   # variables for perl.
148   
149   define_yeti_variable PERLLIB+="/usr/lib/perl5"
150   if [ "$OS" == "Windows_NT" ]; then
151     define_yeti_variable PERLIO=:perlio
152       # choose perl's IO over the ms-windows version so we can handle file
153       # bytes properly.
154   fi
155   
156   # iterate across our sub-directories and find the perl scripts.
157   # this currently only looks one level down.
158   for i in $FEISTY_MEOW_SCRIPTS/*; do
159     if [ -d "$i" ]; then
160       # check if there is a perl file present; add the folder to PERLLIB if so.
161       ls $i/*.pl &>/dev/null
162       if [ $? -eq 0 ]; then
163         PERLLIB+=":$(dos_to_unix_path $i)"
164       fi
165     fi
166   done
167   #echo PERLLIB is now $PERLLIB
168   
169   ##############
170   
171   # set this so nechung can find its data.
172   define_yeti_variable NECHUNG=$FEISTY_MEOW_DIR/infobase/fortunes.dat
173   
174   # ensure we use the right kind of secure shell.
175 #  define_yeti_variable CVS_RSH=$FEISTY_MEOW_SCRIPTS/security/ssh.sh
176 #  define_yeti_variable GIT_SSH=$FEISTY_MEOW_SCRIPTS/security/ssh.sh
177   
178   # the base checkout list is just to update feisty_meow.  additional folder
179   # names can be added in your customized scripts.  the space at the end of
180   # this variable is important and allows users to extend the list like:
181   #    define_yeti_variable REPOSITORY_DIR+="muppets configs"
182   define_yeti_variable REPOSITORY_LIST="feisty_meow "
183   
184   # initializes the feisty meow build variables, if possible.
185   function initialize_build_variables()
186   {
187     found_build_vars=0
188     # we need to know the feisty meow directory, or we bail.
189     if [ -z "$FEISTY_MEOW_DIR" ]; then return; fi
190     # pick from our expected generator folder, but make sure it's there...
191     buildvars="$FEISTY_MEOW_SCRIPTS/generator/build_variables.sh"
192     if [ -f "$buildvars" ]; then
193       # yep, that one looks good, so pull in the build defs.
194       source "$buildvars" "$buildvars"
195       found_build_vars=1
196     fi
197     # now augment the environment if we found our build variables.
198     if [ $found_build_vars == 1 ]; then
199       # the binary directory contains our collection of handy programs.
200       define_yeti_variable BINDIR=$TARGETS_DIR
201       # add binaries created within build to the path.
202       define_yeti_variable PATH="$(dos_to_unix_path $BINDIR):$PATH"
203       # Shared libraries are located via this variable.
204       define_yeti_variable LD_LIBRARY_PATH="$(dos_to_unix_path $LD_LIBRARY_PATH):$(dos_to_unix_path $BINDIR)"
205     fi
206   }
207   
208   ##############
209   
210   # windoze specific patching up missing things.
211   
212   if [ "$OS" == "Windows_NT" ]; then
213     define_yeti_variable HOSTNAME=$(echo $HOSTNAME | tr A-Z a-z)
214   fi
215   
216   ##############
217   
218   # load in the build environment.
219   initialize_build_variables
220   
221   ##############
222   
223   # add to the PATH variables used for locating applications.  this step is taken after any
224   # potential overrides from the user.
225   define_yeti_variable PATH="$(dos_to_unix_path $FEISTY_MEOW_LOADING_DOCK):$PATH:$(find /usr/local/games -maxdepth 1 -type d -exec echo -n {}: ';' 2>/dev/null)/sbin"
226   
227   ##############
228
229   # set the SHUNIT_DIR so our shunit tests can find the codebase.
230   define_yeti_variable SHUNIT_DIR="$FEISTY_MEOW_SCRIPTS/shunit"
231   
232   ##############
233   
234   if [ ! -z "$SHELL_DEBUG" ]; then echo variables initialization ends....; fi
235 fi
236
237 ##############
238
239 # pull in the custom overrides for feisty_meow scripts.  this is done last,
240 # because we want to set everything up as expected, then let the user
241 # override individual variables and definitions.  we also don't guard this
242 # to avoid running it again, because we don't know what mix of functions and
243 # aliases they want to define in there.
244 for i in $FEISTY_MEOW_LOADING_DOCK/custom/*.sh; do
245   if [ ! -f "$i" ]; then
246     # skip it if it's not real.
247     continue;
248   fi
249   if [ ! -z "$SHELL_DEBUG" ]; then
250     echo "loading customization: $(basename $(dirname $i))/$(basename $i)"
251   fi
252   source "$i"
253 done
254