epoc32/include/xml/matchdata.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// Detailed parser information for resolution criteria in XML framework
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
/**
williamr@2
    19
 @file 
williamr@2
    20
 @publishedAll
williamr@2
    21
 @released
williamr@2
    22
*/
williamr@2
    23
williamr@2
    24
williamr@2
    25
#ifndef MATCHDATA_H
williamr@2
    26
#define MATCHDATA_H
williamr@2
    27
williamr@2
    28
#include <e32base.h>
williamr@2
    29
#include <s32strm.h>
williamr@2
    30
#include <s32mem.h>
williamr@2
    31
#include <ecom/implementationinformation.h>
williamr@2
    32
williamr@2
    33
namespace Xml
williamr@2
    34
{
williamr@2
    35
williamr@2
    36
/**
williamr@2
    37
The plugin variant string of the default Symbian-provided XML parser plugins.
williamr@2
    38
@publishedAll
williamr@2
    39
@released
williamr@2
    40
*/
williamr@2
    41
_LIT8(KXmlSymbianPluginVariant, "Symbian");		
williamr@2
    42
williamr@2
    43
/**
williamr@2
    44
CMatchData class provides detailed parser information for XML framework.
williamr@2
    45
Client application should use this class to precisely specify the plugin, 
williamr@2
    46
which should be used as a parsing engine in XML framework.
williamr@2
    47
williamr@2
    48
@publishedAll
williamr@2
    49
@released
williamr@2
    50
*/
williamr@2
    51
williamr@2
    52
NONSHARABLE_CLASS(CMatchData) : public CBase
williamr@2
    53
{
williamr@2
    54
williamr@2
    55
public:
williamr@2
    56
	CMatchData();
williamr@2
    57
	~CMatchData();
williamr@2
    58
	
williamr@2
    59
	IMPORT_C static CMatchData* NewL();
williamr@2
    60
	IMPORT_C static CMatchData* NewL(const TDesC8& aPackage);
williamr@2
    61
	IMPORT_C static CMatchData* NewLC();
williamr@2
    62
	IMPORT_C static CMatchData* NewLC(const TDesC8& aPackage);
williamr@2
    63
williamr@2
    64
	IMPORT_C void SetMimeTypeL(const TDesC8& aData);
williamr@2
    65
	IMPORT_C const TPtrC8 MimeType() const;
williamr@2
    66
williamr@2
    67
	IMPORT_C void SetVariantL(const TDesC8& aVariant);
williamr@2
    68
	IMPORT_C const TPtrC8 Variant() const;
williamr@2
    69
	
williamr@2
    70
	IMPORT_C void SetLeaveOnMany(TBool aSetting);
williamr@2
    71
	IMPORT_C void SetRomOnly(TBool aSetting);
williamr@2
    72
	IMPORT_C void SetCaseSensitivity(TBool aSetting);
williamr@2
    73
	
williamr@2
    74
	IMPORT_C TUid ResolveL(RImplInfoArray& aImplList) const;
williamr@2
    75
williamr@2
    76
public:
williamr@2
    77
	CMatchData& operator=(const CMatchData & aMatchData);
williamr@2
    78
	TBool operator==(const CMatchData & aMatchData) const;
williamr@2
    79
	HBufC8* PackToBufferL() const;
williamr@2
    80
williamr@2
    81
private:
williamr@2
    82
	void ConstructL(const TDesC8& aPackage);
williamr@2
    83
	
williamr@2
    84
	TBool VariantMatch(const TDesC8& aOpaqueField) const;
williamr@2
    85
	TBool MimeTypeMatch(const TDesC8& aDataField) const;
williamr@2
    86
	TBool MatchField(const TDesC8& aField, const TDesC8& aMatchString, const TDesC8& aSeparator) const;
williamr@2
    87
	
williamr@2
    88
	TBool CaseSensitivity() const;
williamr@2
    89
	TBool LeaveOnMany() const;
williamr@2
    90
	TBool RomOnly() const;
williamr@2
    91
	
williamr@2
    92
	void ExternalizeL(RWriteStream& aStream) const;
williamr@2
    93
	void InternalizeL(RReadStream& aStream);		
williamr@2
    94
williamr@2
    95
	TUid SelectSingleParserL(RImplInfoPtrArray& aImplList) const;
williamr@2
    96
	TBool IsInvalidVariant() const;
williamr@2
    97
	
williamr@2
    98
	static TInt SortOrder(const CImplementationInformation &aImpInfo1, 
williamr@2
    99
							const CImplementationInformation &aImpInfo2);
williamr@2
   100
private:
williamr@2
   101
	/** 
williamr@2
   102
	Mime type requested by client
williamr@2
   103
	Is matched against one of entries of data_type field in resoure information file
williamr@2
   104
	*/
williamr@2
   105
	HBufC8* iMimeType; 
williamr@2
   106
	
williamr@2
   107
	/**
williamr@2
   108
	Variant requested by client
williamr@2
   109
	Is matched against first entry in opaque_data field of resource information file
williamr@2
   110
	*/
williamr@2
   111
	HBufC8* iVariant;
williamr@2
   112
	
williamr@2
   113
	/**
williamr@2
   114
	Additional information for resolution constrains. Bitmap.
williamr@2
   115
	*/
williamr@2
   116
	TUint32 iAddInfo;
williamr@2
   117
};
williamr@2
   118
williamr@2
   119
}
williamr@2
   120
#endif // MATCHDATA_H
williamr@4
   121
williamr@4
   122