Statistics
| Branch: | Tag: | Revision:

amiro-blt / tools / ide / QtCreator / QtCreatorSetup.sh @ ca5b937a

History | View | Annotate | Download (25.857 KB)

1
################################################################################
2
# AMiRo-BLT is an bootloader and toolchain designed for the Autonomous Mini    #
3
# Robot (AMiRo) platform.                                                      #
4
# Copyright (C) 2016..2020  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
# load library
27
source "$(dirname ${BASH_SOURCE[0]})/../../bash/setuplib.sh"
28

    
29
### print welcome text #########################################################
30
# Prints a welcome message to standard out.
31
#
32
# usage:      printWelcomeText
33
# arguments:  n/a
34
# return:     n/a
35
#
36
function printWelcomeText {
37
  printf "######################################################################\n"
38
  printf "#                                                                    #\n"
39
  printf "#                  Welcome to the QtCreator setup!                   #\n"
40
  printf "#                                                                    #\n"
41
  printf "######################################################################\n"
42
  printf "#                                                                    #\n"
43
  printf "# Copyright (c) 2016..2020  Thomas Schöpping                         #\n"
44
  printf "#                                                                    #\n"
45
  printf "# This is free software; see the source for copying conditions.      #\n"
46
  printf "# There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR  #\n"
47
  printf "# A PARTICULAR PURPOSE. The development of this software was         #\n"
48
  printf "# supported by the Excellence Cluster EXC 227 Cognitive Interaction  #\n"
49
  printf "# Technology. The Excellence Cluster EXC 227 is a grant of the       #\n"
50
  printf "# Deutsche Forschungsgemeinschaft (DFG) in the context of the German #\n"
51
  printf "# Excellence Initiative.                                             #\n"
52
  printf "#                                                                    #\n"
53
  printf "######################################################################\n"
54
}
55

    
56
### print help #################################################################
57
# Prints a help text to standard out.
58
#
59
# usage:      printHelp
60
# arguments:  n/a
61
# return:     n/a
62
#
63
function printHelp {
64
  printInfo "printing help text\n"
65
  printf "usage:    $(basename ${BASH_SOURCE[0]}) [-h|--help] [-m|--module=<module>] [-a|--all] [-c|--clean] [-w|--wipe] [-q|--quit] [--log=<file>]\n"
66
  printf "\n"
67
  printf "options:  -h, --help\n"
68
  printf "              Print this help text.\n"
69
  printf "          -m, --module <module>\n"
70
  printf "              Create project for a single module.\n"
71
  printf "          -a, --all\n"
72
  printf "              Create projects for all modules.\n"
73
  printf "          -c, --clean\n"
74
  printf "              Delete project files.\n"
75
  printf "          -w, --wipe\n"
76
  printf "              Delete project and .user files.\n"
77
  printf "          -q, --quit\n"
78
  printf "              Quit the script.\n"
79
  printf "          --log=<file>\n"
80
  printf "              Specify a log file.\n"
81
}
82

    
83
### read directory where to create/delete projects #############################
84
# Read the directory where to create/delete project files from user.
85
#
86
# usage:      getProjectDir <pathvar>
87
# arguments:  <pathvar>
88
#                 Variable to store the selected path to.
89
# return:     n/a
90
#
91
function getProjectDir {
92
  printLog "reading path for project files from user...\n"
93
  local amirobltdir=$(realpath $(dirname $(realpath ${BASH_SOURCE[0]}))/../../../Target/)
94
  local input=""
95
  read -p "Path where to create/delete project files: " -i $amirobltdir -e input
96
  printLog "user selected path $(realpath $input)\n"
97
  eval $1="$(realpath $input)"
98
}
99

    
100
### retrieves the ARM-NONE-EABI-GCC include directory ##########################
101
# Retrieves the include directory of the currently set arm-none-eabi-gcc.
102
#
103
# usage:      retrieveGccIncludeDir <path>
104
# arguments:  <path>
105
#                 Variable to store the path to.
106
# return:    0
107
#                 No error or warning occurred.
108
#            -1
109
#                 Error: Command 'arm-none-eabi-gcc' not found.
110
#            -2
111
#                 Error: include directory could not be resolved.
112
#
113
function retrieveGccIncludeDir {
114
  # retrieve binary path or link
115
  local binpath=$(which arm-none-eabi-gcc)
116
  local gccincpath=""
117
  if [ -z "$binpath" ]; then
118
    printError "command 'arm-none-eabi-gcc' not found\n"
119
    return -1
120
  else 
121

    
122
    # traverse any links
123
    while [ -L "$binpath" ]; do
124
      binpath=$(realpath $(dirname $binpath)/$(readlink $binpath))
125
    done
126
    printInfo "gcc-arm-none-eabi detected: $binpath\n"
127

    
128
    # return include path
129
    gccincpath=$(realpath $(dirname ${binpath})/../arm-none-eabi/include/)
130
    if [ ! -d "$gccincpath" ]; then
131
      printWarning "$gccincpath does not exist\n"
132
      return -2
133
    else
134
      eval $1="$gccincpath"
135
      return 0
136
    fi
137
  fi
138
}
139

    
140
### detect available modules ###################################################
141
# Detect all avalable modules supported by AMiRo-OS.
142
#
143
# usage:      detectModules <modulearray>
144
# arguments:  <modulearray>
145
#                 Array variable to store all detected modules to.
146
# return:     n/a
147
#
148
function detectModules {
149
  local modulesdir=$(realpath $(dirname $(realpath ${BASH_SOURCE[0]}))/../../../Target/Modules)
150
  local modules_detected=()
151

    
152
  # detect all available modules (via directories)
153
  for dir in $(ls -d ${modulesdir}/*/); do
154
    modules_detected[${#modules_detected[@]}]=$(basename $dir)
155
  done
156

    
157
  # set the output variable
158
  eval "$1=(${modules_detected[*]})"
159
}
160

    
161
### create project files for a single module ###################################
162
# Create project files for a single module.
163
#
164
# usage:      createModuleProject <modules> [-m|--module=<module>] [-p|--path=<path>] [--gcc=<path>] [-o|--out=<var>] [--gccout=<var>]
165
# arguments:  <modules>
166
#                 Array containing all modules available.
167
#             -m, --module <module>
168
#                 Name (folder name) of the module for which project files shall be generated.
169
#             -p, --path <path>
170
#                 Path where to create the project files.
171
#             --gcc=<path>
172
#                 Path to the GCC include directory.
173
#             -o, --out <var>
174
#                 Variable to store the path to.
175
#             --gccout=<var>
176
#                 Variable to store the path to the GCC include directory to.
177
#                 If this optional arguments is absent, ths function will ask for user input.
178
# return:     0
179
#                 No error or warning occurred.
180
#             1
181
#                 Aborted by user.
182
#             -1
183
#                 No modules available.
184
#             -2
185
#                 The specified <module> could not be found.
186
#             -3
187
#                 Parsing the project for the specified module failed.
188
#             -4
189
#                 Missing dependencies.
190
#
191
function createModuleProject {
192
  local userdir=$(pwd)
193
  local modulesdir=$(realpath $(dirname $(realpath ${BASH_SOURCE[0]}))/../../../Target/Modules)
194
  local modules=("${!1}")
195
  local module=""
196
  local moduleidx=""
197
  local projectdir=""
198
  local gccincludedir=""
199
  local outvar=""
200
  local gccoutvar=""
201

    
202
  # check dependencies
203
  checkCommands make
204
  if [ $? -ne 0 ]; then
205
    printError "Missing dependencies detected.\n"
206
    return -4
207
  fi
208

    
209
  # parse arguments
210
  local otherargs=()
211
  while [ $# -gt 0 ]; do
212
    if ( parseIsOption $1 ); then
213
      case "$1" in
214
        -m=*|--module=*)
215
          module="${1#*=}"; shift 1;;
216
        -m|--module)
217
          module="$2"; shift 2;;
218
        -p=*|--path=*)
219
          projectdir=$(realpath "${1#*=}"); shift 1;;
220
        -p|--path)
221
          projectdir=$(realpath "$2"); shift 2;;
222
        --gcc=*)
223
          gccincludedir=$(realpath "${1#*=}"); shift 1;;
224
        --gcc)
225
          gccincludedir=$(realpath "$2"); shift 2;;
226
        -o=*|--out=*)
227
          outvar=${1#*=}; shift 1;;
228
        -o|--out)
229
          outvar=$2; shift 2;;
230
        --gccout=*)
231
          gccoutvar=$(realpath "${1#*=}"); shift 1;;
232
        --gccout)
233
          gccoutvar=$(realpath "$2"); shift 2;;
234
        *)
235
          printError "invalid option: $1\n"; shift 1;;
236
      esac
237
    else
238
      otherargs+=("$1")
239
      shift 1
240
    fi
241
  done
242

    
243
  # sanity check for the modules variable
244
  if [ -z "${modules[*]}" ]; then
245
    printError "no modules available\n"
246
    return -1
247
  fi
248

    
249
  # select module
250
  if [ -z $module ]; then
251
    # list all available modules
252
    printInfo "choose a module or type 'A' to abort:\n"
253
    for (( idx=0; idx<${#modules[@]}; ++idx )); do
254
      printf "%4u: %s\n" $(($idx + 1)) "${modules[$idx]}"
255
    done
256
    # read user input
257
    printLog "read user selection\n"
258
    local userinput=""
259
    while [[ ! "$userinput" =~ ^[0-9]+$ ]] || [ ! "$userinput" -gt 0 ] || [ ! "$userinput" -le ${#modules[@]} ] && [[ ! "$userinput" =~ ^[Aa]$ ]]; do
260
      read -p "your selection: " -e userinput
261
      printLog "user selection: $userinput\n"
262
      if [[ ! "$userinput" =~ ^[0-9]+$ ]] || [ ! "$userinput" -gt 0 ] || [ ! "$userinput" -le ${#modules[@]} ] && [[ ! "$userinput" =~ ^[Aa]$ ]]; then
263
        printWarning "Please enter an integer between 1 and ${#modules[@]} or 'A' to abort.\n"
264
      fi
265
    done
266
    if [[ "$userinput" =~ ^[Aa]$ ]]; then
267
      printWarning "aborted by user\n"
268
      return 1
269
    fi
270
    # store selection
271
    moduleidx=$(($userinput - 1))
272
    module="${modules[$moduleidx]}"
273
    printf "\n"
274
  else
275
    # search all modules for the selected one
276
    for (( idx=0; idx<${#modules[@]}; ++idx )); do
277
      if [ "${modules[$idx]}" = "$module" ]; then
278
        moduleidx=$idx
279
        break
280
      fi
281
    done
282
    # error if the module could not be found
283
    if [ -z $moduleidx ]; then
284
      printError "module ($module) not available\n"
285
      return -2
286
    fi
287
  fi
288

    
289
  # read absolute project directory if required
290
  if [ -z "$projectdir" ]; then
291
    getProjectDir projectdir
292
    printf "\n"
293
  fi
294

    
295
  # check for existing project files
296
  local projectfiles="$(find ${projectdir} -maxdepth 1 -type f | grep -E "${module}\.(includes|files|config|creator)$")"
297
  IFS=$'\n'; projectfiles=($projectfiles); unset IFS
298
  if [ ! -z "${projectfiles[*]}" ]; then
299
    printWarning "The following files will be overwritten:\n"
300
    for pfile in ${projectfiles[@]}; do
301
      printWarning "\t$(basename $pfile)\n"
302
    done
303
    local userinput=""
304
    printInfo "Continue and overwrite? [y/n]\n"
305
    readUserInput "YyNn" userinput
306
    case "$userinput" in
307
      Y|y)
308
        ;;
309
      N|n)
310
        printWarning "Project generation for ${module} module aborted by user\n"
311
        return 1
312
        ;;
313
      *)
314
        printError "unexpected input: ${userinput}\n"; return -999;;
315
    esac
316
    printf "\n"
317
  fi
318

    
319
  # print message
320
  printInfo "generating QtCreator project files for the $module module...\n"
321

    
322
  # retrieve absolute GCC include path
323
  if [ -z "$gccincludedir" ]; then
324
    retrieveGccIncludeDir gccincludedir
325
  fi
326

    
327
  # change to project directory
328
  local amirobltrootdir=$(realpath $(dirname ${BASH_SOURCE[0]})/../../..)
329
  cd "$projectdir"
330

    
331
  # run make, but only run the GCC preprocessor and produce no binaries
332
  local sourcefiles=()
333
  local sourcefile=""
334
  local parse_state="WAIT_FOR_INCLUDE_OR_COMPILE"
335
  # capture all output from make and GCC and append the return value of make as last line
336
  printInfo "processing project (this may take a while)...\n"
337
  local rawout=$(make --directory ${amirobltrootdir}/Target/Modules/${module}/Boot --always-make USER_CFLAGS="-v -H" 2>&1 && echo $?)
338
  # check whether the make call was successfull
339
  if [[ $(echo "${rawout}" | tail -n 1) != "0" ]]; then
340
    printError "executing 'make' in module directory failed\n"
341
    cd "$userdir"
342
    return -3
343
  fi
344
  # extract file names from raw output
345
  IFS=$'\n'; rawout=($rawout); unset IFS
346
  for line in "${rawout[@]}"; do
347
    case $parse_state in
348
      WAIT_FOR_INCLUDE_OR_COMPILE)
349
        # lines stating included files look like:
350
        # ... <../relative/path/to/file>
351
        if [[ "$line" =~ ^\.+[[:blank:]].+\..+$ ]]; then
352
          sourcefile=${line##* }
353
          if [[ ! "$sourcefile" =~ ^/ ]]; then
354
            sourcefile=$(realpath ${amirobltrootdir}/Target/Modules/${module}/Boot/${sourcefile})
355
          fi
356
          sourcefiles[${#sourcefiles[@]}]="$sourcefile"
357
        # whenever the next source file is processed, a message appears like:
358
        # Compiling <filename>
359
        elif [[ "$line" =~ ^\+\+\+[[:blank:]]Compiling[[:blank:]]\[(.+\.c)\]$ ]]; then
360
          printf "."
361
          sourcefile=${BASH_REMATCH[1]}
362
          parse_state="WAIT_FOR_COMPILERCALL"
363
        fi;;
364
      WAIT_FOR_COMPILERCALL)
365
        # wait for the actual call of the compiler to retrieve the full path to the source file
366
        if [[ "$line" == *${sourcefile}* ]]; then
367
          line="${line%%${sourcefile}*}${sourcefile}"
368
          sourcefile=$(realpath ${amirobltrootdir}/Target/Modules/${module}/Boot/${line##* })
369
          sourcefiles[${#sourcefiles[@]}]="$sourcefile"
370
          parse_state="WAIT_FOR_INCLUDE_OR_COMPILE"
371
        fi;;
372
    esac
373
  done
374
  unset rawout
375
  printf "\n"
376
  # sort and remove duplicates
377
  IFS=$'\n'; sourcefiles=($(sort --unique <<< "${sourcefiles[*]}")); unset IFS
378

    
379
  # extract include paths
380
  local includes=()
381
  for source in ${sourcefiles[*]}; do
382
    includes[${#includes[@]}]="$(dirname ${source})"
383
  done
384
  # sort and remove duplicates
385
  IFS=$'\n'; includes=($(sort --unique <<< "${includes[*]}")); unset IFS
386

    
387
  # generate the .incldues file, containing all include paths
388
  echo "" > ${projectdir}/${module}.includes
389
  for inc in ${includes[*]}; do
390
    echo "$inc" >> ${projectdir}/${module}.includes
391
  done
392
  # generate the .files file, containing all source files
393
  echo "" > ${projectdir}/${module}.files
394
  for source in ${sourcefiles[*]}; do
395
    # skip GCC files
396
    if [[ ! "$source" =~ .*/gcc.* ]]; then
