winIDEA SDK
|
This class provides access to winIDEA project manager.
#include <CProjectController.h>
Public Member Functions | |
CProjectController (std::shared_ptr< ConnectionMgr > connectionMgr) | |
Constructs the object. More... | |
::IConnectProject * | getIConnectProject () |
Returns the isystem.connect Project interface. More... | |
void | compile (const std::string &fileName) |
Compiles the specified file. More... | |
void | link (bool suppressPostLinkActions=false) |
Links the active project. More... | |
void | make (bool suppressPostLinkActions=false) |
Makes the active project. More... | |
void | build (bool suppressPostLinkActions=false) |
Builds the active project. More... | |
bool | isUpToDate () |
Returns true if project is up to date, or false if sources are newer than executable. More... | |
void | setTarget (const std::string &makeTargetName) |
Sets make target in winIDEA. More... | |
void | dependencies () |
Updates dependencies. More... | |
void | stop () |
Stops the current operation. More... | |
void | customOperation (const std::string &operation, const std::string ¶meters) |
Runs custom operation. More... | |
CBuildStatus | getStatus () |
Returns the object with information about the current build manager status. More... | |
CBuildOptions & | options () |
Returns reference to build options associated with this build manager. More... | |
std::string | enumerateProjectOption (const std::string &scope, const std::string &option, int index, bool isReturnRelativePath) |
This method can enumerate build targets, groups, and files in project. More... | |
std::string | modifyProjectOption (IConnectProject::EOptionFlags cmd, DWORD cmdFlags, const std::string &scope, const std::string &option, const std::string &value) |
This is a general method for configuration of project manager in winIDEA. More... | |
std::string | getWarningMessage () |
Returns warning message for methods in this class, which have returned warning error code, for example when importProject() or exportProject() return -1. More... | |
isys::CProjectController::CProjectController | ( | std::shared_ptr< ConnectionMgr > | connectionMgr | ) |
Constructs the object.
void isys::CProjectController::build | ( | bool | suppressPostLinkActions = false | ) |
Builds the active project.
suppressPostLinkActions | if true, automatic post-link actions are not performed |
void isys::CProjectController::compile | ( | const std::string & | fileName | ) |
Compiles the specified file.
fileName | the file to compile. The file must be included in the active project. Python example. |
void isys::CProjectController::customOperation | ( | const std::string & | operation, |
const std::string & | parameters | ||
) |
Runs custom operation.
operation | operation to run |
parameters | parameters of the operation Python example. |
void isys::CProjectController::dependencies | ( | ) |
Updates dependencies.
std::string isys::CProjectController::enumerateProjectOption | ( | const std::string & | scope, |
const std::string & | option, | ||
int | index, | ||
bool | isReturnRelativePath | ||
) |
This method can enumerate build targets, groups, and files in project.
scope | scope should be of format: ">project>group>file name|translator|target" If project or target are blank, the current project/active target is assumed. Examples:
| |||||||||
option | name of the option to get | |||||||||
index | index of item to retrieve. When end of list is reached, empty string is returned. | |||||||||
isReturnRelativePath | if true, relative paths are returned |
::IConnectProject * isys::CProjectController::getIConnectProject | ( | ) |
Returns the isystem.connect Project interface.
Use this method only when some functionality of the IConnectProject interface regarding project handling is not accessible from this wrapper.
CBuildStatus isys::CProjectController::getStatus | ( | ) |
Returns the object with information about the current build manager status.
std::string isys::CProjectController::getWarningMessage | ( | ) |
Returns warning message for methods in this class, which have returned warning error code, for example when importProject() or exportProject() return -1.
bool isys::CProjectController::isUpToDate | ( | ) |
Returns true
if project is up to date, or false
if sources are newer than executable.
void isys::CProjectController::link | ( | bool | suppressPostLinkActions = false | ) |
Links the active project.
suppressPostLinkActions | if true, automatic post-link actions are not performed Python example. |
void isys::CProjectController::make | ( | bool | suppressPostLinkActions = false | ) |
Makes the active project.
suppressPostLinkActions | if true, automatic post-link actions are not performed Python example. |
std::string isys::CProjectController::modifyProjectOption | ( | IConnectProject::EOptionFlags | cmd, |
DWORD | cmdFlags, | ||
const std::string & | scope, | ||
const std::string & | option, | ||
const std::string & | value | ||
) |
This is a general method for configuration of project manager in winIDEA.
cmd | command. If you need command ofaEnum, use more convenient method enumerateProjectOption(). | ||||||||||||||||||||||||||||||
cmdFlags | this parameter may contain the second part of cmd, for example ofaRelativePaths, or-ed with index when needed | ||||||||||||||||||||||||||||||
scope | scope should be of format: ">project>group>file name|translator|target" If project or target are blank, the current project/active target is assumed. Examples:
| ||||||||||||||||||||||||||||||
option | name of the option to get or set. | ||||||||||||||||||||||||||||||
value | new option value when set or add is used. Should be empty string on get. |
CBuildOptions & isys::CProjectController::options | ( | ) |
Returns reference to build options associated with this build manager.
Use this reference to get/set build options.
void isys::CProjectController::setTarget | ( | const std::string & | makeTargetName | ) |
Sets make target in winIDEA.
See winIDEA menu option Project
| Targets
. Python example.
void isys::CProjectController::stop | ( | ) |
Stops the current operation.