1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/tools/coredump/plugindata.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,134 @@
     1.4 +// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +// Defines ECOM-plugin related classes used accross the Core Dump client/server interface 
    1.18 +//
    1.19 +
    1.20 +
    1.21 +
    1.22 +/**
    1.23 + @file
    1.24 + @publishedPartner 
    1.25 + @released
    1.26 +*/
    1.27 +
    1.28 +#ifndef PLUGINDATA_H
    1.29 +#define PLUGINDATA_H
    1.30 +
    1.31 +/**
    1.32 +@publishedPartner 
    1.33 +@released
    1.34 +
    1.35 +Class used between Core Dump Server and its clients to request 
    1.36 +the server to carry out actions on plugins, such as load/unload.
    1.37 +@see CCrashConfig::LoadPlugin()
    1.38 +*/
    1.39 +class TPluginRequest
    1.40 +{
    1.41 +public:
    1.42 +
    1.43 +	/** 
    1.44 +	Type of plugin to request
    1.45 +	*/
    1.46 +	enum TPluginType
    1.47 +		{
    1.48 +		/** A formatter plugin */
    1.49 +		EFormatter,
    1.50 +		/** A writer plugin */
    1.51 +		EWriter
    1.52 +		};
    1.53 +
    1.54 +
    1.55 +	/** Whether to load or unload the plugin */
    1.56 +	TBool						iLoad;
    1.57 +
    1.58 +	/** Type of plugin */
    1.59 +	TPluginType					iPluginType;
    1.60 +
    1.61 +	/** @internalTechnology */
    1.62 +	TUint						iIndex;
    1.63 +
    1.64 +	/** Plugin UID, used to check correct plugin */
    1.65 +	TUid						iUid;
    1.66 +
    1.67 +	/** @internalTechnology */
    1.68 +	TUint32 iSpare1;
    1.69 +
    1.70 +	/** @internalTechnology */
    1.71 +	TUint32 iSpare2;
    1.72 +};
    1.73 +
    1.74 +
    1.75 +/** Maximum length allowed for a plugin's name */
    1.76 +#define KPluginNameLength (50)
    1.77 +
    1.78 +/** Maximum length allowed for a plugin's description */
    1.79 +#define KPluginDescriptionLength (250)
    1.80 +
    1.81 +/**
    1.82 +@publishedPartner 
    1.83 +@released
    1.84 +
    1.85 +Detailed information about a plugin.
    1.86 +@see RPluginList
    1.87 +@see TPluginInfoBlock
    1.88 +*/
    1.89 +class TPluginInfo
    1.90 +{
    1.91 +public:
    1.92 +
    1.93 +	/** Plugin's own version.
    1.94 +	From rss file::IMPLEMENTATION_INFO::version_no */
    1.95 +	TUint					iVersion;
    1.96 +
    1.97 +	/** Plugin's unique UID. 
    1.98 +	From rss file::IMPLEMENTATION_INFO::implementation_uid */
    1.99 +	TUid					iUid;
   1.100 +
   1.101 +	/** Plugin's own name.
   1.102 +	From rss file::IMPLEMENTATION_INFO::display_name */
   1.103 +	TBufC<KPluginNameLength>			iName;
   1.104 +
   1.105 +	/** Plugin's own description obtained from 
   1.106 +	CCoreDumpFormatter->GetDescription()
   1.107 +	@see CCoreDumpFormatter */
   1.108 +	TBufC<KPluginDescriptionLength>	iDescription;
   1.109 +
   1.110 +	/** Plugin type : from TPluginRequest::TPluginType */
   1.111 +	TPluginRequest::TPluginType	iType;
   1.112 +
   1.113 +	/** Plugin loaded state. */
   1.114 +	TBool					iLoaded;
   1.115 +
   1.116 +	/** Reserved for future use
   1.117 +	@internalTechnology */
   1.118 +	TUint32 iSpare1;
   1.119 +
   1.120 +	/** @internalTechnology */
   1.121 +	TUint32 iSpare2;
   1.122 +};
   1.123 +
   1.124 +
   1.125 +/**
   1.126 +@publishedPartner 
   1.127 +@released
   1.128 +
   1.129 +List of TPluginInfo objects.
   1.130 +@see TPluginInfo
   1.131 +@see RArray
   1.132 +*/
   1.133 +typedef RArray<TPluginInfo>	RPluginList;
   1.134 +
   1.135 +
   1.136 +
   1.137 +#endif