/*========================================================================= Program: CMake - Cross-Platform Makefile Generator Module: $RCSfile: cmExtraEclipseCDT4Generator.cxx,v $ Language: C++ Date: $Date: 2008-08-06 21:04:19 $ Version: $Revision: 1.13.2.2 $ Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved. Copyright (c) 2004 Alexander Neundorf neundorf@kde.org, All rights reserved. Copyright (c) 2007 Miguel A. Figueroa-Villanueva. All rights reserved. See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the above copyright notices for more information. =========================================================================*/ #include "cmExtraEclipseCDT4Generator.h" #include "cmGlobalUnixMakefileGenerator3.h" #include "cmLocalUnixMakefileGenerator3.h" #include "cmMakefile.h" #include "cmGeneratedFileStream.h" #include "cmTarget.h" #include "cmSystemTools.h" #include #include //---------------------------------------------------------------------------- cmExtraEclipseCDT4Generator ::cmExtraEclipseCDT4Generator() : cmExternalMakefileProjectGenerator() { // TODO: Verify if __CYGWIN__ should be checked. //#if defined(_WIN32) && !defined(__CYGWIN__) #if defined(_WIN32) this->SupportedGlobalGenerators.push_back("NMake Makefiles"); this->SupportedGlobalGenerators.push_back("MinGW Makefiles"); // this->SupportedGlobalGenerators.push_back("MSYS Makefiles"); #endif this->SupportedGlobalGenerators.push_back("Unix Makefiles"); } //---------------------------------------------------------------------------- void cmExtraEclipseCDT4Generator ::GetDocumentation(cmDocumentationEntry& entry, const char*) const { entry.Name = this->GetName(); entry.Brief = "Generates Eclipse CDT 4.0 project files."; entry.Full = "Project files for Eclipse will be created in the top directory " "and will have a linked resource to every subdirectory which " "features a CMakeLists.txt file containing a PROJECT() call." "Additionally a hierarchy of makefiles is generated into the " "build tree. The appropriate make program can build the project through " "the default make target. A \"make install\" target is also provided."; } //---------------------------------------------------------------------------- void cmExtraEclipseCDT4Generator ::SetGlobalGenerator(cmGlobalGenerator* generator) { cmExternalMakefileProjectGenerator::SetGlobalGenerator(generator); cmGlobalUnixMakefileGenerator3* mf = static_cast(generator); mf->SetToolSupportsColor(true); mf->SetForceVerboseMakefiles(true); mf->EnableInstallTarget(); } //---------------------------------------------------------------------------- void cmExtraEclipseCDT4Generator::Generate() { const cmMakefile* mf = this->GlobalGenerator->GetLocalGenerators()[0]->GetMakefile(); // TODO: Decide if these are local or member variables this->HomeDirectory = mf->GetHomeDirectory(); this->HomeOutputDirectory = mf->GetHomeOutputDirectory(); this->IsOutOfSourceBuild = (this->HomeDirectory!=this->HomeOutputDirectory); this->GenerateSourceProject = (this->IsOutOfSourceBuild && mf->IsOn("ECLIPSE_CDT4_GENERATE_SOURCE_PROJECT")); // NOTE: This is not good, since it pollutes the source tree. However, // Eclipse doesn't allow CVS/SVN to work when the .project is not in // the cvs/svn root directory. Hence, this is provided as an option. if (this->GenerateSourceProject) { // create .project file in the source tree this->CreateSourceProjectFile(); } // create a .project file this->CreateProjectFile(); // create a .cproject file this->CreateCProjectFile(); } void cmExtraEclipseCDT4Generator::CreateSourceProjectFile() const { assert(this->HomeDirectory != this->HomeOutputDirectory); // set up the project name: -Source@ const cmMakefile* mf = this->GlobalGenerator->GetLocalGenerators()[0]->GetMakefile(); std::string name = this->GenerateProjectName(mf->GetProjectName(), "Source", this->GetPathBasename(this->HomeDirectory)); const std::string filename = this->HomeDirectory + "/.project"; cmGeneratedFileStream fout(filename.c_str()); if (!fout) { return; } fout << "\n" "\n" "\t" << name << "\n" "\t\n" "\t\n" "\t\n" "\t\n" "\t\n" "\t\n" "\t\n" "\n" ; } //---------------------------------------------------------------------------- void cmExtraEclipseCDT4Generator::CreateProjectFile() { const cmMakefile* mf = this->GlobalGenerator->GetLocalGenerators()[0]->GetMakefile(); const std::string filename = this->HomeOutputDirectory + "/.project"; cmGeneratedFileStream fout(filename.c_str()); if (!fout) { return; } fout << "\n" "\n" "\t" << this->GenerateProjectName(mf->GetProjectName(), mf->GetDefinition("CMAKE_BUILD_TYPE"), this->GetPathBasename(this->HomeOutputDirectory)) << "\n" "\t\n" "\t\n" "\t\n" "\t\n" "\t\t\n" "\t\t\torg.eclipse.cdt.make.core.makeBuilder\n" "\t\t\tclean,full,incremental,\n" "\t\t\t\n" ; // use clean target fout << "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.cleanBuildTarget\n" "\t\t\t\t\tclean\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.enableCleanBuild\n" "\t\t\t\t\ttrue\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.append_environment\n" "\t\t\t\t\ttrue\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.stopOnError\n" "\t\t\t\t\ttrue\n" "\t\t\t\t\n" ; // set the make command std::string make = mf->GetRequiredDefinition("CMAKE_MAKE_PROGRAM"); fout << "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.enabledIncrementalBuild\n" "\t\t\t\t\ttrue\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.build.command\n" "\t\t\t\t\t" + this->GetEclipsePath(make) + "\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.contents\n" "\t\t\t\t\torg.eclipse.cdt.make.core.activeConfigSettings\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.build.target.inc\n" "\t\t\t\t\tall\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.build.arguments\n" "\t\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.buildLocation\n" "\t\t\t\t\t" << this->GetEclipsePath(this->HomeOutputDirectory) << "\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.useDefaultBuildCmd\n" "\t\t\t\t\tfalse\n" "\t\t\t\t\n" ; // set project specific environment fout << "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.environment\n" "\t\t\t\t\t" ; // set vsvars32.bat environment available at CMake time, // but not necessarily when eclipse is open if (make.find("nmake") != std::string::npos) { if (getenv("PATH")) { fout << "PATH=" << getenv("PATH") << "|"; } if (getenv("INCLUDE")) { fout << "INCLUDE=" << getenv("INCLUDE") << "|"; } if (getenv("LIB")) { fout << "LIB=" << getenv("LIB") << "|"; } if (getenv("LIBPATH")) { fout << "LIBPATH=" << getenv("LIBPATH") << "|"; } } fout << "\n" "\t\t\t\t\n" ; fout << "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.enableFullBuild\n" "\t\t\t\t\ttrue\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.build.target.auto\n" "\t\t\t\t\tall\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.enableAutoBuild\n" "\t\t\t\t\tfalse\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.build.target.clean\n" "\t\t\t\t\tclean\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.fullBuildTarget\n" "\t\t\t\t\tall\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.buildArguments\n" "\t\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.build.location\n" "\t\t\t\t\t" << this->GetEclipsePath(this->HomeOutputDirectory) << "\n" "\t\t\t\t\n" "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.make.core.autoBuildTarget\n" "\t\t\t\t\tall\n" "\t\t\t\t\n" ; // set error parsers fout << "\t\t\t\t\n" "\t\t\t\t\torg.eclipse.cdt.core.errorOutputParser\n" "\t\t\t\t\t" ; if (this->GetToolChainType(*mf) == EclipseToolchainOther) { fout << "org.eclipse.cdt.core.VCErrorParser;"; } fout << "org.eclipse.cdt.core.MakeErrorParser;" "org.eclipse.cdt.core.GCCErrorParser;" "org.eclipse.cdt.core.GASErrorParser;" "org.eclipse.cdt.core.GLDErrorParser;" "\n" "\t\t\t\t\n" ; fout << "\t\t\t\n" "\t\t\n" "\t\t\n" "\t\t\torg.eclipse.cdt.make.core.ScannerConfigBuilder\n" "\t\t\t\n" "\t\t\t\n" "\t\t\n" "\t\n" ; // set natures for c/c++ projects fout << "\t\n" // TODO: ccnature only if it is c++ ??? "\t\torg.eclipse.cdt.core.ccnature\n" "\t\torg.eclipse.cdt.make.core.makeNature\n" "\t\torg.eclipse.cdt.make.core.ScannerConfigNature\n" "\t\torg.eclipse.cdt.core.cnature\n" "\t\n" ; // TODO: refactor this // create linked resources if (this->IsOutOfSourceBuild) { fout << "\t\n"; // for each sub project create a linked resource to the source dir // - only if it is an out-of-source build for (std::map >::const_iterator it = this->GlobalGenerator->GetProjectMap().begin(); it != this->GlobalGenerator->GetProjectMap().end(); ++it) { std::string linkSourceDirectory = this->GetEclipsePath( it->second[0]->GetMakefile()->GetStartDirectory()); // .project dir can't be subdir of a linked resource dir if (!cmSystemTools::IsSubDirectory(this->HomeOutputDirectory.c_str(), linkSourceDirectory.c_str())) { this->AppendLinkedResource(fout, it->first, this->GetEclipsePath(linkSourceDirectory)); this->SrcLinkedResources.push_back(it->first); } } // for EXECUTABLE_OUTPUT_PATH when not in binary dir std::string outputPath = mf->GetSafeDefinition("EXECUTABLE_OUTPUT_PATH"); if (!outputPath.empty() && !cmSystemTools::IsSubDirectory( outputPath.c_str(), this->HomeOutputDirectory.c_str())) { std::string name = this->GetPathBasename(outputPath); // make sure linked resource name is unique while (this->GlobalGenerator->GetProjectMap().find(name) != this->GlobalGenerator->GetProjectMap().end()) { name += "_"; } this->AppendLinkedResource(fout, name, this->GetEclipsePath(outputPath)); this->OutLinkedResources.push_back(name); } // for LIBRARY_OUTPUT_PATH when not in binary dir if (outputPath != mf->GetSafeDefinition("LIBRARY_OUTPUT_PATH")) { outputPath = mf->GetSafeDefinition("LIBRARY_OUTPUT_PATH"); if (!outputPath.empty() && !cmSystemTools::IsSubDirectory( outputPath.c_str(), this->HomeOutputDirectory.c_str())) { std::string name = this->GetPathBasename(outputPath); // make sure linked resource name is unique while (this->GlobalGenerator->GetProjectMap().find(name) != this->GlobalGenerator->GetProjectMap().end()) { name += "_"; } this->AppendLinkedResource(fout, name, this->GetEclipsePath(outputPath)); this->OutLinkedResources.push_back(name); } } fout << "\t\n"; } fout << "\n"; } //---------------------------------------------------------------------------- void cmExtraEclipseCDT4Generator::CreateCProjectFile() const { std::set emmited; const cmMakefile* mf = this->GlobalGenerator->GetLocalGenerators()[0]->GetMakefile(); const std::string filename = this->HomeOutputDirectory + "/.cproject"; cmGeneratedFileStream fout(filename.c_str()); if (!fout) { return; } // add header fout << "\n" "\n\n" "\n" "\n" ; fout << "\n"; // Configuration settings... fout << "\n" "\n" "\n" ; // TODO: refactor this out... switch (this->GetToolChainType(*mf)) { case EclipseToolchainLinux : fout << "\n" ; fout << "\n" "\n" "\n" "\n" ; break; case EclipseToolchainCygwin : fout << "\n" "\n" "\n" "\n" "\n" "\n" ; break; case EclipseToolchainMinGW : fout << "\n" ; break; case EclipseToolchainSolaris : fout << "\n" ; break; case EclipseToolchainMacOSX : fout << "\n" "\n" "\n" ; break; case EclipseToolchainOther : fout << "\n" ; fout << "\n" ; break; default : // *** Should never get here *** fout << "\n"; } fout << "\n" "\n" ; // ??? fout << "\n" "\n" "\n" ; // ??? fout<<"\n" ; // set the path entries (includes, libs, source dirs, etc.) fout << "\n" ; // for each sub project with a linked resource to the source dir: // - make it type 'src' // - and exclude it from type 'out' std::string excludeFromOut; for (std::vector::const_iterator it = this->SrcLinkedResources.begin(); it != this->SrcLinkedResources.end(); ++it) { fout << "\n"; // exlude source directory from output search path // - only if not named the same as an output directory if (!cmSystemTools::FileIsDirectory( std::string(this->HomeOutputDirectory + "/" + *it).c_str())) { excludeFromOut += *it + "/|"; } } excludeFromOut += "**/CMakeFiles/"; fout << "\n"; // add output entry for EXECUTABLE_OUTPUT_PATH and LIBRARY_OUTPUT_PATH // - if it is a subdir of homeOutputDirectory, there is no need to add it // - if it is not then create a linked resource and add the linked name // but check it doesn't conflict with other linked resources names for (std::vector::const_iterator it = this->OutLinkedResources.begin(); it != this->OutLinkedResources.end(); ++it) { fout << "\n"; } // add pre-processor definitions to allow eclipse to gray out sections emmited.clear(); for (std::vector::const_iterator it = this->GlobalGenerator->GetLocalGenerators().begin(); it != this->GlobalGenerator->GetLocalGenerators().end(); ++it) { if(const char* cdefs = (*it)->GetMakefile()->GetProperty( "COMPILE_DEFINITIONS")) { // Expand the list. std::vector defs; cmSystemTools::ExpandListArgument(cdefs, defs); for(std::vector::const_iterator di = defs.begin(); di != defs.end(); ++di) { std::string::size_type equals = di->find('=', 0); std::string::size_type enddef = di->length(); std::string def; std::string val; if (equals != std::string::npos && equals < enddef) { // we have -DFOO=BAR def = di->substr(0, equals); val = di->substr(equals + 1, enddef - equals + 1); } else { // we have -DFOO def = *di; } // insert the definition if not already added. if(emmited.find(def) == emmited.end()) { emmited.insert(def); fout << "\n"; } } } } // include dirs emmited.clear(); for (std::vector::const_iterator it = this->GlobalGenerator->GetLocalGenerators().begin(); it != this->GlobalGenerator->GetLocalGenerators().end(); ++it) { const std::vector& includeDirs = (*it)->GetMakefile()->GetIncludeDirectories(); for(std::vector::const_iterator inc = includeDirs.begin(); inc != includeDirs.end(); ++inc) { std::string dir = cmSystemTools::CollapseFullPath(inc->c_str()); if(emmited.find(dir) == emmited.end()) { emmited.insert(dir); fout << "GetEclipsePath(dir) << "\" kind=\"inc\" path=\"\" system=\"true\"/>\n"; } } } fout << "\n"; // add build targets fout << "\n" "\n" ; emmited.clear(); const std::string make = mf->GetRequiredDefinition("CMAKE_MAKE_PROGRAM"); cmGlobalGenerator* generator = const_cast(this->GlobalGenerator); if (generator->GetAllTargetName()) { emmited.insert(generator->GetAllTargetName()); cmExtraEclipseCDT4Generator::AppendTarget(fout, generator->GetAllTargetName(), make); } if (generator->GetPreinstallTargetName()) { emmited.insert(generator->GetPreinstallTargetName()); cmExtraEclipseCDT4Generator ::AppendTarget(fout, generator->GetPreinstallTargetName(), make); } if (generator->GetCleanTargetName()) { emmited.insert(generator->GetCleanTargetName()); cmExtraEclipseCDT4Generator ::AppendTarget(fout, generator->GetCleanTargetName(), make); } // add all executable and library targets and some of the GLOBAL // and UTILITY targets for (std::vector::const_iterator it = this->GlobalGenerator->GetLocalGenerators().begin(); it != this->GlobalGenerator->GetLocalGenerators().end(); ++it) { const cmTargets& targets = (*it)->GetMakefile()->GetTargets(); for(cmTargets::const_iterator t = targets.begin(); t != targets.end(); ++t) { switch(t->second.GetType()) { case cmTarget::UTILITY: case cmTarget::GLOBAL_TARGET: { // only add these global targets if (!( (t->first=="install") || (t->first=="install/strip") || (t->first=="test") || (t->first=="Experimental") || (t->first=="Nightly") || (t->first=="edit_cache") || (t->first=="package") || (t->first=="package_source") || (t->first=="rebuild_cache") )) { break; } // add the edit_cache target only if it's not ccmake // otherwise ccmake will be executed in the log view of Eclipse, // which is no terminal, so curses don't work there, Alex if (t->first=="edit_cache") { if (strstr(mf->GetRequiredDefinition("CMAKE_EDIT_COMMAND"), "ccmake")!=NULL) { break; } } } case cmTarget::EXECUTABLE: case cmTarget::STATIC_LIBRARY: case cmTarget::SHARED_LIBRARY: case cmTarget::MODULE_LIBRARY: { if(emmited.find(t->first) == emmited.end()) { emmited.insert(t->first); cmExtraEclipseCDT4Generator::AppendTarget(fout, t->first, make); } break; } // ignore these: case cmTarget::INSTALL_FILES: case cmTarget::INSTALL_PROGRAMS: case cmTarget::INSTALL_DIRECTORY: default: break; } } } fout << "\n" "\n" ; this->AppendStorageScanners(fout); fout << "\n" "\n" "\n" "GetProjectName() << ".null.1\"" " name=\"" << mf->GetProjectName() << "\"/>\n" "\n" "\n" ; } //---------------------------------------------------------------------------- cmExtraEclipseCDT4Generator::EclipseToolchainType cmExtraEclipseCDT4Generator::GetToolChainType(const cmMakefile& makefile) { if (makefile.IsSet("UNIX")) { if (makefile.IsSet("CYGWIN")) { return EclipseToolchainCygwin; } if (makefile.IsSet("APPLE" )) { return EclipseToolchainMacOSX; } // *** how do I determine if it is Solaris ??? return EclipseToolchainLinux; } else if (makefile.IsSet("WIN32")) { if (makefile.IsSet("MINGW")) { return EclipseToolchainMinGW; } if (makefile.IsSet("MSYS" )) { return EclipseToolchainMinGW; } return EclipseToolchainOther; } else { return EclipseToolchainOther; } } std::string cmExtraEclipseCDT4Generator::GetEclipsePath(const std::string& path) { #if defined(__CYGWIN__) std::string cmd = "cygpath -m " + path; std::string out; if (!cmSystemTools::RunCommand(cmd.c_str(), out, 0, false)) { return path; } else { out.erase(out.find_last_of('\n')); return out; } #else return path; #endif } std::string cmExtraEclipseCDT4Generator::GetPathBasename(const std::string& path) { std::string outputBasename = path; while (outputBasename.size() > 0 && (outputBasename[outputBasename.size() - 1] == '/' || outputBasename[outputBasename.size() - 1] == '\\')) { outputBasename.resize(outputBasename.size() - 1); } std::string::size_type loc = outputBasename.find_last_of("/\\"); if (loc != std::string::npos) { outputBasename = outputBasename.substr(loc + 1); } return outputBasename; } std::string cmExtraEclipseCDT4Generator::GenerateProjectName(const std::string& name, const std::string& type, const std::string& path) { return name + (type.empty() ? "" : "-") + type + "@" + path; } //---------------------------------------------------------------------------- // Helper functions //---------------------------------------------------------------------------- void cmExtraEclipseCDT4Generator ::AppendStorageScanners(cmGeneratedFileStream& fout) { fout << "\n" "\n" ; cmExtraEclipseCDT4Generator::AppendScannerProfile(fout, "org.eclipse.cdt.make.core.GCCStandardMakePerProjectProfile", true, "", true, "specsFile", "-E -P -v -dD ${plugin_state_location}/${specs_file}", "gcc", true, true); cmExtraEclipseCDT4Generator::AppendScannerProfile(fout, "org.eclipse.cdt.make.core.GCCStandardMakePerFileProfile", true, "", true, "makefileGenerator", "-f ${project_name}_scd.mk", "make", true, true); fout << "\n"; } void cmExtraEclipseCDT4Generator::AppendTarget(cmGeneratedFileStream& fout, const std::string& target, const std::string& make) { fout << "\n" "" << cmExtraEclipseCDT4Generator::GetEclipsePath(make) << "\n" "\n" "" << target << "\n" "true\n" "false\n" "\n" ; } void cmExtraEclipseCDT4Generator ::AppendScannerProfile(cmGeneratedFileStream& fout, const std::string& profileID, bool openActionEnabled, const std::string& openActionFilePath, bool pParserEnabled, const std::string& scannerInfoProviderID, const std::string& runActionArguments, const std::string& runActionCommand, bool runActionUseDefault, bool sipParserEnabled) { fout << "\n" "\n" "\n" "\n" "\n" "\n" "\n" "\n" "\n" "\n" ; } void cmExtraEclipseCDT4Generator ::AppendLinkedResource (cmGeneratedFileStream& fout, const std::string& name, const std::string& path) { fout << "\t\t\n" "\t\t\t" << name << "\n" "\t\t\t2\n" "\t\t\t" << path << "\n" "\t\t\n" ; }