Changeset 1498:01efba83bf60 in freeDiameter for contrib

Timestamp:

Apr 3, 2020, 9:37:26 AM (4 years ago)

Author:

Luke Mewburn <luke@mewburn.net>

Branch:

default

Phase:

public

committer:

Luke Mewburn <luke@mewburn.net> 1585876473 -39600

Message:

csv_to_fd: fdc generate complete file

fdc: Generate a file with a function to create the DICT_AVP
entries, instead of a function snippet.

Processor: provide parameter() method for implementations.
Rename next_file() to filename().

File:

• contrib/tools/csv_to_fd (modified) (14 diffs)

contrib/tools/csv_to_fd

@@ -205 +205 @@
 
     @abc.abstractmethod
-    def next_file(self, filename):
+    def filename(self, filename):
         """Called when a file is opened."""
         pass
@@ -226 +226 @@
         pass
 
+    @abc.abstractmethod
+    def parameter(self, name, value):
+        """Process a parameter row:
+            @name,value.
+        """
+        pass
+
 
 class DebugProcessor(Processor):
     """Display the CSV parsing."""
 
-    def next_file(self, filename):
+    def filename(self, filename):
         print('File: {}'.format(filename))
 
@@ -243 +250 @@
         print('Generate')
 
+    def parameter(self, name, value):
+        print('Parameter: {} {}'.format(name, value))
+
 
 class NoopProcessor(Processor):
     """Validate the CSV; no other output."""
 
-    def next_file(self, filename):
+    def filename(self, filename):
         pass
 
@@ -257 +267 @@
 
     def generate(self):
+        pass
+
+    def parameter(self, name, value):
         pass
 
@@ -271 +284 @@
     COMMENT_WIDTH = 64
 
+    class AvpFunction(object):
+        """Maintain per-function state to create DICT_AVP entries.
+        """
+
+        def __init__(self, name):
+            self.__name = name
+            self.__lines = []
+            self.__derived = set()
+
+        @property
+        def name(self):
+            """Return name."""
+            return self.__name
+
+        @property
+        def lines(self):
+            """Return all lines."""
+            return self.__lines
+
+        @lines.setter
+        def lines(self, value):
+            """Set to append a line."""
+            self.__lines.append(value)
+
+        @property
+        def derived(self):
+            """Return list of all derived values."""
+            return list(self.__derived)
+
+        @derived.setter
+        def derived(self, value):
+            """Set to store a derived type."""
+            self.__derived.add(value)
+
     def __init__(self):
-        self.filenames = []
-        self.lines = []
-
-    def next_file(self, filename):
-        self.filenames.append(os.path.basename(filename))
+        self._filenames = []
+        self._functions = collections.OrderedDict()
+
+    def filename(self, filename):
+        self._filenames.append(os.path.basename(filename))
 
     def avp(self, avp):
@@ -312 +359 @@
         elif avp.datatype in DERIVED_TO_BASE:
             avp_type = '{}_type'.format(avp.datatype)
+            self.derived(avp.datatype)
         self.add('\t\tCHECK_dict_new(DICT_AVP, &data, {}, NULL);'.format(
             avp_type))
@@ -329 +377 @@
 
     def generate(self):
-        self.print_header()
-        self.print_comment('Start of generated data.')
-        self.print_comment('')
-        self.print_comment('The following is created automatically with:')
-        self.print_comment('    csv_to_fd -p {} {}'.format(
-            self.cls_name(), ' '.join(self.filenames)))
-        self.print_comment('Changes will be lost during the next update.')
-        self.print_comment('Do not modify;'
-                           ' modify the source .csv file instead.')
-        self.print_header()
-        print('')
-        print('\n'.join(self.lines))
-        self.print_header()
-        self.print_comment('End of generated data.')
-        self.print_header()
+        fp = sys.stdout
+        self.write_introduction(fp)
+        for func in self._functions:
+            self.write_function(fp, self._functions[func])
+
+    def parameter(self, name, value):
+        pass
+
+    # internal methods
+
+    def current_avpfunction(self):
+        """Return current AvpFunction to update.
+
+        Note: allows for easier future enhancement to generate separate
+        C functions per AVP groups such as: by csv file, standard, or vendor.
+        """
+        name = 'add_avps'
+        if name not in self._functions:
+            self._functions[name] = self.AvpFunction(name)
+        return self._functions[name]
+
+    def add(self, line):
+        self.current_avpfunction().lines = line
+
+    def derived(self, value):
+        self.current_avpfunction().derived = value
+
+    def build_c_token(self, value):
+        """Convert a string into a valid C token."""
+        return re.sub(r'[^\w]', '_', value)
 
     def build_flags(self, flags):
