Merge pull request #35 from acardona/filter-listed-files

New text/regex filter to choose which files are to be listed in the FileSystemTree of the Script Editor.

Author: acardona

src/main/java/org/scijava/ui/swing/script/FileSystemTree.java

@@ -103,7 +103,13 @@ public boolean isDirectory() {
 			return new File(this.path).isDirectory();
 		}
 
-		public File[] updatedChildrenFiles(final boolean sort) {
+		/**
+		 * 
+		 * @param sort
+		 * @param file_filter Applies to leafs, not to directories.
+		 * @return
+		 */
+		public File[] updatedChildrenFiles(final boolean sort, final FileFilter file_filter) {
 			final File file = new File(this.path);
 			if (!file.isDirectory()) {
 				return new File[0];
@@ -112,7 +118,8 @@ public File[] updatedChildrenFiles(final boolean sort) {
 				@Override
 				public boolean accept(final File f) {
 					return !f.isHidden() && !f.getName().endsWith("~")
-							&& !re_ignored_extensions.matcher(f.getName()).matches();
+							&& !re_ignored_extensions.matcher(f.getName()).matches()
+							&& (f.isDirectory() || file_filter.accept(f));
 				}
 			});
 			if (sort) Arrays.sort(files);
@@ -122,11 +129,11 @@ public boolean accept(final File f) {
 		/**
 		 * If it's a directory, add a Node for each of its visible files.
 		 */
-		public synchronized void populateChildren(final DefaultTreeModel model) {
+		public synchronized void populateChildren(final DefaultTreeModel model, final FileFilter file_filter) {
 			try {
 				if (isLeaf()) return;
 				int index = 0;
-				for (final File file : updatedChildrenFiles(true)) {
+				for (final File file : updatedChildrenFiles(true, file_filter)) {
 					// Can't use add: would try to insert at getChildCount(), which is the wrong value here
 					model.insertNodeInto(new Node(file.getAbsolutePath()), this, index++);
 				}
@@ -207,9 +214,9 @@ public synchronized void removeAllChildren(final DefaultTreeModel model) {
 			}
 		}
 
-		public synchronized void updateChildrenList(final DefaultTreeModel model) {
+		public synchronized void updateChildrenList(final DefaultTreeModel model, final FileFilter file_filter) {
 			removeAllChildren(model);
-			populateChildren(model);
+			populateChildren(model, file_filter);
 		}
 	}
 
@@ -225,6 +232,7 @@ public interface LeafListener {
 
 	private final HashSet<String> ignored_extensions = new HashSet<>();
 	private Pattern re_ignored_extensions = Pattern.compile("^.*$", Pattern.CASE_INSENSITIVE); // match all
+	private FileFilter file_filter = ((f) -> true);
 
 	public FileSystemTree(final Logger log)
 	{
@@ -238,7 +246,7 @@ public FileSystemTree(final Logger log)
 			@Override
 			public void treeWillExpand(TreeExpansionEvent event) throws ExpandVetoException {
 				final Node node = ((Node)event.getPath().getLastPathComponent());
-				node.populateChildren(getModel());
+				node.populateChildren(getModel(), file_filter);
 				dir_watcher.register(node);
 			}
 
@@ -329,6 +337,46 @@ private void updateIgnoreExtensionPattern() {
 			this.re_ignored_extensions = Pattern.compile(s.toString(), Pattern.CASE_INSENSITIVE);
 		}
 	}
+	
+	public void setFileFilter(final FileFilter file_filter) {
+		this.file_filter = file_filter;
+		updateRecursively(file_filter);
+	}
+	
+	private void updateRecursively(final FileFilter file_filter) {
+		// Find expanded directories
+		final ArrayList<Node> stack = new ArrayList<>();
+		final Node root = (Node) this.getModel().getRoot();
+		for (int i=root.getChildCount() -1; i>-1; --i) {
+			stack.add((Node)root.getChildAt(i));
+		}
+		final ArrayList<Node> stack2 = new ArrayList<>(stack); // copy for second phase
+		final HashSet<String> expanded = new HashSet<>();
+		while (!stack.isEmpty()) {
+			final Node node = stack.remove(0);
+			if (this.isExpanded(new TreePath(node.getPath()))) {
+				expanded.add(node.path);
+				for (int i=node.getChildCount() -1; i>-1; --i) {
+					final Node child = node.getChildAt(i);
+					if (child.isDirectory()) stack.add(child);
+				}
+			}
+		}
+		// Re-list all files, filtering
+		while (!stack2.isEmpty()) {
+			final Node node = stack2.remove(0);
+			if (expanded.contains(node.path)) {
+				node.removeAllChildren(this.getModel());
+				node.populateChildren(this.getModel(), file_filter);
+				final int count = node.getChildCount();
+				if (count > 0) expandPath(new TreePath(node.getChildAt(0).getPath())); // awkward way to ensure parent is expanded
+				for (int i=0; i<count; ++i) {
+					final Node child = node.getChildAt(i);
+					if (expanded.contains(child.path)) stack2.add(child);
+				}
+			}
+		}
+	}
 
 	synchronized public void addLeafListener(final LeafListener l) {
 		this.leaf_listeners.add(l);
@@ -508,7 +556,7 @@ public void run() {
 
 				SwingUtilities.invokeLater(() -> {
 					for (final Node node : nodes) {
-						node.updateChildrenList(FileSystemTree.this.getModel());
+						node.updateChildrenList(FileSystemTree.this.getModel(), file_filter);
 						FileSystemTree.this.expandPath(new TreePath(node.getPath()));
 					}
 				});

src/main/java/org/scijava/ui/swing/script/TextEditor.java

@@ -52,6 +52,8 @@
 import java.awt.event.ActionListener;
 import java.awt.event.ComponentAdapter;
 import java.awt.event.ComponentEvent;
+import java.awt.event.FocusEvent;
+import java.awt.event.FocusListener;
 import java.awt.event.ItemEvent;
 import java.awt.event.KeyAdapter;
 import java.awt.event.KeyEvent;
@@ -94,6 +96,8 @@
 import java.util.concurrent.ExecutionException;
 import java.util.jar.JarEntry;
 import java.util.jar.JarOutputStream;
+import java.util.regex.Pattern;
+import java.util.regex.PatternSyntaxException;
 import java.util.zip.ZipException;
 
 import javax.script.ScriptEngine;
@@ -116,6 +120,7 @@
 import javax.swing.JSplitPane;
 import javax.swing.JTabbedPane;
 import javax.swing.JTextArea;
+import javax.swing.JTextField;
 import javax.swing.KeyStroke;
 import javax.swing.SwingUtilities;
 import javax.swing.event.ChangeEvent;
@@ -618,6 +623,11 @@ public TextEditor(final Context context) {
 		add_directory.setToolTipText("Add a directory");
 		final JButton remove_directory = new JButton("[-]");
 		remove_directory.setToolTipText("Remove a top-level directory");
+		
+		final JTextField filter = new JTextField("filter...");
+		filter.setForeground(Color.gray);
+		filter.setToolTipText("Use leading '/' for regular expressions");
+		
 		tree = new FileSystemTree(log);
 		tree.ignoreExtension("class");
 		dragSource = new DragSource();
@@ -683,6 +693,63 @@ public TextEditor(final Context context) {
 					"Can only remove top-level folders.");
 			}
 		});
+		filter.addFocusListener(new FocusListener() {
+			@Override
+			public void focusLost(FocusEvent e) {
+				if (0 == filter.getText().length()) {
+					filter.setForeground(Color.gray);
+					filter.setText("filter...");
+				}
+			}
+			
+			@Override
+			public void focusGained(FocusEvent e) {
+				if (filter.getForeground() == Color.gray) {
+					filter.setText("");
+					filter.setForeground(Color.black);
+				}
+			}
+		});
+		filter.addKeyListener(new KeyAdapter() {
+			Pattern pattern = null;
+			@Override
+			public void keyPressed(final KeyEvent ke) {
+				if (ke.getKeyCode() == KeyEvent.VK_ENTER) {
+					final String text = filter.getText();
+					if (0 == text.length()) {
+						tree.setFileFilter(((f) -> true)); // any
+						return;
+					}
+					if ('/' == text.charAt(0)) {
+						// Interpret as a regular expression
+						// Attempt to compile the pattern
+						try {
+							String regex = text.substring(1);
+							if ('^' != regex.charAt(1)) regex = "^.*" + regex;
+							if ('$' != regex.charAt(regex.length() -1)) regex += ".*$";
+							pattern = Pattern.compile(regex);
+							filter.setForeground(Color.black);
+						} catch (final PatternSyntaxException pse) {
+							log.warn(pse.getLocalizedMessage());
+							filter.setForeground(Color.red);
+							pattern = null;
+							return;
+						}
+						if (null != pattern) {
+							tree.setFileFilter((f) -> pattern.matcher(f.getName()).matches());
+						}
+					} else {
+						// Interpret as a literal match
+						tree.setFileFilter((f) -> -1 != f.getName().indexOf(text));
+					}
+				} else {
+					// Upon re-typing something
+					if (filter.getForeground() == Color.red) {
+						filter.setForeground(Color.black);
+					}
+				}
+			}
+		});
 
 		// Restore top-level directories
 		tree.addTopLevelFoldersFrom(getEditorPane().loadFolders());
@@ -699,8 +766,11 @@ public TextEditor(final Context context) {
 		tree_panel.add(add_directory, bc);
 		bc.gridx = 1;
 		tree_panel.add(remove_directory, bc);
+		bc.gridx = 2;
+		bc.fill = GridBagConstraints.BOTH;
+		tree_panel.add(filter, bc);
 		bc.gridx = 0;
-		bc.gridwidth = 2;
+		bc.gridwidth = 3;
 		bc.gridy = 1;
 		bc.weightx = 1.0;
 		bc.weighty = 1.0;