#!/usr/bin/env python import os, glob, re, sys from param import * from wikiemit import WikiEmit from xmlemit import XmlEmit from htmlemit import HtmlEmit from rstemit import RSTEmit from optparse import OptionParser parser = OptionParser("param_parse.py [options]") parser.add_option("-v", "--verbose", dest='verbose', action='store_true', default=False, help="show debugging output") parser.add_option("--vehicle", default='*', help="Vehicle type to generate for") (opts, args) = parser.parse_args() # Regular expressions for parsing the parameter metadata prog_param = re.compile(r"@Param: *(\w+).*((?:\n[ \t]*// @(\w+): (.*))+)(?:\n\n|\n[ \t]+[A-Z])", re.MULTILINE) prog_param_fields = re.compile(r"[ \t]*// @(\w+): (.*)") prog_groups = re.compile(r"@Group: *(\w+).*((?:\n[ \t]*// @(Path): (\S+))+)", re.MULTILINE) prog_group_param = re.compile(r"@Param: (\w+).*((?:\n[ \t]*// @(\w+): (.*))+)(?:\n\n|\n[ \t]+[A-Z])", re.MULTILINE) apm_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), '../../../') vehicle_paths = glob.glob(apm_path + "%s/Parameters.cpp" % opts.vehicle) extension = 'cpp' if len(vehicle_paths) == 0: vehicle_paths = glob.glob(apm_path + "%s/Parameters.pde" % opts.vehicle) extension = 'pde' vehicle_paths.sort(reverse=True) vehicles = [] libraries = [] error_count = 0 def debug(str): '''debug output if verbose is set''' if opts.verbose: print(str) def error(str): '''show errors''' global error_count error_count += 1 print(str) for vehicle_path in vehicle_paths: name = os.path.basename(os.path.dirname(vehicle_path)) path = os.path.normpath(os.path.dirname(vehicle_path)) vehicles.append(Vehicle(name, path)) debug('Found vehicle type %s' % name) for vehicle in vehicles: debug("===\n\n\nProcessing %s" % vehicle.name) f = open(vehicle.path+'/Parameters.' + extension) p_text = f.read() f.close() param_matches = prog_param.findall(p_text) group_matches = prog_groups.findall(p_text) debug(group_matches) for group_match in group_matches: l = Library(group_match[0]) fields = prog_param_fields.findall(group_match[1]) for field in fields: if field[0] in known_group_fields: setattr(l, field[0], field[1]) else: error("unknown parameter metadata field '%s'" % field[0]) if not any(l.name == parsed_l.name for parsed_l in libraries): libraries.append(l) for param_match in param_matches: p = Parameter(vehicle.name+":"+param_match[0]) debug(p.name + ' ') field_text = param_match[1] fields = prog_param_fields.findall(field_text) field_list = [] for field in fields: field_list.append(field[0]) if field[0] in known_param_fields: setattr(p, field[0], field[1]) else: error("unknown parameter metadata field '%s'" % field[0]) for req_field in required_param_fields: if not req_field in field_list: error("missing parameter metadata field '%s' in %s" % (req_field, field_text)) vehicle.params.append(p) debug("Processed %u params" % len(vehicle.params)) debug("Found %u documented libraries" % len(libraries)) for library in libraries: debug("===\n\n\nProcessing library %s" % library.name) if hasattr(library, 'Path'): paths = library.Path.split(',') for path in paths: path = path.strip() debug("\n Processing file '%s'" % path) if path.endswith('.pde') or path.find('/') == -1: if len(vehicles) != 1: print("Unable to handle multiple vehicles with .pde library") continue libraryfname = os.path.join(vehicles[0].path, path) else: libraryfname = os.path.normpath(os.path.join(apm_path + '/libraries/' + path)) if path and os.path.exists(libraryfname): f = open(libraryfname) p_text = f.read() f.close() else: error("Path %s not found for library %s" % (path, library.name)) continue param_matches = prog_group_param.findall(p_text) debug("Found %u documented parameters" % len(param_matches)) for param_match in param_matches: p = Parameter(library.name+param_match[0]) debug(p.name + ' ') field_text = param_match[1] fields = prog_param_fields.findall(field_text) for field in fields: if field[0] in known_param_fields: setattr(p, field[0], field[1]) else: error("unknown parameter metadata field %s" % field[0]) library.params.append(p) else: error("Skipped: no Path found") debug("Processed %u documented parameters" % len(library.params)) def is_number(numberString): try: float(numberString) return True except ValueError: return False def validate(param): """ Validates the parameter meta data. """ # Validate values if (hasattr(param, "Range")): rangeValues = param.__dict__["Range"].split(" ") if (len(rangeValues) != 2): error("Invalid Range values for %s" % (param.name)) return min = rangeValues[0] max = rangeValues[1] if not is_number(min): error("Min value not number: %s %s" % (param.name, min)) return if not is_number(max): error("Max value not number: %s %s" % (param.name, max)) return for vehicle in vehicles: for param in vehicle.params: validate(param) for library in libraries: for param in library.params: validate(param) def do_emit(emit): emit.set_annotate_with_vehicle(len(vehicles) > 1) for vehicle in vehicles: emit.emit(vehicle, f) emit.start_libraries() for library in libraries: if library.params: emit.emit(library, f) emit.close() do_emit(XmlEmit()) do_emit(WikiEmit()) do_emit(HtmlEmit()) do_emit(RSTEmit()) sys.exit(error_count)