1 //===-- MICmdMgr.cpp --------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
13 // Overview: CMICmdMgr implementation.
15 // Environment: Compilers: Visual C++ 12.
16 // gcc (Ubuntu/Linaro 4.8.1-10ubuntu9) 4.8.1
17 // Libraries: See MIReadmetxt.
24 #include "MICmnResources.h"
26 #include "MICmdInterpreter.h"
27 #include "MICmdFactory.h"
28 #include "MICmdInvoker.h"
29 #include "MICmdBase.h"
30 #include "MIUtilSingletonBase.h"
31 #include "MIUtilSingletonHelper.h"
33 //++ ------------------------------------------------------------------------------------
34 // Details: CMICmdMgr constructor.
40 CMICmdMgr::CMICmdMgr(void)
41 : m_interpretor(CMICmdInterpreter::Instance())
42 , m_factory(CMICmdFactory::Instance())
43 , m_invoker(CMICmdInvoker::Instance())
47 //++ ------------------------------------------------------------------------------------
48 // Details: CMICmdMgr destructor.
54 CMICmdMgr::~CMICmdMgr(void)
59 //++ ------------------------------------------------------------------------------------
60 // Details: Initialize resources for *this Command Manager.
63 // Return: MIstatus::success - Functionality succeeded.
64 // MIstatus::failure - Functionality failed.
68 CMICmdMgr::Initialize(void)
70 m_clientUsageRefCnt++;
73 return MIstatus::success;
75 bool bOk = MIstatus::success;
78 // Note initialization order is important here as some resources depend on previous
79 MI::ModuleInit<CMICmnLog>(IDS_MI_INIT_ERR_LOG, bOk, errMsg);
80 MI::ModuleInit<CMICmnResources>(IDS_MI_INIT_ERR_RESOURCES, bOk, errMsg);
81 if (bOk && !m_interpretor.Initialize())
84 errMsg = CMIUtilString::Format(MIRSRC(IDS_MI_INIT_ERR_CMDINTERPRETER), m_interpretor.GetErrorDescription().c_str());
86 if (bOk && !m_factory.Initialize())
89 errMsg = CMIUtilString::Format(MIRSRC(IDS_MI_INIT_ERR_CMDFACTORY), m_factory.GetErrorDescription().c_str());
91 if (bOk && !m_invoker.Initialize())
94 errMsg = CMIUtilString::Format(MIRSRC(IDS_MI_INIT_ERR_CMDINVOKER), m_invoker.GetErrorDescription().c_str());
100 CMIUtilString strInitError(CMIUtilString::Format(MIRSRC(IDS_MI_INIT_ERR_CMDMGR), errMsg.c_str()));
101 SetErrorDescription(strInitError);
102 return MIstatus::failure;
105 return MIstatus::success;
108 //++ ------------------------------------------------------------------------------------
109 // Details: Release resources for *this Command Manager.
112 // Return: MIstatus::success - Functionality succeeded.
113 // MIstatus::failure - Functionality failed.
117 CMICmdMgr::Shutdown(void)
119 if (--m_clientUsageRefCnt > 0)
120 return MIstatus::success;
123 return MIstatus::success;
125 m_bInitialized = false;
127 ClrErrorDescription();
129 bool bOk = MIstatus::success;
130 CMIUtilString errMsg;
133 m_setCmdDeleteCallback.clear();
135 // Note shutdown order is important here
136 if (!m_invoker.Shutdown())
139 errMsg += CMIUtilString::Format(MIRSRC(IDS_MI_SHTDWN_ERR_CMDINVOKER), m_invoker.GetErrorDescription().c_str());
141 if (!m_factory.Shutdown())
146 errMsg += CMIUtilString::Format(MIRSRC(IDS_MI_SHTDWN_ERR_CMDFACTORY), m_factory.GetErrorDescription().c_str());
148 if (!m_interpretor.Shutdown())
153 errMsg += CMIUtilString::Format(MIRSRC(IDS_MI_SHTDWN_ERR_CMDINTERPRETER), m_interpretor.GetErrorDescription().c_str());
155 MI::ModuleShutdown<CMICmnResources>(IDS_MI_INIT_ERR_RESOURCES, bOk, errMsg);
156 MI::ModuleShutdown<CMICmnLog>(IDS_MI_INIT_ERR_LOG, bOk, errMsg);
160 SetErrorDescriptionn(MIRSRC(IDS_MI_SHUTDOWN_ERR), errMsg.c_str());
163 return MIstatus::success;
166 //++ ------------------------------------------------------------------------------------
167 // Details: Establish whether the text data is an MI format type command.
169 // Args: vTextLine - (R) Text data to interpret.
170 // vwbYesValid - (W) True = MI type command, false = not recognised.
171 // vwbCmdNotInCmdFactor - (W) True = MI command not found in the command factor, false = recognised.
172 // Return: MIstatus::success - Functionality succeeded.
173 // MIstatus::failure - Functionality failed.
177 CMICmdMgr::CmdInterpret(const CMIUtilString &vTextLine, bool &vwbYesValid, bool &vwbCmdNotInCmdFactor, SMICmdData &rwCmdData)
179 return m_interpretor.ValidateIsMi(vTextLine, vwbYesValid, vwbCmdNotInCmdFactor, rwCmdData);
182 //++ ------------------------------------------------------------------------------------
183 // Details: Having previously had the potential command validated and found valid now
184 // get the command executed.
185 // If the Functionalityity returns MIstatus::failure call GetErrorDescription().
186 // This function is used by the application's main thread.
188 // Args: vCmdData - (RW) Command meta data.
189 // Return: MIstatus::success - Functionality succeeded.
190 // MIstatus::failure - Functionality failed.
194 CMICmdMgr::CmdExecute(const SMICmdData &vCmdData)
196 bool bOk = MIstatus::success;
198 // Pass the command's meta data structure to the command
199 // so it can update it if required. (Need to copy it out of the
200 // command before the command is deleted)
201 CMICmdBase *pCmd = nullptr;
202 bOk = m_factory.CmdCreate(vCmdData.strMiCmd, vCmdData, pCmd);
205 const CMIUtilString errMsg(
206 CMIUtilString::Format(MIRSRC(IDS_CMDMGR_ERR_CMD_FAILED_CREATE), m_factory.GetErrorDescription().c_str()));
207 SetErrorDescription(errMsg);
208 return MIstatus::failure;
211 bOk = m_invoker.CmdExecute(*pCmd);
214 const CMIUtilString errMsg(CMIUtilString::Format(MIRSRC(IDS_CMDMGR_ERR_CMD_INVOKER), m_invoker.GetErrorDescription().c_str()));
215 SetErrorDescription(errMsg);
216 return MIstatus::failure;
222 //++ ------------------------------------------------------------------------------------
223 // Details: Iterate all interested clients and tell them a command is being deleted.
225 // Args: vCmdData - (RW) The command to be deleted.
226 // Return: MIstatus::success - Functional succeeded.
227 // MIstatus::failure - Functional failed.
231 CMICmdMgr::CmdDelete(SMICmdData vCmdData)
233 // Note vCmdData is a copy! The command holding its copy will be deleted soon
234 // we still need to iterate callback clients after a command object is deleted
236 m_setCmdDeleteCallback.Delete(vCmdData);
238 return MIstatus::success;
241 //++ ------------------------------------------------------------------------------------
242 // Details: Register an object to be called when a command object is deleted.
244 // Args: vObject - (R) A new interested client.
245 // Return: MIstatus::success - Functional succeeded.
246 // MIstatus::failure - Functional failed.
250 CMICmdMgr::CmdRegisterForDeleteNotification(CMICmdMgrSetCmdDeleteCallback::ICallback &vObject)
252 return m_setCmdDeleteCallback.Register(vObject);
255 //++ ------------------------------------------------------------------------------------
256 // Details: Unregister an object from being called when a command object is deleted.
258 // Args: vObject - (R) The was interested client.
259 // Return: MIstatus::success - Functional succeeded.
260 // MIstatus::failure - Functional failed.
264 CMICmdMgr::CmdUnregisterForDeleteNotification(CMICmdMgrSetCmdDeleteCallback::ICallback &vObject)
266 return m_setCmdDeleteCallback.Unregister(vObject);