cmakelist_generator.h File Reference

#include "PCMakeListsGenerator.h"

Include dependency graph for cmakelist_generator.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
PString	getCMakeListsHeader ()
	Get the CMakeLists.txt header. More...
PString	getFindPackageFileName (const PString &libName)
	Gets the name of the find_package cmake macro with the library name. More...
PString	getFullLibraryName (const PCMakeLibrary &cmakeLib)
	Gets the name of the library binary file. More...
bool	saveCMakeExecutable (std::ofstream &fs, const PCMakeExecutable &cmakeExecutable)
	Saves a cmake executable in a file. More...
bool	saveCMakeIncludeDirectories (std::ofstream &fs, const PVecPath &listIncludeDirectories)
	Saves the list of include directories. More...
bool	saveCMakeLibrary (std::ofstream &fs, const PCMakeLibrary &cmakeLib)
	Saves a cmake library in a file. More...
bool	saveCMakeLibraryFindPackageFile (const PCMakeLibrary &cmakeLib, const PPath &extraFileName=PPath(), const PPath &extraPreviousFileName=PPath())
	Saves the find_package cmake macro with the library file. More...
bool	saveCMakeLinkDirectories (std::ofstream &fs, const PVecPath &listLinkDirectories)
	Saves the list of link directories. More...
bool	saveCMakeListsGenerator (const PPath &fileName, const PCMakeListsGenerator &cmakeGenerator)
	Saves the PCMakeListsGenerator. More...
bool	saveCMakeListsGenerator (std::ofstream &fs, const PCMakeListsGenerator &cmakeGenerator)
	Saves the PCMakeListsGenerator. More...
bool	saveCMakeUsePackages (std::ofstream &fs, const PVecString &listPackages)
	Saves the list of packages dependencies. More...

Function Documentation

getCMakeListsHeader()

PString getCMakeListsHeader

(

)

Get the CMakeLists.txt header.

Returns

CMakeLists.txt header

Definition at line 12 of file cmakelist_generator.cpp.

                             {
        PString body;
        body += "#========================================\n";
        body += "#\tAuteur : Pierre Aubert\n";
        body += "#\tMail : pierre.aubert@lapp.in2p3.fr\n";
        body += "#\tLicence : CeCILL-C\n";
        body += "#========================================\n\n";
        
        body += "#========================================\n";
        body += "#\tThis file was generated automatically by phoenix_filegenerator https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixFileGenerator\n";
        body += "#\tusing phoenix_generator library https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixGenerator\n";
        body += "#\tYou should not modify this file\n";
        body += "#========================================\n\n";
        return body;
}

Referenced by project_generator_cmakeListsMain(), project_generator_cmakeListsSrc(), project_generator_cmakeListsTest(), project_generator_gitlabci(), project_wrapper_classTest(), project_wrapper_generator_pyprojectToml(), project_wrapper_generator_setuppy(), and saveClassTestCMakeLists().

Here is the caller graph for this function:

getFindPackageFileName()

PString getFindPackageFileName

(

const PString &

libName

)

Gets the name of the find_package cmake macro with the library name.

Parameters

libName

: library name

Returns

corresponding find_package cmake macro file name

Definition at line 32 of file cmakelist_generator.cpp.

                                                       {
        if(libName == "") return "";
        return "Find" + libName.toUpper() + ".cmake";
}

References PString::toUpper().

Referenced by saveCMakeLibraryFindPackageFile(), and saveCMakeListsGenerator().

Here is the call graph for this function:

Here is the caller graph for this function:

getFullLibraryName()

PString getFullLibraryName

(

const PCMakeLibrary &

cmakeLib

)

Gets the name of the library binary file.

Parameters

cmakeLib

: library

Returns

name of the library binary file

Definition at line 41 of file cmakelist_generator.cpp.

                                                          {
#ifdef __APPLE
        if(cmakeLib.getIsShared()) return "lib" + cmakeLib.getName() + ".dylib";
#else
        if(cmakeLib.getIsShared()) return "lib" + cmakeLib.getName() + ".so";
#endif
        else return "lib" + cmakeLib.getName() + ".a";
}

