AMiRo-OS

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

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

# (AMiRo) platform.                                                            #

# Copyright (C) 2016..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) 2016..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] [-m|--module=<module>] [-a|--all] [-c|--clean] [-w|--wipe] [-q|--quit] [--log=<file>]\n"

  printf "\n"

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

  printf "              Print this help text.\n"

  printf "          -m, --module <module>\n"

  printf "              Create project for a single module.\n"

  printf "          -a, --all\n"

  printf "              Create projects for all modules.\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 amiroosdir=$(realpath $(dirname $(realpath ${BASH_SOURCE[0]}))/../../../)

  local input=""

  read -p "Path where to create/delete project files: " -i $amiroosdir -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.

#            -2

#                 Error: include directory could not be resolved.

#

function retrieveGccIncludeDir {

  # retrieve binary path or link

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

  local gccincpath=""

  if [ -z "$binpath" ]; then

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

    return -1

  else 

    # traverse any links

    while [ -L "$binpath" ]; do

      binpath=$(realpath $(dirname $binpath)/$(readlink $binpath))

    done

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

    # return include path

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

    if [ ! -d "$gccincpath" ]; then

      printWarning "$gccincpath does not exist\n"

      return -2

    else

      eval $1="$gccincpath"

      return 0

    fi

  fi

}

### detect available modules ###################################################

# Detect all avalable modules supported by AMiRo-OS.

#

# usage:      detectModules <modulearray>

# arguments:  <modulearray>

#                 Array variable to store all detected modules to.

# return:     n/a

#

function detectModules {

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

  local modules_detected=()

  # detect all available modules (via directories)

  for dir in $(ls -d ${modulesdir}/*/); do

    modules_detected[${#modules_detected[@]}]=$(basename $dir)

  done

  # set the output variable

  eval "$1=(${modules_detected[*]})"

}

### create project files for a single module ###################################

# Create project files for a single module.

#

# usage:      createModuleProject <modules> [-m|--module=<module>] [-p|--path=<path>] [--gcc=<path>] [-o|--out=<var>] [--gccout=<var>]

# arguments:  <modules>

#                 Array containing all modules available.

#             -m, --module <module>

#                 Name (folder name) of the module for which project files shall be generated.

#             -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.

#                 If this optional arguments is absent, ths function will ask for user input.

# return:     0

#                 No error or warning occurred.

#             1

#                 Aborted by user.

#             -1

#                 No modules available.

#             -2

#                 The specified <module> could not be found.

#             -3

#                 Parsing the project for the specified module failed.

#             -4

#                 Missing dependencies.

#

function createModuleProject {

  local userdir=$(pwd)

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

  local modules=("${!1}")

  local module=""

  local moduleidx=""

  local projectdir=""

  local gccincludedir=""

  local outvar=""

  local gccoutvar=""

  # check dependencies

  checkCommands make

  if [ $? -ne 0 ]; then

    printError "Missing dependencies detected.\n"

    return -4

  fi

  # parse arguments

  local otherargs=()

  while [ $# -gt 0 ]; do

    if ( parseIsOption $1 ); then

      case "$1" in

        -m=*|--module=*)

          module="${1#*=}"; shift 1;;

        -m|--module)

          module="$2"; shift 2;;

        -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