From aad959a297ff66946effb165518143be15777dd6 Mon Sep 17 00:00:00 2001
From: Rusty Russell <rusty@rustcorp.com.au>
Date: Thu, 27 Apr 2023 13:54:42 +0930
Subject: [PATCH] tools: remove option handling now last optional field was
 removed.

6fee63fc342736a2eb7f6e856ae0d85807cc50ec made `htlc_maximum_msat`
compulsory, which was the last "optional" field.  All future options
will be TLVs, so we never need to parse the "] (optionxxx)" format
for fields again.

We allow options for messages, but only for documentation (we have
some messages which are only for `gossip_queries`), so we don't
put it in the output.

Here's the before/after diff of the output for all the spec files:

```diff
--- /tmp/before	2023-04-27 14:21:07.417170213 +0930
+++ /tmp/after	2023-04-27 14:19:39.184573086 +0930
@@ -273,7 +273,7 @@
 msgdata,channel_update,fee_base_msat,u32,
 msgdata,channel_update,fee_proportional_millionths,u32,
 msgdata,channel_update,htlc_maximum_msat,u64,
-msgtype,query_short_channel_ids,261,gossip_queries
+msgtype,query_short_channel_ids,261
 msgdata,query_short_channel_ids,chain_hash,chain_hash,
 msgdata,query_short_channel_ids,len,u16,
 msgdata,query_short_channel_ids,encoded_short_ids,byte,len
@@ -281,17 +281,17 @@
 tlvtype,query_short_channel_ids_tlvs,query_flags,1
 tlvdata,query_short_channel_ids_tlvs,query_flags,encoding_type,byte,
 tlvdata,query_short_channel_ids_tlvs,query_flags,encoded_query_flags,byte,...
-msgtype,reply_short_channel_ids_end,262,gossip_queries
+msgtype,reply_short_channel_ids_end,262
 msgdata,reply_short_channel_ids_end,chain_hash,chain_hash,
 msgdata,reply_short_channel_ids_end,full_information,byte,
-msgtype,query_channel_range,263,gossip_queries
+msgtype,query_channel_range,263
 msgdata,query_channel_range,chain_hash,chain_hash,
 msgdata,query_channel_range,first_blocknum,u32,
 msgdata,query_channel_range,number_of_blocks,u32,
 msgdata,query_channel_range,tlvs,query_channel_range_tlvs,
 tlvtype,query_channel_range_tlvs,query_option,1
 tlvdata,query_channel_range_tlvs,query_option,query_option_flags,bigsize,
-msgtype,reply_channel_range,264,gossip_queries
+msgtype,reply_channel_range,264
 msgdata,reply_channel_range,chain_hash,chain_hash,
 msgdata,reply_channel_range,first_blocknum,u32,
 msgdata,reply_channel_range,number_of_blocks,u32,
@@ -310,7 +310,7 @@
 subtype,channel_update_checksums
 subtypedata,channel_update_checksums,checksum_node_id_1,u32,
 subtypedata,channel_update_checksums,checksum_node_id_2,u32,
-msgtype,gossip_timestamp_filter,265,gossip_queries
+msgtype,gossip_timestamp_filter,265
 msgdata,gossip_timestamp_filter,chain_hash,chain_hash,
 msgdata,gossip_timestamp_filter,first_timestamp,u32,
 msgdata,gossip_timestamp_filter,timestamp_range,u32,
```

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
---
 tools/extract-formats.py | 60 ++++++++++++++++++----------------------
 1 file changed, 27 insertions(+), 33 deletions(-)

diff --git a/tools/extract-formats.py b/tools/extract-formats.py
index 834adeb70..8b716b4d9 100755
--- a/tools/extract-formats.py
+++ b/tools/extract-formats.py
@@ -6,16 +6,16 @@
 # Outputs:
 #
 # Standard message types:
-#   msgtype,<msgname>,<value>[,<option>]
-#   msgdata,<msgname>,<fieldname>,<typename>,[<count>][,<option>]
+#   msgtype,<msgname>,<value>
+#   msgdata,<msgname>,<fieldname>,<typename>,[<count>]
 #
 # TLV types:
-#   tlvtype,<tlvstreamname>,<tlvname>,<value>[,<option>]
-#   tlvdata,<tlvstreamname>,<tlvname>,<fieldname>,<typename>,[<count>][,<option>]
+#   tlvtype,<tlvstreamname>,<tlvname>,<value>
+#   tlvdata,<tlvstreamname>,<tlvname>,<fieldname>,<typename>,[<count>]
 #
 # Subtypes:
-#   subtype,<msgname>[,<option>]
-#   subtypedata,<msgname>,<fieldname>,<typename>,[<count>][,<option>]
+#   subtype,<msgname>
+#   subtypedata,<msgname>,<fieldname>,<typename>,[<count>]
 
 from optparse import OptionParser
 import sys
@@ -26,11 +26,11 @@
 typeline = re.compile(
     '(1\.|\*) type: (?P<value>[-0-9A-Za-z_|]+) \(`(?P<name>[A-Za-z0-9_]+)`\)( \(`?(?P<option>[^)`]*)`\))?')
 tlvline = re.compile(
-    '(1\.|\*) `tlv_stream`: `(?P<name>[A-Za-z0-9_]+)`( \(`?(?P<option>[^)`]*)`\))?')
+    '(1\.|\*) `tlv_stream`: `(?P<name>[A-Za-z0-9_]+)`')
 subtypeline = re.compile(
-    '(1\.|\*) subtype: `(?P<name>[A-Za-z0-9_]+)`( \(`?(?P<option>[^)`]*)`\))?')
+    '(1\.|\*) subtype: `(?P<name>[A-Za-z0-9_]+)`')
 dataline = re.compile(
-    '\s+([0-9]+\.|\*) \[`(?P<typefield>[-._a-zA-Z0-9*+]+)`:`(?P<name>[_a-z0-9]+)`\]( \(`?(?P<option>[^)`]*)`?\))?')
+    '\s+([0-9]+\.|\*) \[`(?P<typefield>[-._a-zA-Z0-9*+]+)`:`(?P<name>[_a-z0-9]+)`\]')
 datastartline = re.compile(
     '(2\.|\*) data:')
 tlvtypesline = re.compile(
@@ -45,13 +45,9 @@ def next_line(args, lines):
         yield i, line.rstrip()
 
 
-# Helper to print a line to output with optional ,option
-def print_csv(output, fmt, option):
-    print(fmt, file=output, end='')
-    if option:
-        print(',{}'.format(option), file=output)
-    else:
-        print('', file=output)
+# Helper to print a line to output
+def print_csv(output, fmt):
+    print(fmt, file=output)
 
 
 # 1. type: 17 (`error`) (`optionXXX`)
@@ -59,16 +55,16 @@ def print_csv(output, fmt, option):
 #    * [`short_channel_id`:`channel_id`]
 #    * [`u16`:`num_inputs`]
 #    * [`num_inputs*sha256`:`input_info`]
-#    * [`u32`:`len`] (optionYYY)
-#    * [`len*byte`:`data`] (optionYYY)
+#    * [`u32`:`len`]
+#    * [`len*byte`:`data`]
 #
 # output:
 #   msgtype,error,17,optionXXX
 #   msgdata,error,channel_id,short_channel_id,
 #   msgdata,error,num_inputs,u16,
 #   msgdata,error,input_info,sha256,num_inputs
-#   msgdata,error,len,u32,,optionYYY
-#   msgdata,error,data,byte,len,optionYYY
+#   msgdata,error,len,u32,
+#   msgdata,error,data,byte,len
 #
 # 1. type: PERM|NODE|3 (`required_node_feature_missing`)
 #
@@ -88,7 +84,7 @@ def print_csv(output, fmt, option):
 #   msgdata,query_short_channel_ids,len,u16,
 #   msgdata,query_short_channel_ids,encoded_short_ids,byte,len
 #   msgdata,query_short_channel_ids,tlvs,query_short_channel_ids_tlvs,
-def parse_type(genline, output, name, value, option, in_tlv=None):
+def parse_type(genline, output, name, value, in_tlv=None):
     _, line = next(genline)
 
     if in_tlv:
@@ -98,7 +94,7 @@ def parse_type(genline, output, name, value, option, in_tlv=None):
         type_prefix='msgtype'
         data_prefix='msgdata'
 
-    print_csv(output, '{},{},{}'.format(type_prefix, name, value), option)
+    print_csv(output, '{},{},{}'.format(type_prefix, name, value))
 
     # Expect a data: line before values, if any
     if not datastartline.fullmatch(line.lstrip()):
@@ -117,8 +113,7 @@ def parse_type(genline, output, name, value, option, in_tlv=None):
 
         print_csv(output,
                   "{},{},{},{},{}"
-                  .format(data_prefix, name, match.group('name'), typename, num),
-                  match.group('option'))
+                  .format(data_prefix, name, match.group('name'), typename, num))
 
     
 # 1. tlvs: `query_short_channel_ids_tlvs`