397
      echo "$source" >> ${projectdir}/${module}.files
398
    fi
399
  done
400
  # generate a default project configuration file if it doesn't exist yet
401
  if [ ! -f ${projectdir}/${module}.config ]; then
402
    echo "// Add predefined macros for your project here. For example:" > ${projectdir}/${module}.config
403
    echo "// #define YOUR_CONFIGURATION belongs here" >> ${projectdir}/${module}.config
404
  fi
405
  # generate a default .creator file if it doesn't exist yet
406
  if [ ! -f ${projectdir}/${module}.creator ]; then
407
    echo "[general]" > ${projectdir}/${module}.creator
408
  fi
409

    
410
  # go back to user directory
411
  cd $userdir
412

    
413
  # fill the output variables
414
  if [ ! -z "$outvar" ]; then
415
    eval $outvar="$projectdir"
416
  fi
417
  if [ ! -z "$gccoutvar" ]; then
418
    eval $gccoutvar="$gccincludedir"
419
  fi
420

    
421
  return 0
422
}
423

    
424
### create project files for all modules #######################################
425
# Create project files for all modules.
426
#
427
# usage:      createAllProjects <modules> [-p|--path=<path>] [--gcc=<path>] [-o|--out=<var>] [--gccout=<var>]
428
# arguments:  <modules>
429
#                 Array containing all modules available.
430
#             -p, --path <path>
431
#                 Path where to create the project files.
432
#             --gcc=<path>
433
#                 Path to the GCC include directory.
434
#             -o, --out <var>
435
#                 Variable to store the path to.
436
#             --gccout=<var>
437
#                 Variable to store the path to the GCC include directory to.
438
#                 If this optional arguments is absent, ths function will ask for user input.
439
# return:     0
440
#                 No error or warning occurred.
441
#             1
442
#                 Aborted by user.
443
#             -1
444
#                 No modules available.
445
#
446
function createAllProjects {
447
  local modules=("${!1}")
448
  local projectsdir=""
449
  local gccincludedir=""
450
  local outvar=""
451
  local gccoutvar=""
452

    
453
  # parse arguments
454
  local otherargs=()
455
  while [ $# -gt 0 ]; do
456
    if ( parseIsOption $1 ); then
457
      case "$1" in
458
        -p=*|--path=*)
459
          projectsdir=$(realpath "${1#*=}"); shift 1;;
460
        -p|--path)
