[feisty_meow.git] / scripts / generator / build_variables.sh

#!/bin/bash

##############
#
#  Name   : build variable calculator
#  Author : Chris Koeritz
#
#  Purpose:
#
#    This script sets up all the variables needed by the HOOPLE system for
#  building the source code.  It can either be run as a bash script directly
#  like so:
#
#      bash $FEISTY_MEOW_APEX/scripts/generator/build_variables.sh
#
#  which will establish a new shell containing all the variables, or you can
#  'source' the script like so:
#
#      build_vars=$FEISTY_MEOW_APEX/scripts/generator/build_variables.sh
#      source $build_vars $build_vars
#
#  to set all of the variables in your current shell.  The full path is
#  necessary in these commands to allow the script to easily find itself.
#  The 'source' version needs to be fed the actual path to the script
#  because bash 'source' commands cause the first parameter (called $0) to
#  be set to just the path to bash itself.
#
##############
# Copyright (c) 2004-$now By Author.  This program is free software; you can
# redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation; either version 2 of
# the License or (at your option) any later version.  This is online at:
#     http://www.fsf.org/copyleft/gpl.html
# Please send any updates to: fred@gruntose.com
##############

# here is where we compute the locations for the build's pieces, based on
# where this script is located.  we currently assume that the build scripts
# like this one are at the same height in the hierarchy as the clam scripts
# that are used in the bootstrapping process.

# get the most important bits first; the directory this script lives in and
# the script's name.
PARM_0="$0"
PARM_1="$1"

##############

# helpful build function zone.

source "$FEISTY_MEOW_SCRIPTS/core/functions.sh"

##############

# outer check on whether this already was run or not.
if [ -z "$BUILD_VARS_LOADED" ]; then

# perform some calculations to get the right paths from our parameters.
if [ ! -z "$PARM_1" ]; then
  # use the first real parameter since this is probably the 'source' version.
  export BUILD_SCRIPTS_PATH="$(dirname "$PARM_1")"
  THIS_TOOL_NAME="$(basename "$PARM_1")"
else
  # use the zeroth parameter, since we know nothing more about our name.
  export BUILD_SCRIPTS_PATH="$(dirname "$PARM_0")"
  THIS_TOOL_NAME="$(basename "$PARM_0")"
fi
BUILD_SCRIPTS_PATH="$(cd $(echo $BUILD_SCRIPTS_PATH | tr '\\\\' '/' ); \pwd)"

# figure out the other paths based on where we found this script.
export BUILDING_HIERARCHY="$(echo "$BUILD_SCRIPTS_PATH" | sed -e 's/\(.*\)\/[^\/]*/\1/')"
export CLAM_SCRIPTS="$(cd $BUILD_SCRIPTS_PATH/../clam ; \pwd)"
# synonym to make other builds happy.
export BUILDER_PATH="$BUILDING_HIERARCHY"

# set some clam parameters for compilation.  if the script can't guess the
# right configuration, then you will need to set them in the last 'else'
# below.
if [ ! -z "$IS_UNIX" ]; then export OPERATING_SYSTEM=UNIX;
elif [ ! -z "$IS_DOS" ]; then export OPERATING_SYSTEM=WIN32;
else
  # the system is unknown, so we give up on guessing.
  export OPERATING_SYSTEM=unknown
fi
if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
  echo "[OS is \"$OPERATING_SYSTEM\"]"
fi

if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
  echo "[FEISTY_MEOW_APEX is $FEISTY_MEOW_APEX]"
fi

# set some extra variables that clam uses.

# CLAM_ON_UNIX or CLAM_ON_DOS might get defined here.
# we also can set OS_SUBCLASS if we detect darwin.
if [ $OPERATING_SYSTEM == UNIX ]; then
  export CLAM_ON_UNIX=$(uname)
  if [[ $CLAM_ON_UNIX =~ .*[Dd]arwin.* ]]; then
    # pick the subclass now that we know this is darwin.
    export CLAM_OS_SUBCLASS=darwin
  fi
elif [ $OPERATING_SYSTEM == WIN32 ]; then
  export CLAM_ON_DOS=$(uname)
else
  echo "Unknown operating system--clam will not build well here."
fi

# CLAM_BASE_CPU is a flag that distinguishes the type of processor, if necessary.
export CLAM_BASE_CPU="$(machine 2>/dev/null || arch 2>/dev/null || uname -m 2>/dev/null || echo i686)"

