Build configuration. More...

#include <cbbuildcfg.h>

Public Member Functions
CPlatformSet &	Platforms (void)
	Returns reference to the set of platforms in build configuration. More...

CToolChainSet &	ToolChains (void)
	Returns reference to the set of toolchains in build configuration. More...

CGlobalVariableConfig &	GlobalVariables (void)
	Returns reference to the set of global variables in build configuration. More...

CStringList &	Targets (void)

CString &	DefaultOptions (void)

int &	TargetNameCase (void)

int &	MacroVariableCase (void)

int &	QuotePathMode (void)

bool &	NumericToolchainSuffix (void)

bool &	FlatObjectNames (void)
	Controls the way of object file names generation. More...

bool &	FlatObjectPaths (void)
	Controls the way of object file names generation. More...

bool &	MultilineObjects (void)
	Allows generation of multi-line object file lists. More...

bool &	MultilineOptions (void)
	Allows generation of multi-line option lists. More...

bool &	IncludeDependencies (void)

bool &	KeepObjectDirectories (void)

bool &	KeepOutputDirectories (void)

bool &	BeQuiet (void)

bool &	BeVerbose (void)

void	Clear (void)
	Resets the build configuration to the initial state. More...

bool	Load (const CString &FileName)
	Loads a build configuration from a file specified by FileName. More...

bool	Save (const CString &FileName)
	Saves the build configuration to a file specified by FileName. More...

void	Show (void)
	Prints build configuration contents to standard output. More...

	CCodeBlocksBuildConfig (void)
	Creates build configuration. More...

	~CCodeBlocksBuildConfig (void)
	Destroys build configuration. More...

Private Attributes
CPlatformSet	m_Platforms
	Configuration of a set of platforms. More...

CToolChainSet	m_ToolChains
	Configuration of a set of build utilities. More...

CGlobalVariableConfig	m_GlobalVariables
	Configuration of a set of global variables. More...

CStringList	m_Targets

CString	m_DefaultOptions

int	m_TargetNameCase

int	m_MacroVariableCase

int	m_QuotePathMode

bool	m_NumericToolchainSuffix

bool	m_FlatObjectNames
	Controls the way of object file names generation. More...

bool	m_FlatObjectPaths
	Controls the way of object file names generation. More...

bool	m_MultilineObjects
	Allows generation of multi-line object file lists. More...

bool	m_MultilineOptions
	Allows generation of multi-line option lists. More...

bool	m_IncludeDependencies

bool	m_KeepObjectDirectories

bool	m_KeepOutputDirectories

bool	m_BeQuiet

bool	m_BeVerbose

Detailed Description

Build configuration.

Contains configurations for platforms (operating systems), build utilities, i.e., toolchains, global compiler variables (installation-specefic options), makefile generation options.

Constructor & Destructor Documentation

◆ CCodeBlocksBuildConfig()

CCodeBlocksBuildConfig::CCodeBlocksBuildConfig ( void )

Creates build configuration.

◆ ~CCodeBlocksBuildConfig()

CCodeBlocksBuildConfig::~CCodeBlocksBuildConfig ( void )

Destroys build configuration.

Member Function Documentation

◆ BeQuiet()

bool& CCodeBlocksBuildConfig::BeQuiet ( void )

inline

◆ BeVerbose()

bool& CCodeBlocksBuildConfig::BeVerbose ( void )

inline

◆ Clear()

CCodeBlocksBuildConfig::Clear ( void )

Resets the build configuration to the initial state.

◆ DefaultOptions()

CString& CCodeBlocksBuildConfig::DefaultOptions ( void )

inline

◆ FlatObjectNames()

CCodeBlocksBuildConfig::FlatObjectNames ( void )

inline

Controls the way of object file names generation.

Returns: reference to CCodeBlocksBuildConfig::m_FlatObjectNames.

◆ FlatObjectPaths()

CCodeBlocksBuildConfig::FlatObjectPaths ( void )

inline

Controls the way of object file names generation.

Returns: reference to CCodeBlocksBuildConfig::m_FlatObjectPaths.

◆ GlobalVariables()

CCodeBlocksBuildConfig::GlobalVariables ( void )

inline

Returns reference to the set of global variables in build configuration.

Returns: reference to CCodeBlocksBuildConfig::m_GlobalVariables.

◆ IncludeDependencies()

bool& CCodeBlocksBuildConfig::IncludeDependencies ( void )

inline

◆ KeepObjectDirectories()

bool& CCodeBlocksBuildConfig::KeepObjectDirectories ( void )

inline

◆ KeepOutputDirectories()

bool& CCodeBlocksBuildConfig::KeepOutputDirectories ( void )

inline

◆ Load()

CCodeBlocksBuildConfig::Load ( const CString & FileName )

Loads a build configuration from a file specified by FileName.

Parameters

FileName name of build configuration file.

Returns: true if configuration was successfully loaded, false otherwise.

◆ MacroVariableCase()

int& CCodeBlocksBuildConfig::MacroVariableCase ( void )

inline

◆ MultilineObjects()

CCodeBlocksBuildConfig::MultilineObjects ( void )

inline

Allows generation of multi-line object file lists.

Returns: reference to CCodeBlocksBuildConfig::m_MultilineObjects.

◆ MultilineOptions()

CCodeBlocksBuildConfig::MultilineOptions ( void )

inline

Allows generation of multi-line option lists.

