org.fife.ui.search.RegexAwareComboBox Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rtext Show documentation
Show all versions of rtext Show documentation
RText is a powerful, cross-platform programmer's text editor written in Java. It is designed
to be easy to use, highly customizable and flexible. Part of RText's design is for the source code
to be simple, easy to understand, and well documented, so that other programmers can look into its
inner-workings and figure out how RText ticks with ease. A good place to start (besides the source
code) is the Javadoc for all classes used in the project.
/*
* 01/12/2009
*
* RegexAwareComboBox.java - A combo box that offers autocomplete assistance
* for regular expressions.
* Copyright (C) 2009 Robert Futrell
* robert_futrell at users.sourceforge.net
* http://fifesoft.com
*
* This file is a part of RText.
*
* RText is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or any later version.
*
* RText is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
package org.fife.ui.search;
import java.awt.Component;
import javax.swing.ComboBoxModel;
import javax.swing.DefaultListCellRenderer;
import javax.swing.JList;
import javax.swing.text.JTextComponent;
import org.fife.rtext.ContentAssistable;
import org.fife.ui.MaxWidthComboBox;
import org.fife.ui.RComboBoxModel;
import org.fife.ui.autocomplete.AutoCompletion;
import org.fife.ui.autocomplete.BasicCompletion;
import org.fife.ui.autocomplete.CompletionProvider;
import org.fife.ui.autocomplete.DefaultCompletionProvider;
/**
* A combo box that offers content assistance for regular expressions.
*
* @author Robert Futrell
* @version 1.0
*/
class RegexAwareComboBox extends MaxWidthComboBox implements ContentAssistable {
private boolean enabled;
private boolean replace;
private AutoCompletion ac;
private RegexAwareProvider provider;
/**
* Constructor.
*
* @param replace Whether this is a "replace" combo box (as opposed to a
* "find" combo box). This dictates what auto-complete choices the
* user is offered.
*/
public RegexAwareComboBox(boolean replace) {
this(new RComboBoxModel(), 200, replace);
}
/**
* Constructor.
*/
public RegexAwareComboBox(ComboBoxModel model, int maxWidth,
boolean replace) {
super(model, maxWidth);
setEditable(true);
this.replace = replace;
}
/**
* Adds the completion choices for regexes in a "find" text field.
*
* @param p The completion provider to add to.
* @see #addReplaceFieldCompletions(RegexAwareProvider)
*/
private void addFindFieldCompletions(RegexAwareProvider p) {
// Characters
p.addCompletion(new RegexCompletion(p, "\\\\", "\\\\", "\\\\ - Backslash"));
p.addCompletion(new RegexCompletion(p, "\\t", "\\t", "\\t - Tab"));
p.addCompletion(new RegexCompletion(p, "\\n", "\\n", "\\n - Newline"));
// Character classes
p.addCompletion(new RegexCompletion(p, "[", "[", "[abc] - Any of a, b, or c"));
p.addCompletion(new RegexCompletion(p, "[^", "[^", "[^abc] - Any character except a, b, or c"));
// Predefined character classes
p.addCompletion(new RegexCompletion(p, ".", ".", ". - Any character"));
p.addCompletion(new RegexCompletion(p, "\\d", "\\d", "\\d - A digit"));
p.addCompletion(new RegexCompletion(p, "\\D", "\\D", "\\D - Not a digit"));
p.addCompletion(new RegexCompletion(p, "\\s", "\\s", "\\s - A whitespace"));
p.addCompletion(new RegexCompletion(p, "\\S", "\\S", "\\S - Not a whitespace"));
p.addCompletion(new RegexCompletion(p, "\\w", "\\w", "\\w - An alphanumeric (word character)"));
p.addCompletion(new RegexCompletion(p, "\\W", "\\W", "\\W - Not an alphanumeric"));
// Boundary matchers
p.addCompletion(new RegexCompletion(p, "^", "^", "^ - Line Start"));
p.addCompletion(new RegexCompletion(p, "$", "$", "$ - Line End"));
p.addCompletion(new RegexCompletion(p, "\\b", "\b", "\\b - Word beginning or end"));
p.addCompletion(new RegexCompletion(p, "\\B", "\\B", "\\B - Not a word beginning or end"));
// Greedy, reluctant and possessive quantifiers
p.addCompletion(new RegexCompletion(p, "?", "?", "X? - Greedy match, 0 or 1 times"));
p.addCompletion(new RegexCompletion(p, "*", "*", "X* - Greedy match, 0 or more times"));
p.addCompletion(new RegexCompletion(p, "+", "+", "X+ - Greedy match, 1 or more times"));
p.addCompletion(new RegexCompletion(p, "{", "{", "X{n} - Greedy match, exactly n times"));
p.addCompletion(new RegexCompletion(p, "{", "{", "X{n,} - Greedy match, at least n times"));
p.addCompletion(new RegexCompletion(p, "{", "{", "X{n,m} - Greedy match, at least n but no more than m times"));
p.addCompletion(new RegexCompletion(p, "??", "??", "X?? - Lazy match, 0 or 1 times"));
p.addCompletion(new RegexCompletion(p, "*?", "*?", "X*? - Lazy match, 0 or more times"));
p.addCompletion(new RegexCompletion(p, "+?", "+?", "X+? - Lazy match, 1 or more times"));
p.addCompletion(new RegexCompletion(p, "?+", "?+", "X?+ - Possessive match, 0 or 1 times"));
p.addCompletion(new RegexCompletion(p, "*+", "*+", "X*+ - Possessive match, 0 or more times"));
p.addCompletion(new RegexCompletion(p, "++", "++", "X++ - Possessive match, 0 or more times"));
// Back references
p.addCompletion(new RegexCompletion(p, "\\i", "\\i", "\\i - Match of the capturing group i"));
// Capturing groups
p.addCompletion(new RegexCompletion(p, "(", "(", "(Expr) - Mark Expr as capturing group"));
p.addCompletion(new RegexCompletion(p, "(?:", "(?:", "(?:Expr) - Non-capturing group"));
}
/**
* Adds the completion choices for regexes in a "replace with" text field.
*
* @param p The completion provider to add to.
* @see #addFindFieldCompletions(RegexAwareProvider)
*/
private void addReplaceFieldCompletions(RegexAwareProvider p) {
p.addCompletion(new RegexCompletion(p, "$", "$", "$i - Match of the capturing group i"));
p.addCompletion(new RegexCompletion(p, "\\", "\\", "\\ - Quote next character"));
p.addCompletion(new RegexCompletion(p, "\\t", "\\t", "\\t - Tab"));
p.addCompletion(new RegexCompletion(p, "\\n", "\\n", "\\n - Newline"));
}
/**
* Lazily creates the AutoCompletion instance this combo box uses.
*
* @return The auto-completion instance.
*/
private AutoCompletion getAutoCompletion() {
if (ac==null) {
ac = new AutoCompletion(getCompletionProvider());
}
return ac;
}
/**
* Creates the shared completion provider instance.
*
* @return The completion provider.
*/
protected synchronized CompletionProvider getCompletionProvider() {
if (provider==null) {
provider = new RegexAwareProvider();
if (replace) {
addReplaceFieldCompletions(provider);
}
else {
addFindFieldCompletions(provider);
}
}
return provider;
}
/**
* Hides any auto-complete windows that are visible.
*
* @return Whether any windows were visible.
*/
public boolean hideAutoCompletePopups() {
return ac==null ? false : ac.hideChildWindows();
}
/**
* Returns whether regex auto-complete is enabled.
*
* @return Whether regex auto-complete is enabled.
* @see #setAutoCompleteEnabled(boolean)
*/
public boolean isAutoCompleteEnabled() {
return enabled;
}
/**
* Toggles whether regex auto-complete is enabled. This method will fire
* a property change event of type
* {@link ContentAssistable#ASSISTANCE_IMAGE}.
*
* @param enabled Whether regex auto complete should be enabled.
* @see #isAutoCompleteEnabled()
*/
public void setAutoCompleteEnabled(boolean enabled) {
if (this.enabled!=enabled) {
this.enabled = enabled;
if (enabled) {
AutoCompletion ac = getAutoCompletion();
ac.setListCellRenderer(new ContentAssistCellRenderer());
JTextComponent tc = (JTextComponent)getEditor().
getEditorComponent();
ac.install(tc);
}
else {
ac.uninstall();
}
String prop = ContentAssistable.ASSISTANCE_IMAGE;
// Must take care how we fire the property event, as Swing
// property change support won't fire a notice if old and new are
// both non-null and old.equals(new).
if (enabled) {
firePropertyChange(prop, null,
AbstractSearchDialog.getContentAssistImage());
}
else {
firePropertyChange(prop, null, null);
}
}
}
/**
* Renderer for the regex content assist.
*/
private static class ContentAssistCellRenderer
extends DefaultListCellRenderer {
public Component getListCellRendererComponent(JList list, Object value,
int index, boolean selected, boolean hasFocus) {
super.getListCellRendererComponent(list, value, index, selected,
hasFocus);
setText(((RegexCompletion)value).getShortDescription());
return this;
}
}
/**
* A completion provider for regular expressions.
*/
private static class RegexAwareProvider extends DefaultCompletionProvider {
protected boolean isValidChar(char ch) {
switch (ch) {
case '\\':
case '(':
case '*':
case '.':
case '?':
case '[':
case '^':
case ':':
case '{':
case '$':
case '+':
return true;
default:
return false;
}
}
}
private static class RegexCompletion extends BasicCompletion {
private String inputText;
/**
* Constructor.
*
* @param provider The parent completion provider.
* @param inputText The text the user must input.
* @param replacementText The text to replace.
* @param shortDesc A short description of the completion. This will be
* displayed in the completion list.
*/
public RegexCompletion(CompletionProvider provider, String inputText,
String replacementText, String shortDesc) {
super(provider, replacementText, shortDesc);
this.inputText = inputText;
}
/**
* {@inheritDoc}
*/
public String getInputText() {
return inputText;
}
}
}