// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// apgcli.cpp

//

#include "../apserv/APSCLSV.H"

#include "../apserv/apsserv.h"

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#if !defined(__APA_INTERNAL_H__)

#include "apainternal.h"

#endif

#if !defined(__APGICNFL_PARTNER_H__)

#include "apgicnflpartner.h"

#endif

#endif //SYMBIAN_ENABLE_SPLIT_HEADERS

#include "APGCLI.H"

#include "APGSTD.H"

#include "APGICNFL.H"

#include "APGPRIV.H"

#include "apprivate.h"

const TUint KInitialIconBufSize = sizeof(TSize)*6 + sizeof(TInt);

const TUint KInitialViewDataBufSize = sizeof(TApaAppViewInfo)*6 + sizeof(TInt);

const TUint KInitialOwnedFilesBufSize = sizeof(TFileName)*6 + sizeof(TInt);

const TUint KDefaultBufSize = 0x400;

const TUint KAsyncMessageSlots = 4; // One slot each for, RApaLsSession::SetNotify, RApaLsSession::

                                    // RegisterListPopulationCompleteObserver and RApaLsSession::NotifyOnDataMappingChange

                                    // CAsyncFileRecognition::Start makes an asynch request of apparc server.

extern void CleanupAppServiceArray(TAny* aServiceArray);

IMPORT_C extern const TInt KMinApplicationStackSize;

/** 

@internalComponent

*/

class MArrayFiller

	{

public:

	virtual void AppendItemFromStreamL(RReadStream& aReadStream) = 0;

	};

/** 

@internalComponent

*/

NONSHARABLE_CLASS(TSizeArrayFiller) : public MArrayFiller

	{

public:

	inline TSizeArrayFiller(CArrayFixFlat<TSize>& aArray) : iArray(aArray) {}

public: // from MArrayFiller

	void AppendItemFromStreamL(RReadStream& aReadStream);

private:

	CArrayFixFlat<TSize>& iArray;

	};

/** 

@internalComponent

*/

NONSHARABLE_CLASS(TViewDataArrayFiller) : public MArrayFiller

	{

public:

	inline TViewDataArrayFiller(CApaAppViewArray& aArray) : iArray(aArray) {}

public: // from MArrayFiller

	void AppendItemFromStreamL(RReadStream& aReadStream);

private:

	CApaAppViewArray& iArray;

	};

/** 

@internalComponent

*/

NONSHARABLE_CLASS(TDesCArrayFiller) : public MArrayFiller

	{

public:

	inline TDesCArrayFiller(CDesCArray& aArray) : iArray(aArray) {}

public: // from MArrayFiller

	void AppendItemFromStreamL(RReadStream& aReadStream);

private:

	CDesCArray& iArray;

	};

// TSizeArrayFiller

void TSizeArrayFiller::AppendItemFromStreamL(RReadStream& aReadStream)

	{

	TSize size;

	size.iWidth = aReadStream.ReadUint32L();

	size.iHeight= aReadStream.ReadUint32L();

	iArray.AppendL(size);

	}

// TViewDataArrayFiller

void TViewDataArrayFiller::AppendItemFromStreamL(RReadStream& aReadStream)

	{

	TApaAppViewInfo info;

	aReadStream >> info;

	iArray.AppendL(info);

	}

// TDesCArrayFiller

void TDesCArrayFiller::AppendItemFromStreamL(RReadStream& aReadStream)

	{

	TFileName info;

	aReadStream >> info;

	iArray.AppendL(info);

	}

/** 

@internalComponent

*/

EXPORT_C TUint MinApplicationStackSize()

	{

	return KMinApplicationStackSize;

	}

//

// class RApaLsSession

//

EXPORT_C RApaLsSession::RApaLsSession()

	: iExtension(NULL)

	{}

/** Connects a client to the application architecture server, creating a session 

with it.

@return KErrNone if successful; otherwise, one of the system-wide error codes. 

*/

EXPORT_C TInt RApaLsSession::Connect()

	{

	TInt r=CreateSession(KAppListServerName,Version(),KAsyncMessageSlots);

	return(r); 

	}

EXPORT_C void RApaLsSession::Close()

/** 

Closes the session. Needs to be called to avoid memory leaks.

@publishedAll

@released

*/

	{

	CancelRecognizeFiles();

	RHandleBase::Close();

	}

/** Gets the version of the application architecture server.

@return The version number. 

*/

