project_generator.cpp File Reference

#include "parser_toml.h"
#include "cmakelist_generator.h"
#include "gitlab_doc.h"
#include "wrapper_generator.h"
#include "project_generator.h"

Include dependency graph for project_generator.cpp:

Go to the source code of this file.

Functions
bool	project_generator (const PPath &descriptionFile, const PPath &configFile, bool isPythonWrapper)
	Generate a full project with PhoenixDataStream and PhoenixTypeStream. More...
bool	project_generator_cmakeListsMain (const PPath &fileName, const ProjectConfig &projectConfig, const PString &baseConfigClassName)
	Create the main CMakeLists.txt of the project directory. More...
bool	project_generator_cmakeListsSrc (const PPath &fileName, const PString &projectName, const PString &libName)
	Create the CMakeLists.txt of the src directory. More...
bool	project_generator_cmakeListsTest (const PPath &fileName, const PString &baseConfigClassName)
	Create the main CMakeLists.txt of the project directory. More...
bool	project_generator_gitignore (const PPath &fileName)
	Create the .gitignore of the project. More...
bool	project_generator_gitlabci (const PPath &fileName, const ProjectConfig &projectConfig)
	Create the .gitlab-ci.yml of the project. More...
bool	project_generator_loadConfig (ProjectConfig &config, const PPath &descriptionFile)
	Load the project configuration. More...
bool	project_generator_readme (const PPath &fileName, const ProjectConfig &projectConfig)
	Create the readme of the project directory. More...

Function Documentation

project_generator()

bool project_generator	(	const PPath &	descriptionFile,
		const PPath &	configFile,
		bool	isPythonWrapper
	)

Generate a full project with PhoenixDataStream and PhoenixTypeStream.

Parameters

descriptionFile	: description of the full project
configFile	: configuration file of the
isPythonWrapper	: true if we want to generate a Python wrapper

Returns

true on success, false otherwise

Definition at line 292 of file project_generator.cpp.

                                                                                                     {
        //First, let's read the toml config of the project
        ProjectConfig projectConfig;
        if(!project_generator_loadConfig(projectConfig, descriptionFile)){
                std::cerr << "project_generator : cannot parse project description file '"<<descriptionFile<<"'" << std::endl;
                return false;
        }
        //Then, let's create the hierarchy
        PPath mainProjectDir(projectConfig.name);
        if(!mainProjectDir.createDirectory()){
                std::cerr << "project_generator : cannot create main directory of project '"<<mainProjectDir<<"'" << std::endl;
                return false;
        }
        //And src dir
        PPath mainProjectSrc(mainProjectDir / PPath("src"));
        if(!mainProjectSrc.createDirectory()){
                std::cerr << "project_generator : cannot create source directory of project '"<<mainProjectSrc<<"'" << std::endl;
                return false;
        }
        //Let's generate sources
        PString className = configFile.getFileName().eraseExtension();
        if(!saveParserClassConfig(mainProjectSrc / className, configFile, true, true, true, mainProjectDir, projectConfig.name.toLower())){
                std::cerr << "project_generator : can't save file '"<<className<<"'[.h or .cpp]" << std::endl;
                return false;
        }
        //Now, some CMakeLists.txt of the sources
        PPath cmakeListsSrc(mainProjectSrc / PPath("CMakeLists.txt"));
        if(!project_generator_cmakeListsSrc(cmakeListsSrc, projectConfig.name, projectConfig.name.toLower())){return false;}
        //The main CMakeLists
        PPath cmakeListsMain(mainProjectDir / PPath("CMakeLists.txt"));
        if(!project_generator_cmakeListsMain(cmakeListsMain, projectConfig, configFile.getFileName().eraseExtension())){return false;}
        //CMakeLists of the tests
        PPath cmakeListsTest(mainProjectDir / PPath("TESTS/CMakeLists.txt"));
        if(!project_generator_cmakeListsTest(cmakeListsTest, configFile.getFileName().eraseExtension())){return false;}
        //The readme
        PPath readmeFile(mainProjectDir / PPath("README.md"));
        if(!project_generator_readme(readmeFile, projectConfig)){return false;}
        //The gitignore
        PPath gitignoreFile(mainProjectDir / PPath(".gitignore"));
        if(!project_generator_gitignore(gitignoreFile)){return false;}
        
        PPath gitlabciFile(mainProjectDir / PPath(".gitlab-ci.yml"));
        if(!project_generator_gitlabci(gitlabciFile, projectConfig)){return false;}
        if(isPythonWrapper){
                return project_wrapper_generator(projectConfig, configFile);
        }
        return true;
}

