/*

* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "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: 

*

*/

include("renderLibrary.js")

/**

 * Create a contribution that sets a property if its value

 * is not equal to a given default.  

 * @param phase the phase to supply

 * @param indent extra indentation to add (i.e. 1 if inside an "if")

 * @param instanceMemberName the name of the member variable

 * @param propertyValue the current value of the property

 * @param defaultValue the value considered the default

 * @param format a format string for setting the property, where

 *		{0} is substituted with instanceMemberName and 

 *		{1} is substituted with the propertyValue

 * @return a contribution, or null

 */

function createSetPropertyForPhase(contribs, phase, indent, instanceMemberName, 

			propertyValue, defaultValue, format) {

	if (propertyValue != defaultValue) {

		contrib = Engine.createContributionForPhase(phase);

		contrib.indentAdjust(indent);

		contrib.setFormattedText(format, new Array( instanceMemberName, propertyValue) );

		return contrib;

	}

	return null;

}

/**

 * Generate a contribution that sets a property if its value

 * is not equal to a given default.  

 * @param contribs the contribution list

 * @param phase the phase to supply

 * @param indent extra indentation to add (i.e. 1 if inside an "if")

 * @param instanceMemberName the name of the member variable

 * @param propertyValue the current value of the property

 * @param defaultValue the value considered the default

 * @param format a format string for setting the property, where

 *		{0} is substituted with instanceMemberName and 

 *		{1} is substituted with the propertyValue

 * @param checkNull if true, insert check for null instance around sette

 */

function setPropertyForPhase(contribs, phase, indent, instanceMemberName, 

			propertyValue, defaultValue, format, checkNull) {

	contrib = createSetPropertyForPhase(contribs, phase, indent, 

			instanceMemberName, propertyValue, defaultValue, format);

	if (contrib == null)

		return;

	if (checkNull) {

		acontrib = Engine.createContributionForPhase(phase);

		acontrib.indentAdjust(indent);

		acontrib.setFormattedText("if ( {0} )\n", [ instanceMemberName ]);

		contribs.add(acontrib);

		acontrib = Engine.createContributionForPhase(phase);

		acontrib.indentAdjust(indent+1);

		acontrib.setText("{\n");

		contribs.add(acontrib);

		contribs.add(contrib);

		acontrib = Engine.createContributionForPhase(phase);

		acontrib.indentAdjust(indent+1);

		acontrib.setText("}\n");

		contribs.add(acontrib);

	} else {

		contribs.add(contrib);

	}

}

/**

 * Generate a set of contributions to set multiple possible

 * properties.

 * Like #setPropertyForPhase(), where the 5th and later arguments

 * are taken in groups of three as [propertyValue, defaultValue, format].

 */

function setPropertiesForPhase(contribs, phase, indent, instanceMemberName, checkNull) {

	var ourContribStr = "";

	var any = false;

	var innerIndent = indent + (checkNull ? 1 : 0);

	for (var h = 5; h < arguments.length; h += 3) {

		contrib = createSetPropertyForPhase(contribs, phase, innerIndent, instanceMemberName,

			arguments[h], arguments[h+1], arguments[h+2]);

		if (contrib == null)

			continue;

		if (!any && checkNull) {

			acontrib = Engine.createContributionForPhase(phase);

			acontrib.indentAdjust(indent);

			acontrib.setFormattedText("if ( {0} )\n", [ instanceMemberName ]);

			ourContribStr = acontrib.getText();

			acontrib = Engine.createContributionForPhase(phase);

			acontrib.indentAdjust(indent+1);

			acontrib.setText("\t" + "{\n");

			ourContribStr = ourContribStr + acontrib.getText();

			any	= true;

		}

		ourContribStr = ourContribStr + "\t" + contrib.getText();

	}

	if (any && checkNull) {

		acontrib = Engine.createContributionForPhase(phase);

		acontrib.indentAdjust(indent+1);

		acontrib.setText("\t" + "}\n");

		ourContribStr = ourContribStr + acontrib.getText();

	}

	acontrib = Engine.createContributionForPhase(phase);

	acontrib.indentAdjust(indent);

	acontrib.setText(ourContribStr);

	contribs.add(acontrib);

}

/**

 *	Get the base filename

 *	@param path a path

 */

function getBaseFileName(path) {

	var idx = path.lastIndexOf('/');

	if (idx >= 0)

		base = path.substring(idx+1);

	else {

		idx = path.lastIndexOf('\\');

		if (idx >= 0)

			base = path.substring(idx+1);

		else

			base = path;

	}

	idx = base.lastIndexOf('.');

	if (idx >= 0)

		base = base.substring(0, idx);

	return base;

}

