1 //===-- MICmnLog.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 "MICmnLogMediumFile.h"
13 #include "MICmnResources.h"
14 #include "MIDriverMgr.h"
15 #include "MIUtilDateTimeStd.h"
18 //------------------------------------------------------------------------------------
19 // Details: CMICmnLog constructor.
25 CMICmnLog::CMICmnLog() : m_bEnabled(false), m_bInitializingATM(false) {
26 // Do not use this constructor, use Initialize()
30 //------------------------------------------------------------------------------------
31 // Details: CMICmnLog destructor.
37 CMICmnLog::~CMICmnLog() { Shutdown(); }
40 //------------------------------------------------------------------------------------
41 // Details: Initialize resources for *this Logger.
44 // Return: MIstatus::success - Functional succeeded.
45 // MIstatus::failure - Functional failed.
48 bool CMICmnLog::Initialize() {
49 m_clientUsageRefCnt++;
52 return MIstatus::success;
54 ClrErrorDescription();
56 // Mediums set inside because explicitly initing in MIDriverMain.cpp causes
57 // compile errors with CAtlFile
58 CMICmnLogMediumFile &rFileLog(CMICmnLogMediumFile::Instance());
59 bool bOk = RegisterMedium(rFileLog);
61 // Set the Log trace file's header
62 const CMIUtilString &rCR(rFileLog.GetLineReturn());
63 CMIUtilDateTimeStd date;
65 msg = CMIUtilString::Format(
66 "%s\n", CMIDriverMgr::Instance().GetAppVersion().c_str());
67 CMIUtilString logHdr(msg);
68 msg = CMIUtilString::Format(MIRSRC(IDS_LOG_MSG_CREATION_DATE),
69 date.GetDate().c_str(), date.GetTime().c_str(),
73 CMIUtilString::Format(MIRSRC(IDS_LOG_MSG_FILE_LOGGER_PATH),
74 rFileLog.GetFileNamePath().c_str(), rCR.c_str());
77 bOk = rFileLog.SetHeaderTxt(logHdr);
79 // Note log file medium's status is not available until we write at least
80 // once to the file (so just write the title 1st line)
81 m_bInitializingATM = true;
82 CMICmnLog::WriteLog(".");
83 if (!rFileLog.IsOk()) {
84 const CMIUtilString msg(
85 CMIUtilString::Format(MIRSRC(IDS_LOG_ERR_FILE_LOGGER_DISABLED),
86 rFileLog.GetErrorDescription().c_str()));
87 CMICmnLog::WriteLog(msg);
89 m_bInitializingATM = false;
98 //------------------------------------------------------------------------------------
99 // Details: Release resources for *this Logger.
102 // Return: MIstatus::success - Functional succeeded.
103 // MIstatus::failure - Functional failed.
106 bool CMICmnLog::Shutdown() {
107 if (--m_clientUsageRefCnt > 0)
108 return MIstatus::success;
111 return MIstatus::success;
113 ClrErrorDescription();
115 const bool bOk = UnregisterMediumAll();
117 m_bInitialized = bOk;
123 //------------------------------------------------------------------------------------
124 // Details: Enabled or disable *this Logger from writing any data to registered
127 // Args: vbYes - (R) True = Logger enabled, false = disabled.
128 // Return: MIstatus::success - Functional succeeded.
129 // MIstatus::failure - Functional failed.
132 bool CMICmnLog::SetEnabled(const bool vbYes) {
135 return MIstatus::success;
139 //------------------------------------------------------------------------------------
140 // Details: Retrieve state whether *this Logger is enabled writing data to
141 // registered clients.
144 // Return: True = Logger enable.
148 bool CMICmnLog::GetEnabled() const { return m_bEnabled; }
151 //------------------------------------------------------------------------------------
152 // Details: Unregister all the Mediums registered with *this Logger.
155 // Return: MIstatus::success - Functional succeeded.
156 // MIstatus::failure - Functional failed.
159 bool CMICmnLog::UnregisterMediumAll() {
160 MapMediumToName_t::const_iterator it = m_mapMediumToName.begin();
161 for (; it != m_mapMediumToName.end(); it++) {
162 IMedium *pMedium = (*it).first;
166 m_mapMediumToName.clear();
168 return MIstatus::success;
172 //------------------------------------------------------------------------------------
173 // Details: Register a Medium with *this Logger.
175 // Args: vrMedium - (R) The medium to register.
176 // Return: MIstatus::success - Functional succeeded.
177 // MIstatus::failure - Functional failed.
180 bool CMICmnLog::RegisterMedium(const IMedium &vrMedium) {
181 if (HaveMediumAlready(vrMedium))
182 return MIstatus::success;
184 IMedium *pMedium = const_cast<IMedium *>(&vrMedium);
185 if (!pMedium->Initialize()) {
186 const CMIUtilString &rStrMedName(pMedium->GetName());
187 const CMIUtilString &rStrMedErr(pMedium->GetError());
188 SetErrorDescription(CMIUtilString::Format(MIRSRC(IDS_LOG_MEDIUM_ERR_INIT),
190 rStrMedErr.c_str()));
191 return MIstatus::failure;
194 MapPairMediumToName_t pr(pMedium, pMedium->GetName());
195 m_mapMediumToName.insert(pr);
197 return MIstatus::success;
201 //------------------------------------------------------------------------------------
202 // Details: Query the Logger to see if a medium is already registered.
204 // Args: vrMedium - (R) The medium to query.
205 // Return: True - registered.
206 // False - not registered.
209 bool CMICmnLog::HaveMediumAlready(const IMedium &vrMedium) const {
210 IMedium *pMedium = const_cast<IMedium *>(&vrMedium);
211 const MapMediumToName_t::const_iterator it = m_mapMediumToName.find(pMedium);
212 if (it != m_mapMediumToName.end())
219 //------------------------------------------------------------------------------------
220 // Details: Unregister a medium from the Logger.
222 // Args: vrMedium - (R) The medium to unregister.
223 // Return: MIstatus::success - Functional succeeded.
224 // MIstatus::failure - Functional failed.
227 bool CMICmnLog::UnregisterMedium(const IMedium &vrMedium) {
228 IMedium *pMedium = const_cast<IMedium *>(&vrMedium);
229 m_mapMediumToName.erase(pMedium);
231 return MIstatus::success;
235 //------------------------------------------------------------------------------------
236 // Details: The callee client uses this function to write to the Logger. The
238 // written is given out to all the mediums registered. The verbosity
240 // indicates to the medium(s) the type of data or message given to it.
242 // modes of verbosity and depending on the verbosity set determines
244 // go in to the logger.
245 // The logger must be initialized successfully before a write to any
247 // can be carried out.
249 // Args: vData - (R) The data to write to the logger.
250 // veType - (R) Verbosity type.
251 // Return: MIstatus::success - Functional succeeded.
252 // MIstatus::failure - Functional failed.
255 bool CMICmnLog::Write(const CMIUtilString &vData, const ELogVerbosity veType) {
256 if (!m_bInitialized && !m_bInitializingATM)
257 return MIstatus::success;
258 if (m_bRecursiveDive)
259 return MIstatus::success;
261 return MIstatus::success;
263 m_bRecursiveDive = true;
268 MapMediumToName_t::const_iterator it = m_mapMediumToName.begin();
269 while (it != m_mapMediumToName.end()) {
270 IMedium *pMedium = (*it).first;
271 const CMIUtilString &rNameMedium = (*it).second;
272 MIunused(rNameMedium);
273 if (pMedium->Write(vData, veType))
283 bool bOk = MIstatus::success;
284 const MIuint mediumCnt = m_mapMediumToName.size();
285 if ((cnt == 0) && (mediumCnt > 0)) {
286 SetErrorDescription(MIRSRC(IDS_LOG_MEDIUM_ERR_WRITE_ANY));
287 bOk = MIstatus::failure;
289 if (bOk && (cntErr != 0)) {
290 SetErrorDescription(MIRSRC(IDS_LOG_MEDIUM_ERR_WRITE_MEDIUMFAIL));
291 bOk = MIstatus::failure;
294 m_bRecursiveDive = false;
300 //------------------------------------------------------------------------------------
301 // Details: Short cut function call to write only to the Log file.
302 // The logger must be initialized successfully before a write to any
304 // can be carried out.
306 // Args: vData - (R) The data to write to the logger.
307 // Return: MIstatus::success - Functional succeeded.
308 // MIstatus::failure - Functional failed.
311 bool CMICmnLog::WriteLog(const CMIUtilString &vData) {
312 return CMICmnLog::Instance().Write(vData, CMICmnLog::eLogVerbosity_Log);
316 //------------------------------------------------------------------------------------
317 // Details: Retrieve a string detailing the last error.
320 // Return: CMIUtilString.
323 const CMIUtilString &CMICmnLog::GetErrorDescription() const {
324 return m_strMILastErrorDescription;
328 //------------------------------------------------------------------------------------
329 // Details: Set the internal description of the last error.
331 // Args: (R) String containing a description of the last error.
335 void CMICmnLog::SetErrorDescription(const CMIUtilString &vrTxt) const {
336 m_strMILastErrorDescription = vrTxt;
340 //------------------------------------------------------------------------------------
341 // Details: Clear the last error.
347 void CMICmnLog::ClrErrorDescription() const {
348 m_strMILastErrorDescription = CMIUtilString("");