build: meson doctest autoglob

Author: mochaaP

.gitignore

@@ -2,6 +2,9 @@
 build/
 Testing/
 
+# Python bytecode cache
+__pycache__/
+
 # Meson subprojects
 /subprojects/*
 !/subprojects/*.wrap

docs/meson.build

@@ -7,27 +7,38 @@ maybe_fmt_dep = dependency(
   disabler: true,
 )
 
-# glob **.md
+autogen_glob = custom_target(
+  command: [autogen_doctest_exe, meson.current_source_dir()],
+  output: 'autogen.stamp',
+  build_by_default: true,
+)
+
+#pragma autogen push
 docs = [
-  'README.md',
-  'faq.md',
-  'modules_support.md',
   'spec/PRO_DEF_FREE_AS_MEM_DISPATCH.md',
   'spec/PRO_DEF_FREE_DISPATCH.md',
   'spec/PRO_DEF_MEM_DISPATCH.md',
-  'spec/ProAccessible.md',
-  'spec/ProBasicConvention.md',
-  'spec/ProBasicFacade.md',
-  'spec/ProBasicReflection.md',
-  'spec/ProConvention.md',
-  'spec/ProDispatch.md',
-  'spec/ProFacade.md',
-  'spec/ProOverload.md',
-  'spec/ProReflection.md',
-  'spec/README.md',
   'spec/allocate_proxy.md',
   'spec/allocate_proxy_shared.md',
-  'spec/bad_proxy_cast.md',
+  'spec/facade_aware_overload_t.md',
+  'spec/inplace_proxiable_target.md',
+  'spec/is_bitwise_trivially_relocatable.md',
+  'spec/make_proxy.md',
+  'spec/make_proxy_inplace.md',
+  'spec/make_proxy_shared.md',
+  'spec/make_proxy_view.md',
+  'spec/msft_lib_proxy.md',
+  'spec/proxiable.md',
+  'spec/proxiable_target.md',
+  'spec/proxy_invoke.md',
+  'spec/proxy_reflect.md',
+  'spec/proxy_view.md',
+  'spec/skills_as_view.md',
+  'spec/skills_as_weak.md',
+  'spec/skills_fmt_format.md',
+  'spec/skills_format.md',
+  'spec/skills_slim.md',
+  'spec/weak_proxy.md',
   'spec/basic_facade_builder/README.md',
   'spec/basic_facade_builder/add_convention.md',
   'spec/basic_facade_builder/add_facade.md',
@@ -38,30 +49,10 @@ docs = [
   'spec/basic_facade_builder/support_copy.md',
   'spec/basic_facade_builder/support_destruction.md',
   'spec/basic_facade_builder/support_relocation.md',
-  'spec/constraint_level.md',
   'spec/explicit_conversion_dispatch/README.md',
-  'spec/explicit_conversion_dispatch/accessor.md',
-  'spec/explicit_conversion_dispatch/operator_call.md',
-  'spec/facade.md',
-  'spec/facade_aware_overload_t.md',
   'spec/implicit_conversion_dispatch/README.md',
-  'spec/implicit_conversion_dispatch/accessor.md',
-  'spec/implicit_conversion_dispatch/operator_call.md',
-  'spec/inplace_proxiable_target.md',
-  'spec/is_bitwise_trivially_relocatable.md',
-  'spec/make_proxy.md',
-  'spec/make_proxy_inplace.md',
-  'spec/make_proxy_shared.md',
-  'spec/make_proxy_view.md',
-  'spec/msft_lib_proxy.md',
-  'spec/not_implemented.md',
   'spec/operator_dispatch/README.md',
-  'spec/operator_dispatch/accessor.md',
-  'spec/operator_dispatch/operator_call.md',
-  'spec/proxiable.md',
-  'spec/proxiable_target.md',
   'spec/proxy/README.md',
-  'spec/proxy/assignment.md',
   'spec/proxy/constructor.md',
   'spec/proxy/destructor.md',
   'spec/proxy/emplace.md',
@@ -70,26 +61,13 @@ docs = [
   'spec/proxy/indirection.md',
   'spec/proxy/operator_bool.md',
   'spec/proxy/reset.md',
-  'spec/proxy/swap.md',
-  'spec/proxy_indirect_accessor.md',
-  'spec/proxy_invoke.md',
-  'spec/proxy_reflect.md',
-  'spec/proxy_view.md',
-  'spec/skills_as_view.md',
-  'spec/skills_as_weak.md',
-  'spec/skills_fmt_format.md',
-  'spec/skills_format.md',
   'spec/skills_rtti/README.md',
   'spec/skills_rtti/proxy_cast.md',
   'spec/skills_rtti/proxy_typeid.md',
-  'spec/skills_slim.md',
   'spec/substitution_dispatch/README.md',
-  'spec/substitution_dispatch/accessor.md',
-  'spec/substitution_dispatch/operator_call.md',
   'spec/weak_dispatch/README.md',
-  'spec/weak_dispatch/operator_call.md',
-  'spec/weak_proxy.md',
 ]
+#pragma autogen pop
 
 docdir = get_option('docdir')
 if docdir == ''
@@ -160,6 +138,7 @@ foreach doc : docs
         input: 'example.cpp.in',
         output: f'example_@name@.cpp',
       ),
+      extra_files: doc,
       implicit_include_directories: false,
       dependencies: deps,
       build_by_default: false,
@@ -169,6 +148,7 @@ foreach doc : docs
       name,
       example_exe,
       suite: 'ProxyExamples',
+      depends: autogen_glob,
     )
   endif
 endforeach

tools/extract_example_code_from_docs.py

@@ -2,12 +2,13 @@
 # pyright: strict
 
 import re
+import typing as T
 from pathlib import Path
 
 EXAMPLE_PATTERN = re.compile(r"## Example\r?\n\r?\n```cpp\r?\n(.*?)\r?\n```", re.DOTALL)
 
 
-def extract_cpp_code(md_path: Path, cpp_path: Path) -> None:
+def extract_cpp_code(md_path: Path) -> T.Optional[str]:
     with open(md_path, "r", encoding="utf-8") as f:
         content = f.read()
 
@@ -26,9 +27,7 @@ def extract_cpp_code(md_path: Path, cpp_path: Path) -> None:
 
 """.lstrip()
 
-    with open(cpp_path, "w", encoding="utf-8") as out:
-        _ = out.write(header)
-        _ = out.write(cpp_code)
+    return header + cpp_code
 
 
 def main() -> None:
@@ -56,7 +55,11 @@ class Args:
                 rel_path = md_path.relative_to(input_dir)
                 rel_base = "_".join([*rel_path.parent.parts, rel_path.stem])
                 cpp_path = output_dir / f"example_{rel_base}.cpp"
-                extract_cpp_code(md_path, cpp_path)
+                cpp_code = extract_cpp_code(md_path)
+                if cpp_code is None:
+                    continue
+                with open(cpp_path, "w", encoding="utf-8") as f:
+                    _ = f.write(cpp_code)
 
 
 if __name__ == "__main__":

tools/meson.build

@@ -1 +1,2 @@
 autogen_tests_exe = find_program('./meson_autogen_tests.py')
+autogen_doctest_exe = find_program('./meson_autogen_doctest.py')

tools/meson_autogen_doctest.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+# pyright: strict
+
+import sys
+from pathlib import Path
+
+from mesonbuild import mformat
+
+from extract_example_code_from_docs import extract_cpp_code
+
+directory = Path(sys.argv[1])
+mesonfile = directory / "meson.build"
+
+with mesonfile.open(encoding="utf-8") as f:
+    build = f.readlines()
+
+begin = -1
+end = -1
+
+for i, line in enumerate(build):
+    if begin == -1 and line.strip() == "#pragma autogen push":
+        begin = i + 1
+    elif end == -1 and line.strip() == "#pragma autogen pop":
+        end = i
+
+if begin == -1 or end == -1:
+    raise ValueError
+
+docs = [str(path.relative_to(directory)) for path in directory.glob("**/*.md") if extract_cpp_code(path) is not None]
+
+config = mformat.get_meson_format([mesonfile])
+formatter = mformat.Formatter(config, False, False)
+pretty = formatter.format(f"{docs = }", mesonfile)
+
+if pretty == "".join(build[begin:end]):
+    exit()
+
+with mesonfile.open("w", encoding="utf-8") as f:
+    f.writelines(build[:begin])
+    _ = f.write(pretty)
+    f.writelines(build[end:])