/**

 *	Get the bitmap header file

 *	@param path the system MBM/MIF name from the image.bmpfile property

 */

function getBitmapHeaderName(path) {

	var base = getBaseFileName(path);

	base = base + ".mbg";	

	return base.toLowerCase();

}

function addContrib(contribs, phase, loc, indent, text) {

	var c;

	if (phase != null)

		c = Engine.createContributionForPhase(phase);

	else

		c = Engine.createContributionForLocation(loc);

	c.setText(text);

	c.indentAdjust(indent);

	contribs.add(c);

}

function addFormattedContrib(contribs, phase, loc, indent, format, args) {

	var c;

	if (phase != null)

		c = Engine.createContributionForPhase(phase);

	else

		c = Engine.createContributionForLocation(loc);

	c.setFormattedText(format, args);

	c.indentAdjust(indent);

	contribs.add(c);

}

/**

 *	Get the nearest enclosing instance that defines a class.

 */

function getClassHolder(instance) {

	while (instance != null && !instance.properties.className) {

		instance = instance.parent;

	}

	return instance;

}

/**

 *	Get the table of multi-image filenames to literal names

 */

function getFilenameToLiteralTable(instance) {

	var holder = getClassHolder(instance);

	var key = "ImageSupport.filenameToLiteralTable:" + holder;

	var table = Engine.getGlobalDictionary().get(key);

	if (table == null) {

		table = new java.util.HashMap();

		Engine.getGlobalDictionary().put(key, table);

	}

	return table;

}

/**

 *	Get an identifier name from a MBM/MIF filepath

 */

function makeLiteralIdentifier(map, path) {

	// no need to uniquify, as the base mbmdef/mifdef name must be unique as well

	var base = getBaseFileName(path);

	var litname = "K" + base + "File";

	return litname;

}

/**

 *	Prepare a container for sourcegen that involves generating

 *	image properties.  We need to ensure the MBM/MIF filename for

 *	an image is emitted as a constant only once.

 */

function resetImagePropertyState(instance) {

	var classHolder = getClassHolder(instance);

	classHolder.filenameToLiteralTable = new java.util.HashMap();

}

/**

 *	Tell if an image property is set.  If not, it should be ignored.

 */		

function isImagePropertySet(imageProperty) {

	return imageProperty.bmpfile != "" 

		&& imageProperty.bmpid != "";

}

/** 

 *	Tell if we support scaling at all

 */

function isScalingIcons() {

	var version = getComponentVersions();

	if (version.getMajor() >= 3)

		return true;

	if (version.getMajor() == 2 && version.getMinor() >= 8) {

		appUi = getRootModelInstanceOfType("com.nokia.sdt.series60.CAknAppUi");

		if (appUi != null)

			return appUi.properties.layoutAware;

	}

	return false;

}

/**

 *	Set up contributions that set up an image property given

 *	its compound property.  This uses CFbsBitmap* objects and

 *	thus allows for resizing behavior.  Use a separate routine if

 *	setting up multiple images, since the repeated code for SVG setup

 *	can get quite long.

 *	@param contribs the contributions to append to

 *	@param instance instance the image is for (used to find the class)

 *	@param phase primary phase to write to (or null, loc must be set)

 *	@param loc primary location to write to (or null, phase must be set)

 *	@param indent indentation adjust

 *	@param imageProperty the property value

 *	@param aspectOption the appropriate enumeration for aspect ratio handling (or null)

 *	@param bitmapPattern when only a bitmap is set,

 *		a MessageFormat string to be substituted with arguments ([ CFbsBitmap* ])

 *	@param bitmapAndMaskPattern when a bitmap and mask is set,

 *		a MessageFormat string to be substituted with arguments (or null)

 *		([ CFbsBitmap*, CFbsBitmap* ])

 *	@param theSize text representing the TSize argument (e.g. "control->Size()" or "TSize(45, 66)")

 *			or null to use the image's real size

 */

