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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/*
* Copyright 2000-2014 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.psi.search.searches;
import com.intellij.openapi.components.ServiceManager;
import com.intellij.openapi.util.TextRange;
import com.intellij.psi.PsiFile;
import com.intellij.psi.search.IndexPattern;
import com.intellij.psi.search.IndexPatternOccurrence;
import com.intellij.psi.search.IndexPatternProvider;
import com.intellij.util.Query;
import com.intellij.util.QueryFactory;
import org.jetbrains.annotations.NotNull;
/**
* Allows to search for occurrences of specified regular expressions in the comments
* of Java source files.
*
* @author yole
* @since 5.1
* @see IndexPatternProvider
* @see com.intellij.psi.search.PsiTodoSearchHelper#findFilesWithTodoItems()
*/
public abstract class IndexPatternSearch extends QueryFactory<IndexPatternOccurrence, IndexPatternSearch.SearchParameters> {
public static IndexPatternSearch INDEX_PATTERN_SEARCH_INSTANCE = ServiceManager.getService(IndexPatternSearch.class);
public static class SearchParameters {
private final PsiFile myFile;
private final IndexPattern myPattern;
private final IndexPatternProvider myPatternProvider;
private final TextRange myRange;
public SearchParameters(@NotNull PsiFile file, @NotNull IndexPattern pattern) {
this(file, pattern,null);
}
public SearchParameters(@NotNull PsiFile file, @NotNull IndexPattern pattern, TextRange range) {
myFile = file;
myRange = range;
myPatternProvider = null;
myPattern = pattern;
}
public SearchParameters(@NotNull PsiFile file, @NotNull IndexPatternProvider patternProvider) {
this(file, patternProvider,null);
}
public SearchParameters(@NotNull PsiFile file, @NotNull IndexPatternProvider patternProvider, TextRange range) {
myFile = file;
myPatternProvider = patternProvider;
myRange = range;
myPattern = null;
}
@NotNull
public PsiFile getFile() {
return myFile;
}
public IndexPattern getPattern() {
return myPattern;
}
public IndexPatternProvider getPatternProvider() {
return myPatternProvider;
}
public TextRange getRange() {
return myRange;
}
}
protected IndexPatternSearch() {
}
/**
* Returns a query which can be used to process occurrences of the specified pattern
* in the specified file. The query is executed by parsing the contents of the file.
*
* @param file the file in which occurrences should be searched.
* @param pattern the pattern to search for.
* @return the query instance.
*/
@NotNull
public static Query<IndexPatternOccurrence> search(@NotNull PsiFile file, @NotNull IndexPattern pattern) {
final SearchParameters parameters = new SearchParameters(file, pattern);
return INDEX_PATTERN_SEARCH_INSTANCE.createQuery(parameters);
}
/**
* Returns a query which can be used to process occurrences of the specified pattern
* in the specified text range. The query is executed by parsing the contents of the file.
*
* @param file the file in which occurrences should be searched.
* @param pattern the pattern to search for.
* @param startOffset the start offset of the range to search.
* @param endOffset the end offset of the range to search.
* @return the query instance.
*/
@NotNull
public static Query<IndexPatternOccurrence> search(@NotNull PsiFile file,
@NotNull IndexPattern pattern,
int startOffset,
int endOffset) {
final SearchParameters parameters = new SearchParameters(file, pattern, new TextRange(startOffset, endOffset));
return INDEX_PATTERN_SEARCH_INSTANCE.createQuery(parameters);
}
/**
* Returns a query which can be used to process occurrences of any pattern from the
* specified provider in the specified file. The query is executed by parsing the
* contents of the file.
*
* @param file the file in which occurrences should be searched.
* @param patternProvider the provider the patterns from which are searched.
* @return the query instance.
*/
@NotNull
public static Query<IndexPatternOccurrence> search(@NotNull PsiFile file, @NotNull IndexPatternProvider patternProvider) {
final SearchParameters parameters = new SearchParameters(file, patternProvider);
return INDEX_PATTERN_SEARCH_INSTANCE.createQuery(parameters);
}
/**
* Returns a query which can be used to process occurrences of any pattern from the
* specified provider in the specified text range. The query is executed by parsing the
* contents of the file.
*
* @param file the file in which occurrences should be searched.
* @param patternProvider the provider the patterns from which are searched.
* @param startOffset the start offset of the range to search.
* @param endOffset the end offset of the range to search.
* @return the query instance.
*/
@NotNull
public static Query<IndexPatternOccurrence> search(@NotNull PsiFile file, @NotNull IndexPatternProvider patternProvider,
int startOffset, int endOffset) {
final SearchParameters parameters = new SearchParameters(file, patternProvider, new TextRange(startOffset, endOffset));
return INDEX_PATTERN_SEARCH_INSTANCE.createQuery(parameters);
}
/**
* Returns the number of occurrences of any pattern from the specified provider
* in the specified file. The returned value is taken from the index, and the file
* is not parsed.
*
* @param file the file in which occurrences should be searched.
* @param patternProvider the provider the patterns from which are searched.
* @return the number of pattern occurrences.
*/
public static int getOccurrencesCount(@NotNull PsiFile file, @NotNull IndexPatternProvider patternProvider) {
return INDEX_PATTERN_SEARCH_INSTANCE.getOccurrencesCountImpl(file, patternProvider);
}
/**
* Returns the number of occurrences of the specified pattern
* in the specified file. The returned value is taken from the index, and the file
* is not parsed.
*
* @param file the file in which occurrences should be searched.
* @param pattern the pattern to search for.
* @return the number of pattern occurrences.
*/
public static int getOccurrencesCount(@NotNull PsiFile file, @NotNull IndexPattern pattern) {
return INDEX_PATTERN_SEARCH_INSTANCE.getOccurrencesCountImpl(file, pattern);
}
protected abstract int getOccurrencesCountImpl(@NotNull PsiFile file, @NotNull IndexPatternProvider provider);
protected abstract int getOccurrencesCountImpl(@NotNull PsiFile file, @NotNull IndexPattern pattern);
}
|
