AMiRo-OS

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

# AMiRo-Apps is a collection of applications and configurations for the        #

# Autonomous Mini Robot (AMiRo).                                               #

# Copyright (C) 2018..2020  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

# load library

source "$(dirname ${BASH_SOURCE[0]})/../../bash/setuplib.sh"

### print welcome text #########################################################

# Prints a welcome message to standard out.

#

# usage:      printWelcomeText

# arguments:  n/a

# return:     n/a

#

function printWelcomeText {

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

  printf "#                                                                    #\n"

  printf "#                  Welcome to the QtCreator setup!                   #\n"

  printf "#                                                                    #\n"

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

  printf "#                                                                    #\n"

  printf "# Copyright (c) 2018..2020  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"

}

### print help #################################################################

# Prints a help text to standard out.

#

# usage:      printHelp

# arguments:  n/a

# return:     n/a

#

function printHelp {

  printInfo "printing help text\n"

  printf "usage:    $(basename ${BASH_SOURCE[0]}) [-h|--help] [-c|--clean] [-w|--wipe] [-q|--quit] [--log=<file>]\n"

  printf "\n"

  printf "options:  -h, --help\n"

  printf "              Print this help text.\n"

  printf "          -i, --initialize\n"

  printf "              Initialize project files.\n"

  printf "          -c, --clean\n"

  printf "              Delete project files.\n"

  printf "          -w, --wipe\n"

  printf "              Delete project and .user files.\n"

  printf "          -q, --quit\n"

  printf "              Quit the script.\n"

  printf "          --log=<file>\n"

  printf "              Specify a log file.\n"

}

### read directory where to create/delete projects #############################

# Read the directory where to create/delete project files from user.

#

# usage:      getProjectDir <pathvar>

# arguments:  <pathvar>

#                 Variable to store the selected path to.

# return:     n/a

#

function getProjectDir {

  printLog "reading path for project files from user...\n"

  local amiroappsdir=$(realpath $(dirname $(realpath ${BASH_SOURCE[0]}))/../../../)

  local input=""

  read -p "Path where to create/delete project files: " -i $amiroappsdir -e input

  printLog "user selected path $(realpath $input)\n"

  eval $1="$(realpath $input)"

}

### retrieves the ARM-NONE-EABI-GCC include directory ##########################

# Retrieves the include directory of the currently set arm-none-eabi-gcc.

#

# usage:      retrieveGccIncludeDir <path>

# arguments:  <path>

#                 Variable to store the path to.

# return:    0

#                 No error or warning occurred.

#            -1

#                 Error: Command 'arm-none-eabi-gcc' not found.

#

function retrieveGccIncludeDir {

  # retrieve binary path or link

  local binpath=$(which arm-none-eabi-gcc)

  if [ -z "$binpath" ]; then

    printError "command 'arm-none-eabi-gcc' not found\n"

    return -1

  else 

    # traverse any links

    while [ -L "$binpath" ]; do

      binpath=$(readlink $binpath)

    done

    printInfo "gcc-arm-none-eabi detected: $binpath\n"

    # return include path

    eval $1=$(realpath $(dirname ${binpath})/../arm-none-eabi/include/)

    return 0

  fi

}

### intialize project files ####################################################

# Initailizes all project files.

#

# usage:      initProject [-p|--path=<path>] [--gcc=<path>] [-o|--out=<var>] [--gccout=<var>]

# arguments:  -p, --path <path>

#                 Path where to create the project files.

#             --gcc=<path>

#                 Path to the GCC include directory.

#             -o, --out <var>

#                 Variable to store the path to.

#             --gccout=<var>

#                 Variable to store the path to the GCC include directory to.

# return:     0

#                 No error or warning occurred.

#

