Provide an example of extending CMake project type in Core Build

NewAndNoteworthy/CDT-12.0.md

@@ -63,6 +63,14 @@ Starting in CDT 12, the Terminal will now default to UTF-8.
 
 # API Changes, current and planned
 
+## CMake Support easier for extenders and ISVs
+
+Improvements to the API for CMake has made it easier to extend and specialize CMake for ISVs.
+A fully worked example demonstrating the support is now provided in the CDT source in [org.eclipse.cdt.cmake.example](https://github.com/eclipse-cdt/cdt/tree/main/cmake/org.eclipse.cdt.cmake.example).
+This example demonstrates the API, and how to contribute a new project wizard to make such a project.
+
+<p align="center"><img src="images/CDT-12.0-cmake-example-project-for-isvs.png"></p>
+
 ## Breaking API changes
 
 Please see [CHANGELOG-API](CHANGELOG-API.md) for details on the breaking API changes in this release as well as future planned API changes.

cmake/org.eclipse.cdt.cmake.core/src/org/eclipse/cdt/cmake/core/CMakeBuildConfigurationProvider.java

@@ -27,6 +27,13 @@
 import org.eclipse.core.runtime.Platform;
 
 /**
+ * A ICBuildConfigurationProvider specialized for CMake
+ *
+ * Extenders can provide their own specialised CMakeConfiguration by extending this class and {@link CMakeBuildConfiguration}.
+ * Extenders need to override at least {@link #getId()}, and the various createCMakeBuildConfiguration methods.
+ * See the example project <a href="https://github.com/eclipse-cdt/cdt/tree/main/cmake/org.eclipse.cdt.cmake.example">
+ * org.eclipse.cdt.cmake.example</a> for a full example.
+ *
  * @since 1.6
  */
 public class CMakeBuildConfigurationProvider implements ICBuildConfigurationProvider {
@@ -41,6 +48,30 @@ public String getId() {
 		return ID;
 	}
 
+	/**
+	 * Extenders should override this method to construct their specialized build configuration.
+	 */
+	protected CMakeBuildConfiguration createCMakeBuildConfiguration(IBuildConfiguration config, String name)
+			throws CoreException {
+		return new CMakeBuildConfiguration(config, name);
+	}
+
+	/**
+	 * Extenders should override this method to construct their specialized build configuration.
+	 */
+	protected CMakeBuildConfiguration createCMakeBuildConfiguration(IBuildConfiguration config, String name,
+			IToolChain toolChain) {
+		return new CMakeBuildConfiguration(config, name, toolChain);
+	}
+
+	/**
+	 * Extenders should override this method to construct their specialized build configuration.
+	 */
+	protected CMakeBuildConfiguration createCMakeBuildConfiguration(IBuildConfiguration config, String name,
+			IToolChain toolChain, ICMakeToolChainFile toolChainFile, String launchMode) {
+		return new CMakeBuildConfiguration(config, name, toolChain, toolChainFile, launchMode);
+	}
+
 	@Override
 	public synchronized ICBuildConfiguration getCBuildConfiguration(IBuildConfiguration config, String name)
 			throws CoreException {
@@ -66,13 +97,13 @@ public synchronized ICBuildConfiguration getCBuildConfiguration(IBuildConfigurat
 			}
 
 			if (toolChain != null) {
-				return new CMakeBuildConfiguration(config, name, toolChain);
+				return createCMakeBuildConfiguration(config, name, toolChain);
 			} else {
 				// No valid combinations
 				return null;
 			}
 		}
-		CMakeBuildConfiguration cmakeConfig = new CMakeBuildConfiguration(config, name);
+		CMakeBuildConfiguration cmakeConfig = createCMakeBuildConfiguration(config, name);
 		ICMakeToolChainFile tcFile = cmakeConfig.getToolChainFile();
 		IToolChain toolChain = cmakeConfig.getToolChain();
 		if (toolChain == null) {
@@ -81,7 +112,7 @@ public synchronized ICBuildConfiguration getCBuildConfiguration(IBuildConfigurat
 		}
 		if (tcFile != null && !toolChain.equals(tcFile.getToolChain())) {
 			// toolchain changed
-			return new CMakeBuildConfiguration(config, name, tcFile.getToolChain(), tcFile,
+			return createCMakeBuildConfiguration(config, name, tcFile.getToolChain(), tcFile,
 					cmakeConfig.getLaunchMode());
 		} else {
 			return cmakeConfig;
@@ -136,7 +167,7 @@ public ICBuildConfiguration createBuildConfiguration(IProject project, IToolChai
 			config = configManager.createBuildConfiguration(this, project, name, monitor);
 		}
 
-		CMakeBuildConfiguration cmakeConfig = new CMakeBuildConfiguration(config, name, toolChain, file, launchMode);
+		CMakeBuildConfiguration cmakeConfig = createCMakeBuildConfiguration(config, name, toolChain, file, launchMode);
 		configManager.addBuildConfiguration(config, cmakeConfig);
 		return cmakeConfig;
 	}

cmake/org.eclipse.cdt.cmake.example/.classpath

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-17"/>
+	<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
+	<classpathentry kind="src" path="src"/>
+	<classpathentry kind="output" path="bin"/>
+</classpath>

cmake/org.eclipse.cdt.cmake.example/.project

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>org.eclipse.cdt.cmake.example</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.pde.ManifestBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.pde.SchemaBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.pde.PluginNature</nature>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+	</natures>
+</projectDescription>

cmake/org.eclipse.cdt.cmake.example/.settings/org.eclipse.core.resources.prefs

@@ -0,0 +1,2 @@
+eclipse.preferences.version=1
+encoding/<project>=UTF-8