Allow inserting feature flag macros on info fields

Author: GDYendell

epicsdbbuilder/recordbase.py

@@ -142,8 +142,8 @@ def add_comment(self, comment):
     def add_metadata(self, metadata):
         self.__comments.append('#% ' + metadata)
 
-    def add_info(self, name, info):
-        self.__infos.append((name, info))
+    def add_info(self, name, info, feature_flag=""):
+        self.__infos.append((name, info, feature_flag))
 
     def __dbd_order(self, fields):
         field_set = set(fields)
@@ -176,9 +176,13 @@ def Print(self, output, alphabetical=True):
         sort = sorted if alphabetical else list
         for alias in sort(self.__aliases.keys()):
             print('    alias("%s")' % alias, file = output)
-        for name, info in self.__infos:
-            value = self.__FormatFieldForDb(name, info)
-            print('    info(%s, %s)' % (name, value), file = output)
+        for name, info, feature_flag in self.__infos:
+            # Restrict to one line if there is a feature flag so that it can be escaped
+            feature_flag_macro = "$(%s=#)" % feature_flag if feature_flag else ""
+            value = self.__FormatFieldForDb(name, info, line_prefix=feature_flag_macro)
+            print(
+                '%s    info(%s, %s)' % (feature_flag_macro, name, value), file = output
+            )
         print('}', file = output)
 
 
@@ -227,13 +231,15 @@ def __ValidateField(self, fieldname, value):
             self._validate.ValidFieldValue(fieldname, str(value))
 
     # Field formatting
-    def __FormatFieldForDb(self, fieldname, value):
+    def __FormatFieldForDb(self, fieldname, value, line_prefix=""):
         if hasattr(value, 'FormatDb'):
             return value.FormatDb(self, fieldname)
         elif isinstance(value, dict):
             # JSON values in EPICS database as per
             # https://epics.anl.gov/base/R7-0/6-docs/links.html
-            return '\n    '.join(json.dumps(value, indent=4).splitlines())
+            return '\n{}    '.format(line_prefix).join(
+                json.dumps(value, indent=4).splitlines()
+            )
         else:
             return quote_string(str(value))
 

test/expected_output.db

@@ -1,7 +1,7 @@
 # This file was automatically generated on Thu 25 Nov 2021 10:35:33 GMT.
-# 
+#
 # *** Please do not edit this file: edit the source file instead. ***
-# 
+#
 #% macro, DEVICE, Device name
 #% macro, P, A parameter
 #% macro, Q, A number
@@ -100,6 +100,15 @@ record(waveform, "$(DEVICE):FIELD:WITH_CONST_ARRAY")
             }
         }
     })
+$(V4=#)    info(Q:group, {
+$(V4=#)        "MYTABLE2": {
+$(V4=#)            "+id": "epics:nt/NTTable:1.0",
+$(V4=#)            "labels": {
+$(V4=#)                "+type": "plain",
+$(V4=#)                "+channel": "VAL"
+$(V4=#)            }
+$(V4=#)        }
+$(V4=#)    })
 }
 
 record(ai, "$(DEVICE):FIELD:WITH_JSON_LINK")

test/expected_output_alphabetical.db

@@ -1,7 +1,7 @@
 # This file was automatically generated on Mon 08 Nov 2021 09:23:43 GMT.
-# 
+#
 # *** Please do not edit this file: edit the source file instead. ***
-# 
+#
 #% macro, DEVICE, Device name
 #% macro, P, A parameter
 #% macro, Q, A number
@@ -23,6 +23,15 @@ record(waveform, "$(DEVICE):FIELD:WITH_CONST_ARRAY")
             }
         }
     })
+$(V4=#)    info(Q:group, {
+$(V4=#)        "MYTABLE2": {
+$(V4=#)            "+id": "epics:nt/NTTable:1.0",
+$(V4=#)            "labels": {
+$(V4=#)                "+type": "plain",
+$(V4=#)                "+channel": "VAL"
+$(V4=#)            }
+$(V4=#)        }
+$(V4=#)    })
 }
 
 record(ai, "$(DEVICE):FIELD:WITH_JSON_LINK")

test/test_a_file.py

@@ -74,6 +74,7 @@ def test_output(tmp_path):
             ("+channel", "VAL")
         ]))])
     w.add_info("Q:group", {"MYTABLE": td})
+    w.add_info("Q:group", {"MYTABLE2": td}, "V4")
     # And json links with readbacks
     a = records.ai(
         'FIELD:WITH_JSON_LINK',