# "FEISTY_MEOW_CPP_HEADERS" are folders where our C and C++ header files can be found.
# we'll compute the set of folders as best we can below.
if [ -d "$FEISTY_MEOW_APEX/nucleus" ]; then
  # just assumes we're at home and know our header locations under the feisty meow hierarchy.
  export LOCUS_LIBRARY_HEADERS="$FEISTY_MEOW_APEX/nucleus $FEISTY_MEOW_APEX/octopi $FEISTY_MEOW_APEX/graphiq"
else
  export LOCUS_LIBRARY_HEADERS=
fi 
   ####blech!  maybe not needed now?  was involved above.  | tr "\\\\" / | sed -e "s/\([a-zA-Z]\):\/\([^ ]*\)/\/cygdrive\/\1\/\2/g" ')
export FEISTY_MEOW_CPP_HEADERS=$(find $LOCUS_LIBRARY_HEADERS -mindepth 1 -maxdepth 1 -type d | grep -v "\.settings" )

# the root name of the version file.  This is currently irrelevant on
# non-windoze platforms.
export CLAM_VERSION_RC_ROOT=$(bash $CLAM_SCRIPTS/cpp/rc_name.sh)

# CLAM_COMPILER is the C/C++ compiler application that builds our code.
# The variable is mainly used within CLAM itself for determining the proper
# compiler flags.
export CLAM_COMPILER
if [ "$OPERATING_SYSTEM" == UNIX ]; then
  if [ "$CLAM_OS_SUBCLASS" == darwin ]; then
    CLAM_COMPILER=GNU_DARWIN
  else
    CLAM_COMPILER=GNU_LINUX
  fi
elif [ "$OPERATING_SYSTEM" == WIN32 ]; then
  CLAM_COMPILER=GNU_WINDOWS
fi
if [ -z "$CLAM_COMPILER" ]; then
  # if we get into this case, we have no idea how to set the default compiler.
  # so... pick a fun default.
  CLAM_COMPILER=GNU_LINUX
fi

# "CLAM_COMPILER_ROOT_DIR" is the top-level for the C++ compiler location.
# it is generally the top of the OS, although some variants may need this
# modified (e.g., gnu arm linux, but we haven't built on that in a bit).
export CLAM_COMPILER_ROOT_DIR="/"

# CLAM_COMPILER_VERSION specifies the version of the particular compiler we're using.
# this is sometimes needed to distinguish how the code is built or where headers/libraries are found.
export CLAM_COMPILER_VERSION=$(bash $CLAM_SCRIPTS/cpp/get_version.sh $CLAM_COMPILER $CLAM_COMPILER_ROOT_DIR )

# new BUILD_TOP variable points at the utter top-most level of any files
# in the building hierarchy.
export BUILD_TOP="$FEISTY_MEOW_APEX"

# the production directory is the location for all the scripts and setup
# code needed to produce the executables for feisty meow.
export PRODUCTION_STORE="$BUILD_TOP/production"

## set up the top-level for all build creations and logs and such.
#export FEISTY_MEOW_GENERATED_STORE="$TMP/generated-feisty_meow"
#if [ ! -d "$FEISTY_MEOW_GENERATED_STORE" ]; then
#  mkdir -p "$FEISTY_MEOW_GENERATED_STORE"
#fi
## set up our effluent outsourcing valves.
#export TEMPORARIES_PILE="$FEISTY_MEOW_GENERATED_STORE/temporaries"
#if [ ! -d "$TEMPORARIES_PILE" ]; then
#  mkdir -p "$TEMPORARIES_PILE"
#fi

# this variable points at a folder where we store the generated products of
# the build, such as the binaries and installer packages.
export RUNTIME_PATH="$FEISTY_MEOW_GENERATED_STORE/runtime"
if [ ! -d "$RUNTIME_PATH" ]; then
  mkdir -p "$RUNTIME_PATH"
fi

# we define a log file storage area that can be relied on by the build.
export FEISTY_MEOW_LOGS="$FEISTY_MEOW_GENERATED_STORE/logs"
if [ ! -d "$FEISTY_MEOW_LOGS" ]; then
  mkdir -p "$FEISTY_MEOW_LOGS"
fi

##############