References PCMakeLibrary::getIsShared(), and PCMakeLibrary::getName().

Referenced by saveCMakeLibraryFindPackageFile().

Here is the call graph for this function:

Here is the caller graph for this function:

saveCMakeExecutable()

bool saveCMakeExecutable	(	std::ofstream &	fs,
		const PCMakeExecutable &	cmakeExecutable
	)

Saves a cmake executable in a file.

Parameters

[out]	fs	: file to complete
	cmakeExecutable	: cmake executable we want to save in the file

Returns

true on success, false otherwise

Definition at line 209 of file cmakelist_generator.cpp.

                                                                                    {
        if(cmakeExecutable.getName() == "" || cmakeExecutable.getListSources().size() == 0lu){
                std::cerr << "saveCMakeExecutable : no source or name for target" << std::endl;
                return true;
        }
        if(cmakeExecutable.getRemoveDefinitions() != "") fs << "remove_definitions("<<cmakeExecutable.getRemoveDefinitions()<<")" << std::endl;
        if(cmakeExecutable.getAddDefinitions() != "") fs << "add_definitions("<<cmakeExecutable.getAddDefinitions()<<")" << std::endl;
        fs << "add_executable(" << cmakeExecutable.getName();
        fs << std::endl;
        const PVecPath & listSources = cmakeExecutable.getListSources();
        for(PVecPath::const_iterator it(listSources.begin()); it != listSources.end(); ++it){
                fs << "\t" << *it << std::endl;
        }
        fs << ")" << std::endl << std::endl;
        const PVecString & listDependencies = cmakeExecutable.getListDependecies();
        if(listDependencies.size() != 0lu){
                fs << "target_link_libraries(" << cmakeExecutable.getName() << std::endl;
                for(PVecString::const_iterator it(listDependencies.begin()); it != listDependencies.end(); ++it){
                        fs << "\t" << *it << std::endl;
                }
                fs << ")" << std::endl << std::endl;
        }
        PPath libInstall(cmakeExecutable.getInstallDirectory());
        if(libInstall != ""){
                fs << "install(TARGETS "<<cmakeExecutable.getName()<<" RUNTIME DESTINATION "<<libInstall<<" ARCHIVE DESTINATION "<<libInstall<<")" << std::endl;
        }
        if(cmakeExecutable.getOtherCommandAfter() != ""){fs << cmakeExecutable.getOtherCommandAfter();}
        fs << std::endl << std::endl;
//      if(cmakeExecutable.getWantGenerateFindPackage()){
//              if(!saveCMakeLibraryFindPackageFile(cmakeExecutable)){
//                      cerr << "saveCMakeLibrary : can't create the find_package cmake macro file" << std::endl;
//                      return false;
//              }
//      }
        return true;
        
}

References PCMakeExecutable::getAddDefinitions(), PCMakeExecutable::getInstallDirectory(), PCMakeExecutable::getListDependecies(), PCMakeExecutable::getListSources(), PCMakeExecutable::getName(), PCMakeExecutable::getOtherCommandAfter(), and PCMakeExecutable::getRemoveDefinitions().

Referenced by saveCMakeListsGenerator().

Here is the call graph for this function:

Here is the caller graph for this function:

saveCMakeIncludeDirectories()

bool saveCMakeIncludeDirectories	(	std::ofstream &	fs,
		const PVecPath &	listIncludeDirectories
	)

Saves the list of include directories.

Parameters

[out]	fs	: file to complete
	listIncludeDirectories	: list of include directories

Returns

true on success, false otherwise

Definition at line 266 of file cmakelist_generator.cpp.

                                                                                           {
        if(listIncludeDirectories.size() == 0lu) return true;
        fs << "include_directories" << std::endl;
        for(PVecPath::const_iterator it(listIncludeDirectories.begin()); it != listIncludeDirectories.end(); ++it){
                fs << *it << std::endl;
        }
        fs << ")" << std::endl;
        fs << std::endl << std::endl;
        return true;
}

Referenced by saveCMakeListsGenerator().

Here is the caller graph for this function:

saveCMakeLibrary()

