/*

 * Copyright (c) 2008-2010 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:

 *

 * Workbench monitor which opens / closes the trace project

 *

 */

package com.nokia.tracebuilder.eclipse;

import java.io.BufferedReader;

import java.io.BufferedWriter;

import java.io.DataInputStream;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.io.FileOutputStream;

import java.io.FilenameFilter;

import java.io.IOException;

import java.io.InputStream;

import java.io.InputStreamReader;

import java.io.OutputStreamWriter;

import java.util.ArrayList;

import java.util.List;

import java.util.Vector;

import org.eclipse.core.resources.IFile;

import org.eclipse.core.resources.IProject;

import org.eclipse.core.resources.IWorkspace;

import org.eclipse.core.resources.ResourcesPlugin;

import org.eclipse.core.runtime.CoreException;

import org.eclipse.core.runtime.IPath;

import org.eclipse.core.runtime.Path;

import org.eclipse.jface.text.Document;

import org.eclipse.jface.text.IDocument;

import org.eclipse.ui.IEditorReference;

import org.eclipse.ui.IWorkbenchPage;

import org.eclipse.ui.IWorkbenchWindow;

import org.eclipse.ui.PlatformUI;

import org.eclipse.ui.texteditor.ITextEditor;

import org.osgi.framework.Version;

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

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

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

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

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

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

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

import com.nokia.carbide.cdt.builder.project.ICarbideBuildConfiguration;

import com.nokia.carbide.cdt.builder.project.ICarbideProjectInfo;

import com.nokia.carbide.cpp.epoc.engine.EpocEnginePlugin;

import com.nokia.carbide.cpp.epoc.engine.MMPDataRunnableAdapter;

import com.nokia.carbide.cpp.epoc.engine.MMPViewRunnableAdapter;

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

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

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

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

import com.nokia.tracebuilder.engine.TraceBuilderConfiguration;

import com.nokia.tracebuilder.engine.TraceBuilderGlobals;

import com.nokia.tracebuilder.engine.TraceBuilderView;

import com.nokia.tracebuilder.engine.TraceLocationConverter;

import com.nokia.tracebuilder.engine.TraceLocationMap;

import com.nokia.tracebuilder.engine.TraceProjectMonitorInterface;

import com.nokia.tracebuilder.engine.TraceBuilderErrorCodes.FileErrorParameters;

import com.nokia.tracebuilder.engine.TraceBuilderErrorCodes.TraceBuilderErrorCode;

import com.nokia.tracebuilder.engine.project.ProjectEngine;

import com.nokia.tracebuilder.engine.source.SourceProperties;

import com.nokia.tracebuilder.file.FileUtils;

import com.nokia.tracebuilder.model.TraceBuilderException;

import com.nokia.tracebuilder.project.GroupNameHandlerBase;

import com.nokia.tracebuilder.project.GroupNameHandlerOSTv1;

import com.nokia.tracebuilder.project.GroupNameHandlerOSTv2;

import com.nokia.tracebuilder.source.SourceConstants;

import com.nokia.tracebuilder.source.SourceDocumentInterface;

import com.nokia.tracebuilder.utils.DocumentFactory;

import com.nokia.carbide.cpp.sdk.core.SDKCorePlugin;

import com.nokia.carbide.cpp.sdk.core.ISDKManager;

/**

 * Workbench monitor which opens / closes the trace project

 * 

 */

