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

Build manager for Code::Blocks projects. More...

#include <cbbuildmgr.h>

Public Member Functions

CPlatformSetPlatforms (void)
 Returns reference to the set of platforms in build configuration. More...
 
CToolChainSetToolChains (void)
 Returns reference to the set of toolchains in build configuration. More...
 
CCodeBlocksBuildConfigConfig (void)
 Returns reference to the build configuration. More...
 
void Clear (void)
 Resets build manager to the initial state. More...
 
bool LoadProjectOrWorkspace (const CString &FileName)
 Loads a workspace or a project file whichever specified by FileName. More...
 
void Show (void)
 Prints project or workspace contents to standard output. More...
 
void GenerateMakefile (const CString &FileName)
 Generates makefile text and writes it to the file specified by FileName. More...
 
 CCodeBlocksBuildManager (void)
 Creates build manager. More...
 
 ~CCodeBlocksBuildManager (void)
 Destroys build manager. More...
 

Private Attributes

CCodeBlocksWorkspace m_Workspace
 Code::Blocks workspace object. More...
 
CCodeBlocksProject m_Project
 Code::Blocks project object. More...
 
CCodeBlocksBuildConfig m_Config
 Build configuration. More...
 
bool m_ProjectLoaded
 Indicated that a Code::Blocks project was loaded. More...
 
bool m_WorkspaceLoaded
 Indicates that a Code::Blocks workspace was loaded. More...
 

Detailed Description

Build manager for Code::Blocks projects.

Manages workspace and project settings and starts makefile generation process.

Constructor & Destructor Documentation

◆ CCodeBlocksBuildManager()

CCodeBlocksBuildManager::CCodeBlocksBuildManager ( void  )

Creates build manager.

◆ ~CCodeBlocksBuildManager()

CCodeBlocksBuildManager::~CCodeBlocksBuildManager ( void  )

Destroys build manager.

Member Function Documentation

◆ Clear()

CCodeBlocksBuildManager::Clear ( void  )

Resets build manager to the initial state.

◆ Config()

CCodeBlocksBuildManager::Config ( void  )
inline

Returns reference to the build configuration.

Returns
reference to CCodeBlocksBuildManager::m_Config.

◆ GenerateMakefile()

CCodeBlocksBuildManager::GenerateMakefile ( const CString FileName)

Generates makefile text and writes it to the file specified by FileName.

Parameters
FileNamea file name for makefile.

Build manager does not generate makefile text by itself, makefile for workspace is generated by CCodeBlocksWorkspace and makefiles for individual projects in a workspace are generated by CCodeBlocksProject.

◆ LoadProjectOrWorkspace()

CCodeBlocksBuildManager::LoadProjectOrWorkspace ( const CString FileName)

Loads a workspace or a project file whichever specified by FileName.

Parameters
FileNamea file name of a project or workspace.
Returns
true if the project or workspace is successfully loaded, false otherwise.

◆ Platforms()

CCodeBlocksBuildManager::Platforms ( void  )
inline

Returns reference to the set of platforms in build configuration.

Returns
reference to CCodeBlocksBuildManager::m_Platforms.

◆ Show()

CCodeBlocksBuildManager::Show ( void  )

Prints project or workspace contents to standard output.

◆ ToolChains()

CCodeBlocksBuildManager::ToolChains ( void  )
inline

Returns reference to the set of toolchains in build configuration.

Returns
reference to CCodeBlocksBuildManager::m_ToolChains.

Member Data Documentation

◆ m_Config

CCodeBlocksBuildManager::m_Config
private

Build configuration.

Includes installation-specific parametes such as compilers, toolchains and global variables.

◆ m_Project

CCodeBlocksBuildManager::m_Project
private

Code::Blocks project object.

◆ m_ProjectLoaded

CCodeBlocksBuildManager::m_ProjectLoaded
private

Indicated that a Code::Blocks project was loaded.

Build manager CCodeBlocksBuildManager can load both Code::Blocks workspace (.workspace) and Code::Blocks project (.cbp) files. A flag is required to tell if a file is loaded and what kind of file it is.

◆ m_Workspace

CCodeBlocksBuildManager::m_Workspace
private

Code::Blocks workspace object.

◆ m_WorkspaceLoaded

CCodeBlocksBuildManager::m_WorkspaceLoaded
private

Indicates that a Code::Blocks workspace was loaded.

Build manager CCodeBlocksBuildManager can load both Code::Blocks workspace (.workspace) and Code::Blocks project (.cbp) files. A flag is required to tell if a file is loaded and what kind of file it is.


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