1 /*
2 $Id: ShellCompleter.java,v 1.3 2005/04/12 16:38:42 jstrachan Exp $
3
4 Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
5
6 Redistribution and use of this software and associated documentation
7 ("Software"), with or without modification, are permitted provided
8 that the following conditions are met:
9
10 1. Redistributions of source code must retain copyright
11 statements and notices. Redistributions must also contain a
12 copy of this document.
13
14 2. Redistributions in binary form must reproduce the
15 above copyright notice, this list of conditions and the
16 following disclaimer in the documentation and/or other
17 materials provided with the distribution.
18
19 3. The name "groovy" must not be used to endorse or promote
20 products derived from this Software without prior written
21 permission of The Codehaus. For written permission,
22 please contact info@codehaus.org.
23
24 4. Products derived from this Software may not be called "groovy"
25 nor may "groovy" appear in their names without prior written
26 permission of The Codehaus. "groovy" is a registered
27 trademark of The Codehaus.
28
29 5. Due credit should be given to The Codehaus -
30 http://groovy.codehaus.org/
31
32 THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
33 ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
34 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
35 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
36 THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
37 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
43 OF THE POSSIBILITY OF SUCH DAMAGE.
44
45 */
46 package groovy.ui;
47
48 import groovy.lang.GroovyShell;
49 import groovy.lang.MetaMethod;
50 import org.codehaus.groovy.sandbox.ui.Completer;
51
52 import java.util.ArrayList;
53 import java.util.Iterator;
54 import java.util.List;
55 import java.util.Set;
56
57 /***
58 * Readline completion for InteractiveShell.
59 *
60 * @author Yuri Schimke
61 * @version $Revision: 1.3 $
62 */
63 public class ShellCompleter implements Completer {
64 // The shell being handled
65 private GroovyShell shell;
66 private List completions = new ArrayList();
67
68 public ShellCompleter(GroovyShell shell) {
69 this.shell = shell;
70 }
71
72 // @TODO add optimisations like check for . and rule out variables etc
73 public List findCompletions(String token) {
74 completions.clear();
75
76 if (token.length() == 0) {
77 return completions;
78 }
79
80 // completions of local variable names
81 findLocalVariables(token);
82
83 // completions of local fields.
84
85 // completions of local methods
86 findShellMethods(token);
87
88 // completions of methods invoked on a target
89 //findTargetCompletions(complete);
90
91 // completion of keywords.
92
93 return completions;
94 }
95
96 private void findShellMethods(String complete) {
97 List methods = shell.getMetaClass().getMetaMethods();
98 for (Iterator i = methods.iterator(); i.hasNext();) {
99 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 }