cbp2make
Makefile generation tool for Code::Blocks IDE
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
CGlobalVariable Class Reference

Contains properties of global compiler variables. More...

#include <cbglobalvar.h>

Public Member Functions

CStringName (void)
 Name of the variable. More...
 
CStringDescription (void)
 Description of the variable. More...
 
CString Base (void)
 Value of the built-in default field of the variable. More...
 
CString Include (void)
 Value of the built-in "Include" field of the variable. More...
 
CString Lib (void)
 Value of the built-in "Lib" field of the variable. More...
 
CStringObj (void)
 Value of the built-in "Obj" field of the variable. More...
 
CStringCflags (void)
 Value of the built-in "Cflags" field of the variable. More...
 
CStringLflags (void)
 Value of the built-in "Lflags" field of the variable. More...
 
int Count (void)
 Returns number of user-defined fields. More...
 
CString GetField (const int Index)
 Returns name of user-defined field. More...
 
CString GetValue (const int Index)
 Returns value of user-defined field. More...
 
void Clear (void)
 Resets the global compiler variable to the initial state. More...
 
void Add (const CString &Name, const CString &Value)
 Adds new user-defined field. More...
 
void Remove (const CString &Name)
 Removes user-defined field. More...
 
void Read (const TiXmlElement *GlobalVariableRoot)
 Reads the global variable settings from an XML document. More...
 
void Write (TiXmlElement *GlobalVariableRoot)
 Writes the global variable settings to an XML document. More...
 
void Show (void)
 Prints the global compiler variable contents to standard output. More...
 
 CGlobalVariable (void)
 Creates global compiler variable. More...
 
 ~CGlobalVariable (void)
 Destroys global compiler variable. More...
 

Static Public Member Functions

static CString Convert (const CString &Value, const int Case=0)
 

Private Attributes

CString m_Name
 Name of the variable. More...
 
CString m_Description
 Description of the variable. More...
 
CString m_Base
 Value of the built-in default field of the variable. More...
 
CString m_Include
 Value of the built-in "Include" field of the variable. More...
 
CString m_Lib
 Value of the built-in "Lib" field of the variable. More...
 
CString m_Obj
 Value of the built-in "Obj" field of the variable. More...
 
CString m_Cflags
 Value of the built-in "Cflags" field of the variable. More...
 
CString m_Lflags
 Value of the built-in "Lflags" field of the variable. More...
 
CConfiguration m_Fields
 User-defined fields of the global compiler variable. More...
 

Detailed Description

Contains properties of global compiler variables.

Global compiler variables store installation-specific file paths and build options.

Constructor & Destructor Documentation

◆ CGlobalVariable()

CGlobalVariable::CGlobalVariable ( void  )

Creates global compiler variable.

◆ ~CGlobalVariable()

CGlobalVariable::~CGlobalVariable ( void  )

Destroys global compiler variable.

Member Function Documentation

◆ Add()

CGlobalVariable::Add ( const CString Name,
const CString Value 
)

Adds new user-defined field.

Parameters
Namefield name.
Valuefield value.

◆ Base()

CGlobalVariable::Base ( void  )

Value of the built-in default field of the variable.

Returns
default field value.

◆ Cflags()

CGlobalVariable::Cflags ( void  )
inline

Value of the built-in "Cflags" field of the variable.

Returns
reference to .

◆ Clear()

CGlobalVariable::Clear ( void  )

Resets the global compiler variable to the initial state.

◆ Convert()

CString CGlobalVariable::Convert ( const CString Value,
const int  Case = 0 
)
static

◆ Count()

CGlobalVariable::Count ( void  )

Returns number of user-defined fields.

Returns
number of user-defined fields.

◆ Description()

CGlobalVariable::Description ( void  )
inline

Description of the variable.

Returns
reference to CGlobalVariable::m_Description.

◆ GetField()

CGlobalVariable::GetField ( const int  Index)

Returns name of user-defined field.

Parameters
Indexindex of user-defined field.
Returns
field name.

◆ GetValue()

CGlobalVariable::GetValue ( const int  Index)

Returns value of user-defined field.

Parameters
Indexindex of user-defined field.
Returns
field value.

◆ Include()

CGlobalVariable::Include ( void  )

Value of the built-in "Include" field of the variable.

Returns
"Include" field value.

◆ Lflags()

CGlobalVariable::Lflags ( void  )
inline

Value of the built-in "Lflags" field of the variable.

Returns
reference to .

◆ Lib()

CGlobalVariable::Lib ( void  )

Value of the built-in "Lib" field of the variable.

Returns
"Lib" field value.

◆ Name()

CGlobalVariable::Name ( void  )
inline

Name of the variable.

Returns
reference to CGlobalVariable::m_Name.

◆ Obj()

CGlobalVariable::Obj ( void  )
inline

Value of the built-in "Obj" field of the variable.

Returns
reference to .

◆ Read()

CGlobalVariable::Read ( const TiXmlElement *  GlobalVariableRoot)

Reads the global variable settings from an XML document.

Parameters
GlobalVariableRootan element of XML document.

◆ Remove()

CGlobalVariable::Remove ( const CString Name)

Removes user-defined field.

Parameters
Namefield name.

◆ Show()

CGlobalVariable::Show ( void  )

Prints the global compiler variable contents to standard output.

◆ Write()

CGlobalVariable::Write ( TiXmlElement *  GlobalVariableRoot)

Writes the global variable settings to an XML document.

Parameters
GlobalVariableRootan element of XML document.

Member Data Documentation

◆ m_Base

CGlobalVariable::m_Base
private

Value of the built-in default field of the variable.

When a global variable field is not specified, this value should used as variable's value. The base field usually points to root directory of a library.

◆ m_Cflags

CGlobalVariable::m_Cflags
private

Value of the built-in "Cflags" field of the variable.

◆ m_Description

CGlobalVariable::m_Description
private

Description of the variable.

◆ m_Fields

CGlobalVariable::m_Fields
private

User-defined fields of the global compiler variable.

◆ m_Include

CGlobalVariable::m_Include
private

Value of the built-in "Include" field of the variable.

◆ m_Lflags

CGlobalVariable::m_Lflags
private

Value of the built-in "Lflags" field of the variable.

◆ m_Lib

CGlobalVariable::m_Lib
private

Value of the built-in "Lib" field of the variable.

◆ m_Name

CGlobalVariable::m_Name
private

Name of the variable.

◆ m_Obj

CGlobalVariable::m_Obj
private

Value of the built-in "Obj" field of the variable.


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