/*******************************************************************************
* Copyright (c) 2004, 2009 IBM Corporation and others.
* 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 - Initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.core.dom;
import org.eclipse.cdt.core.dom.ast.IASTCompletionNode;
import org.eclipse.cdt.core.dom.ast.IASTTranslationUnit;
import org.eclipse.cdt.core.model.IWorkingCopyProvider;
import org.eclipse.cdt.internal.core.dom.InternalASTServiceProvider;
import org.eclipse.cdt.internal.core.dom.PartialWorkingCopyCodeReaderFactory;
import org.eclipse.cdt.internal.core.dom.SavedCodeReaderFactory;
import org.eclipse.cdt.internal.core.dom.WorkingCopyCodeReaderFactory;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IStorage;
/**
* @author jcamelon
*
* This class serves as the manager of the AST/DOM mechanisms for the CDT.
* It should be eventually added to CCorePlugin for startup.
*
* @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
* @deprecated This class does not take into account language mappings. Use
* org.eclipse.cdt.core.model.ILanguage instead.
*/
@Deprecated
public class CDOM implements IASTServiceProvider {
/**
* Singleton - Constructor is private.
*/
private CDOM()
{
}
/**
* <code>instance</code> is the singleton.
*/
private static CDOM instance = new CDOM();
/**
* accessor for singleton instance
* @return instance
*/
public static CDOM getInstance()
{
return instance;
}
/**
* Currently, only one AST Service is provided.
*/
private IASTServiceProvider defaultService = new InternalASTServiceProvider();
/**
* @return IASTServiceProvider, the mechanism for obtaining an AST
*/
public IASTServiceProvider getASTService() {
//CDOM itself is not so much "the" AST service as it acts as a proxy
//to different AST services
//Should we see the need to provide an extension point for this
//rather than purely proxying the calls to IASTServiceProvider#*
//we would have to do some discovery and co-ordination on behalf of the
//client
return this;
}
/**
* Constant <code>PARSE_SAVED_RESOURCES</code> - Parse saved resources in the workspace
*/
public static final int PARSE_SAVED_RESOURCES = 0;
/**
* Constant <code>PARSE_WORKING_COPY_WITH_SAVED_INCLUSIONS</code> - Parse working copy for
* translation unit, saved resources for all header files.
*/
public static final int PARSE_WORKING_COPY_WITH_SAVED_INCLUSIONS = 1;
/**
* Constant <code>PARSE_WORKING_COPY_WHENEVER_POSSIBLE</code> - Parse working copy whenever possible for both
* header files and the file in question as a translation unit.
*/
public static final int PARSE_WORKING_COPY_WHENEVER_POSSIBLE = 2;
/**
* <code>provider</code> is registered by the UI as a IWorkingCopyProvider.
*/
private IWorkingCopyProvider provider;
/**
* This is the factory function that returns an ICodeReaderFactory instance based upon the key provided.
*
* @param key one of PARSE_SAVED_RESOURCES, PARSE_WORKING_COPY_WITH_SAVED_INCLUSIONS, PARSE_WORKING_COPY_WHENEVER_POSSIBLE
* @return an implementation that works according to the key specified or null for an invalid key
*/
public ICodeReaderFactory getCodeReaderFactory( int key )
{
//TODO - eventually these factories will need to hook into the
//CodeReader caches
switch( key )
{
case PARSE_SAVED_RESOURCES:
return SavedCodeReaderFactory.getInstance();
case PARSE_WORKING_COPY_WITH_SAVED_INCLUSIONS:
return new PartialWorkingCopyCodeReaderFactory(provider, null);
case PARSE_WORKING_COPY_WHENEVER_POSSIBLE:
return new WorkingCopyCodeReaderFactory( provider, null );
}
return null;
}
/* (non-Javadoc)
* @see org.eclipse.cdt.core.dom.IASTServiceProvider#getTranslationUnit(org.eclipse.core.resources.IFile)
*/
public IASTTranslationUnit getTranslationUnit(IFile fileToParse) throws UnsupportedDialectException {
//TODO - At this time, we purely delegate blindly
//In the future, we may need to delegate based upon context provided
return defaultService.getTranslationUnit(fileToParse);
}
/* (non-Javadoc)
* @see org.eclipse.cdt.core.dom.IASTServiceProvider#getTranslationUnit(org.eclipse.core.resources.IFile, org.eclipse.cdt.core.dom.ICodeReaderFactory)
*/
public IASTTranslationUnit getTranslationUnit(IFile fileToParse, ICodeReaderFactory fileCreator) throws UnsupportedDialectException {
//TODO - At this time, we purely delegate blindly
//In the future, we may need to delegate based upon context provided
return defaultService.getTranslationUnit(fileToParse, fileCreator );
}
/* (non-Javadoc)
* @see org.eclipse.cdt.core.dom.IASTServiceProvider#getTranslationUnit(org.eclipse.core.resources.IFile, org.eclipse.cdt.core.dom.ICodeReaderFactory, org.eclipse.cdt.core.dom.IParserConfiguration)
*/
public IASTTranslationUnit getTranslationUnit(IFile fileToParse, ICodeReaderFactory fileCreator, IParserConfiguration configuration) throws UnsupportedDialectException {
//TODO - At this time, we purely delegate blindly
//In the future, we may need to delegate based upon context provided
return defaultService.getTranslationUnit(fileToParse, fileCreator, configuration );
}
public IASTCompletionNode getCompletionNode(IFile fileToParse, int offset,
ICodeReaderFactory fileCreator) throws UnsupportedDialectException {
//TODO - At this time, we purely delegate blindly
//In the future, we may need to delegate based upon context provided
return defaultService.getCompletionNode(fileToParse, offset, fileCreator);
}
public IASTCompletionNode getCompletionNode(IStorage fileToParse, IProject project, int offset,
ICodeReaderFactory fileCreator) throws UnsupportedDialectException {
//TODO - At this time, we purely delegate blindly
//In the future, we may need to delegate based upon context provided
return defaultService.getCompletionNode(fileToParse, project, offset, fileCreator);
}
/**
* This method allows a UI component to register its IWorkingCopyProvider to the CDOM.
*
* @param workingCopyProvider - UI components buffer manager
*/
public void setWorkingCopyProvider(IWorkingCopyProvider workingCopyProvider) {
this.provider = workingCopyProvider;
}
public IASTTranslationUnit getTranslationUnit(IStorage fileToParse, IProject project, ICodeReaderFactory fileCreator) throws UnsupportedDialectException {
return defaultService.getTranslationUnit( fileToParse, project, fileCreator );
}
public IASTTranslationUnit getTranslationUnit(IStorage fileToParse, IProject project) throws UnsupportedDialectException {
return defaultService.getTranslationUnit( fileToParse, project );
}
public IASTTranslationUnit getTranslationUnit(IFile fileToParse, boolean parseComments) throws UnsupportedDialectException {
return defaultService.getTranslationUnit(fileToParse, parseComments);
}
public IASTTranslationUnit getTranslationUnit(IFile fileToParse, ICodeReaderFactory fileCreator, boolean parseComments) throws UnsupportedDialectException {
return defaultService.getTranslationUnit(fileToParse, fileCreator, parseComments);
}
}