@@ -132,7 +127,7 @@ def parse_type(genline, output, name, value, option, in_tlv=None):
 #  tlvtype,query_short_channel_ids_tlvs,query_flags,1
 #  tlvdata,query_short_channel_ids_tlvs,query_flags,encoding_type,byte,
 #  tlvdata,query_short_channel_ids_tlvs,query_flags,encoded_query_flags,byte,...
-def parse_tlv(genline, output, name, option):
+def parse_tlv(genline, output, name):
     i, line = next(genline)
 
     # Expect a types: line after tlvs.
@@ -146,7 +141,7 @@ def parse_tlv(genline, output, name, option):
         if not match:
             break
 
-        _, line = parse_type(genline, output, match.group('name'), match.group('value'), match.group('option'), name)
+        _, line = parse_type(genline, output, match.group('name'), match.group('value'), name)
 
     
 # 1. subtype: `input_info`
@@ -159,14 +154,14 @@ def parse_tlv(genline, output, name, option):
 #  subtypedata,input_info,satoshis,u64,
 #  subtypedata,input_info,prevtx_txid,sha256,
 
-def parse_subtype(genline, output, name, option):
+def parse_subtype(genline, output, name):
     i, line = next(genline)
 
     # Expect a data: line after subtype.
     if not datastartline.fullmatch(line):
         raise ValueError('{}: Expected "2. data:" line'.format(i))
 
-    print_csv(output, 'subtype,{}'.format(name), option)
+    print_csv(output, 'subtype,{}'.format(name))
 
     while True:
         i, line = next(genline)
@@ -181,8 +176,7 @@ def parse_subtype(genline, output, name, option):
 
         print_csv(output,
                   "{},{},{},{},{}"
-                  .format('subtypedata', name, match.group('name'), typename, num),
-                  match.group('option'))
+                  .format('subtypedata', name, match.group('name'), typename, num))
 
     
 def main(options, args=None, output=sys.stdout, lines=None):
@@ -193,15 +187,15 @@ def main(options, args=None, output=sys.stdout, lines=None):
 
             match = typeline.fullmatch(line)
             if match:
-                parse_type(genline, output, match.group('name'), match.group('value'), match.group('option'))
+                parse_type(genline, output, match.group('name'), match.group('value'))
                 continue
             match = tlvline.fullmatch(line)
             if match:
-                parse_tlv(genline, output, match.group('name'), match.group('option'))
+                parse_tlv(genline, output, match.group('name'))
                 continue
             match = subtypeline.fullmatch(line)
             if match:
-                parse_subtype(genline, output, match.group('name'), match.group('option'))
+                parse_subtype(genline, output, match.group('name'))
                 continue
     except StopIteration:
         pass