1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
|
//===-- MICmnLogMediumFile.cpp ----------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//++
// File: MICmnLogMediumFile.cpp
//
// Overview: CMICmnLogMediumFile implementation.
//
// Environment: Compilers: Visual C++ 12.
// gcc (Ubuntu/Linaro 4.8.1-10ubuntu9) 4.8.1
// Libraries: See MIReadmetxt.
//
// Copyright: None.
//--
// Include compiler configuration
#include "MICmnConfig.h"
// In-house headers:
#include "MICmnLogMediumFile.h"
#include "MICmnResources.h"
#if defined( _MSC_VER )
#include "MIUtilSystemWindows.h"
#elif defined( __FreeBSD_kernel__ ) || defined( __linux__ )
#include "MIUtilSystemLinux.h"
#elif defined( __APPLE__ )
#include "MIUtilSystemOsx.h"
#endif // defined( _MSC_VER )
#include "MIUtilDateTimeStd.h"
//++ ------------------------------------------------------------------------------------
// Details: CMICmnLogMediumFile constructor.
// Type: Method.
// Args: None.
// Return: None.
// Throws: None.
//--
CMICmnLogMediumFile::CMICmnLogMediumFile( void )
: m_constThisMediumName( MIRSRC( IDS_MEDIUMFILE_NAME ) )
, m_constMediumFileName( "lldb-mi-log.txt" )
, m_fileNamePath( MIRSRC( IDS_MEDIUMFILE_ERR_INVALID_PATH ) )
, m_eVerbosityType( CMICmnLog::eLogVerbosity_Log )
, m_strDate( CMIUtilDateTimeStd().GetDate() )
, m_fileHeaderTxt( MIRSRC( IDS_MEDIUMFILE_ERR_FILE_HEADER ) )
{
}
//++ ------------------------------------------------------------------------------------
// Details: CMICmnLogMediumFile destructor.
// Type: Overridden.
// Args: None.
// Return: None.
// Throws: None.
//--
CMICmnLogMediumFile::~CMICmnLogMediumFile( void )
{
}
//++ ------------------------------------------------------------------------------------
// Details: Get the singleton instance of *this class.
// Type: Static.
// Args: None.
// Return: CMICmnLogMediumFile - Reference to *this object.
// Throws: None.
//--
CMICmnLogMediumFile & CMICmnLogMediumFile::Instance( void )
{
static CMICmnLogMediumFile instance;
return instance;
}
//++ ------------------------------------------------------------------------------------
// Details: Initialize setup *this medium ready for use.
// Type: Overridden.
// Args: None.
// Return: MIstatus::success - Functional succeeded.
// MIstatus::failure - Functional failed.
// Throws: None.
//--
bool CMICmnLogMediumFile::Initialize( void )
{
m_bInitialized = FileFormFileNamePath();
return m_bInitialized;
}
//++ ------------------------------------------------------------------------------------
// Details: Unbind detach or release resources used by *this medium.
// Type: Method.
// Args: None.
// Return: None.
// Throws: None.
//--
bool CMICmnLogMediumFile::Shutdown( void )
{
if( m_bInitialized )
{
m_bInitialized = false;
m_file.Close();
}
return MIstatus::success;
}
//++ ------------------------------------------------------------------------------------
// Details: Retrieve the name of *this medium.
// Type: Overridden.
// Args: None.
// Return: CMIUtilString - Text data.
// Throws: None.
//--
const CMIUtilString & CMICmnLogMediumFile::GetName( void ) const
{
return m_constThisMediumName;
}
//++ ------------------------------------------------------------------------------------
// Details: The callee client calls the write function on the Logger. The data to be
// written is given out to all the mediums registered. The verbosity type parameter
// indicates to the medium the type of data or message given to it. The medium has
// modes of verbosity and depending on the verbosity set determines which data is
// sent to the medium's output.
// Type: Method.
// Args: vData - (R) The data to write to the logger.
// veType - (R) Verbosity type.
// Return: MIstatus::success - Functional succeeded.
// MIstatus::failure - Functional failed.
// Throws: None.
//--
bool CMICmnLogMediumFile::Write( const CMIUtilString & vData, const CMICmnLog::ELogVerbosity veType )
{
if( m_bInitialized && m_file.IsOk() )
{
const bool bDoWrite = (m_eVerbosityType & veType);
if( bDoWrite )
{
bool bNewCreated = false;
bool bOk = m_file.CreateWrite( m_fileNamePath, bNewCreated );
if( bOk )
{
if( bNewCreated )
bOk = FileWriteHeader();
bOk = bOk && FileWriteEnglish( MassagedData( vData, veType ) );
}
return bOk;
}
}
return MIstatus::failure;
}
//++ ------------------------------------------------------------------------------------
// Details: Retrieve *this medium's last error condition.
// Type: Method.
// Args: None.
// Return: CString & - Text description.
// Throws: None.
//--
const CMIUtilString & CMICmnLogMediumFile::GetError( void ) const
{
return m_strMILastErrorDescription;
}
//++ ------------------------------------------------------------------------------------
// Details: Set the verbosity mode for this medium.
// Type: Method.
// Args: veType - (R) Mask value.
// Return: MIstatus::success - Functional succeeded.
// MIstatus::failure - Functional failed.
// Throws: None.
//--
bool CMICmnLogMediumFile::SetVerbosity( const MIuint veType )
{
m_eVerbosityType = veType;
return MIstatus::success;
}
//++ ------------------------------------------------------------------------------------
// Details: Get the verbosity mode for this medium.
// Type: Method.
// Args: veType - (R) Mask value.
// Return: CMICmnLog::ELogVerbosity - Mask value.
// Throws: None.
//--
MIuint CMICmnLogMediumFile::GetVerbosity( void ) const
{
return m_eVerbosityType;
}
//++ ------------------------------------------------------------------------------------
// Details: Write data to a file English font.
// Type: Method.
// Args: vData - (R) The data to write to the logger.
// Return: None.
// Throws: None.
//--
bool CMICmnLogMediumFile::FileWriteEnglish( const CMIUtilString & vData )
{
return m_file.Write( vData );
}
//++ ------------------------------------------------------------------------------------
// Details: Determine and form the medium file's directory path and name.
// Type: Method.
// Args: None.
// Return: MIstatus::success - Functional succeeded.
// MIstatus::failure - Functional failed.
// Throws: None.
//--
bool CMICmnLogMediumFile::FileFormFileNamePath( void )
{
ClrErrorDescription();
m_fileNamePath = MIRSRC( IDS_MEDIUMFILE_ERR_INVALID_PATH );
CMIUtilString strPathName;
if( CMIUtilSystem().GetLogFilesPath( strPathName ) )
{
const CMIUtilString strPath = CMIUtilFileStd().StripOffFileName( strPathName );
// ToDo: Review this LINUX log file quick fix so not hidden
// AD:
// Linux was creating a log file here called '.\log.txt'. The '.' on linux
// signifies that this file is 'hidden' and not normally visible. A quick fix
// is to remove the path component all together. Linux also normally uses '/'
// as directory separators, again leading to the problem of the hidden log.
#if defined ( _MSC_VER )
m_fileNamePath = CMIUtilString::Format( "%s\\%s", strPath.c_str(), m_constMediumFileName.c_str() );
#else
m_fileNamePath = CMIUtilString::Format( "%s", m_constMediumFileName.c_str() );
#endif // defined ( _MSC_VER )
return MIstatus::success;
}
SetErrorDescription( MIRSRC( IDE_MEDIUMFILE_ERR_GET_FILE_PATHNAME_SYS ) );
return MIstatus::failure;
}
//++ ------------------------------------------------------------------------------------
// Details: Retrieve the medium file's directory path and name.
// Type: Method.
// Args: None.
// Return: CMIUtilString & - File path.
// Throws: None.
//--
const CMIUtilString & CMICmnLogMediumFile::GetFileNamePath( void ) const
{
return m_fileNamePath;
}
//++ ------------------------------------------------------------------------------------
// Details: Retrieve the medium file's name.
// Type: Method.
// Args: None.
// Return: CMIUtilString & - File name.
// Throws: None.
//--
const CMIUtilString & CMICmnLogMediumFile::GetFileName( void ) const
{
return m_constMediumFileName;
}
//++ ------------------------------------------------------------------------------------
// Details: Massage the data to behave correct when submitted to file. Insert extra log
// specific text. The veType is there to allow in the future to parse the log and
// filter in out specific types of message to make viewing the log more manageable.
// Type: Method.
// Args: vData - (R) Raw data.
// veType - (R) Message type.
// Return: CMIUtilString - Massaged data.
// Throws: None.
//--
CMIUtilString CMICmnLogMediumFile::MassagedData( const CMIUtilString & vData, const CMICmnLog::ELogVerbosity veType )
{
const CMIUtilString strCr( "\n" );
CMIUtilString data;
const MIchar verbosityCode( ConvertLogVerbosityTypeToId( veType ) );
const CMIUtilString dt( CMIUtilString::Format( "%s %s", m_strDate.c_str(), CMIUtilDateTimeStd().GetTime().c_str() ) );
data = CMIUtilString::Format( "%c,%s,%s", verbosityCode, dt.c_str(), vData.c_str() );
data = ConvertCr( data );
// Look for EOL...
const MIint pos = vData.rfind( strCr );
if( pos == (MIint) vData.size() )
return data;
// ... did not have an EOL so add one
data += GetLineReturn();
return data;
}
//++ ------------------------------------------------------------------------------------
// Details: Convert the Log's verbosity type number into a single char character.
// Type: Method.
// Args: veType - (R) Message type.
// Return: wchar_t - A letter.
// Throws: None.
//--
MIchar CMICmnLogMediumFile::ConvertLogVerbosityTypeToId( const CMICmnLog::ELogVerbosity veType ) const
{
MIchar c = 0;
if( veType != 0 )
{
MIuint cnt = 0;
MIuint number( veType );
while( 1 != number )
{
number = number >> 1;
++cnt;
}
c = 'A' + cnt;
}
else
{
c = '*';
}
return c;
}
//++ ------------------------------------------------------------------------------------
// Details: Retrieve state of whether the file medium is ok.
// Type: Method.
// Args: None.
// Return: True - file ok.
// False - file has a problem.
// Throws: None.
//--
bool CMICmnLogMediumFile::IsOk( void ) const
{
return m_file.IsOk();
}
//++ ------------------------------------------------------------------------------------
// Details: Status on the file log medium existing already.
// Type: Method.
// Args: None.
// Return: True - Exists.
// False - Not found.
// Throws: None.
//--
bool CMICmnLogMediumFile::IsFileExist( void ) const
{
return m_file.IsFileExist( GetFileNamePath() );
}
//++ ------------------------------------------------------------------------------------
// Details: Write the header text the logger file.
// Type: Method.
// Args: vText - (R) Text.
// Return: MIstatus::success - Functional succeeded.
// MIstatus::failure - Functional failed.
// Throws: None.
//--
bool CMICmnLogMediumFile::FileWriteHeader( void )
{
return FileWriteEnglish( ConvertCr( m_fileHeaderTxt ) );
}
//++ ------------------------------------------------------------------------------------
// Details: Convert any carriage line returns to be compatible with the platform the
// Log fiel is being written to.
// Type: Method.
// Args: vData - (R) Text data.
// Return: CMIUtilString - Converted string data.
// Throws: None.
//--
CMIUtilString CMICmnLogMediumFile::ConvertCr( const CMIUtilString & vData ) const
{
const CMIUtilString strCr( "\n" );
const CMIUtilString & rCrCmpat( GetLineReturn() );
if( strCr == rCrCmpat )
return vData;
const MIuint nSizeCmpat( rCrCmpat.size() );
const MIuint nSize( strCr.size() );
CMIUtilString strConv( vData );
MIint pos = strConv.find( strCr );
while( pos != (MIint) CMIUtilString::npos )
{
strConv.replace( pos, nSize, rCrCmpat );
pos = strConv.find( strCr, pos + nSizeCmpat );
}
return strConv;
}
//++ ------------------------------------------------------------------------------------
// Details: Set the header text that is written to the logger file at the begining.
// Type: Method.
// Args: vText - (R) Text.
// Return: MIstatus::success - Functional succeeded.
// MIstatus::failure - Functional failed.
// Throws: None.
//--
bool CMICmnLogMediumFile::SetHeaderTxt( const CMIUtilString & vText )
{
m_fileHeaderTxt = vText;
return MIstatus::success;
}
//++ ------------------------------------------------------------------------------------
// Details: Retrieve the file current carriage line return characters used.
// Type: Method.
// Args: None.
// Return: CMIUtilString & - Text.
// Throws: None.
//--
const CMIUtilString & CMICmnLogMediumFile::GetLineReturn( void ) const
{
return m_file.GetLineReturn();
}
|