/*******************************************************************************
* Copyright (c) 2008, 2014 Wind River Systems, Inc. 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:
* Markus Schorn - initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.core.dom.ast.cpp;
/**
* Models the mapping of template parameters to values, or pack-expansions.
*
* @since 5.1
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ICPPTemplateParameterMap {
/**
* Returns the value for the template parameter with the given id.
* @see ICPPTemplateParameter#getParameterID()
*/
public ICPPTemplateArgument getArgument(int paramID);
/**
* Returns the value for the template parameter in the map, or {@code null} if
* the parameter is not mapped or the parameter is a parameter pack.
*/
public ICPPTemplateArgument getArgument(ICPPTemplateParameter param);
/**
* Returns the values for the template parameter pack with the given id in the map,
* or {@code null} if the parameter is not mapped or is not a parameter pack.
* @since 5.2
*/
public ICPPTemplateArgument[] getPackExpansion(int paramID);
/**
* Returns the values for the template parameter pack in the map, or {@code null} if the
* parameter is not mapped or is no parameter pack.
* @since 5.2
*/
public ICPPTemplateArgument[] getPackExpansion(ICPPTemplateParameter param);
/**
* If 'param' is not a parameter pack, returns the value for 'param' in the map.
* If 'param' is a parameter pack, returns the value at position 'packOffset'
* in the pack of values for 'param' in the map.
* Returns {@code null} is 'param' is not mapped.
* @since 5.5
*/
public ICPPTemplateArgument getArgument(ICPPTemplateParameter param, int packOffset);
/**
* Returns the array of template parameter positions, for which a mapping exists.
*/
Integer[] getAllParameterPositions();
}