tools/pldt/org.eclipse.ptp.pldt.mpi.core/src/org/eclipse/ptp/pldt/mpi/core/analysis/MpiCASTVisitor.java

/**********************************************************************
 * Copyright (c) 2005, 2008 IBM Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ptp.pldt.mpi.core.analysis;

import java.util.List;

import org.eclipse.cdt.core.dom.ast.IASTExpression;
import org.eclipse.cdt.core.dom.ast.IASTFunctionCallExpression;
import org.eclipse.cdt.core.dom.ast.IASTIdExpression;
import org.eclipse.cdt.core.dom.ast.IASTLiteralExpression;
import org.eclipse.cdt.core.dom.ast.IASTName;
import org.eclipse.cdt.core.dom.ast.IBinding;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.ptp.pldt.common.CommonPlugin;
import org.eclipse.ptp.pldt.common.ScanReturn;
import org.eclipse.ptp.pldt.common.analysis.PldtAstVisitor;
import org.eclipse.ptp.pldt.mpi.core.Messages;
import org.eclipse.ptp.pldt.mpi.core.MpiIDs;
import org.eclipse.ptp.pldt.mpi.core.MpiPlugin;

/**
 * This dom-walker collects "artifacts" related to the specific domain <br>
 * (e.g. MPI, OpenMP, etc.). Currently these artifacts include function calls
 * and constants. It adds markers to the source file for C code, marking the
 * position of the artifacts found.
 * 
 * @author Beth Tibbitts
 * 
 */
public class MpiCASTVisitor extends PldtAstVisitor {
	private static final String PREFIX = "MPI_"; //$NON-NLS-1$

	private static/* final */boolean traceOn = false;

	{
		this.shouldVisitExpressions = true;
		this.shouldVisitStatements = true;
		this.shouldVisitDeclarations = true;
		this.shouldVisitTranslationUnit = true;
	}

	@SuppressWarnings("unchecked")
	public MpiCASTVisitor(List mpiIncludes, String fileName, boolean allowPrefixOnlyMatch, ScanReturn msr) {
		super(mpiIncludes, fileName, allowPrefixOnlyMatch, msr);
		ARTIFACT_CALL = Messages.getString("MpiCASTVisitor.mpiCall"); //$NON-NLS-1$
		ARTIFACT_CONSTANT = Messages.getString("MpiCASTVisitor.mpiConstant"); //$NON-NLS-1$
		ARTIFACT_NAME="MPI"; //$NON-NLS-1$

		traceOn = CommonPlugin.getTraceOn();
		if (traceOn)
			System.out.println("MpiCASTVisitor.ctor: traceOn=" + traceOn); //$NON-NLS-1$

	}

	/**
	 * Visit an expression node.
	 * 
	 * @see org.eclipse.cdt.core.dom.ast.ASTVisitor#visit(org.eclipse.cdt.core.dom.ast.IASTExpression)
	 */
	public int visit(IASTExpression expression) {
		if (expression instanceof IASTFunctionCallExpression) {
			// in stdmake this is a CASTFunctionCallExpression but implements
			// IASTFUnctionCallExpr, so ok
			IASTExpression astExpr = ((IASTFunctionCallExpression) expression)
					.getFunctionNameExpression();
			String signature = astExpr.getRawSignature();
			// note: getRawSig is the name BEFORE being processed by
			// preprocessor!
			// but it seems to be empty if it's different.
			// IASTFunctionCallExpression
			// fce=(IASTFunctionCallExpression)expression;
			// IASTExpression fne=fce.getFunctionNameExpression();

			// can we get post-pre-processor name here?
			if (astExpr instanceof IASTIdExpression) {
				IASTName tempFN = ((IASTIdExpression) astExpr).getName();
				IBinding tempBIND = tempFN.resolveBinding();
				String tempNAME = tempBIND.getName();
				if (traceOn)
					System.out
							.println("MCAV name: " + tempNAME + " rawsig: " + signature); //$NON-NLS-1$ //$NON-NLS-2$
				// if e.g. preprocessor substitution used, use that for function
				// name
				boolean preProcUsed = !signature.equals(tempNAME);
				if (preProcUsed) {
					signature = tempNAME;
				}
			}
			if (signature.startsWith(PREFIX)) {
				if (astExpr instanceof IASTIdExpression) {
					IASTName funcName = ((IASTIdExpression) astExpr).getName();
					// IBinding binding = funcName.resolveBinding();
					// String name=binding.getName();// name ok for stdMake
					processFuncName(funcName, astExpr);
				}
			}
		} else if (expression instanceof IASTLiteralExpression) {
			processMacroLiteral((IASTLiteralExpression) expression);
		} else {
			// Other possibilities? Do we care? Assume not.
			// if(expression instanceof CASTUnaryExpression)
			// if(expression instanceof CASTIdExpression)

		}
		return PROCESS_CONTINUE;
	}

	/**
	 * allow dynamic adding to include path?
	 * <br>Note: if this returns true, be certain to override getIncludesPrefID() and
	 * getPreferenceStore() which will be needed by the implementation to do this
	 * 
	 * @return
	 */
	@Override
	public boolean allowIncludePathAdd() {
		boolean canAsk = getPreferenceStore().getBoolean(MpiIDs.MPI_PROMPT_FOR_OTHER_INCLUDES);
		return canAsk;
	}
	/**
	 * needs to be overridden for derived classes that need to dynamically update the pref store 
	 * e.g. for the includes path
	 * @return
	 */
	@Override
	protected String getIncludesPrefID() {
		return MpiIDs.MPI_INCLUDES;
	}
	/**
	 * needs to be overridden for derived classes that need to dynamically update the pref store 
	 * e.g. for the includes path
	 * @return
	 */
	@Override
	protected IPreferenceStore getPreferenceStore() {
		return MpiPlugin.getDefault().getPreferenceStore();
	}

	/**
	 * needs to be overridden for derived classes that need to dynamically update the pref store 
	 * e.g. for the includes path.  This type name is used for messages, etc.
	 * @return artifact type name such as "MPI", "OpenMP" etc.
	 */	
	@Override
	protected String getTypeName() {
		return ARTIFACT_NAME;
	}

}