Merge pull request #22 from Kvixen/license_clarification

Clarifying license of FMU generated by Simulix

Author: Kvixen

content-builder.py

@@ -88,16 +88,12 @@ def xmlgen(data):
     ET.ElementTree(root).write(path.join('modelDescription.xml'),
         encoding='utf-8', xml_declaration=True, method='xml', pretty_print=True)
 
-def dllgen(dst, src, data):
+def dllgen(dst, data):
 
-    template_replace = {
+    src = path.join(path.dirname(path.realpath(__file__)), 'templates/') 
 
-    }
+    template_replace = {
 
-    causality_dict = {
-        'input':'U',
-        'output':'Y',
-        'parameter':'P'
     }
 
     template_replace['numReal'] = int(data['numReal'])
@@ -106,8 +102,6 @@ def dllgen(dst, src, data):
     template_replace['stepSize'] = data['StepSize']
     template_replace['modelName'] = data['Model']
     template_replace['GUID'] = data['GUID']
-    model_name = data['Model']
-    model_nameS = model_name[:29]
 
     real_string = ""
     int_string = ""
@@ -125,14 +119,16 @@ def dllgen(dst, src, data):
     template_replace['intString'] = int_string
     template_replace['booleanString'] = boolean_string
     with open(path.join(dst, 'Simulix_dllmain.c'), 'w') as dllmain:
-        with open(src, 'r') as dllmainTemplate:
+        with open(path.join(src, "Simulix_cg_license.txt"), 'r') as license_text:
+            dllmain.write(license_text.read())
+        with open(path.join(src, "Simulix_dllmain_template.c"), 'r') as dllmainTemplate:
             dllmain.write(dllmainTemplate.read().format(**template_replace))
 
-def main(dst, src):
+def main(dst):
     data = read_json_file("ModelOutputs.json")
     data["GUID"] = str(uuid.uuid4())
 
-    dllgen(dst, src, data)
+    dllgen(dst, data)
     # remove index and offset keys that must not be known to xmlgen
     index_list = list(map(lambda d: d.pop('index'), data['ModelVariables'][0]['ScalarVariable']))
     offset_list = list(map(lambda d: d.pop('offset'), data['ModelVariables'][0]['ScalarVariable']))
@@ -141,6 +137,5 @@ def main(dst, src):
 if __name__ == '__main__':
     parser = argparse.ArgumentParser(description="Generate a C file for a FMU",prog="dllgen",usage="%(prog)s [options]")
     parser.add_argument('-o', help='Path to Simulix_dllmain.c output', default=getcwd())
-    parser.add_argument('-t', help='Path to template file', default=path.join(path.dirname(path.realpath(__file__)), 'templates/Simulix_dllmain_template.c'))
     args = parser.parse_args()
-    main(args.o, args.t)
+    main(args.o)

libraryincludes/fmusdk_license.txt licenses/fmusdk_license.txtlibraryincludes/fmusdk_license.txt renamed to licenses/fmusdk_license.txt

@@ -0,0 +1,16 @@
+Simulix generates an FMU from a simulink model source code.
+ 
+Copyright (C) 2018 Scania CV AB and Simulix contributors
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

licenses/simulix_license.txt

@@ -106,11 +106,11 @@ if(PC_DEFINITIONS MATCHES "^SIMULIX" OR PC_DEFINITIONS MATCHES ";SIMULIX")
             "fmuTemplate.c"
             "fmuTemplate.h"
         )
-        message(STATUS "GENERATED_FILES_PATH: ${{GENERATED_FILES_PATH}}")
         foreach(FILE_NAME ${{LIBRARY_SOURCES}})
             configure_file("${{GENERATED_FILES_PATH}}/libraryincludes/${{FILE_NAME}}" "${{FMU_PATH}}/sources" COPYONLY)
         endforeach()
-        configure_file("${{GENERATED_FILES_PATH}}/libraryincludes/fmusdk_license.txt" "${{FMU_PATH}}/documentation")
+        configure_file("${{GENERATED_FILES_PATH}}/licenses/fmusdk_license.txt" "${{FMU_PATH}}/documentation")
+        configure_file("${{GENERATED_FILES_PATH}}/licenses/simulix_license.txt" "${{FMU_PATH}}/documentation")
 
         if(UNIX)
             target_link_libraries(

templates/CMakeLists.txt

@@ -168,23 +168,12 @@ def handle_extension(extension_path, src, dst):
 def copy_directories(src, dst):
     copy_directory(path.join(src, 'includes'), path.join(dst, 'includes'))
     copy_directory(path.join(src, 'libraryincludes'), path.join(dst, 'libraryincludes'))
+    copy_directory(path.join(src, 'licenses'), path.join(dst, 'licenses'))
 
 def generate_files(src, dst, zip_path, zip_name, extension_path, temp_path):
     """
     Extracts content from zip in zip_path
     Generates and copies neccesary files
-    
-
-    Parameters:
-        src:
-            Source of template files, should be 
-            {path_to_cgen.py}/includes unless specified otherwise.
-
-        dst:
-            Destination of generated file(s).
-
-        zip_path:
-            Path to generated Zip.
     """
     environ['SIMX_EXE'] = "1"
     TEMPLATE_REPLACE['path'] = path.dirname(path.realpath(__file__)).replace('\\', '/')