1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*******************************************************************************
* Copyright (c) 2006, 2007 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
* Bryan Wilkinson (QNX)
* Andrew Ferguson (Symbian)
*******************************************************************************/
package org.eclipse.cdt.internal.core.index;
import java.util.regex.Pattern;
import org.eclipse.cdt.core.dom.ast.IASTName;
import org.eclipse.cdt.core.dom.ast.IBinding;
import org.eclipse.cdt.core.index.IIndex;
import org.eclipse.cdt.core.index.IIndexFileLocation;
import org.eclipse.cdt.core.index.IIndexLinkage;
import org.eclipse.cdt.core.index.IndexFilter;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
/**
* Interface for the implementation of the actual index storage mechanism.
*
* @since 4.0
*/
public interface IIndexFragment {
/**
* @see IIndex#FIND_DECLARATIONS
*/
final int FIND_DECLARATIONS = IIndex.FIND_DECLARATIONS;
/**
* @see IIndex#FIND_DEFINITIONS
*/
final int FIND_DEFINITIONS = IIndex.FIND_DEFINITIONS;
/**
* @see IIndex#FIND_REFERENCES
*/
final int FIND_REFERENCES = IIndex.FIND_REFERENCES;
/**
* @see IIndex#FIND_DECLARATIONS_DEFINITIONS
*/
final int FIND_DECLARATIONS_DEFINITIONS = IIndex.FIND_DECLARATIONS_DEFINITIONS;
/**
* @see IIndex#FIND_ALL_OCCURENCES
*/
final int FIND_ALL_OCCURENCES = IIndex.FIND_ALL_OCCURENCES;
/**
* Returns the file for the given location. May return <code>null</code>, if no such file exists.
* This method may only return files that are actually managed by this fragement.
* @param location the IIndexFileLocation representing the location of the file
* @return the file for the location
* @throws CoreException
*/
IIndexFragmentFile getFile(IIndexFileLocation location) throws CoreException;
/**
* Returns all include directives that point to the given file. The input file may belong to
* another fragment. All of the include directives returned must belong to files managed by
* this fragment.
* @param file a file to search for includes pointing to it
* @return an array of inlucde directives managed by this fragment
* @throws CoreException
*/
IIndexFragmentInclude[] findIncludedBy(IIndexFragmentFile file) throws CoreException;
/**
* Looks for a binding matching the given one. May return <code>null</code>, if no
* such binding exists. The binding may belong to an AST or another index fragment.
* @param binding the binding to look for.
* @return the binding, or <code>null</code>
* @throws CoreException
*/
IIndexFragmentBinding adaptBinding(IBinding binding) throws CoreException;
/**
* Looks for a proxy binding matching the given one. May return <code>null</code>, if no
* such binding exists. The binding may belong to another index fragment.
* @param proxy the binding to look for.
* @return the binding, or <code>null</code>
* @throws CoreException
*/
IIndexFragmentBinding adaptBinding(IIndexFragmentBinding proxy) throws CoreException;
/**
* Looks for a binding of the given name from the AST. May return <code>null</code>, if no
* such binding exists.
* @param astName the name for looking up the binding
* @return the binding for the name, or <code>null</code>
* @throws CoreException
*/
IIndexFragmentBinding findBinding(IASTName astName) throws CoreException;
/**
* Searches for all bindings with qualified names that seen as an array of simple names match the given array
* of patterns. In case a binding exists in multiple projects, no duplicate bindings are returned.
* You can search with an array of patterns that specifies a partial qualification only.
* @param patterns an array of patterns the names of the qualified name of the bindings have to match.
* @param isFullyQualified if <code>true</code>, the array of pattern specifies the fully qualified name
* @param filter a filter that allows for skipping parts of the index
* @param monitor a monitor to report progress
* @return an array of bindings matching the pattern
* @throws CoreException
*/
IIndexFragmentBinding[] findBindings(Pattern[] patterns, boolean isFullyQualified, IndexFilter filter, IProgressMonitor monitor) throws CoreException;
/**
* Searches for all bindings with qualified names that seen as an array of simple names equals
* the given array of names.
* @param names an array of names the qualified name of the bindings have to match.
* @param filter a filter that allows for skipping parts of the index
* @param monitor a monitor to report progress
* @return an array of bindings matching the pattern
* @throws CoreException
*/
IIndexFragmentBinding[] findBindings(char[][] names, IndexFilter filter, IProgressMonitor monitor) throws CoreException;
/**
* Searches for all names that resolve to the given binding. You can limit the result to references, declarations
* or definitions, or a combination of those.
* @param binding a binding for which names are searched for
* @param flags a combination of {@link #FIND_DECLARATIONS}, {@link #FIND_DEFINITIONS} and {@link #FIND_REFERENCES}
* @return an array of names
* @throws CoreException
*/
IIndexFragmentName[] findNames(IIndexFragmentBinding binding, int flags) throws CoreException;
/**
* Acquires a read lock.
* @throws InterruptedException
*/
void acquireReadLock() throws InterruptedException;
/**
* Releases a read lock.
*/
void releaseReadLock();
/**
* Returns the timestamp of the last modification to the index.
*/
long getLastWriteAccess();
/**
* Returns all bindings with the given prefix, accepted by the given filter
*/
IIndexFragmentBinding[] findBindingsForPrefix(char[] prefix, IndexFilter filter, boolean caseSensitive) throws CoreException;
/**
* Returns the linkages that are contained in this fragment
* @return
*/
IIndexLinkage[] getLinkages();
}
|
