MercurialSymaptic / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | raw | help
os/persistentdata/loggingservices/filelogger/INC/FLOGGER.H
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib. 
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 // FLogger Client side header

    15 // 

    16 //

    17 

    18 /**

    19 @file

    20 @publishedAll

    21 @deprecated Migrate to Open System Trace Instrumentation API instead

    22 */

    23 

    24 #ifndef __FLOGGER_H__

    25 #define __FLOGGER_H__

    26 

    27 #include <e32base.h>

    28 

    29 /** Maximum log buffer size.

    30 @publishedAll

    31 @deprecated Migrate to Open System Trace Instrumentation API instead

    32 */

    33 const TInt KLogBufferSize=150;

    34 

    35 // [All of this start up stuff copied from DBMS]

    36 

    37 class FLogger

    38 /** Controls the flogger server.

    39 @publishedAll

    40 @deprecated Migrate to Open System Trace Instrumentation API instead

    41 */

    42 	{

    43 public:

    44 	class TSignal

    45 /**

    46 @publishedAll

    47 @deprecated Migrate to Open System Trace Instrumentation API instead

    48 */

    49 		{

    50 		friend class FLogger;

    51 	public:

    52 		inline TSignal() {}

    53 		inline TInt Set(const TDesC& aCommand);

    54 	

    55 		inline TSignal(TRequestStatus& aStatus);

    56 

    57 		inline TPtrC Command() const;

    58 

    59 	private:

    60 		TRequestStatus* iStatus;

    61 		TThreadId iId;

    62 		};

    63 public:

    64 	static TInt Start();

    65 

    66 	IMPORT_C static TInt Run(TSignal& aSignal);

    67 

    68 private:

    69 	static TInt Init();

    70 	};

    71 

    72 

    73 /** The mode used to write to the log file.

    74 @publishedAll

    75 @deprecated Migrate to Open System Trace Instrumentation API instead

    76 */

    77 enum TFileLoggingMode 

    78 	{

    79 	/** Log file mode has not been explicitly set. */

    80 	EFileLoggingModeUnknown =0,

    81 	/** Open the log file in append mode. */

    82 	EFileLoggingModeAppend,

    83 	/** Open the log file in overwrite mode. */

    84 	EFileLoggingModeOverwrite,

    85 	EFileLoggingModeAppendRaw,

    86 	EFileLoggingModeOverwriteRaw	

    87 	};

    88 

    89 NONSHARABLE_CLASS(TLogFormatter16Overflow) :public TDes16Overflow

    90 /** Unicode overflow handler.

    91 @publishedAll

    92 @deprecated Migrate to Open System Trace Instrumentation API instead

    93 */

    94 	{

    95 public:

    96 	virtual void Overflow(TDes16& aDes);

    97 	};

    98 

    99 NONSHARABLE_CLASS(TLogFormatter8Overflow) :public TDes8Overflow

   100 /** Overflow handler.

   101 @publishedAll

   102 @deprecated Migrate to Open System Trace Instrumentation API instead

   103 */

   104 	{

   105 public:

   106 	virtual void Overflow(TDes8& aDes);

   107 	};

   108 

   109 class TLogFormatter

   110 /** Formatting methods for log file data.

   111 @publishedAll

   112 @deprecated Migrate to Open System Trace Instrumentation API instead

   113 */

   114 	{

   115 public:

   116 	TLogFormatter();

   117 	void SetDateAndTime(TBool aUseDate,TBool aUseTime);

   118 	TInt FormatTextToWritableBuffer(TDes8& aBuf, const TDesC16& aText) const;

   119 	TInt FormatTextToWritableBuffer(TDes8& aBuf, const TDesC8& aText) const;

   120 	TInt ConvertToWritableBuffer(TDes8& aBuf, TRefByValue<const TDesC16> aFmt, VA_LIST& aList);

   121 	TInt ConvertToWritableBuffer(TDes8& aBuf, TRefByValue<const TDesC8> aFmt, VA_LIST& aList);

   122 private:

   123 	void GetDateAndTimeL(TDes& aDate, TDes& aTime) const;

   124 	void WriteL(TDes8& aTrg, const TDesC16& aSrc) const;

   125 	void WriteL(TDes8& aTrg, const TDesC8& aSrc) const;

   126 private:

   127 	TBool iUseDate;

   128 	TBool iUseTime;

   129 	TLogFormatter16Overflow iOverflow16;

   130 	TLogFormatter8Overflow iOverflow8;

   131 	};

   132 

   133 class TLogFile

   134 /** General access to packaged log files.

   135 @publishedAll

   136 @deprecated Migrate to Open System Trace Instrumentation API instead

   137 */

   138 	{

   139 public:

   140 	TLogFile();

   141 	TLogFile(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode);

   142 	TBool operator==(const TLogFile& aLogFile) const;

   143 	void Set(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode);

   144 	inline TBool Valid() const;

   145 	inline TFileName Directory() const;

   146 	inline TFileName Name() const;

   147 	inline TFileLoggingMode Mode() const;

   148 	inline void SetValid(TBool aValid);

   149 private:

   150 	TBool iValid;

   151 	TFileName iDirectory;

   152 	TFileName iName;

   153 	TFileLoggingMode iMode;

   154 	};

   155 

   156 #include <flogger.inl>

   157 

   158 class RFileLogger : public RSessionBase

   159 /** Provides access methods to file logging.

   160 

   161 The file logger API contains both static and non-static versions of access 

   162 functions to the file logging system. 

   163 @publishedAll

   164 @deprecated Migrate to Open System Trace Instrumentation API instead

   165 */

   166 	{

   167 public:

   168 	IMPORT_C RFileLogger();

   169 	IMPORT_C ~RFileLogger();

   170 	IMPORT_C TVersion Version() const;

   171 	IMPORT_C TInt Connect();

   172 	IMPORT_C void SetDateAndTime(TBool aUseDate,TBool aUseTime);

   173 	IMPORT_C void CreateLog(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode);

   174 	IMPORT_C void CloseLog();

   175 	IMPORT_C void Write(const TDesC16& aText);

   176 	IMPORT_C void WriteFormat(TRefByValue<const TDesC16> aFmt,...);

   177 	IMPORT_C void WriteFormat(TRefByValue<const TDesC16> aFmt, VA_LIST& aList);

   178 	IMPORT_C void Write(const TDesC8& aText);

   179 	IMPORT_C void WriteFormat(TRefByValue<const TDesC8> aFmt,...);

   180 	IMPORT_C void WriteFormat(TRefByValue<const TDesC8> aFmt, VA_LIST& aList);

   181 	IMPORT_C void HexDump(const TText* aHeader, const TText* aMargin, const TUint8* aPtr, TInt aLen);

   182 	IMPORT_C static void Write(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, const TDesC16& aText);

   183 	IMPORT_C static void WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC16> aFmt,...);

   184 	IMPORT_C static void WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC16> aFmt, VA_LIST& aList);

   185 	IMPORT_C static void Write(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, const TDesC8& aText);

   186 	IMPORT_C static void WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt,...);

   187 	IMPORT_C static void WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt, VA_LIST& aList);

   188 	IMPORT_C static void HexDump(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, const TText* aHeader, const TText* aMargin, const TUint8* aPtr, TInt aLen);

   189 	IMPORT_C TInt LastError() const;

   190 	IMPORT_C TBool LogValid() const;

   191 	IMPORT_C TBool LogSTI() const;

   192 

   193 private:

   194 	TInt DoConnect();

   195 	void DoWrite(const TDesC8& aBuf);

   196 	void DoStaticWrite(const TDesC8& aBuf);

   197 	void DoWriteFormat(TRefByValue<const TDesC16> aFmt, VA_LIST& aList);

   198 	void DoWriteFormat(TRefByValue<const TDesC8> aFmt, VA_LIST& aList);

   199 	static void DoStaticWriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC16> aFmt, VA_LIST& aList);

   200 	static void DoStaticWriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt, VA_LIST& aList);

   201 	void DoHexDump(const TText* aHeader, const TText* aMargin, const TUint8* aPtr, TInt aLen);

   202 private:

   203 	TLogFormatter iFormatter;

   204 	TLogFile iLogFile;

   205 	TInt iLastError;

   206 	TBool iLogSTI;	/* CR1688  	Flogger to use RDebug::Print */

   207 	

   208 	};

   209 

   210 #endif
Symaptic