function initProject {

  local userdir=$(pwd)

  local projectdir=""

  local gccincludedir=""

  local outvar=""

  local gccoutvar=""

  # parse arguments

  local otherargs=()

  while [ $# -gt 0 ]; do

    if ( parseIsOption $1 ); then

      case "$1" in

        -p=*|--path=*)

          projectdir=$(realpath "${1#*=}"); shift 1;;

        -p|--path)

          projectdir=$(realpath "$2"); shift 2;;

        --gcc=*)

          gccincludedir=$(realpath "${1#*=}"); shift 1;;

        --gcc)

          gccincludedir=$(realpath "$2"); shift 2;;

        -o=*|--out=*)

          outvar=${1#*=}; shift 1;;

        -o|--out)

          outvar=$2; shift 2;;

        --gccout=*)

          gccoutvar=$(realpath "${1#*=}"); shift 1;;

        --gccout)

          gccoutvar=$(realpath "$2"); shift 2;;

        *)

          printError "invalid option: $1\n"; shift 1;;

      esac

    else

      otherargs+=("$1")

      shift 1

    fi

  done

  # print message

  printInfo "creating QtCreator project files...\n"

  # read absolute project directory if required

  if [ -z "$projectdir" ]; then

    getProjectDir projectdir

  fi

  # retrieve absolute GCC include dir

  if [ -z "$gccincludedir" ]; then

    retrieveGccIncludeDir gccincludedir

  fi

  # move to project directory

  cd $projectdir

  # AMiRo-OS, ChibiOS, AMiRo-BLT, AMiRo-LLD and uRtWare relative root directories

  local amiroappsrootdir=$(realpath --relative-base=$projectdir $(dirname ${BASH_SOURCE[0]})/../../..)

  local amiroosrootdir=$(realpath --relative-base=$projectdir ${amiroappsrootdir}/os/AMiRo-OS/os)

  local chibiosrootdir=$(realpath --relative-base=$projectdir ${amiroosrootdir}/../kernel/ChibiOS)

  local amirobltrootdir=$(realpath --relative-base=$projectdir ${amiroosrootdir}/../bootloader/AMiRo-BLT)

  local amirolldrootdir=$(realpath --relative-base=$projectdir ${amiroosrootdir}/../periphery-lld/AMiRo-LLD)

  local urtwarerootdir=$(realpath --relative-base=$projectdir $(dirname ${BASH_SOURCE[0]})/../../../middleware/uRtWare/)

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

  find $gccincludedir -type d > ${projectdir}/AMiRo-Apps.includes

  find $amiroappsrootdir -type d | grep -E "/(apps|configurations)/.+" >> ${projectdir}/AMiRo-Apps.includes

  find $amiroosrootdir -type d | grep -v "/doc\|/build\|/.dep\|/hal\|/ports" >> ${projectdir}/AMiRo-Apps.includes

  find $amiroosrootdir -type d | grep -E "/os/hal/(include|src)" >> ${projectdir}/AMiRo-Apps.includes

  find $chibiosrootdir -type d | grep -E "/os/common/abstractions/cmsis_os$" >> ${projectdir}/AMiRo-Apps.includes

  find $chibiosrootdir -type d | grep -E "/os/common/oslib/(include|src)$" >> ${projectdir}/AMiRo-Apps.includes

  find $chibiosrootdir -type d | grep -E "/os/hal/(include|src)$" >> ${projectdir}/AMiRo-Apps.includes

  find $chibiosrootdir -type d | grep -E "/os/hal/lib/streams" >> ${projectdir}/AMiRo-Apps.includes

  find $chibiosrootdir -type d | grep -E "/os/hal/osal/(lib|rt)$" >> ${projectdir}/AMiRo-Apps.includes

  find $chibiosrootdir -type d | grep -E "/os/license$" >> ${projectdir}/AMiRo-Apps.includes

  find $chibiosrootdir -type d | grep -E "/os/rt/(include|src)$" >> ${projectdir}/AMiRo-Apps.includes

  find $chibiosrootdir -type d | grep -E "/os/various/(shell|cpp_wrappers)" >> ${projectdir}/AMiRo-Apps.includes

  find $chibiosrootdir -type d | grep -E "/test/(lib|rt/source/test)$" >> ${projectdir}/AMiRo-Apps.includes

  find $amirobltrootdir -type d | grep -E "/Target/Source/AMiRo$" >> ${projectdir}/AMiRo-Apps.includes

  echo "$(realpath --relative-base=$projectdir ${amirolldrootdir}/..)" >> ${projectdir}/AMiRo-Apps.includes

  find $amirolldrootdir -type d | grep -v "/doc" >> ${projectdir}/AMiRo-Apps.includes

  find $urtwarerootdir -type d | grep -v "/doc" >> ${projectdir}/AMiRo-Apps.includes

  # generate a file that specifies all files

  echo -n "" > ${projectdir}/AMiRo-Apps.files

  for path in `cat ${projectdir}/AMiRo-Apps.includes`; do

    find $path -maxdepth 1 -type f \( ! -iname ".*" \) |

      grep -Ev "^.*/arm-none-eabi/.*$" |

      grep -E  "^.*(\.s|\.S|\.h|\.c|\.hpp|\.cpp|\.tpp|\.ld)$" |

      grep -Ev "^${amirobltrootdir}/Target/Source/AMiRo/helper.*$" >> ${projectdir}/AMiRo-Apps.files;

  done

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

  if [ ! -f ${projectdir}/AMiRo-Apps.config ]; then

    echo "// Add predefined macros for your project here. For example:" > ${projectdir}/AMiRo-Apps.config

    echo "// #define YOUR_CONFIGURATION belongs here" >> ${projectdir}/AMiRo-Apps.config

  fi

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

  if [ ! -f ${projectdir}/AMiRo-Apps}.creator ]; then

    echo "[general]" > ${projectdir}/AMiRo-Apps.creator

  fi

  # go back to user directory

  cd $userdir

  # fill the output variables

  if [ ! -z "$outvar" ]; then

    eval $outvar="$projectdir"

  fi

  if [ ! -z "$gccoutvar" ]; then

    eval $gccoutvar="$gccincludedir"

  fi

  return 0

}

