/*

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

*

*/

package com.nokia.carbide.cpp.epoc.engine.tests.model;

import com.nokia.carbide.cdt.builder.EMMPPathContext;

import com.nokia.carbide.cdt.builder.InvalidDriveInMMPPathException;

import com.nokia.carbide.cdt.builder.MMPViewPathHelper;

import com.nokia.carbide.cpp.epoc.engine.image.IBitmapSource;

import com.nokia.carbide.cpp.epoc.engine.image.IMultiImageSource;

import com.nokia.carbide.cpp.epoc.engine.model.EGeneratedHeaderFlags;

import com.nokia.carbide.cpp.epoc.engine.model.mmp.EMMPStatement;

import com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPBitmap;

import com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPResource;

import com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPView;

import com.nokia.carbide.cpp.epoc.engine.preprocessor.DefineFactory;

import com.nokia.carbide.internal.api.cpp.epoc.engine.dom.IASTNode;

import com.nokia.carbide.internal.api.cpp.epoc.engine.dom.IASTTranslationUnit;

import com.nokia.carbide.internal.api.cpp.epoc.engine.dom.mmp.IASTMMPStartBlockStatement;

import com.nokia.carbide.internal.cpp.epoc.engine.model.ViewASTBase;

import com.nokia.cpp.internal.api.utils.core.IMessage;

import org.eclipse.core.runtime.IPath;

import org.eclipse.core.runtime.Path;

import org.eclipse.jface.text.IDocument;

import java.util.List;

/**

 * Test MMP view manipulation

 *

 */

public class TestMMPView2 extends BaseMMPViewTest {

	static final String TEST_TRK_RESOURCE = 

		"START RESOURCE	trkapp.rss\r\n" + 

		"HEADER\r\n" + 

		"targetpath	\\resource\\apps\r\n" + 

		"lang		sc\r\n" + 

		"End\r\n" + 

		"";

	public void testTrkBug() {

		makeModel(TEST_TRK_RESOURCE);

		IMMPView view = model.createView(mmpConfig);

		assertEquals(0, view.getMessages().length);

	}

	static final String EMPTY_BITMAPS = 

		"start bitmap test.mbm\r\n" + 

		"end\r\n"; 

	public void testEmptyBitmaps() {

		makeModel(EMPTY_BITMAPS);

		IMMPView view = model.createView(mmpConfig);

		List<IMMPBitmap> bitmaps = view.getBitmaps();

		assertEquals(1, bitmaps.size());

		IMMPBitmap bm = bitmaps.get(0);

		assertNotNull(bm);

		assertNotNull(bm.getSources());

		assertEquals(0, bm.getSources().size());

	}

	public void testStartPlatform() {

		final String MMP = 

						"Start WINS\n"+

						"\t\twin32_headers\n"+

						"end";

		makeModel(MMP);

		IMMPView view = model.createView(mmpConfig);

		assertEquals(0, view.getMessages().length);

	}

	public void testAbsolutePaths() {

		// don't convert absolute or absolute-like paths

		final String MMP = 

			"USERINCLUDE +\\include\\oem \\epoc32\\foo c:\\foo\\bar\n";

		makeModel(MMP);

		IMMPView view = model.createView(mmpConfig);

		IPath path = view.getUserIncludes().get(0);

		assertEquals(new Path("+\\include\\oem"), path);

		path = view.getUserIncludes().get(1);

		assertEquals(new Path("\\epoc32\\foo"), path);

		path = view.getUserIncludes().get(2);

		assertEquals(new Path("c:\\foo\\bar"), path);

		view.getSystemIncludes().add(new Path("+\\epoc32\\data"));

		view.getSystemIncludes().add(new Path("\\epoc32\\user"));

		// NOTE: absolute paths with drive letters not allowed, so c:\ is dropped

		// if a normal API using MMPViewPathHelper constructs the path.

		// We don't strip anything inside MMPView because we don't know

		// what future enhancements may need the letter.

		view.getSystemIncludes().add(new Path("c:\\system\\files"));

		commitTest(view, MMP +

				"SYSTEMINCLUDE +\\epoc32\\data \\epoc32\\user c:\\system\\files\n");

	}