function setupImageFromPropertyViaCFbsBitmap(contribs, instance, phase, loc, indent,

		imageProperty, aspectOption, 

		bitmapPattern, bitmapAndMaskPattern, theSize) {

	var version = getComponentVersions();

	var contrib;

	// moved here to precede system includes of .mbg files	

	var isSVG = imageProperty.editableValue.isSVG();

	if (isScalingIcons() || isSVG) {

		// get icon utilities header

		addContrib(contribs, "MainSystemIncludes", loc, 0,

			"#include <akniconutils.h>\n");

	}

	if (imageProperty.bmpfile != "") {

		// make the literal string for the filename

		var table = getFilenameToLiteralTable(instance);

		var litname = table.get(imageProperty.bmpfile);

		if (!litname) {

			litname = makeLiteralIdentifier(table, imageProperty.bmpfile);

			addContrib(contribs, "MainConstants", null, 0,

				"_LIT( " + litname +", \"" + 

					TextUtils.escape(imageProperty.bmpfile, '"') + "\" );\n");

			// get the mbg header

			addContrib(contribs, "MainSystemIncludes", null, 0,

				"#include <" + getBitmapHeaderName(imageProperty.bmpfile) + ">\n");

			table.put(imageProperty.bmpfile, litname);

		}

	}

	if (!isScalingIcons() && !isSVG) {

		// only unscalable bitmaps allowed, and initialized via CFbsBitmap

		indent++;

		addContrib(contribs, phase, loc, indent,

			"{\n");

		if (bitmapAndMaskPattern != null 

				&& imageProperty.bmpfile != ""

				&& imageProperty.bmpmask != "" 

				&& imageProperty.bmpid != "") {

			addContrib(contribs, phase, loc, indent,

				"CFbsBitmap* bitmap = iEikonEnv->CreateBitmapL( " + litname + ", " + imageProperty.bmpid + " );\n"

				);

			addContrib(contribs, phase, loc, indent,

				"CFbsBitmap* mask = iEikonEnv->CreateBitmapL( " + litname + ", " + imageProperty.bmpmask + " );\n"

				);

			addFormattedContrib(contribs, phase, loc, indent,

				bitmapAndMaskPattern, [ "bitmap", "mask" ]);

		}

		else if (bitmapPattern != null) {

			if (imageProperty.bmpfile != "" && imageProperty.bmpid != "") {

				addContrib(contribs, phase, loc, indent,

					"CFbsBitmap* bitmap = iEikonEnv->CreateBitmapL( " + litname + ", " + imageProperty.bmpid + " );\n"

					);

			} else {

				// no image, but at least a bitmap is required

				addContrib(contribs, phase, loc, indent,

					"CFbsBitmap* bitmap = new (ELeave) CFbsBitmap;\n"

					);

			}						

			addFormattedContrib(contribs, phase, loc, indent,

				bitmapPattern, [ "bitmap" ]);

		}

		addContrib(contribs, phase, loc, indent,

			"}\n");

		indent--;

	} else {

		// S60 >= 3.0

		indent++;

		addContrib(contribs, phase, loc, indent,

			"{\n");

		var sizeArg = theSize;

		if (sizeArg == null)

			sizeArg = "size"; 	// for SVG 

		if (imageProperty.bmpfile != "") {		

			// load the bitmap and/or mask

			addContrib(contribs, phase, loc, indent,

				"CFbsBitmap *bitmap, *mask;\n");

			addContrib(contribs, phase, loc, indent,

				"AknIconUtils::CreateIconL( bitmap, mask,\n"+

				"\t\t" + litname + ", " + 

				((bitmapPattern != null && imageProperty.bmpid != "") ?

					imageProperty.bmpid : "-1") + 

					", " +

				((bitmapAndMaskPattern != null && imageProperty.bmpmask != "") ?

					imageProperty.bmpmask : "-1") +

					" );\n");

			// prepare to issue two calls needing SVG info

			if (isSVG && theSize == null) {

				addContrib(contribs, phase, loc, indent,

					"TSize size;\n"+

					"AknIconUtils::PreserveIconData( bitmap );\n"+

					//"AknIconUtils::PreserveIconData( mask );\n"+

					"");

			}

		} else {

			// no image, but at least a bitmap WITH CONTENT is required

			addContrib(contribs, phase, loc, indent,

				"CFbsBitmap *bitmap = new (ELeave) CFbsBitmap;\n"+

				"bitmap->Create( TSize( 1, 1), EGray2 );\n");

		}

		// set the size

		var aspectText;

		if (aspectOption != null && aspectOption != "")

			aspectText = ", " + aspectOption;

		else

			aspectText = ", EAspectRatioNotPreserved";

		if (imageProperty.bmpfile != "") {		

			if (isSVG && theSize == null) {

				// get the size

				addContrib(contribs, phase, loc, indent,

					"AknIconUtils::GetContentDimensions( bitmap, size );\n");

			}

		}

		if (bitmapAndMaskPattern != null 

				&& imageProperty.bmpfile != ""

				&& imageProperty.bmpmask != "" 

				&& imageProperty.bmpid != "") {

			addContrib(contribs, phase, loc, indent,

				"AknIconUtils::SetSize( bitmap, " + sizeArg + aspectText + " );\n");

			addContrib(contribs, phase, loc, indent,

				"AknIconUtils::SetSize( mask, " + sizeArg + aspectText + " );\n");

			addFormattedContrib(contribs, phase, loc, indent,

				bitmapAndMaskPattern, [ "bitmap", "mask" ]);

		} else if (bitmapPattern != null) {

			addContrib(contribs, phase, loc, indent,

				"AknIconUtils::SetSize( bitmap, " + theSize + aspectText + " );\n");

			addFormattedContrib(contribs, phase, loc, indent,

				bitmapPattern, [ "bitmap" ]);

		}

		if (isSVG && theSize == null) {

			addContrib(contribs, phase, loc, indent,

				"AknIconUtils::DestroyIconData( bitmap );\n");

		}

		addContrib(contribs, phase, loc, indent,

			"}\n");

		indent--;

	}

}

/**

 *	Set up contributions that set up an image property given

 *	its compound property.  This passes arguments to a function

 *	which takes the (TDesc aFileName, TInt bmpid, TInt maskid)

 *	arguments.  Image resizing is not allowed.

 *	@param contribs the contributions to append to

 *	@param instance instance the image is for (used to find the class)

 *	@param phase primary phase to write to (or null, loc must be set)

 *	@param loc primary location to write to (or null, phase must be set)

 *	@param indent indentation adjust

 *	@param imageProperty the compound property providing bmpfile, bmpid, bmpmask

 *	@param bitmapPattern when only a bitmap is set,

 *		a MessageFormat string to be substituted with arguments

 *		([ filename, id ])

 *	@param bitmapAndMaskPattern when a bitmap and mask is set,

 *		a MessageFormat string to be substituted with arguments (or null)

 *		([ filename, id, maskid ])

 */

function setupImageFromPropertyViaTuple(contribs, instance, phase, loc, indent,

		imageProperty,

		bitmapPattern, bitmapAndMaskPattern) {

	if (!isImagePropertySet(imageProperty))

		return;

	var version = getComponentVersions();

	var contrib;

	// make the literal string for the filename

	var table = getFilenameToLiteralTable(instance);

	var litname = table.get(imageProperty.bmpfile);

	if (!litname) {

		litname = makeLiteralIdentifier(table, imageProperty.bmpfile);

		addContrib(contribs, "MainConstants", null, 0,

			"_LIT( " + litname +", \"" + 

				TextUtils.escape(imageProperty.bmpfile, '"') + "\" );\n");

		// get the mbg header

		addContrib(contribs, "MainSystemIncludes", null, 0,

			"#include <" + getBitmapHeaderName(imageProperty.bmpfile) + ">\n");

		table.put(imageProperty.bmpfile, litname);

	}

	if (bitmapAndMaskPattern != null 

			&& imageProperty.bmpmask != "") {

		addFormattedContrib(contribs, phase, loc, indent,

			bitmapAndMaskPattern, [ litname, imageProperty.bmpid, imageProperty.bmpmask ]);

	}

	else if (bitmapPattern != null) {

		addFormattedContrib(contribs, phase, loc, indent,

			bitmapPattern, [ litname, imageProperty.bmpid ]);

	}

}

/**

 *	Create a method that loads and scales SVG or BMP icons, for use when

 *	multiple icons are loaded at once.  This assumes the function defined in

 *	LoadAndScaleIconL.inc.  For S60 2.8 or newer.

 */

function defineIconLoadingRoutines(contribs, location, className) { 

	// get icon utilities headers.  

	addContrib(contribs, "HeaderIncludes", null, 0,

		"#include <akniconutils.h>\n");

	addContrib(contribs, "HeaderIncludes", null, 0,

		"#include <gulicon.h>\n");

	//// needs to be permanent or else it's duplicated

	//addContrib(contribs, "UserHandlers", null, 0,

	addContrib(contribs, "ClassMethods", null, 0,

		"static CGulIcon* LoadAndScaleIconL(\n"+

		"\t\tconst TDesC& aFileName,\n"+

		"\t\tTInt aBitmapId,\n"+

		"\t\tTInt aMaskId,\n"+

		"\t\tTSize* aSize,\n"+

		"\t\tTScaleMode aScaleMode );\n"

	);

	// force the location to be instantiated

	addContrib(contribs, null, location, 0, "");

	return;

}

var alignmentMap = {

	"EHLeft+EVTop" : "EHLeftVTop",

	"EHLeft+EVCenter" : "EHLeftVCenter",

	"EHLeft+EVBottom" : "EHLeftVBottom",

	"EHCenter+EVTop" : "EHCenterVTop",

	"EHCenter+EVCenter" : "EHCenterVCenter",

	"EHCenter+EVBottom" : "EHCenterVBottom",

	"EHRight+EVTop" : "EHRightVTop",

	"EHRight+EVCenter" : "EHRightVCenter",