AMiRo-OS

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

# AMiRo-OS is an operating system designed for the Autonomous Mini Robot       #

# (AMiRo) platform.                                                            #

# Copyright (C) 2016..2017  Thomas Schöpping et al.                            #

#                                                                              #

# 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 3 of the License, or            #

# (at your option) any later version.                                          #

#                                                                              #

# This program is distributed in the hope that it will be useful,              #

# but WITHOUT ANY WARRANTY; without even the implied warranty of               #

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                #

# GNU General Public License for more details.                                 #

#                                                                              #

# You should have received a copy of the GNU General Public License            #

# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #

#                                                                              #

# This research/work was supported by the Cluster of Excellence Cognitive      #

# Interaction Technology 'CITEC' (EXC 277) at Bielefeld University, which is   #

# funded by the German Research Foundation (DFG).                              #

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

#!/bin/bash

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

###   HELPER FUNCTIONS                                                       ###

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

#-------------------------------------------------------------------------------

# toAbsolutePath $1 [$2]

#

# Makes a given path absolute and either echos the result or stores it in the

# specified variable.

# arguments:

#   $1: the path to be converted

#   $2: a variable to store the resulting path [optiional]

function toAbsolutePath {

  # the path that shall be converted if required

  TARGET_PATH=$1

  # store the path where the script was called from

  ORIGIN_PATH="${PWD}/"

  # check, whether the target is a directory or not

  if [ -d $TARGET_PATH ]; then

    cd $TARGET_PATH

    # special case: the target is the root directory

    if [ $TARGET_PATH = "/" ]; then

      ABSOLUTE_PATH="${PWD}"

    else

      ABSOLUTE_PATH="${PWD}/"

    fi

  else

    cd $(dirname $TARGET_PATH)

    ABSOLUTE_PATH="${PWD}/$(basename $TARGET_PATH)"

  fi

  cd $ORIGIN_PATH

  # return the result

  if [ $# -gt 1 ]; then

    eval $2="$ABSOLUTE_PATH"

  else

    echo $ABSOLUTE_PATH

  fi

  # cleanup

  unset TARGET_PATH

  unset ORIGIN_PATH

  unset ABSOLUTE_PATH

}

#-------------------------------------------------------------------------------

#-------------------------------------------------------------------------------

# getRelativePath $1 $2 [$3]

#

# Computes the relative path from one to another location.

# The result is then either stored in a specified variable, or just echoed.

# arguments:

#   $1: the path to start from

#       If this is not a directory, only the path will be used

#   $2: the target location

#   $3: a variable to store the resulting path [optional]

function getRelativePath {

  # make start and target location absolute

  START_PATH=$(toAbsolutePath $1)

  if [ ! -d $START_PATH ]; then

    START_PATH="$(dirname $START_PATH)/"

  fi

  TARGET_PATH=$(toAbsolutePath $2)

  # initialize the common prefix and the relative path from START_PATH to TARGET_PATH

  COMMON_PREFIX=$START_PATH

  RELATIVE_PATH="./"

  # while the common prefix is no substring of the target path

  while [ "${TARGET_PATH#$COMMON_PREFIX}" == "$TARGET_PATH" ]; do

    read

    # reduce the common prefix and record the relative path

    COMMON_PREFIX="$(dirname $COMMON_PREFIX)/"

    RELATIVE_PATH="../$RELATIVE_PATH"

    # special case: if only root is the common prefix, remove the just appended '/'

    if [ $COMMON_PREFIX == "//" ]; then

      COMMON_PREFIX="/"

    fi

  done

  # if the relative path is more than just the current directory, cut off the trailing './'

  if [ ! $RELATIVE_PATH == "./" ]; then

    RELATIVE_PATH=${RELATIVE_PATH::-2}

  fi

  # compute the unique part of the target path

  UNIQUE_POSTFIX=${TARGET_PATH#$COMMON_PREFIX}

  # append the unique postfix to the relative path

  RELATIVE_PATH=$RELATIVE_PATH$UNIQUE_POSTFIX

  # return the result

  if [ $# -gt 2 ]; then

    eval $3="$RELATIVE_PATH"

  else

    echo $RELATIVE_PATH

  fi

  # clean up

  unset START_PATH

  unset TARGET_PATH

  unset COMMON_PREFIX

  unset RELATIVE_PATH

  unset UNIQUE_POSTFIX

}

#-------------------------------------------------------------------------------

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

###   INITIALIZATION                                                        ###

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

# ignore case when comparing strings

shopt -s nocasematch

# detect what exactly should be done

NOINFO_FLAG="NOINFO"

HELP_FLAG="HELP"

CLEAN_FLAG="CLEAN"

WIPE_FLAG="WIPE"

LIGHTRING_FLAG="LR"

POWERMANAGEMENT_FLAG="PM"

DIWHEELDRIVE_FLAG="DWD"

# start with an empty array

ARG_LIST=()

# try to interpret all given arguments

for ARG in "$@"; do

  case $ARG in

    "no_info")

      ARG_LIST+=( "$NOINFO_FLAG" )

      ;;

    "help")

      ARG_LIST+=( "$HELP_FLAG" )

      ;;

    "clean")

      ARG_LIST+=( "$CLEAN_FLAG" )

      ;;

    "wipe")

      ARG_LIST+=( "$WIPE_FLAG" )

      ;;

    "all")

      ARG_LIST+=( "$LIGHTRING_FLAG" "$POWERMANAGEMENT_FLAG" "$DIWHEELDRIVE_FLAG" )

      ;;

    "LightRing"|"LR")

      ARG_LIST+=( "$LIGHTRING_FLAG" )

      ;;

    "PowerManagement"|"PM")

      ARG_LIST+=( "$POWERMANAGEMENT_FLAG" )

      ;;

    "DiWheelDrive"|"DWD")

      ARG_LIST+=( "$DIWHEELDRIVE_FLAG" )

      ;;

  esac

