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 //===----------------------------------------------------------------------===//
12 #include "MICmnResources.h"
14 #include "MICmdInterpreter.h"
15 #include "MICmdFactory.h"
16 #include "MICmdInvoker.h"
17 #include "MICmdBase.h"
18 #include "MIUtilSingletonBase.h"
19 #include "MIUtilSingletonHelper.h"
21 //++ ------------------------------------------------------------------------------------
22 // Details: CMICmdMgr constructor.
28 CMICmdMgr::CMICmdMgr(void)
29 : m_interpretor(CMICmdInterpreter::Instance())
30 , m_factory(CMICmdFactory::Instance())
31 , m_invoker(CMICmdInvoker::Instance())
35 //++ ------------------------------------------------------------------------------------
36 // Details: CMICmdMgr destructor.
42 CMICmdMgr::~CMICmdMgr(void)
47 //++ ------------------------------------------------------------------------------------
48 // Details: Initialize resources for *this Command Manager.
51 // Return: MIstatus::success - Functionality succeeded.
52 // MIstatus::failure - Functionality failed.
56 CMICmdMgr::Initialize(void)
58 m_clientUsageRefCnt++;
61 return MIstatus::success;
63 bool bOk = MIstatus::success;
66 // Note initialization order is important here as some resources depend on previous
67 MI::ModuleInit<CMICmnLog>(IDS_MI_INIT_ERR_LOG, bOk, errMsg);
68 MI::ModuleInit<CMICmnResources>(IDS_MI_INIT_ERR_RESOURCES, bOk, errMsg);
69 if (bOk && !m_interpretor.Initialize())
72 errMsg = CMIUtilString::Format(MIRSRC(IDS_MI_INIT_ERR_CMDINTERPRETER), m_interpretor.GetErrorDescription().c_str());
74 if (bOk && !m_factory.Initialize())
77 errMsg = CMIUtilString::Format(MIRSRC(IDS_MI_INIT_ERR_CMDFACTORY), m_factory.GetErrorDescription().c_str());
79 if (bOk && !m_invoker.Initialize())
82 errMsg = CMIUtilString::Format(MIRSRC(IDS_MI_INIT_ERR_CMDINVOKER), m_invoker.GetErrorDescription().c_str());
88 CMIUtilString strInitError(CMIUtilString::Format(MIRSRC(IDS_MI_INIT_ERR_CMDMGR), errMsg.c_str()));
89 SetErrorDescription(strInitError);
90 return MIstatus::failure;
93 return MIstatus::success;
96 //++ ------------------------------------------------------------------------------------
97 // Details: Release resources for *this Command Manager.
100 // Return: MIstatus::success - Functionality succeeded.
101 // MIstatus::failure - Functionality failed.
105 CMICmdMgr::Shutdown(void)
107 if (--m_clientUsageRefCnt > 0)
108 return MIstatus::success;
111 return MIstatus::success;
113 m_bInitialized = false;
115 ClrErrorDescription();
117 bool bOk = MIstatus::success;
118 CMIUtilString errMsg;
121 m_setCmdDeleteCallback.clear();
123 // Note shutdown order is important here
124 if (!m_invoker.Shutdown())
127 errMsg += CMIUtilString::Format(MIRSRC(IDS_MI_SHTDWN_ERR_CMDINVOKER), m_invoker.GetErrorDescription().c_str());
129 if (!m_factory.Shutdown())
134 errMsg += CMIUtilString::Format(MIRSRC(IDS_MI_SHTDWN_ERR_CMDFACTORY), m_factory.GetErrorDescription().c_str());
136 if (!m_interpretor.Shutdown())
141 errMsg += CMIUtilString::Format(MIRSRC(IDS_MI_SHTDWN_ERR_CMDINTERPRETER), m_interpretor.GetErrorDescription().c_str());
143 MI::ModuleShutdown<CMICmnResources>(IDS_MI_INIT_ERR_RESOURCES, bOk, errMsg);
144 MI::ModuleShutdown<CMICmnLog>(IDS_MI_INIT_ERR_LOG, bOk, errMsg);
148 SetErrorDescriptionn(MIRSRC(IDS_MI_SHUTDOWN_ERR), errMsg.c_str());
151 return MIstatus::success;
154 //++ ------------------------------------------------------------------------------------
155 // Details: Establish whether the text data is an MI format type command.
157 // Args: vTextLine - (R) Text data to interpret.
158 // vwbYesValid - (W) True = MI type command, false = not recognised.
159 // vwbCmdNotInCmdFactor - (W) True = MI command not found in the command factor, false = recognised.
160 // Return: MIstatus::success - Functionality succeeded.
161 // MIstatus::failure - Functionality failed.
165 CMICmdMgr::CmdInterpret(const CMIUtilString &vTextLine, bool &vwbYesValid, bool &vwbCmdNotInCmdFactor, SMICmdData &rwCmdData)
167 return m_interpretor.ValidateIsMi(vTextLine, vwbYesValid, vwbCmdNotInCmdFactor, rwCmdData);
170 //++ ------------------------------------------------------------------------------------
171 // Details: Having previously had the potential command validated and found valid now
172 // get the command executed.
173 // If the Functionality returns MIstatus::failure call GetErrorDescription().
174 // This function is used by the application's main thread.
176 // Args: vCmdData - (RW) Command meta data.
177 // Return: MIstatus::success - Functionality succeeded.
178 // MIstatus::failure - Functionality failed.
182 CMICmdMgr::CmdExecute(const SMICmdData &vCmdData)
184 bool bOk = MIstatus::success;
186 // Pass the command's meta data structure to the command
187 // so it can update it if required. (Need to copy it out of the
188 // command before the command is deleted)
189 CMICmdBase *pCmd = nullptr;
190 bOk = m_factory.CmdCreate(vCmdData.strMiCmd, vCmdData, pCmd);
193 const CMIUtilString errMsg(
194 CMIUtilString::Format(MIRSRC(IDS_CMDMGR_ERR_CMD_FAILED_CREATE), m_factory.GetErrorDescription().c_str()));
195 SetErrorDescription(errMsg);
196 return MIstatus::failure;
199 bOk = m_invoker.CmdExecute(*pCmd);
202 const CMIUtilString errMsg(CMIUtilString::Format(MIRSRC(IDS_CMDMGR_ERR_CMD_INVOKER), m_invoker.GetErrorDescription().c_str()));
203 SetErrorDescription(errMsg);
204 return MIstatus::failure;
210 //++ ------------------------------------------------------------------------------------
211 // Details: Iterate all interested clients and tell them a command is being deleted.
213 // Args: vCmdData - (RW) The command to be deleted.
214 // Return: MIstatus::success - Functional succeeded.
215 // MIstatus::failure - Functional failed.
219 CMICmdMgr::CmdDelete(SMICmdData vCmdData)
221 // Note vCmdData is a copy! The command holding its copy will be deleted soon
222 // we still need to iterate callback clients after a command object is deleted
224 m_setCmdDeleteCallback.Delete(vCmdData);
226 return MIstatus::success;
229 //++ ------------------------------------------------------------------------------------
230 // Details: Register an object to be called when a command object is deleted.
232 // Args: vObject - (R) A new interested client.
233 // Return: MIstatus::success - Functional succeeded.
234 // MIstatus::failure - Functional failed.
238 CMICmdMgr::CmdRegisterForDeleteNotification(CMICmdMgrSetCmdDeleteCallback::ICallback &vObject)
240 return m_setCmdDeleteCallback.Register(vObject);
243 //++ ------------------------------------------------------------------------------------
244 // Details: Unregister an object from being called when a command object is deleted.
246 // Args: vObject - (R) The was interested client.
247 // Return: MIstatus::success - Functional succeeded.
248 // MIstatus::failure - Functional failed.
252 CMICmdMgr::CmdUnregisterForDeleteNotification(CMICmdMgrSetCmdDeleteCallback::ICallback &vObject)
254 return m_setCmdDeleteCallback.Unregister(vObject);