461
          projectsdir=$(realpath "$2"); shift 2;;
462
        --gcc=*)
463
          gccincludedir=$(realpath "${1#*=}"); shift 1;;
464
        --gcc)
465
          gccincludedir=$(realpath "$2"); shift 2;;
466
        -o=*|--out=*)
467
          outvar=${1#*=}; shift 1;;
468
        -o|--out)
469
          outvar=$2; shift 2;;
470
        --gccout=*)
471
          gccoutvar=$(realpath "${1#*=}"); shift 1;;
472
        --gccout)
473
          gccoutvar=$(realpath "$2"); shift 2;;
474
        *)
475
          printError "invalid option: $1\n"; shift 1;;
476
      esac
477
    else
478
      otherargs+=("$1")
479
      shift 1
480
    fi
481
  done
482

    
483
  # sanity check for the modules variable
484
  if [ -z "${modules[*]}" ]; then
485
    printError "no modules available\n"
486
    return -1
487
  fi
488

    
489
  # read absolute project directory if required
490
  if [ -z "$projectsdir" ]; then
491
    getProjectDir projectsdir
492
  fi
493

    
494
  # check for existing project files
495
  local projectfiles=""
496
  for module in ${modules[@]}; do
497
    projectfiles+="$(find ${projectsdir} -maxdepth 1 -type f | grep -E "${module}\.(includes|files|config|creator)$")"
