From a31575ca0b5a6d53ac8c8ed949d3a8686e1f690c Mon Sep 17 00:00:00 2001
From: Christian Decker <decker.christian@gmail.com>
Date: Mon, 5 Dec 2022 13:45:10 +0100
Subject: [PATCH] tools: Add multi-language support to blockreplace.py

Suggested-by: Rusty Russell <@rustyrussell>
---
 devtools/blockreplace.py | 35 +++++++++++++++++++++++++++++------
 doc/Makefile             |  2 +-
 2 files changed, 30 insertions(+), 7 deletions(-)

diff --git a/devtools/blockreplace.py b/devtools/blockreplace.py
index 25243c984..72d92bcd0 100644
--- a/devtools/blockreplace.py
+++ b/devtools/blockreplace.py
@@ -6,15 +6,37 @@
 # requiring a separate template. The markers are currently for
 # reStructuredText only, but more can be added.
 
+from enum import Enum
 import argparse
 import os
 import sys
 import textwrap
 
 
-def replace(filename, blockname, content):
-    start = f".. block_start {blockname}"
-    stop = f".. block_end {blockname}"
+class Language(str, Enum):
+    md = 'md'
+    rst = 'rst'
+    c = 'c'
+
+
+comment_style = {
+    Language.md: (
+        "<!-- block_start {blockname} -->",
+        "<!-- block_end {blockname} -->",
+    ),
+    Language.rst: (
+        ".. block_start {blockname}",
+        ".. block_end {blockname}",
+    ),
+    Language.c: (
+        "/* block_start {blockname} */",
+        "/* block_end {blockname} */",
+    ),
+}
+
+
+def replace(filename, blockname, language, content):
+    start, stop = comment_style[language]
 
     tempfile = f"{filename}.tmp"
 
@@ -24,7 +46,7 @@ def replace(filename, blockname, content):
         while lines != []:
             l = lines.pop(0)
             o.write(l)
-            if l.strip() == start:
+            if l.strip() == start.format(blockname=blockname):
                 break
 
         o.write(content)
@@ -32,7 +54,7 @@ def replace(filename, blockname, content):
         # Skip lines until we get the end marker
         while lines != []:
             l = lines.pop(0)
-            if l.strip() == stop:
+            if l.strip() == stop.format(blockname=blockname):
                 o.write(l)
                 break
 
@@ -50,12 +72,13 @@ def main(args):
     )
     parser.add_argument('filename')
     parser.add_argument('blockname')
+    parser.add_argument('--language', type=Language)
     parser.add_argument('--indent', dest="indent", default="")
     args = parser.parse_args()
     content = sys.stdin.read()
     content = textwrap.indent(content, args.indent)
 
-    replace(args.filename, args.blockname, content)
+    replace(args.filename, args.blockname, args.language, content)
 
 
 if __name__ == "__main__":
diff --git a/doc/Makefile b/doc/Makefile
index a8dad83fa..51f216a4c 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -200,5 +200,5 @@ doc/index.rst: $(MANPAGES:=.md)
 	  find doc -maxdepth 1 -name '*\.[0-9]\.md' | \
 	  cut -b 5- | LC_ALL=C sort | \
 	  sed 's/\(.*\)\.\(.*\).*\.md/\1 <\1.\2.md>/' | \
-	  python3 devtools/blockreplace.py doc/index.rst manpages --indent "   " \
+	  python3 devtools/blockreplace.py doc/index.rst manpages --language=rst --indent "   " \
 	)