EXPORT_C TVersion RApaLsSession::Version(void) const

	{

	return(TVersion(KAppListServMajorVersionNumber,KAppListServMinorVersionNumber,KAppListServBuildVersionNumber));

	}

/** Gets the total number of applications.

Control panel applications are excluded.

@param aCount On return, the total number of applications.

@return KErrNone if successful, otherwise one of the system-wide error codes. 

*/

EXPORT_C TInt RApaLsSession::AppCount(TInt& aCount) const

	{

	return DoAppCount(aCount, EAppListServAppCount);

	}

/** Gets the total number of embeddable applications.

Control panel applications are excluded.

@param aCount On return, the total number of embeddable applications.

@return KErrNone, if successful, otherwise one of the system-wide error codes. 

*/

EXPORT_C TInt RApaLsSession::EmbeddableAppCount(TInt& aCount) const

	{

	return DoAppCount(aCount, EAppListServEmbedCount);

	}

TInt RApaLsSession::DoAppCount(TInt& aCount,TInt aCommand) const

// returns the number of embeddable apps in the server side list

	{

	__ASSERT_DEBUG(aCommand==EAppListServEmbedCount || aCommand==EAppListServAppCount,Panic(EDPanicWrongCommand));

	const TInt returnValue = SendReceiveWithReconnect(aCommand,TIpcArgs());

	if (returnValue < 0)

		return returnValue;

	aCount = returnValue;

	return KErrNone;

	}

/** Initialises the process of getting all applications in the cached list.

Control panel applications are excluded.

A call to this function is followed by subsequent and repeated calls to GetNextApp() 

to retrieve all applications in the cached list.

@return KErrNone, if successful, otherwise one of the system-wide error codes. 

*/

EXPORT_C TInt RApaLsSession::GetAllApps() const

	{

	return GetAllApps(0);

	}

/** Initialises the process of getting all applications in the cached list.

Control panel applications are excluded.

A call to this function is followed by subsequent and repeated calls to GetNextApp() 

to retrieve all applications supporting aScreenMode in the cached list.

@param aScreenMode Only applications which define a view supporting aScreenMode

will be returned by subsequent calls to GetNextApp(). If an application does not

define views in it's application information file, only screen mode 0 is supported.

@return KErrNone, if successful, otherwise one of the system-wide error codes. 

*/

EXPORT_C TInt RApaLsSession::GetAllApps(TInt aScreenMode) const

	{

	return GetFilteredApps(TApaAppCapability::EControlPanelItem, 0, aScreenMode); // exclude control panel apps

	}

/** Initialises the process of getting all embeddable applications from the cached list.

Control panel applications are excluded.

A call to this function is followed by subsequent and repeated calls to GetNextApp() 

to retrieve embeddable applications in the cached list.

Only applications which specify KAppEmbeddable or KAppEmbeddableOnly in their

application information file will be returned by subsequent calls to GetNextApp().

@return KErrNone, if successful, otherwise one of the system-wide error codes. 

*/

EXPORT_C TInt RApaLsSession::GetEmbeddableApps() const

	{

	return GetEmbeddableApps(0);

	}

/** Initialises the process of getting embeddable applications from the cached list

that support the specified screen mode.

Control panel applications are excluded.

A call to this function is followed by subsequent and repeated calls to GetNextApp() 

to retrieve embeddable applications in the cached list.

Only applications which specify KAppEmbeddable or KAppEmbeddableOnly in their

application information file will be returned by subsequent calls to GetNextApp().

@param aScreenMode Only embeddable applications which define a view supporting

aScreenMode will be returned by subsequent calls to GetNextApp(). If an application

does not define views in it's application information file, only screen mode 0 is supported.

@return KErrNone, if successful, otherwise one of the system-wide error codes. 

*/

EXPORT_C TInt RApaLsSession::GetEmbeddableApps(TInt aScreenMode) const

	{

	TApaEmbeddabilityFilter filter;

	filter.AddEmbeddability(TApaAppCapability::EEmbeddable);

	filter.AddEmbeddability(TApaAppCapability::EEmbeddableOnly);

	return GetFilteredApps(filter, aScreenMode);

	}

/** Initialises the process of getting all applications matching aFilter in the

cached list.

Control panel applications are excluded.

A call to this function is followed by subsequent and repeated calls to GetNextApp() 

to retrieve all applications matching aFilter in the cached list.

@param aFilter Defines the filter to be applied to the cached list.

@return KErrNone, if successful, otherwise one of the system-wide error codes. 

*/