# debugging area where we say what we think we know.

if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
  echo scripts: $BUILD_SCRIPTS_PATH
  echo build tools hier: $BUILDING_HIERARCHY
  echo this tool: $THIS_TOOL_NAME
  echo repository: $FEISTY_MEOW_APEX
  echo clam: $CLAM_SCRIPTS
fi

##############

# test out our computed variables to make sure they look right.
pushd / &>/dev/null # jump to the root so relative paths are caught.

# flag for whether any checks have failed.
got_bad=

# first the scripts directory; do we find this script there?
if [ ! -f "$BUILD_SCRIPTS_PATH/$THIS_TOOL_NAME" ]; then
  echo "This script cannot locate the proper build folders.  The crucial path"
  echo "variable seems to be '$BUILD_SCRIPTS_PATH', which"
  echo "does not seem to contain '$THIS_TOOL_NAME' (this"
  echo "script's apparent name)."
  got_bad=1
fi

# next the clam directory; is the main variables file present there?
if [ -z "$got_bad" -a ! -f "$CLAM_SCRIPTS/variables.def" ]; then
  echo "The clam directory could not be located under our build tools hierarchy."
  echo "Please examine the configuration and make sure that this script is in a"
  echo "directory that resides at the same height as the 'clam' directory."
  got_bad=1
fi

# now compute some more paths with a bit of "heuristics" for where we can
# find the source code.
export TOOL_SOURCES="$FEISTY_MEOW_APEX/nucleus/tools"
if [ -z "$got_bad" -a ! -d "$TOOL_SOURCES/dependency_tool" -o ! -d "$TOOL_SOURCES/clam_tools" ]; then
  echo "This script cannot locate the tool source code folder.  This is where the"
  echo "dependency_tool and clam_tools folders are expected to be."
  got_bad=1
fi

############################
  
# we only run the rest of the script if we know we didn't have some kind of
# bad thing happen earlier.
if [ -z "$got_bad" ]; then

  # where we store the binaries used for building the rest of the code base.
  export CLAM_BINARIES="$RUNTIME_PATH/clam_bin"
    # the final destination for the new binaries which provide the
    # build with all the applications it needs to get going.
  export TARGETS_STORE="$RUNTIME_PATH/binaries"
    # targets directory is meaningful to clam, which will use it for output.
  export INTERMEDIATE_STORE="$TARGETS_STORE"
    # where we are building the applications before they get promoted.

#hmmm: could allow override on this if already set.
  # calculate which build ini file to use.
  export BUILD_PARAMETER_FILE="$PRODUCTION_STORE/feisty_meow_config.ini"
  if [ ! -f "$BUILD_PARAMETER_FILE" ]; then
    echo "Cannot find a useful build configuration file."
  fi
  
  # pick the executable's file ending based on the platform.
  if [ "$OPERATING_SYSTEM" == "UNIX" ]; then export EXE_ENDING=;
  elif [ "$OPERATING_SYSTEM" == "WIN32" ]; then export EXE_ENDING=.exe;
  else
    echo "The OPERATING_SYSTEM variable is unset or unknown.  Bailing out."
  fi
  
  # we should have established our internal variables now, so let's try
  # using them.
  export PATH=$(dos_to_unix_path $CLAM_BINARIES):$PATH
  
  # load up the helper variables for visual studio on winders.
  if [ "$OPERATING_SYSTEM" == "WIN32" ]; then
    # moved back to the good path of using gcc, not visual studio.
#what vars needed?
#trying just unixy ones, since we're doing cygwin on doze.
export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$TARGETS_STORE"
  else
    export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$TARGETS_STORE"
  fi
  
  popd &>/dev/null # checking is over, jump back to the starting point.
  
  ############################
  
  # at this point, all the build related variables should be valid.
  
  if [ -z "$INCLUDED_FROM_BOOTSTRAP" \
      -a -z "$PARM_1" ]; then
    # we are running as a stand-alone script, so we stay resident with our
    # current set of variables.
    bash
  fi

  # sentinel that tells us this script was pulled in.
  export BUILD_VARS_LOADED=true

fi

fi  # outer wrapper for already ran build vars check.

##############

# hook clam into the compilation system.
# this always needs to be defined since functions aren't exported.
function make()
{
  /usr/bin/make -I "$CLAM_SCRIPTS" $*
}