@@ -353 +416 @@
         return ' |'.join(result)
 
-    def add(self, line):
-        self.lines.append(line)
-
     def add_comment(self, comment):
-        self.lines.append(self.format_comment(comment))
+        self.add(self.format_comment(comment))
 
     def add_header(self):
-        self.lines.append(self.format_header())
+        self.add(self.format_header())
 
     def format_comment(self, comment):
@@ -368 +428 @@
         return '\t/*={:=<{width}}=*/'.format('', width=self.COMMENT_WIDTH)
 
-    def print_comment(self, comment):
-        print(self.format_comment(comment))
-
-    def print_header(self):
-        print(self.format_header())
+    def write_introduction(self, fp):
+        """Write the introduction to the generated file."""
+        fp.write('''\
+/*
+Generated by:
+\tcsv_to_fd -p {processor} {files}
+
+Do not modify; modify the source .csv files instead.
+*/
+
+#include <freeDiameter/extension.h>
+
+#define CHECK_dict_new( _type, _data, _parent, _ref ) \\
+\tCHECK_FCT(  fd_dict_new( fd_g_config->cnf_dict, \
+(_type), (_data), (_parent), (_ref))  );
+
+#define CHECK_dict_search( _type, _criteria, _what, _result ) \\
+\tCHECK_FCT( fd_dict_search( fd_g_config->cnf_dict, \
+(_type), (_criteria), (_what), (_result), ENOENT) );
+'''.format(
+            processor=self.cls_name(),
+            files=' '.join(self._filenames)))
+
+    def write_function(self, fp, avpfunction):
+        """Generate a function from AvpFunction."""
+        function = self.build_c_token(avpfunction.name)
+        # Function start
+        fp.write('''\
+
+int {}()
+{{
+'''.format(function))
+
+        # Create variables used by derived type validation
+        for derived in avpfunction.derived:
+            fp.write('''\
+\tstruct dict_object * {name}_type = NULL;
+\tCHECK_dict_search(DICT_TYPE, TYPE_BY_NAME, "{name}", &{name}_type);
+
+'''.format(name=derived))
+
+        # Write generated DICT_AVP creation
+        fp.write('\n'.join(avpfunction.lines))
+
+        # Write function end
+        fp.write('''\
+
+\treturn 0;
+}} /* {}() */
+'''.format(function))
 
 
@@ -382 +487 @@
         self.avps = []
 
-    def next_file(self, filename):
+    def filename(self, filename):
         pass
 
@@ -405 +510 @@
         doc = {"AVPs": self.avps}
         print(json.dumps(doc, indent=2))
+
+    def parameter(self, name, value):
+        pass
 
     def build_flags(self, flags):
@@ -467 +575 @@
 into various formats using the specified processor PROCESSOR.
 """)
-
     parser.add_option(
         '-p', '--processor',
@@ -491 +598 @@
     # Process files
     for filename in args:
-        avpproc.next_file(filename)
+        avpproc.filename(filename)
         with open(filename, 'r') as csvfile:
             csvdata = csv.DictReader(csvfile, CSV_COLUMN_NAMES,
@@ -517 +624 @@
                             raise ValueError('Unknown parameter "{}"'.format(
                                 parameter))
+                        avpproc.parameter(parameter, value)
                     else:
                         avp = Avp(filename=filename, line_num=csvdata.line_num,