	public void testRootProject() {

		// make sure we handle project root correctly when it's the root directory

		for (int i = 0; i < 2; i++){

			parserConfig.projectPath = i == 0 ? new Path("c:\\") : new Path("c:");

			this.path = new Path("c:\\symbian\\9.1\\S60_3rd\\S60Ex\\Hello\\group\\hello.mmp");

			makeModel("SOURCEPATH ..\\src\n"+

					"SOURCE foo.cpp\n");

			IMMPView view = model.createView(mmpConfig);

			IPath[] srcPaths = view.getEffectiveSourcePaths();

			// important to be relative

			assertEquals(new Path("symbian/9.1/S60_3rd/S60Ex/Hello/src"), srcPaths[0]);

			IPath src = view.getSources().get(0);

			// important to be relative

			assertEquals(new Path("symbian/9.1/S60_3rd/S60Ex/Hello/src/foo.cpp"), src);

		}

	}

	final static String HELLOWORLD_MMP =

		"/*\r\n" + 

		"* ==============================================================================\r\n" + 

		"*  Name        : helloworldbasic.mmp\r\n" + 

		"*  Part of     : Helloworldbasic\r\n" + 

		"*  Interface   : \r\n" + 

		"*  Description : \r\n" + 

		"*  Version     : \r\n" + 

		"*\r\n" + 

		"*  Copyright (c) 2005-2006 Nokia Corporation.\r\n" + 

		"*  This material, including documentation and any related \r\n" + 

		"*  computer programs, is protected by copyright controlled by \r\n" + 

		"*  Nokia Corporation.\r\n" + 

		"* ==============================================================================\r\n" + 

		"*/\r\n" + 

		"\r\n" + 

		"TARGET            HelloWorldBasic.exe\r\n" + 

		"TARGETTYPE        exe\r\n" + 

		"UID		  0x100039CE 0xA000017F\r\n" + 

		"\r\n" + 

		"SECUREID	  0xA000017F\r\n" + 

		"EPOCSTACKSIZE	  0x5000\r\n" + 

		"\r\n" + 

		"SOURCEPATH        ..\\src\r\n" + 

		"SOURCE            HelloWorldBasic.cpp\r\n" + 

		"SOURCE            HelloWorldBasicApplication.cpp\r\n" + 

		"SOURCE            HelloWorldBasicAppView.cpp\r\n" + 

		"SOURCE            HelloWorldBasicAppUi.cpp\r\n" + 

		"SOURCE            HelloWorldBasicDocument.cpp\r\n" + 

		"\r\n" + 

		"SOURCEPATH        ..\\data\r\n" + 

		"\r\n" + 

		"START RESOURCE    HelloWorldBasic.rss\r\n" + 

		"HEADER\r\n" + 

		"TARGETPATH resource\\apps\r\n" + 

		"END //RESOURCE\r\n" + 

		"\r\n" + 

		"START RESOURCE    HelloWorldBasic_reg.rss\r\n" + 

		"#ifdef WINSCW\r\n" + 

		"TARGETPATH 	  \\private\\10003a3f\\apps\r\n" + 

		"#else\r\n" + 

		"TARGETPATH 	  \\private\\10003a3f\\import\\apps\r\n" + 

		"#endif\r\n" + 

		"END //RESOURCE\r\n" + 

		"\r\n" + 

		"\r\n" + 

		"\r\n" + 

		"USERINCLUDE       ..\\inc\r\n" + 

		"\r\n" + 

		"SYSTEMINCLUDE     \\epoc32\\include\r\n" + 

		"\r\n" + 

		"LIBRARY           euser.lib\r\n" + 

		"LIBRARY           apparc.lib\r\n" + 

		"LIBRARY           cone.lib\r\n" + 

		"LIBRARY           eikcore.lib\r\n" + 

		"LIBRARY           avkon.lib\r\n" + 

		"LIBRARY           commonengine.lib\r\n" + 

		"LIBRARY		  efsrv.lib \r\n" + 

		"LIBRARY           estor.lib\r\n" + 

