1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/Example/ExampleResolver.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,140 @@
1.4 +// Copyright (c) 1997-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 "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.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 +//
1.18 +
1.19 +
1.20 +#ifndef __EXAMPLERESOLVER_H__
1.21 +#define __VRESOLVER_H__
1.22 +
1.23 +#include "Resolver.h"
1.24 +#include "RegistryData.h"
1.25 +
1.26 +class TEComResolverParams;
1.27 +
1.28 +/**
1.29 + @since 7.0
1.30 + Controls the identification, (resolution), of which implementation
1.31 + will be used to satisfy an interface implementation instantiation.
1.32 + */
1.33 +class CExampleResolver : public CResolver
1.34 +{
1.35 +public:
1.36 +/**
1.37 + @fn NewL(MPublicRegistry& aRegistry)
1.38 + Intended Usage : Standardized safe construction which leaves nothing
1.39 + on the cleanup stack.
1.40 + Error Condition : Cannot fully construct because of memory limitations.
1.41 + @leave KErrNoMemory
1.42 + @since 7.0
1.43 + @return A pointer to the new class
1.44 + @post CExampleResolver is fully constructed,
1.45 + and initialized.
1.46 + */
1.47 + static CExampleResolver* NewL(MPublicRegistry& aRegistry);
1.48 +
1.49 +/**
1.50 + @fn ~CExampleResolver()
1.51 + Intended Usage : Standard default d'tor
1.52 + Error Condition : None
1.53 + @since 7.0
1.54 + */
1.55 + ~CExampleResolver();
1.56 +
1.57 +/**
1.58 + @fn IdentifyImplementationL(TUid aInterfaceUid,
1.59 + const TEComResolverParams& aAdditionalParameters) const
1.60 + Intended Usage : Request that the resolver identify the most appropriate
1.61 + interface implementation.
1.62 + Error Condition :
1.63 + @since 7.0
1.64 + @param aInterfaceUid The interface for which implementations are requested
1.65 + @param aAdditionalParameters Data to be used to refine the search further
1.66 + @return The Uid of the best fit interface implementation - KNullUid if no match is found
1.67 + @pre Object is fully constructed and initialized
1.68 + @post Registry contents are not modified but registry keys may be updated
1.69 + */
1.70 + TUid IdentifyImplementationL(TUid aInterfaceUid, const TEComResolverParams& aAdditionalParameters) const;
1.71 +
1.72 +/**
1.73 + @fn ListAllL(TUid aInterfaceUid, const TEComResolverParams& aAdditionalParameters) const
1.74 + Intended Usage : List all the implementations which satisfy the specified interface.
1.75 + Error Condition :
1.76 + @since 7.0
1.77 + @param aInterfaceUid The interface for which implementations are requested
1.78 + @param aAdditionalParameters Data to be used to refine the search further
1.79 + @return Pointer to an array of suitable implementations. Ownership of this array
1.80 + is passed to the calling function.
1.81 + @pre Object is fully constructed and initialized
1.82 + @post Registry contents are not modified but registry keys may be updated
1.83 + */
1.84 + RImplInfoArray* ListAllL(TUid aInterfaceUid,
1.85 + const TEComResolverParams& aAdditionalParameters)const ;
1.86 +
1.87 +private:
1.88 +/**
1.89 + @internalComponent
1.90 + @fn CExampleResolver(MPublicRegistry& aRegistry)
1.91 + Intended Usage : Standardized default c'tor
1.92 + Error Condition : None
1.93 + @since 7.0
1.94 + @post CExampleResolver is fully constructed
1.95 + */
1.96 + explicit CExampleResolver(MPublicRegistry& aRegistry);
1.97 +
1.98 +/**
1.99 + @fn Resolve(const RImplInfoArray& aImplementationsInfo,
1.100 + const TEComResolverParams& aAdditionalParameters) const
1.101 + Intended Usage : Called by IdentifyImplementationL to select an appropriate
1.102 + implementation from a list of possibles
1.103 + @since 7.0
1.104 + @param aImplementationsInfo Information on the potential implementations
1.105 + @param aAdditionalParameters The data to match against to detemine the
1.106 + implementation
1.107 + @return The Uid of the selected implementation - KNullUid if no match is found
1.108 + @pre This object is fully constructed
1.109 + */
1.110 + TUid Resolve(const RImplInfoArray& aImplementationsInfo,
1.111 + const TEComResolverParams& aAdditionalParameters) const;
1.112 +
1.113 +/**
1.114 + @fn Match(const TDesC8& aImplementationType,
1.115 + const TDesC8& aMatchType,
1.116 + TBool aUseWildcards) const
1.117 + Intended Usage : Searches for a match of a data type on an implementation type.
1.118 + Match returns ETrue if aMatchType is found within aImplementationType according to
1.119 + the following rules:
1.120 + 1) aImplementationType is treated as a series of descriptors separated by double
1.121 + bars (||). ETrue is returned if aMatchType matches exactly any of the short
1.122 + descriptors. If no double bar is present then aImplementationType is treated as a
1.123 + single descriptor.
1.124 + 2) If aUseWildcards == ETrue then a '?' in aMatchType will be matched to any single
1.125 + character and '*' will be matched to any series of characters.
1.126 + @leave KErrNoMemory
1.127 + @since 7.0
1.128 + @param aImplementationType The implementation data type to search for a match
1.129 + @param aMatchType The data to search for
1.130 + @param aUseWildcards ETrue if wildcard matching should be allowed
1.131 + @return ETrue if a match was found, EFalse otherwise
1.132 + @pre This object is fully constructed
1.133 + */
1.134 + TBool Match(const TDesC8& aImplementationType,
1.135 + const TDesC8& aMatchType,
1.136 + TBool aUseWildcards) const;
1.137 +
1.138 +private:
1.139 + mutable RImplInfoArray* iImplementationInfoArray;
1.140 +};
1.141 +
1.142 +#endif // __EXAMPLERESOLVER_H__
1.143 +