class TraceProjectMonitor implements WorkbenchListenerCallback,

		TraceProjectMonitorInterface {

	/**

	 * OST_INSTRUMENTATION_API_VERSION text

	 */

	private static final String OST_INSTRUMENTATION_API_VERSION_TEXT = "OST_INSTRUMENTATION_API_VERSION"; //$NON-NLS-1$

	/**

	 * Regular expression for OST_INSTRUMENTATION_API_VERSION macro check

	 */

	private static final String OST_INSTRUMENTATION_API_VERSION_REGEX = "#define\\s+OST_INSTRUMENTATION_API_VERSION.*"; //$NON-NLS-1$

	/**

	 * OSTv1 version text

	 */

	private static final String OST_VERSION_1_X_X = "1.x.x"; //$NON-NLS-1$

	/**

	 * OSTv2 version text

	 */

	private static final String OST_VERSION_2_X_X = "2.x.x"; //$NON-NLS-1$

	/**

	 * OpenSystemTrace.h file name

	 */

	private static final String OPEN_SYSTEM_TRACE_H = "opensystemtrace.h"; //$NON-NLS-1$

	/**

	 * epoc32\include\include path as string

	 */

	private static final String EPOC32_INCLUDE_INTERNAL = "epoc32" + File.separator + "include" + File.separator + "internal"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$

	/**

	 * epoc32\include\platform path as string

	 */

	private static final String EPOC32_INCLUDE_PLATFORM = "epoc32" + File.separator + "include" + File.separator + "platform"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$

	/**

	 * PLATFORM_PATHS.HRH

	 */

	private static final String PLATFORM_PATHS_HRH = "PLATFORM_PATHS.HRH"; //$NON-NLS-1$

	/**

	 * #INCLUDE

	 */

	private static final String INCLUDE = "#INCLUDE"; //$NON-NLS-1$

	/**

	 * Multiline comment start

	 */

	private static final String MULTILINE_COMMENT_START = "/*"; //$NON-NLS-1$

	/**

	 * Comment

	 */

	private static final String COMMENT = "//"; //$NON-NLS-1$	

	/**

	 * Multiline comment end

	 */

	private static final String MULTILINE_COMMENT_END = "*/"; //$NON-NLS-1$

	/**

	 * ncp sw folder name

	 */

	private static final String NCP_SW_FOLDER_NAME = "ncp_sw"; //$NON-NLS-1$

	/**

	 * os folder name

	 */

	private static final String OS_FOLDER_NAME = "os"; //$NON-NLS-1$

	/**

	 * mw folder name

	 */

	private static final String MW_FOLDER_NAME = "mw"; //$NON-NLS-1$

	/**

	 * sf folder name

	 */

	private static final String SF_FOLDER_NAME = "sf"; //$NON-NLS-1$

	/**

	 * platform_paths.hrh include

	 */

	private static final String INCLUDE_PLATFORM_PATHS_HRH = "#include \"platform_paths.hrh\""; //$NON-NLS-1$

	/**

	 * OS layer system include macro

	 */

	private static final String OS_LAYER_SYSTEMINCLUDE_MACRO = "OS_LAYER_SYSTEMINCLUDE"; //$NON-NLS-1$

	/**

	 * MW layer system include macro

	 */

	private static final String MW_LAYER_SYSTEMINCLUDE_MACRO = "MW_LAYER_SYSTEMINCLUDE"; //$NON-NLS-1$

	/**

	 * APP layer system include macro

	 */

	private static final String APP_LAYER_SYSTEMINCLUDE_MACRO = "APP_LAYER_SYSTEMINCLUDE"; //$NON-NLS-1$

	/**

	 * Group directory

	 */

	private static final String GROUP_DIRECTORY = "group"; //$NON-NLS-1$	

	/**

	 * Traces directory

	 */

	public static final String TRACES_DIRECTORY = "traces"; //$NON-NLS-1$

	/**

	 * MmpFiles directory

	 */

	private static final String MMPFILES_DIRECTORY = "mmpfiles"; //$NON-NLS-1$

	/**

	 * Underscore character

	 */

	public static final String UNDERSCORE = "_"; //$NON-NLS-1$

	/**

	 * The workbench listener

	 */

	private WorkbenchListener listener;

	/**

	 * Project path that is currently open

	 */

	private String openProjectPath;

	/**

	 * Project object that is currently open

	 */

	private IProject openProjectObject;

	/**

	 * Trace project include added to MMP files

	 */

	private boolean mmpFileModified;

	/**

	 * Name of the "traces_<component name>" folder

	 */

	private String tracesComponentNameFolder;

	/**

	 * Name of the "traces_<target_name>_<target_type>" folder

	 */

	private String tracesTargetNameTargetTypeFolder;

	/**

	 * Name of the "traces\<target_name>_<target_ext>" folder

	 */

	private String tracesDirTargetNameTargetExtFolder;

	/**

	 * Trace folder name used in SBSv2

	 */

	private String sbsv2TraceFolderName;

	/**

	 * Select software component flag

	 */

	private boolean selectSoftwareComponent = true;

	/**

	 * Select software component check needed flag

	 */

	private boolean selectSoftwareComponentCheckNeeded = false;

	/**

	 * Trace folder changed flag

	 */

	private boolean traceFolderChanged = false;

	/**

	 * Previous file included more than once flag

	 */

	private boolean previousFileIncludedMoreThanOnce = false;

	/**

	 * Editor opened flag

	 */

	private boolean editorOpened = false;

	/**

	 * File object that is currently visible

	 */

	IFile openFileObject = null;

	/**

	 * Trace folder name of the project that is currently visible

	 */

	String openProjectTraceFolderName = null;

	/**

	 * OSTv1 start text

	 */

	private static final String OSTV1_START_TEXT = "1."; //$NON-NLS-1$	

	/**

	 * OSTv2 start text

	 */

	private static final String OSTV2_START_TEXT = "2."; //$NON-NLS-1$		

	/**

	 * Constructor

	 */

	TraceProjectMonitor() {

		listener = new WorkbenchListener(this);

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see

	 * com.nokia.tracebuilder.eclipse.TraceProjectMonitorInterface#startMonitor

	 * ()

	 */

	public void startMonitor() {

		listener.startListener();

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see

	 * com.nokia.tracebuilder.eclipse.TraceProjectMonitorInterface#stopMonitor()

	 */

	public void stopMonitor() {

		listener.stopListener();

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see com.nokia.tracebuilder.eclipse.WorkbenchListenerCallback#

	 * editorActivated(org.eclipse.ui.texteditor.ITextEditor,

	 * org.eclipse.core.resources.IFile)

	 */

	public void editorActivated(ITextEditor editor, IFile file) {

		TraceBuilderView view = TraceBuilderGlobals.getView();

		view.refresh();

		if (editorOpened) {

			view.expandTraceGroupsBranch();

			editorOpened = false;

		}

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see com.nokia.tracebuilder.eclipse.WorkbenchListenerCallback#

	 * editorClosed(org.eclipse.ui.texteditor.ITextEditor,

	 * org.eclipse.core.resources.IFile)

	 */

	public void editorClosed(ITextEditor editor, IFile file) {

		if (!WorkbenchUtils.isEditorsOpen()) {

			if (openProjectPath != null) {

				TraceBuilderGlobals.getTraceBuilder().closeProject();

				openProjectPath = null;

			}

		}

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see com.nokia.tracebuilder.eclipse.WorkbenchListenerCallback#

	 * editorOpened(org.eclipse.ui.texteditor.ITextEditor,

	 * org.eclipse.core.resources.IFile)

	 */

	public void editorOpened(ITextEditor editor, IFile file) {

		openFileObject = file;

		updateProject(file);

		editorOpened = true;

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see com.nokia.tracebuilder.eclipse.WorkbenchListenerCallback#

	 * editorHidden(org.eclipse.ui.texteditor.ITextEditor,

	 * org.eclipse.core.resources.IFile)

	 */

	public void editorHidden(ITextEditor editor, IFile file) {

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see com.nokia.tracebuilder.eclipse.WorkbenchListenerCallback#

	 * editorVisible(org.eclipse.ui.texteditor.ITextEditor,

	 * org.eclipse.core.resources.IFile)

	 */

	public void editorVisible(ITextEditor editor, IFile file) {

		if (!file.equals(openFileObject)) {

			updateProject(file);

			openFileObject = file;

		}

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see com.nokia.tracebuilder.eclipse.WorkbenchListenerCallback#

	 * editorReplaced(org.eclipse.ui.texteditor.ITextEditor,

	 * org.eclipse.core.resources.IFile)

	 */

	public void editorReplaced(ITextEditor editor, IFile file) {

		updateProject(file);

	}

	/**

	 * Opens the trace project related to given file

	 * 

	 * @param file

	 *            the file

	 */

	private void updateProject(IFile file) {

		IProject project = file.getProject();

		// Check that project is Carbide project

		boolean isCarbideProject = CarbideBuilderPlugin.getBuildManager()

				.isCarbideProject(project);

		if (isCarbideProject) {

			String projectPath = getProjectPath(file);

			// If trace folder name or project changes, existing project

			// needs to be closed

			if (traceFolderChanged == true

					|| (openProjectPath != null && projectPath != null && !projectPath

							.equals(openProjectPath))) {

				TraceBuilderGlobals.getTraceBuilder().closeProject();

				openProjectPath = null;

				openProjectObject = null;

			}

			if (projectPath != null && !projectPath.equals(openProjectPath)) {

				try {

					mmpFileModified = false;

					openProjectPath = projectPath;

					openProjectObject = file.getProject();

					ProjectEngine.traceFolderName = openProjectTraceFolderName;

					TraceBuilderGlobals.setProjectPath(projectPath);

					initializeDefaultGroupNames();

					// Get project name

					String projectName = getProjectName(projectPath);

					// Save Epoc root of this SDK

					saveEpocRoot(openProjectObject);

					// Open the project

					TraceBuilderGlobals.getTraceBuilder().openProject(

							projectName);

					// Parse traces from other source files in same

					// component

					parseOtherTracesFromComponent(file, project);

				} catch (TraceBuilderException e) {

					openProjectPath = null;

					openProjectObject = null;

					// If a source file is not open, this error is not

					// relevant

					// The project will be opened when a source is opened

					if (e.getErrorCode() != TraceBuilderErrorCode.SOURCE_NOT_OPEN) {

						TraceBuilderGlobals.getEvents().postError(e);

					}

				}

			}

		} else {

			TraceBuilderGlobals.getTraceBuilder().closeProject();

			openProjectPath = null;

			openProjectObject = null;

		}

	}

	/**

	 * Initialize default group names based on used OST version

	 * 

	 * @throws TraceBuilderException

	 */

	private void initializeDefaultGroupNames() throws TraceBuilderException {

		// Initialize default group names

		String ostVersion = null;

		IPath epocroot = WorkbenchUtils

				.getEpocRootForProject(openProjectObject);

		String epocRootAsString = epocroot.toOSString();

		File platformDir = new File(epocRootAsString + EPOC32_INCLUDE_PLATFORM);

		File platformOpenSystemTraceFile = new File(platformDir,

				OPEN_SYSTEM_TRACE_H);

		if (platformOpenSystemTraceFile.exists()

				&& platformOpenSystemTraceFile.isFile()) {

			ostVersion = getOstVersion(platformOpenSystemTraceFile);

			// If OST version is not defined in opensystemtrace.h file then

			// default is 1.x.x

			if (ostVersion == null) {

				ostVersion = OST_VERSION_1_X_X;

			}

		} else {

			File internalDir = new File(epocRootAsString

					+ EPOC32_INCLUDE_INTERNAL);

			File internalOpenSystemTraceFile = new File(internalDir,

					OPEN_SYSTEM_TRACE_H);

			// If opensystemtrace.h file exist only in internal folder then

			// version is 1.x.x. In OSTv2 case opensystemtrace.h file should

			// newer exist only in internal folder, so it is enough that we

			// check version only from header in platform folder, because OSTv1

			// version of header does not contain version information.

			if (internalOpenSystemTraceFile.exists()

					&& internalOpenSystemTraceFile.isFile()) {

				ostVersion = OST_VERSION_1_X_X;

			} else {

				// If opensystemtrace.h file does not exist at all then default

				// is 2.x.x

				ostVersion = OST_VERSION_2_X_X;

			}

		}

		// Check is OST version 1.x.x in use. If it is then use OSTv1 otherwise

		// use OSTv2

		GroupNameHandlerBase groupNameHandler = TraceBuilderGlobals

				.getGroupNameHandler();

		if (ostVersion.startsWith(OSTV1_START_TEXT)) {

			if (!(groupNameHandler instanceof GroupNameHandlerOSTv1)) {