		"\r\n" + 

		"LANG SC\r\n" + 

		"\r\n" + 

		"VENDORID	  	  0\r\n" + 

		"CAPABILITY	NONE\r\n" + 

		"\r\n" + 

		"// End of File\r\n" + 

		"\r\n" + 

		"";

	public void testCommitBug() {

		makeModel(HELLOWORLD_MMP);

		IMMPView view = model.createView(mmpConfig);

		assertEquals(0, view.getMessages().length);

		commitTest(view, HELLOWORLD_MMP);

	}

	public void testMultiSourcePaths() {

		String txt = 

			"DOCUMENT group_doc.txt\n"+

			"SOURCEPATH ..\\src\n"+

			"SOURCE foo.cpp bar.cpp\n"+

			"RESOURCE src_rsrc.rss\n"+

			"SOURCEPATH ..\\data\n"+

			"SOURCE data_src.cpp\n"+

			"RESOURCE foo.rss\n"+

			"SOURCEPATH ..\\doc\n"+

			"DOCUMENT readme.txt\n"+

			"SYSTEMRESOURCE doc_rsrc.rss\n";

		makeModel(txt);

		IMMPView view = model.createView(mmpConfig);

		assertEquals(new Path("group/group_doc.txt"), view.getDocuments().get(0));

		assertEquals(new Path("src/foo.cpp"), view.getSources().get(0));

		assertEquals(new Path("src/bar.cpp"), view.getSources().get(1));

		assertEquals(new Path("src/src_rsrc.rss"), view.getUserResources().get(0));

		assertEquals(new Path("data/foo.rss"), view.getUserResources().get(1));

		assertEquals(new Path("data/data_src.cpp"), view.getSources().get(2));

		assertEquals(new Path("doc/readme.txt"), view.getDocuments().get(1));

		assertEquals(new Path("doc/doc_rsrc.rss"), view.getSystemResources().get(0));

		commitTest(view, txt);

	}

	public void testMultiSourcePathsChanging() {

		String txt = "SOURCEPATH ..\\src\n"+

		"SOURCE foo.cpp bar.cpp\n"+

		"SOURCEPATH ..\\data\n"+

		"RESOURCE foo.rss\n"+

		"SOURCEPATH ..\\doc\n"+

		"DOCUMENT readme.txt\n";

		makeModel(txt);

		IMMPView view = model.createView(mmpConfig);

		commitTest(view, txt);

		view.getSources().add(new Path("othersrc/uid.cpp"));

		view.getUserResources().add(new Path("otherdata/uid.rss"));

		view.getDocuments().add(new Path("otherdox/releasenotes.txt"));

		commitTest(view, "SOURCEPATH ..\\src\n" + 

				"SOURCE foo.cpp bar.cpp\n" + 

				"SOURCEPATH ..\\data\n" + 

				"RESOURCE foo.rss\n" + 

				"SOURCEPATH ..\\doc\n" + 

				"DOCUMENT readme.txt\n" + 

				"SOURCEPATH ..\\othersrc\n" + 

				"SOURCE uid.cpp\n" + 

				"SOURCEPATH ..\\otherdata\n" + 

				"RESOURCE uid.rss\n" + 

				"SOURCEPATH ..\\otherdox\n" + 

		"DOCUMENT releasenotes.txt\n");

		view.getSources().clear();

		view.getUserResources().clear();

		view.getDocuments().clear();

		view.getDocuments().add(new Path("data/foo_rss.txt"));

		commitTest(view, "SOURCEPATH ..\\data\n" + 

				"DOCUMENT foo_rss.txt\n");

	}

	public void testUIDChanging() {

		makeModel("");

		IMMPView view = model.createView(mmpConfig);

		view.setUid2("0x10000000");

		commitTest(view, "UID 0x10000000\n");

		view.setUid3("0xaaaaaaaa");

		commitTest(view, "UID 0x10000000 0xaaaaaaaa\n");

		view.setUid3(null);

		commitTest(view, "UID 0x10000000\n");

		view.setUid2(null);

		commitTest(view, "");

	}

	/**

	 * The base directory changes as files are #included

	 *

	 */

