Build scripts - Revision history

BlueHazzard: base is a keyword in squirrel, so we need a other name for the parameter

2022-01-18T07:34:01Z

base is a keyword in squirrel, so we need a other name for the parameter

← Older revision		Revision as of 07:34, 18 January 2022
Line 9:		Line 9:
	// file: build_debug_symbols.script		// file: build_debug_symbols.script

	function SetBuildOptions(~~base~~)		function SetBuildOptions(cbase)
	{		{
	// enable debugging symbols		// enable debugging symbols
	~~base~~.AddCompilerOption(_T("-g"));		cbase.AddCompilerOption(_T("-g"));
	// disable all optimizations		// disable all optimizations
	~~base~~.AddCompilerOption(_T("-O0"));		cbase.AddCompilerOption(_T("-O0"));
	}		}

	The "~~base~~" parameter in this function is a CompiletargetBase instance. SetBuildOptions(~~base~~) is called before the project/target is built. Each build script ''must define this function'', even if it is not needed (in which case you can leave it with an empty body).		The "cbase" parameter in this function is a CompiletargetBase instance. SetBuildOptions(cbase) is called before the project/target is built. Each build script ''must define this function'', even if it is not needed (in which case you can leave it with an empty body).

	This specific script enables the generation of debugging symbols for the build target it is attached to. You could similarly have other build scripts for different configuration sets like optimizations, architecture, C++ options, C++ standards, etc.		This specific script enables the generation of debugging symbols for the build target it is attached to. You could similarly have other build scripts for different configuration sets like optimizations, architecture, C++ options, C++ standards, etc.

Sethjackson at 18:11, 28 November 2006

2006-11-28T18:11:34Z

← Older revision		Revision as of 18:11, 28 November 2006
Line 15:		Line 15:
	// disable all optimizations		// disable all optimizations
	base.AddCompilerOption(_T("-O0"));		base.AddCompilerOption(_T("-O0"));
	}		}

	~~function UnsetBuildOptions(base)~~
	{
	~~// remove the settings we added in SetBuildOptions()~~
	~~base.RemoveCompilerOption(_T("-g"));~~
	~~base.RemoveCompilerOption(_T("-O0"));~~
	}

	The "base" parameter in ~~both functions~~ is a ~~CompileOptionsBase~~ instance. SetBuildOptions() is called before the project/target is ~~built and UnsetBuildOptions() is called after it has~~ built. Each build script ''must define ~~both of these functions~~'', even if ~~they 're~~ not needed (in which case you can leave ~~them~~ with an empty body).		The "base" parameter in this function is a CompiletargetBase instance. SetBuildOptions(base) is called before the project/target is built. Each build script ''must define this function'', even if it is not needed (in which case you can leave it with an empty body).

	This specific script enables the generation of debugging symbols for the build target it is attached to. You could similarly have other build scripts for different configuration sets like optimizations, architecture, C++ options, C++ standards, etc.		This specific script enables the generation of debugging symbols for the build target it is attached to. You could similarly have other build scripts for different configuration sets like optimizations, architecture, C++ options, C++ standards, etc.

Artojon: removed extra category

2006-11-11T17:40:29Z

removed extra category

← Older revision		Revision as of 17:40, 11 November 2006
Line 1:		Line 1:
	~~[[Category:Code::Blocks Documentation]]~~
	[[Category:Scripting Code::Blocks]]		[[Category:Scripting Code::Blocks]]

Artojon: wikify

2006-07-07T18:59:10Z

wikify

← Older revision		Revision as of 18:59, 7 July 2006
Line 1:		Line 1:
			[[Category:Code::Blocks Documentation]]
			[[Category:Scripting Code::Blocks]]

	Build scripts can help configuring build options and reusing these configurations.		Build scripts can help configuring build options and reusing these configurations.

Line 37:		Line 40:


			== See also ==

	~~See also:~~ [[~~scripting~~ commands~~]].~~		* [[Scripting commands]]

	~~Back to [[Scripting_Code::Blocks\|scripting index]].~~

	~~[[Category:Code::Blocks_Documentation~~]]

Mandrav: Initial

2006-07-04T09:55:20Z

Initial

New page

Build scripts can help configuring build options and reusing these configurations.

What you need to do is create as many build scripts are needed and attach them to projects or build targets.

Let's see an example build script for the GNU GCC compiler:

// file: build_debug_symbols.script

function SetBuildOptions(base)
{
// enable debugging symbols
base.AddCompilerOption(_T("-g"));
// disable all optimizations
base.AddCompilerOption(_T("-O0"));
}

function UnsetBuildOptions(base)
{
// remove the settings we added in SetBuildOptions()
base.RemoveCompilerOption(_T("-g"));
base.RemoveCompilerOption(_T("-O0"));
}

The "base" parameter in both functions is a CompileOptionsBase instance. SetBuildOptions() is called before the project/target is built and UnsetBuildOptions() is called after it has built. Each build script ''must define both of these functions'', even if they 're not needed (in which case you can leave them with an empty body).

This specific script enables the generation of debugging symbols for the build target it is attached to. You could similarly have other build scripts for different configuration sets like optimizations, architecture, C++ options, C++ standards, etc.

Great. Now you have created your own set of build scripts. How do you attach them to project/targets? Simple: "Project->Properties->Scripts". Select the project or target to attach a script to and click "Add". If you want to detach a script, click "Remove".
You can also change the order scripts are ran with the two little arrows on the right side.
Finally, you can press "Validate all scripts" to make sure that the attached build scripts are valid.

If you choose to go the build scripts way for your project, please don't use the project build options dialog (unless maybe for global project settings). If you do, things may not work as expected and you will unrightfully blame Code::Blocks for this ;).

Well, that's all there is to it!

''NOTE: I 've been told that this is like MS Visual Studio's "properties". I wouldn't know since I don't use it myself. But maybe this similarity (if it really exists) helps you grasp the concept better.''

See also: [[scripting commands]].

Back to [[Scripting_Code::Blocks|scripting index]].

[[Category:Code::Blocks_Documentation]]