wrapper_generator.cpp

Go to the documentation of this file.

/***************************************
        Auteur : Pierre Aubert
        Mail : pierre.aubert@lapp.in2p3.fr
        Licence : CeCILL-C
****************************************/
 
#include "cmakelist_generator.h"
#include "wrapper_module_generator.h"
#include "wrapper_test.h"
#include "wrapper_generator.h"
 
 
ProjectConfig project_createWrapperConfig(const ProjectConfig & projectConfig){
        ProjectConfig wrapper(projectConfig);
        wrapper.name = "Py"+projectConfig.name;
        wrapper.url = wrapper.url.replace(projectConfig.name, wrapper.name);
        
        return wrapper;
}
 
 
bool project_wrapper_generator_readme(const PPath & fileName, const ProjectConfig & projectConfig){
        PString body;
        body += "![PLIBS_9 logo](doc/logo.png)\n\n";
        
        body += "# Remarks\n\n";
        body += "This project was generated automatically by [phoenix_filegenerator](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixFileGenerator)\n";
        body += "using [phoenix_generator](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixGenerator) library\n\n";
        
        body += "# Code\n\n";
        body += "Version : " + projectConfig.version + "\n\n";
        body += projectConfig.url + "\n\n";
        body += "# Description\n\n";
        body += "Python wrapper version.\n";
        body += projectConfig.description + "\n\n";
        
        return fileName.saveFileContent(body);
}
 
 
bool project_wrapper_generator_setuppy(const PPath & fileName, const ProjectConfig & projectConfig, const PString & baseImplInclude, const std::vector<PClassConfig> & vecClassConfig, const PVecPath & vecInclude){
        PString body, moduleName = "py" + projectConfig.name.toLower();
        body += "\n";
        body += getCMakeListsHeader();
        body += "from setuptools import setup\n";
        body += "from setuptools import Extension\n";
        body += "import sys\n";
        body += "import numpy as np\n";
        body += "import subprocess\n";
        body += "\n";
        body += "dataStreamIncludeDir = subprocess.run(['phoenixdatastream-config', '--include'], capture_output = True, text = True).stdout.strip(\"\\n\")\n";
        body += "dataStreamLibDir = subprocess.run(['phoenixdatastream-config', '--lib'], capture_output = True, text = True).stdout.strip(\"\\n\")\n";
        body += "\n";
        body += "ext_modules = [\n";
        body += "\tExtension(\""+moduleName+"\", sources=([\n";
        body += "\t\t\""+moduleName+"/"+baseImplInclude+"_wrapper.cpp\",\n";
        body += "\t\t\""+moduleName+"/"+projectConfig.name.toLower()+"_module.cpp\"\n";
        body += "\t]),\n";
        body += "\textra_compile_args = [\"-O3\", \"-Werror\", \"-g\"],\n";
        
        body += "\tinclude_dirs = [np.get_include(), dataStreamIncludeDir, \"./\", \""+moduleName+"/\"],\n";
        body += "\tlibraries=[\"phoenix_data_stream\"],\n";
        body += "\tlibrary_dirs=[dataStreamLibDir],\n";
        body += "\t)\n";
        body += "]\n\n";
        
        body += "try:\n";
        body += "\tsetup(\n";
        body += "\t\tname=\""+moduleName+"\",\n";
        body += "\t\tversion=\""+projectConfig.version+"\",\n";
        body += "\t\text_modules=ext_modules,\n";
        body += "\t)\n";
        body += "except Exception as e:\n";
        body += "\tprint(str(e))\n";
        body += "\tsys.exit(-1)\n";
        body += "\n";
        return fileName.saveFileContent(body);
}
 
 
bool project_wrapper_generator_pyprojectToml(const PPath & fileName, const ProjectConfig & projectConfig, const PString & baseImplInclude, const std::vector<PClassConfig> & vecClassConfig, const PVecPath & vecInclude){
        PString body;
        body += "\n";
        body += getCMakeListsHeader();
        body += "[project]\n";
        body += "name = \"py"+projectConfig.name.toLower()+"\"\n";
        body += "version = \""+projectConfig.version+"\"\n";
        body += "description = \""+projectConfig.description.replace("\n", " ")+"\"\n";
        body += "readme = \"README.md\"\n";
        body += "license = \"CeCILL-C\"\n";
        body += "dependencies = [\n";
        body += "\t\"numpy\"\n";
        body += "]\n";
        body += "\n";
        body += "[build-system]\n";
        body += "requires = [\n";
        body += "\t\"numpy\",\n";
        body += "\t\"setuptools >= 74.1\",\n";
        body += "\t\"cython\"\n";
        body += "]\n";
        body += "build-backend = \"setuptools.build_meta\"\n";
        body += "\n";
//      body += "[tool.setuptools]\n";
//      body += "ext-modules = [\n";
//      body += "\t{\n";
//      body += "\t\tname = \""+projectConfig.name.toLower()+"\",\n";
//      body += "\t\tsources = [\n";
//      body += "\t\t\t\""+projectConfig.name.toLower()+"/"+baseImplInclude+"_wrapper.cpp\",\n";
//      body += "\t\t\t\""+projectConfig.name.toLower()+"/"+projectConfig.name+"_module.cpp\"\n";
//      body += "\t\t],\n";
//      body += "\t\textra_compile_args = [\"-O3\", \"-Werror\", \"-g\"]\n";
//      body += "\t}\n";
//      body += "\n";
//      body += "]\n";
        body += "\n";
        return fileName.saveFileContent(body);
}
 
 
void updateVecClassConfig(std::vector<PClassConfig> & vecClassConfig){
        std::map<std::string, std::string> mapEnum;
        for(std::vector<PClassConfig>::iterator it(vecClassConfig.begin()); it != vecClassConfig.end(); ++it){
                if(it->getIsEnum()){
                        mapEnum[it->getName() + "::" + it->getName()] = it->getName();
                        size_t i(0lu);
                        std::vector<PClassAttribute> & vecAttr = it->getListAttribute();
                        for(std::vector<PClassAttribute>::iterator itAttr(vecAttr.begin()); itAttr != vecAttr.end(); ++itAttr){
                                if(itAttr->getDefaultValue() == ""){
                                        itAttr->setDefaultValue(PString::toString(i));
                                }
                                ++i;
                        }
                }
        }
        for(std::vector<PClassConfig>::iterator itClass(vecClassConfig.begin()); itClass != vecClassConfig.end(); ++itClass){
                std::vector<PClassAttribute> & vecAttr = itClass->getListAttribute();
                for(std::vector<PClassAttribute>::iterator itAttr(vecAttr.begin()); itAttr != vecAttr.end(); ++itAttr){
                        std::map<std::string, std::string>::iterator it(mapEnum.find(itAttr->getType()));
                        if(it != mapEnum.end()){
                                itAttr->setType(it->second);
                                itAttr->setIsEnum(true);
                        }
                        if(itAttr->getType() == "PPath" || itAttr->getType() == "PString"){
                                itAttr->setType("std::string");
                        }
                }
        }
}
 
 
bool project_wrapper_generator(const ProjectConfig & projectConfig, const PPath & configFile){
        ProjectConfig wrapperConfig(project_createWrapperConfig(projectConfig));
        PVecPath vecInclude;
        std::vector<PClassConfig> vecClassConfig;
        if(!parserClassConfig(vecClassConfig, vecInclude, configFile)){
                std::cerr << "project_wrapper_generator : can't load file '" << configFile << "'" << std::endl;
                return false;
        }
        //TODO : pass through vecClassConfig and replace PPath and PString by std::string to ensure PhoenixDataStream will work well on them for the wrapper
        updateVecClassConfig(vecClassConfig);
        
        //Then, let's create the hierarchy
        PPath mainProjectDir(wrapperConfig.name);
        if(!mainProjectDir.createDirectory()){
                std::cerr << "project_wrapper_generator : cannot create main directory of project '"<<mainProjectDir<<"'" << std::endl;
                return false;
        }
        //And module dir
        PPath mainProjectModule(mainProjectDir / PPath(wrapperConfig.name.toLower()));
        if(!mainProjectModule.createDirectory()){
                std::cerr << "project_generator : cannot create module directory of project '"<<mainProjectModule<<"'" << std::endl;
                return false;
        }
        //The readme
        PPath readmeFile(mainProjectDir / PPath("README.md"));
        if(!project_wrapper_generator_readme(readmeFile, projectConfig)){return false;}
        
        PString baseImplInclude = configFile.getFileName().eraseExtension();
        //The readme
        PPath setupFile(mainProjectDir / PPath("setup.py"));
        if(!project_wrapper_generator_setuppy(setupFile, projectConfig, baseImplInclude, vecClassConfig, vecInclude)){return false;}
        
        PPath pyprojectFile(mainProjectDir / PPath("pyproject.toml"));
        if(!project_wrapper_generator_pyprojectToml(pyprojectFile, projectConfig, baseImplInclude, vecClassConfig, vecInclude)){return false;}
        //The unit tests
        if(!project_wrapper_moduleGeneratorTest(mainProjectDir, projectConfig, "py"+projectConfig.name.toLower(), vecClassConfig, vecInclude)){return false;}
        //The full module
        return project_wrapper_moduleGenerator(mainProjectModule, projectConfig, baseImplInclude, vecClassConfig, vecInclude);
}