498
  done
499
  IFS=$'\n'; projectfiles=($projectfiles); unset IFS
500
  if [ ! -z "${projectfiles[*]}" ]; then
501
    printWarning "The following files will be removed:\n"
502
    for pfile in ${projectfiles[@]}; do
503
      printWarning "\t$(basename $pfile)\n"
504
    done
505
    local userinput=""
506
    printInfo "Continue and overwrite? [y/n]\n"
507
    readUserInput "YyNn" userinput
508
    case "${userinput}" in
509
      Y|y)
510
        for pfile in ${projectfiles[*]}; do
511
          rm "$pfile"
512
        done
513
        ;;
514
      N|n)
515
        printWarning "Project generation aborted by user\n"
516
        return 1
517
        ;;
518
      *)
519
        printError "unexpected input: ${userinput}\n"
520
        return 999
521
        ;;
522
    esac
523
  fi
524

    
525
  # print message
526
  printf "\n"
527
  printInfo "generating QtCreator project files for all modules...\n"
528

    
529
  # retrieve absolute GCC include path
530
  if [ -z "$gccincludedir" ]; then
531
    retrieveGccIncludeDir gccincludedir
532
  fi
533

    
534
  # iterate over all modules
535
  local retval=1
536
  for module in ${modules[@]}; do
