1 // Copyright (c) 2007-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 //

    15 

    16 #ifndef TRACEEVENTBASE_H

    17 #define TRACEEVENTBASE_H

    18 

    19 #include <string>

    20 #include "traceevent.h"

    21 

    22 class CTraceEventFactory;

    23 class MEventOutputHandler;

    24 class CMultiPartFrameCollection;

    25 class CUTraceFrame;

    26 

    27 class CTraceEventBase : public MTraceEvent

    28     {

    29     friend class CTraceEventFactory;

    30 

    31     protected:

    32         CTraceEventBase(const CMultiPartFrameCollection& aFrames, MEventOutputHandler& aOutputHandler);

    33         CTraceEventBase(const CUTraceFrame& aFrame, MEventOutputHandler& aOutputHandler);

    34 

    35     public:

    36         virtual ~CTraceEventBase();

    37 

    38     // From MLogEvent

    39     public:

    40         // Flags from the frame header

    41         virtual unsigned int Flags() const;

    42 

    43         // Primary filter (Category) of the frame

    44         virtual unsigned int PrimaryFilter() const;

    45 

    46         // Secondary filter of the frame

    47         virtual unsigned int SecondaryFilter() const;

    48 

    49         // Subcategory of the frame (meaning dependant on the Category)

    50         virtual unsigned int SubCategory() const;

    51 

    52         // Flag accessors

    53         virtual bool Header2Present() const;

    54         virtual bool Timestamp1Present() const;

    55         virtual bool Timestamp2Present() const;

    56         virtual bool ContextIdPresent() const;

    57         virtual bool PcPresent() const;

    58         virtual bool ExtraPresent() const;

    59 

    60         // These return values from the header if they are present

    61         virtual unsigned int Header2() const;

    62         virtual unsigned int Timestamp1() const;

    63         virtual unsigned int Timestamp2() const;

    64         virtual unsigned int ContextType() const;

    65         virtual unsigned int ContextId() const;

    66         virtual unsigned int ProgramCounter() const;

    67         virtual unsigned int Extra() const;

    68 

    69         virtual unsigned int Arg1() const;

    70         virtual unsigned char* Data() const;

    71         virtual unsigned int DataLength() const;

    72 

    73         virtual unsigned int EventEntryNumber() const;

    74 

    75     public:

    76         virtual void ProcessEvent() const;

    77         virtual void Describe(std::ostream& aOutput) const = 0;

    78 

    79         void DumpEvent(std::ostream& aStream) const;

    80         

    81         void WriteContextInfo(std::ostream& aOutput) const;

    82         void WriteEventPrefix(std::ostream& aOutput) const;

    83 

    84         void SetPrefix(const std::string& aPrefix);

    85         void SetPrefix(const char* aPrefix);

    86 

    87     protected:

    88         inline MEventOutputHandler& EventOutputHandler() const

    89             {

    90             return iOutputHandler;

    91             }

    92 

    93         virtual void Initialise(const CUTraceFrame& aFrame);

    94     

    95     private:

    96         mutable MEventOutputHandler& iOutputHandler;

    97 

    98         unsigned int iFlags;

    99         unsigned int iPrimaryFilter;

   100         unsigned int iSecondaryFilter;

   101         unsigned int iContext;

   102         unsigned int iSubCategory;

   103 

   104         unsigned int iArg1;

   105         

   106         unsigned int iHeader2;

   107         unsigned int iTimestamp1;

   108         unsigned int iTimestamp2;

   109         unsigned int iProgramCounter;

   110         unsigned int iExtra;

   111 

   112         unsigned char* iData;

   113         unsigned int iDataLength;

   114 

   115         unsigned int iEventEntryNumber;

   116 

   117         std::string iPrefix;

   118     };

   119 

   120 #endif

   121 // TRACEEVENTBASE_H

   122