EXPORT_C TInt RApaLsSession::GetFilteredApps(const TApaEmbeddabilityFilter& aFilter) const

	{

	return GetFilteredApps(aFilter, 0);

	}

/** Initialises the process of getting all applications matching aFilter in the

cached list.

Control panel applications are excluded.

A call to this function is followed by subsequent and repeated calls to GetNextApp() 

to retrieve all applications matching aFilter in the cached list.

@param aFilter Defines the filter to be applied to the cached list.

@param aScreenMode Only applications which define a view supporting aScreenMode

will be returned by subsequent calls to GetNextApp(). If an application does not

define views in it's application information file, only screen mode 0 is supported.

@return KErrNone, if successful, otherwise one of the system-wide error codes. 

*/

EXPORT_C TInt RApaLsSession::GetFilteredApps(const TApaEmbeddabilityFilter& aFilter, TInt aScreenMode) const

	{

	const TPckgC<TApaEmbeddabilityFilter> filter(aFilter);

	return SendReceiveWithReconnect(EAppListServInitFilteredEmbedList,TIpcArgs(aScreenMode,&filter));

	}

/** Initialises the process of getting all applications matching the specified

application attributes.

A call to this function is followed by subsequent and repeated calls to GetNextApp() 

to retrieve all applications matching the filter in the cached list.

Attributes are defined by TApaAppCapability::TCapabilityAttribute

@param aCapabilityAttributeMask Specifies the attributes whose values will be

used to filter the cached list. If the mask specifies more than one attribute,

all associated attribute values must match.

@param aCapabilityAttributeValue Specifies the attribute values for each attribute

identified by the mask.

@return KErrNone, if successful, otherwise one of the system-wide error codes.

@see TCapabilityAttribute 

*/

EXPORT_C TInt RApaLsSession::GetFilteredApps(TUint aCapabilityAttributeMask, TUint aCapabilityAttributeValue) const

	{

	return GetFilteredApps(aCapabilityAttributeMask, aCapabilityAttributeValue, 0);

	}

/** Initialises the process of getting all applications matching the specified

application attributes.

A call to this function is followed by subsequent and repeated calls to GetNextApp() 

to retrieve all applications matching the filter in the cached list.

Attributes are defined by TApaAppCapability::TCapabilityAttribute

@param aCapabilityAttributeMask Specifies the attributes whose values will be

used to filter the cached list. If the mask specifies more than one attribute,

all associated attribute values must match.

@param aCapabilityAttributeValue Specifies the attribute values for each attribute

identified by the mask.

@param aScreenMode Only applications which define a view supporting aScreenMode

will be returned by subsequent calls to GetNextApp(). If an application does not

define views in it's application information file, only screen mode 0 is supported.

@return KErrNone, if successful, otherwise one of the system-wide error codes.

@see TCapabilityAttribute 

*/

EXPORT_C TInt RApaLsSession::GetFilteredApps(TUint aCapabilityAttributeMask, TUint aCapabilityAttributeValue, TInt aScreenMode) const

	{

	return SendReceiveWithReconnect(EAppListServInitAttrFilteredList,TIpcArgs(aScreenMode, aCapabilityAttributeMask, aCapabilityAttributeValue));

	}

/** Initialises the process of getting server applications in the cached list.

Control panel applications are excluded.

A call to this function is followed by subsequent and repeated calls to GetNextApp() 

to retrieve server applications in the cached list.

Only applications which specify one or more services in their application

information file will be returned by subsequent calls to GetNextApp().

@return KErrNone, if successful, otherwise one of the system-wide error codes.

@publishedPartner

@released

*/

EXPORT_C TInt RApaLsSession::GetServerApps(TUid aServiceUid) const

	{

	return GetServerApps(aServiceUid, 0);

	}

/** Initialises the process of getting server applications in the cached list.

Control panel applications are excluded.

A call to this function is followed by subsequent and repeated calls to GetNextApp() 

to retrieve server applications in the cached list.

Only applications which specify one or more services in their application

information file will be returned by subsequent calls to GetNextApp().

@param aScreenMode Only server applications which define a view supporting

aScreenMode will be returned by subsequent calls to GetNextApp(). If an application

does not define views in its application information file, only screen mode 0 is supported.

@return KErrNone, if successful, otherwise one of the system-wide error codes.

@publishedPartner

@released

*/

EXPORT_C TInt RApaLsSession::GetServerApps(TUid aServiceUid, TInt aScreenMode) const

	{

	return SendReceiveWithReconnect(EAppListServInitServerAppList,TIpcArgs(aScreenMode, aServiceUid.iUid));

	}

