KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > groovy > ui > ShellCompleter


1 /*
2 $Id: ShellCompleter.java,v 1.2 2004/09/28 20:08:34 yuri 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
51 import java.util.ArrayList JavaDoc;
52 import java.util.Iterator JavaDoc;
53 import java.util.List JavaDoc;
54 import java.util.Set JavaDoc;
55
56 import org.codehaus.groovy.sandbox.ui.Completer;
57
58 /**
59  * Readline completion for InteractiveShell.
60  *
61  * @author Yuri Schimke
62  * @version $Revision: 1.2 $
63  */

64 public class ShellCompleter implements Completer {
65   // The shell being handled
66
private GroovyShell shell;
67   private ArrayList JavaDoc completions;
68
69   public ShellCompleter(GroovyShell shell) {
70     this.shell = shell;
71   }
72   
73   // @TODO add optimisations like check for . and rule out variables etc
74
public List JavaDoc findCompletions(String JavaDoc token) {
75     completions.clear();
76       
77     if (token.length() == 0)
78       return completions;
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 JavaDoc complete) {
97     List JavaDoc methods = shell.getMetaClass().getMetaMethods();
98     for (Iterator JavaDoc 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         else
104           completions.add(method.getName() + "()");
105       }
106     }
107   }
108
109   private void findLocalVariables(String JavaDoc complete) {
110     Set JavaDoc names = shell.getContext().getVariables().keySet();
111     
112     for (Iterator JavaDoc i = names.iterator(); i.hasNext();) {
113       String JavaDoc name = (String JavaDoc) i.next();
114       if (name.startsWith(complete)) {
115         completions.add(name);
116       }
117     }
118   }
119 }
120
Popular Tags