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
|
#!/usr/bin/env python3
# argv[1] argv[2:-1] argv[-1]
# insert_example_code.py <examples_base_dir> <input_xml_files>... <output_xml_file>
import os
import sys
import re
import glob
import shutil
# Where to insert example code.
source_include_pattern = re.compile(
r'\s*<para><link xlink:href="&url_examples_base;([/\w]+)">Source Code</link></para>\s*(?:<!--\s*Insert\s+(.*?)-->)?')
# First line not part of leading comment in a source code file.
# The comment typically consists of copyright and license text.
start_of_source_pattern = re.compile(r'[#\w]')
def process_source_file(source_directory, source_basename, outfile, skip_leading_comments):
found_start = not skip_leading_comments
source_filename = os.path.join(source_directory, source_basename)
with open(source_filename, mode='r', encoding='utf-8', errors='surrogateescape') as srcfile:
outfile.write('<para>File: <filename>' + source_basename + '</filename> (For use with gtkmm 4)</para>\n')
outfile.write('<programlisting><code><![CDATA[')
for line in srcfile:
if not found_start:
# Skip leading comment.
if not start_of_source_pattern.match(line):
continue
found_start = True
outfile.write(line)
outfile.write(']]></code></programlisting>\n')
def insert_example_code(examples_base_dir, input_xml_files, output_xml_file):
if not (isinstance(input_xml_files, list) or isinstance(input_xml_files, tuple)):
input_xml_files = [] if input_xml_files == None else [input_xml_files]
# Assume that all files are UTF-8 encoded.
# If illegal UTF-8 bytes in the range 0x80..0xff are encountered, they are
# replaced by Unicode Private Use characters in the range 0xdc80..0xdcff
# and restored to their original values when the file is rewritten.
with open(output_xml_file, mode='w', encoding='utf-8', errors='surrogateescape') as outfile:
for input_xml_file in input_xml_files:
with open(input_xml_file, mode='r', encoding='utf-8', errors='surrogateescape') as infile:
for line in infile:
# Look for
# <para><link xlink:href="&url_examples_base;helloworld">Source Code</link></para> [<!-- Insert filenames... -->]
source_include_match = source_include_pattern.match(line)
if not source_include_match:
# Print the line without changes.
outfile.write(line)
else:
# Modify the line to remove the trailing comment, if any.
# url_examples_base is assumed to be a GitLab URL. The git branch is then
# included in url_examples_base. No need to add it here.
outfile.write(source_include_match.expand(
'<para><link xlink:href="&url_examples_base;\\1">Source Code</link></para>\n'))
outfile.write('<!-- start inserted example code -->\n')
# List all the source files in the examples directory.
source_directory = os.path.join(examples_base_dir, source_include_match.group(1))
for source_filename in sorted(glob.glob(os.path.join(source_directory, '*.h'))) + \
sorted(glob.glob(os.path.join(source_directory, '*.cc'))):
source_basename = os.path.basename(source_filename)
process_source_file(source_directory, source_basename, outfile, True)
# And possibly other files in the examples directory.
if source_include_match.group(2):
for source_basename in source_include_match.group(2).split():
process_source_file(source_directory, source_basename, outfile, False)
outfile.write('<!-- end inserted example code -->\n')
return 0
# ----- Main -----
if __name__ == '__main__':
if len(sys.argv) < 4:
print('Usage: ' + sys.argv[0] + ' <examples_base_dir> <input_xml_files>... <output_xml_file>')
sys.exit(1)
sys.exit(insert_example_code(sys.argv[1], sys.argv[2:-1], sys.argv[-1]))
|
