111 lines
3.6 KiB
Python
111 lines
3.6 KiB
Python
|
#! /usr/bin/python3
|
||
|
|
# -*- coding: utf-8 -*-
|
||
|
|
"""
|
||
|
|
:file: returnvalues_parser.py
|
||
|
|
:brief: Part of the MOD export tools for the SOURCE project by KSat.
|
||
|
|
TODO: Integrate into Parser Structure instead of calling this file (no cpp file generated yet)
|
||
|
|
:details:
|
||
|
|
Returnvalue exporter.
|
||
|
|
To use MySQLdb, run pip install mysqlclient or install in IDE. On Windows, Build Tools installation might be necessary.
|
||
|
|
:data: 21.11.2019
|
||
|
|
"""
|
||
|
|
from modgen.parserbase.file_list_parser import FileListParser
|
||
|
|
from modgen.returnvalues.returnvalues_parser import InterfaceParser, ReturnValueParser
|
||
|
|
from modgen.utility.sql_writer import SqlWriter
|
||
|
|
from modgen.utility.file_management import move_file
|
||
|
|
|
||
|
|
from definitions import BspType, DATABASE_NAME
|
||
|
|
|
||
|
|
EXPORT_TO_FILE = True
|
||
|
|
MOVE_CSV_FILE = True
|
||
|
|
EXPORT_TO_SQL = True
|
||
|
|
PRINT_TABLES = True
|
||
|
|
|
||
|
|
CSV_RETVAL_FILENAME = "mod_returnvalues.csv"
|
||
|
|
CSV_MOVE_DESTINATION = "../"
|
||
|
|
FILE_SEPARATOR = ';'
|
||
|
|
MAX_STRING_LENGTH = 32
|
||
|
|
|
||
|
|
BSP_SELECT = BspType.BSP_Q7S
|
||
|
|
BSP_DIR_NAME = BSP_SELECT.value
|
||
|
|
ADD_LINUX_FOLDER = False
|
||
|
|
if BSP_SELECT == BspType.BSP_Q7S or BSP_SELECT == BspType.BSP_LINUX_BOARD:
|
||
|
|
FSFW_CONFIG_ROOT = f"../../linux/fsfwconfig"
|
||
|
|
ADD_LINUX_FOLDER = True
|
||
|
|
else:
|
||
|
|
FSFW_CONFIG_ROOT = f"../../{BSP_DIR_NAME}/fsfwconfig"
|
||
|
|
BSP_PATH = f"../../{BSP_DIR_NAME}"
|
||
|
|
|
||
|
|
INTERFACE_DEFINITION_FILES = [
|
||
|
|
"../../fsfw/returnvalues/FwClassIds.h",
|
||
|
|
"../../common/config/commonClassIds.h",
|
||
|
|
f"{FSFW_CONFIG_ROOT}/returnvalues/classIds.h"
|
||
|
|
]
|
||
|
|
RETURNVALUE_DESTINATIONS = [
|
||
|
|
"../../mission/", "../../fsfw/", f"{BSP_PATH}"
|
||
|
|
]
|
||
|
|
|
||
|
|
if ADD_LINUX_FOLDER:
|
||
|
|
RETURNVALUE_DESTINATIONS.append("../../linux")
|
||
|
|
|
||
|
|
SQL_DELETE_RETURNVALUES_CMD = """
|
||
|
|
DROP TABLE IF EXISTS Returnvalues
|
||
|
|
"""
|
||
|
|
|
||
|
|
SQL_CREATE_RETURNVALUES_CMD = """
|
||
|
|
CREATE TABLE IF NOT EXISTS Returnvalues (
|
||
|
|
id INTEGER PRIMARY KEY,
|
||
|
|
code TEXT,
|
||
|
|
name TEXT,
|
||
|
|
interface TEXT,
|
||
|
|
file TEXT,
|
||
|
|
description TEXT
|
||
|
|
)
|
||
|
|
"""
|
||
|
|
|
||
|
|
SQL_INSERT_RETURNVALUES_CMD = """
|
||
|
|
INSERT INTO Returnvalues(code,name,interface,file,description)
|
||
|
|
VALUES(?,?,?,?,?)
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
def main():
|
||
|
|
returnvalue_table = parse_returnvalues()
|
||
|
|
print("")
|
||
|
|
if EXPORT_TO_FILE:
|
||
|
|
ReturnValueParser.export_to_file(CSV_RETVAL_FILENAME, returnvalue_table, FILE_SEPARATOR)
|
||
|
|
if MOVE_CSV_FILE:
|
||
|
|
move_file(file_name=CSV_RETVAL_FILENAME, destination=CSV_MOVE_DESTINATION)
|
||
|
|
if EXPORT_TO_SQL:
|
||
|
|
print("ReturnvalueParser: Exporting to SQL")
|
||
|
|
sql_retval_exporter(returnvalue_table=returnvalue_table, db_file_dest=f"../{DATABASE_NAME}")
|
||
|
|
|
||
|
|
|
||
|
|
def parse_returnvalues():
|
||
|
|
""" Core function to parse for the return values """
|
||
|
|
interface_parser = InterfaceParser(file_list=INTERFACE_DEFINITION_FILES, print_table=PRINT_TABLES)
|
||
|
|
interfaces = interface_parser.parse_files()
|
||
|
|
header_parser = FileListParser(RETURNVALUE_DESTINATIONS)
|
||
|
|
header_list = header_parser.parse_header_files(True, "Parsing header file list: ")
|
||
|
|
print("")
|
||
|
|
returnvalue_parser = ReturnValueParser(interfaces, header_list, PRINT_TABLES)
|
||
|
|
returnvalue_parser.set_moving_window_mode(moving_window_size=7)
|
||
|
|
returnvalue_table = returnvalue_parser.parse_files(True)
|
||
|
|
print(f"ReturnvalueParser: Found {len(returnvalue_table)} returnvalues.")
|
||
|
|
return returnvalue_table
|
||
|
|
|
||
|
|
|
||
|
|
def sql_retval_exporter(returnvalue_table, db_file_dest: str):
|
||
|
|
sql_writer = SqlWriter(db_filename=db_file_dest)
|
||
|
|
sql_writer.open(SQL_CREATE_RETURNVALUES_CMD)
|
||
|
|
for entry in returnvalue_table.items():
|
||
|
|
sql_writer.write_entries(
|
||
|
|
SQL_INSERT_RETURNVALUES_CMD,
|
||
|
|
(entry[0], entry[1][2], entry[1][4], entry[1][3], entry[1][1]))
|
||
|
|
sql_writer.commit()
|
||
|
|
sql_writer.close()
|
||
|
|
|
||
|
|
|
||
|
|
if __name__ == "__main__":
|
||
|
|
main()
|