1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/frame/Registrar.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,462 @@
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 +// Contains the definition of the CRegistrar class.
1.18 +//
1.19 +//
1.20 +
1.21 +/**
1.22 + @internalComponent
1.23 + @file
1.24 +*/
1.25 +
1.26 +#ifndef __REGISTRAR_H__
1.27 +#define __REGISTRAR_H__
1.28 +
1.29 +#include <f32file.h>
1.30 +#include <barsread2.h> // RResourceReader
1.31 +#include "DiscovererObserver.h"
1.32 +#include "BackupNotifierObserver.h"
1.33 +#include "RegistryData.h"
1.34 +#include "StartupStateObserver.h"
1.35 +#include "callback.h"
1.36 +class CDiscoverer;
1.37 +class CBackupNotifier;
1.38 +class MRegistrarObserver;
1.39 +class CEComCachedDriveInfo;
1.40 +
1.41 +/**
1.42 + @internalComponent
1.43 + @since 7.0
1.44 + Responsible for managing Interface Implementaion Collection registration
1.45 + (adding and removing entries).
1.46 + */
1.47 +
1.48 +class CRegistrar : public CBase, public MStartupStateObserver, private MDiscovererObserver, private MBackupNotifierObserver
1.49 +{
1.50 +public:
1.51 +
1.52 +/** State declaration for CRegistrar */
1.53 + enum TRegistrarState
1.54 + {
1.55 + /** Undefined state*/
1.56 + EReg_Undefined,
1.57 + /** Internalization/Externalization and Discovery in progress */
1.58 + EReg_StartupInProgess,
1.59 + /** Internalization/Externalization and Discovery complete */
1.60 + EReg_StartupComplete
1.61 + };
1.62 +
1.63 +/**
1.64 + @fn static CRegistrar* NewL(CRegistryData& aRegistry, MRegistrarObserver& aRegistrarObserver, RFs& aFs)
1.65 + Intended Usage : Standardised safe construction which leaves nothing
1.66 + on the cleanup stack.
1.67 + Error Condition : Cannot fully construct because of memory limitations.
1.68 + @leave KErrNoMemory
1.69 + @since 7.0
1.70 + @param aRegistry A reference to the registry data management class.
1.71 + @param aRegistrarObserver A reference to the registrar observer class.
1.72 + @param aFs A reference to an connected file server session.
1.73 + @return CRegistrar* A pointer to the new class
1.74 + @pre None
1.75 + @post CRegistrar is fully constructed,
1.76 + and initialised.
1.77 + */
1.78 +
1.79 + static CRegistrar* NewL(CRegistryData& aRegistry, MRegistrarObserver& aRegistrarObserver, RFs& aFs);
1.80 +
1.81 +/**
1.82 + @fn ~CRegistrar()
1.83 + Intended Usage : Standard default d'tor
1.84 + Error Condition : None
1.85 + @since 7.0
1.86 + @pre None
1.87 + @post CRegistrar is totally destroyed
1.88 + */
1.89 +
1.90 + ~CRegistrar();
1.91 +
1.92 +/**
1.93 + @fn Enable(TUid aImplementationUid)
1.94 + Intended Usage :Allow the specified Interface Implementation to be used.
1.95 + Error Condition : KErrEnableFailed The enable call failed.
1.96 + @since 7.0 :
1.97 + @param aImplementationUid The Interface Implementation to enable.
1.98 + @return KErrNone on success, KErrEnableFailed otherwise.
1.99 + @pre CRegistrar is fully constructed
1.100 + @post The interface implementation identified by
1.101 + the UID is made available for use.
1.102 + */
1.103 +
1.104 + TInt Enable(TUid aImplementationUid);
1.105 +
1.106 +/**
1.107 + @fn Disable(TUid aImplementationUid)
1.108 + Intended Usage :Stop the specified interface implementation
1.109 + from being used.
1.110 + Error Condition : KErrDisableFailed The disable call failed.
1.111 + @since 7.0 :
1.112 + @param aImplementationUid The Interface Implementation to disable.
1.113 + @return KErrNone on success, KErrDisableFailed otherwise.
1.114 + @pre CRegistrar is fully constructed
1.115 + @post The interface implementation identified by
1.116 + the UID is no longer available for use.
1.117 + */
1.118 +
1.119 + TInt Disable(TUid aImplementationUid);
1.120 +
1.121 +/**
1.122 + @fn Resume()
1.123 + Intended Usage : Overload of the MBackupNotifierObserver method.
1.124 + Allow registration of new Interface Implementation Collections
1.125 + to begin again.
1.126 + Error Condition : KErrResumeFailed The registration resume failed.
1.127 + @since 7.0 :
1.128 + @return KErrNone on success, KErrResumeFailed otherwise.
1.129 + @pre CRegistrar is fully constructed
1.130 + @post Registration suspension is cancelled.
1.131 + */
1.132 +
1.133 + TInt Resume();
1.134 +
1.135 +/**
1.136 + @fn Suspend()
1.137 + Intended Usage : Overload of the MBackupNotifierObserver method.
1.138 + Suspend registration of new Interface Implementation Collections.
1.139 + Error Condition : KErrSuspendFailed The registration suspension failed.
1.140 + @since 7.0 :
1.141 + @return KErrNone on success, KErrSuspendFailed otherwise.
1.142 + @pre CRegistrar is fully constructed
1.143 + @post Registration is suspended.
1.144 + */
1.145 +
1.146 + TInt Suspend();
1.147 +
1.148 +/**
1.149 + @fn ProcessSSAEventL()
1.150 + Intended Usage :Overload of MStartupStateObserver method.
1.151 + Used by CServerStratupMgr to notify the objects
1.152 + of the start-up state changes.
1.153 + @param aKnownState the startup state passing into the CRegistar.
1.154 + @pre CRegistrar is fully constructed.
1.155 + @post CRegistrar is notified of the start-up state changes.
1.156 +*/
1.157 + void ProcessSSAEventL(TStartupStateIdentifier aKnownState);
1.158 +
1.159 +/** Install a callback function to receive notification of SWI status
1.160 +changes. Note that the callback is passed along to CDsicoverer which
1.161 +does the SWI monitoring.
1.162 +@param aCallBack the callback function to install.
1.163 +*/
1.164 + void InstallSwiEventCallBack(const TCallBackWithArg& aCallBack);
1.165 +
1.166 +/** Install a callback function to receive notification of BUR status
1.167 +changes. Note that the callback is passed along to CDsicoverer which
1.168 +does the BUR monitoring.
1.169 +@param aCallBack the callback function to install.
1.170 +*/
1.171 + void InstallBurEventCallBack(const TCallBackWithArg& aCallBack);
1.172 +
1.173 +private:
1.174 +// MDiscovererObserver method implementations
1.175 +/**
1.176 + @fn DiscoveriesBegin()
1.177 + Intended Usage :Overload of the MDiscovererObserver callback method.
1.178 + The cue that a registry update is about to occur.
1.179 + Error Condition : None.
1.180 + @since 7.0 :
1.181 + @pre CRegistrar is fully constructed
1.182 + @post The Registry data manager has been informed that its internal
1.183 + data is out of date.
1.184 + */
1.185 +
1.186 + void DiscoveriesBegin();
1.187 +
1.188 +/**
1.189 + @fn RegisterDiscoveryL(const TDriveName& aDrive,CPluginBase*& aDirEntry,TBool aAnyDllDiscovered)
1.190 + Intended Usage :Overload of the MDiscovererObserver callback method.
1.191 + Adds the specified Interface Implementation Collection to the
1.192 + registry.
1.193 + Error Condition : Leaves with an error code.
1.194 + @leave KErrNoMemory, KErrRegistrationFailed.
1.195 + @since 9.1 :
1.196 + @param aDrive, the drive containing this entry
1.197 + @param aDirEntry The directory entry to register.
1.198 + @param aAnyDllDiscovered A flag to tell if any DLL is discovered in the drive.
1.199 + @pre CRegistrar is fully constructed
1.200 + @post The Interface Implementation Collection identified by the directory entry
1.201 + is registered.
1.202 + */
1.203 +
1.204 + void RegisterDiscoveryL(const TDriveName& aDrive,CPluginBase*& aDirEntry, TBool aAnyDllDiscovered);
1.205 +
1.206 +/**
1.207 + @fn UpdateRegistryL(TDriveUnit& driveUnit, TUid aDllUid, const TTime& aModified, TInt& aRegistryDriveIndex)
1.208 + Intended Usage :Checks if the Registry must be updated or not.
1.209 + Error Condition : Leaves with an error code.
1.210 + @leave KErrNoMemory, KErrRegistrationFailed.
1.211 + @since 9.0 :
1.212 + @param aDrive The drive the registry data has been found on
1.213 + @param aDllUid The interface implementation collection data to add.
1.214 + CRegistryData takes ownership of this object
1.215 + so it should not be on the CleanupStack.
1.216 + @param aModified The date of the last modification of the Interface
1.217 + Implementation Collection.
1.218 + @param aRegistryDriveIndex An output providing index within the registry data
1.219 + for the branch that the registry entry was found within.
1.220 + @return ETrue if the Interface Implementation Collection already has a registry entry and
1.221 + must be updated.
1.222 + EFalse otherwise.
1.223 + @pre CRegistrar is fully constructed
1.224 + @post No change to object..
1.225 + */
1.226 + TBool UpdateRegistryL(TDriveUnit& driveUnit, TUid aDllUid, const TTime& aModified, TInt& aRegistryDriveIndex);
1.227 +
1.228 +/**
1.229 + @fn DiscoveriesComplete(TBool aSuccessful,TPluginProcessingTypeIdentifier aProcessingType)
1.230 + Intended Usage :Overload of the MDiscovererObserver callback method.
1.231 + Error Condition : None.
1.232 + @since 7.0 :
1.233 + @param aSuccessful ETrue indicates the scan completed successfully,
1.234 + EFalse, that the scan was only partial.
1.235 + @param aProcessingType indicates the type of processing for plugins
1.236 + for ensuring that plugins are not processed multiple times
1.237 + during start-up phase
1.238 + @pre CRegistrar is fully constructed
1.239 + @post The current registry data and the
1.240 + internal access indexes have been rebuilt.
1.241 + */
1.242 +
1.243 + void DiscoveriesComplete(TBool aSuccessful, TPluginProcessingTypeIdentifier aProcessingType);
1.244 +/**
1.245 + @fn SetDiscoveryFlagL(const TDriveUnit aDrive)
1.246 + Intended Usage :Overload of the MDiscovererObserver callback method
1.247 + to notify the observer to find the drive has changed.
1.248 + Error Condition : None.
1.249 + @param aDrive The identifier of the drive changed.
1.250 + @pre The MDiscovererObserver must be fully constructed
1.251 + @post The flag is set.
1.252 +*/
1.253 + void SetDiscoveryFlagL(const TDriveUnit& aDriveUnit);
1.254 +/**
1.255 + @fn DriveRemovedL(TDriveUnit aDrive)
1.256 + Intended Usage :Overload of the MDiscovererObserver callback method.
1.257 + The cue to signal the registry that
1.258 + the registered Interface Implementation Collections
1.259 + stored upon the specified drive should no
1.260 + longer available for use.
1.261 + Error Condition : Leaves with an error code.
1.262 + @leave KErrNoMemory
1.263 + @since 7.0 :
1.264 + @param aDrive The drive identifier.
1.265 + @pre CRegistrar is fully constructed.
1.266 + @post The registered Interface Implementation Collections
1.267 + stored upon the specified drive are no
1.268 + longer available for use.
1.269 + */
1.270 +
1.271 + void DriveRemovedL(TDriveUnit aDrive);
1.272 +
1.273 +/**
1.274 + @fn DriveReinstatedL(TDriveUnit aDrive)
1.275 + Intended Usage :Overload of the MDiscovererObserver callback method.
1.276 + The cue to signal the registry that
1.277 + the registered Interface Implementation Collections
1.278 + stored upon the specified drive are again
1.279 + available for use.
1.280 + Error Condition : Leaves with an error code.
1.281 + @leave KErrNoMemory, KErrRegistrationFailed.
1.282 + @since 7.0 :
1.283 + @param aDrive The drive identifier.
1.284 + @pre CRegistrar is fully constructed.
1.285 + @post The registered Interface Implementation Collections
1.286 + stored upon the specified drive are again
1.287 + made available for use.
1.288 + */
1.289 +
1.290 + void DriveReinstatedL(TDriveUnit aDrive);
1.291 +
1.292 +/**
1.293 + @fn NotifiedWithErrorCode(TInt aError)
1.294 + Intended Usage :Overload of the MDiscovererObserver callback method.
1.295 + The notification that the notifier has been activated
1.296 + with an error status code. The observer should instruct
1.297 + the notification object how to proceed.
1.298 + Error Condition : None.
1.299 + @since 7.0 :
1.300 + @param aError The error value recieved by the notifier.
1.301 + @return ETrue for ignore error, EFalse otherwise.
1.302 + @pre CRegistrar is fully constructed.
1.303 + @post The status code should be used by the observer to instruct
1.304 + the notifier to cease recieving notifications or not.
1.305 + */
1.306 +
1.307 + TBool NotifiedWithErrorCode(TInt aError);
1.308 +
1.309 +/*
1.310 + @fn LanguageChangedL(TBool& aLanguageChanged)
1.311 + Intended Usage :Overload of the MDiscovererObserver callback method.
1.312 + It is used to notify the observer that the language switch notifier has been activated.
1.313 + The observer should instruct the notification object how to proceed.
1.314 + Error Condition : Leaves with an error code.
1.315 + @leave KErrNoMemory
1.316 + @since 9.3 :
1.317 + @param aLanguageChanged the flag returned to indicate whether language downgrade path is changed.
1.318 + @pre The MDiscovererObserver must be fully constructed, and
1.319 + capable of accepting discoveries for registration.
1.320 + @post The CRegistryData will have its iLanguageChanged
1.321 + flag set to True when language switch happens.
1.322 +
1.323 +*/
1.324 + void LanguageChangedL(TBool& aLanguageChanged);
1.325 +
1.326 +// Internal methods
1.327 +/**
1.328 + @internalComponent
1.329 + @fn CRegistrar(CRegistryData& aRegistry, MRegistrarObserver& aRegistrarObserver, RFs& aFs)
1.330 + Intended Usage : Standardised default c'tor
1.331 + Error Condition : None
1.332 + @since 7.0
1.333 + @param aRegistry A reference to the registry data management class.
1.334 + @param aRegistrarObserver A reference to the registrar observer class.
1.335 + @param aFs A reference to an connected file server session.
1.336 + @pre None
1.337 + @post CRegistrar is fully constructed
1.338 + */
1.339 +
1.340 + CRegistrar(CRegistryData& aRegistry, MRegistrarObserver& aRegistrarObserver, RFs& aFs);
1.341 +
1.342 +/**
1.343 + @fn void ConstructL()
1.344 + Intended Usage : Standardised 2nd, (Initialisation) phase of two phase construction.
1.345 + Error Condition : None
1.346 + @leave None
1.347 + @since 7.0
1.348 + @pre CRegistrar is fully constructed.
1.349 + @post CRegistrar is fully initialised.
1.350 + */
1.351 +
1.352 + void ConstructL();
1.353 +
1.354 +/**
1.355 + @fn ParseRegistrationDataL(CPluginBase*& aEntry,
1.356 + const TDriveUnit& aDrive,
1.357 + TBool aUpdate,
1.358 + TInt aRegistryDriveIndex)
1.359 + Intended Usage : To determine if the directory entry for an Interface Implementation
1.360 + Collection entry requires registration.
1.361 + Parsing the associated resource file information where necessary.
1.362 + Error Condition : Parsing fails due to a lack of memory, or a parsing error.
1.363 + @leave KErrNoMemory
1.364 + @since 9.1
1.365 + @param aEntry The directory entry data for the Interface Impplementation Collection.
1.366 + @param aDrive The drive the registry data has been found on
1.367 + @param aUpdate A flag indicating if this is an update, or new entry.
1.368 + @param aRegistryDriveIndex The index within the registry data
1.369 + for the branch that the registry entry was found within.
1.370 + @param aDriveData Output value, which delivers the CDriveData object, needed for the
1.371 + CDllData object construction.
1.372 + @pre CRegistrar is fully constructed.
1.373 + @post The Interface Implementation Collection entry has been processed appropriately.
1.374 +*/
1.375 +
1.376 + void ParseRegistrationDataL(CPluginBase*& aEntry,
1.377 + const TDriveUnit& aDrive,
1.378 + TBool aUpdate,
1.379 + TInt aRegistryDriveIndex,
1.380 + CRegistryData::CDriveData* aDriveData);
1.381 +
1.382 +/**
1.383 + @fn ParseL(CPluginBase*& aEntry, CRegistryData::CDllData& aDll)
1.384 + Intended Usage : Parsing the resource file information associated with an
1.385 + Interface Implementation Collection for entry into the registry
1.386 + information.
1.387 + Error Condition : Parsing fails due to a lack of memory, or a parsing error.
1.388 + @leave KErrNoMemory
1.389 + @since 9.1
1.390 + @param aEntry The directory entry data for the Interface Impplementation Collection.
1.391 + @param aDll The CDllData information to fill
1.392 + @pre CRegistrar is fully constructed.
1.393 + @post The resource file has been parsed and the data added to 'aDll'.
1.394 + */
1.395 +
1.396 + void ParseL(CPluginBase*& aEntry,CRegistryData::CDllData& aDll);
1.397 +/**
1.398 + Intended Usage : Get resource format version from the resource file
1.399 + @param aReader The resource file reader.
1.400 + @param aResourceFormatVersion The resource file format version
1.401 + @pre CRegistrar is fully constructed.
1.402 + */
1.403 + void GetResourceFormatVersionL(RResourceReader& aReader, TInt& aResourceFormatVersion);
1.404 +/**
1.405 + @fn State()
1.406 + Intended Usage :Retrieve the object's current state.
1.407 + @return TCRegistarState the CRegistrar's current state.
1.408 + @pre CRegistrar is fully constructed.
1.409 + @post the CRegistrar's current state has been returned.
1.410 +*/
1.411 + TRegistrarState State() const;
1.412 +
1.413 +/**
1.414 + @fn InitialiseEvent()
1.415 + Intended Usage : change the state during the CRegistrar's construction.
1.416 + @post : state is changed to EReg_StartupInProgess.
1.417 +*/
1.418 + void InitialiseEvent();
1.419 +
1.420 +/**
1.421 + @fn IsAnyDllRegisteredWithDriveL(const TDriveUnit aDrive)
1.422 + Intended Usage Find if any Dll is registered in the drive unit.
1.423 + @param aDrive the identifier of the drive to find if any Dll is registered.
1.424 + @return ETrue if any Dll is registered in the drive, otherwise EFalse.
1.425 + @pre CRegistrar is fully constructed.
1.426 + @post If any Dll registered in the drive is returned.
1.427 +*/
1.428 + TBool IsAnyDllRegisteredWithDriveL(const TDriveUnit aDrive) const;
1.429 +
1.430 +
1.431 +
1.432 +//Attributes
1.433 +private:
1.434 +
1.435 + /** The reference to the registry data manager class */
1.436 +
1.437 + CRegistryData& iRegistry;
1.438 + /** The owned discovery notification handling class */
1.439 +
1.440 + CDiscoverer* iDiscoverer;
1.441 + /** The owned backup/restore notification handling class */
1.442 +
1.443 + CBackupNotifier* iBackupNotifier;
1.444 + /**
1.445 + The reference to the observer of the
1.446 + Registrar for change notification.
1.447 + */
1.448 +
1.449 + MRegistrarObserver& iRegistrarObserver;
1.450 + /** A reference to a conncted file session */
1.451 +
1.452 + RFs& iFs;
1.453 +
1.454 + /** The current state of this object */
1.455 + TRegistrarState iState;
1.456 +
1.457 + /** cached info on drivelist */
1.458 + CEComCachedDriveInfo* iCachedDriveInfo;
1.459 +
1.460 + // Declare the test accessor as a friend
1.461 + friend class TRegistrar_StateAccessor;
1.462 +};
1.463 +
1.464 +#endif /* __REGISTRAR_H__ */
1.465 +