freeDiameter: contrib/tools/csv_to

comparison contrib/tools/csv_to_fd @ 1498:01efba83bf60

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().

author	Luke Mewburn <luke@mewburn.net>
date	Fri, 03 Apr 2020 11:37:26 +1100
parents	ae76ea63ee12
children	2ab9d941bad5

comparison

equal deleted inserted replaced

-:d9615342e116
+:01efba83bf60
 if cls.__doc__ is None:
 return ""
 return cls.__doc__.split('\n')[0]
 @abc.abstractmethod
-def next_file(self, filename):
+def filename(self, filename):
 """Called when a file is opened."""
 pass
 @abc.abstractmethod
 def avp(self, avp):
 @abc.abstractmethod
 def generate(self):
 """Invoked after all rows processed."""
 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))
 def avp(self, avp):
 avpdict = vars(avp)
 print('AVP: {name}, {code}, {datatype}'.format(**avpdict))
 print('Comment: {}'.format(comment))
 def generate(self):
 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
 def avp(self, avp):
 pass
 def comment(self, comment, filename, line_num):
 pass
 def generate(self):
+pass
+def parameter(self, name, value):
 pass
 class FdcProcessor(Processor):
 """Generate freeDiameter C code.
 #               [blank line]
 """
 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._filenames = []
-self.lines = []
+self._functions = collections.OrderedDict()
-def next_file(self, filename):
+def filename(self, filename):
-self.filenames.append(os.path.basename(filename))
+self._filenames.append(os.path.basename(filename))
 def avp(self, avp):
 comment = '{name}, {datatype}, code {code}'.format(**vars(avp))
 if avp.section != '':
 comment += ', section {}'.format(avp.section)
 # XXX: add enumerated values
 self.add('\t\tCHECK_dict_new(DICT_TYPE, &tdata, NULL, &type);')
 avp_type = "type"
 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))
 # TODO: remove ; on scope brace
 self.add('\t};')
 self.add('')
 self.add_comment(comment[1:])
 else:
 raise ValueError('Unsupported comment "{}"'.format(comment))
 def generate(self):
-self.print_header()
+fp = sys.stdout
-self.print_comment('Start of generated data.')
+self.write_introduction(fp)
-self.print_comment('')
+for func in self._functions:
-self.print_comment('The following is created automatically with:')
+self.write_function(fp, self._functions[func])
-self.print_comment('    csv_to_fd -p {} {}'.format(
-self.cls_name(), ' '.join(self.filenames)))
+def parameter(self, name, value):
-self.print_comment('Changes will be lost during the next update.')
+pass
-self.print_comment('Do not modify;'
-' modify the source .csv file instead.')
+# internal methods
-self.print_header()
-print('')
+def current_avpfunction(self):
-print('\n'.join(self.lines))
+"""Return current AvpFunction to update.
-self.print_header()
-self.print_comment('End of generated data.')
+Note: allows for easier future enhancement to generate separate
-self.print_header()
+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):
 result = []
 if 'V' in flags:
 result.append('AVP_FLAG_VENDOR')
 if 'M' in flags:
 result.append('AVP_FLAG_MANDATORY')
 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):
 return '\t/* {:<{width}} */'.format(comment, width=self.COMMENT_WIDTH)
 def format_header(self):
 return '\t/*={:=<{width}}=*/'.format('', width=self.COMMENT_WIDTH)
-def print_comment(self, comment):
+def write_introduction(self, fp):
-print(self.format_comment(comment))
+"""Write the introduction to the generated file."""
+fp.write('''\
-def print_header(self):
+/*
-print(self.format_header())
+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))
 class JsonProcessor(Processor):
 """Generate freeDiameter JSON object.
 """
 def __init__(self):
 self.avps = []
-def next_file(self, filename):
+def filename(self, filename):
 pass
 def avp(self, avp):
 flags = collections.OrderedDict([
 ('Must',    self.build_flags(avp.must)),
 pass
 def generate(self):
 doc = {"AVPs": self.avps}
 print(json.dumps(doc, indent=2))
+def parameter(self, name, value):
+pass
 def build_flags(self, flags):
 result = []
 if 'V' in flags:
 result.append('V')
 usage='%prog [-h] [-p PROCESSOR] FILE ...',
 description="""\
 Convert CSV files FILE ... containing RADIUS or Diameter AVP tables
 into various formats using the specified processor PROCESSOR.
 """)
 parser.add_option(
 '-p', '--processor',
 default='noop',
 help='AVP processor. One of: {}. [%default]'.format(
 ', '.join(processors.keys())))
 # dict of [vendor][name] : Avp
 avp_names = collections.defaultdict(dict)
 # 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,
 restkey='extra_cells')
 standard = ''
 vendor = 0
 elif parameter == 'vendor':
 vendor = int(value)
 else:
 raise ValueError('Unknown parameter "{}"'.format(
 parameter))
+avpproc.parameter(parameter, value)
 else:
 avp = Avp(filename=filename, line_num=csvdata.line_num,
 standard=standard, vendor=vendor,
 **row)
 # Ensure AVP vendor/code not already defined

Mercurial > hg > freeDiameter

comparison contrib/tools/csv_to_fd @ 1498:01efba83bf60