537
    if [ $retval != 0 ]; then
538
      printf "\n"
539
    fi
540
    createModuleProject modules[@] --module="$module" --path="$projectsdir" --gcc="$gccincludedir"
541
    retval=$?
542
  done
543

    
544
  return 0
545
}
546

    
547
### delete project files #######################################################
548
# Deletes all project files and optionally .user files, too.
549
#
550
# usage:      deleteProjects [-p|--path=<path>] [-m|--module=<module>] [-o|--out=<var>] [-w|-wipe]
551
# arguments:  -p, --path <path>
552
#                 Path where to delete the project files.
553
#             -m, --module <module>
554
#                 Module name for which the project files shall be deleted.
555
#             -o, --out <var>
556
#                 Variable to store the path to.
557
#             -w, --wipe
558
#                 Delete .user files as well.
559
# return:
560
#  -  0: no error
561
#
562
function deleteProjects {
563
  local modulename=""
564
  local projectdir=""
565
  local outvar=""
566
  local wipe=false
567
  local files=""
568

    
569
  # parse arguments
570
  local otherargs=()
571
  while [ $# -gt 0 ]; do
572
    if ( parseIsOption $1 ); then
573
      case "$1" in
574
        -p=*|--path=*)
575
          projectdir=$(realpath "${1#*=}"); shift 1;;
576
        -p|--path)
