| /* |
| * Copyright 2000-2011 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; |
| |
| import com.intellij.openapi.components.ServiceManager; |
| import com.intellij.openapi.project.Project; |
| import com.intellij.psi.PsiFile; |
| import org.jetbrains.annotations.NotNull; |
| |
| /** |
| * @author irengrig |
| * Date: 2/24/11 |
| * Time: 10:08 AM |
| */ |
| public interface PsiTodoSearchHelper { |
| class SERVICE { |
| private SERVICE() { |
| } |
| |
| public static PsiTodoSearchHelper getInstance(Project project) { |
| return ServiceManager.getService(project, PsiTodoSearchHelper.class); |
| } |
| } |
| |
| /** |
| * Returns the list of all files in the project which have to do items. |
| * |
| * @return the list of files with to do items. |
| */ |
| @NotNull |
| PsiFile[] findFilesWithTodoItems(); |
| |
| /** |
| * Searches the specified file for to do items. |
| * |
| * @param file the file to search for to do items. |
| * @return the array of found items. |
| */ |
| @NotNull |
| TodoItem[] findTodoItems(@NotNull PsiFile file); |
| |
| /** |
| * Searches the specified range of text in the specified file for to do items. |
| * |
| * @param file the file to search for to do items. |
| * @param startOffset the start offset of the text range to search to do items in. |
| * @param endOffset the end offset of the text range to search to do items in. |
| * @return the array of found items. |
| */ |
| @NotNull |
| TodoItem[] findTodoItems(@NotNull PsiFile file, int startOffset, int endOffset); |
| |
| @NotNull |
| TodoItem[] findTodoItemsLight(@NotNull PsiFile file); |
| @NotNull |
| TodoItem[] findTodoItemsLight(@NotNull PsiFile file, int startOffset, int endOffset); |
| |
| /** |
| * Returns the number of to do items in the specified file. |
| * |
| * @param file the file to return the to do count for. |
| * @return the count of to do items in the file. |
| */ |
| int getTodoItemsCount(@NotNull PsiFile file); |
| |
| /** |
| * Returns the number of to do items matching the specified pattern in the specified file. |
| * |
| * @param file the file to return the to do count for. |
| * @param pattern the pattern of to do items to find. |
| * @return the count of to do items in the file. |
| */ |
| int getTodoItemsCount(@NotNull PsiFile file, @NotNull TodoPattern pattern); |
| } |