References PPath::createDirectory(), PPath::eraseExtension(), PPath::getFileName(), ProjectConfig::name, project_generator_cmakeListsMain(), project_generator_cmakeListsSrc(), project_generator_cmakeListsTest(), project_generator_gitignore(), project_generator_gitlabci(), project_generator_loadConfig(), project_generator_readme(), project_wrapper_generator(), saveParserClassConfig(), and PString::toLower().

Here is the call graph for this function:

project_generator_cmakeListsMain()

bool project_generator_cmakeListsMain	(	const PPath &	fileName,
		const ProjectConfig &	projectConfig,
		const PString &	baseConfigClassName
	)

Create the main CMakeLists.txt of the project directory.

Parameters

fileName	: name of the file to be created
projectConfig	: config of the project
baseConfigClassName	: base name of the config class file

Returns

true on success, false otherwise

Definition at line 82 of file project_generator.cpp.

                                                                                                                                       {
        PString body;
        body += getCMakeListsHeader();
        
        body += "cmake_minimum_required(VERSION 3.10)\n";
        body += "project("+projectConfig.name+")\n";
 
        body += "\nfind_package(PhoenixCMake REQUIRED)\n\n";
 
        body += "phoenix_base_project(\""+projectConfig.name+"\" \""+projectConfig.version+"\"\n";
        body += "\t\t\""+projectConfig.description+"\"\n";
        body += "\t\t\""+projectConfig.url+"\")\n\n";
 
        body += "pull_extra_module(\"PhoenixDataStream\" \"https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixDataStream.git\")\n";
        body += "pull_extra_module(\"PhoenixTypeStream\" \"https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixTypeStream.git\")\n\n";
 
        body += "phoenix_include_directories(\n";
        body += "\t${CMAKE_CURRENT_SOURCE_DIR}\n";
        body += "\t${CMAKE_CURRENT_BINARY_DIR}\n";
        body += "\t${CMAKE_CURRENT_SOURCE_DIR}/src\n";
        body += ")\n\n";
        body += "phoenix_create_find("+projectConfig.name+" "+projectConfig.name.toLower()+" "+baseConfigClassName+".h "" PhoenixDataStream PhoenixTypeStream)\n\n";
        body += "add_subdirectory(src)\n\n";
        body += "phoenix_tests()\n";
        
        return fileName.saveFileContent(body);
}

References ProjectConfig::description, getCMakeListsHeader(), ProjectConfig::name, PPath::saveFileContent(), PString::toLower(), ProjectConfig::url, and ProjectConfig::version.

Referenced by project_generator().

Here is the call graph for this function:

Here is the caller graph for this function:

project_generator_cmakeListsSrc()

bool project_generator_cmakeListsSrc	(	const PPath &	fileName,
		const PString &	projectName,
		const PString &	libName
	)

Create the CMakeLists.txt of the src directory.

Parameters

fileName	: name of the file to be created
projectName	: name of hte project
libName	: name of the library to be created

Returns

true on success, false otherwise