577
          projectdir=$(realpath "$2"); shift 2;;
578
        -m=*|--module=*)
579
          modulename="${1#*=}"; shift 1;;
580
        -m|--module)
581
          modulename="${2}"; shift 2;;
582
        -o=*|--out=*)
583
          outvar=${1#*=}; shift 1;;
584
        -o|--out)
585
          outvar=$2; shift 2;;
586
        -w|--wipe)
587
          wipe=true; shift 1;;
588
        *)
589
          printError "invalid option: $1\n"; shift 1;;
590
      esac
591
    else
592
      otherargs+=("$1")
593
      shift 1
594
    fi
595
  done
596

    
597
  # read absolute project directory if required
598
  if [ -z "$projectdir" ]; then
599
    getProjectDir projectdir
600
  fi
601

    
602
  # list all files to be deleted
603
  if [ -z "$modulename" ]; then
604
    if [ $wipe != true ]; then
605
      files=$(find "${projectdir}" -maxdepth 1 -type f | grep -E "^.+\.(includes|files|config|creator|cflags|cxxflags)$")
606
    else
607
      files=$(find "${projectdir}" -maxdepth 1 -type f | grep -E "^.+\.(includes|files|config|creator|cflags|cxxflags|creator(\.user(\..+)?)?)$")
608
    fi
609
  else
610
    if [ $wipe != true ]; then
611
      files=$(find "${projectdir}" -maxdepth 1 -type f | grep -E "^${modulename}\.(includes|files|config|creator|cflags|cxxflags)$")
612
    else
613
      files=$(find "${projectdir}" -maxdepth 1 -type f | grep -E "^${modulename}\.(includes|files|config|creator|cflags|cxxflags|creator(\.user(\..+)?)?)$")
614
    fi
615
  fi
616
  if [ ! -z "$files" ]; then
617
    printInfo "Deleting the following files:\n"
618
    while read line; do
619
      printInfo "\t$(basename ${line})\n"
620
      rm ${line} 2>&1 | tee -a $LOG_FILE
621
    done <<< "${files}"
622
  else
623
    printInfo "No project files found\n"
624
  fi
625

    
626
  # store the path to the output variable, if required
627
  if [ ! -z "$outvar" ]; then
628
    eval $outvar="$projectdir"
629
  fi
630

    
631
  return 0