### delete project files #######################################################

# Deletes all project files and optionally .user files, too.

#

# usage:      deleteProject [-p|--path=<path>] [-o|--out=<var>] [-w|-wipe]

# arguments:  -p, --path <path>

#                 Path where to delete the project files.

#             -o, --out <var>

#                 Variable to store the path to.

#             -w, --wipe

#                 Delete .user files as well.

# return:

#  -  0: no error

#  -  1: warning: function aborted by user

#  - -1: error: unexpected user input

function deleteProject {

  local projectdir=""

  local outvar=""

  local wipe=false

  # parse arguments

  local otherargs=()

  while [ $# -gt 0 ]; do

    if ( parseIsOption $1 ); then

      case "$1" in

        -p=*|--path=*)

          projectdir=$(realpath "${1#*=}"); shift 1;;

        -p|--path)

          projectdir=$(realpath "$2"); shift 2;;

        -o=*|--out=*)

          outvar=${1#*=}; shift 1;;

        -o|--out)

          outvar=$2; shift 2;;

        -w|--wipe)

          wipe=true; shift 1;;

        *)

          printError "invalid option: $1\n"; shift 1;;

      esac

    else

      otherargs+=("$1")

      shift 1

    fi

  done

  # print message

  if [ $wipe != true ]; then

    printInfo "deleting all QtCreator project files (*.includes, *.files, *.config, and *.creator)\n"

  else

    printInfo "deleting all QtCreator project files (*.includes, *.files, *.config, *.creator, and *.user)\n"

  fi

  # read project directory if required

  if [ -z "$projectdir" ]; then

    getProjectDir projectdir

  fi

  # remove all project files

  rm ${projectdir}/AMiRo-Apps.includes 2>&1 | tee -a $LOG_FILE

  rm ${projectdir}/AMiRo-Apps.files 2>&1 | tee -a $LOG_FILE

  rm ${projectdir}/AMiRo-Apps.config 2>&1 | tee -a $LOG_FILE

  rm ${projectdir}/AMiRo-Apps.creator 2>&1 | tee -a $LOG_FILE

  if [ $wipe == true ]; then

    rm ${projectdir}/AMiRo-Apps.creator.user 2>&1 | tee -a $LOG_FILE

  fi

  # store the path to the output variable, if required

  if [ ! -z "$outvar" ]; then

    eval $outvar="$projectdir"

  fi

  return 0

}