bool saveCMakeLibrary	(	std::ofstream &	fs,
		const PCMakeLibrary &	cmakeLib
	)

Saves a cmake library in a file.

Parameters

[out]	fs	: file to complete
	cmakeLib	: cmake library we want to save in the file

Returns

true on success, false otherwise

Definition at line 159 of file cmakelist_generator.cpp.

                                                                       {
        if(cmakeLib.getName() == "" || cmakeLib.getListSources().size() == 0lu) return true;
        if(cmakeLib.getRemoveDefinitions() != "") fs << "remove_definitions("<<cmakeLib.getRemoveDefinitions()<<")" << std::endl;
        if(cmakeLib.getAddDefinitions() != "") fs << "add_definitions("<<cmakeLib.getAddDefinitions()<<")" << std::endl;
        fs << "add_library(" << cmakeLib.getName();
        if(cmakeLib.getIsShared()){
                fs << " SHARED";
        }
        fs << std::endl;
        const PVecPath & listSources = cmakeLib.getListSources();
        for(PVecPath::const_iterator it(listSources.begin()); it != listSources.end(); ++it){
                fs << "\t" << *it << std::endl;
        }
        fs << ")" << std::endl << std::endl;
        const PVecString & listDependencies = cmakeLib.getListLibDependecies();
        if(listDependencies.size() != 0lu){
                fs << "target_link_libraries(" << cmakeLib.getName() << std::endl;
                for(PVecString::const_iterator it(listDependencies.begin()); it != listDependencies.end(); ++it){
                        fs << "\t" << *it << std::endl;
                }
                fs << ")" << std::endl << std::endl;
        }
        PPath libInstall(cmakeLib.getInstallDirectory());
        if(libInstall != ""){
                fs << "install(TARGETS "<<cmakeLib.getName()<<" LIBRARY DESTINATION "<<libInstall<<" ARCHIVE DESTINATION "<<libInstall<<")" << std::endl;
        }
        const PVecPath & listHeaders = cmakeLib.getListHeaders();
        if(listHeaders.size() != 0lu){
                fs << "set(headers" << cmakeLib.getName()<<" " << std::endl;
                for(PVecPath::const_iterator it(listHeaders.begin()); it != listHeaders.end(); ++it){
                        fs << "\t" << *it << std::endl;
                }
                fs << ")" << std::endl << std::endl;
                fs << "install(FILES ${headers" << cmakeLib.getName()<<"} DESTINATION include/"<<cmakeLib.getName().toUpper()<<")" << std::endl;
        }
        if(cmakeLib.getOtherCommandAfter() != ""){fs << cmakeLib.getOtherCommandAfter();}
        if(cmakeLib.getWantGenerateFindPackage()){
                if(!saveCMakeLibraryFindPackageFile(cmakeLib)){
                        std::cerr << "saveCMakeLibrary : can't create the find_package cmake macro file" << std::endl;
                        return false;
                }
        }
        return true;
}

References PCMakeLibrary::getAddDefinitions(), PCMakeLibrary::getInstallDirectory(), PCMakeLibrary::getIsShared(), PCMakeLibrary::getListHeaders(), PCMakeLibrary::getListLibDependecies(), PCMakeLibrary::getListSources(), PCMakeLibrary::getName(), PCMakeLibrary::getOtherCommandAfter(), PCMakeLibrary::getRemoveDefinitions(), PCMakeLibrary::getWantGenerateFindPackage(), saveCMakeLibraryFindPackageFile(), and PString::toUpper().

Referenced by saveCMakeListsGenerator().

Here is the call graph for this function:

Here is the caller graph for this function:

saveCMakeLibraryFindPackageFile()

bool saveCMakeLibraryFindPackageFile	(	const PCMakeLibrary &	cmakeLib,
		const PPath &	extraFileName,
		const PPath &	extraPreviousFileName
	)

Saves the find_package cmake macro with the library file.

Parameters

cmakeLib	: library we want to generate the cmake find_package macro
extraFileName	: extra filename, its content will be put after the generated find
extraPreviousFileName	: extra filename, its content will be put before the generated find

Returns

true on success, false otherwise