632
}
633

    
634
### main function of this script ###############################################
635
# Creates, deletes and wipes QtCreator project files for any module supported by AMiRo-OS.
636
#
637
# usage:      see function printHelp
638
# arguments:  see function printHelp
639
# return:     0
640
#                 No error or warning ocurred.
641
#
642
function main {
643
# print welcome/info text if not suppressed
644
  if [[ $@ != *"--noinfo"* ]]; then
645
    printWelcomeText
646
  else
647
    printf "######################################################################\n"
648
  fi
649
  printf "\n"
650

    
651
  # if --help or -h was specified, print the help text and exit
652
  if [[ $@ == *"--help"* || $@ == *"-h"* ]]; then
653
    printHelp
654
    printf "\n"
655
    quitScript
656
  fi
657

    
658
  # set log file if specified
659
  if [[ $@ == *"--log"* ]] || [[ $@ == *"--LOG"* ]]; then
660
    # get the parameter (file name)
661
    local cmdidx=1
662
    while [[ ! "${!cmdidx}" = "--log"* ]] && [[ ! "${!cmdidx}" = "--LOG"* ]]; do
663
      cmdidx=$[cmdidx + 1]
664
    done
665
    local cmd="${!cmdidx}"
666
    local logfile=""
667
    if [[ "$cmd" = "--log="* ]] || [[ "$cmd" = "--LOG="* ]]; then
668
      logfile=${cmd#*=}
669
    else
670
      local filenameidx=$((cmdidx + 1))
671
      logfile="${!filenameidx}"
672
    fi
673
    # optionally force silent appending
674
    if [[ "$cmd" = "--LOG"* ]]; then
675
      setLogFile --option=c --quiet "$logfile" LOG_FILE
676
    else
677
      setLogFile "$logfile" LOG_FILE
678
      printf "\n"
679
    fi
680
  fi
681
  # log script name
682
  printLog "this is $(realpath ${BASH_SOURCE[0]})\n"
683

    
684
  # detect available modules and inform user
685
  local modules=()
686
  detectModules modules
687
  case "${#modules[@]}" in
688
    0)
689
      printInfo "no module has been detected\n";;
690
    1)
691
      printInfo "1 module has been detected:\n";;
692
    *)
693
      printInfo "${#modules[@]} modules have been detected:\n"
694
  esac
695
  for (( idx=0; idx<${#modules[@]}; ++idx )); do
696
    printInfo "  - ${modules[$idx]}\n"
697
  done
698
  printf "\n"
699

    
700
  # parse arguments
701
  local otherargs=()
702
  while [ $# -gt 0 ]; do
703
    if ( parseIsOption $1 ); then
704
      case "$1" in
705
        -h|--help) # already handled; ignore
706
          shift 1;;
707
        -m=*|--module=*)
708
          createModuleProject modules[@] --module="${1#*=}"; printf "\n"; shift 1;;
709
        -m|--module)
710
          createModuleProject modules[@] --module="${2}"; printf "\n"; shift 2;;
711
        -a|--all)
712
          createAllProjects modules[@]; shift 1;;
713
        -c|--clean)
714
          deleteProjects; printf "\n"; shift 1;;
715
        -w|--wipe)
716
          deleteProjects --wipe; printf "\n"; shift 1;;
717
        -q|--quit)
718
          quitScript; shift 1;;
719
        --log=*|--LOG=*) # already handled; ignore
720
          shift 1;;
721
        --log|--LOG) # already handled; ignore
722
          shift 2;;
723
        --noinfo) # already handled; ignore
724
          shift 1;;
725
        *)
726
          printError "invalid option: $1\n"; shift 1;;
727
      esac
728
    else
729
      otherargs+=("$1")
730
      shift 1
731
    fi
732
  done
733

    
734
  # interactive menu
735
  while ( true ); do
736
    # main menu info prompt and selection
737
    printInfo "QtCreator setup main menu\n"
738
    printf "Please select one of the following actions:\n"
739
    printf "  [M] - create a project for a single module\n"
740
    printf "  [A] - create a project for all modules\n"
741
    printf "  [C] - clean all project files\n"
742
    printf "  [W] - wipe all project and .user files\n"
743
    printf "  [Q] - quit this setup\n"
744
    local userinput=""
745
    readUserInput "MmAaCcWwQq" userinput
746
    printf "\n"
747

    
748
    # evaluate user selection
749
    case "$userinput" in
750
      M|m)
751
        createModuleProject modules[@]; printf "\n";;
752
      A|a)
753
        createAllProjects modules[@]; printf "\n";;
754
      C|c)
755
        deleteProjects; printf "\n";;
756
      W|w)
757
        deleteProjects --wipe; printf "\n";;
758
      Q|q)
759
        quitScript;;
760
      *) # sanity check (exit with error)
761
        printError "unexpected argument: $userinput\n";;
762
    esac
763
  done
764

    
765
  exit 0
766
}
767

    
768
################################################################################
769
# SCRIPT ENTRY POINT                                                           #
770
################################################################################
771

    
772
main "$@"
773