Definition at line 45 of file project_generator.cpp.

                                                                                                                  {
        PString body;
        body += getCMakeListsHeader();
        
        body += "file(GLOB "+libName+"_SRC \"${CMAKE_CURRENT_SOURCE_DIR}/*.cpp\")\n";
        body += "phoenix_add_library("+libName+" ${"+libName+"_SRC})\n";
        body += "target_link_libraries("+libName+" phoenix_type_stream phoenix_data_stream)\n";
 
        body += "install(TARGETS "+libName+" LIBRARY DESTINATION ${LIBRARY_DIRECTORY} ARCHIVE DESTINATION ${LIBRARY_DIRECTORY})\n";
 
        body += "file(GLOB headers \"${CMAKE_CURRENT_SOURCE_DIR}/*.h\")\n";
 
        body += "install(FILES ${headers} DESTINATION include/"+projectName+")\n";
        
        return fileName.saveFileContent(body);
}

References getCMakeListsHeader(), and PPath::saveFileContent().

Referenced by project_generator().

Here is the call graph for this function:

Here is the caller graph for this function:

project_generator_cmakeListsTest()

bool project_generator_cmakeListsTest	(	const PPath &	fileName,
		const PString &	baseConfigClassName
	)

Create the main CMakeLists.txt of the project directory.

Parameters

fileName	: name of the file to be created
baseConfigClassName	: base name of the config class file

Returns

true on success, false otherwise

Definition at line 67 of file project_generator.cpp.

                                                                                                  {
        PString body;
        body += getCMakeListsHeader();
        
        body += "add_subdirectory(TEST_"+baseConfigClassName.toUpper()+")\n\n";
        
        return fileName.saveFileContent(body);
}

References getCMakeListsHeader(), PPath::saveFileContent(), and PString::toUpper().

Referenced by project_generator().

Here is the call graph for this function:

Here is the caller graph for this function:

project_generator_gitignore()

bool project_generator_gitignore

(

const PPath &

fileName

)

Create the .gitignore of the project.

Parameters

fileName

: name of the file to be created

Returns

true on success, false otherwise

Definition at line 159 of file project_generator.cpp.

                                                        {
        PString body;
        body += "build\n";
        body += "build2\n";
        body += ".kdev4/\n";
        body += "*.kdev4\n";
        body += ".tmp_project/\n";
        body += "tmp_project/\n\n";
        return fileName.saveFileContent(body);
}

References PPath::saveFileContent().

Referenced by project_generator().

Here is the call graph for this function:

Here is the caller graph for this function:

project_generator_gitlabci()

bool project_generator_gitlabci	(	const PPath &	fileName,
		const ProjectConfig &	projectConfig
	)

Create the .gitlab-ci.yml of the project.

Parameters

fileName	: name of the file to be created
projectConfig	: config of the project

Returns

true on success, false otherwise