Definition at line 129 of file cmakelist_generator.cpp.

                                                                                                                                      {
        if(!cmakeLib.getWantGenerateFindPackage()) return true;
        std::ofstream fs;
        PPath findPackageFileName(getFindPackageFileName(cmakeLib.getName()));
        
        fs.open(findPackageFileName.c_str());
        if(!fs.is_open()){
                std::cerr << "saveCMakeLibraryFindPackageFile : can't open file '" << findPackageFileName << "'" << std::endl;
                return false;
        }
        
        if(extraPreviousFileName != ""){
                fs << extraPreviousFileName.loadFileContent() << std::endl;
        }
        PPath libPrefix(cmakeLib.getName().toUpper());
        saveFindPackageHeader(fs, libPrefix, cmakeLib.getListHeaders());
        PPath fullLibraryName(getFullLibraryName(cmakeLib));
        saveFindPackageLibrary(fs, libPrefix, cmakeLib.getName(), fullLibraryName);
        if(extraFileName != ""){
                fs << extraFileName.loadFileContent() << std::endl;
        }
        fs.close();
        return true;
}

References getFindPackageFileName(), getFullLibraryName(), PCMakeLibrary::getListHeaders(), PCMakeLibrary::getName(), PCMakeLibrary::getWantGenerateFindPackage(), PPath::loadFileContent(), saveFindPackageHeader(), saveFindPackageLibrary(), and PString::toUpper().

Referenced by saveCMakeLibrary().

Here is the call graph for this function:

Here is the caller graph for this function:

saveCMakeLinkDirectories()

bool saveCMakeLinkDirectories	(	std::ofstream &	fs,
		const PVecPath &	listLinkDirectories
	)

Saves the list of link directories.

Parameters

[out]	fs	: file to complete
	listLinkDirectories	: list of link directories

Returns

true on success, false otherwise

Definition at line 282 of file cmakelist_generator.cpp.

                                                                                     {
        if(listLinkDirectories.size() == 0lu) return true;
        fs << "link_directories" << std::endl;
        for(PVecPath::const_iterator it(listLinkDirectories.begin()); it != listLinkDirectories.end(); ++it){
                fs << *it << std::endl;
        }
        fs << ")" << std::endl;
        fs << std::endl << std::endl;
        return true;
}

Referenced by saveCMakeListsGenerator().

Here is the caller graph for this function:

saveCMakeListsGenerator() [1/2]

bool saveCMakeListsGenerator	(	const PPath &	fileName,
		const PCMakeListsGenerator &	cmakeGenerator
	)

Saves the PCMakeListsGenerator.

Parameters

fileName	: name of the file we want to write
cmakeGenerator	: PCMakeListsGenerator we want to save

Returns

true on success, false otherwise

Definition at line 298 of file cmakelist_generator.cpp.

                                                                                                 {
        if(fileName == "") return false;
        std::ofstream fs;
        fs.open(fileName.c_str());
        if(!fs.is_open()){
                std::cerr << "saveCMakeListsGenerator : can't open file '" << fileName << "'" << std::endl;
                return false;
        }
        bool b = saveCMakeListsGenerator(fs, cmakeGenerator);
        fs.close();
        return b;
}

saveCMakeListsGenerator() [2/2]

bool saveCMakeListsGenerator	(	std::ofstream &	fs,
		const PCMakeListsGenerator &	cmakeGenerator
	)

Saves the PCMakeListsGenerator.

Parameters

[out]	fs	: file to complete
	cmakeGenerator	: PCMakeListsGenerator we want to save

Returns

true on success, false otherwise

