// 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:

// apacmdln.cpp

//

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#if !defined(__APA_INTERNAL_H__)

#include "apainternal.h"

#endif

#endif //SYMBIAN_ENABLE_SPLIT_HEADERS

#include <apacmdln.h>

#include "APASTD.H" // Panics etc.

#include <s32mem.h>

#include <e32svr.h>

// comand line tokens

const TUint KApaCommandLetterOpen='O';

const TUint KApaCommandLetterCreate='C';

const TUint KApaCommandLetterRun='R';

const TUint KApaCommandLetterBackground='B';

const TUint KApaCommandLetterViewActivate='V';

const TUint KApaCommandLetterRunWithoutViews='W';

const TUint KApaCommandLetterBackgroundAndWithoutViews='A';

_LIT(KLitTokenServerDifferentiator, "-srvDfr=");

_LIT(KLitTokenDefaultScreenNumber, "-dsc=");

_LIT(KLitTokenParentWindowGroupID, "-prntwgid=");

_LIT(KLitTokenDebugMemFail, "-debugMemFail:");

_LIT(KLitTokenAppStartupInstrumentationEventIdBase, "-appStartupInstrEvIdBase=");

_LIT(KLitTokenOpaqueData, "-opaque=");

enum TProcessEnvironmentSots 

	{

	EEnvironmentSlotUnused = 0,

	EEnvironmentSlotMain = 1,

	EEnvironmentSlotFsSession = 2,

	EEnvironmentSlotFile = 3,

	EFirstEnvironmentSlotForPublicUse = 8,

	ENumberOfEnvironmentSlotsForPublicUse = 4

	};

enum TIpcMessageSlots

	{

	EIpcSlotMain = 0,

	EIpcSlotFsSession = 1,

	EIpcSlotFile = 2

	};

// CApaCommandLine

/** Private c'tor - initialize using NewLC()

@internalTechnology */

CApaCommandLine::CApaCommandLine() : 

	iCommand(EApaCommandRun), iServerDifferentiator(0), iDefaultScreenNumber(KErrNotFound),

	iParentWindowGroupID(0), iDebugMemFail(0), iAppStartupInstrumentationEventIdBase(0),

	iFile(), iParentProcessId(KNullProcessId)

	{

	}

/** Destructor.

Frees resources owned by the object prior to deletion. */

EXPORT_C CApaCommandLine::~CApaCommandLine()

	{

	iDocumentName.Close();

	iExecutableName.Close();

	iOpaqueData.Close();

	iTailEnd.Close();

	iFile.Close();

	}

/** Creates an empty command line object.

@return A pointer to the new command line object. */

EXPORT_C CApaCommandLine* CApaCommandLine::NewL()

	{

	CApaCommandLine* self = CApaCommandLine::NewLC();

	CleanupStack::Pop();

	return self;

	}

/** Creates an empty command line object, and puts a pointer to it onto the cleanup stack.

@return A pointer to the new command line object. */

EXPORT_C CApaCommandLine* CApaCommandLine::NewLC()

	{

	CApaCommandLine* self = new(ELeave) CApaCommandLine;

	CleanupStack::PushL(self);

	return self;

	}

EXPORT_C void CApaCommandLine::SetDocumentNameL(const TDesC& aDocName)

/** Sets the document name from the specified descriptor.

If the document name has embedded spaces, then it must be enclosed within 

quotation marks.

@param aDocName A descriptor containing the document name. */

	{

	RBuf documentName;

	documentName.CreateL(aDocName);

	iDocumentName.Close();	// free any existing memory

	iDocumentName.Assign(documentName);	

	}

/** Gets the document name from the launch information.

@return A pointer descriptor representing the document name. The document 

name is returned without any enclosing quotation marks. If the launch information 

contains no document name, then the pointer descriptor has zero length. */

EXPORT_C TPtrC CApaCommandLine::DocumentName() const

	{

	return iDocumentName;

	}

/** Sets the executable name from the specified descriptor.

@param aExecutableName A descriptor containing the executable name. */

EXPORT_C void CApaCommandLine::SetExecutableNameL(const TDesC& aExecutableName)

	{

	RBuf executableName;

	executableName.CreateL(aExecutableName);

	iExecutableName.Close();	// free any existing memory

	iExecutableName.Assign(executableName);

	}

/** Gets the executable name from the launch information.

@return A pointer descriptor representing the executable name. */

EXPORT_C TPtrC CApaCommandLine::ExecutableName() const

	{

	return iExecutableName;

	}

/** Sets the opaque-data from the specified 8-bit descriptor.

This is called internally and populated from the data in the application's registration resource file, 

i.e. from the resource indicated by the opaque_data field of the APP_REGISTRATION_INFO resource (if the 

opaque_data field was non-zero).

@param aOpaqueData An 8-bit descriptor containing the opaque-data. 

*/

