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
|
#! /usr/bin/env python3
# SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
# SPDX-FileCopyrightText: Bradley M. Bell <bradbell@seanet.com>
# SPDX-FileContributor: 2003-24 Bradley M. Bell
# ----------------------------------------------------------------------------
import re
import sys
import subprocess
#
# p_symbol_heading
p_symbol_heading = re.compile( r'\n(CPPAD[A-Z_]*)\n([^\n]*)\n' )
#
# p_symbol_undef
p_symbol_undef = re.compile( r'\n# undef (CPPAD[A-Z_]*)\n' )
#
def main() :
#
if sys.argv[0] != 'bin/check_user_def.py' :
sys.exit(
'bin/check_user_def.py must execute from its parent directory'
)
#
# dev_doc_symbol_list
dev_doc_symbol_list=[
'CPPAD_VEC_AD_COMP_ASSIGN',
'CPPAD_FOR_HES_TRACE',
]
#
# exclude_list
exclude_list = [
'include/cppad/configure.hpp.in',
'configure',
]
#
# file_list
command = [ 'git', 'ls-files' ]
result = subprocess.run(
command ,
stdout = subprocess.PIPE ,
stderr = subprocess.PIPE ,
text = True ,
)
if result.returncode != 0 :
msg = 'Error: ' + ' '.join(command) + '\n'
msg += result.stderr
sys.exit(msg)
file_list = result.stdout.strip().split('\n')
#
# file_list
file_tmp = list()
for file in file_list :
exclude = file in exclude_list
if not exclude :
file_tmp.append(file)
file_list = file_tmp
#
# preprocessor_data
file_obj = open('xrst/preprocessor.xrst', 'r')
preprocessor_data = file_obj.read()
file_obj.close()
#
# undef_list
undef_list = list()
#
# m_symbol_undef
m_symbol_undef = p_symbol_undef.search( preprocessor_data )
while m_symbol_undef != None :
undef_list.append( m_symbol_undef.group(1) )
#
# m_symbol_undef
start = m_symbol_undef.end() - 1
m_symbol_undef = p_symbol_undef.search( preprocessor_data , start)
#
# file
for file in file_tmp :
#
# file_data
file_obj = open(file, 'r')
try :
file_data = file_obj.read()
except :
file_data = ''
file_obj.close()
#
# m_symbol_heading
m_symbol_heading = p_symbol_heading.search( file_data )
while m_symbol_heading != None :
#
# error
symbol = m_symbol_heading.group(1)
underline = m_symbol_heading.group(2)
error = False
if len(symbol) == len(underline) :
if underline == len(symbol) * underline[0] :
if symbol not in undef_list :
if symbol not in dev_doc_symbol_list :
error = True
if error :
msg = f'{file}:\n'
msg += f'Documentation for {symbol} appears in this file '
msg += 'but it is supposed to be in the user API.'
sys.exit(msg)
#
# m_symbol_heading
start = m_symbol_heading.end()
m_symbol_heading = p_symbol_heading.search( file_data , start)
#
main()
print('check_user_def.py: OK')
|
