| /******************************************************************************* |
| * Copyright (c) 2000, 2006 IBM Corporation 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: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| |
| package org.eclipse.search.core.text; |
| |
| import java.util.regex.Pattern; |
| |
| import org.eclipse.core.runtime.IProgressMonitor; |
| import org.eclipse.core.runtime.IStatus; |
| |
| import org.eclipse.core.resources.IFile; |
| |
| import org.eclipse.search.internal.core.text.TextSearchVisitor; |
| import org.eclipse.search.internal.ui.SearchPlugin; |
| |
| /** |
| * A {@link TextSearchEngine} searches the content of a workspace file resources |
| * for matches to a given search pattern. |
| * <p> |
| * {@link #create()} gives access to an instance of the search engine. By default this is the default |
| * text search engine (see {@link #createDefault()}) but extensions can offer more sophisticated |
| * search engine implementations. |
| * </p> |
| * @since 3.2 |
| */ |
| public abstract class TextSearchEngine { |
| |
| /** |
| * Creates an instance of the search engine. By default this is the default text search engine (see {@link #createDefault()}), |
| * but extensions can offer more sophisticated search engine implementations. |
| * @return the created {@link TextSearchEngine}. |
| */ |
| public static TextSearchEngine create() { |
| return SearchPlugin.getDefault().getTextSearchEngineRegistry().getPreferred(); |
| } |
| |
| /** |
| * Creates the default, built-in, text search engine that implements a brute-force search, not using |
| * any search index. |
| * Note that clients should always use the search engine provided by {@link #create()}. |
| * @return an instance of the default text search engine {@link TextSearchEngine}. |
| */ |
| public static TextSearchEngine createDefault() { |
| return new TextSearchEngine() { |
| public IStatus search(TextSearchScope scope, TextSearchRequestor requestor, Pattern searchPattern, IProgressMonitor monitor) { |
| return new TextSearchVisitor(requestor, searchPattern).search(scope, monitor); |
| } |
| |
| public IStatus search(IFile[] scope, TextSearchRequestor requestor, Pattern searchPattern, IProgressMonitor monitor) { |
| return new TextSearchVisitor(requestor, searchPattern).search(scope, monitor); |
| } |
| }; |
| } |
| |
| /** |
| * Uses a given search pattern to find matches in the content of workspace file resources. If a file is open in an editor, the |
| * editor buffer is searched. |
| |
| * @param requestor the search requestor that gets the search results |
| * @param scope the scope defining the resources to search in |
| * @param searchPattern The search pattern used to find matches in the file contents. |
| * @param monitor the progress monitor to use |
| * @return the status containing information about problems in resources searched. |
| */ |
| public abstract IStatus search(TextSearchScope scope, TextSearchRequestor requestor, Pattern searchPattern, IProgressMonitor monitor); |
| |
| /** |
| * Uses a given search pattern to find matches in the content of workspace file resources. If a file is open in an editor, the |
| * editor buffer is searched. |
| |
| * @param requestor the search requestor that gets the search results |
| * @param scope the files to search in |
| * @param searchPattern The search pattern used to find matches in the file contents. |
| * @param monitor the progress monitor to use |
| * @return the status containing information about problems in resources searched. |
| */ |
| public abstract IStatus search(IFile[] scope, TextSearchRequestor requestor, Pattern searchPattern, IProgressMonitor monitor); |
| |
| } |