Definition at line 175 of file project_generator.cpp.

                                                                                            {
        PString specificRunnerTag;
        if(projectConfig.runnerTag != ""){
                specificRunnerTag += "        tags:\n";
                specificRunnerTag += "                - "+projectConfig.runnerTag+"\n";
        }
        
        PString body;
        body += "\n";
        body += getCMakeListsHeader();
        body += "\nstages:\n";
        body += "- BuildTestinstall\n";
        body += "- DocCoverage\n";
        body += "- deploy\n\n";
        
        body += "dailyBuildMasterAll:\n";
        body += "        image: gitlab-registry.in2p3.fr/cta-lapp/phoenix_libs2/phoenixcmake/phoenix_cmake_ubuntu_2204:latest\n";
        body += "        stage: BuildTestinstall\n";
        body += "        script:\n";
        body += "        - export LD_LIBRARY_PATH=/usr/lib\n";
        body += "        - env\n";
        body += "        - mkdir -p build\n";
        body += "        - cd build\n";
        body += "        - >\n";
        body += "                cmake ..\n";
        body += "                -DCMAKE_INSTALL_PREFIX=/usr\n";
        body += "                -DSELF_TESTS_MODE=yes\n";
        body += "                -DCMAKE_MODULE_PATH=/usr/share/cmake/Modules\n";
        body += "        - make all\n";
        body += "        - make install\n";
        body += "        - make test\n";
        body += "        only:\n";
        body += "        - branches\n";
        body += "        - tags\n";
        body += specificRunnerTag;
        body += "\n";
        
        body += "TestCoverage:\n";
        body += "        image: gitlab-registry.in2p3.fr/cta-lapp/phoenix_libs2/phoenixcmake/phoenix_cmake_ubuntu_2204:latest\n";
        body += "        stage: DocCoverage\n";
        body += "        script:\n";
        body += "        - export LD_LIBRARY_PATH=/usr/lib\n";
        body += "        - env\n";
        body += "        - mkdir -p build coverage\n";
        body += "        - cd build\n";
        body += "        - >\n";
        body += "                cmake ..\n";
        body += "                -DCMAKE_INSTALL_PREFIX=/usr\n";
        body += "                -DSELF_TESTS_MODE=yes\n";
        body += "                -DCMAKE_BUILD_TYPE=Coverage\n";
        body += "                -DCMAKE_MODULE_PATH=/usr/share/cmake/Modules\n";
        body += "        - make all\n";
        body += "        - make install\n";
        body += "        - make test\n";
        body += "        - ./uninstall_"+projectConfig.name.toLower()+"\n";
        body += "        - cd ../coverage\n";
        body += "        - gcovr -r ../ --exclude-throw-branches --html cov_report.html --html-details\n";
        body += "        - gcovr -r ../ --exclude-throw-branches --xml Coverage.xml\n";
        body += "        - gcovr -r ../ --exclude-throw-branches\n";
        body += "        coverage: '/TOTAL.*\\s+(\\d+\\%)$/'\n";
        body += "        artifacts:\n";
        body += "                paths:\n";
        body += "                - coverage\n";
        body += "                expire_in: 8d\n";
        body += "        only:\n";
        body += "        - branches\n";
        body += "        - tags\n";
        body += specificRunnerTag;
        body += "\n";
        body += "Doc:\n";
        body += "        image: gitlab-registry.in2p3.fr/cta-lapp/phoenix_libs2/phoenixcmake/phoenix_cmake_ubuntu_2204:latest\n";
        body += "        stage: DocCoverage\n";
        body += "        script:\n";
        body += "        - export LD_LIBRARY_PATH=/usr/lib\n";
        body += "        - env\n";
        body += "        - rm -fr build public\n";
        body += "        - mkdir -p build\n";
        body += "        - mkdir -p public\n";
        body += "        - cd build\n";
        body += "        - >\n";
        body += "                cmake ..\n";
        body += "                -DCMAKE_INSTALL_PREFIX=/usr\n";
        body += "                -DDOC_MODE=yes\n";
        body += "                -DCMAKE_MODULE_PATH=/usr/share/cmake/Modules\n";
        body += "        - make all\n";
        body += "        - make doc\n";
        body += "        - scp -r doc/html/* ../public\n";
        body += "        artifacts:\n";
        body += "                paths:\n";
        body += "                - public\n";
        body += "                expire_in: 8d\n";
        body += "        only:\n";
        body += "        - branches\n";
        body += "        - tags\n";
        body += specificRunnerTag;
        body += "\n";
        body += "pages:\n";
        body += "        stage: deploy\n";
        body += "        image: gitlab-registry.in2p3.fr/cta-lapp/phoenix_libs2/phoenixcmake/phoenix_cmake_ubuntu_2204:latest\n";
        body += "        script:\n";
        body += "        - mv coverage public/\n";
        body += "        artifacts:\n";
        body += "                paths:\n";
        body += "                - public\n";
        body += "                expire_in: 8d\n";
        body += specificRunnerTag;
        body += "\n";
        
        return fileName.saveFileContent(body);
}

References getCMakeListsHeader(), ProjectConfig::name, ProjectConfig::runnerTag, PPath::saveFileContent(), and PString::toLower().

