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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
#!/bin/bash
#
# Note: you can set $DOCSTRING_PYTHON in the environment if you wish to
# force a particular python executable (in particular, one for which the
# clang module is available).
#
set -e
set -o pipefail
if [ "$#" = 0 ]; then
dirs="algebra angle census core enumerate file foreign hypersurface link manifold maths packet progress python snappea split subcomplex surface treewidth triangulation utilities"
else
dirs="$@"
fi
usage() {
if [ -n "$1" ]; then echo "ERROR: $1"; echo; fi
echo "Usage: $0 [ <engine_dir> ... ]"
echo "Example: $0 algebra core packet"
exit 1
}
if [ ! -e gendoc.sh ]; then
usage "This script must be run from python/docstrings/ in Regina's source tree."
fi
# Work out which python executable to run.
if [ -n "$DOCSTRING_PYTHON" ]; then
PYTHON="$DOCSTRING_PYTHON"
else
PYTHON=python3
fi
# If we are using Xcode clang, we will use the matching clang python bindings
# in the regina source tree.
if ! clang_version=`clang --version | head -n1`; then
echo "ERROR: Could not find clang on the path."
exit 1
fi
case "$clang_version" in
'Apple clang version '* )
# Assume we are on macOS, and therefore have BSD sed.
echo "macOS: $clang_version"
clang_major="`echo "$clang_version" | \
/usr/bin/sed -E -e 's/^Apple clang version ([0-9]+)\..*$/\1/'`"
clang_support="clang-support/$clang_major"
if [ -d "$clang_support" ]; then
export PYTHONPATH="$clang_support:$PYTHONPATH"
else
echo "ERROR: Could not access clang python bindings"
echo " Clang major version: $clang_major"
echo " Bindings path: $clang_support"
exit 1
fi
;;
* )
;;
esac
# For the include path, we grab the pre-rolled macOS config file.
# The choice of config file shouldn't actually affect the docstrings.
export PYTHONPATH=".:$PYTHONPATH"
export CPP_INCLUDE_DIRS="../../engine ../../preconfig/macos .."
for dir in $dirs; do
case "$dir" in
*[/\\:\;]* )
usage "Argument $dir should be a single directory name, not a full path"
;;
* )
;;
esac
if [ "$dir" != python -a ! -d ../../engine/"$dir" ]; then
usage "Argument $dir should be a subdirectory of ../../engine"
fi
if [ ! -d "$dir" ]; then
usage "Argument $dir does not have a docstring output directory"
fi
if [ "$dir" = python ]; then
"$PYTHON" ./mkdoc.py -std=c++20 \
-o python/equality.h "../helpers/equality.h"
else
if [ "$dir" = core ]; then
"$PYTHON" ./mkdoc.py -std=c++20 \
-o core/regina-core.h "../../engine/regina-core.h"
elif [ "$dir" = maths ]; then
for i in ../../engine/"$dir"/spec/*.h; do
header=`basename "$i"`
"$PYTHON" ./mkdoc.py -std=c++20 \
-o "$dir/$header" ../../engine/"$dir/spec/$header"
done
elif [ "$dir" = triangulation ]; then
for sub in dim2 dim3 dim4 generic alias detail; do
for i in ../../engine/"$dir"/"$sub"/*.h; do
header=`basename "$i"`
case "$sub/$header" in
*-impl.h ) ;;
detail/retriangulate.h ) ;;
* )
"$PYTHON" ./mkdoc.py -std=c++20 \
-o "$dir/$sub/$header" ../../engine/"$dir/$sub/$header"
;;
esac
done
done
fi
for i in ../../engine/"$dir"/*.h; do
header=`basename "$i"`
case "$dir/$header" in
*-impl.h ) ;;
link/graph.h ) ;;
manifold/notation.h ) ;;
triangulation/dim?.h ) ;;
triangulation/facetpairing.h ) ;;
triangulation/forward.h ) ;;
triangulation/generic.h ) ;;
triangulation/graph.h ) ;;
triangulation/pachner.h ) ;;
utilities/markedvector.h ) ;;
utilities/memstream.h ) ;;
utilities/sequence.h ) ;;
utilities/shortarray.h ) ;;
utilities/topologylock.h ) ;;
utilities/typeutils.h ) ;;
utilities/zstr.h ) ;;
* )
"$PYTHON" ./mkdoc.py -std=c++20 \
-o "$dir/$header" ../../engine/"$dir/$header"
;;
esac
done
fi
done
|
