LogObject.h

//========================================================================================
// 
// $File$
// 
// Owner: lance bushore
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// This file is conditionally compiled. If we are building Public, we want
// to only build this if we are doing a DEBUG build. If we are building
// TestLib, we want to build this if we are doing a non-DEBUG build. This
// is so that Logging code will be stripped out of shipping code, but still
// allow us to write logs from test plugins in non-debug builds.
// 
//========================================================================================

#ifndef __LogObject__
#define __LogObject__

#include <time.h>
#include "IDFile.h"
#include "IPMStream.h" // for OpenMode
#include <string>

#if defined (ID_ENABLE_DEBUGGING) && (!TESTLIB_BUILD)
#define LOG_DECL 
#else
#define LOG_DECL TESTLIB_DECL
#endif

class IXferBytes;
class IPMStream;

//If you change the definition of LogObject, remember to build
//Public. Both TestLib and Public include LogObject.cpp, but
//this class belongs to Public in the Debug build. Building
//TestLib alone won't allow the linker to resolve a reference
//to, for example, an added member function.

class LOG_DECL LogObject
{
 public:

 LogObject(const char *logFileName, bool16 newFile = kTrue, bool16 writeMemoryInfo = kTrue, bool16 autoflush = kFalse);

 LogObject(bool16 newFile, const char *logFileName, bool16 autoflush = kFalse);// For those who do not want any header trailer text

 LogObject(IDFile pathAndName, bool16 newFile = kTrue, bool16 autoflush = kFalse);

 virtual ~LogObject();

 void WriteLog(bool16 terminateLine, const char *format, ... );

 void WriteLogFormat(const char *format, va_list argptr, bool16 terminateLine = kTrue );


 void WriteLog(const PMString& logString, bool16 terminateLine = kTrue);


 void WriteDateTime(bool16 terminateLine);


 void WriteElapsedTime(bool16 terminateLine);

 void WriteMemoryInfo();

 void WriteAvailableMemory();

 void WriteMemoryUsed();

 void WriteSeparator();

 void Indent();

 void UnIndent();

 int16 GetNumIndents();


 void Prepend(const PMString& prepend);

 void RemovePrepend();


 void SetWriteTrailer(bool16 writeTrailer) { fWriteTrailer = writeTrailer; }

 static PMString GetQAFileDir();

 static PMString GetLogFileDir();

 static PMString GetBenchmarkDataDir();

 static PMString GetPortDirName();

 PMString GetLogFileName(void);


 void WriteInsert(const PMString& logString, CharCounter startPos);

 void WriteBasicHeader(const char *fileName);

 protected:

 private:
 IPMStream *GetStream( OpenMode mode = kOpenTrunc );
 void CloseStream();
 
 time_t fStartTime;
 int32 fStartMem;
 IDFile fLogFile;
 IPMStream *fLogStream;
 IXferBytes *fXferBytes;
 bool16 fWriteTrailer;
 std::string fIndent;
 std::string fPrepend;
 bool16 fAutoflush;
};
#endif