EXPORT_C void CApaCommandLine::SetOpaqueDataL(const TDesC8& aOpaqueData)

	{

	RBuf8 opaqueData;

	opaqueData.CreateL(aOpaqueData);

	iOpaqueData.Close();	// free any existing memory

	iOpaqueData.Assign(opaqueData);

	}

/** Gets the opaque-data from the launch information.

See the description of SetOpaqueDataL. By default, this attribute is an empty descriptor.

@see SetOpaqueDataL

@return An 8-bit pointer descriptor representing the opaque-data. 

*/

EXPORT_C TPtrC8 CApaCommandLine::OpaqueData() const

	{

	return iOpaqueData;

	}

/** Sets the command code.

The command code is used to indicate how an application is to be launched.

@see TApaCommand

@param aCommand The command code. */

EXPORT_C void CApaCommandLine::SetCommandL(TApaCommand aCommand)

	{

	iCommand = aCommand;

	}

/** Gets the command code from the launch information.

See the description of SetCommandL.

@see SetCommandL

@see TApaCommand

@return The command code. */

EXPORT_C TApaCommand CApaCommandLine::Command() const

	{

	return iCommand;

	}

/** Sets the trailing data.

The UI Framework provides a specific set of pre-defined command line 

options. Additional user defined or pre-defined command line options, 

may be passed to an application by setting the TailEnd.

@param aTailEnd An 8 bit descriptor containing the trailing data. 

@publishedAll */

EXPORT_C void CApaCommandLine::SetTailEndL(const TDesC8& aTailEnd)

	{

	RBuf8 tailEnd;

	tailEnd.CreateL(aTailEnd);

	iTailEnd.Close();	// free any existing memory

	iTailEnd.Assign(tailEnd);

	}

/** Gets the trailing data from the launch information.

See the description of SetTailEndL.

@see SetTailEndL

@return A pointer descriptor representing the trailing data. If the launch 

information contains no trailing data, then the pointer descriptor has zero 

length. 

@publishedAll */

EXPORT_C TPtrC8 CApaCommandLine::TailEnd() const

	{

	return iTailEnd;

	}

/** Sets the file to be passed into the application (by handle). 

This will then be retrieved by that application-process calling GetFileByHandleL().

@publishedPartner

@released

@param aFile The file object to be passed into the application. No transfer of this 

object's ownership takes place in this function. */

EXPORT_C void CApaCommandLine::SetFileByHandleL(const RFile& aFile)

	{

	__ASSERT_ALWAYS(aFile.SubSessionHandle() != KNullHandle, Panic(EPanicInvalidHandle));

	__ASSERT_ALWAYS(iFile.SubSessionHandle() == KNullHandle, Panic(EPanicHandleAlreadySet));

	User::LeaveIfError(iFile.Duplicate(aFile));

	}

/** Opens (by handle) the file that was passed into SetFileByHandleL by the process launching the local application.

On entering this function, aFile must be non-open. It is recommended that aFile is 

pushed onto the cleanup-stack (via CleanupClosePushL()) before this function is called.

@publishedPartner

@released

@param aFile The file object to be set up from the handle passed into the application. The 

caller has the responsibility to Close() this object, even if this function leaves. */

EXPORT_C void CApaCommandLine::GetFileByHandleL(RFile& aFile) const

	{

	__ASSERT_ALWAYS(aFile.SubSessionHandle()==KNullHandle, Panic(EPanicHandleAlreadySet));

	if (iFile.SubSessionHandle() != KNullHandle)

		User::LeaveIfError(aFile.Duplicate(iFile));

	}

/** Assigns a command line to a process (EKA2 only). 

This replaces the EKA1 method which involved retrieving the full command line (using 

CApaCommandLine::FullCommandLine()) and passing it to the process (or thread on the 

emulator).

This function is used as follows (the order of the first 2 steps is irrelevant):-

- create the process and load the executable (RProcess::Create()),

- create the command line object (CApaCommandLine::NewLC()), and set it up using 

the various setter functions, for instance SetDocumentNameL(),

- call SetProcessEnvironmentL() to assign the command line to the process,

- call Resume() on the process.

Note that this sequence of steps bypasses the application architecture, and is 

not recommended. RApaLsSession::StartApp() is the recommended way to 

launch an application with a command line.

@param aProcess The process to which the command line is assigned.

@leave KErrNotSupported This indicates that the function was called on EKA1.

@see RApaLsSession::StartApp()

*/

