1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
#!/bin/bash
# Copyright (c) 2021 - 2022 by Apex.AI Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# This script exports svg files from all *.puml files in a user-defined folder
# example usage: ./tools/generate_plantuml_svg.sh
set -e
declare -a REQUIRED_PROGRAMS=("java" "wget" "git" "unzip")
STARTUP_CHECK_SUCCESS=true
verifyProgram() {
if ! command -v $1 &>/dev/null
then
echo Please install \"$1\" to use this script
STARTUP_CHECK_SUCCESS=false
fi
}
checkRequiredPrograms() {
for p in "${REQUIRED_PROGRAMS[@]}"
do
verifyProgram $p
done
if ! $STARTUP_CHECK_SUCCESS
then
echo Please install missing applications
exit
fi
}
checkRequiredPrograms
WORKSPACE="$(git rev-parse --show-toplevel)"
PUML_DIR="$WORKSPACE/doc/design/diagrams"
IMPORT_DIR=${1:-$PUML_DIR}
EXPORT_DIR="$WORKSPACE/doc/website/images/"
TEMP_DIR="/var/tmp/iceoryx" # this is persistent across reboots
PLANTUML_DIR="$TEMP_DIR/plantuml-jar-mit-1.2021.5"
NUM_THREADS=1
cd "$WORKSPACE"
if [ ! -f $PLANTUML_DIR/plantuml.jar ]; then
echo "Downloading Plantuml..."
wget -P $TEMP_DIR https://downloads.sourceforge.net/project/plantuml/1.2021.5/plantuml-jar-mit-1.2021.5.zip
cd $TEMP_DIR
unzip plantuml-jar-mit-1.2021.5.zip -d plantuml-jar-mit-1.2021.5
cd "$WORKSPACE"
fi
if ! java -jar $PLANTUML_DIR/plantuml.jar -v &> /dev/null
then
echo "plantuml could not be found"
exit 1
fi
# set number of cores for building
if [[ "$OSTYPE" == "linux-gnu"* ]] || [[ "$OSTYPE" == "cygwin" ]] || [[ "$OSTYPE" == "msys" ]]; then
NUM_THREADS=$(nproc)
elif [[ "$OSTYPE" == "darwin"* ]]; then
NUM_THREADS=$(sysctl -n hw.ncpu)
fi
echo " [i] Generating with $NUM_THREADS threads"
java -jar $PLANTUML_DIR/plantuml.jar \
-config "$WORKSPACE/doc/iceoryx-plantuml-config.puml" \
-nometadata \
-nbthread "$NUM_THREADS" \
-tsvg \
-I "$IMPORT_DIR/**.puml" \
-output "$EXPORT_DIR"
echo " [i] Finished"
|