/** Gets information about the next application or embeddable application from 

the cached list.

A sequence of calls to this function must always be preceded by a call to 

one of GetAllApps(), GetEmbeddableApps() or GetFilteredApps().

@param aInfo On return, contains application information.

@return KErrNone if successful; ENoMoreAppsInList, if there are no more applications 

in the list; EAppListInvalid if the server's initial population of the list has

not completed; otherwise one of the other system wide error codes. 

*/

EXPORT_C TInt RApaLsSession::GetNextApp(TApaAppInfo& aInfo) const

	{

	return GetNextApp(aInfo,0);

	}

/** Gets information about the next application or embeddable application from 

the cached list.

A sequence of calls to this function must always be preceded by a call to 

one of GetAllApps(), GetEmbeddableApps() or GetFilteredApps().

@param aInfo On return, contains application information.

@param aScreenMode This parameter is ignored.

@return KErrNone if successful; ENoMoreAppsInList, if there are no more applications 

in the list; EAppListInvalid if the server's initial population of the list has

not completed; otherwise one of the other system wide error codes. 

*/

EXPORT_C TInt RApaLsSession::GetNextApp(TApaAppInfo& aInfo,TInt aScreenMode) const

	{

	TPckg<TApaAppInfo> info(aInfo);

	TInt err = SendReceiveWithReconnect(EAppListServGetNextApp, TIpcArgs(aScreenMode,&info));

	if (!err)

		aInfo = info();

	else if (err==KErrNotFound)

		err = ENoMoreAppsInList;

	else if (err==KErrCorrupt)

		err = EAppListInvalid;

	return err;

	}

/** Gets information about the application with the specified UID.

@param aInfo On return, contains the application information, if an application 

with the specified UID is found. If no matching application is found, then 

this object is not changed.

@param aAppUid The application specific UID.

@return KErrNone if successful; KErrNotFound if a matching entry could not be found; 

otherwise one of the other system wide error codes. 

*/

EXPORT_C TInt RApaLsSession::GetAppInfo(TApaAppInfo& aInfo, TUid aAppUid) const

	{

	TPckg<TApaAppInfo> info(aInfo);

	return SendReceiveWithReconnect(EAppListServGetAppInfo, TIpcArgs(aAppUid.iUid,&info));

	} //lint !e1764 Suppress reference parameter 'aInfo' could be declared const ref

/** Sets the short caption of the application.

Overrides the short caption specified in the localizable resource file for this application.

Short captions set using this API will only take effect until the next device reset.

@param aShortCaption The short caption of the application. The maximum length allowed is KApaMaxAppCaption.

@param aLanguage The language corresponding to the caption. If this is ELangNone the caption is used

for all languages for which a language specific short caption has not been set.

@param aAppUid The uid of the application.

@return KErrNone if successful, otherwise one of the system wide error codes.

*/ 

EXPORT_C TInt RApaLsSession::SetAppShortCaption(const TDesC& aShortCaption, TLanguage aLanguage, TUid aAppUid)

	{

	if (aShortCaption.Length() > KApaMaxAppCaption || aShortCaption.Length() == 0)

		return KErrArgument;

	return SendReceiveWithReconnect(EAppListServSetAppShortCaption, TIpcArgs(aAppUid.iUid, &aShortCaption, aLanguage));

	} //lint !e1762 Suppress member function could be made const

/** Gets the default screen-number of the application with the specified UID.

@param aDefaultScreenNumber On return, contains the default screen-number, if an application 

with the specified UID is found. If no matching application is found, then 

this object is not changed.

@param aAppUid The application specific UID.

@return KErrNone if successful; KErrNotFound if a matching entry could not be found; 

otherwise one of the other system wide error codes. 

*/

EXPORT_C TInt RApaLsSession::GetDefaultScreenNumber(TInt& aDefaultScreenNumber, TUid aAppUid) const

	{

	const TInt result = SendReceiveWithReconnect(EAppListServGetDefaultScreenNumber, TIpcArgs(aAppUid.iUid));

	if (result < 0)

		return result;

	aDefaultScreenNumber = result;

	return KErrNone;

	}

/** Gets the capabilities of the application with the specified UID.

@param aCapabilityBuf A modifiable descriptor that, on return, contains the 

application's capability information. The data returned in the descriptor 

is mapped by the TApaAppCapability class. If no matching application is found, 

then the content of this descriptor is not changed.

@param aAppUid The application specific UID.