EXPORT_C void CApaCommandLine::SetProcessEnvironmentL(RProcess& aProcess) const

	{

	HBufC8* const streamableAttributes = StreamableAttributesLC();

	User::LeaveIfError(aProcess.SetParameter(EEnvironmentSlotMain, *streamableAttributes));

	CleanupStack::PopAndDestroy(streamableAttributes);

	if (iFile.SubSessionHandle() != KNullHandle)

		User::LeaveIfError(iFile.TransferToProcess(aProcess, EEnvironmentSlotFsSession, EEnvironmentSlotFile));

	}

/**

@internalTechnology

*/

EXPORT_C void CApaCommandLine::GetIpcArgsLC(TIpcArgs& aIpcArgs) const

	{

	aIpcArgs.Set(EIpcSlotMain, StreamableAttributesLC());

	if (iFile.SubSessionHandle() != KNullHandle)

		User::LeaveIfError(iFile.TransferToServer(aIpcArgs, EIpcSlotFsSession, EIpcSlotFile));

	}

/**

@internalTechnology

*/

HBufC8* CApaCommandLine::StreamableAttributesLC() const

	{

	CBufFlat* const buffer = CBufFlat::NewL(128);

	CleanupStack::PushL(buffer);

	RBufWriteStream writeStream;

	writeStream.Truncate(*buffer);

	ExternalizeL(writeStream);

	writeStream.CommitL();

	HBufC8* const bufferAsDescriptor = buffer->Ptr(0).AllocL();

	CleanupStack::PopAndDestroy(buffer);

	CleanupStack::PushL(bufferAsDescriptor);

	return bufferAsDescriptor;

	}

/** Acts as a second constructor and completes a commandline object from 

the aMessage object.

@internalTechnology */

EXPORT_C void CApaCommandLine::ConstructCmdLineFromMessageL(const RMessage2& aMessage)

	{

	// Create a buffer of the right size and get the data from the RMessage2

	RBuf8 buffer;

	buffer.CleanupClosePushL();

	buffer.CreateL(aMessage.GetDesLengthL(EIpcSlotMain));

	aMessage.ReadL(EIpcSlotMain, buffer);

	// Create a stream and use it to read the data from the buffer

	RDesReadStream stream;

	CleanupClosePushL(stream);

	stream.Open(buffer);

	InternalizeL(stream);

	CleanupStack::PopAndDestroy();	// stream

	CleanupStack::PopAndDestroy();	// buffer

	iFile.AdoptFromClient(aMessage, EIpcSlotFsSession, EIpcSlotFile); // ignore the returned error - assume it means that no file has been passed across

	}

/** Constructs a command line object.

If command line information is provided in the environment-slots it creates command line object from

process environment-slots, else creates it from the information returned by User::CommandLine().

It can be called from a context where there is no CTrapCleanup.

Calling this function more than once in a process is not supported and will result in an empty command

line being returned. If an application wants to inspect any part of its command line, it 

should override CEikAppUi::ProcessCommandParametersL(CApaCommandLine& aCommandLine) and call the base

class implementation if required.

@see CEikAppUi::ProcessCommandParametersL(CApaCommandLine& aCommandLine).

@param aCommandLine On return, a pointer to a newly constructed command line object.

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

@internalTechnology */

EXPORT_C TInt CApaCommandLine::GetCommandLineFromProcessEnvironment(CApaCommandLine*& aCommandLine)

	{ // static

	aCommandLine = NULL;

	CApaCommandLine* const commandLine = new CApaCommandLine;

	if(!commandLine)

		return KErrNoMemory;

	CTrapCleanup* trapCleanup = NULL;

	if (!User::TrapHandler())

		{

		trapCleanup = CTrapCleanup::New(); // we're being called from an environment without a cleanup-stack, so temporarily create one here

		if(!trapCleanup)

			{

			delete commandLine;

			return KErrNoMemory;

			}

		}

	TRAPD(error, commandLine->DoGetCommandLineFromProcessEnvironmentL());

	aCommandLine = commandLine;

	delete trapCleanup;

	return error;

	}

void CApaCommandLine::DoGetCommandLineFromProcessEnvironmentL()

	{

	const TInt bufLen = User::ParameterLength(EEnvironmentSlotMain);

	if (bufLen == KErrNotFound)

		{

		RBuf commandLineString;

		commandLineString.CleanupClosePushL();

		commandLineString.CreateL(User::CommandLineLength());

		User::CommandLine(commandLineString);

		User::LeaveIfError(DoGetParametersFromCommandLineString(commandLineString));

		CleanupStack::PopAndDestroy();	// commandLineString

		}

	else

		{

		User::LeaveIfError(bufLen); // in case bufLen is some error other than KErrNotFound

		RBuf8 buffer;

		buffer.CleanupClosePushL();

		buffer.CreateL(bufLen);

		User::LeaveIfError(User::GetDesParameter(EEnvironmentSlotMain, buffer));

		RDesReadStream stream;

		CleanupClosePushL(stream);

		stream.Open(buffer);

		InternalizeL(stream);

		CleanupStack::PopAndDestroy();	// stream

		CleanupStack::PopAndDestroy();	// buffer

		}

	iFile.AdoptFromCreator(EEnvironmentSlotFsSession, EEnvironmentSlotFile); // ignore the returned error - assume it means that no file has been passed across

	}