Definition at line 316 of file cmakelist_generator.cpp.

                                                                                           {
        if(cmakeGenerator.getProjectName() != ""){
                fs << "project(" << cmakeGenerator.getProjectName() << ")" << std::endl;
                fs << "cmake_minimum_required(VERSION 3.0)" << std::endl << std::endl;
        }
        fs << "set(PHOENIX_PREFIX \"$ENV{HOME}/usr\" CACHE STRING \"PHOENIX prefix prefix\")" << std::endl;
        fs << "set(CMAKE_INSTALL_PREFIX \"${PHOENIX_PREFIX}\")" << std::endl;
        if(cmakeGenerator.getCmakeModulePath() != ""){
                fs << "set(CMAKE_MODULE_PATH "<<cmakeGenerator.getCmakeModulePath()<<")" << std::endl;
        }
//      fs << "add_definitions(-g -O2 -Wall -Werror)" << std::endl;
        bool b = saveCMakeUsePackages(fs, cmakeGenerator.getListPackage());
        b &= saveCMakeIncludeDirectories(fs, cmakeGenerator.getListIncludeDirectories());
        b &= saveCMakeLinkDirectories(fs, cmakeGenerator.getListLinkDirecories());
        const std::vector<PCMakeLibrary> & listLib = cmakeGenerator.getListLibraries();
        bool haveFindMacro(false);
        if(listLib.size() != 0lu){
                for(std::vector<PCMakeLibrary>::const_iterator it(listLib.begin()); it != listLib.end(); ++it){
                        b &= saveCMakeLibrary(fs, *it);
                        haveFindMacro |= it->getWantGenerateFindPackage();
                }
        }
        const std::vector<PCMakeExecutable> & listExecutable = cmakeGenerator.getListExecutable();
        if(listExecutable.size() != 0lu){
                for(std::vector<PCMakeExecutable>::const_iterator it(listExecutable.begin()); it != listExecutable.end(); ++it){
                        b &= saveCMakeExecutable(fs, *it);
                        haveFindMacro |= it->getWantGenerateFindPackage();
                }
        }
        if(haveFindMacro){
                fs << "install(FILES";
                for(std::vector<PCMakeLibrary>::const_iterator it(listLib.begin()); it != listLib.end(); ++it){
                        if(!it->getWantGenerateFindPackage()) continue;
                        fs << " ${CMAKE_CURRENT_SOURCE_DIR}/" << getFindPackageFileName(it->getName());
                }
                for(std::vector<PCMakeExecutable>::const_iterator it(listExecutable.begin()); it != listExecutable.end(); ++it){
                        if(!it->getWantGenerateFindPackage()) continue;
                        fs << " ${CMAKE_CURRENT_SOURCE_DIR}/" << getFindPackageFileName(it->getName());
                }
                fs << " DESTINATION share/cmake)" << std::endl << std::endl;
        }
        if(cmakeGenerator.getTestDirectory() != ""){
                fs << "if(SELF_TESTS_MODE)" << std::endl;
                fs << "\tinclude(CTest)" << std::endl;
                fs << "\tadd_subdirectory("<<cmakeGenerator.getTestDirectory()<<")" << std::endl;
                fs << "endif()" << std::endl << std::endl;
        }
        fs << std::endl << std::endl << std::endl;
        return b;
}

References PCMakeListsGenerator::getCmakeModulePath(), getFindPackageFileName(), PCMakeListsGenerator::getListExecutable(), PCMakeListsGenerator::getListIncludeDirectories(), PCMakeListsGenerator::getListLibraries(), PCMakeListsGenerator::getListLinkDirecories(), PCMakeListsGenerator::getListPackage(), PCMakeListsGenerator::getProjectName(), PCMakeListsGenerator::getTestDirectory(), saveCMakeExecutable(), saveCMakeIncludeDirectories(), saveCMakeLibrary(), saveCMakeLinkDirectories(), and saveCMakeUsePackages().

Here is the call graph for this function:

saveCMakeUsePackages()

bool saveCMakeUsePackages	(	std::ofstream &	fs,
		const PVecString &	listPackages
	)

Saves the list of packages dependencies.

Parameters

[out]	fs	: file to complete
	listPackages	: list of packages dependencies

Returns

true on success, false otherwise

Definition at line 252 of file cmakelist_generator.cpp.

                                                                            {
        if(listPackages.size() == 0lu) return true;
        for(PVecString::const_iterator it(listPackages.begin()); it != listPackages.end(); ++it){
                fs << "find_package("<<*it<<" REQUIRED)" << std::endl;
        }
        fs << std::endl << std::endl;
        return true;
}

Referenced by saveCMakeListsGenerator().

Here is the caller graph for this function: