isys::CBuildOptions Class Reference

This class provides access to build manager options. More...

#include <CProjectController.h>

Inheritance diagram for isys::CBuildOptions:

Public Member Functions
void	add (const std::string &scope, const std::string &option, const std::string &value)
	Adds the build manager option.
std::string	get (const std::string &scope, const std::string &option)
	Returns the requested option.
std::string	get (DWORD index, const std::string &scope, const std::string &option)
	Returns option at the given index.
void	move (const std::string &scope, const std::string &option, const std::string &value)
	Moves the build manager option.
void	remove (const std::string &scope, const std::string &option)
	Removes the build manager option.
void	set (const std::string &scope, const std::string &option, const std::string &value)
	Sets the build manager option.

Detailed Description

This class provides access to build manager options.

Do not instantiate this class directly, but use CProjectController::options() instead.

File is defined either by >proj>file or by >proj>groups...>file

Available options:

Scope	Option
>proj>	OutputFile
>proj>	ExternalMakePath
>proj>:Compile	ExtInput
>proj>:Compile	ExtOutput
>proj>:Assemble	ExtInput
>proj>:Assemble	ExtOutput
>proj>:Link	ExtInput
>proj>:Compile	ExtInclude
>proj>:Link	RunAfterPath
>proj>:Link	RunAfterParam
>proj>	ToolsetDir
>proj>:Compile	Path
>proj>:Assemble	Path
>proj>:Link	Path
>proj>:Assemble	RunAfterPath
>proj>:Assemble	RunAfterParam
>proj>:Compile	RunAfterPath
>proj>:Compile	RunAfterParam
>proj>	RootDir
>proj>	ExternalMakeParam
>proj>:Assemble	ExtAdditional
>proj>:Compile	ExtAdditional
>proj>:Link	ExtAdditional
>proj>:Link	PathSeparator
>proj>:Assemble	ExtInclude
>proj>:Make	RunBeforePath
>proj>:Make	RunBeforeParam
>proj>:Compile	DefinesPrefix
>proj>:Compile	DefinesPostfix
>proj>	ExternalMakeOn
>proj>	RunWithRelativePaths
>proj>	CopyToTargetDir
>proj>	ChangeWorkingDir
>proj>	DisplayParam
>proj>:Compile	CaptureOutput
>proj>:Assemble	CaptureOutput
>proj>:Link	CaptureOutput
>proj>:Compile	UseCMD
>proj>:Assemble	UseCMD
>proj>:Link	UseCMD
>proj>	ShowTool
	BeepWhenDone
>proj>	WarnIncludeNotFound
>proj>::target	OutputDir
>proj>file	ExcludeFromMake
>proj>:Link:target	CmdLine
>proj>:Link:target	IndirectionPath
>proj>:Make:target	CmdLine
>proj>:Build:target	CmdLine
>proj>:Link:target	CRLF
>proj>:Link:target	TranslateChar
>proj>:Compile:target	RunAssembler
>proj>:Compile:target	CmdLine
>proj>file:Compile:target	CmdLine
>proj>:Assemble:target	CmdLine
>proj>file:Assemble:target	CmdLine
>proj>:Compile:target	Defines
>proj>file:Compile:target	Defines
>proj>:Make	Mode
>proj>:Make	Path
>proj>:Build	Mode
>proj>:Build	Path
>proj>	Environment
>proj>:Assemble	DepScan
>proj>:Assemble	DepReqBlanksFront
>proj>:Assemble	DepAllowBlanksFront
>proj>:Assemble	DepKeyword
>proj>:Assemble	DepStartPath
>proj>:Assemble	DepEndPath
>proj>	IncludePath // ofaEnum
>proj>	IncludePath>path // ofaAdd, ofaRmv,
>proj>	IncludePath>path 0/1 // ofaSet, ofaGet subdir
>proj>	Name
>proj>	Target // ofaEnum
>proj>::target	Target // ofaRmv, ofaAdd (the value defines the target from which to copy settings)
>proj>::target	Target // ofaSet, ofaGet
>proj>	Group // ofaEnum
>proj>group>	Group // ofaRmv, ofaAdd
>proj>	Filter
set to TRUE if the below is not empty
>proj>:Compile	CustomFilter
>proj>:Assemble	CustomFilter
>proj>:Link	CustomFilter
>proj>	CustomFilter
>proj>::target	Name
>proj>group>	Name
>proj>group>	File // enum only

See also

CProjectController

Member Function Documentation

add()

void isys::CBuildOptions::add	(	const std::string &	scope,
		const std::string &	option,
		const std::string &	value )

Adds the build manager option.

See class description for available scope and options.

Exceptions

IOException

if error occurred

get() [1/2]

std::string isys::CBuildOptions::get	(	const std::string &	scope,
		const std::string &	option )

Returns the requested option.

See class description for available scope and options.

Exceptions

IOException

if error occurred

get() [2/2]

std::string isys::CBuildOptions::get	(	DWORD	index,
		const std::string &	scope,
		const std::string &	option )

Returns option at the given index.

See class description for available scope and options.

Exceptions

IllegalStateException	if index is out of range.
IOException	if any other error occurred

move()

void isys::CBuildOptions::move	(	const std::string &	scope,
		const std::string &	option,
		const std::string &	value )

Moves the build manager option.

See class description for available scope and options.

Exceptions

IOException

if error occurred

remove()

void isys::CBuildOptions::remove	(	const std::string &	scope,
		const std::string &	option )

Removes the build manager option.

See class description for available scope and options.

Exceptions

IOException

if error occurred

set()

void isys::CBuildOptions::set	(	const std::string &	scope,
		const std::string &	option,
		const std::string &	value )

Sets the build manager option.

See class description for available scope and options.

Exceptions

IOException

if error occurred