	public void testBaseDirectory() {

		parserConfig.getFilesystem().put(new Path("c:/test/basefile.mmp").toOSString(), 

				"SOURCEPATH .\n"+

				"SOURCE base.cpp\n");

		parserConfig.getFilesystem().put(projectPath.append("utils").append("helper.mmh").toOSString(), 

				"SOURCEPATH .\n"+

				"SOURCE helper.cpp\n");

		makeModel(

				"SOURCEPATH .\n"+

				"SOURCE first.cpp\n"+

				"#include \"c:\\test\\basefile.mmp\"\n"+

				"#include \"../utils/helper.mmh\"\n"+

				"SOURCEPATH ../src\n"+

				"SOURCE last.cpp\n");

		IMMPView view = model.createView(mmpConfig);

		assertEquals(4, view.getSources().size());

		assertEquals(new Path("group/first.cpp"), view.getSources().get(0));

		// note: should not be relative path when outside the project

		assertEquals(new Path("c:/test/base.cpp"), view.getSources().get(1));

		assertEquals(new Path("utils/helper.cpp"), view.getSources().get(2));

		assertEquals(new Path("src/last.cpp"), view.getSources().get(3));

	}

	/** Sourcepath generation was buggy when mmp was at root. */

	public void testRootModelEmptySourcePaths() {

		path = new Path("test.mmp");

		makeModel("");

		IMMPView view = model.createView(mmpConfig);

		view.getSources().add(new Path("0"));

		// no SOURCEPATH . should be here

		commitTest(view,

				"SOURCE 0\n");

		view.getSources().add(new Path("1"));

		// no SOURCEPATH . should be here

		commitTest(view,

			"SOURCE 0 1\n");

	}

	public void testMbmChanging() {

		makeModel("START BITMAP test.mbm\n"+

				"SOURCE /c8 foo.bmp\n"+

				"END\n");

		IMMPView view = model.createView(mmpConfig);

		IMultiImageSource sources = view.getMultiImageSources().get(0);

		IBitmapSource source = sources.createBitmapSource();

		source.setPath(new Path("gfx/pic.bmp"));

		source.setColor(true);

		source.setDepth(16);

		sources.getSources().add(source);

		// bug 4726: new format is fwd slash

		commitTest(view,

				"START BITMAP test.mbm\n"+

				"\tSOURCE c8 foo.bmp\n"+

				"\tSOURCEPATH ../gfx\n"+

				"\tSOURCE c16 pic.bmp\n"+

				"END\n");

		sources = view.getMultiImageSources().get(0);

		source = sources.createBitmapSource();

		source.setPath(new Path("src/pic.bmp"));

		source.setColor(true);

		source.setDepth(8);

		source.setMaskDepth(1);

		source.setMaskPath(new Path("src/mask/pic.bmp"));

		sources.getSources().add(source);

		source = sources.createBitmapSource();

		source.setPath(new Path("src/pic2.bmp"));

		source.setColor(true);

		source.setDepth(8);

		source.setMaskDepth(1);

		source.setMaskPath(new Path("src/mask/pic2.bmp"));

		sources.getSources().add(source);

		commitTest(view,

				"START BITMAP test.mbm\n"+

				"\tSOURCE c8 foo.bmp\n"+

				"\tSOURCEPATH ../gfx\n"+

				"\tSOURCE c16 pic.bmp\n"+

				"\tSOURCEPATH ../src\n"+

				"\tSOURCE c8,1 pic.bmp mask/pic.bmp pic2.bmp mask/pic2.bmp\n"+

				"END\n");

	}

	/** This caused a ClassCastException */

	public void testResourceBlockScanning1() {

		makeModel("START RESOURCE target.rss\n"+

				"END\n"+

				"AIF target.aif ..\\aif\\ foo.rss\n");

		IMMPView view = model.createView(mmpConfig);

		assertEquals(1, view.getAifs().size());

		assertEquals(1, view.getResourceBlocks().size());

		view.getAifs().get(0).setTarget(new Path("newtarget.aif"));

		view.getResourceBlocks().get(0).setSource(new Path("group/newtarget.rss"));

		commitTest(view, "START RESOURCE newtarget.rss\n"+

				"END\n"+

				"AIF newtarget.aif ..\\aif foo.rss\n");

	}