done

# evaluate if a help text shall be printed and which further actions to take

PRINT_INFO=true

PRINT_HELP=false

ACTION_REQUESTED=false

for ARG in ${ARG_LIST[@]}; do

  case $ARG in

    $NOINFO_FLAG)

      PRINT_INFO=false

      ;;

    $HELP_FLAG)

      PRINT_HELP=true

      ;;

    $CLEAN_FLAG|$WIPE_FLAG|$LIGHTRING_FLAG|$POWERMANAGEMENT_FLAG|$DIWHEELDRIVE_FLAG)

      ACTION_REQUESTED=true

      ;;

    *)

      PRINT_HELP=true

      ;;

  esac

done

# print the info prompt

if [[ $PRINT_INFO = true ]]; then

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

  ###   PRINT INFO                                                           ###

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

  printf "######################################################################\n"

  printf "#                                                                    #\n"

  printf "#            Welcome to the AMiRo-BLT QtCreator IDE setup            #\n"

  printf "#                                                                    #\n"

  printf "######################################################################\n"

  printf "#                                                                    #\n"

  printf "# Copyright (c) 2016..2017  Thomas Schöpping                         #\n"

  printf "#                                                                    #\n"

  printf "# This is free software; see the source for copying conditions.      #\n"

  printf "# There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR  #\n"

  printf "# A PARTICULAR PURPOSE. The development of this software was         #\n"

  printf "# supported by the Excellence Cluster EXC 227 Cognitive Interaction  #\n"

  printf "# Technology. The Excellence Cluster EXC 227 is a grant of the       #\n"

  printf "# Deutsche Forschungsgemeinschaft (DFG) in the context of the German #\n"

  printf "# Excellence Initiative.                                             #\n"

  printf "#                                                                    #\n"

  printf "######################################################################\n"

  printf "\n"

fi

# print setup header

printf "QtCreator projects setup\n"

printf "========================\n"

printf "\n"

