← Back to branch summary

~ubuntu-branches/debian/sid/eclipse-cdt/sid

« back to all changes in this revision

Viewing changes to core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/IIndexMacro.java

  • Committer: Package Import Robot
  • Author(s): Jakub Adam
  • Date: 2011-10-06 21:15:04 UTC
  • mfrom: (1.1.4)
  • Revision ID: package-import@ubuntu.com-20111006211504-8dutmljjih0zikfv
Tags: 8.0.1-1
* New upstream release.
* Split the JNI packages into a separate architecture dependent
  package and made eclipse-cdt architecture independent.
* Install JNI libraries into multiarch aware location
* Bumped Standards-Version to 3.9.2.

Show diffs side-by-side

added added

removed removed

Lines of Context:
core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/IIndexMacro.java
 
1
/*******************************************************************************
 
2
 * Copyright (c) 2006, 2009 Wind River Systems, Inc. and others.
 
3
 * All rights reserved. This program and the accompanying materials
 
4
 * are made available under the terms of the Eclipse Public License v1.0
 
5
 * which accompanies this distribution, and is available at
 
6
 * http://www.eclipse.org/legal/epl-v10.html
 
7
 *
 
8
 * Contributors:
 
9
 *    Markus Schorn - initial API and implementation
 
10
 *******************************************************************************/
 
11
 
 
12
package org.eclipse.cdt.core.index;
 
13
 
 
14
import org.eclipse.cdt.core.dom.ast.IASTFileLocation;
 
15
import org.eclipse.cdt.core.dom.ast.IMacroBinding;
 
16
import org.eclipse.core.runtime.CoreException;
 
17
 
 
18
/**
 
19
 * Represents a macro stored in the index. 
 
20
 * 
 
21
 * @since 4.0
 
22
 * @noextend This interface is not intended to be extended by clients.
 
23
 * @noimplement This interface is not intended to be implemented by clients.
 
24
 */
 
25
public interface IIndexMacro extends IMacroBinding, IIndexBinding {
 
26
        
 
27
        IIndexMacro[] EMPTY_INDEX_MACRO_ARRAY = new IIndexMacro[0];
 
28
 
 
29
        /**
 
30
         * If available, return the file location for the macro definition of this macro,
 
31
         * otherwise return <code>null</code>.
 
32
         */
 
33
        IASTFileLocation getFileLocation() throws CoreException;
 
34
        
 
35
        /**
 
36
         * Returns the file in which this macro is defined and belongs to.
 
37
         * @throws CoreException 
 
38
         */
 
39
        IIndexFile getFile() throws CoreException;
 
40
 
 
41
        /**
 
42
         * Returns the name of the definition of this macro, or <code>null</code> if not available.
 
43
         * @throws CoreException 
 
44
         * @since 5.0
 
45
         */
 
46
        IIndexName getDefinition() throws CoreException;
 
47
}