Referenced by project_generator().

Here is the call graph for this function:

Here is the caller graph for this function:

project_generator_loadConfig()

bool project_generator_loadConfig	(	ProjectConfig &	config,
		const PPath &	descriptionFile
	)

Load the project configuration.

Parameters

[out]	config	: loaded project configuration
	descriptionFile	: description of the full project

Returns

true on success, false otherwise

Definition at line 18 of file project_generator.cpp.

                                                                                        {
        DicoValue dico;
        if(!parser_toml(dico, descriptionFile)){
                std::cerr << "project_generator : cannot parse config file '"<<descriptionFile<<"'" << std::endl;
                return false;
        }
        DicoValue * mapProject = dico.getMap("project");
        if(mapProject == NULL){
                std::cerr << "project_generator_loadConfig : Missing [project] in config file '"<<descriptionFile<<"'" << std::endl;
                return false;
        }
        //TODO : It should be better to tell if there are missing values, but it's late ...
        config.name = phoenix_get_string(*mapProject, "name", "MyAwesomeProject");
        config.url = phoenix_get_string(*mapProject, "url", "need and url");
        config.version = phoenix_get_string(*mapProject, "version", "0.0.1");
        config.description = phoenix_get_string(*mapProject, "description", "A very important project");
        config.mainBranch = phoenix_get_string(*mapProject, "main_branch", "master");
        config.runnerTag = phoenix_get_string(*mapProject, "runner_tag", "");   //Could be MUST_big_runner
        return true;
}

References ProjectConfig::description, DicoValue::getMap(), ProjectConfig::mainBranch, ProjectConfig::name, parser_toml(), phoenix_get_string(), ProjectConfig::runnerTag, ProjectConfig::url, and ProjectConfig::version.

Referenced by project_generator().

Here is the call graph for this function:

Here is the caller graph for this function:

project_generator_readme()

bool project_generator_readme	(	const PPath &	fileName,
		const ProjectConfig &	projectConfig
	)

Create the readme of the project directory.

Parameters

fileName	: name of the file to be created
projectConfig	: config of the project

Returns

true on success, false otherwise

Definition at line 115 of file project_generator.cpp.

                                                                                          {
        PString body, mainBranch(projectConfig.mainBranch);
        body += "![PLIBS_9 logo](doc/logo.png)\n\n";
        
        body += "----\n";
        body += "[![pipeline status]("+projectConfig.url+"/badges/"+mainBranch+"/pipeline.svg)]("+projectConfig.url+"/-/commits/"+mainBranch+")\n";
        body += "[![coverage report]("+projectConfig.url+"/badges/"+mainBranch+"/coverage.svg)]("+projectConfig.url+"/-/commits/"+mainBranch+")\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 += projectConfig.description + "\n\n";
        
        PString docPagesUrl = getGitlabDocUrl(projectConfig.url);
        if(docPagesUrl != ""){
                body += "# Documentation\n\n";
                body += "[See the pages documentation](" + docPagesUrl + ")\n\n";
        }
        body += "# Requirements\n\n";
        body += "- c++ compiler (tested with g++ 11,12 and clang 14)\n";
        body += "- [PhoenixCMake](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixCMake)\n";
        body += "- cmake > 3\n";
        body += "- make\n\n";
 
        body += "# Installation for Users\n\n";
 
        body += "```sh\n";
        body += "git clone "+projectConfig.url+".git\n";
        body += "cd "+projectConfig.name+"\n";
        body += "./install.sh\n";
        body += "```\n\n";
 
        return fileName.saveFileContent(body);
}

References ProjectConfig::description, getGitlabDocUrl(), ProjectConfig::mainBranch, ProjectConfig::name, PPath::saveFileContent(), ProjectConfig::url, and ProjectConfig::version.

Referenced by project_generator().

Here is the call graph for this function:

Here is the caller graph for this function: