You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by gn...@apache.org on 2010/08/26 18:09:00 UTC
svn commit: r989801 - in /karaf/trunk/shell/console/src:
main/java/org/apache/felix/gogo/commands/
main/java/org/apache/karaf/shell/console/
main/java/org/apache/karaf/shell/console/completer/
test/java/org/apache/karaf/shell/console/
Author: gnodet
Date: Thu Aug 26 16:08:59 2010
New Revision: 989801
URL: http://svn.apache.org/viewvc?rev=989801&view=rev
Log:
added support for tab completion of commands inside the non-OSGi shell for https://issues.apache.org/jira/browse/KARAF-174 along with adding a little bit more javadoc to the annotations
Added:
karaf/trunk/shell/console/src/main/java/org/apache/karaf/shell/console/completer/SimpleCommandsCompleter.java
Modified:
karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Argument.java
karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Command.java
karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Option.java
karaf/trunk/shell/console/src/main/java/org/apache/karaf/shell/console/Main.java
karaf/trunk/shell/console/src/test/java/org/apache/karaf/shell/console/ExampleSubclassMain.java
Modified: karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Argument.java
URL: http://svn.apache.org/viewvc/karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Argument.java?rev=989801&r1=989800&r2=989801&view=diff
==============================================================================
--- karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Argument.java (original)
+++ karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Argument.java Thu Aug 26 16:08:59 2010
@@ -23,6 +23,9 @@ import java.lang.annotation.RetentionPol
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
+/**
+ * Represents a positional argument on a command line (as opposed to an optional named {@link Option}
+ */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface Argument
Modified: karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Command.java
URL: http://svn.apache.org/viewvc/karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Command.java?rev=989801&r1=989800&r2=989801&view=diff
==============================================================================
--- karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Command.java (original)
+++ karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Command.java Thu Aug 26 16:08:59 2010
@@ -23,13 +23,26 @@ import java.lang.annotation.RetentionPol
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
+/**
+ * Used to denote a class represents a command which is executable within a shell/scope or as a
+ * command line process.
+ */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface Command
{
+ /**
+ * Returns the scope or sub shell of the command
+ */
String scope();
+ /**
+ * REturns the name of the command if used inside a shell
+ */
String name();
+ /**
+ * Returns the description of the command which is used to generate command line help
+ */
String description() default "";
}
Modified: karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Option.java
URL: http://svn.apache.org/viewvc/karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Option.java?rev=989801&r1=989800&r2=989801&view=diff
==============================================================================
--- karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Option.java (original)
+++ karaf/trunk/shell/console/src/main/java/org/apache/felix/gogo/commands/Option.java Thu Aug 26 16:08:59 2010
@@ -23,6 +23,9 @@ import java.lang.annotation.RetentionPol
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
+/**
+ * Used to mark an optional named command line option who's name typically starts with "--"
+ */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface Option
Modified: karaf/trunk/shell/console/src/main/java/org/apache/karaf/shell/console/Main.java
URL: http://svn.apache.org/viewvc/karaf/trunk/shell/console/src/main/java/org/apache/karaf/shell/console/Main.java?rev=989801&r1=989800&r2=989801&view=diff
==============================================================================
--- karaf/trunk/shell/console/src/main/java/org/apache/karaf/shell/console/Main.java (original)
+++ karaf/trunk/shell/console/src/main/java/org/apache/karaf/shell/console/Main.java Thu Aug 26 16:08:59 2010
@@ -27,6 +27,7 @@ import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Properties;
+import java.util.Set;
import jline.Terminal;
import org.apache.felix.gogo.commands.Action;
@@ -35,6 +36,7 @@ import org.apache.felix.gogo.commands.ba
import org.apache.felix.gogo.runtime.lang.Support;
import org.apache.felix.gogo.runtime.shell.CommandShellImpl;
import org.apache.felix.gogo.runtime.threadio.ThreadIOImpl;
+import org.apache.karaf.shell.console.completer.SimpleCommandsCompleter;
import org.apache.karaf.shell.console.jline.Console;
import org.apache.karaf.shell.console.jline.TerminalFactory;
import org.fusesource.jansi.AnsiConsole;
@@ -76,12 +78,13 @@ public class Main {
args = a;
}
- discoverCommands(commandProcessor, cl);
+ SimpleCommandsCompleter completer = new SimpleCommandsCompleter(getApplication());
+ discoverCommands(commandProcessor, cl, completer);
InputStream in = unwrap(System.in);
PrintStream out = wrap(unwrap(System.out));
PrintStream err = wrap(unwrap(System.err));
- run(commandProcessor, args, in, out, err);
+ run(commandProcessor, args, in, out, err, completer);
// TODO: do we need to stop the threadio that was started?
// threadio.stop();
@@ -116,18 +119,20 @@ public class Main {
System.arraycopy(args, 1, a, 0, a.length);
args = a;
}
- discoverCommands(commandProcessor, cl);
+
+ SimpleCommandsCompleter completer = new SimpleCommandsCompleter(getApplication());
+ discoverCommands(commandProcessor, cl, completer);
InputStream in = parent.getKeyboard();
PrintStream out = parent.getConsole();
PrintStream err = parent.getConsole();
- run(commandProcessor, args, in, out, err);
+ run(commandProcessor, args, in, out, err, completer);
}
- private void run(final CommandShellImpl commandProcessor, String[] args, final InputStream in, final PrintStream out, final PrintStream err) throws Exception {
+ private void run(final CommandShellImpl commandProcessor, String[] args, final InputStream in, final PrintStream out, final PrintStream err, final Completer completer) throws Exception {
TerminalFactory terminalFactory = new TerminalFactory();
Terminal terminal = terminalFactory.getTerminal();
- Console console = createConsole(commandProcessor, in, out, err, terminal);
+ Console console = createConsole(commandProcessor, in, out, err, terminal, completer);
CommandSession session = console.getSession();
session.put("USER", user);
session.put("APPLICATION", application);
@@ -162,8 +167,8 @@ public class Main {
* @return
* @throws Exception
*/
- protected Console createConsole(CommandShellImpl commandProcessor, InputStream in, PrintStream out, PrintStream err, Terminal terminal) throws Exception {
- return new Console(commandProcessor, in, out, err, terminal, null, null);
+ protected Console createConsole(CommandShellImpl commandProcessor, InputStream in, PrintStream out, PrintStream err, Terminal terminal, Completer completer) throws Exception {
+ return new Console(commandProcessor, in, out, err, terminal, completer, null);
}
/**
@@ -176,7 +181,7 @@ public class Main {
return "META-INF/services/org/apache/karaf/shell/commands";
}
- private void discoverCommands(CommandShellImpl commandProcessor, ClassLoader cl) throws IOException, ClassNotFoundException {
+ private void discoverCommands(CommandShellImpl commandProcessor, ClassLoader cl, SimpleCommandsCompleter completer) throws IOException, ClassNotFoundException {
Enumeration<URL> urls = cl.getResources("META-INF/services/org/apache/karaf/shell/commands");
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
@@ -195,6 +200,7 @@ public class Main {
}
};
commandProcessor.addCommand(cmd.scope(), function, cmd.name());
+ completer.addCommand(cmd, function);
} catch (Exception e) {
}
}
Added: karaf/trunk/shell/console/src/main/java/org/apache/karaf/shell/console/completer/SimpleCommandsCompleter.java
URL: http://svn.apache.org/viewvc/karaf/trunk/shell/console/src/main/java/org/apache/karaf/shell/console/completer/SimpleCommandsCompleter.java?rev=989801&view=auto
==============================================================================
--- karaf/trunk/shell/console/src/main/java/org/apache/karaf/shell/console/completer/SimpleCommandsCompleter.java (added)
+++ karaf/trunk/shell/console/src/main/java/org/apache/karaf/shell/console/completer/SimpleCommandsCompleter.java Thu Aug 26 16:08:59 2010
@@ -0,0 +1,98 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.karaf.shell.console.completer;
+
+import org.apache.felix.gogo.commands.Command;
+import org.apache.karaf.shell.console.CompletableFunction;
+import org.apache.karaf.shell.console.Completer;
+import org.osgi.service.command.Function;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+
+/**
+ * Like the {@link org.apache.karaf.shell.console.completer.CommandsCompleter} but does not use OSGi but is
+ * instead used from the non-OSGi {@link org.apache.karaf.shell.console.Main}
+ */
+public class SimpleCommandsCompleter implements Completer {
+
+ private final Map<Command, Completer> completers = new ConcurrentHashMap<Command, Completer>();
+ private String application;
+
+ public SimpleCommandsCompleter(String application) {
+ this.application = application;
+ }
+
+
+ public void addCommand(Command command, Function function) {
+ Set<String> functions = getNames(command);
+ if (functions != null) {
+ List<Completer> cl = new ArrayList<Completer>();
+ cl.add(new StringsCompleter(functions));
+ if (function instanceof CompletableFunction) {
+ List<Completer> fcl = ((CompletableFunction) function).getCompleters();
+ if (fcl != null) {
+ for (Completer c : fcl) {
+ cl.add(c == null ? NullCompleter.INSTANCE : c);
+ }
+ } else {
+ cl.add(NullCompleter.INSTANCE);
+ }
+ } else {
+ cl.add(NullCompleter.INSTANCE);
+ }
+ ArgumentCompleter c = new ArgumentCompleter(cl);
+ completers.put(command, c);
+ }
+ }
+
+ public void removeCommand(Command cmd) {
+ if (cmd != null) {
+ completers.remove(cmd);
+ }
+ }
+
+ private Set<String> getNames(Command command) {
+ Set<String> names = new HashSet<String>();
+ Object scope = command.scope();
+ String function = command.name();
+ if (function != null) {
+ if (scope == null || scope.equals(application)) {
+ names.add(function);
+ return names;
+ } else {
+ names.add(scope + ":" + function);
+ return names;
+ }
+ }
+ return null;
+ }
+
+ public int complete(String buffer, int cursor, List<String> candidates) {
+ int res = new AggregateCompleter(completers.values()).complete(buffer, cursor, candidates);
+ Collections.sort(candidates);
+ return res;
+ }
+}
+
Modified: karaf/trunk/shell/console/src/test/java/org/apache/karaf/shell/console/ExampleSubclassMain.java
URL: http://svn.apache.org/viewvc/karaf/trunk/shell/console/src/test/java/org/apache/karaf/shell/console/ExampleSubclassMain.java?rev=989801&r1=989800&r2=989801&view=diff
==============================================================================
--- karaf/trunk/shell/console/src/test/java/org/apache/karaf/shell/console/ExampleSubclassMain.java (original)
+++ karaf/trunk/shell/console/src/test/java/org/apache/karaf/shell/console/ExampleSubclassMain.java Thu Aug 26 16:08:59 2010
@@ -46,8 +46,8 @@ public class ExampleSubclassMain extends
}
@Override
- protected Console createConsole(CommandShellImpl commandProcessor, InputStream in, PrintStream out, PrintStream err, Terminal terminal) throws Exception {
- return new Console(commandProcessor, in, out, err, terminal, null, null) {
+ protected Console createConsole(CommandShellImpl commandProcessor, InputStream in, PrintStream out, PrintStream err, Terminal terminal, Completer completer) throws Exception {
+ return new Console(commandProcessor, in, out, err, terminal, completer, null) {
/**
* If you don't overwrite, then karaf will use the welcome message found in the