Returns: reference to CCodeBlocksBuildConfig::m_MultilineOptions.

◆ NumericToolchainSuffix()

bool& CCodeBlocksBuildConfig::NumericToolchainSuffix ( void )

inline

◆ Platforms()

CCodeBlocksBuildConfig::Platforms ( void )

inline

Returns reference to the set of platforms in build configuration.

Returns: reference to CCodeBlocksBuildConfig::m_Platforms.

◆ QuotePathMode()

int& CCodeBlocksBuildConfig::QuotePathMode ( void )

inline

◆ Save()

CCodeBlocksBuildConfig::Save ( const CString & FileName )

Saves the build configuration to a file specified by FileName.

Parameters

FileName name of build configuration file.

Returns: true if configuration was successfully saved, false otherwise.

◆ Show()

CCodeBlocksBuildConfig::Show ( void )

Prints build configuration contents to standard output.

◆ TargetNameCase()

int& CCodeBlocksBuildConfig::TargetNameCase ( void )

inline

◆ Targets()

CStringList& CCodeBlocksBuildConfig::Targets ( void )

inline

◆ ToolChains()

CCodeBlocksBuildConfig::ToolChains ( void )

inline

Returns reference to the set of toolchains in build configuration.

Returns: reference to CCodeBlocksBuildConfig::m_ToolChains.

Member Data Documentation

◆ m_BeQuiet

bool CCodeBlocksBuildConfig::m_BeQuiet

private

◆ m_BeVerbose

bool CCodeBlocksBuildConfig::m_BeVerbose

private

◆ m_DefaultOptions

CString CCodeBlocksBuildConfig::m_DefaultOptions

private

◆ m_FlatObjectNames

CCodeBlocksBuildConfig::m_FlatObjectNames

private

Controls the way of object file names generation.

When m_FlatObjectNames is set to true, file names of build units are processed depending on CCodeBlocksBuildConfig::m_FlatObjectNames value.

◆ m_FlatObjectPaths

CCodeBlocksBuildConfig::m_FlatObjectPaths

private

Controls the way of object file names generation.

When m_FlatObjectPaths is set to true, file names of build units including file path are processed using FlatFileName(const CString& FileName) function, otherwise, path to build unit is not used for composing path to corresponding object file and all object files will be created in one directory. This option works only if CCodeBlocksBuildConfig::m_FlatObjectNames is set to true.

◆ m_GlobalVariables

CCodeBlocksBuildConfig::m_GlobalVariables

private

Configuration of a set of global variables.

See also: CGlobalVariableConfig.

◆ m_IncludeDependencies

bool CCodeBlocksBuildConfig::m_IncludeDependencies

private

◆ m_KeepObjectDirectories

bool CCodeBlocksBuildConfig::m_KeepObjectDirectories

private

◆ m_KeepOutputDirectories

bool CCodeBlocksBuildConfig::m_KeepOutputDirectories

private

◆ m_MacroVariableCase

int CCodeBlocksBuildConfig::m_MacroVariableCase

private

◆ m_MultilineObjects

CCodeBlocksBuildConfig::m_MultilineObjects

private

Allows generation of multi-line object file lists.

◆ m_MultilineOptions

CCodeBlocksBuildConfig::m_MultilineOptions

private

Allows generation of multi-line option lists.

◆ m_NumericToolchainSuffix

bool CCodeBlocksBuildConfig::m_NumericToolchainSuffix

private

◆ m_Platforms

CCodeBlocksBuildConfig::m_Platforms

private

Configuration of a set of platforms.

See also: CPlatformSet.

◆ m_QuotePathMode

int CCodeBlocksBuildConfig::m_QuotePathMode

private

◆ m_TargetNameCase

int CCodeBlocksBuildConfig::m_TargetNameCase

private

◆ m_Targets

CStringList CCodeBlocksBuildConfig::m_Targets

private

◆ m_ToolChains

CCodeBlocksBuildConfig::m_ToolChains

private

Configuration of a set of build utilities.

See also: CToolChainSet.

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CCodeBlocksBuildConfig()

◆ ~CCodeBlocksBuildConfig()

Member Function Documentation

◆ BeQuiet()

◆ BeVerbose()

◆ Clear()

◆ DefaultOptions()

◆ FlatObjectNames()

◆ FlatObjectPaths()

◆ GlobalVariables()

◆ IncludeDependencies()

◆ KeepObjectDirectories()

◆ KeepOutputDirectories()

◆ Load()

◆ MacroVariableCase()

◆ MultilineObjects()

◆ MultilineOptions()

◆ NumericToolchainSuffix()

◆ Platforms()

◆ QuotePathMode()

◆ Save()

◆ Show()

◆ TargetNameCase()

◆ Targets()

◆ ToolChains()

Member Data Documentation

◆ m_BeQuiet

◆ m_BeVerbose

◆ m_DefaultOptions

◆ m_FlatObjectNames

◆ m_FlatObjectPaths

◆ m_GlobalVariables

◆ m_IncludeDependencies

◆ m_KeepObjectDirectories

◆ m_KeepOutputDirectories

◆ m_MacroVariableCase

◆ m_MultilineObjects

◆ m_MultilineOptions

◆ m_NumericToolchainSuffix

◆ m_Platforms

◆ m_QuotePathMode

◆ m_TargetNameCase

◆ m_Targets

◆ m_ToolChains