# print the help text

if [[ ${#ARG_LIST[@]} == 0 ||

      (${#ARG_LIST[@]} == 1 && ${ARG_LIST[0]} == "$NOINFO_FLAG") ||

      $PRINT_HELP = true ]]; then

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

  ###   PRINT HELP                                                           ###

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

  printf "The following commands are available:                                 \n"

  printf "                                                                      \n"

  printf "  help            - Prints this help text.                            \n"

  printf "  clean           - Deletes all files created by this script.         \n"

  printf "  wipe            - Deletes the .user files, created by QtCreator.    \n"

  printf "  LightRing       - Creates a project for the LightRing module.       \n"

  printf "  PowerManagement - Creates a project for the PowerManagement module. \n"

  printf "  DiWheelDrive    - Creates a project for the DiWheelDrive module.    \n"

  printf "  all             - Creates all three projects.                       \n"

  printf "                                                                      \n"

  printf "Any of these commands can be combined, e.g.                           \n"

  printf "  $> ./setup.sh PowerManagement DiWheelDrive                          \n"

  printf "will create two projects.                                             \n"

  printf "\n"

  printf "Note that this script does not create a project for the SerialBoot    \n"

  printf "application. Since it uses CMAKE, QtCreator can import it directly.   \n"

fi

# execute action

if [ $ACTION_REQUESTED = true ]; then

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

  ###   CONFIGURATION                                                        ###

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

  # the current user dir

  USER_DIR="${PWD}/"

  # the directory containing this script file

  toAbsolutePath $(dirname ${BASH_SOURCE[0]}) SCRIPT_DIR

  # the root directory of the project

  toAbsolutePath ${SCRIPT_DIR}../.. PROJECT_ROOT_PATH

  # the relative path where all project files shall be generated

  read -p "path where to create/delete the project files: " -i "$PROJECT_ROOT_PATH" -e QTCREATOR_FILES_PATH

  toAbsolutePath $QTCREATOR_FILES_PATH QTCREATOR_FILES_PATH

  # the include path for GCC specific headers

  ARM_NONE_EABI_GCC_BIN=$(which arm-none-eabi-gcc)

  while [ -L $ARM_NONE_EABI_GCC_BIN ]; do

    ARM_NONE_EABI_GCC_BIN=$(readlink $ARM_NONE_EABI_GCC_BIN)

  done

  toAbsolutePath "$(dirname $ARM_NONE_EABI_GCC_BIN)/../arm-none-eabi/include/" ARM_NONE_EABI_GCC_INCLUDE_PATH

  # a common path for all projects

  COMMON_SOURCE_INCLUDE_PATH=${PROJECT_ROOT_PATH}Target/Source

  # the paths to the individual projects

  POWERMANAGEMENT_PROJECT_ROOT_PATH=${PROJECT_ROOT_PATH}Target/Demo/ARMCM4_STM32F405_Power_Management_GCC/Boot

  DIWHEELDRIVE_PROJECT_ROOT_PATH=${PROJECT_ROOT_PATH}Target/Demo/ARMCM3_STM32F103_DiWheelDrive_GCC/Boot

  LIGHTRING_PROJECT_ROOT_PATH=${PROJECT_ROOT_PATH}Target/Demo/ARMCM3_STM32F103_LightRing_GCC/Boot

  # the prefix names for the projects to be generated

  LIGHTRING_PROJECT_PREFIX="LightRing"

  POWERMANAGEMENT_PROJECT_PREFIX="PowerManagement"

  DIWHEELDRIVE_PROJECT_PREFIX="DiWheelDrive"

  printf "\n"

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

  ###   SETUP                                                                ###

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

  # move to the project root directory

  cd $QTCREATOR_FILES_PATH

  for ARG in ${ARG_LIST[@]}; do

    case $ARG in

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

      ###   CLEAN STEP                                                       ###

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

      $CLEAN_FLAG)

        printf "removing project files..."

        # remove all files

        rm ${LIGHTRING_PROJECT_PREFIX}.includes 2> /dev/null

        rm ${LIGHTRING_PROJECT_PREFIX}.files 2> /dev/null

        rm ${LIGHTRING_PROJECT_PREFIX}.config 2> /dev/null

        rm ${LIGHTRING_PROJECT_PREFIX}.creator 2> /dev/null

        rm ${POWERMANAGEMENT_PROJECT_PREFIX}.includes 2> /dev/null

        rm ${POWERMANAGEMENT_PROJECT_PREFIX}.files 2> /dev/null

        rm ${POWERMANAGEMENT_PROJECT_PREFIX}.config 2> /dev/null

        rm ${POWERMANAGEMENT_PROJECT_PREFIX}.creator 2> /dev/null

        rm ${DIWHEELDRIVE_PROJECT_PREFIX}.includes 2> /dev/null

        rm ${DIWHEELDRIVE_PROJECT_PREFIX}.files 2> /dev/null

        rm ${DIWHEELDRIVE_PROJECT_PREFIX}.config 2> /dev/null

        rm ${DIWHEELDRIVE_PROJECT_PREFIX}.creator 2> /dev/null

        printf "\tdone\n"

        ;;

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

      ###   WIPE STEP                                                        ###

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

      $WIPE_FLAG)

        printf "removing .user project files..."

        # remove all user files

        rm ${POWERMANAGEMENT_PROJECT_PREFIX}.creator.user 2> /dev/null

        rm ${DIWHEELDRIVE_PROJECT_PREFIX}.creator.user 2> /dev/null

        rm ${LIGHTRING_PROJECT_PREFIX}.creator.user 2> /dev/null

        printf "\tdone\n"

        ;;

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

      ###   LIGHTRING SETUP                                                  ###

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

      $LIGHTRING_FLAG)

        printf "creating project files for ${LIGHTRING_PROJECT_PREFIX} (STM32F103RET6)..."

        # generate a file that contains all subdirectories as includes (but ignore hidden and documentation directories)

        find $ARM_NONE_EABI_GCC_INCLUDE_PATH -type d > ${LIGHTRING_PROJECT_PREFIX}.includes

        find $COMMON_SOURCE_INCLUDE_PATH -type d | grep -v "ARMCM4_STM32" >> ${LIGHTRING_PROJECT_PREFIX}.includes

        find $LIGHTRING_PROJECT_ROOT_PATH -type d | grep -v "uip\|fatfs\|ethernetlib\|cmd\|ide" >> ${LIGHTRING_PROJECT_PREFIX}.includes

        # generate a file that specifies all files

        echo -n "" > ${LIGHTRING_PROJECT_PREFIX}.files

        for path in `cat ${LIGHTRING_PROJECT_PREFIX}.includes`; do

          find $path -maxdepth 1 -type f \( ! -iname ".*" \) | grep -v "/arm-none-eabi/" | grep -E ".*(\.h|\.c|\.x)$" >> ${LIGHTRING_PROJECT_PREFIX}.files

        done

        # generate a default project configuration file if none exists so far

        if [ ! -f ${LIGHTRING_PROJECT_PREFIX}.config ]; then

          echo -e "// Add predefined macros for your project here. For example:\n// #define YOUR_CONFIGURATION belongs here\n" > ${LIGHTRING_PROJECT_PREFIX}.config

        fi

        # generate a default .creator file if none exists so far

        if [ ! -f ${LIGHTRING_PROJECT_PREFIX}.creator ]; then

          echo -e "[general]\n" > ${LIGHTRING_PROJECT_PREFIX}.creator

        fi

        printf "\tdone\n"

        ;;

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

      ###   POWERMANAGEMENT SETUP                                            ###

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

      $POWERMANAGEMENT_FLAG)

        printf "creating project files for ${POWERMANAGEMENT_PROJECT_PREFIX} (STM32F405RGT6)..."

        # generate a file that contains all subdirectories as includes (but ignore hidden and documentation directories)

        find $ARM_NONE_EABI_GCC_INCLUDE_PATH -type d > ${POWERMANAGEMENT_PROJECT_PREFIX}.includes

        find $COMMON_SOURCE_INCLUDE_PATH -type d | grep -v "ARMCM3_STM32" >> ${POWERMANAGEMENT_PROJECT_PREFIX}.includes

        find $POWERMANAGEMENT_PROJECT_ROOT_PATH -type d | grep -v "uip\|fatfs\|ethernetlib\|cmd\|ide" >> ${POWERMANAGEMENT_PROJECT_PREFIX}.includes

        # generate a file that specifies all files

        echo -n "" > ${POWERMANAGEMENT_PROJECT_PREFIX}.files

        for path in `cat ${POWERMANAGEMENT_PROJECT_PREFIX}.includes`; do

          find $path -maxdepth 1 -type f \( ! -iname ".*" \) | grep -v "/arm-none-eabi/" | grep -E ".*(\.h|\.c|\.x)$" >> ${POWERMANAGEMENT_PROJECT_PREFIX}.files

        done

        # generate a default project configuration file if none exists so far

        if [ ! -f ${POWERMANAGEMENT_PROJECT_PREFIX}.config ]; then

          echo -e "// Add predefined macros for your project here. For example:\n// #define YOUR_CONFIGURATION belongs here\n" > ${POWERMANAGEMENT_PROJECT_PREFIX}.config

        fi

        # generate a default .creator file if none exists so far

        if [ ! -f ${POWERMANAGEMENT_PROJECT_PREFIX}.creator ]; then

          echo -e "[general]\n" > ${POWERMANAGEMENT_PROJECT_PREFIX}.creator

        fi

        printf "\tdone\n"

        ;;

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

      ###   DIWHEELDRIVE SETUP                                               ###

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

      $DIWHEELDRIVE_FLAG)

        printf "creating project files for ${DIWHEELDRIVE_PROJECT_PREFIX} (STM32F103RET6)..."

        # generate a file that contains all subdirectories as includes (but ignore hidden and documentation directories)

        find $ARM_NONE_EABI_GCC_INCLUDE_PATH -type d > ${DIWHEELDRIVE_PROJECT_PREFIX}.includes

        find $COMMON_SOURCE_INCLUDE_PATH -type d | grep -v "ARMCM4_STM32" >> ${DIWHEELDRIVE_PROJECT_PREFIX}.includes

        find $DIWHEELDRIVE_PROJECT_ROOT_PATH -type d | grep -v "uip\|fatfs\|ethernetlib\|cmd\|ide" >> ${DIWHEELDRIVE_PROJECT_PREFIX}.includes

        # generate a file that specifies all files

        echo -n "" > ${DIWHEELDRIVE_PROJECT_PREFIX}.files

        for path in `cat ${DIWHEELDRIVE_PROJECT_PREFIX}.includes`; do

          find $path -maxdepth 1 -type f \( ! -iname ".*" \) | grep -v "/arm-none-eabi/" | grep -E ".*(\.h|\.c|\.x)$" >> ${DIWHEELDRIVE_PROJECT_PREFIX}.files

        done

        # generate a default project configuration file if none exists so far

        if [ ! -f ${DIWHEELDRIVE_PROJECT_PREFIX}.config ]; then

          echo -e "// Add predefined macros for your project here. For example:\n// #define YOUR_CONFIGURATION belongs here\n" > ${DIWHEELDRIVE_PROJECT_PREFIX}.config

        fi

        # generate a default .creator file if none exists so far

        if [ ! -f ${DIWHEELDRIVE_PROJECT_PREFIX}.creator ]; then

          echo -e "[general]\n" > ${DIWHEELDRIVE_PROJECT_PREFIX}.creator

        fi

        printf "\tdone\n"

        ;;

    esac

  done

fi

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

###   OUTRO                                                                  ###

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