amiro-blt / tools / compiler / compilersetup.sh @ 2b9a14a2
History | View | Annotate | Download (15.984 KB)
| 1 | 0a42f078 | Thomas Schöpping | ################################################################################ |
|---|---|---|---|
| 2 | # AMiRo-BLT is an bootloader and toolchain designed for the Autonomous Mini # |
||
| 3 | # Robot (AMiRo) platform. # |
||
| 4 | 449d916a | Thomas Schöpping | # Copyright (C) 2016..2019 Thomas Schöpping et al. # |
| 5 | 0a42f078 | Thomas Schöpping | # # |
| 6 | # This program is free software: you can redistribute it and/or modify # |
||
| 7 | # it under the terms of the GNU General Public License as published by # |
||
| 8 | # the Free Software Foundation, either version 3 of the License, or # |
||
| 9 | # (at your option) any later version. # |
||
| 10 | # # |
||
| 11 | # This program is distributed in the hope that it will be useful, # |
||
| 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of # |
||
| 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # |
||
| 14 | # GNU General Public License for more details. # |
||
| 15 | # # |
||
| 16 | # You should have received a copy of the GNU General Public License # |
||
| 17 | # along with this program. If not, see <http://www.gnu.org/licenses/>. # |
||
| 18 | # # |
||
| 19 | # This research/work was supported by the Cluster of Excellence Cognitive # |
||
| 20 | # Interaction Technology 'CITEC' (EXC 277) at Bielefeld University, which is # |
||
| 21 | # funded by the German Research Foundation (DFG). # |
||
| 22 | ################################################################################ |
||
| 23 | |||
| 24 | #!/bin/bash |
||
| 25 | |||
| 26 | ################################################################################ |
||
| 27 | # GENERIC FUNCTIONS # |
||
| 28 | ################################################################################ |
||
| 29 | |||
| 30 | ### print an error message ##################################################### |
||
| 31 | # Prints a error <message> to standard output. |
||
| 32 | #If variable 'LOG_FILE' is specified, the message is also appended to the given file. |
||
| 33 | # |
||
| 34 | # usage: printError <message> |
||
| 35 | # arguments: <message> |
||
| 36 | # Message string to print. |
||
| 37 | # return: n/a |
||
| 38 | # |
||
| 39 | function printError {
|
||
| 40 | local string="ERROR: $1" |
||
| 41 | # if a log file is specified |
||
| 42 | if [ -n "$LOG_FILE" ]; then |
||
| 43 | printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
||
| 44 | fi |
||
| 45 | printf "$(tput setaf 1)>>> $string$(tput sgr 0)" 1>&2 |
||
| 46 | } |
||
| 47 | |||
| 48 | ### print a warning message #################################################### |
||
| 49 | # Prints a warning <message> to standard output. |
||
| 50 | #If variable 'LOG_FILE' is specified, the message is also appended to the given file. |
||
| 51 | # |
||
| 52 | # usage: printMessage <message> |
||
| 53 | # arguments: <message> |
||
| 54 | # Message string to print. |
||
| 55 | # return: n/a |
||
| 56 | # |
||
| 57 | function printWarning {
|
||
| 58 | local string="WARNING: $1" |
||
| 59 | # if a log file is specified |
||
| 60 | if [ -n "$LOG_FILE" ]; then |
||
| 61 | printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
||
| 62 | fi |
||
| 63 | printf "$(tput setaf 3)>>> $string$(tput sgr 0)" |
||
| 64 | } |
||
| 65 | |||
| 66 | ### print an information message ############################################### |
||
| 67 | # Prints an information <message> to standard output. |
||
| 68 | #If variable 'LOG_FILE' is specified, the message is also appended to the given file. |
||
| 69 | # |
||
| 70 | # usage: printInfo <message> |
||
| 71 | # arguments: <message> |
||
| 72 | # Message string to print. |
||
| 73 | # return: n/a |
||
| 74 | # |
||
| 75 | function printInfo {
|
||
| 76 | local string="INFO: $1" |
||
| 77 | # if a log file is specified |
||
| 78 | if [ -n "$LOG_FILE" ]; then |
||
| 79 | printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
||
| 80 | fi |
||
| 81 | printf "$(tput setaf 2)>>> $string$(tput sgr 0)" |
||
| 82 | } |
||
| 83 | |||
| 84 | ### print a message to file #################################################### |
||
| 85 | # Appends a <message> to a log file, specified by the variable 'LOG_FILE'. |
||
| 86 | # |
||
| 87 | # usage printLog <message> |
||
| 88 | # arguments: <message> |
||
| 89 | # Message string to print. |
||
| 90 | # return: n/a |
||
| 91 | # |
||
| 92 | function printLog {
|
||
| 93 | local string="LOG: $1" |
||
| 94 | # if a log file is specified |
||
| 95 | if [ -n "$LOG_FILE" ]; then |
||
| 96 | printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
||
| 97 | fi |
||
| 98 | } |
||
| 99 | |||
| 100 | ### exit the script normally ################################################### |
||
| 101 | # Prints a delimiter and exits the script normally (returns 0). |
||
| 102 | # |
||
| 103 | # usage: quitScript |
||
| 104 | # arguments: n/a |
||
| 105 | # return: 0 |
||
| 106 | # No error or warning occurred. |
||
| 107 | # |
||
| 108 | function quitScript {
|
||
| 109 | 3719a40a | Thomas Schöpping | printInfo "exiting $(realpath ${BASH_SOURCE[0]})\n"
|
| 110 | printf "\n" |
||
| 111 | 0a42f078 | Thomas Schöpping | printf "######################################################################\n" |
| 112 | exit 0 |
||
| 113 | } |
||
| 114 | |||
| 115 | ### read a user input ########################################################## |
||
| 116 | # Reads a single character user input from a set up <options> and stores it in |
||
| 117 | # a given <return> variable. |
||
| 118 | # |
||
| 119 | # usage: readUserInput <options> <return> |
||
| 120 | # arguments: <options> |
||
| 121 | # String definiing the set of valid characters. |
||
| 122 | # If the string is empty, the user can input any character. |
||
| 123 | # <return> |
||
| 124 | # Variable to store the selected character to. |
||
| 125 | # return: n/a |
||
| 126 | # |
||
| 127 | function readUserInput {
|
||
| 128 | local input="" |
||
| 129 | # read user input |
||
| 130 | while [ -z $input ] || ( [ -n "$1" ] && [[ ! $input =~ ^[$1]$ ]] ); do |
||
| 131 | read -p "your selection: " -n 1 -e input |
||
| 132 | if [ -z $input ] || ( [ -n "$1" ] && [[ ! $input =~ ^[$1]$ ]] ); then |
||
| 133 | printWarning "[$input] is no valid action\n" |
||
| 134 | fi |
||
| 135 | done |
||
| 136 | printLog "[$input] has been selected\n" |
||
| 137 | eval $2="$input" |
||
| 138 | } |
||
| 139 | |||
| 140 | ### check whether argument is an option ######################################## |
||
| 141 | # Checks a <string> whether it is an option. |
||
| 142 | # Options are defined to either start with '--' followed by any string, or |
||
| 143 | # to start with a single '-' followed by a single character, or |
||
| 144 | # to start with a single '-' followed by a single character, a '=' and any string. |
||
| 145 | # Examples: '--option', '--option=arg', '-o', '-o=arg', '--' |
||
| 146 | # |
||
| 147 | # usage: parseIsOption <string> |
||
| 148 | # arguments: <string> |
||
| 149 | # A string to check whether it is an option. |
||
| 150 | # return: 0 |
||
| 151 | # <string> is an option. |
||
| 152 | # -1 |
||
| 153 | # <string> is not an option. |
||
| 154 | # |
||
| 155 | function parseIsOption {
|
||
| 156 | if [[ "$1" =~ ^-(.$|.=.*) ]] || [[ "$1" =~ ^--.* ]]; then |
||
| 157 | return 0 |
||
| 158 | else |
||
| 159 | return -1 |
||
| 160 | fi |
||
| 161 | } |
||
| 162 | |||
| 163 | ### set the log file ########################################################### |
||
| 164 | # Sets a specified <infile> as log file and checks whether it already exists. |
||
| 165 | # If so, the log may either be appended to the file, its content can be cleared, |
||
| 166 | # or no log is generated at all. |
||
| 167 | # The resulting path is stored in <outvar>. |
||
| 168 | # |
||
| 169 | # usage: setLogFile [--option=<option>] [--quiet] <infile> <outvar> |
||
| 170 | # arguments: --option=<option> |
||
| 171 | # Select what to do if <file> already exists. |
||
| 172 | 0dc9f2f9 | Thomas Schöpping | # Possible values are 'a', 'c', 'r' and 'n'. |
| 173 | # - a: append (starts with a separator) |
||
| 174 | # - c: continue (does not insert a seperator) |
||
| 175 | 0a42f078 | Thomas Schöpping | # - r: delete and restart |
| 176 | # - n: no log |
||
| 177 | # If no option is secified but <file> exists, an interactive selection is provided. |
||
| 178 | # --quiet |
||
| 179 | # Suppress all messages. |
||
| 180 | # <infile> |
||
| 181 | # Path of the wanted log file. |
||
| 182 | # <outvar> |
||
| 183 | # Variable to store the path of the log file to. |
||
| 184 | # return: 0 |
||
| 185 | # No error or warning occurred. |
||
| 186 | # -1 |
||
| 187 | # Error: invalid input |
||
| 188 | # |
||
| 189 | function setLogFile {
|
||
| 190 | local filepath="" |
||
| 191 | local option="" |
||
| 192 | local quiet=false |
||
| 193 | |||
| 194 | # parse arguments |
||
| 195 | local otherargs=() |
||
| 196 | while [ $# -gt 0 ]; do |
||
| 197 | if ( parseIsOption $1 ); then |
||
| 198 | case "$1" in |
||
| 199 | -o=*|--option=*) |
||
| 200 | option=${1#*=}; shift 1;;
|
||
| 201 | -o*|--option*) |
||
| 202 | option="$2"; shift 2;; |
||
| 203 | -q|--quiet) |
||
| 204 | quiet=true; shift 1;; |
||
| 205 | *) |
||
| 206 | printError "invalid option: $1\n"; shift 1;; |
||
| 207 | esac |
||
| 208 | else |
||
| 209 | otherargs+=("$1")
|
||
| 210 | shift 1 |
||
| 211 | fi |
||
| 212 | done |
||
| 213 | filepath=$(realpath ${otherargs[0]})
|
||
| 214 | |||
| 215 | # if file already exists |
||
| 216 | if [ -e $filepath ]; then |
||
| 217 | # if no option was specified, ask what to do |
||
| 218 | if [ -z "$option" ]; then |
||
| 219 | printWarning "log file $filepath already esists\n" |
||
| 220 | local userinput="" |
||
| 221 | printf "Select what to do:\n" |
||
| 222 | printf " [A] - append log\n" |
||
| 223 | printf " [R] - restart log (delete existing file)\n" |
||
| 224 | printf " [N] - no log\n" |
||
| 225 | readUserInput "AaRrNn" userinput |
||
| 226 | option=${userinput,,}
|
||
| 227 | fi |
||
| 228 | # evaluate option |
||
| 229 | case "$option" in |
||
| 230 | 0dc9f2f9 | Thomas Schöpping | a|c) |
| 231 | 0a42f078 | Thomas Schöpping | if [ $quiet = false ]; then |
| 232 | printInfo "appending log to $filepath\n" |
||
| 233 | fi |
||
| 234 | 0dc9f2f9 | Thomas Schöpping | if [ $option != c ]; then |
| 235 | printf "\n" >> $filepath |
||
| 236 | printf "######################################################################\n" >> $filepath |
||
| 237 | printf "\n" >> $filepath |
||
| 238 | fi |
||
| 239 | 0a42f078 | Thomas Schöpping | ;; |
| 240 | r) |
||
| 241 | echo -n "" > $filepath |
||
| 242 | if [ $quiet = false ]; then |
||
| 243 | printInfo "content of $filepath wiped\n" |
||
| 244 | fi |
||
| 245 | ;; |
||
| 246 | n) |
||
| 247 | if [ $quiet = false ]; then |
||
| 248 | printInfo "no log file will be generated\n" |
||
| 249 | fi |
||
| 250 | filepath="" |
||
| 251 | ;; |
||
| 252 | *) # sanity check (return error) |
||
| 253 | printError "unexpected argument: $option\n"; return -1;; |
||
| 254 | esac |
||
| 255 | else |
||
| 256 | if [ $quiet = false ]; then |
||
| 257 | printInfo "log file set to $filepath\n" |
||
| 258 | fi |
||
| 259 | fi |
||
| 260 | |||
| 261 | eval ${otherargs[1]}="$filepath"
|
||
| 262 | |||
| 263 | return 0 |
||
| 264 | } |
||
| 265 | |||
| 266 | fad4c1e7 | Thomas Schöpping | ### check whether commands are available ####################################### |
| 267 | # Checks whether the specified commands are available and can be executed. |
||
| 268 | # |
||
| 269 | e687187f | Thomas Schöpping | # usage: checkCommands [<command> <command> ...] |
| 270 | fad4c1e7 | Thomas Schöpping | # arguments: <command> |
| 271 | # Name of the command to check. |
||
| 272 | # return: 0 |
||
| 273 | # All requested commands are available. |
||
| 274 | # >0 |
||
| 275 | # Number of requested commands that were not found. |
||
| 276 | # -1 |
||
| 277 | # No argument given. |
||
| 278 | # |
||
| 279 | function checkCommands {
|
||
| 280 | local status=0 |
||
| 281 | |||
| 282 | # return if no argument was specified |
||
| 283 | if [ $# -eq 0 ]; then |
||
| 284 | return -1 |
||
| 285 | fi |
||
| 286 | |||
| 287 | # check all specified commands |
||
| 288 | while [ $# -gt 0 ]; do |
||
| 289 | command -v $1 &>/dev/null |
||
| 290 | if [ $? -ne 0 ]; then |
||
| 291 | printWarning "Command '$1' not available.\n" |
||
| 292 | status=$((status + 1)) |
||
| 293 | fi |
||
| 294 | shift 1 |
||
| 295 | done |
||
| 296 | |||
| 297 | return $status |
||
| 298 | } |
||
| 299 | |||
| 300 | 0a42f078 | Thomas Schöpping | ################################################################################ |
| 301 | # SPECIFIC FUNCTIONS # |
||
| 302 | ################################################################################ |
||
| 303 | |||
| 304 | ### print welcome text ######################################################### |
||
| 305 | # Prints a welcome message to standard out. |
||
| 306 | # |
||
| 307 | # usage: printWelcomeText |
||
| 308 | # arguments: n/a |
||
| 309 | # return: n/a |
||
| 310 | # |
||
| 311 | function printWelcomeText {
|
||
| 312 | printf "######################################################################\n" |
||
| 313 | printf "# #\n" |
||
| 314 | printf "# Welcome to the AMiRo-BLT compiler setup! #\n" |
||
| 315 | printf "# #\n" |
||
| 316 | printf "######################################################################\n" |
||
| 317 | printf "# #\n" |
||
| 318 | 449d916a | Thomas Schöpping | printf "# Copyright (c) 2016..2019 Thomas Schöpping #\n" |
| 319 | 0a42f078 | Thomas Schöpping | printf "# #\n" |
| 320 | printf "# This is free software; see the source for copying conditions. #\n" |
||
| 321 | printf "# There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR #\n" |
||
| 322 | printf "# A PARTICULAR PURPOSE. The development of this software was #\n" |
||
| 323 | printf "# supported by the Excellence Cluster EXC 227 Cognitive Interaction #\n" |
||
| 324 | printf "# Technology. The Excellence Cluster EXC 227 is a grant of the #\n" |
||
| 325 | printf "# Deutsche Forschungsgemeinschaft (DFG) in the context of the German #\n" |
||
| 326 | printf "# Excellence Initiative. #\n" |
||
| 327 | printf "# #\n" |
||
| 328 | printf "######################################################################\n" |
||
| 329 | } |
||
| 330 | |||
| 331 | ### print help ################################################################# |
||
| 332 | # Prints a help text to standard out. |
||
| 333 | # |
||
| 334 | # usage: printHelp |
||
| 335 | # arguments: n/a |
||
| 336 | # return: n/a |
||
| 337 | # |
||
| 338 | function printHelp {
|
||
| 339 | printInfo "printing help text\n" |
||
| 340 | printf "usage: $(basename ${BASH_SOURCE[0]}) [-h|--help] [--GCC] [-q|--quit] [--log=<file>]\n"
|
||
| 341 | printf "\n" |
||
| 342 | printf "options: -h, --help\n" |
||
| 343 | printf " Print this help text.\n" |
||
| 344 | printf " --GCC\n" |
||
| 345 | printf " Enter GCC setup.\n" |
||
| 346 | printf " -q, --quit\n" |
||
| 347 | printf " Quit the script.\n" |
||
| 348 | printf " --log=<file>\n" |
||
| 349 | printf " Specify a log file.\n" |
||
| 350 | } |
||
| 351 | |||
| 352 | ### enter GCC setup ############################################################ |
||
| 353 | # Enter the arm-none-eabi-gcc setup. |
||
| 354 | # |
||
| 355 | # usage: gccSetup |
||
| 356 | # arguments: n/a |
||
| 357 | # return: n/a |
||
| 358 | function gccSetup {
|
||
| 359 | printInfo "entering GCC setup...\n" |
||
| 360 | printf "\n" |
||
| 361 | if [ -z "$LOG_FILE" ]; then |
||
| 362 | $(realpath $(dirname ${BASH_SOURCE[0]}))/GCC/gccsetup.sh --noinfo
|
||
| 363 | else |
||
| 364 | $(realpath $(dirname ${BASH_SOURCE[0]}))/GCC/gccsetup.sh --LOG="$LOG_FILE" --noinfo
|
||
| 365 | fi |
||
| 366 | } |
||
| 367 | |||
| 368 | ### main function of this script ############################################### |
||
| 369 | # The IDE setup lets the user select an IDE of choice. |
||
| 370 | # As of now, only QtCreator is supported. |
||
| 371 | # |
||
| 372 | # usage: see function printHelp |
||
| 373 | # arguments: see function printHelp |
||
| 374 | # return: 0 |
||
| 375 | # No error or warning occurred. |
||
| 376 | # |
||
| 377 | function main {
|
||
| 378 | # print welcome/info text if not suppressed |
||
| 379 | if [[ $@ != *"--noinfo"* ]]; then |
||
| 380 | printWelcomeText |
||
| 381 | else |
||
| 382 | printf "######################################################################\n" |
||
| 383 | fi |
||
| 384 | printf "\n" |
||
| 385 | |||
| 386 | 1446566f | Thomas Schöpping | # if --help or -h was specified, print the help text and exit |
| 387 | if [[ $@ == *"--help"* || $@ == *"-h"* ]]; then |
||
| 388 | printHelp |
||
| 389 | printf "\n" |
||
| 390 | quitScript |
||
| 391 | fi |
||
| 392 | |||
| 393 | 0a42f078 | Thomas Schöpping | # set log file if specified |
| 394 | if [[ $@ == *"--log"* ]] || [[ $@ == *"--LOG"* ]]; then |
||
| 395 | # get the parameter (file name) |
||
| 396 | local cmdidx=1 |
||
| 397 | while [[ ! "${!cmdidx}" = "--log"* ]] && [[ ! "${!cmdidx}" = "--LOG"* ]]; do
|
||
| 398 | cmdidx=$[cmdidx + 1] |
||
| 399 | done |
||
| 400 | local cmd="${!cmdidx}"
|
||
| 401 | local logfile="" |
||
| 402 | if [[ "$cmd" = "--log="* ]] || [[ "$cmd" = "--LOG="* ]]; then |
||
| 403 | logfile=${cmd#*=}
|
||
| 404 | else |
||
| 405 | local filenameidx=$((cmdidx + 1)) |
||
| 406 | logfile="${!filenameidx}"
|
||
| 407 | fi |
||
| 408 | # optionally force silent appending |
||
| 409 | if [[ "$cmd" = "--LOG"* ]]; then |
||
| 410 | 0dc9f2f9 | Thomas Schöpping | setLogFile --option=c --quiet "$logfile" LOG_FILE |
| 411 | 0a42f078 | Thomas Schöpping | else |
| 412 | setLogFile "$logfile" LOG_FILE |
||
| 413 | printf "\n" |
||
| 414 | fi |
||
| 415 | fi |
||
| 416 | # log script name |
||
| 417 | printLog "this is $(realpath ${BASH_SOURCE[0]})\n"
|
||
| 418 | |||
| 419 | # parse arguments |
||
| 420 | local otherargs=() |
||
| 421 | while [ $# -gt 0 ]; do |
||
| 422 | if ( parseIsOption $1 ); then |
||
| 423 | case "$1" in |
||
| 424 | -h|--help) # already handled; ignore |
||
| 425 | shift 1;; |
||
| 426 | --GCC) |
||
| 427 | gccSetup; printf "\n"; shift 1;; |
||
| 428 | -q|--quit) |
||
| 429 | quitScript; printf "\n"; shift 1;; |
||
| 430 | --log=*|--LOG=*) # already handled; ignore |
||
| 431 | shift 1;; |
||
| 432 | --log|--LOG) # already handled; ignore |
||
| 433 | shift 2;; |
||
| 434 | --noinfo) # already handled; ignore |
||
| 435 | shift 1;; |
||
| 436 | *) |
||
| 437 | printError "invalid option: $1\n"; shift 1;; |
||
| 438 | esac |
||
| 439 | else |
||
| 440 | otherargs+=("$1")
|
||
| 441 | shift 1 |
||
| 442 | fi |
||
| 443 | done |
||
| 444 | |||
| 445 | # interactive menu |
||
| 446 | while ( true ); do |
||
| 447 | # main menu info prompt and selection |
||
| 448 | printInfo "AMiRo-BLT compiler setup main menu\n" |
||
| 449 | printf "Please select one of the following actions:\n" |
||
| 450 | printf " [G] - enter GCC setup\n" |
||
| 451 | printf " [Q] - quit this setup\n" |
||
| 452 | local userinput="" |
||
| 453 | readUserInput "GgQq" userinput |
||
| 454 | printf "\n" |
||
| 455 | |||
| 456 | # evaluate user selection |
||
| 457 | case "$userinput" in |
||
| 458 | G|g) |
||
| 459 | gccSetup; printf "\n";; |
||
| 460 | Q|q) |
||
| 461 | quitScript;; |
||
| 462 | *) # sanity check (exit with error) |
||
| 463 | printError "unexpected argument: $userinput\n"; printf "\n";; |
||
| 464 | esac |
||
| 465 | done |
||
| 466 | |||
| 467 | exit 0 |
||
| 468 | } |
||
| 469 | |||
| 470 | ################################################################################ |
||
| 471 | # SCRIPT ENTRY POINT # |
||
| 472 | ################################################################################ |
||
| 473 | |||
| 474 | main "$@" |