Statistics
| Branch: | Tag: | Revision:

amiro-blt / ide / idesetup.sh @ 1446566f

History | View | Annotate | Download (15.1 KB)

1
################################################################################
2
# AMiRo-BLT is an bootloader and toolchain designed for the Autonomous Mini    #
3
# Robot (AMiRo) platform.                                                      #
4
# Copyright (C) 2016..2017  Thomas Schöpping et al.                            #
5
#                                                                              #
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
  printInfo "exiting $(realpath ${BASH_SOURCE[0]})\n"
110
  printf "\n"
111
  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
#                 Possible values are 'a', 'r' and 'n'.
173
#                 - a: append
174
#                 - r: delete and restart
175
#                 - n: no log
176
#                 If no option is secified but <file> exists, an interactive selection is provided.
177
#             --quiet
178
#                 Suppress all messages.
179
#             <infile>
180
#                 Path of the wanted log file.
181
#             <outvar>
182
#                 Variable to store the path of the log file to.
183
# return:     0
184
#                 No error or warning occurred.
185
#             -1
186
#                 Error: invalid input
187
#
188
function setLogFile {
189
  local filepath=""
190
  local option=""
191
  local quiet=false
192

    
193
  # parse arguments
194
  local otherargs=()
195
  while [ $# -gt 0 ]; do
196
    if ( parseIsOption $1 ); then
197
      case "$1" in
198
        -o=*|--option=*)
199
          option=${1#*=}; shift 1;;
200
        -o*|--option*)
201
          option="$2"; shift 2;;
202
        -q|--quiet)
203
          quiet=true; shift 1;;
204
        *)
205
          printError "invalid option: $1\n"; shift 1;;
206
      esac
207
    else
208
      otherargs+=("$1")
209
      shift 1
210
    fi
211
  done
212
  filepath=$(realpath ${otherargs[0]})
213

    
214
  # if file already exists
215
  if [ -e $filepath ]; then
216
    # if no option was specified, ask what to do
217
    if [ -z "$option" ]; then
218
      printWarning "log file $filepath already esists\n"
219
      local userinput=""
220
      printf "Select what to do:\n"
221
      printf "  [A] - append log\n"
222
      printf "  [R] - restart log (delete existing file)\n"
223
      printf "  [N] - no log\n"
224
      readUserInput "AaRrNn" userinput
225
      option=${userinput,,}
226
    fi
227
    # evaluate option
228
    case "$option" in
229
      a)
230
        if [ $quiet = false ]; then
231
          printInfo "appending log to $filepath\n"
232
        fi
233
        printf "\n" >> $filepath
234
        printf "######################################################################\n" >> $filepath
235
        printf "\n" >> $filepath
236
        ;;
237
      r)
238
        echo -n "" > $filepath
239
        if [ $quiet = false ]; then
240
          printInfo "content of $filepath wiped\n"
241
        fi
242
        ;;
243
      n)
244
        if [ $quiet = false ]; then
245
          printInfo "no log file will be generated\n"
246
        fi
247
        filepath=""
248
        ;;
249
      *) # sanity check (return error)
250
        printError "unexpected argument: $option\n"; return -1;;
251
    esac
252
  else
253
    if [ $quiet = false ]; then
254
      printInfo "log file set to $filepath\n"
255
    fi
256
  fi
257

    
258
  eval ${otherargs[1]}="$filepath"
259

    
260
  return 0
