-
Notifications
You must be signed in to change notification settings - Fork 375
/
Copy pathgmt_make_module_purpose.sh
executable file
·75 lines (61 loc) · 3.38 KB
/
gmt_make_module_purpose.sh
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
#!/usr/bin/env bash
#
# Copyright (c) 2020
# by the GMT Team (https://www.generic-mapping-tools.org/team.html)
# See LICENSE.TXT file for copying and redistribution conditions.
#
# This script will fild all the C files of GMT core and supplemental modules,
# extract the THIS_MODULE_PURPOSE from the source files,
# and create module_core_purpose.rst_ and module_supplements_purpose.rst_
# for the documentation.
#
# Set LC_ALL to get the same sort order on Linux and macOS
export LC_ALL=C
# Set temporary directory
TMPDIR=${TMPDIR:-/tmp}
# Define paths
RSTDIR="../doc/rst/source/"
FILE_CORE_MODULE_PURPOSE="${RSTDIR}/module_core_purpose.rst_"
FILE_SUPPL_MODULE_PURPOSE="${RSTDIR}/supplements/module_supplements_purpose.rst_"
# Output purpose of core modules
grep "^#define THIS_MODULE_LIB" *.c | egrep -v '_mt|_old|_experimental' | gawk -F: '{print $1}' | sort -u > ${TMPDIR}/gmt_core_modules.lst
echo "Writing to ${FILE_CORE_MODULE_PURPOSE}"
echo ".. Automatically generated by src/gmt_make_module_purpose.sh." > ${FILE_CORE_MODULE_PURPOSE}
echo "" >> ${FILE_CORE_MODULE_PURPOSE}
while read program; do
modern_name=$(grep "^#define THIS_MODULE_MODERN_NAME" $program | gawk '{print $3}' | sed -e 's/"//g')
classic_name=$(grep "^#define THIS_MODULE_CLASSIC_NAME" $program | gawk '{print $3}' | sed -e 's/"//g')
purpose=$(grep '^#define THIS_MODULE_PURPOSE' $program | gawk -F'\t' '{print $2}' | sed -e 's/^"//' -e 's/"$//')
echo ".. |${modern_name}_purpose| replace:: ${purpose}" >> ${FILE_CORE_MODULE_PURPOSE}
echo "" >> ${FILE_CORE_MODULE_PURPOSE}
if [ "$modern_name" != "$classic_name" ]; then
echo ".. |${classic_name}_purpose| replace:: ${purpose}" >> ${FILE_CORE_MODULE_PURPOSE}
echo "" >> ${FILE_CORE_MODULE_PURPOSE}
fi
done < ${TMPDIR}/gmt_core_modules.lst
rm -f ${TMPDIR}/gmt_core_modules.lst
echo "Writing to ${FILE_SUPPL_MODULE_PURPOSE}"
echo ".. Automatically generated by src/gmt_make_module_purpose.sh." > ${FILE_SUPPL_MODULE_PURPOSE}
echo "" >> ${FILE_SUPPL_MODULE_PURPOSE}
# Output purpose of supplemental modules
grep "^#define THIS_MODULE_LIB" */*.c | egrep -v '_mt|_old|_experimental' | gawk -F: '{print $1}' | sort -u > ${TMPDIR}/gmt_supplements_modules.lst
while read program; do
modern_name=$(grep "^#define THIS_MODULE_MODERN_NAME" $program | gawk '{print $3}' | sed -e 's/"//g')
classic_name=$(grep "^#define THIS_MODULE_CLASSIC_NAME" $program | gawk '{print $3}' | sed -e 's/"//g')
purpose=$(grep '^#define THIS_MODULE_PURPOSE' $program | gawk -F'\t' '{print $2}' | sed -e 's/^"//' -e 's/"$//')
echo ".. |${modern_name}_purpose| replace:: ${purpose}" >> ${FILE_SUPPL_MODULE_PURPOSE}
echo "" >> ${FILE_SUPPL_MODULE_PURPOSE}
if [ "$modern_name" != "$classic_name" ]; then
echo ".. |${classic_name}_purpose| replace:: ${purpose}" >> ${FILE_SUPPL_MODULE_PURPOSE}
echo "" >> ${FILE_SUPPL_MODULE_PURPOSE}
fi
done < ${TMPDIR}/gmt_supplements_modules.lst
rm -f ${TMPDIR}/gmt_supplements_modules.lst
# Add purpose for a few GSFML bash scripts (i.e, not .c code)
cat <<- EOF >> ${FILE_SUPPL_MODULE_PURPOSE}
.. |fzinformer_purpose| replace:: Bash script to plot statistical information related to fracture zones
.. |fzmapper_purpose| replace:: Bash script to plot fracture zone cross-profiles on a Mercator map
.. |fzmodeler_purpose| replace:: Bash script to build fracture zone cross-profile model
.. |fzprofiler_purpose| replace:: Bash script to plot fracture zone cross-profiles
EOF
echo "Writing done"