	public void testResourceBlockScanning2() {

		makeModel("START RESOURCE target.rss\n"+

				"END\n"+

				"START BITMAP foo.mbm\n"+

				"END\n");

		IMMPView view = model.createView(mmpConfig);

		assertEquals(1, view.getBitmaps().size());

		assertEquals(1, view.getResourceBlocks().size());

		view.getResourceBlocks().get(0).setSource(new Path("group/newtarget.rss"));

		commitTest(view, "START RESOURCE newtarget.rss\n"+

				"END\n"+

				"START BITMAP foo.mbm\n"+

				"END\n");

	}

	public void testMissingNewlines() {

		makeModel("nostrictdef");

		IMMPView view = model.createView(mmpConfig);

		view.getSources().add(new Path("src/test.cpp"));

		commitTest(view, "nostrictdef\n"+

				"\n"+ // added newline 

				"SOURCEPATH ../src\n"+

				"SOURCE test.cpp\n");

	}

	public void addSpaceyFiles() {

		makeModel("SOURCEPATH ..\\src\n"

				+"SOURCE foo.cpp\n");

		IMMPView view = model.createView(mmpConfig);

		view.getSources().add(new Path("src/Copy of foo.cpp"));

		commitTest(view, 

				"SOURCEPATH ..\\src\n"+

				"SOURCE foo.cpp \"Copy of foo.cpp\"\n");

	}

	public void testPreprocessorProblems1() {

		String string = "#if 1\nSOURCE foo.cpp\n";

		makeModel(string);

		IMMPView view = model.createView(mmpConfig);

		IMessage[] problemNodes = view.getMessages();

		assertEquals(1, problemNodes.length);

		checkMessages(problemNodes);

		problemNodes = view.getMessages();

		assertEquals(1, problemNodes.length);

		checkMessages(problemNodes);

		assertEquals(1, view.getSources().size());

		// ensure no crash

		commitTest(view, string);

	}

	public void testPreprocessorProblems2() {

		String string = "BASEADDRESS 0\n#if 1\nSOURCE foo.cpp\nSRCDBG\n";

		makeModel(string);

		IMMPView view = model.createView(mmpConfig);

		IMessage[] problemNodes = view.getMessages();

		assertEquals(1, problemNodes.length);

		checkMessages(problemNodes);

		assertEquals(1, view.getSources().size());

		assertEquals("0", view.getSingleArgumentSettings().get(EMMPStatement.BASEADDRESS));

		assertTrue(view.getFlags().contains(EMMPStatement.SRCDBG));

		// ensure no crash

		commitTest(view, string);

	}

	public void testEmptySingleArgStatementCleaning() {

		makeModel("TARGET foo.exe\n"+

				"TARGETTYPE dll\n"+

				"START RESOURCE foo.rss\n"+

				"TARGETPATH wow\\man\n"+

				"UID 0x2 0x3\n"+

				"END\n");

		IMMPView view = model.createView(mmpConfig);

		view.getSingleArgumentSettings().put(EMMPStatement.TARGET, "");

		view.getSingleArgumentSettings().put(EMMPStatement.TARGETTYPE, "");

		view.getSingleArgumentSettings().put(EMMPStatement.TARGETPATH, "");

		IMMPResource resource = view.getResourceBlocks().get(0);

		resource.setTargetFile("");

		resource.setUid2("");

		resource.setUid3("");

		makeModel(

				"START RESOURCE foo.rss\n"+

				"END\n");

		////

		makeModel("TARGET foo.exe\n"+

				"TARGETTYPE dll\n"+

				"START RESOURCE foo.rss\n"+

				"TARGETPATH wow\\man\n"+

				"UID 0x2 0x3\n"+

				"END\n");

		view = model.createView(mmpConfig);

		view.getSingleArgumentSettings().put(EMMPStatement.TARGET, null);

		view.getSingleArgumentSettings().put(EMMPStatement.TARGETTYPE, null);