/** Sets the Parent Process ID for the Child Process launched with this command line.

This establishes a Parent-Child relationship which ensures that the child process is

terminated when the parent terminates.

@param aProcessId The Process ID. */

EXPORT_C void CApaCommandLine::SetParentProcessId(TProcessId aProcessId)

	{

	iParentProcessId = aProcessId;

	}

/** Gets the Parent Process ID of the Child Process launched with this command line.

See the description of SetParentProcessId.

@see SetParentProcessId

@return The Parent Process ID. */

EXPORT_C TProcessId CApaCommandLine::ParentProcessId() const

	{

	return iParentProcessId;

	}

void CApaCommandLine::ExternalizeL(RWriteStream& aStream) const

	{

	// iFile is not supported via RReadStream/RWriteStream

	aStream << DocumentName();

	aStream << ExecutableName();

	aStream << OpaqueData();

	aStream << TailEnd();

	aStream.WriteInt32L(iCommand);

	aStream.WriteInt32L(iServerDifferentiator);

	aStream.WriteInt32L(iDefaultScreenNumber);

	aStream.WriteInt32L(iParentWindowGroupID);

	aStream.WriteInt32L(iDebugMemFail);

	aStream.WriteInt32L(iAppStartupInstrumentationEventIdBase);

	aStream.WriteInt32L(iParentProcessId);

	}

void CApaCommandLine::InternalizeL(RReadStream& aStream)

	{

	// iFile is not supported via RReadStream/RWriteStream

	const TInt KMaxBufLength = 4000;

	iDocumentName.Close();	// free any existing memory

	iDocumentName.CreateL(aStream, KMaxBufLength);

	iExecutableName.Close();	// free any existing memory

	iExecutableName.CreateL(aStream, KMaxBufLength);

	iOpaqueData.Close();	// free any existing memory

	iOpaqueData.CreateL(aStream, KMaxBufLength);

	iTailEnd.Close();	// free any existing memory

	iTailEnd.CreateL(aStream, KMaxBufLength);

	iCommand = static_cast<TApaCommand>(aStream.ReadInt32L());

	iServerDifferentiator = aStream.ReadInt32L();

	iDefaultScreenNumber = aStream.ReadInt32L();

	iParentWindowGroupID = aStream.ReadInt32L();

	iDebugMemFail = aStream.ReadInt32L();

	iAppStartupInstrumentationEventIdBase = aStream.ReadInt32L();

	iParentProcessId = aStream.ReadInt32L();

	}

/** Sets that no server is required.

The value of server differentiator is set to zero, to indicate that no server

is required.

See the description of SetServerRequiredL.

@see SetServerRequiredL

*/

EXPORT_C void CApaCommandLine::SetServerNotRequiredL()

	{

	SetServerDifferentiatorL(0);

	}

/** Sets the required server.

The server differentiator is a number generated by the client that helps to uniquely 

identify the server. It is used by an application to indicate whether a server should

be created and how it should be named.

@param aServerDifferentiator A differentiator for the required server.

@see REikAppServiceBase::LaunchAppL() 

*/

EXPORT_C void CApaCommandLine::SetServerRequiredL(TUint aServerDifferentiator)

	{

	SetServerDifferentiatorL(aServerDifferentiator);

	}

/**

@see REikAppServiceBase::LaunchAppL()

@internalTechnology

*/

void CApaCommandLine::SetServerDifferentiatorL(TUint aServerDifferentiator)

	{

	iServerDifferentiator = aServerDifferentiator;

	}

/** Gets the server differentiator.

See the description of SetServerRequiredL.

@see SetServerRequiredL

@return The non-zero differentiator for the server, else zero indicating a server 

is not required.

@see REikAppServiceBase::LaunchAppL() */

EXPORT_C TUint CApaCommandLine::ServerRequired() const

	{

	return iServerDifferentiator;

	}

/** Provides support for devices with more than one screen.  A number representing the default

or startup screen may be passed to an application.

Screen numbers and characteristics are defined in the window server initialisation 

file (wsini.ini).

@param aDefaultScreenNumber The number of the default (startup) screen.