|
sl@0
|
1 |
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// Defines the configuration for the format of the log data.
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
/**
|
|
sl@0
|
19 |
@test
|
|
sl@0
|
20 |
*/
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#ifndef __DATAFORMAT_H__
|
|
sl@0
|
23 |
#define __DATAFORMAT_H__
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
#include <e32std.h>
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
/**
|
|
sl@0
|
28 |
@internalAll
|
|
sl@0
|
29 |
@enum TLoggingStyle
|
|
sl@0
|
30 |
Comments : Indicates the logging style which should be used by CDataLogger
|
|
sl@0
|
31 |
*/
|
|
sl@0
|
32 |
enum TLoggingStyle {EText, EHtml, ECustom};
|
|
sl@0
|
33 |
|
|
sl@0
|
34 |
/**
|
|
sl@0
|
35 |
@internalAll
|
|
sl@0
|
36 |
@struct TLogFormat
|
|
sl@0
|
37 |
Configures the format of the DataLogger's
|
|
sl@0
|
38 |
documentatry output. (see the comments
|
|
sl@0
|
39 |
for an example usage.
|
|
sl@0
|
40 |
*/
|
|
sl@0
|
41 |
typedef struct
|
|
sl@0
|
42 |
{
|
|
sl@0
|
43 |
const TDesC* iDocumentStart; // <HTML><HEAD><TITLE>
|
|
sl@0
|
44 |
const TDesC* iContentStart; // </TITLE><BODY>
|
|
sl@0
|
45 |
const TDesC* iCommentStart; // <P>
|
|
sl@0
|
46 |
const TDesC* iCommentEnd; // </P>
|
|
sl@0
|
47 |
const TDesC* iDocumentEnd; // </BODY></HTML>
|
|
sl@0
|
48 |
} TLogFormat;
|
|
sl@0
|
49 |
|
|
sl@0
|
50 |
/**
|
|
sl@0
|
51 |
@internalAll
|
|
sl@0
|
52 |
|
|
sl@0
|
53 |
*/
|
|
sl@0
|
54 |
|
|
sl@0
|
55 |
class MLogOutput
|
|
sl@0
|
56 |
{
|
|
sl@0
|
57 |
public:
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
@fn OpenL() = 0
|
|
sl@0
|
60 |
Intended Usage : Sets up the logging facility provided by the implementation of this
|
|
sl@0
|
61 |
interface. If logging cannot be established for any reason then
|
|
sl@0
|
62 |
this function should leave.
|
|
sl@0
|
63 |
@leave Implementation dependant.
|
|
sl@0
|
64 |
@since 7.0
|
|
sl@0
|
65 |
@pre None
|
|
sl@0
|
66 |
@post Nothing is left on the CleanupStack
|
|
sl@0
|
67 |
*/
|
|
sl@0
|
68 |
|
|
sl@0
|
69 |
virtual void OpenL() = 0;
|
|
sl@0
|
70 |
|
|
sl@0
|
71 |
/**
|
|
sl@0
|
72 |
@fn Write(const TDesC& aOutput) = 0
|
|
sl@0
|
73 |
Intended Usage : Logs the specified descriptor.
|
|
sl@0
|
74 |
@since 7.0
|
|
sl@0
|
75 |
@param aOutput The descriptor to stream to the logging facility
|
|
sl@0
|
76 |
@pre OpenL has been called to set up logging
|
|
sl@0
|
77 |
@post aOutput has been logged
|
|
sl@0
|
78 |
*/
|
|
sl@0
|
79 |
|
|
sl@0
|
80 |
virtual void Write(const TDesC& aOutput) = 0;
|
|
sl@0
|
81 |
|
|
sl@0
|
82 |
/**
|
|
sl@0
|
83 |
@fn Close() = 0
|
|
sl@0
|
84 |
Intended Usage : Called when all logging has finished to close down any log
|
|
sl@0
|
85 |
connections.
|
|
sl@0
|
86 |
@since 7.0
|
|
sl@0
|
87 |
@pre None
|
|
sl@0
|
88 |
@post Logging facility is closed down and this object can be deleted.
|
|
sl@0
|
89 |
*/
|
|
sl@0
|
90 |
|
|
sl@0
|
91 |
virtual void Close() = 0;
|
|
sl@0
|
92 |
};
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
/**
|
|
sl@0
|
95 |
@internalAll
|
|
sl@0
|
96 |
@struct TLoggingInfo
|
|
sl@0
|
97 |
Specifies the logging configuration.
|
|
sl@0
|
98 |
*/
|
|
sl@0
|
99 |
typedef struct
|
|
sl@0
|
100 |
{
|
|
sl@0
|
101 |
/** The title to be used in the output logs */
|
|
sl@0
|
102 |
const TDesC* iTitle;
|
|
sl@0
|
103 |
/** If logging messages should also be printed using RDebug */
|
|
sl@0
|
104 |
TBool iUseRDebug;
|
|
sl@0
|
105 |
/** The output style of the logging (plain text, html etc) */
|
|
sl@0
|
106 |
TLoggingStyle iStyle;
|
|
sl@0
|
107 |
/** If iStyle is set to ECustom then this will be used for outputting log comments */
|
|
sl@0
|
108 |
TLogFormat* iLogFormat;
|
|
sl@0
|
109 |
/** The logging mechanism. NULL will default to RFileLogger */
|
|
sl@0
|
110 |
MLogOutput* iLogOutput;
|
|
sl@0
|
111 |
/** The reporting mechanism. NULL will default to RFileLogger */
|
|
sl@0
|
112 |
MLogOutput* iReportOutput;
|
|
sl@0
|
113 |
} TLoggingInfo;
|
|
sl@0
|
114 |
|
|
sl@0
|
115 |
#endif
|
|
sl@0
|
116 |
|