This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.CMake.

Summary

The c make runner base

Assembly

Cake.CMake.dll

Namespace

Cake.CMake

Base Types

Tool<TSettings>

Derived Types

graph BT Type-->Base0["Tool<TSettings>"] Type["CMakeRunnerBase<TSettings>"] class Type type-node Derived0["CMakeBuildRunner"]-->Type click Derived0 "/api/Cake.CMake/CMakeBuildRunner" Derived1["CMakeRunner"]-->Type click Derived1 "/api/Cake.CMake/CMakeRunner"

Syntax

public abstract class CMakeRunnerBase<TSettings> : Tool<TSettings> where TSettings : ToolSettings

Type Parameters

Name	Description
TSettings	The type of the settings.

Constructors

Name	Summary
CMakeRunnerBase(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator)	Initializes a new instance of the `CMakeRunnerBase<TSettings>` class.

Methods

Name	Value	Summary
GetAlternativeToolPaths(TSettings)	IEnumerable<FilePath>	Gets the alternative tool paths to CMake.
GetToolExecutableNames()	IEnumerable<string>	Gets the tool executable names.
GetToolName()	string	Gets the name of the tool.
Run(TSettings)	void	Runs the tool using the specified settings.

Extension Methods

Name	Value	Summary
Dump<CMakeRunnerBase<TSettings>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<CMakeRunnerBase<TSettings>>(CMakeRunnerBase<TSettings>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<CMakeRunnerBase<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<CMakeRunnerBase<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<CMakeRunnerBase<TSettings>>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<CMakeRunnerBase<TSettings>>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin