001 /*
002 $Id: ShellCompleter.java,v 1.3 2005/04/12 16:38:42 jstrachan Exp $
003
004 Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
005
006 Redistribution and use of this software and associated documentation
007 ("Software"), with or without modification, are permitted provided
008 that the following conditions are met:
009
010 1. Redistributions of source code must retain copyright
011 statements and notices. Redistributions must also contain a
012 copy of this document.
013
014 2. Redistributions in binary form must reproduce the
015 above copyright notice, this list of conditions and the
016 following disclaimer in the documentation and/or other
017 materials provided with the distribution.
018
019 3. The name "groovy" must not be used to endorse or promote
020 products derived from this Software without prior written
021 permission of The Codehaus. For written permission,
022 please contact info@codehaus.org.
023
024 4. Products derived from this Software may not be called "groovy"
025 nor may "groovy" appear in their names without prior written
026 permission of The Codehaus. "groovy" is a registered
027 trademark of The Codehaus.
028
029 5. Due credit should be given to The Codehaus -
030 http://groovy.codehaus.org/
031
032 THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
033 ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
034 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
035 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
036 THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
037 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
038 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
039 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
040 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
041 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
042 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
043 OF THE POSSIBILITY OF SUCH DAMAGE.
044
045 */
046 package groovy.ui;
047
048 import groovy.lang.GroovyShell;
049 import groovy.lang.MetaMethod;
050 import org.codehaus.groovy.sandbox.ui.Completer;
051
052 import java.util.ArrayList;
053 import java.util.Iterator;
054 import java.util.List;
055 import java.util.Set;
056
057 /**
058 * Readline completion for InteractiveShell.
059 *
060 * @author Yuri Schimke
061 * @version $Revision: 1.3 $
062 */
063 public class ShellCompleter implements Completer {
064 // The shell being handled
065 private GroovyShell shell;
066 private List completions = new ArrayList();
067
068 public ShellCompleter(GroovyShell shell) {
069 this.shell = shell;
070 }
071
072 // @TODO add optimisations like check for . and rule out variables etc
073 public List findCompletions(String token) {
074 completions.clear();
075
076 if (token.length() == 0) {
077 return completions;
078 }
079
080 // completions of local variable names
081 findLocalVariables(token);
082
083 // completions of local fields.
084
085 // completions of local methods
086 findShellMethods(token);
087
088 // completions of methods invoked on a target
089 //findTargetCompletions(complete);
090
091 // completion of keywords.
092
093 return completions;
094 }
095
096 private void findShellMethods(String complete) {
097 List methods = shell.getMetaClass().getMetaMethods();
098 for (Iterator i = methods.iterator(); i.hasNext();) {
099 MetaMethod method = (MetaMethod) i.next();
100 if (method.getName().startsWith(complete)) {
101 if (method.getParameterTypes().length > 0) {
102 completions.add(method.getName() + "(");
103 }
104 else {
105 completions.add(method.getName() + "()");
106 }
107 }
108 }
109 }
110
111 private void findLocalVariables(String complete) {
112 Set names = shell.getContext().getVariables().keySet();
113
114 for (Iterator i = names.iterator(); i.hasNext();) {
115 String name = (String) i.next();
116 if (name.startsWith(complete)) {
117 completions.add(name);
118 }
119 }
120 }
121 }