### main function of this script ###############################################

# Creates, deletes and wipes QtCreator project files for the three AMiRo base modules.

#

# usage:      see function printHelp

# arguments:  see function printHelp

# return:     0

#                 No error or warning ocurred.

#

function main {

# print welcome/info text if not suppressed

  if [[ $@ != *"--noinfo"* ]]; then

    printWelcomeText

  else

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

  fi

  printf "\n"

  # if --help or -h was specified, print the help text and exit

  if [[ $@ == *"--help"* || $@ == *"-h"* ]]; then

    printHelp

    printf "\n"

    quitScript

  fi

  # set log file if specified

  if [[ $@ == *"--log"* ]] || [[ $@ == *"--LOG"* ]]; then

    # get the parameter (file name)

    local cmdidx=1

    while [[ ! "${!cmdidx}" = "--log"* ]] && [[ ! "${!cmdidx}" = "--LOG"* ]]; do

      cmdidx=$[cmdidx + 1]

    done

    local cmd="${!cmdidx}"

    local logfile=""

    if [[ "$cmd" = "--log="* ]] || [[ "$cmd" = "--LOG="* ]]; then

      logfile=${cmd#*=}

    else

      local filenameidx=$((cmdidx + 1))

      logfile="${!filenameidx}"

    fi

    # optionally force silent appending

    if [[ "$cmd" = "--LOG"* ]]; then

      setLogFile --option=c --quiet "$logfile" LOG_FILE

    else

      setLogFile "$logfile" LOG_FILE

      printf "\n"

    fi

  fi

  # log script name

  printLog "this is $(realpath ${BASH_SOURCE[0]})\n"

  # parse arguments

  local otherargs=()

  while [ $# -gt 0 ]; do

    if ( parseIsOption $1 ); then

      case "$1" in

        -h|--help) # already handled; ignore

          shift 1;;

        -c|--clean)

          deleteProjects; printf "\n"; shift 1;;

        -w|--wipe)

          deleteProjects --wipe; printf "\n"; shift 1;;

        -q|--quit)

          quitScript; shift 1;;

        --log=*|--LOG=*) # already handled; ignore

          shift 1;;

        --log|--LOG) # already handled; ignore

          shift 2;;

        --noinfo) # already handled; ignore

          shift 1;;

        *)

          printError "invalid option: $1\n"; shift 1;;

      esac

    else

      otherargs+=("$1")

      shift 1

    fi

  done

  # interactive menu

  while ( true ); do

    # main menu info prompt and selection

    printInfo "QtCreator setup main menu\n"

    printf "Please select one of the following actions:\n"

    printf "  [I] - initialize project files\n"

    printf "  [C] - clean project files\n"

    printf "  [W] - wipe project and .user files\n"

    printf "  [Q] - quit this setup\n"

    local userinput=""

    readUserInput "IiCcWwQq" userinput

    printf "\n"

    # evaluate user selection

    case "$userinput" in

      I|i)

        initProject; printf "\n";;

      C|c)

        deleteProject; printf "\n";;

      W|w)

        deleteProject --wipe; printf "\n";;

      Q|q)

        quitScript;;

      *) # sanity check (exit with error)

        printError "unexpected argument: $userinput\n";;

    esac

  done

  exit 0

}

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

# SCRIPT ENTRY POINT                                                           #

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

main "$@"