~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/dom/ast/IASTPreprocessorIncludeStatement.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:
 
1
/*******************************************************************************
 
2
 * Copyright (c) 2004, 2009 IBM Corporation 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
 *    IBM - Initial API and implementation
 
10
 *    Markus Schorn (Wind River Systems)
 
11
 *******************************************************************************/
 
12
package org.eclipse.cdt.core.dom.ast;
 
13
 
 
14
/**
 
15
 * This interface represent a preprocessor #include statement.
 
16
 * 
 
17
 * @noextend This interface is not intended to be extended by clients.
 
18
 * @noimplement This interface is not intended to be implemented by clients.
 
19
 */
 
20
public interface IASTPreprocessorIncludeStatement extends
 
21
                IASTPreprocessorStatement {
 
22
 
 
23
        /**
 
24
         * <code>INCLUDE_NAME</code> describes the relationship between an include directive and
 
25
         * it's name.
 
26
         */
 
27
        public static final ASTNodeProperty INCLUDE_NAME = new ASTNodeProperty(
 
28
                        "IASTPreprocessorMacroDefinition.INCLUDE_NAME - Include Name"); //$NON-NLS-1$
 
29
 
 
30
 
 
31
        /**
 
32
         * Returns the absolute location of the file found through #include.
 
33
         * Only valid if {@link #isResolved()} returns <code>true</code>.
 
34
         */
 
35
        public String getPath();
 
36
        
 
37
        /**
 
38
         * Returns the name of the file as specified in the directive. Does not include quotes or
 
39
         * angle brackets.
 
40
         * @since 4.0
 
41
         */
 
42
        public IASTName getName();
 
43
        
 
44
        /**
 
45
         * Returns whether this is a system include (one specified with angle brackets).
 
46
         * @since 4.0
 
47
         */
 
48
        public boolean isSystemInclude();
 
49
 
 
50
        /**
 
51
         * Returns whether this include directive was actually taken.
 
52
         * @since 4.0
 
53
         */
 
54
        public boolean isActive();
 
55
 
 
56
        /**
 
57
         * Returns whether this include file was successfully resolved.
 
58
         * @since 4.0
 
59
         */
 
60
        public boolean isResolved();
 
61
        
 
62
        /**
 
63
         * Returns whether the inclusion was resolved using a heuristics.
 
64
         * @since 5.1
 
65
         */
 
66
        public boolean isResolvedByHeuristics();
 
67
}