Meson build: Add insert_example_code.py

kjellahl · kjellahl · commit 9933bbb448eb · 2021-07-02T17:12:07.000+02:00
* docs/manual/insert_example_code.py: New Python file, equivalent to
the insert_example_code.pl Perl file.

The Perl file is still used when building with Autotools.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,6 @@
 # wildcard patterns
 *.[ao]
 *.l[ao]
-*~
 Makefile
 Makefile.in
 .deps/
@@ -34,6 +33,7 @@ stamp-h?
 /docs/doxygen.css
 /docs/doxygen-extra.css
 /docs/tagfile-to-devhelp2.xsl
+/docs/manual/__pycache__/
 /docs/manual/html/
 /docs/manual/libxml++.xml
 /docs/reference/Doxyfile
diff --git a/Makefile.am b/Makefile.am
@@ -30,6 +30,7 @@ EXTRA_DIST = \
   meson_options.txt \
   libxml++config.h.meson \
   MSVC_NMake/libxml++/meson.build \
+  docs/manual/insert_example_code.py \
   docs/manual/meson.build \
   docs/reference/meson.build \
   examples/meson.build \
diff --git a/docs/manual/insert_example_code.py b/docs/manual/insert_example_code.py
@@ -0,0 +1,68 @@
+#!/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><ulink url="&url_examples_base;([/\w]+)">Source Code</ulink></para>')
+
+# 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):
+  source_filename = os.path.join(source_directory, source_basename)
+  with open(source_filename, mode='r') as srcfile:
+    outfile.write('<para>File: <filename>' + source_basename + '</filename></para>\n')
+    outfile.write('<programlisting>\n<![CDATA[')
+
+    found_start = False
+    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(']]></programlisting>\n')
+
+def insert_example_code(examples_base_dir, input_xml_files, output_xml_file):
+  if not isinstance(input_xml_files, list):
+    input_xml_files = [input_xml_files]
+
+  with open(output_xml_file, mode='w') as outfile:
+    for input_xml_file in input_xml_files:
+      with open(input_xml_file, mode='r') as infile:
+        for line in infile:
+          # Print the line.
+          outfile.write(line)
+
+          # Look for
+          # <para><ulink url="&url_examples_base;helloworld">Source Code</ulink></para>
+          source_include_match = source_include_pattern.match(line)
+          if source_include_match:
+            # List all the source files in the examples directory.
+            source_directory = os.path.join(examples_base_dir, source_include_match.group(1))
+            outfile.write('<!-- start inserted example code -->\n')
+            for source_filename in glob.glob(os.path.join(source_directory, '*.h')) + \
+                                   glob.glob(os.path.join(source_directory, '*.cc')):
+              source_basename = os.path.basename(source_filename)
+              process_source_file(source_directory, source_basename, outfile)
+            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]))
diff --git a/docs/manual/meson.build b/docs/manual/meson.build
@@ -35,7 +35,7 @@ xml_manual_docbook = custom_target('libxml++.xml',
   output: 'libxml++.xml',
   command: [
     python3, tutorial_custom_cmd_py, 'insert_example_code',
-    meson.current_source_dir() / 'insert_example_code.pl',
+    meson.current_source_dir(),
     project_source_root / 'examples',
     '@INPUT@',
     '@OUTPUT@',
diff --git a/tools/build_scripts/tutorial-custom-cmd.py b/tools/build_scripts/tutorial-custom-cmd.py
@@ -8,29 +8,19 @@
 import os
 import sys
 import subprocess
-from pathlib import Path
 import shutil
 
 subcommand = sys.argv[1]
 
-def insert_example_code():
-  #      argv[2]            argv[3]             argv[4]         argv[5]
-  # <perl_script_file> <examples_dir> <input_xml_file> <output_xml_file>
+def insert_ex_code():
+  #      argv[2]        argv[3]         argv[4]         argv[5]
+  # <py_script_file> <examples_dir> <input_xml_file> <output_xml_file>
 
-  perl_script_file = sys.argv[2]
-  examples_dir = sys.argv[3]
-  input_xml_file = sys.argv[4]
-  output_xml_file = sys.argv[5]
+  # Search for insert_example_code.py first in <py_script_dir>.
+  sys.path.insert(0, sys.argv[2])
+  from insert_example_code import insert_example_code
 
-  cmd = [
-    'perl',
-    '--',
-    perl_script_file,
-    examples_dir,
-    input_xml_file,
-  ]
-  with open(output_xml_file, mode='w') as xml_file:
-    return subprocess.run(cmd, stdout=xml_file).returncode
+  return insert_example_code(sys.argv[3], sys.argv[4], sys.argv[5])
 
 def html():
   #      argv[2]          argv[3]         argv[4]
@@ -65,6 +55,8 @@ def html():
   return result.returncode
 
 def xmllint():
+  from pathlib import Path
+
   #  argv[2]       argv[3]          argv[4]
   # <validate> <input_xml_file> <stamp_file_path>
 
@@ -184,7 +176,7 @@ def dist_doc():
 
 # ----- Main -----
 if subcommand == 'insert_example_code':
-  sys.exit(insert_example_code())
+  sys.exit(insert_ex_code())
 if subcommand == 'html':
   sys.exit(html())
 if subcommand == 'xmllint':