261
}
262

    
263
################################################################################
264
# SPECIFIC FUNCTIONS                                                           #
265
################################################################################
266

    
267
### print welcome text #########################################################
268
# Prints a welcome message to standard out.
269
#
270
# usage:      printWelcomeText
271
# arguments:  n/a
272
# return:     n/a
273
#
274
function printWelcomeText {
275
  printf "######################################################################\n"
276
  printf "#                                                                    #\n"
277
  printf "#                Welcome to the AMiRo-BLT IDE setup!                 #\n"
278
  printf "#                                                                    #\n"
279
  printf "######################################################################\n"
280
  printf "#                                                                    #\n"
281
  printf "# Copyright (c) 2016..2017  Thomas Schöpping                         #\n"
282
  printf "#                                                                    #\n"
283
  printf "# This is free software; see the source for copying conditions.      #\n"
284
  printf "# There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR  #\n"
285
  printf "# A PARTICULAR PURPOSE. The development of this software was         #\n"
286
  printf "# supported by the Excellence Cluster EXC 227 Cognitive Interaction  #\n"
287
  printf "# Technology. The Excellence Cluster EXC 227 is a grant of the       #\n"
288
  printf "# Deutsche Forschungsgemeinschaft (DFG) in the context of the German #\n"
289
  printf "# Excellence Initiative.                                             #\n"
290
  printf "#                                                                    #\n"
291
  printf "######################################################################\n"
292
}
293

    
294
### print help #################################################################
295
# Prints a help text to standard out.
296
#
297
# usage:      printHelp
298
# arguments:  n/a
299
# return:     n/a
300
#
301
function printHelp {
302
  printInfo "printing help text\n"
303
  printf "usage:    $(basename ${BASH_SOURCE[0]}) [-h|--help] [--QtCreator] [-q|--quit] [--log=<file>]\n"
304
  printf "\n"
305
  printf "options:  -h, --help\n"
306
  printf "              Print this help text.\n"
307
  printf "          --QtCreator\n"
308
  printf "              Enter QtCreator setup.\n"
309
  printf "          -q, --quit\n"
310
  printf "              Quit the script.\n"
311
  printf "          --log=<file>\n"
312
  printf "              Specify a log file.\n"
313
}
314

    
315
### enter QtCreator setup ######################################################
316
# Enter the QtCreator IDE setup.
317
#
318
# usage:      qtCreatorSetup
319
# arguments:  n/a
320
# return:     n/a
321
function qtCreatorSetup {
322
  printInfo "entering QtCreator setup...\n"
323
  printf "\n"
324
  if [ -z "$LOG_FILE" ]; then
325
    $(realpath $(dirname ${BASH_SOURCE[0]}))/QtCreator/QtCreatorSetup.sh --noinfo
326
  else
327
    $(realpath $(dirname ${BASH_SOURCE[0]}))/QtCreator/QtCreatorSetup.sh --LOG="$LOG_FILE" --noinfo
328
  fi
329
}
330

    
331
### main function of this script ###############################################
332
# The IDE setup lets the user select an IDE of choice.
333
# As of now, only QtCreator is supported.
334
#
335
# usage:      see function printHelp
336
# arguments:  see function printHelp
337
# return:     0
338
#                 No error or warning occurred.
339
#
340
function main {
341
  # print welcome/info text if not suppressed
342
  if [[ $@ != *"--noinfo"* ]]; then
343
    printWelcomeText
344
  else
345
    printf "######################################################################\n"
346
  fi
347
  printf "\n"
348

    
349
  # if --help or -h was specified, print the help text and exit
350
  if [[ $@ == *"--help"* || $@ == *"-h"* ]]; then
351
    printHelp
352
    printf "\n"
353
    quitScript
354
  fi
355

    
356
  # set log file if specified
357
  if [[ $@ == *"--log"* ]] || [[ $@ == *"--LOG"* ]]; then
358
    # get the parameter (file name)
359
    local cmdidx=1
360
    while [[ ! "${!cmdidx}" = "--log"* ]] && [[ ! "${!cmdidx}" = "--LOG"* ]]; do
361
      cmdidx=$[cmdidx + 1]
362
    done
363
    local cmd="${!cmdidx}"
364
    local logfile=""
365
    if [[ "$cmd" = "--log="* ]] || [[ "$cmd" = "--LOG="* ]]; then
366
      logfile=${cmd#*=}
367
    else
368
      local filenameidx=$((cmdidx + 1))
369
      logfile="${!filenameidx}"
370
    fi
371
    # optionally force silent appending
372
    if [[ "$cmd" = "--LOG"* ]]; then
373
      setLogFile --option=a --quiet "$logfile" LOG_FILE
374
    else
375
      setLogFile "$logfile" LOG_FILE
376
      printf "\n"
377
    fi
378
  fi
379
  # log script name
380
  printLog "this is $(realpath ${BASH_SOURCE[0]})\n"
381

    
382
  # parse arguments
383
  local otherargs=()
384
  while [ $# -gt 0 ]; do
385
    if ( parseIsOption $1 ); then
386
      case "$1" in
387
        -h|--help) # already handled; ignore
388
          shift 1;;
389
        --QtCreator)
390
          qtCreatorSetup; printf "\n"; shift 1;;
391
        -q|--quit)
392
          quitScript; printf "\n"; shift 1;;
393
        --log=*|--LOG=*) # already handled; ignore
394
          shift 1;;
395
        --log|--LOG) # already handled; ignore
396
          shift 2;;
397
        --noinfo) # already handled; ignore
398
          shift 1;;
399
        *)
400
          printError "invalid option: $1\n"; shift 1;;
401
      esac
402
    else
403
      otherargs+=("$1")
404
      shift 1
405
    fi
406
  done
407

    
408
  # interactive menu
409
  while ( true ); do
410
    # main menu info prompt and selection
411
    printInfo "AMiRo-BLT IDE setup main menu\n"
412
    printf "Please select one of the following actions:\n"
413
    printf "  [C] - enter QtCreator setup\n"
414
    printf "  [Q] - quit this setup\n"
415
    local userinput=""
416
    readUserInput "CcQq" userinput
417
    printf "\n"
418

    
419
    # evaluate user selection
420
    case "$userinput" in
421
      C|c)
422
        qtCreatorSetup; printf "\n";;
423
      Q|q)
424
        quitScript;;
425
      *) # sanity check (exit with error)
426
        printError "unexpected argument: $userinput\n";;
427
    esac
428
  done
429

    
430
  exit 0
431
}
432

    
433
################################################################################
434
# SCRIPT ENTRY POINT                                                           #
435
################################################################################
436

    
437
main "$@"