amiro-blt / ide / QtCreator / QtCreatorSetup.sh @ 4f07e80a
History | View | Annotate | Download (32.3 KB)
1 |
################################################################################ |
---|---|
2 |
# AMiRo-BLT is an bootloader and toolchain designed for the Autonomous Mini # |
3 |
# Robot (AMiRo) platform. # |
4 |
# Copyright (C) 2016..2018 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', 'c', 'r' and 'n'. |
173 |
# - a: append (starts with a separator) |
174 |
# - c: continue (does not insert a seperator) |
175 |
# - 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 |
a|c) |
231 |
if [ $quiet = false ]; then |
232 |
printInfo "appending log to $filepath\n" |
233 |
fi |
234 |
if [ $option != c ]; then |
235 |
printf "\n" >> $filepath |
236 |
printf "######################################################################\n" >> $filepath |
237 |
printf "\n" >> $filepath |
238 |
fi |
239 |
;; |
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 |
################################################################################ |
267 |
# SPECIFIC FUNCTIONS # |
268 |
################################################################################ |
269 |
|
270 |
### print welcome text ######################################################### |
271 |
# Prints a welcome message to standard out. |
272 |
# |
273 |
# usage: printWelcomeText |
274 |
# arguments: n/a |
275 |
# return: n/a |
276 |
# |
277 |
function printWelcomeText { |
278 |
printf "######################################################################\n" |
279 |
printf "# #\n" |
280 |
printf "# Welcome to the QtCreator setup! #\n" |
281 |
printf "# #\n" |
282 |
printf "######################################################################\n" |
283 |
printf "# #\n" |
284 |
printf "# Copyright (c) 2016..2018 Thomas Schöpping #\n" |
285 |
printf "# #\n" |
286 |
printf "# This is free software; see the source for copying conditions. #\n" |
287 |
printf "# There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR #\n" |
288 |
printf "# A PARTICULAR PURPOSE. The development of this software was #\n" |
289 |
printf "# supported by the Excellence Cluster EXC 227 Cognitive Interaction #\n" |
290 |
printf "# Technology. The Excellence Cluster EXC 227 is a grant of the #\n" |
291 |
printf "# Deutsche Forschungsgemeinschaft (DFG) in the context of the German #\n" |
292 |
printf "# Excellence Initiative. #\n" |
293 |
printf "# #\n" |
294 |
printf "######################################################################\n" |
295 |
} |
296 |
|
297 |
### print help ################################################################# |
298 |
# Prints a help text to standard out. |
299 |
# |
300 |
# usage: printHelp |
301 |
# arguments: n/a |
302 |
# return: n/a |
303 |
# |
304 |
function printHelp { |
305 |
printInfo "printing help text\n" |
306 |
printf "usage: $(basename ${BASH_SOURCE[0]}) [-h|--help] [-c|--clean] [-w|--wipe] [--LightRing] [--PowerManagement] [--DiWheelDrive] [-a|--all] [-q|--quit] [--log=<file>]\n" |
307 |
printf "\n" |
308 |
printf "options: -h, --help\n" |
309 |
printf " Print this help text.\n" |
310 |
printf " -c, --clean\n" |
311 |
printf " Delete project files.\n" |
312 |
printf " -w, --wipe\n" |
313 |
printf " Delete project and .user files.\n" |
314 |
printf " --LightRing\n" |
315 |
printf " Create project for the LightRing module.\n" |
316 |
printf " --PowerManagement\n" |
317 |
printf " Create project for the PowerManagement module.\n" |
318 |
printf " --DiWheelDrive\n" |
319 |
printf " Create project for the DiWheelDrive module.\n" |
320 |
printf " -a, --all\n" |
321 |
printf " Create projects for all modules.\n" |
322 |
printf " -q, --quit\n" |
323 |
printf " Quit the script.\n" |
324 |
printf " --log=<file>\n" |
325 |
printf " Specify a log file.\n" |
326 |
} |
327 |
|
328 |
### read directory where to create/delete projects ############################# |
329 |
# Read the directory where to create/delete project files from user. |
330 |
# |
331 |
# usage: getProjectDir <pathvar> |
332 |
# arguments: <pathvar> |
333 |
# Variable to store the selected path to. |
334 |
# return: n/a |
335 |
# |
336 |
function getProjectDir { |
337 |
printLog "reading path for project files from user...\n" |
338 |
local amirobltdir=$(realpath $(dirname $(realpath ${BASH_SOURCE[0]}))/../../Target/) |
339 |
local input="" |
340 |
read -p "Path where to create/delete project files: " -i $amirobltdir -e input |
341 |
printLog "user selected path $(realpath $input)\n" |
342 |
eval $1="$(realpath $input)" |
343 |
} |
344 |
|
345 |
### retrieves the ARM-NONE-EABI-GCC include directory ########################## |
346 |
# Retrieves the include directory of the currently set arm-none-eabi-gcc. |
347 |
# |
348 |
# usage: retrieveGccIncludeDir <path> |
349 |
# arguments: <path> |
350 |
# Variable to store the path to. |
351 |
# return: 0 |
352 |
# No error or warning occurred. |
353 |
# -1 |
354 |
# Error: Command 'arm-none-eabi-gcc' not found. |
355 |
# |
356 |
function retrieveGccIncludeDir { |
357 |
# retrieve binary path or link |
358 |
local binpath=$(which arm-none-eabi-gcc) |
359 |
if [ -z "$binpath" ]; then |
360 |
printError "command 'arm-none-eabi-gcc' not found\n" |
361 |
return -1 |
362 |
else |
363 |
|
364 |
# traverse any links |
365 |
while [ -L "$binpath" ]; do |
366 |
binpath=$(readlink $binpath) |
367 |
done |
368 |
printInfo "gcc-arm-none-eabi detected: $binpath\n" |
369 |
|
370 |
# return include path |
371 |
eval $1=$(realpath $(dirname ${binpath})/../arm-none-eabi/include/) |
372 |
|
373 |
return 0 |
374 |
fi |
375 |
} |
376 |
|
377 |
### delete project files ####################################################### |
378 |
# Deletes all project files and optionally .user files, too. |
379 |
# |
380 |
# usage: deleteProjects [-p|--path=<path>] [-o|--out=<var>] [-w|-wipe] |
381 |
# arguments: -p, --path <path> |
382 |
# Path where to delete the project files. |
383 |
# -o, --out <var> |
384 |
# Variable to store the path to. |
385 |
# -w, --wipe |
386 |
# Delete .user files as well. |
387 |
# return: |
388 |
# - 0: no error |
389 |
# - 1: warning: function aborted by user |
390 |
# - -1: error: unexpected user input |
391 |
function deleteProjects { |
392 |
local projectdir="" |
393 |
local outvar="" |
394 |
local wipe=false |
395 |
|
396 |
# parse arguments |
397 |
local otherargs=() |
398 |
while [ $# -gt 0 ]; do |
399 |
if ( parseIsOption $1 ); then |
400 |
case "$1" in |
401 |
-p=*|--path=*) |
402 |
projectdir=$(realpath "${1#*=}"); shift 1;; |
403 |
-p|--path) |
404 |
projectdir=$(realpath "$2"); shift 2;; |
405 |
-o=*|--out=*) |
406 |
outvar=${1#*=}; shift 1;; |
407 |
-o|--out) |
408 |
outvar=$2; shift 2;; |
409 |
-w|--wipe) |
410 |
wipe=true; shift 1;; |
411 |
*) |
412 |
printError "invalid option: $1\n"; shift 1;; |
413 |
esac |
414 |
else |
415 |
otherargs+=("$1") |
416 |
shift 1 |
417 |
fi |
418 |
done |
419 |
|
420 |
# print message |
421 |
if [ $wipe != true ]; then |
422 |
printInfo "deleting all QtCreator project files (*.includes, *.files, *.config, and *.creator)\n" |
423 |
else |
424 |
printInfo "deleting all QtCreator project files (*.includes, *.files, *.config, *.creator, and *.user)\n" |
425 |
fi |
426 |
|
427 |
# read project directory if required |
428 |
if [ -z "$projectdir" ]; then |
429 |
getProjectDir projectdir |
430 |
fi |
431 |
|
432 |
# remove all project files |
433 |
rm ${projectdir}/LightRing.includes 2>&1 | tee -a $LOG_FILE |
434 |
rm ${projectdir}/PowerManagement.includes 2>&1 | tee -a $LOG_FILE |
435 |
rm ${projectdir}/DiWheelDrive.includes 2>&1 | tee -a $LOG_FILE |
436 |
|
437 |
rm ${projectdir}/LightRing.files 2>&1 | tee -a $LOG_FILE |
438 |
rm ${projectdir}/PowerManagement.files 2>&1 | tee -a $LOG_FILE |
439 |
rm ${projectdir}/DiWheelDrive.files 2>&1 | tee -a $LOG_FILE |
440 |
|
441 |
rm ${projectdir}/LightRing.config 2>&1 | tee -a $LOG_FILE |
442 |
rm ${projectdir}/PowerManagement.config 2>&1 | tee -a $LOG_FILE |
443 |
rm ${projectdir}/DiWheelDrive.config 2>&1 | tee -a $LOG_FILE |
444 |
|
445 |
rm ${projectdir}/LightRing.creator 2>&1 | tee -a $LOG_FILE |
446 |
rm ${projectdir}/PowerManagement.creator 2>&1 | tee -a $LOG_FILE |
447 |
rm ${projectdir}/DiWheelDrive.creator 2>&1 | tee -a $LOG_FILE |
448 |
|
449 |
if [ $wipe == true ]; then |
450 |
rm ${projectdir}/LightRing.user 2>&1 | tee -a $LOG_FILE |
451 |
rm ${projectdir}/PowerManagement.user 2>&1 | tee -a $LOG_FILE |
452 |
rm ${projectdir}/DiWheelDrive.user 2>&1 | tee -a $LOG_FILE |
453 |
fi |
454 |
|
455 |
# store the path to the output variable, if required |
456 |
if [ ! -z "$outvar" ]; then |
457 |
eval $outvar="$projectdir" |
458 |
fi |
459 |
|
460 |
return 0 |
461 |
} |
462 |
|
463 |
### create LightRing project files ############################################# |
464 |
# Create project files for the LightRing module. |
465 |
# |
466 |
# usage: createLightRingProject [-p|--path=<path>] [--gcc=<path>] [-o|--out=<var>] [--gccout=<var>] |
467 |
# arguments: -p, --path <path> |
468 |
# Path where to create the project files. |
469 |
# --gcc=<path> |
470 |
# Path to the GCC include directory. |
471 |
# -o, --out <var> |
472 |
# Variable to store the path to. |
473 |
# --gccout=<var> |
474 |
# Variable to store the path to the GCC include directory to. |
475 |
# return: 0 |
476 |
# No error or warning occurred. |
477 |
# |
478 |
function createLightRingProject { |
479 |
local userdir=$(pwd) |
480 |
local projectdir="" |
481 |
local gccincludedir="" |
482 |
local outvar="" |
483 |
local gccoutvar="" |
484 |
|
485 |
# parse arguments |
486 |
local otherargs=() |
487 |
while [ $# -gt 0 ]; do |
488 |
if ( parseIsOption $1 ); then |
489 |
case "$1" in |
490 |
-p=*|--path=*) |
491 |
projectdir=$(realpath "${1#*=}"); shift 1;; |
492 |
-p|--path) |
493 |
projectdir=$(realpath "$2"); shift 2;; |
494 |
--gcc=*) |
495 |
gccincludedir=$(realpath "${1#*=}"); shift 1;; |
496 |
--gcc) |
497 |
gccincludedir=$(realpath "$2"); shift 2;; |
498 |
-o=*|--out=*) |
499 |
outvar=${1#*=}; shift 1;; |
500 |
-o|--out) |
501 |
outvar=$2; shift 2;; |
502 |
--gccout=*) |
503 |
gccoutvar=$(realpath "${1#*=}"); shift 1;; |
504 |
--gccout) |
505 |
gccoutvar=$(realpath "$2"); shift 2;; |
506 |
*) |
507 |
printError "invalid option: $1\n"; shift 1;; |
508 |
esac |
509 |
else |
510 |
otherargs+=("$1") |
511 |
shift 1 |
512 |
fi |
513 |
done |
514 |
|
515 |
# print message |
516 |
printInfo "creating QtCreator project files for the LightRing module...\n" |
517 |
|
518 |
# read absolute project directory if required |
519 |
if [ -z "$projectdir" ]; then |
520 |
getProjectDir projectdir |
521 |
fi |
522 |
|
523 |
# retrieve absolute GCC include dir |
524 |
if [ -z "$gccincludedir" ]; then |
525 |
retrieveGccIncludeDir gccincludedir |
526 |
fi |
527 |
|
528 |
# move to project directory |
529 |
cd $projectdir |
530 |
|
531 |
# create project files |
532 |
# generate a file that contains all subdirectories as includes (but ignore hidden and documentation directories) |
533 |
find $gccincludedir -type d > ${projectdir}/LightRing.includes |
534 |
find $(realpath --relative-base=$projectdir $(dirname ${BASH_SOURCE[0]})/../../Target/Source) -type d | grep -v "ARMCM4_STM32" >> ${projectdir}/LightRing.includes |
535 |
find $(realpath --relative-base=$projectdir $(dirname ${BASH_SOURCE[0]})/../../Target/Demo/ARMCM3_STM32F103_LightRing_GCC/Boot) -type d | grep -v "bin\|cmd\|ethernetlib\|fatfs\|uip\|obj" >> ${projectdir}/LightRing.includes |
536 |
# generate a file that specifies all files |
537 |
echo -n "" > ${projectdir}/LightRing.files |
538 |
for path in `cat ${projectdir}/LightRing.includes`; do |
539 |
find $path -maxdepth 1 -type f \( ! -iname ".*" \) | grep -v "/arm-none-eabi/" | grep -E ".*(\.h|\.c|\.x)$" >> ${projectdir}/LightRing.files |
540 |
done |
541 |
# generate a default project configuration file if none exists so far |
542 |
if [ ! -f ${projectdir}/LightRing.config ]; then |
543 |
echo -e "// Add predefined macros for your project here. For example:" > ${projectdir}/LightRing.config |
544 |
echo -e "// #define YOUR_CONFIGURATION belongs here" >> ${projectdir}/LightRing.config |
545 |
echo -e "" >> ${projectdir}/LightRing.config |
546 |
fi |
547 |
# generate a default .creator file if none exists so far |
548 |
if [ ! -f ${projectdir}/LightRing.creator ]; then |
549 |
echo -e "[general]" > ${projectdir}/LightRing.creator |
550 |
echo -e "" >> ${projectdir}/LightRing.creator |
551 |
fi |
552 |
|
553 |
# go back to user directory |
554 |
cd $userdir |
555 |
|
556 |
# fill the output variables |
557 |
if [ ! -z "$outvar" ]; then |
558 |
eval $outvar="$projectdir" |
559 |
fi |
560 |
if [ ! -z "$gccoutvar" ]; then |
561 |
eval $gccoutvar="$gccincludedir" |
562 |
fi |
563 |
|
564 |
return 0 |
565 |
} |
566 |
|
567 |
### create PowerManagement project files ####################################### |
568 |
# Create project files for the PowerManagement module. |
569 |
# |
570 |
# usage: createPowerManagementProject [-p|--path=<path>] [--gcc=<path>] [-o|--out=<var>] [--gccout=<var>] |
571 |
# arguments: -p, --path <path> |
572 |
# Path where to create the project files. |
573 |
# --gcc=<path> |
574 |
# Path to the GCC include directory. |
575 |
# -o, --out <var> |
576 |
# Variable to store the path to. |
577 |
# --gccout=<var> |
578 |
# Variable to store the path to the GCC include directory to. |
579 |
# return: 0 |
580 |
# No error or warning occurred. |
581 |
# |
582 |
function createPowerManagementProject { |
583 |
local userdir=$(pwd) |
584 |
local projectdir="" |
585 |
local gccincludedir="" |
586 |
local outvar="" |
587 |
local gccoutvar="" |
588 |
|
589 |
# parse arguments |
590 |
local otherargs=() |
591 |
while [ $# -gt 0 ]; do |
592 |
if ( parseIsOption $1 ); then |
593 |
case "$1" in |
594 |
-p=*|--path=*) |
595 |
projectdir=$(realpath "${1#*=}"); shift 1;; |
596 |
-p|--path) |
597 |
projectdir=$(realpath "$2"); shift 2;; |
598 |
--gcc=*) |
599 |
gccincludedir=$(realpath "${1#*=}"); shift 1;; |
600 |
--gcc) |
601 |
gccincludedir=$(realpath "$2"); shift 2;; |
602 |
-o=*|--out=*) |
603 |
outvar=${1#*=}; shift 1;; |
604 |
-o|--out) |
605 |
outvar=$2; shift 2;; |
606 |
--gccout=*) |
607 |
gccoutvar=$(realpath "${1#*=}"); shift 1;; |
608 |
--gccout) |
609 |
gccoutvar=$(realpath "$2"); shift 2;; |
610 |
*) |
611 |
printError "invalid option: $1\n"; shift 1;; |
612 |
esac |
613 |
else |
614 |
otherargs+=("$1") |
615 |
shift 1 |
616 |
fi |
617 |
done |
618 |
|
619 |
# print message |
620 |
printInfo "creating QtCreator project files for the PowerManagement module...\n" |
621 |
|
622 |
# read absolute project directory if required |
623 |
if [ -z "$projectdir" ]; then |
624 |
getProjectDir projectdir |
625 |
fi |
626 |
|
627 |
# retrieve absolute GCC include dir |
628 |
if [ -z "$gccincludedir" ]; then |
629 |
retrieveGccIncludeDir gccincludedir |
630 |
fi |
631 |
|
632 |
# move to project directory |
633 |
cd $projectdir |
634 |
|
635 |
# create project files |
636 |
# generate a file that contains all subdirectories as includes (but ignore hidden and documentation directories) |
637 |
find $gccincludedir -type d > ${projectdir}/PowerManagement.includes |
638 |
find $(realpath --relative-base=$projectdir $(dirname ${BASH_SOURCE[0]})/../../Target/Source) -type d | grep -v "ARMCM4_STM32" >> ${projectdir}/PowerManagement.includes |
639 |
find $(realpath --relative-base=$projectdir $(dirname ${BASH_SOURCE[0]})/../../Target/Demo/ARMCM4_STM32F405_Power_Management_GCC/Boot) -type d | grep -v "bin\|cmd\|ethernetlib\|fatfs\|uip\|obj" >> ${projectdir}/PowerManagement.includes |
640 |
# generate a file that specifies all files |
641 |
echo -n "" > ${projectdir}/PowerManagement.files |
642 |
for path in `cat ${projectdir}/PowerManagement.includes`; do |
643 |
find $path -maxdepth 1 -type f \( ! -iname ".*" \) | grep -v "/arm-none-eabi/" | grep -E ".*(\.h|\.c|\.x)$" >> ${projectdir}/PowerManagement.files |
644 |
done |
645 |
# generate a default project configuration file if none exists so far |
646 |
if [ ! -f ${projectdir}/PowerManagement.config ]; then |
647 |
echo -e "// Add predefined macros for your project here. For example:" > ${projectdir}/PowerManagement.config |
648 |
echo -e "// #define YOUR_CONFIGURATION belongs here" >> ${projectdir}/PowerManagement.config |
649 |
echo -e "" >> ${projectdir}/PowerManagement.config |
650 |
fi |
651 |
# generate a default .creator file if none exists so far |
652 |
if [ ! -f ${projectdir}/PowerManagement.creator ]; then |
653 |
echo -e "[general]" > ${projectdir}/PowerManagement.creator |
654 |
echo -e "" >> ${projectdir}/PowerManagement.creator |
655 |
fi |
656 |
|
657 |
# go back to user directory |
658 |
cd $userdir |
659 |
|
660 |
|
661 |
# fill the output variables |
662 |
if [ ! -z "$outvar" ]; then |
663 |
eval $outvar="$projectdir" |
664 |
fi |
665 |
if [ ! -z "$gccoutvar" ]; then |
666 |
eval $gccoutvar="$gccincludedir" |
667 |
fi |
668 |
|
669 |
return 0 |
670 |
} |
671 |
|
672 |
### create DiWheelDrive project files ########################################## |
673 |
# Create project files for the DiWheelDrive module. |
674 |
# |
675 |
# usage: createDiWheelDriveProject [-p|--path=<path>] [--gcc=<path>] [-o|--out=<var>] [--gccout=<var>] |
676 |
# arguments: -p, --path <path> |
677 |
# Path where to create the project files. |
678 |
# --gcc=<path> |
679 |
# Path to the GCC include directory. |
680 |
# -o, --out <var> |
681 |
# Variable to store the path to. |
682 |
# --gccout=<var> |
683 |
# Variable to store the path to the GCC include directory to. |
684 |
# return: 0 |
685 |
# No error or warning occurred. |
686 |
# |
687 |
function createDiWheelDriveProject { |
688 |
local userdir=$(pwd) |
689 |
local projectdir="" |
690 |
local gccincludedir="" |
691 |
local outvar="" |
692 |
local gccoutvar="" |
693 |
|
694 |
# parse arguments |
695 |
local otherargs=() |
696 |
while [ $# -gt 0 ]; do |
697 |
if ( parseIsOption $1 ); then |
698 |
case "$1" in |
699 |
-p=*|--path=*) |
700 |
projectdir=$(realpath "${1#*=}"); shift 1;; |
701 |
-p|--path) |
702 |
projectdir=$(realpath "$2"); shift 2;; |
703 |
--gcc=*) |
704 |
gccincludedir=$(realpath "${1#*=}"); shift 1;; |
705 |
--gcc) |
706 |
gccincludedir=$(realpath "$2"); shift 2;; |
707 |
-o=*|--out=*) |
708 |
outvar=${1#*=}; shift 1;; |
709 |
-o|--out) |
710 |
outvar=$2; shift 2;; |
711 |
--gccout=*) |
712 |
gccoutvar=$(realpath "${1#*=}"); shift 1;; |
713 |
--gccout) |
714 |
gccoutvar=$(realpath "$2"); shift 2;; |
715 |
*) |
716 |
printError "invalid option: $1\n"; shift 1;; |
717 |
esac |
718 |
else |
719 |
otherargs+=("$1") |
720 |
shift 1 |
721 |
fi |
722 |
done |
723 |
|
724 |
# print message |
725 |
printInfo "creating QtCreator project files for the DiWheelDrive module...\n" |
726 |
|
727 |
# read absolute project directory if required |
728 |
if [ -z "$projectdir" ]; then |
729 |
getProjectDir projectdir |
730 |
fi |
731 |
|
732 |
# retrieve absolute GCC include dir |
733 |
if [ -z "$gccincludedir" ]; then |
734 |
retrieveGccIncludeDir gccincludedir |
735 |
fi |
736 |
|
737 |
# move to project directory |
738 |
cd $projectdir |
739 |
|
740 |
|
741 |
# create project files |
742 |
# generate a file that contains all subdirectories as includes (but ignore hidden and documentation directories) |
743 |
find $gccincludedir -type d > ${projectdir}/DiWheelDrive.includes |
744 |
find $(realpath --relative-base=$projectdir $(dirname ${BASH_SOURCE[0]})/../../Target/Source) -type d | grep -v "ARMCM4_STM32" >> ${projectdir}/DiWheelDrive.includes |
745 |
find $(realpath --relative-base=$projectdir $(dirname ${BASH_SOURCE[0]})/../../Target/Demo/ARMCM3_STM32F103_DiWheelDrive_GCC/Boot) -type d | grep -v "bin\|cmd\|ethernetlib\|fatfs\|uip\|obj" >> ${projectdir}/DiWheelDrive.includes |
746 |
# generate a file that specifies all files |
747 |
echo -n "" > ${projectdir}/DiWheelDrive.files |
748 |
for path in `cat ${projectdir}/DiWheelDrive.includes`; do |
749 |
find $path -maxdepth 1 -type f \( ! -iname ".*" \) | grep -v "/arm-none-eabi/" | grep -E ".*(\.h|\.c|\.x)$" >> ${projectdir}/DiWheelDrive.files |
750 |
done |
751 |
# generate a default project configuration file if none exists so far |
752 |
if [ ! -f ${projectdir}/DiWheelDrive.config ]; then |
753 |
echo -e "// Add predefined macros for your project here. For example:" > ${projectdir}/DiWheelDrive.config |
754 |
echo -e "// #define YOUR_CONFIGURATION belongs here" >> ${projectdir}/DiWheelDrive.config |
755 |
echo -e "" >> ${projectdir}/DiWheelDrive.config |
756 |
fi |
757 |
# generate a default .creator file if none exists so far |
758 |
if [ ! -f ${projectdir}/DiWheelDrive.creator ]; then |
759 |
echo -e "[general]" > ${projectdir}/DiWheelDrive.creator |
760 |
echo -e "" >> ${projectdir}/DiWheelDrive.creator |
761 |
fi |
762 |
|
763 |
# go back to user directory |
764 |
cd $userdir |
765 |
|
766 |
|
767 |
# fill the output variables |
768 |
if [ ! -z "$outvar" ]; then |
769 |
eval $outvar="$projectdir" |
770 |
fi |
771 |
if [ ! -z "$gccoutvar" ]; then |
772 |
eval $gccoutvar="$gccincludedir" |
773 |
fi |
774 |
|
775 |
return 0 |
776 |
} |
777 |
|
778 |
### create project files for al modules ######################################## |
779 |
# Create project files for all modules. |
780 |
# |
781 |
# usage: createAllProjects |
782 |
# arguments: n/a |
783 |
# return: 0 |
784 |
# No error or warning occurred. |
785 |
# |
786 |
function createAllProjects { |
787 |
# print message |
788 |
printInfo "creating QtCreator project files for the DiWheelDrive module...\n" |
789 |
|
790 |
# read project directory |
791 |
local projectdir="" |
792 |
getProjectDir projectdir |
793 |
printInfo "files will be created in $projectdir\n" |
794 |
|
795 |
# retrieve gcc-arm-none-eabi include dir |
796 |
retrieveGccIncludeDir gccincludedir |
797 |
|
798 |
# create projects |
799 |
createLightRingProject --path="$projectdir" --gcc="$gccincludedir" |
800 |
createPowerManagementProject --path="$projectdir" --gcc="$gccincludedir" |
801 |
createDiWheelDriveProject --path="$projectdir" --gcc="$gccincludedir" |
802 |
|
803 |
return 0 |
804 |
} |
805 |
|
806 |
### main function of this script ############################################### |
807 |
# Creates, deletes and wipes QtCreator project files for the three AMiRo base modules. |
808 |
# |
809 |
# usage: see function printHelp |
810 |
# arguments: see function printHelp |
811 |
# return: 0 |
812 |
# No error or warning ocurred. |
813 |
# |
814 |
function main { |
815 |
# print welcome/info text if not suppressed |
816 |
if [[ $@ != *"--noinfo"* ]]; then |
817 |
printWelcomeText |
818 |
else |
819 |
printf "######################################################################\n" |
820 |
fi |
821 |
printf "\n" |
822 |
|
823 |
# if --help or -h was specified, print the help text and exit |
824 |
if [[ $@ == *"--help"* || $@ == *"-h"* ]]; then |
825 |
printHelp |
826 |
printf "\n" |
827 |
quitScript |
828 |
fi |
829 |
|
830 |
# set log file if specified |
831 |
if [[ $@ == *"--log"* ]] || [[ $@ == *"--LOG"* ]]; then |
832 |
# get the parameter (file name) |
833 |
local cmdidx=1 |
834 |
while [[ ! "${!cmdidx}" = "--log"* ]] && [[ ! "${!cmdidx}" = "--LOG"* ]]; do |
835 |
cmdidx=$[cmdidx + 1] |
836 |
done |
837 |
local cmd="${!cmdidx}" |
838 |
local logfile="" |
839 |
if [[ "$cmd" = "--log="* ]] || [[ "$cmd" = "--LOG="* ]]; then |
840 |
logfile=${cmd#*=} |
841 |
else |
842 |
local filenameidx=$((cmdidx + 1)) |
843 |
logfile="${!filenameidx}" |
844 |
fi |
845 |
# optionally force silent appending |
846 |
if [[ "$cmd" = "--LOG"* ]]; then |
847 |
setLogFile --option=c --quiet "$logfile" LOG_FILE |
848 |
else |
849 |
setLogFile "$logfile" LOG_FILE |
850 |
printf "\n" |
851 |
fi |
852 |
fi |
853 |
# log script name |
854 |
printLog "this is $(realpath ${BASH_SOURCE[0]})\n" |
855 |
|
856 |
# parse arguments |
857 |
local otherargs=() |
858 |
while [ $# -gt 0 ]; do |
859 |
if ( parseIsOption $1 ); then |
860 |
case "$1" in |
861 |
-h|--help) # already handled; ignore |
862 |
shift 1;; |
863 |
-c|--clean) |
864 |
deleteProjects; printf "\n"; shift 1;; |
865 |
-w|--wipe) |
866 |
deleteProjects --wipe; printf "\n"; shift 1;; |
867 |
--LightRing) |
868 |
createLightRingProject; printf "\n"; shift 1;; |
869 |
--PowerManagement) |
870 |
createPowerManagementProject; printf "\n"; shift 1;; |
871 |
--DiWheelDrive) |
872 |
createDiWheelDriveProject; printf "\n"; shift 1;; |
873 |
-a|--all) |
874 |
createAllProjects; printf "\n"; shift 1;; |
875 |
-q|--quit) |
876 |
quitScript; shift 1;; |
877 |
--log=*|--LOG=*) # already handled; ignore |
878 |
shift 1;; |
879 |
--log|--LOG) # already handled; ignore |
880 |
shift 2;; |
881 |
--noinfo) # already handled; ignore |
882 |
shift 1;; |
883 |
*) |
884 |
printError "invalid option: $1\n"; shift 1;; |
885 |
esac |
886 |
else |
887 |
otherargs+=("$1") |
888 |
shift 1 |
889 |
fi |
890 |
done |
891 |
|
892 |
# interactive menu |
893 |
while ( true ); do |
894 |
# main menu info prompt and selection |
895 |
printInfo "QtCreator setup main menu\n" |
896 |
printf "Please select one of the following actions:\n" |
897 |
printf " [C] - clean project files\n" |
898 |
printf " [W] - wipe project and .user files\n" |
899 |
printf " [L] - create a project for the LightRing module\n" |
900 |
printf " [P] - create a project for the PowerManagement module\n" |
901 |
printf " [D] - create a project for the DiWheelDrive module\n" |
902 |
printf " [A] - create a project for all modules\n" |
903 |
printf " [Q] - quit this setup\n" |
904 |
local userinput="" |
905 |
readUserInput "CcWwLlPpDdAaQq" userinput |
906 |
printf "\n" |
907 |
|
908 |
# evaluate user selection |
909 |
case "$userinput" in |
910 |
C|c) |
911 |
deleteProjects; printf "\n";; |
912 |
W|w) |
913 |
deleteProjects --wipe; printf "\n";; |
914 |
L|l) |
915 |
createLightRingProject; printf "\n";; |
916 |
P|p) |
917 |
createPowerManagementProject; printf "\n";; |
918 |
D|d) |
919 |
createDiWheelDriveProject; printf "\n";; |
920 |
A|a) |
921 |
createAllProjects; printf "\n";; |
922 |
Q|q) |
923 |
quitScript;; |
924 |
*) # sanity check (exit with error) |
925 |
printError "unexpected argument: $userinput\n";; |
926 |
esac |
927 |
done |
928 |
|
929 |
exit 0 |
930 |
} |
931 |
|
932 |
################################################################################ |
933 |
# SCRIPT ENTRY POINT # |
934 |
################################################################################ |
935 |
|
936 |
main "$@" |
937 |
|