Compare commits

..

38 Commits

Author SHA1 Message Date
3bed05c53f [maven-release-plugin] prepare release gclc-2.0.7 2018-10-08 13:48:47 -04:00
27bc7cc07b Configure site.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 13:46:19 -04:00
c83a598abb moved package
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 13:45:58 -04:00
829445bf74 [maven-release-plugin] prepare for next development iteration 2018-10-08 12:24:10 -04:00
02ea720bb9 [maven-release-plugin] prepare release gclc-2.0.6 2018-10-08 12:24:01 -04:00
41c9c9cd0d Licensing, upgrade configuration, use official license-plugin.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 12:21:43 -04:00
d99d97b9d5 Reorganize code to avoid cyclic dependencies.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 11:49:14 -04:00
c8745e00a9 [maven-release-plugin] prepare for next development iteration 2018-05-10 11:34:15 -04:00
8ca2905b2a [maven-release-plugin] prepare release process-0.0.2 2018-05-10 11:34:08 -04:00
37cbe2eb95 Skip release 0.0.1. Add scm
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-05-10 11:33:52 -04:00
9bc46c93a6 [maven-release-plugin] prepare release process-0.0.1 2018-05-10 11:32:07 -04:00
00c0e86d72 Fork process
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-05-10 11:29:38 -04:00
eae7e0d69f Fix prompting mechanics
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-05-10 11:29:11 -04:00
926a8d72fa Update dependency, parent pom and group id
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-05-10 11:28:45 -04:00
95ec674528 [maven-release-plugin] prepare for next development iteration 2018-05-10 11:20:32 -04:00
4d30402a42 [maven-release-plugin] prepare release gclc-2.0.5 2018-05-10 11:20:25 -04:00
cdcf9f0fae Update command parameterization mechanics 2018-05-10 11:18:10 -04:00
cce8a9504d [maven-release-plugin] prepare for next development iteration 2018-01-30 13:50:27 -05:00
119afe1660 [maven-release-plugin] prepare release gclc-2.0.4 2018-01-30 13:50:17 -05:00
7517251d1c Update prompt for dynamic value
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-01-30 12:54:40 -05:00
f8a37e7eee [maven-release-plugin] prepare for next development iteration 2017-11-25 10:50:57 -05:00
3598bb359e [maven-release-plugin] prepare release gclc-2.0.3 2017-11-25 10:50:44 -05:00
e9fa6e209f Update help of sub command in case the command is unknown 2017-11-25 10:46:28 -05:00
d4b695f60b [maven-release-plugin] prepare for next development iteration 2017-11-19 07:57:03 -05:00
8a8d298485 [maven-release-plugin] prepare release gclc-2.0.2 2017-11-19 07:56:45 -05:00
50887f44bb Fixed close closing non possessed resource
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-19 07:49:30 -05:00
3a5250d987 [maven-release-plugin] prepare for next development iteration 2017-11-18 18:31:56 -05:00
ddc60652f1 [maven-release-plugin] prepare release gclc-swt-1.1.4 2017-11-18 18:31:37 -05:00
206df88506 Update to gclc-2.0.1
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-18 18:29:24 -05:00
d2cd059c01 [maven-release-plugin] prepare for next development iteration 2017-11-18 16:38:21 -05:00
90dab5a809 [maven-release-plugin] prepare release gclc-socket-1.1.9 2017-11-18 16:37:59 -05:00
d5f2d39808 Update gclc-socket.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-18 16:37:06 -05:00
36f39df87e [maven-release-plugin] prepare for next development iteration 2017-11-18 08:54:25 -05:00
82e8d1e1b7 [maven-release-plugin] prepare release gclc-2.0.1 2017-11-18 08:54:00 -05:00
0ebcd7b210 Update thread namings.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-18 08:51:54 -05:00
d32ea6b4b0 Fixed tests
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-18 08:13:51 -05:00
e5d5edcf63 Update gclc version in secondary pakages
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-17 17:46:22 -05:00
b80a3fc5b8 [maven-release-plugin] prepare for next development iteration 2017-11-13 22:40:53 -05:00
132 changed files with 17198 additions and 11924 deletions

View File

@@ -1,4 +1,35 @@
<!-- process, Distribution repositories and basic setup for Emmanuel Bigeon projects -->
<!-- Copyright (C) 2014-2018 E. Bigeon -->
<!-- mailto:emmanuel@bigeon.fr -->
<!-- -->
<!-- This software is governed by the CeCILL license under French law and -->
<!-- abiding by the rules of distribution of free software. You can use, -->
<!-- modify and/or redistribute the software under the terms of the CeCILL -->
<!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
<!-- "http://www.cecill.info". -->
<!-- -->
<!-- As a counterpart to the access to the source code and rights to copy, -->
<!-- modify and redistribute granted by the license, users are provided only -->
<!-- with a limited warranty and the software's author, the holder of the -->
<!-- economic rights, and the successive licensors have only limited -->
<!-- liability. -->
<!-- -->
<!-- In this respect, the user's attention is drawn to the risks associated -->
<!-- with loading, using, modifying and/or developing or reproducing the -->
<!-- software by the user in light of its specific status of free software, -->
<!-- that may mean that it is complicated to manipulate, and that also -->
<!-- therefore means that it is reserved for developers and experienced -->
<!-- professionals having in-depth computer knowledge. Users are therefore -->
<!-- encouraged to load and test the software's suitability as regards their -->
<!-- requirements in conditions enabling the security of their systems and/or -->
<!-- data to be ensured and, more generally, to use and operate it in the -->
<!-- same conditions as regards security. -->
<!-- -->
<!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. -->
<!-- process, Distribution repositories and basic setup for Emmanuel Bigeon projects --> <!-- process, Distribution repositories and basic setup for Emmanuel Bigeon projects -->
<!-- Copyright (C) 2014-2017 E. Bigeon --> <!-- Copyright (C) 2014-2017 E. Bigeon -->
<!-- mailto:emmanuel@bigeon.fr --> <!-- mailto:emmanuel@bigeon.fr -->
@@ -29,13 +60,12 @@
<!-- The fact that you are presently reading this means that you have had --> <!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. --> <!-- knowledge of the CeCILL license and that you accept its terms. -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<groupId>fr.bigeon.gclc</groupId> <groupId>fr.bigeon.gclc</groupId>
<artifactId>process</artifactId> <artifactId>process</artifactId>
<version>0.0.1-SNAPSHOT</version> <version>0.0.3-SNAPSHOT</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<name>process</name> <name>process</name>
@@ -46,15 +76,20 @@
</properties> </properties>
<parent> <parent>
<groupId>fr.bigeon</groupId> <groupId>fr.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId> <artifactId>ebigeon-config</artifactId>
<version>1.8.0</version> <version>1.8.2</version>
</parent> </parent>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>fr.bigeon</groupId> <groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId> <artifactId>gclc</artifactId>
<version>2.0.0-SNAPSHOT</version> <version>2.0.5</version>
</dependency> </dependency>
</dependencies> </dependencies>
<scm>
<tag>process-0.0.1</tag>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
</scm>
</project> </project>

View File

@@ -0,0 +1,139 @@
/*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
* gclc-process:fr.bigeon.gclc.process.CommandFork.java
* Created on: Nov 13, 2017
*/
package fr.bigeon.gclc.process;
import java.util.List;
import fr.bigeon.gclc.command.CommandParameters;
import fr.bigeon.gclc.command.ParametrizedCommand;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.exception.InvalidParameterException;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** A command that is launched inside an internal terminal.
* <p>
* Several things are to be considered before adding this command to an
* application:
* <ul>
* <li>The commands will be able to run in parallel.
* <li>The managing of the commands will be handled through piped systems and
* buffered in so switching to a forked command will actually print again all
* the command history to the output console.
* </ul>
*
* @author Emmanuel Bigeon */
public class CommandForeground extends ParametrizedCommand {
private final TaskPool pool;
/** Add the fork command.
*
* @param name the command name
* @param pool The pool to get joinable tasks from */
public CommandForeground(final String name, TaskPool pool) {
super(name, false);
this.pool = pool;
addParameters();
}
/**
*
*/
private void addParameters() {
try {
addStringParameter("pid", false);
addStringParameter("delai", false);
} catch (final InvalidParameterException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ParametrizedCommand#doExecute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* fr.bigeon.gclc.command.CommandParameters) */
@Override
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) throws CommandRunException {
String string = parameters.get("pid");
final List<String> additionals = parameters.getAdditionals();
if (string == null && !additionals.isEmpty()) {
string = additionals.get(0);
}
if (string == null) {
throw new CommandRunException(CommandRunExceptionType.USAGE,
"Missing process id", this);
}
// Join the command.
final Task cmd = pool.get(string);
if (!(cmd instanceof ForkTask)) {
throw new CommandRunException("No such forked process", this);
}
long delai = 0;
final String delaiOpt = parameters.get("delai");
if (delaiOpt != null) {
delai = Long.parseLong(delaiOpt) * 1000;
}
if (delai < 0) {
throw new CommandRunException("Join delai cannot be negative", this);
}
((ForkTask) cmd).join(out, in, delai);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Join the execution of a command, for a given amount of time";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return "";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */
@Override
protected String usagePattern() {
return super.usagePattern() + " [(-pid) <id>] ([-delai <delai>])";
}
}

View File

@@ -1,6 +1,6 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
@@ -35,17 +35,12 @@
*/ */
package fr.bigeon.gclc.process; package fr.bigeon.gclc.process;
import java.io.IOException;
import java.util.Arrays; import java.util.Arrays;
import java.util.List;
import fr.bigeon.gclc.command.CommandParameters; import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.command.ICommand; import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.command.ICommandProvider; import fr.bigeon.gclc.command.ICommandProvider;
import fr.bigeon.gclc.command.ParametrizedCommand;
import fr.bigeon.gclc.exception.CommandRunException; import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.exception.InvalidParameterException;
import fr.bigeon.gclc.manager.ConsoleInput; import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import fr.bigeon.gclc.manager.ConsoleOutput;
@@ -56,72 +51,46 @@ import fr.bigeon.gclc.manager.ConsoleOutput;
* <ul> * <ul>
* <li>The commands will be able to run in parallel. * <li>The commands will be able to run in parallel.
* <li>The managing of the commands will be handled through piped systems and * <li>The managing of the commands will be handled through piped systems and
* buffered in so switching to a forled command will actually print again all * buffered in so switching to a forked command will actually print again all
* the command history to the output console. * the command history to the output console.
* </ul> * </ul>
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public class CommandFork extends ParametrizedCommand { public class CommandFork extends Command {
private final TaskPool pool = new TaskPool(); private final TaskPool pool;
private ICommandProvider provider; private final ICommandProvider provider;
private final int lines;
/** Add the fork command. /** Add the fork command.
* *
* @param name the command name */ * @param name the command name
public CommandFork(final String name) { * @param provider the allowed command collection */
super(name); public CommandFork(final String name, ICommandProvider provider, TaskPool pool) {
addParameters(); this(name, provider, pool, -1);
} }
/** /** Add the fork command.
* *
*/ * @param name the command name
private void addParameters() { * @param provider the allowed command collection */
try { public CommandFork(final String name, ICommandProvider provider, TaskPool pool,
addStringParameter("join", false); int lines) {
addBooleanParameter("list"); super(name);
} catch (final InvalidParameterException e) { this.provider = provider;
// TODO Auto-generated catch block this.pool = pool;
e.printStackTrace(); this.lines = lines;
}
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ParametrizedCommand#doExecute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* fr.bigeon.gclc.command.CommandParameters) */
@Override @Override
protected void doExecute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in, String... args)
final CommandParameters parameters) throws CommandRunException { throws CommandRunException {
if (parameters.getBool("list")) { if (args.length < 1) {
for (final String id : pool.getPIDs()) { throw new CommandRunException("No command to fork", this);
try {
out.println(id + "\t" + pool.get(id).getName());
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"Failed to write to console", e, this);
} }
} final ICommand cmd = provider.get(args[0]);
} final String[] inner = Arrays.copyOfRange(args, 1, args.length);
final ForkTask task = new ForkCommandTask(cmd, inner, lines);
final String string = parameters.get("join");
if (string != null) {
// Join the command.
final ForkTask cmd = (ForkTask) pool.get(string);
if (cmd == null) {
throw new CommandRunException("No such fork process", this);
}
cmd.join(out, in);
return;
}
final List<String> strings = parameters.getAdditionals();
final ICommand cmd = provider.get(strings.get(0));
final String[] args = Arrays.copyOfRange(strings.toArray(new String[0]),
1, strings.size());
final ForkTask task = new ForkTask(cmd, args);
final Thread th = new Thread(task); final Thread th = new Thread(task);
pool.add(task); pool.add(task);
th.start(); th.start();
@@ -131,18 +100,20 @@ public class CommandFork extends ParametrizedCommand {
* @see fr.bigeon.gclc.command.ICommand#tip() */ * @see fr.bigeon.gclc.command.ICommand#tip() */
@Override @Override
public String tip() { public String tip() {
// TODO Auto-generated method stub return "Command background launch";
// return null;
throw new RuntimeException("Not implemented yet");
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */ * @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override @Override
protected String usageDetail() { protected String usageDetail() {
// TODO Auto-generated method stub return "";
// return null;
throw new RuntimeException("Not implemented yet");
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */
@Override
protected String usagePattern() {
return super.usagePattern() + " <command>";
}
} }

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* * Copyright (C) 2014-2018 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -33,43 +30,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.exception.CommandRunExceptionTest.java *
* Created on: Nov 19, 2016
*/ */
package fr.bigeon.gclc.exception; package fr.bigeon.gclc.process;
import static org.junit.Assert.assertEquals; import java.util.Arrays;
import org.junit.Test;
import fr.bigeon.gclc.command.ICommand; import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.command.MockCommand; import fr.bigeon.gclc.exception.CommandRunException;
/** /**
* <p>
* TODO
*
* @author Emmanuel Bigeon * @author Emmanuel Bigeon
* *
*/ */
public class CommandRunExceptionTest { public class ForkCommandTask extends ForkTask {
private final ICommand command;
private final String[] args;
/** /** @param cmd the command
* Test method for {@link fr.bigeon.gclc.exception.CommandRunException#getLocalizedMessage()}. * @param args the arguements
*/ * @param lines the number of print to store in the output */
@Test public ForkCommandTask(final ICommand cmd, final String[] args, int lines) {
public final void testGetLocalizedMessage() { super(lines);
CommandRunException e; command = cmd;
ICommand cmd = new MockCommand("name"); this.args = Arrays.copyOf(args, args.length);
String messageInner = "inner"; }
String message = "message";
e = new CommandRunException(message,
new CommandRunException(messageInner, new MockCommand("name")), //$NON-NLS-1$
cmd);
assertEquals(message + ": " + messageInner, e.getLocalizedMessage()); /* (non-Javadoc)
e = new CommandRunException(message, cmd); * @see fr.bigeon.gclc.process.Task#getName() */
assertEquals(message, e.getLocalizedMessage()); @Override
public String getName() {
return command.getCommandName();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.ForkTask#doRun() */
@Override
protected void doRun() throws CommandRunException {
command.execute(out, in, args);
} }
} }

View File

@@ -1,6 +1,6 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
@@ -35,63 +35,70 @@
*/ */
package fr.bigeon.gclc.process; package fr.bigeon.gclc.process;
import java.util.Arrays;
import java.util.HashSet; import java.util.HashSet;
import java.util.Set; import java.util.Set;
import fr.bigeon.gclc.command.ICommand; import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleInput; import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import fr.bigeon.gclc.manager.ConsoleOutput;
import fr.bigeon.gclc.process.io.ConnectingConsoleInput;
import fr.bigeon.gclc.process.io.ConnectingConsoleOutput;
/** /**
* <p> * <p>
* TODO * TODO
* *
* @author Emmanuel Bigeon * @author Emmanuel Bigeon */
* public abstract class ForkTask implements Task {
*/
public class ForkTask implements Task {
private final ICommand command;
private final String[] args;
private final Set<InterruptionListener> listeners = new HashSet<>(); private final Set<InterruptionListener> listeners = new HashSet<>();
private boolean running = false; private boolean running = false;
/** @param cmd the command protected final ConnectingConsoleInput in = new ConnectingConsoleInput();
* @param args the arguements */ protected final ConnectingConsoleOutput out;
public ForkTask(final ICommand cmd, final String[] args) { private CommandRunException exception;
command = cmd; private final Object runLock = new Object();
this.args = Arrays.copyOf(args, args.length);
/** @param lines the number of print to store in the output */
public ForkTask(int lines) {
out = new ConnectingConsoleOutput(ConnectingConsoleOutput.PERSIST, lines);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#addInterruptionListener(fr.bigeon.gclc. * @see fr.bigeon.gclc.process.Task#addInterruptionListener(fr.bigeon.gclc.
* process.InterruptionListener) */ * process.InterruptionListener) */
@Override @Override
public void addInterruptionListener(final InterruptionListener listener) { public final void addInterruptionListener(final InterruptionListener listener) {
listeners.add(listener); listeners.add(listener);
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#getName() */
@Override
public String getName() {
return command.getCommandName();
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#isRunning() */ * @see fr.bigeon.gclc.process.Task#isRunning() */
@Override @Override
public boolean isRunning() { public final boolean isRunning() {
synchronized (runLock) {
return running; return running;
} }
}
/** @param out the console output /** @param out the console output
* @param in the console input */ * @param in the console input
public void join(final ConsoleOutput out, final ConsoleInput in) { * @param timeout the maximal wait (0 for ever) */
// TODO Auto-generated method stub public final void join(final ConsoleOutput out, final ConsoleInput in, long timeout) {
// synchronized (runLock) {
throw new RuntimeException("Not implemented yet"); this.out.connect(out);
this.in.connect(in);
try {
if (running) {
runLock.wait(timeout);
}
} catch (final InterruptedException e) {
// TODO log.
Thread.currentThread().interrupt();
}
this.out.disconnect();
this.in.disconnect();
}
} }
/* (non-Javadoc) /* (non-Javadoc)
@@ -99,29 +106,50 @@ public class ForkTask implements Task {
* fr.bigeon.gclc.process.Task#rmInterruptionListener(fr.bigeon.gclc.process * fr.bigeon.gclc.process.Task#rmInterruptionListener(fr.bigeon.gclc.process
* .InterruptionListener) */ * .InterruptionListener) */
@Override @Override
public void rmInterruptionListener(final InterruptionListener listener) { public final void rmInterruptionListener(final InterruptionListener listener) {
listeners.remove(listener); listeners.remove(listener);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see java.lang.Runnable#run() */ * @see java.lang.Runnable#run() */
@Override @Override
public void run() { public final void run() {
synchronized (runLock) {
running = true; running = true;
try {
// TODO Auto-generated method stub
//
throw new RuntimeException("Not implemented yet");
} finally {
running = false;
} }
try {
doRun();
} catch (final CommandRunException e) {
exception = e;
} finally {
setRunning(false);
}
for (final InterruptionListener interruptionListener : listeners) {
interruptionListener.interrupted();
}
}
/** Actually run the fork. */
protected abstract void doRun() throws CommandRunException;
/** Get the excepion that caused a failure.
*
* @return the exception */
public final CommandRunException getException() {
return exception;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#setRunning(boolean) */ * @see fr.bigeon.gclc.process.Task#setRunning(boolean) */
@Override @Override
public void setRunning(final boolean running) { public final void setRunning(final boolean running) {
synchronized (runLock) {
this.running = running; this.running = running;
runLock.notifyAll();
}
} }
protected final Object getRunningLock() {
return runLock;
}
} }

View File

@@ -1,6 +1,6 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* * Copyright (C) 2014-2018 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -33,35 +30,35 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.prompt.CLIPrompterMessagesTest.java *
* Created on: Nov 19, 2016
*/ */
package fr.bigeon.gclc.prompt; package fr.bigeon.gclc.process;
import static org.junit.Assert.assertEquals; import fr.bigeon.gclc.ApplicationAttachement;
import fr.bigeon.gclc.command.ICommandProvider;
import org.junit.Test; import fr.bigeon.gclc.exception.InvalidCommandName;
/** /**
* <p>
* TODO
*
* @author Emmanuel Bigeon * @author Emmanuel Bigeon
* *
*/ */
public class CLIPrompterMessagesTest { public class ProcessAttachement implements ApplicationAttachement {
/** private final TaskPool pool;
* Test method for {@link fr.bigeon.gclc.prompt.CLIPrompterMessages#getString(java.lang.String, java.lang.Object[])}.
/** @param pool the task pool to manage */
public ProcessAttachement(TaskPool pool) {
super();
this.pool = pool;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc.ConsoleApplication)
*/ */
@Test @Override
public final void testGetString() { public void attach(ICommandProvider application) throws InvalidCommandName {
String key = "bad.key"; application.add(new ProcessKill("kill", pool));
assertEquals('!' + key + '!', CLIPrompterMessages.getString(key)); application.add(new ProcessList("list", pool));
assertEquals('!' + key + '!',
CLIPrompterMessages.getString(key, "some arg"));
assertEquals('!' + key + '!',
CLIPrompterMessages.getString(key, new Object[] {}));
} }
} }

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* * Copyright (C) 2014-2018 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -33,60 +30,57 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.command.MockCommand.java * gclc:fr.bigeon.gclc.proc.ProcessList.java
* Created on: Nov 18, 2016 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.command; package fr.bigeon.gclc.process;
import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleInput; import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import fr.bigeon.gclc.manager.ConsoleOutput;
/** This implement a command that does nothing. /** A command that will flag a task to stop
* <p>
* This class is intended for testing purpose only.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class MockCommand implements ICommand { public final class ProcessClear extends Command {
/** The taskpool */
private final TaskPool pool;
/** The command name. */ /** @param name the command name
private final String name; * @param pool the pool */
public ProcessClear(final String name, final TaskPool pool) {
/** Create the command. super(name);
* this.pool = pool;
* @param name the command name */
public MockCommand(final String name) {
this.name = name;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput, * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* String[]) */ * ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) { final String... args) throws CommandRunException {
// for (final String id : pool.getPIDs()) {
if (!pool.get(id).isRunning()) {
pool.remove(id);
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */
@Override
public String getCommandName() {
return name;
} }
return;
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#help(fr.bigeon.gclc.manager.
* ConsoleManager, java.lang.String[]) */
@Override
public void help(final ConsoleOutput manager,
final String... args) {
//
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */ * @see fr.bigeon.gclc.command.ICommand#tip() */
@SuppressWarnings("nls")
@Override @Override
public String tip() { public String tip() {
return "Request a process to stop (softly)";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return null; return null;
} }

View File

@@ -1,6 +1,6 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and

View File

@@ -1,6 +1,6 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and

View File

@@ -0,0 +1,65 @@
/*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
*
*/
package fr.bigeon.gclc.process;
import fr.bigeon.gclc.ApplicationAttachement;
import fr.bigeon.gclc.command.ICommandProvider;
import fr.bigeon.gclc.exception.InvalidCommandName;
/** @author Emmanuel Bigeon */
public class ScreenAttachement implements ApplicationAttachement {
private final TaskPool pool;
private final int lines;
/** @param pool the task pool to manage */
public ScreenAttachement(TaskPool pool, int lines) {
super();
this.pool = pool;
this.lines = lines;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc.
* ConsoleApplication) */
@Override
public void attach(ICommandProvider application) throws InvalidCommandName {
application.add(new ProcessKill("terminate", pool));
application.add(new ProcessList("list", pool));
application.add(new ProcessClear("clear", pool));
application.add(new CommandForeground("fg", pool));
application.add(new CommandFork("fork", application, pool, lines));
}
}

View File

@@ -1,6 +1,6 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and

View File

@@ -1,6 +1,6 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
@@ -50,10 +50,26 @@ public final class TaskPool {
private int count = 0; private int count = 0;
/** The lock for pid attribution synchronization. */ /** The lock for pid attribution synchronization. */
private final Object lock = new Object(); private final Object lock = new Object();
private final boolean autoClear;
/** Default constructor. */ /** Default constructor. */
public TaskPool() { public TaskPool() {
// this(true);
}
/** Default constructor. */
public TaskPool(boolean autoClear) {
this.autoClear = autoClear;
}
/** Remove a task from the pool
*
* @param pid the task id */
public void remove(String pid) {
synchronized (lock) {
running.remove(pid);
count = Math.min(count, Integer.parseInt(pid));
}
} }
/** Add a process in the pool. /** Add a process in the pool.
@@ -64,22 +80,23 @@ public final class TaskPool {
if (cmd == null) { if (cmd == null) {
throw new IllegalArgumentException("Task cannot be null"); //$NON-NLS-1$ throw new IllegalArgumentException("Task cannot be null"); //$NON-NLS-1$
} }
final String pid = getPID(); final String pid;
synchronized (lock) { synchronized (lock) {
pid = getPID();
running.put(pid, cmd); running.put(pid, cmd);
} }
if (autoClear) {
cmd.addInterruptionListener(new InterruptionListener() { cmd.addInterruptionListener(new InterruptionListener() {
@SuppressWarnings("synthetic-access") @SuppressWarnings("synthetic-access")
@Override @Override
public void interrupted() { public void interrupted() {
synchronized (lock) { synchronized (lock) {
running.remove(pid); remove(pid);
count = Math.min(count, Integer.parseInt(pid));
} }
cmd.rmInterruptionListener(this); cmd.rmInterruptionListener(this);
} }
}); });
}
return pid; return pid;
} }
@@ -112,4 +129,21 @@ public final class TaskPool {
public Collection<String> getPIDs() { public Collection<String> getPIDs() {
return new HashSet<>(running.keySet()); return new HashSet<>(running.keySet());
} }
/** @return if the clearing of ended task is automatic */
public boolean isAutoClearing() {
return autoClear;
}
/** Request all task to stop running.
* <p>
* This call does not guaranty end of execution, it is up to the task
* implementation to actually take into account the termination request. */
public void shutdown() {
synchronized (lock) {
for (final Task task : running.values()) {
task.setRunning(false);
}
}
}
} }

View File

@@ -1,6 +1,6 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
@@ -35,6 +35,8 @@
*/ */
package fr.bigeon.gclc.process; package fr.bigeon.gclc.process;
import java.util.concurrent.ExecutorService;
import fr.bigeon.gclc.command.Command; import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.exception.CommandRunException; import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleInput; import fr.bigeon.gclc.manager.ConsoleInput;
@@ -46,31 +48,35 @@ import fr.bigeon.gclc.manager.ConsoleOutput;
public abstract class TaskSpawner extends Command { public abstract class TaskSpawner extends Command {
/** The process pool */ /** The process pool */
private final TaskPool pool; private final TaskPool pool;
private final ExecutorService threadPool;
/** @param name the command name /** @param name the command name
* @param pool the pool */ * @param pool the pool */
public TaskSpawner(final String name, final TaskPool pool) { public TaskSpawner(final String name, final TaskPool pool,
ExecutorService threadPool) {
super(name); super(name);
this.pool = pool; this.pool = pool;
this.threadPool = threadPool;
} }
/** @param in the input /** @param in the input
* @param out the output * @param out the output
* @param args the arguments * @param args the arguments
* @return the process to start and add to the pool */ * @return the process to start and add to the pool
* @throws CommandRunException if the task creation failed */
protected abstract Task createTask(ConsoleOutput out, ConsoleInput in, protected abstract Task createTask(ConsoleOutput out, ConsoleInput in,
String... args); String... args) throws CommandRunException;
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager. * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */ * java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public final void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
final Task task = createTask(out, in, args); final Task task = createTask(out, in, args);
final Thread th = new Thread(task); final Thread th = new Thread(task);
pool.add(task); pool.add(task);
th.start(); threadPool.execute(th);
} }
} }

View File

@@ -0,0 +1,211 @@
/*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
*
*/
package fr.bigeon.gclc.process.io;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.tools.StringProvider;
/** @author Emmanuel Bigeon */
public final class ConnectingConsoleInput implements ConsoleInput {
private static final Logger LOGGER = Logger
.getLogger(ConnectingConsoleInput.class.getName());
private boolean close = false;
private StringProvider prompt;
private boolean prompting;
private final Object promptLock = new Object();
private final Object connectionLock = new Object();
private ConsoleInput connected;
private boolean disconnection;
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#close() */
@Override
public void close() throws IOException {
close = true;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override
public StringProvider getPrompt() {
return prompt;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
@Override
public void interruptPrompt() {
synchronized (promptLock) {
prompting = false;
if (connected != null) {
connected.interruptPrompt();
}
promptLock.notifyAll();
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */
@Override
public boolean isClosed() {
return close;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override
public String prompt() throws IOException {
return prompt(prompt.apply());
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools.
* StringProvider) */
@Override
public void setPrompt(StringProvider string) {
prompt = string;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override
public String prompt(long timeout) throws IOException {
return prompt(prompt.apply(), timeout);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
@Override
public String prompt(String message) throws IOException {
synchronized (promptLock) {
prompting = true;
}
while (prompting) {
synchronized (promptLock) {
if (connected == null) {
try {
promptLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, "Inerruption of console thread", e);
Thread.currentThread().interrupt();
}
} else {
final String res = connected.prompt(message);
synchronized (connectionLock) {
if (disconnection) {
disconnection = false;
} else if (prompting) {
return res;
}
}
}
}
}
return null;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override
public String prompt(String message, long timeout) throws IOException {
if (timeout <= 0) {
return prompt(message);
}
final long end = System.currentTimeMillis() + timeout;
synchronized (promptLock) {
prompting = true;
}
while (prompting) {
synchronized (promptLock) {
if (connected == null) {
try {
promptLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, "Inerruption of console thread", e);
Thread.currentThread().interrupt();
}
} else {
final String res = connected.prompt(message,
end - System.currentTimeMillis());
synchronized (connectionLock) {
if (disconnection) {
disconnection = false;
} else if (prompting) {
return res;
}
}
}
}
}
return null;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override
public void setPrompt(final String prompt) {
this.prompt = new StringProvider() {
@Override
public String apply() {
return prompt;
}
};
}
public void connect(ConsoleInput input) {
disconnect();
synchronized (promptLock) {
connected = input;
promptLock.notifyAll();
}
}
public void disconnect() {
synchronized (connectionLock) {
if (connected != null) {
disconnection = true;
synchronized (promptLock) {
connected.interruptPrompt();
}
connected = null;
}
}
}
}

View File

@@ -0,0 +1,146 @@
/*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
*
*/
package fr.bigeon.gclc.process.io;
import java.io.IOException;
import java.util.ArrayDeque;
import java.util.Deque;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** @author Emmanuel Bigeon */
public class ConnectingConsoleOutput implements ConsoleOutput {
private static final Logger LOGGER = Logger
.getLogger(ConnectingConsoleOutput.class.getName());
/** If the undelivered message should be stored. */
public static final int QUEUE = 1;
/** If the messages should be stored in all cases. */
public static final int PERSIST = 1 << 1;
private ConsoleOutput output;
private boolean close = false;
private final boolean persistent;
private final boolean queued;
private final Deque<String> messages;
private final int lines;
/** @param style the type of redirected output
* @param lines the number of lines to store */
public ConnectingConsoleOutput(int style, int lines) {
super();
this.lines = lines;
queued = (style & QUEUE) != 0;
persistent = (style & PERSIST) != 0;
if (lines > 0) {
messages = new ArrayDeque<>(lines);
} else {
messages = new ArrayDeque<>();
}
}
private synchronized void addMessage(String text) {
if (persistent || queued && output == null) {
if (messages.size() == lines) {
messages.poll();
}
messages.offer(text);
}
if (output != null) {
try {
output.print(text);
} catch (final IOException e) {
LOGGER.severe("nable to print to connecting console");
LOGGER.log(Level.FINE, "Console error", e);
}
}
}
/* (non-Javadoc)
* @see java.lang.AutoCloseable#close() */
@Override
public void close() {
close = true;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */
@Override
public boolean isClosed() {
return close;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
@Override
public void print(String text) {
addMessage(text);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */
@Override
public void println() {
addMessage(System.lineSeparator());
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
@Override
public void println(String message) {
addMessage(message + System.lineSeparator());
}
public synchronized void connect(ConsoleOutput output) {
this.output = output;
for (final String string : messages) {
try {
output.print(string);
} catch (final IOException e) {
LOGGER.severe("nable to print to connecting console");
LOGGER.log(Level.FINE, "Console error", e);
}
}
if (!persistent) {
messages.clear();
}
}
public synchronized void disconnect() {
output = null;
}
}

517
gclc-socket/LICENSE.txt Normal file
View File

@@ -0,0 +1,517 @@
CeCILL FREE SOFTWARE LICENSE AGREEMENT
Version 2.1 dated 2013-06-21
Notice
This Agreement is a Free Software license agreement that is the result
of discussions between its authors in order to ensure compliance with
the two main principles guiding its drafting:
* firstly, compliance with the principles governing the distribution
of Free Software: access to source code, broad rights granted to users,
* secondly, the election of a governing law, French law, with which it
is conformant, both as regards the law of torts and intellectual
property law, and the protection that it offers to both authors and
holders of the economic rights over software.
The authors of the CeCILL (for Ce[a] C[nrs] I[nria] L[ogiciel] L[ibre])
license are:
Commissariat à l'énergie atomique et aux énergies alternatives - CEA, a
public scientific, technical and industrial research establishment,
having its principal place of business at 25 rue Leblanc, immeuble Le
Ponant D, 75015 Paris, France.
Centre National de la Recherche Scientifique - CNRS, a public scientific
and technological establishment, having its principal place of business
at 3 rue Michel-Ange, 75794 Paris cedex 16, France.
Institut National de Recherche en Informatique et en Automatique -
Inria, a public scientific and technological establishment, having its
principal place of business at Domaine de Voluceau, Rocquencourt, BP
105, 78153 Le Chesnay cedex, France.
Preamble
The purpose of this Free Software license agreement is to grant users
the right to modify and redistribute the software governed by this
license within the framework of an open source distribution model.
The exercising of this right is conditional upon certain obligations for
users so as to preserve this status for all subsequent redistributions.
In consideration of access to the source code and the rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors only have limited liability.
In this respect, the risks associated with loading, using, modifying
and/or developing or reproducing the software by the user are brought to
the user's attention, given its Free Software status, which may make it
complicated to use, with the result that its use is reserved for
developers and experienced professionals having in-depth computer
knowledge. Users are therefore encouraged to load and test the
suitability of the software as regards their requirements in conditions
enabling the security of their systems and/or data to be ensured and,
more generally, to use and operate it in the same conditions of
security. This Agreement may be freely reproduced and published,
provided it is not altered, and that no provisions are either added or
removed herefrom.
This Agreement may apply to any or all software for which the holder of
the economic rights decides to submit the use thereof to its provisions.
Frequently asked questions can be found on the official website of the
CeCILL licenses family (http://www.cecill.info/index.en.html) for any
necessary clarification.
Article 1 - DEFINITIONS
For the purpose of this Agreement, when the following expressions
commence with a capital letter, they shall have the following meaning:
Agreement: means this license agreement, and its possible subsequent
versions and annexes.
Software: means the software in its Object Code and/or Source Code form
and, where applicable, its documentation, "as is" when the Licensee
accepts the Agreement.
Initial Software: means the Software in its Source Code and possibly its
Object Code form and, where applicable, its documentation, "as is" when
it is first distributed under the terms and conditions of the Agreement.
Modified Software: means the Software modified by at least one
Contribution.
Source Code: means all the Software's instructions and program lines to
which access is required so as to modify the Software.
Object Code: means the binary files originating from the compilation of
the Source Code.
Holder: means the holder(s) of the economic rights over the Initial
Software.
Licensee: means the Software user(s) having accepted the Agreement.
Contributor: means a Licensee having made at least one Contribution.
Licensor: means the Holder, or any other individual or legal entity, who
distributes the Software under the Agreement.
Contribution: means any or all modifications, corrections, translations,
adaptations and/or new functions integrated into the Software by any or
all Contributors, as well as any or all Internal Modules.
Module: means a set of sources files including their documentation that
enables supplementary functions or services in addition to those offered
by the Software.
External Module: means any or all Modules, not derived from the
Software, so that this Module and the Software run in separate address
spaces, with one calling the other when they are run.
Internal Module: means any or all Module, connected to the Software so
that they both execute in the same address space.
GNU GPL: means the GNU General Public License version 2 or any
subsequent version, as published by the Free Software Foundation Inc.
GNU Affero GPL: means the GNU Affero General Public License version 3 or
any subsequent version, as published by the Free Software Foundation Inc.
EUPL: means the European Union Public License version 1.1 or any
subsequent version, as published by the European Commission.
Parties: mean both the Licensee and the Licensor.
These expressions may be used both in singular and plural form.
Article 2 - PURPOSE
The purpose of the Agreement is the grant by the Licensor to the
Licensee of a non-exclusive, transferable and worldwide license for the
Software as set forth in Article 5 <#scope> hereinafter for the whole
term of the protection granted by the rights over said Software.
Article 3 - ACCEPTANCE
3.1 The Licensee shall be deemed as having accepted the terms and
conditions of this Agreement upon the occurrence of the first of the
following events:
* (i) loading the Software by any or all means, notably, by
downloading from a remote server, or by loading from a physical medium;
* (ii) the first time the Licensee exercises any of the rights granted
hereunder.
3.2 One copy of the Agreement, containing a notice relating to the
characteristics of the Software, to the limited warranty, and to the
fact that its use is restricted to experienced users has been provided
to the Licensee prior to its acceptance as set forth in Article 3.1
<#accepting> hereinabove, and the Licensee hereby acknowledges that it
has read and understood it.
Article 4 - EFFECTIVE DATE AND TERM
4.1 EFFECTIVE DATE
The Agreement shall become effective on the date when it is accepted by
the Licensee as set forth in Article 3.1 <#accepting>.
4.2 TERM
The Agreement shall remain in force for the entire legal term of
protection of the economic rights over the Software.
Article 5 - SCOPE OF RIGHTS GRANTED
The Licensor hereby grants to the Licensee, who accepts, the following
rights over the Software for any or all use, and for the term of the
Agreement, on the basis of the terms and conditions set forth hereinafter.
Besides, if the Licensor owns or comes to own one or more patents
protecting all or part of the functions of the Software or of its
components, the Licensor undertakes not to enforce the rights granted by
these patents against successive Licensees using, exploiting or
modifying the Software. If these patents are transferred, the Licensor
undertakes to have the transferees subscribe to the obligations set
forth in this paragraph.
5.1 RIGHT OF USE
The Licensee is authorized to use the Software, without any limitation
as to its fields of application, with it being hereinafter specified
that this comprises:
1. permanent or temporary reproduction of all or part of the Software
by any or all means and in any or all form.
2. loading, displaying, running, or storing the Software on any or all
medium.
3. entitlement to observe, study or test its operation so as to
determine the ideas and principles behind any or all constituent
elements of said Software. This shall apply when the Licensee
carries out any or all loading, displaying, running, transmission or
storage operation as regards the Software, that it is entitled to
carry out hereunder.
5.2 ENTITLEMENT TO MAKE CONTRIBUTIONS
The right to make Contributions includes the right to translate, adapt,
arrange, or make any or all modifications to the Software, and the right
to reproduce the resulting software.
The Licensee is authorized to make any or all Contributions to the
Software provided that it includes an explicit notice that it is the
author of said Contribution and indicates the date of the creation thereof.
5.3 RIGHT OF DISTRIBUTION
In particular, the right of distribution includes the right to publish,
transmit and communicate the Software to the general public on any or
all medium, and by any or all means, and the right to market, either in
consideration of a fee, or free of charge, one or more copies of the
Software by any means.
The Licensee is further authorized to distribute copies of the modified
or unmodified Software to third parties according to the terms and
conditions set forth hereinafter.
5.3.1 DISTRIBUTION OF SOFTWARE WITHOUT MODIFICATION
The Licensee is authorized to distribute true copies of the Software in
Source Code or Object Code form, provided that said distribution
complies with all the provisions of the Agreement and is accompanied by:
1. a copy of the Agreement,
2. a notice relating to the limitation of both the Licensor's warranty
and liability as set forth in Articles 8 and 9,
and that, in the event that only the Object Code of the Software is
redistributed, the Licensee allows effective access to the full Source
Code of the Software for a period of at least three years from the
distribution of the Software, it being understood that the additional
acquisition cost of the Source Code shall not exceed the cost of the
data transfer.
5.3.2 DISTRIBUTION OF MODIFIED SOFTWARE
When the Licensee makes a Contribution to the Software, the terms and
conditions for the distribution of the resulting Modified Software
become subject to all the provisions of this Agreement.
The Licensee is authorized to distribute the Modified Software, in
source code or object code form, provided that said distribution
complies with all the provisions of the Agreement and is accompanied by:
1. a copy of the Agreement,
2. a notice relating to the limitation of both the Licensor's warranty
and liability as set forth in Articles 8 and 9,
and, in the event that only the object code of the Modified Software is
redistributed,
3. a note stating the conditions of effective access to the full source
code of the Modified Software for a period of at least three years
from the distribution of the Modified Software, it being understood
that the additional acquisition cost of the source code shall not
exceed the cost of the data transfer.
5.3.3 DISTRIBUTION OF EXTERNAL MODULES
When the Licensee has developed an External Module, the terms and
conditions of this Agreement do not apply to said External Module, that
may be distributed under a separate license agreement.
5.3.4 COMPATIBILITY WITH OTHER LICENSES
The Licensee can include a code that is subject to the provisions of one
of the versions of the GNU GPL, GNU Affero GPL and/or EUPL in the
Modified or unmodified Software, and distribute that entire code under
the terms of the same version of the GNU GPL, GNU Affero GPL and/or EUPL.
The Licensee can include the Modified or unmodified Software in a code
that is subject to the provisions of one of the versions of the GNU GPL,
GNU Affero GPL and/or EUPL and distribute that entire code under the
terms of the same version of the GNU GPL, GNU Affero GPL and/or EUPL.
Article 6 - INTELLECTUAL PROPERTY
6.1 OVER THE INITIAL SOFTWARE
The Holder owns the economic rights over the Initial Software. Any or
all use of the Initial Software is subject to compliance with the terms
and conditions under which the Holder has elected to distribute its work
and no one shall be entitled to modify the terms and conditions for the
distribution of said Initial Software.
The Holder undertakes that the Initial Software will remain ruled at
least by this Agreement, for the duration set forth in Article 4.2 <#term>.
6.2 OVER THE CONTRIBUTIONS
The Licensee who develops a Contribution is the owner of the
intellectual property rights over this Contribution as defined by
applicable law.
6.3 OVER THE EXTERNAL MODULES
The Licensee who develops an External Module is the owner of the
intellectual property rights over this External Module as defined by
applicable law and is free to choose the type of agreement that shall
govern its distribution.
6.4 JOINT PROVISIONS
The Licensee expressly undertakes:
1. not to remove, or modify, in any manner, the intellectual property
notices attached to the Software;
2. to reproduce said notices, in an identical manner, in the copies of
the Software modified or not.
The Licensee undertakes not to directly or indirectly infringe the
intellectual property rights on the Software of the Holder and/or
Contributors, and to take, where applicable, vis-à-vis its staff, any
and all measures required to ensure respect of said intellectual
property rights of the Holder and/or Contributors.
Article 7 - RELATED SERVICES
7.1 Under no circumstances shall the Agreement oblige the Licensor to
provide technical assistance or maintenance services for the Software.
However, the Licensor is entitled to offer this type of services. The
terms and conditions of such technical assistance, and/or such
maintenance, shall be set forth in a separate instrument. Only the
Licensor offering said maintenance and/or technical assistance services
shall incur liability therefor.
7.2 Similarly, any Licensor is entitled to offer to its licensees, under
its sole responsibility, a warranty, that shall only be binding upon
itself, for the redistribution of the Software and/or the Modified
Software, under terms and conditions that it is free to decide. Said
warranty, and the financial terms and conditions of its application,
shall be subject of a separate instrument executed between the Licensor
and the Licensee.
Article 8 - LIABILITY
8.1 Subject to the provisions of Article 8.2, the Licensee shall be
entitled to claim compensation for any direct loss it may have suffered
from the Software as a result of a fault on the part of the relevant
Licensor, subject to providing evidence thereof.
8.2 The Licensor's liability is limited to the commitments made under
this Agreement and shall not be incurred as a result of in particular:
(i) loss due the Licensee's total or partial failure to fulfill its
obligations, (ii) direct or consequential loss that is suffered by the
Licensee due to the use or performance of the Software, and (iii) more
generally, any consequential loss. In particular the Parties expressly
agree that any or all pecuniary or business loss (i.e. loss of data,
loss of profits, operating loss, loss of customers or orders,
opportunity cost, any disturbance to business activities) or any or all
legal proceedings instituted against the Licensee by a third party,
shall constitute consequential loss and shall not provide entitlement to
any or all compensation from the Licensor.
Article 9 - WARRANTY
9.1 The Licensee acknowledges that the scientific and technical
state-of-the-art when the Software was distributed did not enable all
possible uses to be tested and verified, nor for the presence of
possible defects to be detected. In this respect, the Licensee's
attention has been drawn to the risks associated with loading, using,
modifying and/or developing and reproducing the Software which are
reserved for experienced users.
The Licensee shall be responsible for verifying, by any or all means,
the suitability of the product for its requirements, its good working
order, and for ensuring that it shall not cause damage to either persons
or properties.
9.2 The Licensor hereby represents, in good faith, that it is entitled
to grant all the rights over the Software (including in particular the
rights set forth in Article 5 <#scope>).
9.3 The Licensee acknowledges that the Software is supplied "as is" by
the Licensor without any other express or tacit warranty, other than
that provided for in Article 9.2 <#good-faith> and, in particular,
without any warranty as to its commercial value, its secured, safe,
innovative or relevant nature.
Specifically, the Licensor does not warrant that the Software is free
from any error, that it will operate without interruption, that it will
be compatible with the Licensee's own equipment and software
configuration, nor that it will meet the Licensee's requirements.
9.4 The Licensor does not either expressly or tacitly warrant that the
Software does not infringe any third party intellectual property right
relating to a patent, software or any other property right. Therefore,
the Licensor disclaims any and all liability towards the Licensee
arising out of any or all proceedings for infringement that may be
instituted in respect of the use, modification and redistribution of the
Software. Nevertheless, should such proceedings be instituted against
the Licensee, the Licensor shall provide it with technical and legal
expertise for its defense. Such technical and legal expertise shall be
decided on a case-by-case basis between the relevant Licensor and the
Licensee pursuant to a memorandum of understanding. The Licensor
disclaims any and all liability as regards the Licensee's use of the
name of the Software. No warranty is given as regards the existence of
prior rights over the name of the Software or as regards the existence
of a trademark.
Article 10 - TERMINATION
10.1 In the event of a breach by the Licensee of its obligations
hereunder, the Licensor may automatically terminate this Agreement
thirty (30) days after notice has been sent to the Licensee and has
remained ineffective.
10.2 A Licensee whose Agreement is terminated shall no longer be
authorized to use, modify or distribute the Software. However, any
licenses that it may have granted prior to termination of the Agreement
shall remain valid subject to their having been granted in compliance
with the terms and conditions hereof.
Article 11 - MISCELLANEOUS
11.1 EXCUSABLE EVENTS
Neither Party shall be liable for any or all delay, or failure to
perform the Agreement, that may be attributable to an event of force
majeure, an act of God or an outside cause, such as defective
functioning or interruptions of the electricity or telecommunications
networks, network paralysis following a virus attack, intervention by
government authorities, natural disasters, water damage, earthquakes,
fire, explosions, strikes and labor unrest, war, etc.
11.2 Any failure by either Party, on one or more occasions, to invoke
one or more of the provisions hereof, shall under no circumstances be
interpreted as being a waiver by the interested Party of its right to
invoke said provision(s) subsequently.
11.3 The Agreement cancels and replaces any or all previous agreements,
whether written or oral, between the Parties and having the same
purpose, and constitutes the entirety of the agreement between said
Parties concerning said purpose. No supplement or modification to the
terms and conditions hereof shall be effective as between the Parties
unless it is made in writing and signed by their duly authorized
representatives.
11.4 In the event that one or more of the provisions hereof were to
conflict with a current or future applicable act or legislative text,
said act or legislative text shall prevail, and the Parties shall make
the necessary amendments so as to comply with said act or legislative
text. All other provisions shall remain effective. Similarly, invalidity
of a provision of the Agreement, for any reason whatsoever, shall not
cause the Agreement as a whole to be invalid.
11.5 LANGUAGE
The Agreement is drafted in both French and English and both versions
are deemed authentic.
Article 12 - NEW VERSIONS OF THE AGREEMENT
12.1 Any person is authorized to duplicate and distribute copies of this
Agreement.
12.2 So as to ensure coherence, the wording of this Agreement is
protected and may only be modified by the authors of the License, who
reserve the right to periodically publish updates or new versions of the
Agreement, each with a separate number. These subsequent versions may
address new issues encountered by Free Software.
12.3 Any Software distributed under a given version of the Agreement may
only be subsequently distributed under the same version of the Agreement
or a subsequent version, subject to the provisions of Article 5.3.4
<#compatibility>.
Article 13 - GOVERNING LAW AND JURISDICTION
13.1 The Agreement is governed by French law. The Parties agree to
endeavor to seek an amicable solution to any disagreements or disputes
that may arise during the performance of the Agreement.
13.2 Failing an amicable solution within two (2) months as from their
occurrence, and unless emergency proceedings are necessary, the
disagreements or disputes shall be referred to the Paris Courts having
jurisdiction, by the more diligent Party.

View File

@@ -1,4 +1,35 @@
<!-- GCLC Socket, Socket implementation of GCLC -->
<!-- Copyright (C) 2014-2017 E. Bigeon -->
<!-- mailto:emmanuel@bigeon.fr -->
<!-- -->
<!-- This software is governed by the CeCILL license under French law and -->
<!-- abiding by the rules of distribution of free software. You can use, -->
<!-- modify and/or redistribute the software under the terms of the CeCILL -->
<!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
<!-- "http://www.cecill.info". -->
<!-- -->
<!-- As a counterpart to the access to the source code and rights to copy, -->
<!-- modify and redistribute granted by the license, users are provided only -->
<!-- with a limited warranty and the software's author, the holder of the -->
<!-- economic rights, and the successive licensors have only limited -->
<!-- liability. -->
<!-- -->
<!-- In this respect, the user's attention is drawn to the risks associated -->
<!-- with loading, using, modifying and/or developing or reproducing the -->
<!-- software by the user in light of its specific status of free software, -->
<!-- that may mean that it is complicated to manipulate, and that also -->
<!-- therefore means that it is reserved for developers and experienced -->
<!-- professionals having in-depth computer knowledge. Users are therefore -->
<!-- encouraged to load and test the software's suitability as regards their -->
<!-- requirements in conditions enabling the security of their systems and/or -->
<!-- data to be ensured and, more generally, to use and operate it in the -->
<!-- same conditions as regards security. -->
<!-- -->
<!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. -->
<!-- Copyright E. Bigeon (2014) --> <!-- Copyright E. Bigeon (2014) -->
<!-- --> <!-- -->
<!-- emmanuel@bigeon.fr --> <!-- emmanuel@bigeon.fr -->
@@ -38,8 +69,8 @@
<!-- emmanuel@bigeon.fr --> <!-- emmanuel@bigeon.fr -->
<!-- --> <!-- -->
<!-- This software is a computer program whose purpose is to --> <!-- This software is a computer program whose purpose is to -->
<!-- Defines the distribution repositories and basic setup for projects <!-- Defines the distribution repositories and basic setup for projects of
of Emmanuel Bigeon. --> Emmanuel Bigeon. -->
<!-- --> <!-- -->
<!-- This software is governed by the CeCILL license under French law and --> <!-- This software is governed by the CeCILL license under French law and -->
<!-- abiding by the rules of distribution of free software. You can use, --> <!-- abiding by the rules of distribution of free software. You can use, -->
@@ -67,37 +98,74 @@ of Emmanuel Bigeon. -->
<!-- The fact that you are presently reading this means that you have had --> <!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. --> <!-- knowledge of the CeCILL license and that you accept its terms. -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<artifactId>gclc-socket</artifactId> <artifactId>gclc-socket</artifactId>
<version>1.1.9-SNAPSHOT</version> <version>1.1.10-SNAPSHOT</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<url>http://www.bigeon.fr/emmanuel</url> <url>http://www.bigeon.net</url>
<properties> <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.scm.id>git.bigeon.net</project.scm.id> <project.scm.id>git.code.bigeon.net</project.scm.id>
<license.licenseName>cecill_2.1</license.licenseName>
<copyright.email>emmanuel@bigeon.fr</copyright.email>
</properties> </properties>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>fr.bigeon</groupId> <groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId> <artifactId>gclc</artifactId>
<version>1.5.0</version> <version>2.0.5</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>fr.bigeon</groupId> <groupId>fr.bigeon</groupId>
<artifactId>smu</artifactId> <artifactId>smu</artifactId>
<version>0.0.5</version> <version>0.0.9</version>
</dependency> </dependency>
</dependencies> </dependencies>
<parent> <parent>
<groupId>fr.bigeon</groupId> <groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId> <artifactId>ebigeon-config</artifactId>
<version>1.7.1</version> <version>1.8.3</version>
</parent> </parent>
<licenses>
<license>
<distribution>manual</distribution>
<name>CeCILL 2.1</name>
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
</license>
</licenses>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>dsm-maven-plugin</artifactId>
<version>2.2.0</version>
</plugin>
</plugins>
</reporting>
<developers>
<developer>
<email>emmanuel@bigeon.fr</email>
<name>Emmanuel Bigeon</name>
<url>bigeon.net</url>
<roles>
<role>PM</role>
</roles>
</developer>
</developers>
<name>GCLC Socket</name> <name>GCLC Socket</name>
<description>Socket implementation of GCLC</description> <description>Socket implementation of GCLC</description>
<scm> <scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag> <tag>HEAD</tag>
</scm> </scm>
<groupId>net.bigeon.gclc</groupId>
<inceptionYear>2016</inceptionYear>
</project> </project>

View File

@@ -0,0 +1,100 @@
/**
* gclc-socket:fr.bigeon.gclc.socket.ConnexionManager.java
* Created on: Nov 18, 2017
*/
package fr.bigeon.gclc.socket;
/*-
* #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.util.Collection;
/** A manager for connected elements.
* <p>
* Connected elements are given an identifier (unique) at connexion.
*
* @author Emmanuel Bigeon
* @param <T> the type of object connected */
public interface ConnexionManager<T> {
/** Add a connection in the name.
*
* @param handle the connected object
* @return the name */
String addConnexion(T handle);
/** Disconnect an element.
*
* @param id the element connection id
* @return the object being disconnected */
T disconnect(String id);
/** Get the connected object.
*
* @param id the connexion id
* @return the object */
T get(String id);
/** Get the connected elements' ids.
*
* @return the connected elements' ids */
Collection<String> getConnected();
/** Test if a connection is active.
*
* @param id the connexion id
* @return if the connection is active. */
boolean isConnected(String id);
/** Add a lock on the disconnection.
* <p>
* This lock will <strong>not</strong> prevent calls to
* {@link #disconnect(String)}. It will however stop them from completing after
* the effective disconnection of the specified connection.
* <p>
* Calls to {@link #releaseDisconnexionLock(String)} remove a lock (at a pace of
* one for one).
*
* @param id the connexion id */
void lockDisconnexion(String id);
/** Release one lock on a disconnection
*
* @param id the connexion being released. */
void releaseDisconnexionLock(String id);
/** Wait for calls to {@link #disconnect(String)}
*
* @param id the connexion id
* @throws InterruptedException if the wait was interrupted. */
void waitDisconnexion(String id) throws InterruptedException;
}

View File

@@ -1,133 +0,0 @@
/*
* Copyright E. Bigeon (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* Socket implementation of GCLC.
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
* gclc-socket:fr.bigeon.gclc.socket.ConsoleRunnable.java
* Created on: Jun 1, 2016
*/
package fr.bigeon.gclc.socket;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.ConsoleApplication;
/** A runnable class that will actually have the application running.
*
* @author Emmanuel Bigeon */
public class ConsoleRunnable implements Runnable {
/** The wait timeout */
private static final long TIMEOUT = 100;
/** The logger */
private static final Logger LOGGER = Logger
.getLogger(ConsoleRunnable.class.getName());
/** The actual application */
private final ConsoleApplication app;
/** The synchro object */
private final Object lock = new Object();
/** the state of this runnable */
private boolean running = true;
/** If a start is required */
private boolean startReq;
/** @param app the application */
public ConsoleRunnable(ConsoleApplication app) {
super();
this.app = app;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
while (running) {
synchronized (lock) {
while (running && !startReq) {
try {
lock.wait(TIMEOUT);
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE,
"Console application runnable interrupted wildly!", //$NON-NLS-1$
e);
return;
}
}
startReq = false;
if (!running) {
return;
}
lock.notify();
}
app.start();
}
}
/** Stop the application (it will finish its current operation) */
public void stop() {
app.exit();
}
/** @return if the application is running */
public boolean isApplicationRunning() {
return app.isRunning();
}
/** @param running the running to set */
public void setRunning(boolean running) {
synchronized (lock) {
this.running = running;
}
}
/** @return the running */
public boolean isRunning() {
synchronized (lock) {
return running;
}
}
/** Request a restart of application */
public void restart() {
synchronized (lock) {
startReq = true;
lock.notify();
try {
lock.wait(TIMEOUT);
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE, "Restart wait interrupted!", e); //$NON-NLS-1$
}
}
}
}

View File

@@ -0,0 +1,175 @@
/**
* gclc-socket:fr.bigeon.gclc.socket.DConnexionManager.java
* Created on: Nov 18, 2017
*/
package fr.bigeon.gclc.socket;
/*-
* #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
/** Default implementation of the {@link ConnexionManager}.
*
* @author Emmanuel Bigeon
* @param <T> the connected objects */
public final class DConnexionManager<T> implements ConnexionManager<T> {
/** Class logger. */
private static final Logger LOGGER = Logger
.getLogger(DConnexionManager.class.getName());
/** The connected objects. */
private final Map<String, T> connecteds = new HashMap<>();
/** The locks for the connexions. */
private final Map<String, Object> locks = new HashMap<>();
/** The counter for the disconnexion locks. */
private final Map<String, Integer> counters = new HashMap<>();
/** The lock for modification of {@link #counters}. */
private final Object counterLock = new Object();
/** The count of connexions. */
private int count = 0;
/** Default.constructor. */
public DConnexionManager() {
//
}
/* (non-Javadoc)
* @see
* fr.bigeon.gclc.socket.ConnexionManager#addConnexion(java.lang.Object) */
@Override
public String addConnexion(final T handle) {
final String newID = newID();
connecteds.put(newID, handle);
locks.put(newID, new Object());
counters.put(newID, Integer.valueOf(0));
return newID;
}
/* (non-Javadoc)
* @see
* fr.bigeon.gclc.socket.ConnexionManager#disconnect(java.lang.String) */
@Override
public T disconnect(final String id) {
if (connecteds.containsKey(id)) {
final T disc = connecteds.remove(id);
final Object lock = locks.get(id);
synchronized (lock) {
lock.notifyAll();
}
synchronized (counterLock) {
while (counters.get(id).intValue() > 0) {
try {
counterLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
Thread.currentThread().interrupt();
}
}
}
return disc;
}
return null;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.socket.ConnexionManager#get(java.lang.String) */
@Override
public T get(final String id) {
return connecteds.get(id);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.socket.ConnexionManager#getConnected() */
@Override
public Collection<String> getConnected() {
return connecteds.keySet();
}
/* (non-Javadoc)
* @see
* fr.bigeon.gclc.socket.ConnexionManager#isConnected(java.lang.String) */
@Override
public boolean isConnected(final String id) {
return connecteds.containsKey(id);
}
/* (non-Javadoc)
* @see
* fr.bigeon.gclc.socket.ConnexionManager#lockDisconnexion(java.lang.String) */
@Override
public void lockDisconnexion(final String id) {
if (!connecteds.containsKey(id)) {
return;
}
synchronized (counterLock) {
counters.put(id, Integer.valueOf(counters.get(id).intValue() + 1));
}
}
/** Get a new identifier for connexion.
*
* @return a new ID */
private String newID() {
return "Client " + count++; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see
* fr.bigeon.gclc.socket.ConnexionManager#releaseDisconnexionLock(java.lang.
* String) */
@Override
public void releaseDisconnexionLock(final String id) {
synchronized (counterLock) {
counters.put(id, Integer
.valueOf(Math.max(counters.get(id).intValue() - 1, 0)));
counterLock.notifyAll();
}
}
/* (non-Javadoc)
* @see
* fr.bigeon.gclc.socket.ConnexionManager#waitDisconnexion(java.lang.String) */
@Override
public void waitDisconnexion(final String id) throws InterruptedException {
final Object lock = locks.get(id);
while (connecteds.containsKey(id)) {
synchronized (lock) {
lock.wait();
}
}
}
}

View File

@@ -0,0 +1,286 @@
/**
* gclc-socket:fr.bigeon.gclc.socket.PlugableConsoleInput.java
* Created on: Nov 18, 2017
*/
package fr.bigeon.gclc.socket;
/*-
* #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ReadingRunnable;
import fr.bigeon.gclc.tools.ConstantString;
import fr.bigeon.gclc.tools.StringProvider;
/** A console input where the stream can be plugged.
* <p>
* This pluggable console input accepts an input and output to be connected to
* it. The connexion cannot be concurrent, which mean that any connected stream
* must be disconnected before a new call to
* {@link #connect(InputStream, PrintStream)} is done.
*
* @author Emmanuel Bigeon */
public final class PluggableConsoleInput implements ConsoleInput {
/** The ten constant. */
private static final int TENTH = 10;
/** Class logger. */
private static final Logger LOGGER = Logger
.getLogger(PluggableConsoleInput.class.getName());
/** The default time out. */
private static final long TIMEOUT = 100;
/** The prompting. */
private boolean prompting = false;
/** If the element is closed. */
private boolean closed = false;
/** The default prompt. */
private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
/** If the input is plugged or buffering. */
private boolean connected = false;
/** The current connexion (if any). */
private ReadingRunnable connexion;
/** The interrupted status for prompts. */
private boolean interrupted = false;
/** The last hint hint. */
private String hint;
/** The output for hints. */
private PrintStream output;
// Locks
/** The lock for connexion and disconnexion of actual streams. */
private final Object connexionLock = new Object();
/** Create the pluggable console input. */
public PluggableConsoleInput() {
// do nothing
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#close() */
@Override
public void close() {
closed = true;
}
/** Connect the given input stream to the input and output to the hints
* writing.
*
* @param stream the input stream
* @param out the output for hints.
* @throws IOException if the input is already connected. */
public void connect(final InputStream stream,
final PrintStream out) throws IOException {
synchronized (connexionLock) {
if (connected) {
throw new IOException(
"Input already connected to an input stream"); //$NON-NLS-1$
}
output = out;
if (prompting) {
out.print(hint);
out.flush();
}
final InputStreamReader streamReader = new InputStreamReader(
stream, StandardCharsets.UTF_8);
final BufferedReader reader = new BufferedReader(streamReader);
connexion = new ReadingRunnable(reader);
final Thread th = new Thread(connexion, "GCLC Socket - Read input"); //$NON-NLS-1$
th.start();
connexionLock.notifyAll();
connected = true;
}
}
/** Disconnect the current input and hint output. */
public synchronized void disconnect() {
synchronized (connexionLock) {
if (!connected) {
return;
}
connected = false;
connexion.setRunning(false);
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override
public StringProvider getPrompt() {
return prompt;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
@Override
public void interruptPrompt() {
interrupted = true;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */
@Override
public boolean isClosed() {
return closed;
}
/** Test if a prompt is occuring.
*
* @return the prompting */
public boolean isPrompting() {
return prompting;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override
public String prompt() throws IOException {
return prompt(prompt.apply());
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override
public String prompt(final long timeout) throws IOException {
return prompt(prompt.apply(), timeout);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
@Override
public String prompt(final String message) throws IOException {
if (closed) {
throw new IOException();
}
prompting = true;
hint = message;
synchronized (connexionLock) {
hint = message;
if (connected) {
output.print(message);
output.flush();
}
}
String res = null;
while (res == null && !interrupted) {
try {
res = waitMessageOrConnexion(TIMEOUT, TIMEOUT / TENTH);
} catch (final InterruptedException e) {
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
Thread.currentThread().interrupt();
}
if (closed) {
throw new IOException();
}
}
prompting = false;
return res;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
* long) */
@Override
public String prompt(final String message,
final long timeout) throws IOException {
if (closed) {
throw new IOException();
}
prompting = true;
synchronized (connexionLock) {
hint = message;
if (connected) {
output.print(message);
output.flush();
}
}
String res = null;
final long tic = System.currentTimeMillis();
long time = System.currentTimeMillis() - tic;
while (res == null && !interrupted && time < timeout) {
try {
res = waitMessageOrConnexion(timeout - time,
(timeout - time) / TENTH);
} catch (final InterruptedException e) {
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
Thread.currentThread().interrupt();
}
time = System.currentTimeMillis() - tic;
if (closed) {
throw new IOException();
}
}
prompting = false;
return res;
}
@Override
public void setPrompt(final StringProvider prompt) {
this.prompt = prompt;
}
@Override
public void setPrompt(String prompt) {
setPrompt(new ConstantString(prompt));
}
/** Wait for a hint or connexion.
*
* @param messageTimeout the timeout on the current connexion hint waiting
* @param connexionTimeout the timeout on the new connexion wait
* @return the hint, or null if not connected or timed out.
* @throws IOException if the reading failed.
* @throws InterruptedException if the wait was interrupted */
private String waitMessageOrConnexion(final long messageTimeout,
final long connexionTimeout) throws IOException,
InterruptedException {
synchronized (connexionLock) {
if (connected) {
return connexion.getNextMessage(messageTimeout);
}
connexionLock.wait(connexionTimeout);
}
return null;
}
}

View File

@@ -0,0 +1,128 @@
/**
* gclc-socket:fr.bigeon.gclc.socket.PluggableConsoleOutput.java
* Created on: Nov 18, 2017
*/
package fr.bigeon.gclc.socket;
/*-
* #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import java.io.PrintStream;
import java.util.ArrayDeque;
import java.util.Deque;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** An output that can be hotplugged to an actual output.
*
* @author Emmanuel Bigeon */
public final class PluggableConsoleOutput implements ConsoleOutput {
/** The actual output. */
private PrintStream out;
/** The buffered messages. */
private final Deque<String> messages = new ArrayDeque<>();
/** If this output is closed. */
private boolean closed = false;
/** Default constructor. */
public PluggableConsoleOutput() {
//
}
/* (non-Javadoc)
* @see java.lang.AutoCloseable#close() */
@Override
public void close() {
closed = true;
}
/** Set the output to write to.
*
* @param output the output to set */
public synchronized void connect(final PrintStream output) {
out = output;
while (!messages.isEmpty()) {
output.print(messages.pop());
}
}
/** Disconnects the output. */
public synchronized void disconnect() {
out = null;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */
@Override
public boolean isClosed() {
return closed;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
@Override
public synchronized void print(final String text) throws IOException {
if (closed) {
throw new IOException("Closed output"); //$NON-NLS-1$
}
if (out == null) {
messages.add(text);
} else {
out.print(text);
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */
@Override
public synchronized void println() throws IOException {
if (closed) {
throw new IOException("Closed output"); //$NON-NLS-1$
}
if (out == null) {
messages.add("\n"); //$NON-NLS-1$
} else {
out.println();
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
@Override
public synchronized void println(final String message) throws IOException {
print(message);
println();
}
}

View File

@@ -0,0 +1,134 @@
/**
* gclc-socket:fr.bigeon.gclc.socket.RemoteDisconnectCommand.java
* Created on: Nov 18, 2017
*/
package fr.bigeon.gclc.socket;
/*-
* #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import java.text.MessageFormat;
import java.util.Collection;
import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** A {@link Command} to disconnect elements from a {@link ConnexionManager}.
*
* @author Emmanuel Bigeon
* @param <T> the type of connected object */
public final class RemoteDisconnectCommand<T> extends Command {
/** The connexion manager. */
private final ConnexionManager<T> manager;
/** If all connexion should be disconnected when no argument have been
* specified. */
private final boolean all;
/** Create the disconnection command.
*
* @param name the command name
* @param manager the manager
* @param all if all elements should be disconnected when no argument is
* provided */
public RemoteDisconnectCommand(final String name,
final ConnexionManager<T> manager, final boolean all) {
super(name);
this.manager = manager;
this.all = all;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
if (args.length == 0 && all) {
final Collection<String> coll = manager.getConnected();
for (final String string : coll) {
manager.disconnect(string);
}
}
for (final String string : args) {
if (manager.isConnected(string)) {
manager.disconnect(string);
} else {
print(out, MessageFormat
.format("[WARNING] {0} is not connected", string)); //$NON-NLS-1$
}
}
}
/** Print a message if the output is defined.
*
* @param out the output
* @param string the message
* @throws CommandRunException if the output exists but cannot be printed
* to */
private void print(final ConsoleOutput out,
final String string) throws CommandRunException {
if (out != null) {
try {
out.println(string);
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"Unable to print to existing output", e, this); //$NON-NLS-1$
}
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Close a connexion."; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@SuppressWarnings("nls")
@Override
protected String usageDetail() {
return MessageFormat.format(
" If arguments are provided the corresponding connexions are closed, " +
"otherwise{0}{1} are.",
System.lineSeparator(), all ? "all connexions" : "none");
}
}

View File

@@ -1,14 +1,14 @@
/* package fr.bigeon.gclc.socket;
* Copyright E. Bigeon (2014)
* /*-
* emmanuel@bigeon.fr * #%L
* * GCLC Socket
* This software is a computer program whose purpose is to * %%
* Socket implementation of GCLC. * Copyright (C) 2016 - 2018 Bigeon
* * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,27 +31,19 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
package fr.bigeon.gclc.socket;
import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
import java.io.InputStreamReader; import java.net.InetAddress;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.net.ServerSocket; import java.net.ServerSocket;
import java.net.Socket; import java.net.Socket;
import java.net.SocketException; import java.net.SocketException;
import java.nio.charset.Charset;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
import fr.bigeon.gclc.ConsoleApplication; import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.manager.ConsoleManager;
import fr.bigeon.gclc.manager.PipedConsoleManager;
import fr.bigeon.gclc.manager.ReadingRunnable;
/** This is a socket communicating console consoleManager /** This is a socket communicating console consoleManager.
* <p> * <p>
* To use this application, the following flow should be used: * To use this application, the following flow should be used:
* *
@@ -69,115 +61,60 @@ import fr.bigeon.gclc.manager.ReadingRunnable;
* end of the execution. * end of the execution.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public class SocketConsoleApplicationShell implements Runnable, AutoCloseable { public final class SocketConsoleApplicationShell implements Runnable {
/** The runnable to forward output of application to socket. /** The class logger. */
*
* @author Emmanuel Bigeon */
private final class OutputForwardRunnable implements Runnable {
/**
*
*/
private final PrintWriter writer;
/**
*
*/
private final Socket socket;
/** @param writer the writer
* @param socket the socket */
protected OutputForwardRunnable(PrintWriter writer, Socket socket) {
this.writer = writer;
this.socket = socket;
}
@SuppressWarnings("synthetic-access")
@Override
public void run() {
try {
while (!socket.isClosed()) {
while (!socket.isClosed() && !consoleManager.available()) {
waitASec();
}
if (socket.isClosed()) {
return;
}
String m = consoleManager.readNextLine();
writer.println(m);
}
} catch (IOException e) {
LOGGER.log(Level.SEVERE, "Unexpected problem in manager", //$NON-NLS-1$
e);
}
}
}
/** The end of line character */
protected static final String EOL = "\n"; //$NON-NLS-1$
/** The class logger */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(SocketConsoleApplicationShell.class.getName()); .getLogger(SocketConsoleApplicationShell.class.getName());
/** Time of wait */ /** The listening port. */
protected static final long ONE_TENTH_OF_SECOND = 100;
/** The listening port */
private final int port; private final int port;
/** The application */ /** The running status. */
private ConsoleApplication app;
/** The session closing command */
private final String close;
/** The running status */
private boolean running; private boolean running;
/** The socket console interface. */
private SocketConsoleInterface sci;
/** The remote disconnection command. */
private ConnexionManager<Socket> rdc;
/** The application. */
private ConsoleApplication app;
/** The console manager implementation */ /** The server socket. */
private final PipedConsoleManager consoleManager;
/** The auto close flag. if this is true, every request closes the session
* after its call */
private final boolean autoClose;
/** The server socket */
private ServerSocket serverSocket; private ServerSocket serverSocket;
/** The application shutdown string */ /** THe server address. */
private final String applicationShutdown; private final InetAddress addr;
/** The charset for the communication. */
private final Charset charset;
/** Create a socket application shell which will listen on the given port /** Create a socket application shell which will listen on the given port
* and close session upon the provided string reception by client * and network interface.
* *
* @param port the port to listen to * @param port the part
* @param close the session closing command * @param addr the inet address */
* @param applicationShutdown the appication shut down command public SocketConsoleApplicationShell(final int port,
* @param charset the charset for communication final InetAddress addr) {
* @throws IOException if the manager could not be created */ super();
public SocketConsoleApplicationShell(int port, String close,
String applicationShutdown, Charset charset) throws IOException {
this.port = port; this.port = port;
this.close = close; this.addr = addr;
this.applicationShutdown = applicationShutdown;
this.autoClose = false;
this.charset = charset;
//
consoleManager = new PipedConsoleManager();
} }
/** Create a socket application shell which will listen on the given port /** Wait for the identified connection to disconnect.
* and auto close session after one instruction
* *
* @param port the port to listen to * @param id the connexion id. */
* @param autoClose if the session must be closed once the request has been private void awaitDisconnexion(final String id) {
* sent while (rdc.isConnected(id)) {
* @param applicationShutdown the appication shut down command try {
* @param charset the charset for communication rdc.waitDisconnexion(id);
* @throws IOException if the manager could not be created */ } catch (final InterruptedException e) {
public SocketConsoleApplicationShell(int port, boolean autoClose, LOGGER.log(Level.SEVERE, "Unexpected interruption", e); //$NON-NLS-1$
String applicationShutdown, Charset charset) throws IOException { Thread.currentThread().interrupt();
this.port = port; }
this.autoClose = autoClose; }
this.applicationShutdown = applicationShutdown; sci.disconnect();
this.close = autoClose ? null : "close"; //$NON-NLS-1$ }
this.charset = charset;
// /** If the port provided was 0, this allows to get the actual port.
consoleManager = new PipedConsoleManager(); * @return the local port
* @see java.net.ServerSocket#getLocalPort()
*/
public int getLocalPort() {
return serverSocket.getLocalPort();
} }
/* (non-Javadoc) /* (non-Javadoc)
@@ -185,8 +122,9 @@ public class SocketConsoleApplicationShell implements Runnable, AutoCloseable {
@Override @Override
public void run() { public void run() {
// Create the server // Create the server
try (ServerSocket actualServerSocket = new ServerSocket(port)) { try (ServerSocket actualServerSocket = new ServerSocket(port, 1,
this.serverSocket = actualServerSocket; addr)) {
serverSocket = actualServerSocket;
running = true; running = true;
// Create the streams // Create the streams
runSokectServer(); runSokectServer();
@@ -197,176 +135,56 @@ public class SocketConsoleApplicationShell implements Runnable, AutoCloseable {
} }
} }
/** @throws IOException if the communication with the client failed */ /** Acctually run the server loop on connexion.
*
* @throws IOException if the communication with the client failed */
private void runSokectServer() throws IOException { private void runSokectServer() throws IOException {
final ConsoleRunnable runnable = new ConsoleRunnable(app); while (running && app.isRunning()) {
Thread appThNext = new Thread(runnable, "gclc-ctrl"); //$NON-NLS-1$
appThNext.start();
while (running) {
LOGGER.info("Waiting client"); //$NON-NLS-1$ LOGGER.info("Waiting client"); //$NON-NLS-1$
try (Socket clientSocket = serverSocket.accept(); try (Socket clientSocket = serverSocket.accept();) {
PrintWriter out = new PrintWriter(new OutputStreamWriter(
clientSocket.getOutputStream(), charset), true);
InputStreamReader isr = new InputStreamReader(
clientSocket.getInputStream(), charset);
BufferedReader in = new BufferedReader(isr);) {
// this is not threaded to avoid several clients at the same
// time
LOGGER.info("Opening client"); //$NON-NLS-1$
// Initiate application sci.connect(clientSocket);
if (!runnable.isApplicationRunning()) {
LOGGER.info("Start application"); //$NON-NLS-1$ final String id = rdc.addConnexion(clientSocket);
startApplication(runnable); rdc.lockDisconnexion(id);
} else { awaitDisconnexion(id);
LOGGER.info("Reconnect to application"); //$NON-NLS-1$ rdc.releaseDisconnexionLock(id);
out.println("Reconnected"); //$NON-NLS-1$ } catch (final SocketException e) {
out.println(consoleManager.getPrompt());
}
communicate(clientSocket, out, in);
} catch (SocketException e) {
LOGGER.log(Level.INFO, "Socket closed"); //$NON-NLS-1$ LOGGER.log(Level.INFO, "Socket closed"); //$NON-NLS-1$
LOGGER.log(Level.FINE, LOGGER.log(Level.FINE,
"Socket closed with exception (probably due to server interruption)", //$NON-NLS-1$ "Socket closed with exception (probably due to server interruption)", //$NON-NLS-1$
e); e);
} catch (IOException e) { } catch (final IOException e) {
throw e; throw e;
} }
LOGGER.info("Closing client"); //$NON-NLS-1$ LOGGER.info("Closing client"); //$NON-NLS-1$
} }
runnable.setRunning(false);
try {
closeManager(appThNext);
} catch (IOException e) {
LOGGER.warning("Unable to close application correctly"); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Application closing caused an exception", //$NON-NLS-1$
e);
}
LOGGER.info("Closing Server"); //$NON-NLS-1$ LOGGER.info("Closing Server"); //$NON-NLS-1$
} }
/** Close the console manager after writing the application shutdown /** Set the application.
* command. * <p>
* If the application is closed, the server will also close.
* *
* @param appThNext the thread containing the application * @param app the app to set */
* @throws IOException if the typyng or closing failed */ public void setApplication(final ConsoleApplication app) {
private void closeManager(Thread appThNext) throws IOException {
consoleManager.type(applicationShutdown);
try {
appThNext.join(ONE_TENTH_OF_SECOND);
} catch (InterruptedException e) {
LOGGER.warning("Application thread was interrupted!"); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"Application thread was interrupted while closing", //$NON-NLS-1$
e);
}
consoleManager.close();
}
/** @param runnable the runnable */
private void startApplication(ConsoleRunnable runnable) {
runnable.restart();
synchronized (this) {
try {
wait(ONE_TENTH_OF_SECOND);
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interruption in application start", //$NON-NLS-1$
e);
}
}
}
/** active communication between server and client
*
* @param socket the socket
* @param writer the writer to the application
* @param in the input from the client
* @throws IOException if the communication failed */
private void communicate(final Socket socket, final PrintWriter writer,
BufferedReader in) throws IOException {
OutputForwardRunnable cc = new OutputForwardRunnable(writer, socket);
Thread th = new Thread(cc, "ClientComm"); //$NON-NLS-1$
th.start();
if (autoClose) {
communicateOnce(in);
} else {
communicateLoop(in);
}
}
/** @param in the input from the client
* @throws IOException if the communication failed */
private void communicateOnce(BufferedReader in) throws IOException {
ReadingRunnable reading = new ReadingRunnable(in);
Thread th = new Thread(reading, "gclcToApp"); //$NON-NLS-1$
th.start();
communicationContent(reading);
doEndCommunication(reading);
}
/** @param reading the reading runnable
* @throws IOException if the end of communication failed */
private void doEndCommunication(ReadingRunnable reading) throws IOException {
reading.setRunning(false);
Thread wait = consoleManager.getWaitForDelivery("Bye."); //$NON-NLS-1$
consoleManager.println("Bye."); //$NON-NLS-1$
try {
wait.join();
} catch (InterruptedException e) {
LOGGER.warning("The Bye wait was interrupted."); //$NON-NLS-1$
LOGGER.log(Level.FINE, "An interruption occured", e); //$NON-NLS-1$
}
}
/** @param in the input from the client
* @throws IOException if the communication failed */
private void communicateLoop(BufferedReader in) throws IOException {
ReadingRunnable reading = new ReadingRunnable(in);
Thread th = new Thread(reading, "gclcToApp"); //$NON-NLS-1$
th.start();
while (app.isRunning() && communicationContent(reading)) {
// keep on going
}
doEndCommunication(reading);
}
/** @param reading the reading
* @return if the communication should be stopped.
* @throws IOException if the reading failed */
private boolean communicationContent(ReadingRunnable reading) throws IOException {
try {
while (app.isRunning() && !reading.hasMessage()) {
synchronized (this) {
waitASec();
}
}
} catch (IOException e) {
LOGGER.warning("Client seems dead. Closing communication"); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Wait on message from client failed", e); //$NON-NLS-1$
return false;
}
if (!app.isRunning()) {
return false;
}
String ln = reading.getMessage();
if (ln.equals(close)) {
return false;
}
// Pass command to application
consoleManager.type(ln);
return true;
}
/** @return the consoleManager */
public synchronized ConsoleManager getConsoleManager() {
return consoleManager;
}
/** @param app the application to set */
public synchronized void setApplication(ConsoleApplication app) {
this.app = app; this.app = app;
} }
/** Set the connexion manager.
*
* @param rdc the rdc to set */
public void setConnexionManager(final ConnexionManager<Socket> rdc) {
this.rdc = rdc;
}
/** Set the socket console interface.
*
* @param sci the console interface to set */
public void setInterface(final SocketConsoleInterface sci) {
this.sci = sci;
}
/** This method will request the server to stop. /** This method will request the server to stop.
* <p> * <p>
* In most cases, this will terminate communication on every client. On some * In most cases, this will terminate communication on every client. On some
@@ -375,29 +193,8 @@ public class SocketConsoleApplicationShell implements Runnable, AutoCloseable {
running = false; running = false;
try { try {
serverSocket.close(); serverSocket.close();
} catch (IOException e) { } catch (final IOException e) {
LOGGER.log(Level.SEVERE, "Exception in closing socket server", e); //$NON-NLS-1$ LOGGER.log(Level.SEVERE, "Exception in closing socket server", e); //$NON-NLS-1$
} }
app.exit();
}
/** a method to wait some time */
protected void waitASec() {
try {
synchronized (this) {
wait(ONE_TENTH_OF_SECOND);
}
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interrupted wait", //$NON-NLS-1$
e);
return;
}
}
/* (non-Javadoc)
* @see java.lang.AutoCloseable#close() */
@Override
public void close() throws IOException {
consoleManager.close();
} }
} }

View File

@@ -0,0 +1,84 @@
/**
* gclc-socket:fr.bigeon.gclc.socket.SocketConsoleInterface.java
* Created on: Nov 18, 2017
*/
package fr.bigeon.gclc.socket;
/*-
* #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import java.io.PrintStream;
import java.net.Socket;
import java.nio.charset.StandardCharsets;
/** The interface for socket based access to console application.
*
* @author Emmanuel Bigeon */
public final class SocketConsoleInterface {
/** The application's input. */
private final PluggableConsoleInput input;
/** The application's output. */
private final PluggableConsoleOutput output;
/** Create the interfacing object.
*
* @param input the input
* @param output the output */
public SocketConsoleInterface(final PluggableConsoleInput input,
final PluggableConsoleOutput output) {
super();
this.input = input;
this.output = output;
}
/** Connect the application's input and outputs to the socket's.
*
* @param socket the socket
* @throws IOException if the connection failed */
public void connect(final Socket socket) throws IOException {
final PrintStream printStream = new PrintStream(
socket.getOutputStream(), true,
StandardCharsets.UTF_8.name());
output.connect(printStream);
input.connect(socket.getInputStream(),
printStream);
}
/** Disconnect the input and output of the application from the socket's. */
public void disconnect() {
input.disconnect();
output.disconnect();
}
}

View File

@@ -0,0 +1,39 @@
/** This package define a framework to access
* {@link fr.bigeon.gclc.ConsoleApplication} through a socket.
*
* @author Emmanuel Bigeon */
package fr.bigeon.gclc.socket;
/*-
* #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/

View File

@@ -1,197 +0,0 @@
/*
* Copyright E. Bigeon (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* Socket implementation of GCLC.
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
* gclc-socket:fr.bigeon.gclc.socket.ConsoleRunnableTest.java
* Created on: Jun 1, 2016
*/
package fr.bigeon.gclc.socket;
import java.io.IOException;
import org.junit.Test;
import fr.bigeon.gclc.manager.ConsoleManager;
/** Test class for {@link ConsoleRunnable}
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"unused", "javadoc"})
public class ConsoleRunnableTest {
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
private static final class ConsoleManagerTestImplementation
implements ConsoleManager {
int i = 0;
String[] cmds;
/** @param cmds the commands to run */
public ConsoleManagerTestImplementation(String[] cmds) {
super();
this.cmds = cmds;
}
@Override
public void setPrompt(String prompt) {
// do nothing
}
@Override
public String getPrompt() {
// Not used in test
return ""; //$NON-NLS-1$
}
@Override
public String prompt() {
try {
Thread.sleep(1000);
} catch (InterruptedException e) { // NOSONAR
// do nothing
}
i++;
if (i == cmds.length) {
i = 0;
}
return cmds[i];
}
@Override
public String prompt(String message) {
return prompt();
}
@Override
public void println(String message) {
// do nothing
}
@Override
public void println() {
// do nothing
}
@Override
public void print(String text) {
// do nothing
}
@Override
public void close() throws IOException {
// do nothing
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
@Override
public boolean isClosed() {
return i == cmds.length;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
@Override
public void interruptPrompt() {
//
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */
@Override
public String prompt(long timeout) throws IOException {
return prompt();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#prompt(java.lang.String,
* long) */
@Override
public String prompt(String message, long timeout) throws IOException {
return prompt(message);
}
}
/** Test method for
* {@link fr.bigeon.gclc.socket.ConsoleRunnable#ConsoleRunnable(fr.bigeon.gclc.ConsoleApplication)}
* . */
@Test
public void testConsoleRunnable() {
// ConsoleApplication app = new ConsoleTestApplication(
// new SystemConsoleManager());
// ConsoleRunnable runnable = new ConsoleRunnable(app);
}
/** Test method for {@link fr.bigeon.gclc.socket.ConsoleRunnable#run()}. */
@Test
public void testRunFlow() {
// ConsoleApplication app = new ConsoleTestApplication(
// new ConsoleManagerTestImplementation(
// new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
// ConsoleRunnable runnable = new ConsoleRunnable(app);
//
// Thread th = new Thread(runnable);
// th.start();
//
// runnable.stop();
}
/** Test method for {@link fr.bigeon.gclc.socket.ConsoleRunnable#stop()}. */
@Test
public void testStop() {
// ConsoleApplication app = new ConsoleTestApplication(
// new ConsoleManagerTestImplementation(
// new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
// ConsoleRunnable runnable = new ConsoleRunnable(app);
// runnable.stop();
// Thread th = new Thread(runnable);
// th.start();
// runnable.stop();
// runnable.stop();
}
/** Test method for {@link fr.bigeon.gclc.socket.ConsoleRunnable#stop()}. */
@Test
public void testRun() {
// ConsoleApplication app = new ConsoleTestApplication(
// new ConsoleManagerTestImplementation(
// new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
// ConsoleRunnable runnable = new ConsoleRunnable(app);
// runnable.run();
}
}

View File

@@ -1,14 +1,14 @@
/* package fr.bigeon.gclc.socket;
* Copyright E. Bigeon (2014)
* /*-
* emmanuel@bigeon.fr * #%L
* * GCLC Socket
* This software is a computer program whose purpose is to * %%
* Socket implementation of GCLC. * Copyright (C) 2016 - 2018 Bigeon
* * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,10 +31,11 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
package fr.bigeon.gclc.socket;
import java.io.IOException; import java.io.IOException;
import java.net.Socket;
import java.util.Collection;
import fr.bigeon.gclc.ConsoleApplication; import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.command.Command; import fr.bigeon.gclc.command.Command;
@@ -42,7 +43,8 @@ import fr.bigeon.gclc.command.ExitCommand;
import fr.bigeon.gclc.command.HelpExecutor; import fr.bigeon.gclc.command.HelpExecutor;
import fr.bigeon.gclc.exception.CommandRunException; import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName; import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.manager.ConsoleManager; import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** A test-purpose application /** A test-purpose application
* *
@@ -52,52 +54,103 @@ public class ConsoleTestApplication {
/** Exit command */ /** Exit command */
public static final String EXIT = "exit"; //$NON-NLS-1$ public static final String EXIT = "exit"; //$NON-NLS-1$
/** @param manager the manager /** Create the test application.
*
* @param output the output
* @param input the input
* @param manager the manager
* @return create the application */ * @return create the application */
@SuppressWarnings("nls") @SuppressWarnings("nls")
public static ConsoleApplication create(final ConsoleManager manager) { public static ConsoleApplication create(final ConsoleOutput output,
final ConsoleInput input,
final ConnexionManager<Socket> manager) {
try { try {
ConsoleApplication application = new ConsoleApplication(manager, final ConsoleApplication application = new ConsoleApplication(
output, input,
"Welcome to the test application. Type help or test.", "Welcome to the test application. Type help or test.",
"See you"); "See you");
application.add(new ExitCommand(EXIT, application)); application.add(new ExitCommand(EXIT, application) {
application.add( /* (non-Javadoc)
new HelpExecutor("help", manager, application.root)); * @see fr.bigeon.gclc.command.ExitCommand#beforeExit() */
@Override
protected void beforeExit() {
final Collection<String> coll = manager.getConnected();
for (final String string : coll) {
manager.disconnect(string);
}
}
});
application
.add(new HelpExecutor("help", application.root));
application.add(new Command("test") { application.add(new Command("test") {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
try {
output.println("Test command ran fine");
} catch (final IOException e) {
throw new CommandRunException("manager closed", e,
this);
}
}
@Override @Override
public String tip() { public String tip() {
return "A test command"; return "A test command";
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail()
*/
@Override @Override
public void execute(String... args) throws CommandRunException { protected String usageDetail() {
// TODO Auto-generated method stub
// return null;
throw new RuntimeException("Not implemented yet");
}
});
application.add(new Command("long") {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
try { try {
manager.println("Test command ran fine"); Thread.sleep(2000);
} catch (IOException e) { output.println("Test command ran fine");
} catch (IOException | InterruptedException e) {
throw new CommandRunException("manager closed", e, throw new CommandRunException("manager closed", e,
this); this);
} }
} }
});
application.add(new Command("long") {
@Override @Override
public String tip() { public String tip() {
return "A long run test command"; return "A long run test command";
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail()
*/
@Override @Override
public void execute(String... args) throws CommandRunException { protected String usageDetail() {
try { // TODO Auto-generated method stub
Thread.sleep(2000); // return null;
manager.println("Test command ran fine"); throw new RuntimeException("Not implemented yet");
} catch (IOException | InterruptedException e) {
throw new CommandRunException("manager closed", e,
this);
}
} }
}); });
application.add(
new RemoteDisconnectCommand<>("out", manager, true));
return application; return application;
} catch (final InvalidCommandName e) { } catch (final InvalidCommandName e) {
e.printStackTrace(); e.printStackTrace();

View File

@@ -0,0 +1,202 @@
/**
* gclc-socket:fr.bigeon.gclc.socket.PluggableConsoleInputTest.java
* Created on: Nov 18, 2017
*/
package fr.bigeon.gclc.socket;
/*-
* #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.IOException;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintStream;
import org.junit.Test;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
public class PluggableConsoleInputTest {
/** Test method for
* {@link fr.bigeon.gclc.socket.PluggableConsoleInput#close()}. */
@Test
public final void testClose() {
final PluggableConsoleInput input = new PluggableConsoleInput();
assertFalse("Input should not be initially closed", input.isClosed());
input.close();
assertTrue("Close should close the input", input.isClosed());
try {
input.prompt();
fail("Closed prompt should cause an IO");
} catch (final IOException e) {
// ok
}
try {
input.prompt(10);
fail("Closed prompt should cause an IO");
} catch (final IOException e) {
// ok
}
final PluggableConsoleInput input2 = new PluggableConsoleInput();
final Thread th = new Thread(new Runnable() {
@Override
public void run() {
while (!input2.isPrompting()) {
}
try {
Thread.sleep(100);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
input2.close();
}
});
th.start();
try {
input.prompt();
fail("Closed prompt should cause an IO");
} catch (final IOException e) {
// ok
}
final PluggableConsoleInput input3 = new PluggableConsoleInput();
final Thread th2 = new Thread(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(200);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
input3.close();
}
});
th2.start();
try {
input.prompt(2000);
fail("Closed prompt should cause an IO");
} catch (final IOException e) {
// ok
}
}
@Test
public final void testConnect() throws IOException, InterruptedException {
final PluggableConsoleInput input = new PluggableConsoleInput();
input.disconnect();
try (final PipedInputStream pis = new PipedInputStream();
final PipedOutputStream pos = new PipedOutputStream();
final PipedInputStream inner = new PipedInputStream(pos);
final PipedOutputStream innerPos = new PipedOutputStream(pis);
final PrintStream testIn = new PrintStream(innerPos, true, "UTF8");
final PrintStream out = new PrintStream(pos)) {
input.connect(pis, out);
try {
input.connect(pis, out);
fail("Should not be able to connect already connected");
} catch (final IOException e) {
// ok
}
input.disconnect();
final Thread th = new Thread(new Runnable() {
@Override
public void run() {
try {
input.prompt("Test", 5000);
} catch (final IOException e) {
e.printStackTrace();
}
}
});
th.start();
while (!input.isPrompting()) {
Thread.sleep(10);
}
input.connect(pis, out);
testIn.println("tac");
final Thread th2 = new Thread(new Runnable() {
@Override
public void run() {
try {
input.prompt("Test", 5000);
fail("Prompt should io");
} catch (final IOException e) {
// ok
}
}
});
th2.start();
while (!input.isPrompting()) {
Thread.sleep(10);
}
input.close();
}
}
/** Test method for
* {@link fr.bigeon.gclc.socket.PluggableConsoleInput#getPrompt()}. */
@Test
public final void testGetPrompt() {
final PluggableConsoleInput input = new PluggableConsoleInput();
assertEquals("Default prompt invalid", "> ", input.getPrompt().apply());
input.setPrompt("test");
assertEquals("Prompt setting failed", "test", input.getPrompt().apply());
}
}

View File

@@ -0,0 +1,107 @@
/**
* gclc-socket:fr.bigeon.gclc.socket.RemoteDisconnectCommandTest.java
* Created on: Nov 18, 2017
*/
package fr.bigeon.gclc.socket;
/*-
* #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.IOException;
import org.junit.Test;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.PipedConsoleOutput;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
public class RemoteDisconnectCommandTest {
/** Test method for
* {@link fr.bigeon.gclc.socket.RemoteDisconnectCommand#execute(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[])}.
*
* @throws CommandRunException if the command unexpectedly failed.
* @throws IOException if the output could not be written to */
@Test
public final void testExecute() throws CommandRunException, IOException {
final DConnexionManager<String> manager = new DConnexionManager<>();
final RemoteDisconnectCommand<String> cmd = new RemoteDisconnectCommand<>(
"quit", manager, true);
final RemoteDisconnectCommand<String> cmd2 = new RemoteDisconnectCommand<>(
"quit", manager, false);
manager.addConnexion("test");
cmd2.execute(null, null);
assertFalse("No arguemnt should remova no connections",
manager.getConnected().isEmpty());
cmd.execute(null, null);
assertTrue("No arguemnt should remova all connections",
manager.getConnected().isEmpty());
final String name1 = manager.addConnexion("test");
final String name2 = manager.addConnexion("test");
cmd.execute(null, null, name1);
assertFalse("With argument shuld remove specified name",
manager.getConnected().contains(name1));
assertTrue("With argument shuld remove only specified name",
manager.getConnected().contains(name2));
cmd.execute(null, null, name1);
assertTrue("With argument shuld remove only specified name",
manager.getConnected().contains(name2));
try (PipedConsoleOutput out = new PipedConsoleOutput()) {
cmd.execute(out, null, name1);
assertTrue("With argument shuld remove only specified name",
manager.getConnected().contains(name2));
out.close();
try {
cmd.execute(out, null, name1);
fail("Closed stream should cause error in printing");
} catch (final CommandRunException e) {
// ok
}
}
}
}

View File

@@ -1,14 +1,18 @@
/* /**
* Copyright E. Bigeon (2014) * gclc-socket:fr.bigeon.gclc.socket.SocketConsoleApplicationTest.java
* * Created on: Jun 1, 2016
* emmanuel@bigeon.fr */
* package fr.bigeon.gclc.socket;
* This software is a computer program whose purpose is to
* Socket implementation of GCLC. /*-
* * #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,17 +35,9 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/**
* gclc-socket:fr.bigeon.gclc.socket.SocketConsoleApplicationTest.java
* Created on: Jun 1, 2016
*/
package fr.bigeon.gclc.socket;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
@@ -55,26 +51,32 @@ import org.junit.Test;
/** Test class for {@link SocketConsoleApplicationShell} /** Test class for {@link SocketConsoleApplicationShell}
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
@SuppressWarnings({"static-method", "unused", "javadoc", "nls"}) @SuppressWarnings({"static-method", "javadoc", "nls"})
public class SocketConsoleApplicationTest { public class SocketConsoleApplicationTest {
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(SocketConsoleApplicationTest.class.getName()); .getLogger(SocketConsoleApplicationTest.class.getName());
/** @param in the input
* @return the string
* @throws IOException if the input reading failed */
private String consumeToPrompt(final String server,
final BufferedReader in) throws IOException {
String fromServer = server;
LOGGER.fine("Server: \n" + fromServer);
while (fromServer != null && !fromServer.equals("Bye.") &&
!fromServer.equals("> ")) {
fromServer = in.readLine();
LOGGER.fine("Server: \n" + fromServer);
}
return fromServer;
}
@Test @Test
public void integrationTest() { public void testIntegration() throws IOException, InterruptedException {
Thread server; Thread server;
try { server = TestServer.getServer();
server = TestServer.startServer("bye");
} catch (IOException e3) {
assertNull(e3);
fail("unable to start server");
}
try {
Thread.sleep(1000); Thread.sleep(1000);
} catch (InterruptedException e1) {
e1.printStackTrace();
}
final String hostName = "127.0.0.1"; final String hostName = "127.0.0.1";
final int portNumber = 3300; final int portNumber = 3300;
@@ -86,7 +88,7 @@ public class SocketConsoleApplicationTest {
String fromServer; String fromServer;
int i = -1; int i = -1;
String[] cmds = {"help", "toto", "test", "bye"}; final String[] cmds = {"help", "toto", "test", "out"};
while ((fromServer = in.readLine()) != null) { while ((fromServer = in.readLine()) != null) {
i++; i++;
fromServer = consumeToPrompt(fromServer, in); fromServer = consumeToPrompt(fromServer, in);
@@ -100,9 +102,7 @@ public class SocketConsoleApplicationTest {
out.println(fromUser); out.println(fromUser);
} }
} }
assertEquals(4, i); assertEquals("Disconnection command should close connection", 3, i);
} catch (final IOException e) {
e.printStackTrace();
} }
try (Socket kkSocket = new Socket(hostName, portNumber); try (Socket kkSocket = new Socket(hostName, portNumber);
@@ -113,7 +113,7 @@ public class SocketConsoleApplicationTest {
String fromServer; String fromServer;
int i = 0; int i = 0;
String[] cmds = {"help", "toto", "test", final String[] cmds = {"help", "toto", "test",
ConsoleTestApplication.EXIT}; ConsoleTestApplication.EXIT};
while ((fromServer = in.readLine()) != null) { while ((fromServer = in.readLine()) != null) {
fromServer = consumeToPrompt(fromServer, in); fromServer = consumeToPrompt(fromServer, in);
@@ -129,15 +129,15 @@ public class SocketConsoleApplicationTest {
} }
i++; i++;
} }
assertEquals(4, i); assertEquals("Application exit command should close connection", 4,
} catch (final IOException e) { i);
e.printStackTrace();
} }
try {
Thread.sleep(100); Thread.sleep(100);
} catch (InterruptedException e1) { TestServer.closeServer();
e1.printStackTrace(); server.join();
} server = TestServer.getServer();
Thread.sleep(1000);
try (Socket kkSocket = new Socket(hostName, portNumber); try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
@@ -147,7 +147,7 @@ public class SocketConsoleApplicationTest {
String fromServer; String fromServer;
int i = 0; int i = 0;
String[] cmds = {"help", "toto", "test", final String[] cmds = {"help", "toto", "test",
ConsoleTestApplication.EXIT}; ConsoleTestApplication.EXIT};
while ((fromServer = in.readLine()) != null) { while ((fromServer = in.readLine()) != null) {
fromServer = consumeToPrompt(fromServer, in); fromServer = consumeToPrompt(fromServer, in);
@@ -162,80 +162,10 @@ public class SocketConsoleApplicationTest {
} }
i++; i++;
} }
assertEquals(4, i); assertEquals("Application exit command should close connection", 4,
} catch (final IOException e) { i);
e.printStackTrace();
} }
TestServer.closeServer(); TestServer.closeServer();
try { server.join();
Thread.sleep(100);
} catch (InterruptedException e2) {
e2.printStackTrace();
}
try {
server = TestServer.startServer(true);
} catch (IOException e2) {
assertNull(e2);
}
try {
Thread.sleep(100);
} catch (InterruptedException e1) {
e1.printStackTrace();
}
try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer;
int i = 0;
String[] cmds = {"help", "test", "close"};
while ((fromServer = in.readLine()) != null) {
fromServer = consumeToPrompt(fromServer, in);
if (fromServer == null || fromServer.equals("Bye.")) {
break;
}
assertTrue(i < 1);
final String fromUser = cmds[i];
if (fromUser != null) {
LOGGER.fine("Client: " + fromUser);
out.println(fromUser);
}
i++;
}
assertEquals(1, i);
} catch (final IOException e) {
e.printStackTrace();
}
Thread srv = null;
try {
srv = TestServer.getServer();
} catch (IOException e1) {
assertNull(e1);
}
TestServer.closeServer();
try {
srv.join();
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/** @param in the input
* @return the string
* @throws IOException if the input reading failed */
private String consumeToPrompt(String server,
BufferedReader in) throws IOException {
String fromServer = server;
LOGGER.fine("Server: \n" + fromServer);
while (fromServer != null && !fromServer.equals("Bye.") &&
!fromServer.equals("> ")) {
fromServer = in.readLine();
LOGGER.fine("Server: \n" + fromServer);
}
return fromServer;
} }
} }

View File

@@ -1,14 +1,14 @@
/* package fr.bigeon.gclc.socket;
* Copyright E. Bigeon (2014)
* /*-
* emmanuel@bigeon.fr * #%L
* * GCLC Socket
* This software is a computer program whose purpose is to * %%
* Socket implementation of GCLC. * Copyright (C) 2016 - 2018 Bigeon
* * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,9 +31,8 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
package fr.bigeon.gclc.socket;
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
import java.io.InputStreamReader; import java.io.InputStreamReader;

View File

@@ -1,14 +1,14 @@
/* package fr.bigeon.gclc.socket;
* Copyright E. Bigeon (2014)
* /*-
* emmanuel@bigeon.fr * #%L
* * GCLC Socket
* This software is a computer program whose purpose is to * %%
* Socket implementation of GCLC. * Copyright (C) 2016 - 2018 Bigeon
* * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,11 +31,12 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
package fr.bigeon.gclc.socket;
import java.io.IOException; import java.io.IOException;
import java.nio.charset.Charset; import java.net.InetAddress;
import java.net.Socket;
import java.net.UnknownHostException;
import fr.bigeon.gclc.ConsoleApplication; import fr.bigeon.gclc.ConsoleApplication;
@@ -46,19 +47,21 @@ import fr.bigeon.gclc.ConsoleApplication;
public class TestServer { public class TestServer {
private static SocketConsoleApplicationShell SHELL; private static SocketConsoleApplicationShell SHELL;
private static ConnexionManager<Socket> manager;
private static Thread server; private static Thread server;
private static PluggableConsoleInput input;
private static PluggableConsoleOutput output;
/** @param args no argument public static synchronized void closeServer() {
* @throws IOException if the server starting failed */ SHELL.stop();
public static void main(String... args) throws IOException { input.close();
try { output.close();
startServer(false).join(); SHELL = null;
} catch (final InterruptedException e) { server = null;
e.printStackTrace();
}
} }
public static Thread getServer() throws IOException { public static synchronized Thread getServer() throws IOException {
if (server == null) { if (server == null) {
server = new Thread(getShell(), "gclcServer"); server = new Thread(getShell(), "gclcServer");
server.start(); server.start();
@@ -66,43 +69,39 @@ public class TestServer {
return server; return server;
} }
private static SocketConsoleApplicationShell getShell() throws IOException { private static SocketConsoleApplicationShell getShell() throws UnknownHostException {
if (SHELL == null) { if (SHELL == null) {
SHELL = new SocketConsoleApplicationShell(3300, "close", input = new PluggableConsoleInput();
ConsoleTestApplication.EXIT, Charset.forName("UTF-8")); input.setPrompt("> \n");
output = new PluggableConsoleOutput();
manager = new DConnexionManager<>();
SHELL = new SocketConsoleApplicationShell(3300,
InetAddress.getByName("127.0.0.1"));
final ConsoleApplication app = ConsoleTestApplication final ConsoleApplication app = ConsoleTestApplication
.create(SHELL.getConsoleManager()); .create(output, input, manager);
SHELL.setInterface(new SocketConsoleInterface(input, output));
SHELL.setConnexionManager(manager);
SHELL.setApplication(app); SHELL.setApplication(app);
final Thread th = new Thread(new Runnable() {
@Override
public void run() {
app.start();
}
});
th.start();
} }
return SHELL; return SHELL;
} }
public static Thread startServer(boolean autoClose) throws IOException { /** @param args no argument
if (SHELL == null) { * @throws IOException if the server starting failed */
SHELL = new SocketConsoleApplicationShell(3300, autoClose, public static void main(final String... args) throws IOException {
ConsoleTestApplication.EXIT, Charset.forName("UTF-8")); try {
final ConsoleApplication app = ConsoleTestApplication getServer().join();
.create(SHELL.getConsoleManager()); } catch (final InterruptedException e) {
SHELL.setApplication(app); e.printStackTrace();
server = null;
} }
return getServer();
} }
public static Thread startServer(String closeConnection) throws IOException {
if (SHELL == null) {
SHELL = new SocketConsoleApplicationShell(3300, closeConnection,
ConsoleTestApplication.EXIT, Charset.forName("UTF-8"));
final ConsoleApplication app = ConsoleTestApplication
.create(SHELL.getConsoleManager());
SHELL.setApplication(app);
server = null;
}
return getServer();
}
public static void closeServer() {
SHELL.stop();
SHELL = null;
}
} }

View File

@@ -1,4 +1,35 @@
<!-- GCLC swt, provide a swt window for console applications -->
<!-- Copyright (C) 2015-2017 E. Bigeon -->
<!-- mailto:emmanuel@bigeon.fr -->
<!-- -->
<!-- This software is governed by the CeCILL license under French law and -->
<!-- abiding by the rules of distribution of free software. You can use, -->
<!-- modify and/or redistribute the software under the terms of the CeCILL -->
<!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
<!-- "http://www.cecill.info". -->
<!-- -->
<!-- As a counterpart to the access to the source code and rights to copy, -->
<!-- modify and redistribute granted by the license, users are provided only -->
<!-- with a limited warranty and the software's author, the holder of the -->
<!-- economic rights, and the successive licensors have only limited -->
<!-- liability. -->
<!-- -->
<!-- In this respect, the user's attention is drawn to the risks associated -->
<!-- with loading, using, modifying and/or developing or reproducing the -->
<!-- software by the user in light of its specific status of free software, -->
<!-- that may mean that it is complicated to manipulate, and that also -->
<!-- therefore means that it is reserved for developers and experienced -->
<!-- professionals having in-depth computer knowledge. Users are therefore -->
<!-- encouraged to load and test the software's suitability as regards their -->
<!-- requirements in conditions enabling the security of their systems and/or -->
<!-- data to be ensured and, more generally, to use and operate it in the -->
<!-- same conditions as regards security. -->
<!-- -->
<!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. -->
<!-- Copyright E. Bigeon (2015) --> <!-- Copyright E. Bigeon (2015) -->
<!-- --> <!-- -->
<!-- emmanuel@bigeon.fr --> <!-- emmanuel@bigeon.fr -->
@@ -35,7 +66,7 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<artifactId>gclc-swt</artifactId> <artifactId>gclc-swt</artifactId>
<version>1.1.4-SNAPSHOT</version> <version>1.1.5-SNAPSHOT</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<url>http://www.bigeon.fr/emmanuel</url> <url>http://www.bigeon.fr/emmanuel</url>
<properties> <properties>
@@ -43,20 +74,20 @@
<project.scm.id>git.bigeon.net</project.scm.id> <project.scm.id>git.bigeon.net</project.scm.id>
</properties> </properties>
<parent> <parent>
<groupId>fr.bigeon</groupId> <groupId>fr.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId> <artifactId>ebigeon-config</artifactId>
<version>1.7.1</version> <version>1.8.2</version>
</parent> </parent>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>fr.bigeon</groupId> <groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId> <artifactId>gclc</artifactId>
<version>1.3.6</version> <version>2.0.5</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>fr.bigeon</groupId> <groupId>fr.bigeon</groupId>
<artifactId>collections</artifactId> <artifactId>collections</artifactId>
<version>1.0.1</version> <version>1.1.0</version>
</dependency> </dependency>
</dependencies> </dependencies>
<inceptionYear>2015</inceptionYear> <inceptionYear>2015</inceptionYear>
@@ -98,4 +129,5 @@
</dependencies> </dependencies>
</profile> </profile>
</profiles> </profiles>
<groupId>fr.bigeon.gclc</groupId>
</project> </project>

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright E. Bigeon (2015) * GCLC swt, provide a swt window for console applications
* * Copyright (C) 2015-2017 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a swt window for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -46,12 +43,15 @@ package fr.bigeon.gclc.swt;
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public interface ConsoleDelayIO { public interface ConsoleDelayIO {
/** Actually send the input as the prompt next input. */ /** Get the input text.
void validateInput(); * @return the non validated input */
String getInput();
/** @param input the input to set */ /** Set the input text.
*
* @param input the input to set */
void setInput(String input); void setInput(String input);
/** @return the non validated input */ /** Actually send the input as the prompt next input. */
String getInput(); void validateInput();
} }

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright E. Bigeon (2015) * GCLC swt, provide a swt window for console applications
* * Copyright (C) 2015-2017 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a swt window for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -45,40 +42,46 @@ import org.eclipse.swt.events.KeyEvent;
import fr.bigeon.collections.ArrayRibbon; import fr.bigeon.collections.ArrayRibbon;
import fr.bigeon.collections.Ribbon; import fr.bigeon.collections.Ribbon;
/** A key listener to validate commands and manage the history of commands /** A key listener to validate commands and manage the history of commands.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class HistoryTextKeyListener extends KeyAdapter { public final class HistoryTextKeyListener extends KeyAdapter {
/** The size of commands history */ /** The size of commands history. */
private static final int DEFAULT_HISTORY_SIZE = 10; private static final int DEFAULT_HISTORY_SIZE = 10;
/** The empty string constant */ /** The empty string constant. */
private static final String EMPTY = ""; //$NON-NLS-1$ private static final String EMPTY = ""; //$NON-NLS-1$
/** The history ribbon */ /** The history ribbon. */
private final Ribbon<String> commands; private final Ribbon<String> commands;
/** The current index in history search */ /** The current index in history search. */
private int currentIndex = 0; private int currentIndex = 0;
/** The console to notify of command validation */ /** The console to notify of command validation. */
private final ConsoleDelayIO console; private final ConsoleDelayIO console;
/** @param console the console delayed */ /** Create the key listener that cycle the history.
public HistoryTextKeyListener(ConsoleDelayIO console) { *
* @param console the console delayed */
public HistoryTextKeyListener(final ConsoleDelayIO console) {
super(); super();
this.console = console; this.console = console;
this.commands = new ArrayRibbon<>(DEFAULT_HISTORY_SIZE); commands = new ArrayRibbon<>(DEFAULT_HISTORY_SIZE);
} }
/* (non-Javadoc)
* @see org.eclipse.swt.events.KeyAdapter#keyPressed(org.eclipse.swt.events.
* KeyEvent) */
@Override @Override
public void keyPressed(KeyEvent e) { public void keyPressed(final KeyEvent e) {
pressedKeyCode(e.keyCode); pressedKeyCode(e.keyCode);
} }
/** @param keyCode the pressed key code */ /** Indicate a pressed key combination.
public void pressedKeyCode(int keyCode) { *
* @param keyCode the pressed key code */
public void pressedKeyCode(final int keyCode) {
// Enter validates the command if prompting // Enter validates the command if prompting
if (keyCode == '\r') { if (keyCode == '\r') {
String input = console.getInput(); final String input = console.getInput();
if (!input.isEmpty()) { if (!input.isEmpty()) {
commands.add(input); commands.add(input);
} }
@@ -90,7 +93,7 @@ public final class HistoryTextKeyListener extends KeyAdapter {
if (keyCode == SWT.ARROW_UP && if (keyCode == SWT.ARROW_UP &&
currentIndex < commands.size() - 1) { currentIndex < commands.size() - 1) {
currentIndex++; currentIndex++;
String cmd = commands.get(commands.size() - currentIndex - 1); final String cmd = commands.get(commands.size() - currentIndex - 1);
console.setInput(cmd); console.setInput(cmd);
} }
@@ -100,7 +103,7 @@ public final class HistoryTextKeyListener extends KeyAdapter {
currentIndex--; currentIndex--;
console.setInput(EMPTY); console.setInput(EMPTY);
} else if (currentIndex > 0) { } else if (currentIndex > 0) {
String cmd = commands final String cmd = commands
.get(commands.size() - (--currentIndex) - 1); .get(commands.size() - (--currentIndex) - 1);
console.setInput(cmd); console.setInput(cmd);
} }

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright E. Bigeon (2015) * GCLC swt, provide a swt window for console applications
* * Copyright (C) 2015-2017 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a swt window for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -51,113 +48,114 @@ import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text; import org.eclipse.swt.widgets.Text;
import fr.bigeon.gclc.ConsoleApplication; import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.manager.ConsoleManager; import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
import fr.bigeon.gclc.tools.ConstantString;
import fr.bigeon.gclc.tools.StringProvider;
/** A SWT component to connect to gclc {@link ConsoleApplication} /** A SWT component to connect to gclc {@link ConsoleApplication}.
* <p> * <p>
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public class SWTConsole extends Composite public final class SWTConsole extends Composite
implements ConsoleDelayIO, ConsoleManager { implements ConsoleDelayIO, ConsoleInput, ConsoleOutput {
/** /** The number of columns of the layout. */
*
*/
private static final int LAYOUT_NB_COLUMNS = 2; private static final int LAYOUT_NB_COLUMNS = 2;
/** The cmd prefix in the output console */ /** The cmd prefix in the output console. */
private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$ private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$
/** The class logger */ /** The class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(SWTConsole.class.getName()); .getLogger(SWTConsole.class.getName());
/** The empty string constant */ /** The empty string constant. */
private static final String EMPTY = ""; //$NON-NLS-1$ private static final String EMPTY = ""; //$NON-NLS-1$
/** The console output text field */ /** The console output text field. */
private final Text consoleOutput; private final Text consoleOutput;
/** The console input text field */ /** The console input text field. */
private final Text consoleInput; private final Text consoleInput;
/** The prompt label */ /** The prompt label. */
private final Label lblPromptlabel; private final Label lblPromptlabel;
/** The prompt text */ /** The prompt text. */
private String prompt = ">"; //$NON-NLS-1$ private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
/** The command entered by the user */ /** The command entered by the user. */
private String command = null; private String command = null;
/** If the prompt should be active */ /** If the prompt should be active. */
private boolean prompting = false; private boolean prompting = false;
/** The object for thread synchronization with the prompt */ /** The object for thread synchronization with the prompt. */
private final Object promptLock = new Object(); private final Object promptLock = new Object();
/** Create the composite. /** Create the composite.
* *
* @param parent the prent composite * @param parent the prent composite
* @param style the composite style */ * @param style the composite style */
public SWTConsole(Composite parent, int style) { public SWTConsole(final Composite parent, final int style) {
super(parent, style); super(parent, style);
setLayout(new GridLayout(LAYOUT_NB_COLUMNS, false)); setLayout(new GridLayout(LAYOUT_NB_COLUMNS, false));
consoleOutput = new Text(this, SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | consoleOutput = new Text(this,
SWT.V_SCROLL | SWT.MULTI); SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | SWT.V_SCROLL | SWT.MULTI);
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, consoleOutput.setLayoutData(
LAYOUT_NB_COLUMNS, 1)); new GridData(SWT.FILL, SWT.FILL, true, true, LAYOUT_NB_COLUMNS, 1));
consoleOutput.setRedraw(true); consoleOutput.setRedraw(true);
lblPromptlabel = new Label(this, SWT.NONE); lblPromptlabel = new Label(this, SWT.NONE);
lblPromptlabel.setText(prompt); lblPromptlabel.setText(prompt.apply());
consoleInput = new Text(this, SWT.BORDER); consoleInput = new Text(this, SWT.BORDER);
consoleInput.setLayoutData( consoleInput.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
consoleInput.addKeyListener(new HistoryTextKeyListener(this)); consoleInput.addKeyListener(new HistoryTextKeyListener(this));
} }
/**
*
*/
@Override
public void validateInput() {
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleInput.setEnabled(false);
}
});
synchronized (promptLock) {
while (!prompting) {
try {
promptLock.wait();
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE,
"Interruption while waiting prompt", e); //$NON-NLS-1$
}
}
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
command = consoleInput.getText();
prompting = false;
consoleInput.setText(EMPTY);
consoleOutput.append(
CMD_PREFIX + command + System.lineSeparator());
}
});
promptLock.notifyAll();
}
}
@Override @Override
protected void checkSubclass() { protected void checkSubclass() {
// Disable the check that prevents subclassing of SWT components // Disable the check that prevents subclassing of SWT components
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */
@Override
public void close() {
synchronized (promptLock) {
promptLock.notifyAll();
}
if (consoleInput.isDisposed()) {
return;
}
consoleInput.setEnabled(false);
consoleOutput.setEnabled(false);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
@Override
public String getInput() {
return consoleInput.getText();
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#getPrompt() */ * @see fr.bigeon.gclc.ConsoleManager#getPrompt() */
@Override @Override
public String getPrompt() { public StringProvider getPrompt() {
return prompt; return prompt;
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
@Override
public void interruptPrompt() {
synchronized (promptLock) {
promptLock.notifyAll();
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
@Override
public boolean isClosed() {
return isDisposed();
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#print(java.lang.String) */ * @see fr.bigeon.gclc.ConsoleManager#print(java.lang.String) */
@Override @Override
@@ -214,22 +212,68 @@ public class SWTConsole extends Composite
} }
try { try {
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override @Override
public void run() { public void run() {
if (!consoleInput.isDisposed()) { if (!consoleInput.isDisposed()) {
consoleInput.setEnabled(true); consoleInput.setEnabled(true);
lblPromptlabel.setText(prompt.apply());
// relayout
SWTConsole.this.layout();
consoleInput.setFocus(); consoleInput.setFocus();
} }
} }
}); });
prompting = true; prompting = true;
promptLock.notifyAll(); promptLock.notifyAll();
while (prompting) {
promptLock.wait(); promptLock.wait();
}
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$
"Error in synchronization of prompting", e); //$NON-NLS-1$
command = null; command = null;
Thread.currentThread().interrupt();
}
}
if (isDisposed()) {
throw new IOException("Input closed"); //$NON-NLS-1$
}
return command;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override
public String prompt(final long timeout) throws IOException {
synchronized (promptLock) {
if (isDisposed()) {
throw new IOException();
}
try {
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
if (!consoleInput.isDisposed()) {
consoleInput.setEnabled(true);
lblPromptlabel.setText(prompt.apply());
// relayout
SWTConsole.this.layout();
consoleInput.setFocus();
}
}
});
prompting = true;
command = null;
promptLock.notifyAll();
long start = System.currentTimeMillis();
long cur = start;
while (prompting && start + timeout>cur) {
promptLock.wait((cur-start-timeout)/2);
cur = System.currentTimeMillis();
}
} catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$
command = null;
Thread.currentThread().interrupt();
} }
} }
if (isDisposed()) { if (isDisposed()) {
@@ -266,16 +310,16 @@ public class SWTConsole extends Composite
throw new IOException(); throw new IOException();
} }
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$
"Error in synchronization of prompting", e); //$NON-NLS-1$
command = null; command = null;
Thread.currentThread().interrupt();
} finally { } finally {
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access") @SuppressWarnings("synthetic-access")
@Override @Override
public void run() { public void run() {
if (!consoleOutput.isDisposed()) { if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(prompt); lblPromptlabel.setText(prompt.apply());
// relayout // relayout
SWTConsole.this.layout(); SWTConsole.this.layout();
} }
@@ -286,6 +330,15 @@ public class SWTConsole extends Composite
return command; return command;
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override
public String prompt(final String message, final long timeout) throws IOException {
// TODO Auto-generated method stub
// return null;
throw new RuntimeException("Not implemented yet");
}
/* (non-Javadoc) /* (non-Javadoc)
* @see org.eclipse.swt.widgets.Composite#setFocus() */ * @see org.eclipse.swt.widgets.Composite#setFocus() */
@Override @Override
@@ -293,17 +346,25 @@ public class SWTConsole extends Composite
return consoleInput.setFocus(); return consoleInput.setFocus();
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
@Override
public void setInput(final String input) {
consoleInput.setText(input);
consoleInput.setSelection(input.length());
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#setPrompt(java.lang.String) */ * @see fr.bigeon.gclc.ConsoleManager#setPrompt(java.lang.String) */
@Override @Override
public void setPrompt(final String prompt) { public void setPrompt(final StringProvider prompt) {
this.prompt = prompt; this.prompt = prompt;
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access") @SuppressWarnings("synthetic-access")
@Override @Override
public void run() { public void run() {
if (!consoleOutput.isDisposed()) { if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(prompt); lblPromptlabel.setText(prompt.apply());
// relayout // relayout
SWTConsole.this.layout(); SWTConsole.this.layout();
} }
@@ -311,29 +372,13 @@ public class SWTConsole extends Composite
}); });
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */
@Override @Override
public void close() { public void setPrompt(String prompt) {
synchronized (promptLock) { setPrompt(new ConstantString(prompt));
promptLock.notify();
}
if (consoleInput.isDisposed()) {
return;
}
consoleInput.setEnabled(false);
consoleOutput.setEnabled(false);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
@Override
public boolean isClosed() {
return isDisposed();
} }
/** @param string the text */ /** @param string the text */
public void setText(String string) { public void setText(final String string) {
consoleInput.setText(string); consoleInput.setText(string);
} }
@@ -344,27 +389,37 @@ public class SWTConsole extends Composite
validateInput(); validateInput();
} }
/* (non-Javadoc) /**
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */ *
*/
@Override @Override
public void setInput(String input) { public void validateInput() {
consoleInput.setText(input); Display.getDefault().syncExec(new Runnable() {
consoleInput.setSelection(input.length()); @SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleInput.setEnabled(false);
} }
});
/* (non-Javadoc)
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
@Override
public String getInput() {
return consoleInput.getText();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
@Override
public void interruptPrompt() {
synchronized (promptLock) { synchronized (promptLock) {
promptLock.notify(); while (!prompting) {
try {
promptLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interruption while waiting prompt", e); //$NON-NLS-1$
}
}
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
command = consoleInput.getText();
prompting = false;
consoleInput.setText(EMPTY);
consoleOutput.append(CMD_PREFIX + command + System.lineSeparator());
}
});
promptLock.notifyAll();
} }
} }

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright E. Bigeon (2015) * GCLC swt, provide a swt window for console applications
* * Copyright (C) 2015-2017 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a swt window for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -43,13 +40,11 @@ import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.widgets.Display; import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell; import org.eclipse.swt.widgets.Shell;
import fr.bigeon.gclc.manager.ConsoleManager;
/** A shell containing a {@link SWTConsole} /** A shell containing a {@link SWTConsole}
* <p> * <p>
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public class SWTConsoleShell extends Shell { public final class SWTConsoleShell extends Shell {
/** The console component */ /** The console component */
private SWTConsole console; private SWTConsole console;
@@ -57,7 +52,7 @@ public class SWTConsoleShell extends Shell {
/** Create the shell. /** Create the shell.
* *
* @param display the display */ * @param display the display */
public SWTConsoleShell(Display display) { public SWTConsoleShell(final Display display) {
super(display, SWT.SHELL_TRIM); super(display, SWT.SHELL_TRIM);
setLayout(new FillLayout(SWT.HORIZONTAL)); setLayout(new FillLayout(SWT.HORIZONTAL));
@@ -75,11 +70,6 @@ public class SWTConsoleShell extends Shell {
setText("Console Application"); //$NON-NLS-1$ setText("Console Application"); //$NON-NLS-1$
} }
/** @return the console manager */
public ConsoleManager getManager() {
return console;
}
/* (non-Javadoc) /* (non-Javadoc)
* @see org.eclipse.swt.widgets.Shell#dispose() */ * @see org.eclipse.swt.widgets.Shell#dispose() */
@Override @Override
@@ -87,4 +77,9 @@ public class SWTConsoleShell extends Shell {
super.dispose(); super.dispose();
console.close(); console.close();
} }
/** @return the input and output. */
public SWTConsole getManager() {
return console;
}
} }

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright E. Bigeon (2015) * GCLC swt, provide a swt window for console applications
* * Copyright (C) 2015-2017 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a swt window for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -50,14 +47,15 @@ import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Text; import org.eclipse.swt.widgets.Text;
import fr.bigeon.gclc.ConsoleApplication; import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.manager.PipedConsoleManager; import fr.bigeon.gclc.manager.PipedConsoleInput;
import fr.bigeon.gclc.manager.PipedConsoleOutput;
import fr.bigeon.gclc.tools.AOutputForwardRunnable; import fr.bigeon.gclc.tools.AOutputForwardRunnable;
/** A SWT component to connect to gclc {@link ConsoleApplication} /** A SWT component to connect to gclc {@link ConsoleApplication}
* <p> * <p>
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public class SWTConsoleView extends Composite implements ConsoleDelayIO { public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
/** The local implementation of the forwarding runnable /** The local implementation of the forwarding runnable
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
@@ -67,12 +65,12 @@ public class SWTConsoleView extends Composite implements ConsoleDelayIO {
private boolean running = true; private boolean running = true;
/** @param manager the manager */ /** @param manager the manager */
public ToSWTConsoleForwardRunnable(PipedConsoleManager manager) { public ToSWTConsoleForwardRunnable(final PipedConsoleOutput manager) {
super(manager); super(manager);
} }
@Override @Override
protected void forwardLine(String m) { protected void forwardLine(final String m) {
appendConsoleOutput(m); appendConsoleOutput(m);
} }
@@ -82,7 +80,7 @@ public class SWTConsoleView extends Composite implements ConsoleDelayIO {
} }
/** @param running the running to set */ /** @param running the running to set */
public void setRunning(boolean running) { public void setRunning(final boolean running) {
this.running = running; this.running = running;
} }
} }
@@ -94,8 +92,8 @@ public class SWTConsoleView extends Composite implements ConsoleDelayIO {
private final Text consoleOutput; private final Text consoleOutput;
/** The console input text field */ /** The console input text field */
private final Text consoleInput; private final Text consoleInput;
/** The actual manager */ /** The input. */
private PipedConsoleManager manager; private PipedConsoleInput input;
/** The forwarding runnable */ /** The forwarding runnable */
private ToSWTConsoleForwardRunnable forward; private ToSWTConsoleForwardRunnable forward;
@@ -103,7 +101,7 @@ public class SWTConsoleView extends Composite implements ConsoleDelayIO {
* *
* @param parent the prent composite * @param parent the prent composite
* @param style the composite style */ * @param style the composite style */
public SWTConsoleView(Composite parent, int style) { public SWTConsoleView(final Composite parent, final int style) {
super(parent, style); super(parent, style);
setLayout(new GridLayout(1, false)); setLayout(new GridLayout(1, false));
@@ -120,17 +118,6 @@ public class SWTConsoleView extends Composite implements ConsoleDelayIO {
consoleInput.addKeyListener(new HistoryTextKeyListener(this)); consoleInput.addKeyListener(new HistoryTextKeyListener(this));
} }
/** @param manager the manager to set */
public void setManager(PipedConsoleManager manager) {
this.manager = manager;
if (forward != null) {
forward.setRunning(false);
}
forward = new ToSWTConsoleForwardRunnable(manager);
Thread th = new Thread(forward, "gclcToSWT"); //$NON-NLS-1$
th.start();
}
/** @param next the next message */ /** @param next the next message */
protected void appendConsoleOutput(final String next) { protected void appendConsoleOutput(final String next) {
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {
@@ -142,23 +129,18 @@ public class SWTConsoleView extends Composite implements ConsoleDelayIO {
}); });
} }
/**
*
*/
@Override
public void validateInput() {
try {
manager.type(getInput());
} catch (IOException e) {
LOGGER.log(Level.SEVERE, "Unable to input value to console", e); //$NON-NLS-1$
}
}
@Override @Override
protected void checkSubclass() { protected void checkSubclass() {
// Disable the check that prevents subclassing of SWT components // Disable the check that prevents subclassing of SWT components
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
@Override
public String getInput() {
return consoleInput.getText();
}
/* (non-Javadoc) /* (non-Javadoc)
* @see org.eclipse.swt.widgets.Composite#setFocus() */ * @see org.eclipse.swt.widgets.Composite#setFocus() */
@Override @Override
@@ -166,23 +148,43 @@ public class SWTConsoleView extends Composite implements ConsoleDelayIO {
return consoleInput.setFocus(); return consoleInput.setFocus();
} }
/** @param string the text */
public void setText(String string) {
consoleInput.setText(string);
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */ * @see fr.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
@Override @Override
public void setInput(String input) { public void setInput(final String input) {
consoleInput.setText(input); consoleInput.setText(input);
consoleInput.setSelection(input.length()); consoleInput.setSelection(input.length());
} }
/* (non-Javadoc) /** Set the input and output.
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#getInput() */ *
* @param manager the output to set
* @param input the input */
public void setManager(final PipedConsoleOutput manager,
final PipedConsoleInput input) {
this.input = input;
if (forward != null) {
forward.setRunning(false);
}
forward = new ToSWTConsoleForwardRunnable(manager);
final Thread th = new Thread(forward, "gclcToSWT"); //$NON-NLS-1$
th.start();
}
/** @param string the text */
public void setText(final String string) {
consoleInput.setText(string);
}
/**
*
*/
@Override @Override
public String getInput() { public void validateInput() {
return consoleInput.getText(); try {
input.type(getInput());
} catch (final IOException e) {
LOGGER.log(Level.SEVERE, "Unable to input value to console", e); //$NON-NLS-1$
}
} }
} }

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * GCLC swt, provide a swt window for console applications
* * Copyright (C) 2015-2017 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -33,10 +30,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.tools.package-info.java * gclc-swt:fr.bigeon.gclc.swt.package-info.java
* Created on: Nov 13, 2017 * Created on: Nov 18, 2017
*/ */
/** Tool classes. /** SWT components for a frontend of GCLC applications.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
package fr.bigeon.gclc.tools; package fr.bigeon.gclc.swt;

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright E. Bigeon (2015) * GCLC swt, provide a swt window for console applications
* * Copyright (C) 2015-2017 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a swt window for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright E. Bigeon (2015) * GCLC swt, provide a swt window for console applications
* * Copyright (C) 2015-2017 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a swt window for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -53,8 +50,11 @@ import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.command.ExitCommand; import fr.bigeon.gclc.command.ExitCommand;
import fr.bigeon.gclc.exception.CommandRunException; import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName; import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** <p> /**
* <p>
* TODO * TODO
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
@@ -65,64 +65,192 @@ public class SWTConsoleShellTest {
private static final Display DISPLAY = Display.getDefault(); private static final Display DISPLAY = Display.getDefault();
@Test @Test
public void testConsoleClose() { public void test() {
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY); final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
final SWTConsole swtConsole = (SWTConsole) shell.getManager(); final SWTConsole swtConsole = shell.getManager();
swtConsole.close();
swtConsole.setPrompt(":");
try { try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole, final ConsoleApplication appl = new ConsoleApplication(swtConsole,
"Hello", "See you"); swtConsole, "Hello", "See you");
appl.add(new ExitCommand("exit", appl)); appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") { appl.add(new Command("long") {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
try {
Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override @Override
public String tip() { public String tip() {
return "a long running command"; return "a long running command";
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override @Override
public void execute(String... args) { protected String usageDetail() {
try { // TODO Auto-generated method stub
Thread.sleep(TWO_SECONDS); // return null;
} catch (InterruptedException e) { throw new RuntimeException("Not implemented yet");
// TODO Auto-generated catch block
e.printStackTrace();
}
}
});
appl.add(new Command("test") {
@Override
public String tip() {
return "a prompting running command";
}
@Override
public void execute(String... args) throws CommandRunException {
try {
appl.getManager().prompt("Test");
} catch (IOException e) {
throw new CommandRunException("No input", e, this);
}
} }
}); });
// shell.pack(); // shell.pack();
shell.open(); shell.open();
Thread applThread = new Thread(new Runnable() { final Thread applThread = new Thread(new Runnable() {
@Override @Override
public void run() { public void run() {
appl.start(); appl.start();
} }
}); });
Thread testThread = new Thread(new Runnable() { final Thread testThread = new Thread(new Runnable() {
@Override @Override
public void run() { public void run() {
try { try {
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) { } catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("test"); //$NON-NLS-1$
swtConsole.validateCommand();
}
});
try {
Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
shell.dispose();
}
});
}
});
applThread.start();
testThread.start();
while (!shell.isDisposed()) {
if (!DISPLAY.readAndDispatch()) {
DISPLAY.sleep();
}
}
// DISPLAY.dispose();
assertTrue(swtConsole.isClosed());
Thread.sleep(TWO_SECONDS);
assertFalse(appl.isRunning());
} catch (final InvalidCommandName e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Test
public void testConsoleClose() {
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
final SWTConsole swtConsole = shell.getManager();
swtConsole.close();
swtConsole.setPrompt(":");
try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole,
swtConsole, "Hello", "See you");
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
try {
Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override
public String tip() {
return "a long running command";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
// TODO Auto-generated method stub
// return null;
throw new RuntimeException("Not implemented yet");
}
});
appl.add(new Command("test") {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
try {
swtConsole.prompt("Test");
} catch (final IOException e) {
throw new CommandRunException("No input", e, this);
}
}
@Override
public String tip() {
return "a prompting running command";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
// TODO Auto-generated method stub
// return null;
throw new RuntimeException("Not implemented yet");
}
});
// shell.pack();
shell.open();
final Thread applThread = new Thread(new Runnable() {
@Override
public void run() {
appl.start();
}
});
final Thread testThread = new Thread(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block // TODO Auto-generated catch block
e.printStackTrace(); e.printStackTrace();
} }
@@ -163,7 +291,7 @@ public class SWTConsoleShellTest {
swtConsole.validateCommand(); swtConsole.validateCommand();
try { try {
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) { } catch (final InterruptedException e) {
// TODO Auto-generated catch block // TODO Auto-generated catch block
e.printStackTrace(); e.printStackTrace();
} }
@@ -187,102 +315,17 @@ public class SWTConsoleShellTest {
try { try {
swtConsole.prompt(); swtConsole.prompt();
fail("Prompting when closed should fail!"); fail("Prompting when closed should fail!");
} catch (IOException e) { } catch (final IOException e) {
assertNotNull(e); assertNotNull(e);
} }
// DISPLAY.dispose(); // DISPLAY.dispose();
assertTrue(appl.getManager().isClosed()); assertTrue(swtConsole.isClosed());
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
assertFalse(appl.isRunning()); assertFalse(appl.isRunning());
} catch (InvalidCommandName e) { } catch (final InvalidCommandName e) {
// TODO Auto-generated catch block // TODO Auto-generated catch block
e.printStackTrace(); e.printStackTrace();
} catch (InterruptedException e) { } catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Test
public void test() {
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
final SWTConsole swtConsole = (SWTConsole) shell.getManager();
try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole,
"Hello", "See you");
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
@Override
public String tip() {
return "a long running command";
}
@Override
public void execute(String... args) {
try {
Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
});
// shell.pack();
shell.open();
Thread applThread = new Thread(new Runnable() {
@Override
public void run() {
appl.start();
}
});
Thread testThread = new Thread(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("test"); //$NON-NLS-1$
swtConsole.validateCommand();
}
});
try {
Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
shell.dispose();
}
});
}
});
applThread.start();
testThread.start();
while (!shell.isDisposed()) {
if (!DISPLAY.readAndDispatch()) {
DISPLAY.sleep();
}
}
// DISPLAY.dispose();
assertTrue(appl.getManager().isClosed());
Thread.sleep(TWO_SECONDS);
assertFalse(appl.isRunning());
} catch (InvalidCommandName e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (InterruptedException e) {
// TODO Auto-generated catch block // TODO Auto-generated catch block
e.printStackTrace(); e.printStackTrace();
} }

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright E. Bigeon (2015) * GCLC swt, provide a swt window for console applications
* * Copyright (C) 2015-2017 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a swt window for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -50,8 +47,12 @@ import org.junit.Test;
import fr.bigeon.gclc.ConsoleApplication; import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.command.Command; import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.command.ExitCommand; import fr.bigeon.gclc.command.ExitCommand;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName; import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.manager.PipedConsoleManager; import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
import fr.bigeon.gclc.manager.PipedConsoleInput;
import fr.bigeon.gclc.manager.PipedConsoleOutput;
/** <p> /** <p>
* TODO * TODO
@@ -67,49 +68,65 @@ public class SWTConsoleViewTest {
public void test() { public void test() {
final Shell shell = new Shell(DISPLAY); final Shell shell = new Shell(DISPLAY);
final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE); final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE);
try (PipedConsoleManager manager = new PipedConsoleManager()) { try (PipedConsoleOutput manager = new PipedConsoleOutput();
swtConsole.setManager(manager); PipedConsoleInput input = new PipedConsoleInput(System.out)) {
} catch (IOException e2) { swtConsole.setManager(manager, input);
} catch (final IOException e2) {
assertNull(e2); assertNull(e2);
} }
try (PipedConsoleManager manager = new PipedConsoleManager()) { try (PipedConsoleOutput manager = new PipedConsoleOutput();
swtConsole.setManager(manager); PipedConsoleInput input = new PipedConsoleInput(System.out)) {
swtConsole.setManager(manager, input);
final ConsoleApplication appl = new ConsoleApplication(manager, final ConsoleApplication appl = new ConsoleApplication(manager,
input,
"Hello", "See you"); "Hello", "See you");
appl.add(new ExitCommand("exit", appl)); appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") { appl.add(new Command("long") {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[])
*/
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override @Override
public String tip() { public String tip() {
return "a long running command"; return "a long running command";
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override @Override
public void execute(String... args) { protected String usageDetail() {
try { // TODO Auto-generated method stub
Thread.sleep(TWO_SECONDS); // return null;
} catch (InterruptedException e) { throw new RuntimeException("Not implemented yet");
// TODO Auto-generated catch block
e.printStackTrace();
}
} }
}); });
// shell.pack(); // shell.pack();
shell.open(); shell.open();
Thread applThread = new Thread(new Runnable() { final Thread applThread = new Thread(new Runnable() {
@Override @Override
public void run() { public void run() {
appl.start(); appl.start();
} }
}); });
Thread testThread = new Thread(new Runnable() { final Thread testThread = new Thread(new Runnable() {
@Override @Override
public void run() { public void run() {
try { try {
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) { } catch (final InterruptedException e) {
// TODO Auto-generated catch block // TODO Auto-generated catch block
e.printStackTrace(); e.printStackTrace();
} }
@@ -122,7 +139,7 @@ public class SWTConsoleViewTest {
}); });
try { try {
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) { } catch (final InterruptedException e) {
// TODO Auto-generated catch block // TODO Auto-generated catch block
e.printStackTrace(); e.printStackTrace();
} }
@@ -141,10 +158,10 @@ public class SWTConsoleViewTest {
DISPLAY.sleep(); DISPLAY.sleep();
} }
} }
} catch (InvalidCommandName e) { } catch (final InvalidCommandName e) {
// TODO Auto-generated catch block // TODO Auto-generated catch block
e.printStackTrace(); e.printStackTrace();
} catch (IOException e1) { } catch (final IOException e1) {
// TODO Auto-generated catch block // TODO Auto-generated catch block
e1.printStackTrace(); e1.printStackTrace();
} }

View File

@@ -23,7 +23,7 @@
<dependency> <dependency>
<groupId>fr.bigeon</groupId> <groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId> <artifactId>gclc</artifactId>
<version>1.3.1</version> <version>2.0.0</version>
</dependency> </dependency>
</dependencies> </dependencies>
<name>GCLC system command</name> <name>GCLC system command</name>

View File

@@ -15,7 +15,8 @@ import java.util.logging.Logger;
import fr.bigeon.gclc.command.Command; import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.exception.CommandRunException; import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType; import fr.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.manager.ConsoleManager; import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** A command that will execute a system command. /** A command that will execute a system command.
* *
@@ -29,71 +30,68 @@ public class ExecSystemCommand extends Command {
/** The class logger */ /** The class logger */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(ExecSystemCommand.class.getName()); .getLogger(ExecSystemCommand.class.getName());
/** The manager for the application's user interface */
private final ConsoleManager manager;
/** @param name the name of the command (the input from the manager that /***/
* should trigger this command) public ExecSystemCommand() {
* @param manager the console manager for input and outputs */ super(COMMAND_DEFAULT_NAME);
public ExecSystemCommand(String name, ConsoleManager manager) {
super(name);
this.manager = manager;
} }
/** @param manager the console manager for input and outputs */ /** @param name the name of the command (the input from the manager that
public ExecSystemCommand(ConsoleManager manager) { * should trigger this command) */
super(COMMAND_DEFAULT_NAME); public ExecSystemCommand(final String name) {
this.manager = manager; super(name);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */ * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
@SuppressWarnings("resource") * ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override @Override
public void execute(String... args) throws CommandRunException { public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
Process proc; Process proc;
try { try {
proc = Runtime.getRuntime().exec(args); proc = Runtime.getRuntime().exec(args);
} catch (IOException e2) { } catch (final IOException e2) {
LOGGER.log(Level.SEVERE, "Unable to run process", e2); //$NON-NLS-1$ LOGGER.log(Level.SEVERE, "Unable to run process", e2); //$NON-NLS-1$
return; return;
} }
final InputStream is = proc final InputStream is = proc
.getInputStream(); .getInputStream();
Thread th = new Thread(new Runnable() { final Thread th = new Thread(new Runnable() {
@SuppressWarnings("synthetic-access") @SuppressWarnings("synthetic-access")
@Override @Override
public void run() { public void run() {
try { try {
readToEnd(is); readToEnd(out, is);
is.close(); is.close();
} catch (CommandRunException e) { } catch (final CommandRunException e) {
LOGGER.log(Level.WARNING, LOGGER.log(Level.WARNING,
"Manager was closed in the meantime...", e); //$NON-NLS-1$ "Manager was closed in the meantime...", e); //$NON-NLS-1$
} catch (IOException e) { } catch (final IOException e) {
LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$ LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$
} }
} }
}); });
th.start(); th.start();
manager.setPrompt(""); //$NON-NLS-1$ in.setPrompt(""); //$NON-NLS-1$
final OutputStream os = proc.getOutputStream(); final OutputStream os = proc.getOutputStream();
try (BufferedWriter writer = new BufferedWriter( try (BufferedWriter writer = new BufferedWriter(
new OutputStreamWriter(os))) { new OutputStreamWriter(os))) {
while (th.isAlive()) { while (th.isAlive()) {
String user; String user;
try { try {
user = manager.prompt(); user = in.prompt();
} catch (IOException e) { } catch (final IOException e) {
throw new CommandRunException( throw new CommandRunException(
CommandRunExceptionType.INTERACTION, CommandRunExceptionType.INTERACTION,
"manager was closed", e, this); //$NON-NLS-1$ "manager was closed", e, this); //$NON-NLS-1$
} }
writer.write(user + EOL); writer.write(user + EOL);
} }
} catch (IOException e1) { } catch (final IOException e1) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION, throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"manager was closed", e1, this); //$NON-NLS-1$ "manager was closed", e1, this); //$NON-NLS-1$
} }
@@ -102,23 +100,31 @@ public class ExecSystemCommand extends Command {
/** @param is the input stream /** @param is the input stream
* @throws CommandRunException if the manager was closed while writing the * @throws CommandRunException if the manager was closed while writing the
* stream */ * stream */
protected void readToEnd(InputStream is) throws CommandRunException { protected void readToEnd(final ConsoleOutput out,
final InputStream is) throws CommandRunException {
int c; int c;
try { try {
while ((c = is.read()) != -1) { while ((c = is.read()) != -1) {
try { try {
manager.print(Character.valueOf((char) c).toString()); out.print(Character.valueOf((char) c).toString());
} catch (IOException e) { } catch (final IOException e) {
throw new CommandRunException( throw new CommandRunException(
CommandRunExceptionType.INTERACTION, CommandRunExceptionType.INTERACTION,
"manager was closed", e, this); //$NON-NLS-1$ "manager was closed", e, this); //$NON-NLS-1$
} }
} }
} catch (IOException e) { } catch (final IOException e) {
LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$ LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$
} }
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Execute a system command"; //$NON-NLS-1$
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */ * @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override @Override
@@ -139,11 +145,4 @@ public class ExecSystemCommand extends Command {
return " CMD <system command>"; //$NON-NLS-1$ return " CMD <system command>"; //$NON-NLS-1$
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Execute a system command"; //$NON-NLS-1$
}
} }

517
gclc/LICENSE.txt Normal file
View File

@@ -0,0 +1,517 @@
CeCILL FREE SOFTWARE LICENSE AGREEMENT
Version 2.1 dated 2013-06-21
Notice
This Agreement is a Free Software license agreement that is the result
of discussions between its authors in order to ensure compliance with
the two main principles guiding its drafting:
* firstly, compliance with the principles governing the distribution
of Free Software: access to source code, broad rights granted to users,
* secondly, the election of a governing law, French law, with which it
is conformant, both as regards the law of torts and intellectual
property law, and the protection that it offers to both authors and
holders of the economic rights over software.
The authors of the CeCILL (for Ce[a] C[nrs] I[nria] L[ogiciel] L[ibre])
license are:
Commissariat à l'énergie atomique et aux énergies alternatives - CEA, a
public scientific, technical and industrial research establishment,
having its principal place of business at 25 rue Leblanc, immeuble Le
Ponant D, 75015 Paris, France.
Centre National de la Recherche Scientifique - CNRS, a public scientific
and technological establishment, having its principal place of business
at 3 rue Michel-Ange, 75794 Paris cedex 16, France.
Institut National de Recherche en Informatique et en Automatique -
Inria, a public scientific and technological establishment, having its
principal place of business at Domaine de Voluceau, Rocquencourt, BP
105, 78153 Le Chesnay cedex, France.
Preamble
The purpose of this Free Software license agreement is to grant users
the right to modify and redistribute the software governed by this
license within the framework of an open source distribution model.
The exercising of this right is conditional upon certain obligations for
users so as to preserve this status for all subsequent redistributions.
In consideration of access to the source code and the rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors only have limited liability.
In this respect, the risks associated with loading, using, modifying
and/or developing or reproducing the software by the user are brought to
the user's attention, given its Free Software status, which may make it
complicated to use, with the result that its use is reserved for
developers and experienced professionals having in-depth computer
knowledge. Users are therefore encouraged to load and test the
suitability of the software as regards their requirements in conditions
enabling the security of their systems and/or data to be ensured and,
more generally, to use and operate it in the same conditions of
security. This Agreement may be freely reproduced and published,
provided it is not altered, and that no provisions are either added or
removed herefrom.
This Agreement may apply to any or all software for which the holder of
the economic rights decides to submit the use thereof to its provisions.
Frequently asked questions can be found on the official website of the
CeCILL licenses family (http://www.cecill.info/index.en.html) for any
necessary clarification.
Article 1 - DEFINITIONS
For the purpose of this Agreement, when the following expressions
commence with a capital letter, they shall have the following meaning:
Agreement: means this license agreement, and its possible subsequent
versions and annexes.
Software: means the software in its Object Code and/or Source Code form
and, where applicable, its documentation, "as is" when the Licensee
accepts the Agreement.
Initial Software: means the Software in its Source Code and possibly its
Object Code form and, where applicable, its documentation, "as is" when
it is first distributed under the terms and conditions of the Agreement.
Modified Software: means the Software modified by at least one
Contribution.
Source Code: means all the Software's instructions and program lines to
which access is required so as to modify the Software.
Object Code: means the binary files originating from the compilation of
the Source Code.
Holder: means the holder(s) of the economic rights over the Initial
Software.
Licensee: means the Software user(s) having accepted the Agreement.
Contributor: means a Licensee having made at least one Contribution.
Licensor: means the Holder, or any other individual or legal entity, who
distributes the Software under the Agreement.
Contribution: means any or all modifications, corrections, translations,
adaptations and/or new functions integrated into the Software by any or
all Contributors, as well as any or all Internal Modules.
Module: means a set of sources files including their documentation that
enables supplementary functions or services in addition to those offered
by the Software.
External Module: means any or all Modules, not derived from the
Software, so that this Module and the Software run in separate address
spaces, with one calling the other when they are run.
Internal Module: means any or all Module, connected to the Software so
that they both execute in the same address space.
GNU GPL: means the GNU General Public License version 2 or any
subsequent version, as published by the Free Software Foundation Inc.
GNU Affero GPL: means the GNU Affero General Public License version 3 or
any subsequent version, as published by the Free Software Foundation Inc.
EUPL: means the European Union Public License version 1.1 or any
subsequent version, as published by the European Commission.
Parties: mean both the Licensee and the Licensor.
These expressions may be used both in singular and plural form.
Article 2 - PURPOSE
The purpose of the Agreement is the grant by the Licensor to the
Licensee of a non-exclusive, transferable and worldwide license for the
Software as set forth in Article 5 <#scope> hereinafter for the whole
term of the protection granted by the rights over said Software.
Article 3 - ACCEPTANCE
3.1 The Licensee shall be deemed as having accepted the terms and
conditions of this Agreement upon the occurrence of the first of the
following events:
* (i) loading the Software by any or all means, notably, by
downloading from a remote server, or by loading from a physical medium;
* (ii) the first time the Licensee exercises any of the rights granted
hereunder.
3.2 One copy of the Agreement, containing a notice relating to the
characteristics of the Software, to the limited warranty, and to the
fact that its use is restricted to experienced users has been provided
to the Licensee prior to its acceptance as set forth in Article 3.1
<#accepting> hereinabove, and the Licensee hereby acknowledges that it
has read and understood it.
Article 4 - EFFECTIVE DATE AND TERM
4.1 EFFECTIVE DATE
The Agreement shall become effective on the date when it is accepted by
the Licensee as set forth in Article 3.1 <#accepting>.
4.2 TERM
The Agreement shall remain in force for the entire legal term of
protection of the economic rights over the Software.
Article 5 - SCOPE OF RIGHTS GRANTED
The Licensor hereby grants to the Licensee, who accepts, the following
rights over the Software for any or all use, and for the term of the
Agreement, on the basis of the terms and conditions set forth hereinafter.
Besides, if the Licensor owns or comes to own one or more patents
protecting all or part of the functions of the Software or of its
components, the Licensor undertakes not to enforce the rights granted by
these patents against successive Licensees using, exploiting or
modifying the Software. If these patents are transferred, the Licensor
undertakes to have the transferees subscribe to the obligations set
forth in this paragraph.
5.1 RIGHT OF USE
The Licensee is authorized to use the Software, without any limitation
as to its fields of application, with it being hereinafter specified
that this comprises:
1. permanent or temporary reproduction of all or part of the Software
by any or all means and in any or all form.
2. loading, displaying, running, or storing the Software on any or all
medium.
3. entitlement to observe, study or test its operation so as to
determine the ideas and principles behind any or all constituent
elements of said Software. This shall apply when the Licensee
carries out any or all loading, displaying, running, transmission or
storage operation as regards the Software, that it is entitled to
carry out hereunder.
5.2 ENTITLEMENT TO MAKE CONTRIBUTIONS
The right to make Contributions includes the right to translate, adapt,
arrange, or make any or all modifications to the Software, and the right
to reproduce the resulting software.
The Licensee is authorized to make any or all Contributions to the
Software provided that it includes an explicit notice that it is the
author of said Contribution and indicates the date of the creation thereof.
5.3 RIGHT OF DISTRIBUTION
In particular, the right of distribution includes the right to publish,
transmit and communicate the Software to the general public on any or
all medium, and by any or all means, and the right to market, either in
consideration of a fee, or free of charge, one or more copies of the
Software by any means.
The Licensee is further authorized to distribute copies of the modified
or unmodified Software to third parties according to the terms and
conditions set forth hereinafter.
5.3.1 DISTRIBUTION OF SOFTWARE WITHOUT MODIFICATION
The Licensee is authorized to distribute true copies of the Software in
Source Code or Object Code form, provided that said distribution
complies with all the provisions of the Agreement and is accompanied by:
1. a copy of the Agreement,
2. a notice relating to the limitation of both the Licensor's warranty
and liability as set forth in Articles 8 and 9,
and that, in the event that only the Object Code of the Software is
redistributed, the Licensee allows effective access to the full Source
Code of the Software for a period of at least three years from the
distribution of the Software, it being understood that the additional
acquisition cost of the Source Code shall not exceed the cost of the
data transfer.
5.3.2 DISTRIBUTION OF MODIFIED SOFTWARE
When the Licensee makes a Contribution to the Software, the terms and
conditions for the distribution of the resulting Modified Software
become subject to all the provisions of this Agreement.
The Licensee is authorized to distribute the Modified Software, in
source code or object code form, provided that said distribution
complies with all the provisions of the Agreement and is accompanied by:
1. a copy of the Agreement,
2. a notice relating to the limitation of both the Licensor's warranty
and liability as set forth in Articles 8 and 9,
and, in the event that only the object code of the Modified Software is
redistributed,
3. a note stating the conditions of effective access to the full source
code of the Modified Software for a period of at least three years
from the distribution of the Modified Software, it being understood
that the additional acquisition cost of the source code shall not
exceed the cost of the data transfer.
5.3.3 DISTRIBUTION OF EXTERNAL MODULES
When the Licensee has developed an External Module, the terms and
conditions of this Agreement do not apply to said External Module, that
may be distributed under a separate license agreement.
5.3.4 COMPATIBILITY WITH OTHER LICENSES
The Licensee can include a code that is subject to the provisions of one
of the versions of the GNU GPL, GNU Affero GPL and/or EUPL in the
Modified or unmodified Software, and distribute that entire code under
the terms of the same version of the GNU GPL, GNU Affero GPL and/or EUPL.
The Licensee can include the Modified or unmodified Software in a code
that is subject to the provisions of one of the versions of the GNU GPL,
GNU Affero GPL and/or EUPL and distribute that entire code under the
terms of the same version of the GNU GPL, GNU Affero GPL and/or EUPL.
Article 6 - INTELLECTUAL PROPERTY
6.1 OVER THE INITIAL SOFTWARE
The Holder owns the economic rights over the Initial Software. Any or
all use of the Initial Software is subject to compliance with the terms
and conditions under which the Holder has elected to distribute its work
and no one shall be entitled to modify the terms and conditions for the
distribution of said Initial Software.
The Holder undertakes that the Initial Software will remain ruled at
least by this Agreement, for the duration set forth in Article 4.2 <#term>.
6.2 OVER THE CONTRIBUTIONS
The Licensee who develops a Contribution is the owner of the
intellectual property rights over this Contribution as defined by
applicable law.
6.3 OVER THE EXTERNAL MODULES
The Licensee who develops an External Module is the owner of the
intellectual property rights over this External Module as defined by
applicable law and is free to choose the type of agreement that shall
govern its distribution.
6.4 JOINT PROVISIONS
The Licensee expressly undertakes:
1. not to remove, or modify, in any manner, the intellectual property
notices attached to the Software;
2. to reproduce said notices, in an identical manner, in the copies of
the Software modified or not.
The Licensee undertakes not to directly or indirectly infringe the
intellectual property rights on the Software of the Holder and/or
Contributors, and to take, where applicable, vis-à-vis its staff, any
and all measures required to ensure respect of said intellectual
property rights of the Holder and/or Contributors.
Article 7 - RELATED SERVICES
7.1 Under no circumstances shall the Agreement oblige the Licensor to
provide technical assistance or maintenance services for the Software.
However, the Licensor is entitled to offer this type of services. The
terms and conditions of such technical assistance, and/or such
maintenance, shall be set forth in a separate instrument. Only the
Licensor offering said maintenance and/or technical assistance services
shall incur liability therefor.
7.2 Similarly, any Licensor is entitled to offer to its licensees, under
its sole responsibility, a warranty, that shall only be binding upon
itself, for the redistribution of the Software and/or the Modified
Software, under terms and conditions that it is free to decide. Said
warranty, and the financial terms and conditions of its application,
shall be subject of a separate instrument executed between the Licensor
and the Licensee.
Article 8 - LIABILITY
8.1 Subject to the provisions of Article 8.2, the Licensee shall be
entitled to claim compensation for any direct loss it may have suffered
from the Software as a result of a fault on the part of the relevant
Licensor, subject to providing evidence thereof.
8.2 The Licensor's liability is limited to the commitments made under
this Agreement and shall not be incurred as a result of in particular:
(i) loss due the Licensee's total or partial failure to fulfill its
obligations, (ii) direct or consequential loss that is suffered by the
Licensee due to the use or performance of the Software, and (iii) more
generally, any consequential loss. In particular the Parties expressly
agree that any or all pecuniary or business loss (i.e. loss of data,
loss of profits, operating loss, loss of customers or orders,
opportunity cost, any disturbance to business activities) or any or all
legal proceedings instituted against the Licensee by a third party,
shall constitute consequential loss and shall not provide entitlement to
any or all compensation from the Licensor.
Article 9 - WARRANTY
9.1 The Licensee acknowledges that the scientific and technical
state-of-the-art when the Software was distributed did not enable all
possible uses to be tested and verified, nor for the presence of
possible defects to be detected. In this respect, the Licensee's
attention has been drawn to the risks associated with loading, using,
modifying and/or developing and reproducing the Software which are
reserved for experienced users.
The Licensee shall be responsible for verifying, by any or all means,
the suitability of the product for its requirements, its good working
order, and for ensuring that it shall not cause damage to either persons
or properties.
9.2 The Licensor hereby represents, in good faith, that it is entitled
to grant all the rights over the Software (including in particular the
rights set forth in Article 5 <#scope>).
9.3 The Licensee acknowledges that the Software is supplied "as is" by
the Licensor without any other express or tacit warranty, other than
that provided for in Article 9.2 <#good-faith> and, in particular,
without any warranty as to its commercial value, its secured, safe,
innovative or relevant nature.
Specifically, the Licensor does not warrant that the Software is free
from any error, that it will operate without interruption, that it will
be compatible with the Licensee's own equipment and software
configuration, nor that it will meet the Licensee's requirements.
9.4 The Licensor does not either expressly or tacitly warrant that the
Software does not infringe any third party intellectual property right
relating to a patent, software or any other property right. Therefore,
the Licensor disclaims any and all liability towards the Licensee
arising out of any or all proceedings for infringement that may be
instituted in respect of the use, modification and redistribution of the
Software. Nevertheless, should such proceedings be instituted against
the Licensee, the Licensor shall provide it with technical and legal
expertise for its defense. Such technical and legal expertise shall be
decided on a case-by-case basis between the relevant Licensor and the
Licensee pursuant to a memorandum of understanding. The Licensor
disclaims any and all liability as regards the Licensee's use of the
name of the Software. No warranty is given as regards the existence of
prior rights over the name of the Software or as regards the existence
of a trademark.
Article 10 - TERMINATION
10.1 In the event of a breach by the Licensee of its obligations
hereunder, the Licensor may automatically terminate this Agreement
thirty (30) days after notice has been sent to the Licensee and has
remained ineffective.
10.2 A Licensee whose Agreement is terminated shall no longer be
authorized to use, modify or distribute the Software. However, any
licenses that it may have granted prior to termination of the Agreement
shall remain valid subject to their having been granted in compliance
with the terms and conditions hereof.
Article 11 - MISCELLANEOUS
11.1 EXCUSABLE EVENTS
Neither Party shall be liable for any or all delay, or failure to
perform the Agreement, that may be attributable to an event of force
majeure, an act of God or an outside cause, such as defective
functioning or interruptions of the electricity or telecommunications
networks, network paralysis following a virus attack, intervention by
government authorities, natural disasters, water damage, earthquakes,
fire, explosions, strikes and labor unrest, war, etc.
11.2 Any failure by either Party, on one or more occasions, to invoke
one or more of the provisions hereof, shall under no circumstances be
interpreted as being a waiver by the interested Party of its right to
invoke said provision(s) subsequently.
11.3 The Agreement cancels and replaces any or all previous agreements,
whether written or oral, between the Parties and having the same
purpose, and constitutes the entirety of the agreement between said
Parties concerning said purpose. No supplement or modification to the
terms and conditions hereof shall be effective as between the Parties
unless it is made in writing and signed by their duly authorized
representatives.
11.4 In the event that one or more of the provisions hereof were to
conflict with a current or future applicable act or legislative text,
said act or legislative text shall prevail, and the Parties shall make
the necessary amendments so as to comply with said act or legislative
text. All other provisions shall remain effective. Similarly, invalidity
of a provision of the Agreement, for any reason whatsoever, shall not
cause the Agreement as a whole to be invalid.
11.5 LANGUAGE
The Agreement is drafted in both French and English and both versions
are deemed authentic.
Article 12 - NEW VERSIONS OF THE AGREEMENT
12.1 Any person is authorized to duplicate and distribute copies of this
Agreement.
12.2 So as to ensure coherence, the wording of this Agreement is
protected and may only be modified by the authors of the License, who
reserve the right to periodically publish updates or new versions of the
Agreement, each with a separate number. These subsequent versions may
address new issues encountered by Free Software.
12.3 Any Software distributed under a given version of the Agreement may
only be subsequently distributed under the same version of the Agreement
or a subsequent version, subject to the provisions of Article 5.3.4
<#compatibility>.
Article 13 - GOVERNING LAW AND JURISDICTION
13.1 The Agreement is governed by French law. The Parties agree to
endeavor to seek an amicable solution to any disagreements or disputes
that may arise during the performance of the Agreement.
13.2 Failing an amicable solution within two (2) months as from their
occurrence, and unless emergency proceedings are necessary, the
disagreements or disputes shall be referred to the Paris Courts having
jurisdiction, by the more diligent Party.

View File

@@ -1,46 +1,15 @@
<!-- Copyright Bigeon Emmanuel (2014) -->
<!-- -->
<!-- emmanuel@bigeon.fr -->
<!-- -->
<!-- This software is a computer program whose purpose is to -->
<!-- provide a generic framework for console applications. -->
<!-- -->
<!-- This software is governed by the CeCILL license under French law and -->
<!-- abiding by the rules of distribution of free software. You can use, -->
<!-- modify and/or redistribute the software under the terms of the CeCILL -->
<!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
<!-- "http://www.cecill.info". -->
<!-- -->
<!-- As a counterpart to the access to the source code and rights to copy, -->
<!-- modify and redistribute granted by the license, users are provided only -->
<!-- with a limited warranty and the software's author, the holder of the -->
<!-- economic rights, and the successive licensors have only limited -->
<!-- liability. -->
<!-- -->
<!-- In this respect, the user's attention is drawn to the risks associated -->
<!-- with loading, using, modifying and/or developing or reproducing the -->
<!-- software by the user in light of its specific status of free software, -->
<!-- that may mean that it is complicated to manipulate, and that also -->
<!-- therefore means that it is reserved for developers and experienced -->
<!-- professionals having in-depth computer knowledge. Users are therefore -->
<!-- encouraged to load and test the software's suitability as regards their -->
<!-- requirements in conditions enabling the security of their systems and/or -->
<!-- data to be ensured and, more generally, to use and operate it in the -->
<!-- same conditions as regards security. -->
<!-- -->
<!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<artifactId>gclc</artifactId> <artifactId>gclc</artifactId>
<version>2.0.0</version> <version>2.0.7</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<url>http://www.bigeon.fr/emmanuel</url> <url>http://bigeon.net</url>
<properties> <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.scm.id>git.bigeon.net</project.scm.id> <project.scm.id>git.code.bigeon.net</project.scm.id>
<copyright.email>emmanuel@bigeon.fr</copyright.email>
<license.licenseName>cecill_2.1</license.licenseName>
</properties> </properties>
<dependencies> <dependencies>
<dependency> <dependency>
@@ -51,38 +20,61 @@
</dependency> </dependency>
</dependencies> </dependencies>
<parent> <parent>
<groupId>fr.bigeon</groupId> <groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId> <artifactId>ebigeon-config</artifactId>
<version>1.7.1</version> <version>1.8.3</version>
</parent> </parent>
<build> <build>
<plugins> <plugins>
<plugin> <plugin>
<groupId>com.mycila</groupId> <groupId>org.codehaus.mojo</groupId>
<artifactId>license-maven-plugin</artifactId> <artifactId>license-maven-plugin</artifactId>
<configuration> <configuration>
<header>fr/bigeon/gclc/licensing/cecill/CeCILL-header.txt</header> <extraExtensions>
<properties> <gclc>properties</gclc>
<owner>Bigeon Emmanuel</owner> <txt>properties</txt>
<email>emmanuel@bigeon.fr</email> </extraExtensions>
</properties>
</configuration> </configuration>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin> </plugin>
</plugins> </plugins>
</build> </build>
<licenses>
<license>
<distribution>manual</distribution>
<name>CeCILL 2.1</name>
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
</license>
</licenses>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>dsm-maven-plugin</artifactId>
<version>2.2.0</version>
</plugin>
</plugins>
</reporting>
<developers>
<developer>
<email>emmanuel@bigeon.fr</email>
<name>Emmanuel Bigeon</name>
<url>bigeon.net</url>
<roles>
<role>PM</role>
</roles>
</developer>
</developers>
<inceptionYear>2014</inceptionYear> <inceptionYear>2014</inceptionYear>
<name>Generic Command Ligne console</name> <name>Generic Command Ligne console</name>
<description>provide a generic framework for console applications</description> <description>A generic framework for console applications, with customized command input and output streams.</description>
<scm> <scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>gclc-2.0.0</tag> <tag>gclc-2.0.7</tag>
</scm> </scm>
<groupId>net.bigeon</groupId>
</project> </project>

View File

@@ -1,14 +1,18 @@
/* /**
* Copyright Bigeon Emmanuel (2014) * gclc:net.bigeon.gclc.ApplicationAttachement.java
* * Created on: Apr 19, 2017
* emmanuel@bigeon.fr */
* package net.bigeon.gclc;
* This software is a computer program whose purpose is to
* provide a generic framework for console applications. /*-
* * #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,14 +35,11 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/**
* gclc:fr.bigeon.gclc.ApplicationAttachement.java
* Created on: Apr 19, 2017
*/
package fr.bigeon.gclc;
import fr.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.command.ICommandProvider;
import net.bigeon.gclc.exception.InvalidCommandName;
/** Represent a functionnality set that can be added to a console application. /** Represent a functionnality set that can be added to a console application.
* *
@@ -54,5 +55,5 @@ public interface ApplicationAttachement {
* @param application the application * @param application the application
* @throws InvalidCommandName if a command name is invalid for the * @throws InvalidCommandName if a command name is invalid for the
* application. */ * application. */
void attach(ConsoleApplication application) throws InvalidCommandName; void attach(ICommandProvider application) throws InvalidCommandName;
} }

View File

@@ -1,14 +1,18 @@
/* /**
* Copyright Bigeon Emmanuel (2014) * gclc:net.bigeon.gclc.CommandRequestListener.java
* * Created on: Mar 19, 2015
* emmanuel@bigeon.fr */
* package net.bigeon.gclc;
* This software is a computer program whose purpose is to
* provide a generic framework for console applications. /*-
* * #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,13 +35,8 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/**
* gclc:fr.bigeon.gclc.CommandRequestListener.java
* Created on: Mar 19, 2015
*/
package fr.bigeon.gclc;
/** Command Request Listeners are listeners that are notified before a command /** Command Request Listeners are listeners that are notified before a command
* is executed by the ConsoleApplication. * is executed by the ConsoleApplication.
* *

View File

@@ -32,10 +32,43 @@
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** gclc:fr.bigeon.gclc.ConsoleApplication.java /** gclc:net.bigeon.gclc.ConsoleApplication.java
* Created on: Sep 6, 2014 */ * Created on: Sep 6, 2014 */
package fr.bigeon.gclc; package net.bigeon.gclc;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import java.io.InterruptedIOException; import java.io.InterruptedIOException;
import java.util.ArrayList; import java.util.ArrayList;
@@ -44,16 +77,16 @@ import java.util.List;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
import fr.bigeon.gclc.command.ICommand; import net.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.command.ICommandProvider; import net.bigeon.gclc.command.ICommandProvider;
import fr.bigeon.gclc.command.SubedCommand; import net.bigeon.gclc.command.SubedCommand;
import fr.bigeon.gclc.exception.CommandParsingException; import net.bigeon.gclc.exception.CommandParsingException;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType; import net.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.i18n.Messages; import net.bigeon.gclc.i18n.Messages;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** /**
* A {@link ConsoleApplication} is an application that require the user to input * A {@link ConsoleApplication} is an application that require the user to input
@@ -62,8 +95,8 @@ import fr.bigeon.gclc.manager.ConsoleOutput;
* A typical use case is the following: * A typical use case is the following:
* *
* <pre> * <pre>
* {@link ConsoleOutput} out = new {@link fr.bigeon.gclc.manager.StreamConsoleOutput StreamConsoleOutput}(); * {@link ConsoleOutput} out = new {@link net.bigeon.gclc.utils.StreamConsoleOutput StreamConsoleOutput}();
* {@link ConsoleInput} in = new {@link fr.bigeon.gclc.manager.StreamConsoleInput StreamConsoleInput}(); * {@link ConsoleInput} in = new {@link net.bigeon.gclc.utils.StreamConsoleInput StreamConsoleInput}();
* {@link ConsoleApplication} app = new {@link ConsoleApplication}(out, in, "welcome", "see you latter")}; * {@link ConsoleApplication} app = new {@link ConsoleApplication}(out, in, "welcome", "see you latter")};
* app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()}); * app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()});
* app.{@link ConsoleApplication#start() start()}; * app.{@link ConsoleApplication#start() start()};
@@ -124,7 +157,7 @@ public final class ConsoleApplication implements ICommandProvider {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommandProvider#executeSub(java.lang.String, * @see net.bigeon.gclc.command.ICommandProvider#executeSub(java.lang.String,
* java.lang.String[]) */ * java.lang.String[]) */
@Override @Override
public void executeSub(final ConsoleOutput output, final ConsoleInput input, public void executeSub(final ConsoleOutput output, final ConsoleInput input,
@@ -141,7 +174,7 @@ public final class ConsoleApplication implements ICommandProvider {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */ * @see net.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */
@Override @Override
public ICommand get(final String command) { public ICommand get(final String command) {
return root.get(command); return root.get(command);
@@ -173,7 +206,7 @@ public final class ConsoleApplication implements ICommandProvider {
.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$ .getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
out.println(e.getLocalizedMessage()); out.println(e.getLocalizedMessage());
if (e.getType() == CommandRunExceptionType.USAGE) { if (e.getType() == CommandRunExceptionType.USAGE) {
e.getSource().help(out); get(args.get(0)).help(out);
} }
} }
} }

View File

@@ -33,15 +33,48 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.GCLCConstants.java * gclc:net.bigeon.gclc.GCLCConstants.java
* Created on: Jun 8, 2016 * Created on: Jun 8, 2016
*/ */
package fr.bigeon.gclc; package net.bigeon.gclc;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import fr.bigeon.gclc.exception.CommandParsingException; import net.bigeon.gclc.exception.CommandParsingException;
/** A Utility class for GCLC /** A Utility class for GCLC
* <p> * <p>

View File

@@ -1,14 +1,18 @@
/* /**
* Copyright Bigeon Emmanuel (2014) * acide:fr.bigeon.acide.Command.java
* * Created on: Jul 31, 2014
* emmanuel@bigeon.fr */
* package net.bigeon.gclc.command;
* This software is a computer program whose purpose is to
* provide a generic framework for console applications. /*-
* * #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,16 +35,11 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/**
* acide:fr.bigeon.acide.Command.java
* Created on: Jul 31, 2014
*/
package fr.bigeon.gclc.command;
import java.io.IOException; import java.io.IOException;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** A command to execute. /** A command to execute.
* <p> * <p>
@@ -91,7 +90,7 @@ public abstract class Command implements ICommand {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ * @see net.bigeon.gclc.command.ICommand#getCommandName() */
@Override @Override
public final String getCommandName() { public final String getCommandName() {
return name; return name;
@@ -111,7 +110,7 @@ public abstract class Command implements ICommand {
* [Usage details] * [Usage details]
* </pre> * </pre>
* *
* @see fr.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */ * @see net.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */
@Override @Override
public final void help(final ConsoleOutput manager, public final void help(final ConsoleOutput manager,
final String... args) throws IOException { final String... args) throws IOException {

View File

@@ -1,14 +1,18 @@
/* /**
* Copyright Bigeon Emmanuel (2014) * gclc:net.bigeon.gclc.command.CommandParameters.java
* * Created on: Dec 24, 2014
* emmanuel@bigeon.fr */
* package net.bigeon.gclc.command;
* This software is a computer program whose purpose is to
* provide a generic framework for console applications. /*-
* * #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,13 +35,8 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/**
* gclc:fr.bigeon.gclc.command.CommandParameters.java
* Created on: Dec 24, 2014
*/
package fr.bigeon.gclc.command;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections; import java.util.Collections;
import java.util.HashMap; import java.util.HashMap;
@@ -45,7 +44,7 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import fr.bigeon.gclc.exception.CommandParsingException; import net.bigeon.gclc.exception.CommandParsingException;
/** An object representing a collection of parameters. /** An object representing a collection of parameters.
* <p> * <p>
@@ -137,7 +136,11 @@ public final class CommandParameters {
* @return the number of element read */ * @return the number of element read */
private int parseArg(final String arg, final String next) { private int parseArg(final String arg, final String next) {
if (!arg.startsWith("-")) { //$NON-NLS-1$ if (!arg.startsWith("-")) { //$NON-NLS-1$
return strict ? 0 : 1; if (strict) {
return 0;
}
additional.add(arg);
return 1;
} }
final String name = arg.substring(1); final String name = arg.substring(1);
if (booleanArguments.containsKey(name)) { if (booleanArguments.containsKey(name)) {

View File

@@ -1,14 +1,16 @@
/* /** acide:fr.bigeon.acide.CommandProvider.java
* Copyright Bigeon Emmanuel (2014) * Created on: Aug 6, 2014 */
* package net.bigeon.gclc.command;
* emmanuel@bigeon.fr
* /*-
* This software is a computer program whose purpose is to * #%L
* provide a generic framework for console applications. * Generic Command Ligne console
* * %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,19 +33,16 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/** acide:fr.bigeon.acide.CommandProvider.java
* Created on: Aug 6, 2014 */
package fr.bigeon.gclc.command;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.i18n.Messages; import net.bigeon.gclc.i18n.Messages;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** A command provider is a map of key word to command to execute. /** A command provider is a map of key word to command to execute.
* *
@@ -67,15 +66,15 @@ public class CommandProvider implements ICommandProvider {
* @param name the command name * @param name the command name
* @throws InvalidCommandName if the name is invalid */ * @throws InvalidCommandName if the name is invalid */
private static void testCommandName(final String name) throws InvalidCommandName { private static void testCommandName(final String name) throws InvalidCommandName {
if (name == null || name.isEmpty() || name.startsWith(MINUS) || if (name == null || name.isEmpty() || name.startsWith(MINUS)
name.contains(SPACE)) { || name.contains(SPACE)) {
throw new InvalidCommandName(); throw new InvalidCommandName();
} }
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommandProvider#add(java.lang.String, * @see net.bigeon.gclc.command.ICommandProvider#add(java.lang.String,
* fr.bigeon.gclc.command.Command) */ * net.bigeon.gclc.command.Command) */
@Override @Override
public final boolean add(final ICommand value) throws InvalidCommandName { public final boolean add(final ICommand value) throws InvalidCommandName {
final String name = value.getCommandName(); final String name = value.getCommandName();
@@ -94,25 +93,22 @@ public class CommandProvider implements ICommandProvider {
/* (non-Javadoc) /* (non-Javadoc)
* @see * @see
* fr.bigeon.gclc.command.ICommandProvider#executeSub(fr.bigeon.gclc.manager * net.bigeon.gclc.command.ICommandProvider#executeSub(net.bigeon.gclc.manager
* .ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String, * .ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String,
* java.lang.String[]) */ * java.lang.String[]) */
@Override @Override
public final void executeSub(final ConsoleOutput out, final ConsoleInput in, public final void executeSub(final ConsoleOutput out, final ConsoleInput in,
final String cmd, final String cmd, final String... args) throws CommandRunException {
final String... args) throws CommandRunException { final ICommand command = get(cmd);
for (final ICommand command : commands) { if (command == null) {
if (command.getCommandName().equals(cmd)) {
command.execute(out, in, args);
return;
}
}
throw new CommandRunException( throw new CommandRunException(
Messages.getString("CommandProvider.unrecognized", cmd), null); //$NON-NLS-1$ Messages.getString("CommandProvider.unrecognized", cmd), null); //$NON-NLS-1$
} }
command.execute(out, in, args);
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */ * @see net.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */
@Override @Override
public final ICommand get(final String commandName) { public final ICommand get(final String commandName) {
for (final ICommand command : commands) { for (final ICommand command : commands) {

View File

@@ -33,18 +33,51 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.command.HelpExecutor.java * gclc:net.bigeon.gclc.command.HelpExecutor.java
* Created on: Sep 6, 2014 * Created on: Sep 6, 2014
*/ */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType; import net.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
import fr.bigeon.gclc.prompt.CLIPrompterMessages; import net.bigeon.gclc.prompt.CLIPrompterMessages;
/** A command to print help of an other command. /** A command to print help of an other command.
* <p> * <p>
@@ -67,7 +100,7 @@ public final class HelpExecutor extends Command {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#brief() */ * @see net.bigeon.gclc.command.Command#brief() */
@Override @Override
protected String brief() { protected String brief() {
if (cmd instanceof SubedCommand) { if (cmd instanceof SubedCommand) {
@@ -77,7 +110,7 @@ public final class HelpExecutor extends Command {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput, * @see net.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput,
* String[]) */ * String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
@@ -86,19 +119,19 @@ public final class HelpExecutor extends Command {
cmd.help(out, args); cmd.help(out, args);
} catch (final IOException e) { } catch (final IOException e) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION, throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"Console manager closed", e, this); //$NON-NLS-1$ "Console manager closed", e); //$NON-NLS-1$
} }
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#tip() */ * @see net.bigeon.gclc.command.Command#tip() */
@Override @Override
public String tip() { public String tip() {
return CLIPrompterMessages.getString("help.cmd.tip"); //$NON-NLS-1$ return CLIPrompterMessages.getString("help.cmd.tip"); //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() * @see net.bigeon.gclc.command.Command#usageDetail()
*/ */
@Override @Override
protected String usageDetail() { protected String usageDetail() {
@@ -106,7 +139,7 @@ public final class HelpExecutor extends Command {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */ * @see net.bigeon.gclc.command.Command#usagePattern() */
@Override @Override
protected String usagePattern() { protected String usagePattern() {
if (cmd instanceof SubedCommand) { if (cmd instanceof SubedCommand) {

View File

@@ -33,16 +33,49 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.command.ICommand.java * gclc:net.bigeon.gclc.command.ICommand.java
* Created on: May 31, 2016 * Created on: May 31, 2016
*/ */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** The contract of commands. /** The contract of commands.
* <p> * <p>

View File

@@ -32,14 +32,48 @@
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** gclc:fr.bigeon.gclc.command.ICommandProvider.java /** gclc:net.bigeon.gclc.command.ICommandProvider.java
* Created on: Sep 6, 2014 */ * Created on: Sep 6, 2014 */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
import fr.bigeon.gclc.exception.CommandRunException; /*-
import fr.bigeon.gclc.exception.InvalidCommandName; * #%L
import fr.bigeon.gclc.manager.ConsoleInput; * Generic Command Ligne console
import fr.bigeon.gclc.manager.ConsoleOutput; * %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/** An ICommadProvider is a provider of commands that can register commands /** An ICommadProvider is a provider of commands that can register commands
* under some keywords. * under some keywords.

View File

@@ -0,0 +1,193 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
* gclc:net.bigeon.gclc.command.ParametrizedCommand.java
* Created on: Dec 24, 2014
*/
package net.bigeon.gclc.command;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import java.util.Set;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidParameterException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/** A command relying on the {@link CommandParameters} to store parameters
* values.
*
* @author Emmanuel BIGEON */
public abstract class ParametrizedCommand extends Command {
private final ParametrizedCommandData data;
/** Create a parametrized command.
* <p>
* Implementation are supposed to call the
* {@link #addBooleanParameter(String)} and
* {@link #addStringParameter(String, boolean)} method to set the
* parameters.
*
* @param name the name */
public ParametrizedCommand(final String name) {
this(name, true);
}
/** Create a parametrized command.
* <p>
* Implementation are supposed to call the
* {@link #addBooleanParameter(String)} and
* {@link #addStringParameter(String, boolean)} method to set the
* parameters.
*
* @param name the name
* @param strict if the arguments are restricted to the declared ones */
public ParametrizedCommand(final String name, final boolean strict) {
super(name);
data = new ParametrizedCommandData(strict);
}
/** Add a boolean parameter to defined parmaters.
*
* @param flag the boolean flag
* @throws InvalidParameterException if the parameter is already defined as
* a string parameter */
protected final void addBooleanParameter(final String flag) throws InvalidParameterException {
data.addBooleanParameter(flag);
}
/** Add a string parameter to defined parmaters.
*
* @param flag the parameter flag
* @param needed if the parameter's absence should cause an exception
* @throws InvalidParameterException if the parameter is already defined as
* a boolean parameter */
protected final void addStringParameter(final String flag,
final boolean needed) throws InvalidParameterException {
data.addStringParameter(flag, needed);
}
/** Actually performs the execution after parsing the parameters.
*
* @param out the output
* @param in the input
* @param parameters the command parameters
* @throws CommandRunException if the command failed */
protected abstract void doExecute(ConsoleOutput out, ConsoleInput in,
CommandParameters parameters) throws CommandRunException;
/* (non-Javadoc)
* @see net.bigeon.gclc.command.Command#execute(java.lang.String[]) */
@Override
public final void execute(final ConsoleOutput output,
final ConsoleInput input,
final String... args) throws CommandRunException {
try {
doExecute(output, input, data.getParameters(input, args));
} catch (final IOException e) {
throw new CommandRunException("Unable to get parameters", e);
}
}
/** Retrieve the boolean parameters (aka flags).
*
* @return the set of boolean parameters */
public final Set<String> getBooleanParameters() {
return data.getBooleanParameters();
}
/** Retrieve the parameter names.
*
* @return the stringParams */
public final Set<String> getParameters() {
return data.getParameters();
}
/** Get the string parameters names.
*
* @return the stringParams */
public final Set<String> getStringParameters() {
return data.getStringParameters();
}
/** Test if a parameter is needed.
*
* @param param the parameter name
* @return if the parameter is needed */
public final boolean isNeeded(final String param) {
return data.isNeeded(param);
}
/** If the command refuse unrecognized parameters.
*
* @return the strict */
public final boolean isStrict() {
return data.isStrict();
}
}

View File

@@ -33,11 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.command.ParametrizedCommand.java * gclc:net.bigeon.gclc.command.ParametrizedCommand.java
* Created on: Dec 24, 2014 * Created on: Dec 24, 2014
*/ */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import java.text.MessageFormat; import java.text.MessageFormat;
import java.util.ArrayList; import java.util.ArrayList;
@@ -47,21 +80,18 @@ import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Map.Entry; import java.util.Map.Entry;
import net.bigeon.gclc.exception.CommandParsingException;
import net.bigeon.gclc.exception.InvalidParameterException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.EmptyInput;
import java.util.Set; import java.util.Set;
import fr.bigeon.gclc.exception.CommandParsingException; /** An object to handle standardized command parameters.
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.exception.InvalidParameterException;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
import fr.bigeon.gclc.manager.EmptyInput;
/** A command relying on the {@link CommandParameters} to store parameters
* values.
* *
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
public abstract class ParametrizedCommand extends Command { public final class ParametrizedCommandData {
/** The boolean parameters mandatory status. */ /** The boolean parameters mandatory status. */
private final Set<String> boolParams = new HashSet<>(); private final Set<String> boolParams = new HashSet<>();
@@ -69,45 +99,31 @@ public abstract class ParametrizedCommand extends Command {
private final Map<String, Boolean> stringParams = new HashMap<>(); private final Map<String, Boolean> stringParams = new HashMap<>();
/** The parameters mandatory status. */ /** The parameters mandatory status. */
private final Map<String, Boolean> params = new HashMap<>(); private final Map<String, Boolean> params = new HashMap<>();
/** The restriction of provided parameters on execution to declared /** The restriction of provided parameters on execution to declared paramters in
* paramters in the status maps. */ * the status maps. */
private final boolean strict; private final boolean strict;
/** Create a parametrized command. /** The data for the parametrized command. */
* <p> public ParametrizedCommandData() {
* Implementation are supposed to call the this(true);
* {@link #addBooleanParameter(String)} and
* {@link #addStringParameter(String, boolean)} method to set the
* parameters.
*
* @param name the name */
public ParametrizedCommand(final String name) {
this(name, true);
} }
/** Create a parametrized command. /** The data for a parametrized command.
* <p>
* Implementation are supposed to call the
* {@link #addBooleanParameter(String)} and
* {@link #addStringParameter(String, boolean)} method to set the
* parameters.
* *
* @param name the name * @param strict if the command was refusing unrecognized parameters */
* @param strict if the arguments are restricted to the declared ones */ public ParametrizedCommandData(final boolean strict) {
public ParametrizedCommand(final String name, final boolean strict) {
super(name);
this.strict = strict; this.strict = strict;
} }
/** Add a boolean parameter to defined parmaters. /** Add a boolean parameter to defined parmaters.
* *
* @param flag the boolean flag * @param flag the boolean flag
* @throws InvalidParameterException if the parameter is already defined as * @throws InvalidParameterException if the parameter is already defined as a
* a string parameter */ * string parameter */
protected final void addBooleanParameter(final String flag) throws InvalidParameterException { public final void addBooleanParameter(final String flag)
throws InvalidParameterException {
if (params.containsKey(flag) && stringParams.containsKey(flag)) { if (params.containsKey(flag) && stringParams.containsKey(flag)) {
throw new InvalidParameterException( throw new InvalidParameterException("Parameter is already defined as string"); //$NON-NLS-1$
"Parameter is already defined as string"); //$NON-NLS-1$
} }
boolParams.add(flag); boolParams.add(flag);
params.put(flag, Boolean.FALSE); params.put(flag, Boolean.FALSE);
@@ -117,10 +133,10 @@ public abstract class ParametrizedCommand extends Command {
* *
* @param flag the parameter flag * @param flag the parameter flag
* @param needed if the parameter's absence should cause an exception * @param needed if the parameter's absence should cause an exception
* @throws InvalidParameterException if the parameter is already defined as * @throws InvalidParameterException if the parameter is already defined as a
* a boolean parameter */ * boolean parameter */
protected final void addStringParameter(final String flag, public final void addStringParameter(final String flag, final boolean needed)
final boolean needed) throws InvalidParameterException { throws InvalidParameterException {
if (params.containsKey(flag)) { if (params.containsKey(flag)) {
checkParam(flag, needed); checkParam(flag, needed);
return; return;
@@ -134,8 +150,8 @@ public abstract class ParametrizedCommand extends Command {
* @param param the string parameter * @param param the string parameter
* @param needed if the parameter is needed * @param needed if the parameter is needed
* @throws InvalidParameterException if the new definition is invalid */ * @throws InvalidParameterException if the new definition is invalid */
private void checkParam(final String param, private void checkParam(final String param, final boolean needed)
final boolean needed) throws InvalidParameterException { throws InvalidParameterException {
if (stringParams.containsKey(param)) { if (stringParams.containsKey(param)) {
final Boolean need = Boolean final Boolean need = Boolean
.valueOf(needed || stringParams.get(param).booleanValue()); .valueOf(needed || stringParams.get(param).booleanValue());
@@ -143,49 +159,37 @@ public abstract class ParametrizedCommand extends Command {
params.put(param, need); params.put(param, need);
return; return;
} }
throw new InvalidParameterException( throw new InvalidParameterException("Parameter is already defined as boolean"); //$NON-NLS-1$
"Parameter is already defined as boolean"); //$NON-NLS-1$
} }
/** Actually performs the execution after parsing the parameters. /** Get the parameters from an input.
* *
* @param out the output * @param input the input
* @param in the input * @param args the command arguments
* @param parameters the command parameters * @return the command object
* @throws CommandRunException if the command failed */ * @throws IOException if the command could not be filled. */
protected abstract void doExecute(ConsoleOutput out, ConsoleInput in, public final CommandParameters getParameters(final ConsoleInput input,
CommandParameters parameters) throws CommandRunException; final String... args) throws IOException {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#execute(java.lang.String[]) */
@Override
public final void execute(final ConsoleOutput output,
final ConsoleInput input,
final String... args) throws CommandRunException {
final CommandParameters parameters = new CommandParameters(boolParams, final CommandParameters parameters = new CommandParameters(boolParams,
stringParams.keySet(), strict); stringParams.keySet(), strict);
try { try {
parameters.parseArgs(args); parameters.parseArgs(args);
} catch (final CommandParsingException e) { } catch (final CommandParsingException e) {
throw new CommandRunException(CommandRunExceptionType.USAGE, throw new IOException(e);
"Unable to read arguments", e, this); //$NON-NLS-1$
} }
final List<String> toProvide = new ArrayList<>(); final List<String> toProvide = new ArrayList<>();
for (final Entry<String, Boolean> string : params.entrySet()) { for (final Entry<String, Boolean> string : params.entrySet()) {
if (string.getValue().booleanValue() && if (string.getValue().booleanValue()
parameters.get(string.getKey()) == null) { && parameters.get(string.getKey()) == null) {
if (input == null || input == EmptyInput.INSTANCE) { if (input == null || input == EmptyInput.INSTANCE) {
throw new CommandRunException( throw new IOException();
CommandRunExceptionType.INTERACTION,
"Missing required parameter " + string.getKey(), //$NON-NLS-1$
this);
} }
toProvide.add(string.getKey()); toProvide.add(string.getKey());
} }
} }
// for each needed parameters that is missing, prompt the user. // for each needed parameters that is missing, prompt the user.
fillParameters(input, toProvide, parameters); fillParameters(input, toProvide, parameters);
doExecute(output, input, parameters); return parameters;
} }
/** Fill the undefined parameters. /** Fill the undefined parameters.
@@ -195,25 +199,18 @@ public abstract class ParametrizedCommand extends Command {
* @param input the input to prompt through * @param input the input to prompt through
* @param parameters the parameter list to complete * @param parameters the parameter list to complete
* @param toProvide the parameters to ask for * @param toProvide the parameters to ask for
* @throws CommandRunException if the manager was closed */ * @throws IOException if the manager was closed */
private final void fillParameters(final ConsoleInput input, private final static void fillParameters(final ConsoleInput input,
final List<String> toProvide, final List<String> toProvide, final CommandParameters parameters)
final CommandParameters parameters) throws CommandRunException { throws IOException {
for (final String string : toProvide) { for (final String string : toProvide) {
String value; String value;
try { value = input.prompt(MessageFormat.format("value of {0}? ", string)); //$NON-NLS-1$
value = input
.prompt(MessageFormat.format("value of {0}? ", string)); //$NON-NLS-1$
while (value.isEmpty()) { while (value.isEmpty()) {
value = input.prompt(MessageFormat.format( value = input
"value of {0}? (cannot be empty) ", //$NON-NLS-1$ .prompt(MessageFormat.format("value of {0}? (cannot be empty) ", //$NON-NLS-1$
string)); string));
} }
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"Interactive command but manager closed...", e, this); //$NON-NLS-1$
}
parameters.set(string, value); parameters.set(string, value);
} }
} }

View File

@@ -32,17 +32,50 @@
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** gclc:fr.bigeon.gclc.command.SubedCommand.java /** gclc:net.bigeon.gclc.command.SubedCommand.java
* Created on: Sep 6, 2014 */ * Created on: Sep 6, 2014 */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import java.util.Arrays; import java.util.Arrays;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType; import net.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** /**
* <p> * <p>
@@ -119,7 +152,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
if (noArgCommand != null) { if (noArgCommand != null) {
noArgCommand.execute(output, input, args); noArgCommand.execute(output, input, args);
} else { } else {
throw new CommandRunException("Unrecognized command", this); //$NON-NLS-1$ throw new CommandRunException("Unrecognized command"); //$NON-NLS-1$
} }
} else { } else {
@@ -127,24 +160,21 @@ public final class SubedCommand extends CommandProvider implements ICommand {
executeSub(output, input, args[0], executeSub(output, input, args[0],
Arrays.copyOfRange(args, 1, args.length)); Arrays.copyOfRange(args, 1, args.length));
} catch (final CommandRunException e) { } catch (final CommandRunException e) {
if (e.getSource() != null) {
throw e;
}
throw new CommandRunException(CommandRunExceptionType.USAGE, throw new CommandRunException(CommandRunExceptionType.USAGE,
e.getLocalizedMessage(), e, this); e.getLocalizedMessage(), e);
} }
} }
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ * @see net.bigeon.gclc.command.ICommand#getCommandName() */
@Override @Override
public String getCommandName() { public String getCommandName() {
return name; return name;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#help() */ * @see net.bigeon.gclc.command.Command#help() */
@Override @Override
public void help(final ConsoleOutput manager, public void help(final ConsoleOutput manager,
final String... args) throws IOException { final String... args) throws IOException {
@@ -153,6 +183,8 @@ public final class SubedCommand extends CommandProvider implements ICommand {
final ICommand c = get(args[0]); final ICommand c = get(args[0]);
if (c != null) { if (c != null) {
c.help(manager, Arrays.copyOfRange(args, 1, args.length)); c.help(manager, Arrays.copyOfRange(args, 1, args.length));
} else {
manager.println("No command "+Arrays.toString(args));
} }
} else { } else {
// Generic // Generic
@@ -171,7 +203,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#tip() */ * @see net.bigeon.gclc.command.Command#tip() */
@Override @Override
public String tip() { public String tip() {
return tip; return tip;

View File

@@ -33,17 +33,51 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.ExitCommand.java * gclc:net.bigeon.gclc.ExitCommand.java
* Created on: Jun 8, 2016 * Created on: Jun 8, 2016
*/ */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command.base;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import fr.bigeon.gclc.ConsoleApplication; import net.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.prompt.CLIPrompterMessages; import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.prompt.CLIPrompterMessages;
/** A command to exit a {@link ConsoleApplication}. /** A command to exit a {@link ConsoleApplication}.
* *
@@ -82,7 +116,7 @@ public class ExitCommand implements ICommand {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ * @see net.bigeon.gclc.command.ICommand#getCommandName() */
@Override @Override
public final String getCommandName() { public final String getCommandName() {
return name; return name;

View File

@@ -0,0 +1,128 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
* gclc:net.bigeon.gclc.command.MockCommand.java
* Created on: Nov 18, 2016
*/
package net.bigeon.gclc.command.base;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/** This implement a command that does nothing.
* <p>
* This class is intended for testing purpose only.
*
* @author Emmanuel Bigeon */
public final class MockCommand implements ICommand {
/** The command name. */
private final String name;
/** Create the command.
*
* @param name the command name */
public MockCommand(final String name) {
this.name = name;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput,
* String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) {
//
}
/* (non-Javadoc)
* @see net.bigeon.gclc.command.ICommand#getCommandName() */
@Override
public String getCommandName() {
return name;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.command.ICommand#help(net.bigeon.gclc.manager.
* ConsoleManager, java.lang.String[]) */
@Override
public void help(final ConsoleOutput manager,
final String... args) {
//
}
/* (non-Javadoc)
* @see net.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return null;
}
}

View File

@@ -33,11 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.command.ScriptExecution.java * gclc:net.bigeon.gclc.command.ScriptExecution.java
* Created on: Jun 12, 2016 * Created on: Jun 12, 2016
*/ */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command.base;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.FileInputStream; import java.io.FileInputStream;
import java.io.IOException; import java.io.IOException;
@@ -47,13 +80,14 @@ import java.text.MessageFormat;
import java.util.Arrays; import java.util.Arrays;
import java.util.List; import java.util.List;
import fr.bigeon.gclc.ConsoleApplication; import net.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.GCLCConstants; import net.bigeon.gclc.GCLCConstants;
import fr.bigeon.gclc.exception.CommandParsingException; import net.bigeon.gclc.command.Command;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandParsingException;
import fr.bigeon.gclc.exception.CommandRunExceptionType; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/** A command that will launch a series of command from a file. /** A command that will launch a series of command from a file.
* <p> * <p>
@@ -93,17 +127,17 @@ public final class ScriptExecution extends Command {
* @param args the arguments * @param args the arguments
* @throws CommandRunException if the arguments were not the ones * @throws CommandRunException if the arguments were not the ones
* expected */ * expected */
private void checkArgs(final String[] args) throws CommandRunException { private static void checkArgs(final String[] args) throws CommandRunException {
if (args.length == 0) { if (args.length == 0) {
throw new CommandRunException(CommandRunExceptionType.USAGE, throw new CommandRunException(CommandRunExceptionType.USAGE,
"Expecting a file", this); //$NON-NLS-1$ "Expecting a file"); //$NON-NLS-1$
} }
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */ * @see net.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
@@ -129,10 +163,10 @@ public final class ScriptExecution extends Command {
} catch (final CommandParsingException e) { } catch (final CommandParsingException e) {
throw new CommandRunException(MessageFormat.format( throw new CommandRunException(MessageFormat.format(
"Invalid command in script ({0})", e.getLocalizedMessage()), //$NON-NLS-1$ "Invalid command in script ({0})", e.getLocalizedMessage()), //$NON-NLS-1$
e, this); e);
} catch (final IOException e) { } catch (final IOException e) {
throw new CommandRunException("Unable to read script", //$NON-NLS-1$ throw new CommandRunException("Unable to read script", //$NON-NLS-1$
e, this); e);
} catch (final CommandRunException e) { } catch (final CommandRunException e) {
throw manageRunException(e, lineNo); throw manageRunException(e, lineNo);
} }
@@ -144,17 +178,13 @@ public final class ScriptExecution extends Command {
* @param e the exception * @param e the exception
* @param lineNo the line nu;ber * @param lineNo the line nu;ber
* @return the exception to actually throw */ * @return the exception to actually throw */
private CommandRunException manageRunException(final CommandRunException e, private static CommandRunException manageRunException(final CommandRunException e,
final int lineNo) { final int lineNo) {
if (e.getSource() == this) {
// ensure closing?
return e;
}
return new CommandRunException(CommandRunExceptionType.EXECUTION, return new CommandRunException(CommandRunExceptionType.EXECUTION,
MessageFormat.format( MessageFormat.format(
"The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$ "The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$
Integer.valueOf(lineNo), e.getLocalizedMessage()), Integer.valueOf(lineNo), e.getLocalizedMessage()),
e, this); e);
} }
/** Read a line of the script. /** Read a line of the script.
@@ -167,8 +197,7 @@ public final class ScriptExecution extends Command {
final Object[] params) throws CommandRunException { final Object[] params) throws CommandRunException {
if (cmd.startsWith(SPACE) || cmd.startsWith(TAB)) { if (cmd.startsWith(SPACE) || cmd.startsWith(TAB)) {
throw new CommandRunException( throw new CommandRunException(
"Invalid line in script (line starts with space character)", //$NON-NLS-1$ "Invalid line in script (line starts with space character)");
this);
} }
if (cmd.isEmpty() || cmd.startsWith(commentPrefix)) { if (cmd.isEmpty() || cmd.startsWith(commentPrefix)) {
// Comment line // Comment line
@@ -178,14 +207,14 @@ public final class ScriptExecution extends Command {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */ * @see net.bigeon.gclc.command.ICommand#tip() */
@Override @Override
public String tip() { public String tip() {
return "Execute a script"; //$NON-NLS-1$ return "Execute a script"; //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */ * @see net.bigeon.gclc.command.Command#usageDetail() */
@Override @Override
protected String usageDetail() { protected String usageDetail() {
final StringBuilder builder = new StringBuilder(); final StringBuilder builder = new StringBuilder();
@@ -208,7 +237,7 @@ public final class ScriptExecution extends Command {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */ * @see net.bigeon.gclc.command.Command#usagePattern() */
@Override @Override
protected String usagePattern() { protected String usagePattern() {
return super.usagePattern() + " <scriptfile>"; //$NON-NLS-1$ return super.usagePattern() + " <scriptfile>"; //$NON-NLS-1$

View File

@@ -0,0 +1,39 @@
/**
* @author Emmanuel Bigeon
*
*/
package net.bigeon.gclc.command.base;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/

View File

@@ -1,14 +1,25 @@
/* /** This package groups elements related to
* Copyright Bigeon Emmanuel (2014) * {@link net.bigeon.gclc.command.ICommand}
* * <p>
* emmanuel@bigeon.fr * There are some implementations, such as the
* * {@link net.bigeon.gclc.command.ParametrizedCommand} for commands with a
* This software is a computer program whose purpose is to * predefined set of flags and option taking a string as value, the
* provide a generic framework for console applications. * {@link net.bigeon.gclc.command.SubedCommand} for a command that is declined in
* a set of sub commands, the {@link net.bigeon.gclc.command.HelpExecutor} for
* help display of other commands and the
* *
* @author Emmanuel BIGEON */
package net.bigeon.gclc.command;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,19 +42,5 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/** gclc:fr.bigeon.gclc.command.package-info.java
* Created on: Sep 6, 2014 */
/** This package groups elements related to
* {@link fr.bigeon.gclc.command.ICommand}
* <p>
* There are some implementations, such as the
* {@link fr.bigeon.gclc.command.ParametrizedCommand} for commands with a
* predefined set of flags and option taking a string as value, the
* {@link fr.bigeon.gclc.command.SubedCommand} for a command that is declined in
* a set of sub commands, the {@link fr.bigeon.gclc.command.HelpExecutor} for
* help display of other commands and the
*
* @author Emmanuel BIGEON */
package fr.bigeon.gclc.command;

View File

@@ -33,11 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.exception.CommandParsingException.java * gclc:net.bigeon.gclc.exception.CommandParsingException.java
* Created on: Jun 1, 2016 * Created on: Jun 1, 2016
*/ */
package fr.bigeon.gclc.exception; package net.bigeon.gclc.exception;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** An exception raised during command parsing. /** An exception raised during command parsing.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */

View File

@@ -33,12 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.exception.CommandRunException.java * gclc:net.bigeon.gclc.exception.CommandRunException.java
* Created on: Feb 10, 2015 * Created on: Feb 10, 2015
*/ */
package fr.bigeon.gclc.exception; package net.bigeon.gclc.exception;
import fr.bigeon.gclc.command.ICommand; /*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** An exception thrown when a command failed to run correctly. /** An exception thrown when a command failed to run correctly.
* *
@@ -50,57 +82,44 @@ public final class CommandRunException extends Exception {
/** The type of run exception. */ /** The type of run exception. */
private final CommandRunExceptionType type; private final CommandRunExceptionType type;
/** The command that caused the error. */
private transient ICommand source;
/** Create the exception. /** Create the exception.
* *
* @param type the type of exception * @param type the type of exception
* @param message the message * @param message the message */
* @param source the source */
public CommandRunException(final CommandRunExceptionType type, public CommandRunException(final CommandRunExceptionType type,
final String message, final ICommand source) { final String message) {
super(message); super(message);
this.type = type; this.type = type;
this.source = source;
} }
/** Create the exception with a cause. /** Create the exception with a cause.
* *
* @param type the type of exception * @param type the type of exception
* @param message a message * @param message a message
* @param cause the cause * @param cause the cause */
* @param source the source */
public CommandRunException(final CommandRunExceptionType type, public CommandRunException(final CommandRunExceptionType type,
final String message, final Throwable cause, final String message, final Throwable cause) {
final ICommand source) {
super(message, cause); super(message, cause);
this.type = type; this.type = type;
this.source = source;
} }
/** Create the exception with type /** Create the exception with type {@link CommandRunExceptionType#EXECUTION}.
* {@link CommandRunExceptionType#EXECUTION}.
* *
* @param message a message * @param message a message */
* @param source the source */ public CommandRunException(final String message) {
public CommandRunException(final String message, final ICommand source) {
super(message); super(message);
type = CommandRunExceptionType.EXECUTION; type = CommandRunExceptionType.EXECUTION;
this.source = source;
} }
/** Create the exception with type {@link CommandRunExceptionType#EXECUTION} /** Create the exception with type {@link CommandRunExceptionType#EXECUTION} and
* and a cause. * a cause.
* *
* @param message a message * @param message a message
* @param cause the cause * @param cause the cause */
* @param source the source */ public CommandRunException(final String message, final Throwable cause) {
public CommandRunException(final String message, final Throwable cause,
final ICommand source) {
super(message, cause); super(message, cause);
type = CommandRunExceptionType.EXECUTION; type = CommandRunExceptionType.EXECUTION;
this.source = source;
} }
/* (non-Javadoc) /* (non-Javadoc)
@@ -114,13 +133,6 @@ public final class CommandRunException extends Exception {
return super.getLocalizedMessage(); return super.getLocalizedMessage();
} }
/** Get the exception raising command.
*
* @return the source */
public ICommand getSource() {
return source;
}
/** Get the exception type. /** Get the exception type.
* *
* @return the type */ * @return the type */

View File

@@ -33,11 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.exception.CommandRunExceptionType.java * gclc:net.bigeon.gclc.exception.CommandRunExceptionType.java
* Created on: Jun 12, 2016 * Created on: Jun 12, 2016
*/ */
package fr.bigeon.gclc.exception; package net.bigeon.gclc.exception;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** The command run exception possible types. /** The command run exception possible types.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */

View File

@@ -33,11 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.exception.InvalidCommandName.java * gclc:net.bigeon.gclc.exception.InvalidCommandName.java
* Created on: Dec 23, 2014 * Created on: Dec 23, 2014
*/ */
package fr.bigeon.gclc.exception; package net.bigeon.gclc.exception;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** Exception sent from the application when a command is added but the name of /** Exception sent from the application when a command is added but the name of
* the command is already used. * the command is already used.
* *

View File

@@ -33,16 +33,46 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.exception.InvalidParameterException.java * gclc:net.bigeon.gclc.exception.InvalidParameterException.java
* Created on: Nov 19, 2016 * Created on: Nov 19, 2016
*/ */
package fr.bigeon.gclc.exception; package net.bigeon.gclc.exception;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** This exception is thrown during command definitions to indicate a wrong /** This exception is thrown during command definitions to indicate a wrong
* parameter definition. * parameter definition.
* <p>
* This class is particularly used by
* {@link fr.bigeon.gclc.command.ParametrizedCommand parameterized commands}.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public class InvalidParameterException extends Exception { public class InvalidParameterException extends Exception {

View File

@@ -1,14 +1,17 @@
/* /** Exceptions package.
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
* *
* @author Emmanuel Bigeon */
package net.bigeon.gclc.exception;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,12 +34,5 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/**
* gclc:fr.bigeon.gclc.exception.package-info.java
* Created on: Nov 13, 2017
*/
/** Exceptions package.
*
* @author Emmanuel Bigeon */
package fr.bigeon.gclc.exception;

View File

@@ -33,11 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.i18n.Messages.java * gclc:net.bigeon.gclc.i18n.Messages.java
* Created on: Jun 1, 2016 * Created on: Jun 1, 2016
*/ */
package fr.bigeon.gclc.i18n; package net.bigeon.gclc.i18n;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.text.MessageFormat; import java.text.MessageFormat;
import java.util.MissingResourceException; import java.util.MissingResourceException;
import java.util.ResourceBundle; import java.util.ResourceBundle;
@@ -49,7 +82,7 @@ import java.util.logging.Logger;
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class Messages { public final class Messages {
/** The resource bundle name. */ /** The resource bundle name. */
private static final String BUNDLE_NAME = "fr.bigeon.gclc.l10n.messages"; //$NON-NLS-1$ private static final String BUNDLE_NAME = "net.bigeon.gclc.l10n.messages"; //$NON-NLS-1$
/** The resource bundle. */ /** The resource bundle. */
private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle

View File

@@ -1,14 +1,17 @@
/* /** Internationalization package.
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
* *
* @author Emmanuel Bigeon */
package net.bigeon.gclc.i18n;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,12 +34,5 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/**
* gclc:fr.bigeon.gclc.i18n.package-info.java
* Created on: Nov 13, 2017
*/
/** Internationalization package.
*
* @author Emmanuel Bigeon */
package fr.bigeon.gclc.i18n;

View File

@@ -33,14 +33,49 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.manager.ConsoleInput.java * gclc:net.bigeon.gclc.manager.ConsoleInput.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.manager;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import java.io.InterruptedIOException; import java.io.InterruptedIOException;
import net.bigeon.gclc.tools.StringProvider;
/** A console application input. /** A console application input.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
@@ -55,21 +90,19 @@ public interface ConsoleInput extends AutoCloseable {
/** Get the prompt string. /** Get the prompt string.
* *
* @return the prompt prefix */ * @return the prompt prefix */
String getPrompt(); StringProvider getPrompt();
/** Indicate to the input that is should interrompt the prompting, if /** Indicate to the input that is should interrompt the prompting, if possible.
* possible.
* <p> * <p>
* The pending {@link #prompt()} or {@link #prompt(String)} operations * The pending {@link #prompt()} or {@link #prompt(String)} operations should
* should return immediatly. However the returned value can be anything * return immediatly. However the returned value can be anything (from the
* (from the partial prompt content to an empty string or even a null * partial prompt content to an empty string or even a null pointer). */
* pointer). */
void interruptPrompt(); void interruptPrompt();
/** Test if the input is closed. /** Test if the input is closed.
* <p> * <p>
* If this is true, {@link #prompt()} methods will return immediatly and a * If this is true, {@link #prompt()} methods will return immediatly and a null
* null chain. * chain.
* *
* @return if the manager is closed. */ * @return if the manager is closed. */
boolean isClosed(); boolean isClosed();
@@ -97,8 +130,8 @@ public interface ConsoleInput extends AutoCloseable {
* @throws InterruptedIOException if the prompt was interrupted */ * @throws InterruptedIOException if the prompt was interrupted */
String prompt(String message) throws IOException; String prompt(String message) throws IOException;
/** Prompt the user, with a hint on what is prompted and an allotated time /** Prompt the user, with a hint on what is prompted and an allotated time to
* to answer. * answer.
* *
* @param timeout the time to wait in milliseconds * @param timeout the time to wait in milliseconds
* @param message the message to prompt the user * @param message the message to prompt the user
@@ -111,4 +144,9 @@ public interface ConsoleInput extends AutoCloseable {
* *
* @param prompt the prompt */ * @param prompt the prompt */
void setPrompt(String prompt); void setPrompt(String prompt);
/** Set the prompting string.
*
* @param string the prompt string */
void setPrompt(StringProvider string);
} }

View File

@@ -33,11 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.manager.ConsoleOutput.java * gclc:net.bigeon.gclc.manager.ConsoleOutput.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.manager;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
/** A console output definition. /** A console output definition.

View File

@@ -33,10 +33,47 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.manager.EmptyInput.java * gclc:net.bigeon.gclc.manager.EmptyInput.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.manager;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.tools.StringProvider;
/** A console input that return empty to all prompting. /** A console input that return empty to all prompting.
* *
@@ -50,56 +87,56 @@ public final class EmptyInput implements ConsoleInput {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#close() */ * @see net.bigeon.gclc.manager.ConsoleInput#close() */
@Override @Override
public void close() { public void close() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override @Override
public String getPrompt() { public StringProvider getPrompt() {
return ""; //$NON-NLS-1$ return new ConstantString(""); //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
@Override @Override
public void interruptPrompt() { public void interruptPrompt() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleInput#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return false; return false;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override @Override
public String prompt() { public String prompt() {
return ""; //$NON-NLS-1$ return ""; //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */ * @see net.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override @Override
public String prompt(final long timeout) { public String prompt(final long timeout) {
return ""; //$NON-NLS-1$ return ""; //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
@Override @Override
public String prompt(final String message) { public String prompt(final String message) {
return ""; //$NON-NLS-1$ return ""; //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, * @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
* long) */ * long) */
@Override @Override
public String prompt(final String message, public String prompt(final String message,
@@ -108,10 +145,14 @@ public final class EmptyInput implements ConsoleInput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override @Override
public void setPrompt(final String prompt) { public void setPrompt(final String prompt) {
// //
} }
@Override
public void setPrompt(StringProvider string) {
//
}
} }

View File

@@ -1,14 +1,17 @@
/* /** The console input and output definitions.
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
* *
* @author Emmanuel Bigeon */
package net.bigeon.gclc.manager;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,12 +34,5 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/**
* gclc:fr.bigeon.gclc.manager.package-info.java
* Created on: Nov 13, 2017
*/
/** The console input and output definitions.
*
* @author Emmanuel Bigeon */
package fr.bigeon.gclc.manager;

View File

@@ -1,14 +1,17 @@
/* /** A framework for commad line applications.
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
* *
* @author Emmanuel Bigeon */
package net.bigeon.gclc;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,12 +34,5 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/**
* gclc:fr.bigeon.gclc.package-info.java
* Created on: Nov 5, 2017
*/
/** A framework for commad line applications.
*
* @author Emmanuel Bigeon */
package fr.bigeon.gclc;

View File

@@ -34,8 +34,41 @@
*/ */
/** acide:fr.bigeon.acide.tool.CLIPrompter.java /** acide:fr.bigeon.acide.tool.CLIPrompter.java
* Created on: Jul 31, 2014 */ * Created on: Jul 31, 2014 */
package fr.bigeon.gclc.prompt; package net.bigeon.gclc.prompt;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
@@ -43,8 +76,8 @@ import java.util.Map;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** The {@link CLIPrompter} class is a utility class that provides method to /** The {@link CLIPrompter} class is a utility class that provides method to
* prompt the user. * prompt the user.

View File

@@ -36,8 +36,41 @@
* acide:fr.bigeon.acide.tool.CLIPrompterMessages.java * acide:fr.bigeon.acide.tool.CLIPrompterMessages.java
* Created on: Aug 6, 2014 * Created on: Aug 6, 2014
*/ */
package fr.bigeon.gclc.prompt; package net.bigeon.gclc.prompt;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.text.MessageFormat; import java.text.MessageFormat;
import java.util.MissingResourceException; import java.util.MissingResourceException;
import java.util.ResourceBundle; import java.util.ResourceBundle;
@@ -49,7 +82,7 @@ import java.util.logging.Logger;
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
public final class CLIPrompterMessages { public final class CLIPrompterMessages {
/** The resource name. */ /** The resource name. */
private static final String BUNDLE_NAME = "fr.bigeon.gclc.messages"; //$NON-NLS-1$ private static final String BUNDLE_NAME = "net.bigeon.gclc.messages"; //$NON-NLS-1$
/** The resource. */ /** The resource. */
private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
.getBundle(BUNDLE_NAME); .getBundle(BUNDLE_NAME);

View File

@@ -1,14 +1,24 @@
/* /** Client prompting related objects.
* Copyright Bigeon Emmanuel (2014) * <p>
* * This package is used for the formatting of prompts for the user. The
* emmanuel@bigeon.fr * {@link net.bigeon.gclc.prompt.CLIPrompter} class provides utility methods to
* * retrieve certain basic type of data from the user or to give list choices.
* This software is a computer program whose purpose is to * <p>
* provide a generic framework for console applications. * The {@link net.bigeon.gclc.prompt.CLIPrompterMessages} class is used for
* internationalization of the prompting methods.
* *
* @author Emmanuel BIGEON */
package net.bigeon.gclc.prompt;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
@@ -31,17 +41,5 @@
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L%
*/ */
/** gclc:fr.bigeon.gclc.prompt.package-info.java
* Created on: Sep 6, 2014 */
/** Client prompting related objects.
* <p>
* This package is used for the formatting of prompts for the user. The
* {@link fr.bigeon.gclc.prompt.CLIPrompter} class provides utility methods to
* retrieve certain basic type of data from the user or to give list choices.
* <p>
* The {@link fr.bigeon.gclc.prompt.CLIPrompterMessages} class is used for
* internationalization of the prompting methods.
*
* @author Emmanuel BIGEON */
package fr.bigeon.gclc.prompt;

View File

@@ -0,0 +1,90 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
package net.bigeon.gclc.tools;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** A {@link StringProvider} that hold a constant string.
*
* @author Emmanuel Bigeon */
public class ConstantString implements StringProvider {
private final String string;
/* (non-Javadoc)
* @see net.bigeon.gclc.tools.StringProvider#apply() */
@Override
public String apply() {
return string;
}
/** Create a provider for a string.
*
* @param string the string */
public ConstantString(String string) {
this.string = string;
}
}

View File

@@ -36,8 +36,41 @@
* acide:fr.bigeon.acide.tools.PrintUtils.java * acide:fr.bigeon.acide.tools.PrintUtils.java
* Created on: Jan 20, 2015 * Created on: Jan 20, 2015
*/ */
package fr.bigeon.gclc.tools; package net.bigeon.gclc.tools;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;

View File

@@ -0,0 +1,83 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
package net.bigeon.gclc.tools;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** A string providing object.
* <p>
* Implementations of this interface will provide a string, this internal state
* of the object may be so that successive calls to the apply method return
* different results.
*
* @author Emmanuel */
public interface StringProvider {
/** Provide a string.
*
* @return the string */
String apply();
}

View File

@@ -0,0 +1,38 @@
/** Tool classes.
*
* @author Emmanuel Bigeon */
package net.bigeon.gclc.tools;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/

View File

@@ -33,17 +33,48 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.tools.AOutputForwardRunnable.java * gclc:net.bigeon.gclc.tools.AOutputForwardRunnable.java
* Created on: Dec 1, 2016 * Created on: Dec 1, 2016
*/ */
package fr.bigeon.gclc.tools; package net.bigeon.gclc.utils;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
import fr.bigeon.gclc.manager.PipedConsoleOutput;
/** An incomplete implematation used to forward messages from a piped console. /** An incomplete implematation used to forward messages from a piped console.
* <p> * <p>
* This forwarding can be interrupted without closing the piped manager. * This forwarding can be interrupted without closing the piped manager.

View File

@@ -33,19 +33,53 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc-test:fr.bigeon.gclc.test.TestConsoleManager.java * gclc-test:net.bigeon.gclc.test.TestConsoleManager.java
* Created on: Nov 18, 2016 * Created on: Nov 18, 2016
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.utils;
import java.io.BufferedReader; /*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PipedInputStream; import java.io.PipedInputStream;
import java.io.PipedOutputStream; import java.io.PipedOutputStream;
import java.io.PrintStream; import java.io.PrintStream;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.tools.StringProvider;
/** This console input allows to enter commands and retrieve the output as an /** This console input allows to enter commands and retrieve the output as an
* input. * input.
* <p> * <p>
@@ -56,103 +90,59 @@ import java.nio.charset.StandardCharsets;
public final class PipedConsoleInput public final class PipedConsoleInput
implements ConsoleInput { implements ConsoleInput {
/** The encoding between streams. */
private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$
/** THe inner manager. */ /** THe inner manager. */
private final StreamConsoleInput innerManager; private final StreamConsoleInput innerManager;
/** The stream to pipe commands into. */ /** The stream to pipe commands into. */
private final PipedOutputStream commandInput; private final PipedOutputStream commandInput;
/** The reader to get application return from. */
private final BufferedReader commandBuffOutput;
/** The stream to get application return from. */
private final PipedInputStream commandOutput;
/** The print writer for application to write return to. */
private final PrintStream outPrint;
/** The stream for the application to read commands from. */ /** The stream for the application to read commands from. */
private final PipedInputStream in; private final PipedInputStream in;
/** The writing thread. */ /** The writing thread. */
private final WritingRunnable writing; private final WritingRunnable writing;
/** The reading thread. */
private final ReadingRunnable reading;
/** Create a manager that will write and read through piped stream. /** Create a manager that will write and read through piped stream.
* *
* @param outPrint the stream to write the prompting messages to
* @throws IOException if the piping failed for streams */ * @throws IOException if the piping failed for streams */
public PipedConsoleInput() throws IOException { public PipedConsoleInput(final PrintStream outPrint) throws IOException {
commandInput = new PipedOutputStream(); commandInput = new PipedOutputStream();
in = new PipedInputStream(commandInput); in = new PipedInputStream(commandInput);
commandOutput = new PipedInputStream();
final PipedOutputStream out = new PipedOutputStream(commandOutput);
commandBuffOutput = new BufferedReader(
new InputStreamReader(commandOutput, StandardCharsets.UTF_8));
outPrint = new PrintStream(out, true, UTF_8);
innerManager = new StreamConsoleInput(outPrint, in, innerManager = new StreamConsoleInput(outPrint, in,
StandardCharsets.UTF_8); StandardCharsets.UTF_8);
writing = new WritingRunnable(commandInput, StandardCharsets.UTF_8); writing = new WritingRunnable(commandInput, StandardCharsets.UTF_8);
reading = new ReadingRunnable(commandBuffOutput); final Thread th = new Thread(writing,
Thread th = new Thread(writing, "write"); //$NON-NLS-1$ "GCLC console piped input stream"); //$NON-NLS-1$
th.start(); th.start();
th = new Thread(reading, "read"); //$NON-NLS-1$
th.setDaemon(true);
th.start();
}
/** Test if a content is available on the reading head.
* <p>
* If this method returns true, the next {@link #prompt()} operation should
* return immediatly.
*
* @return the content of the next line written by the application
* @throws IOException if the reading failed */
public boolean available() throws IOException {
return reading.hasMessage();
} }
@Override @Override
public void close() throws IOException { public void close() throws IOException {
reading.setRunning(false);
writing.setRunning(false); writing.setRunning(false);
in.close(); in.close();
innerManager.close(); innerManager.close();
outPrint.close();
commandBuffOutput.close();
commandOutput.close();
commandInput.close(); commandInput.close();
} }
@Override @Override
public String getPrompt() { public StringProvider getPrompt() {
return innerManager.getPrompt(); return innerManager.getPrompt();
} }
/** Wait for a specific message to arrive.
* <p>
* When this method returns, the message was appended to the data, it
* <em>may or may not</em> be the next line of data.
*
* @param message the message
* @return the thread to join to wait for message delivery
* @see fr.bigeon.gclc.manager.ReadingRunnable#getWaitForDelivery(java.lang.String) */
public Thread getWaitForDelivery(final String message) {
return reading.getWaitForDelivery(message);
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */ * @see net.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
@Override @Override
public void interruptPrompt() { public void interruptPrompt() {
innerManager.interruptPrompt(); innerManager.interruptPrompt();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleInput#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return innerManager.isClosed(); return innerManager.isClosed();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override @Override
public String prompt() throws IOException { public String prompt() throws IOException {
return innerManager return innerManager
@@ -160,44 +150,39 @@ public final class PipedConsoleInput
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */ * @see net.bigeon.gclc.manager.ConsoleManager#prompt(long) */
@Override @Override
public String prompt(final long timeout) throws IOException { public String prompt(final long timeout) throws IOException {
return innerManager.prompt(timeout); return innerManager.prompt(timeout);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
@Override @Override
public String prompt(final String message) throws IOException { public String prompt(final String message) throws IOException {
return innerManager.prompt(message + System.lineSeparator()); return innerManager.prompt(message + System.lineSeparator());
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, * @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
* long) */ * long) */
@Override @Override
public String prompt(final String message, final long timeout) throws IOException { public String prompt(final String message, final long timeout) throws IOException {
return innerManager.prompt(message + System.lineSeparator(), timeout); return innerManager.prompt(message + System.lineSeparator(), timeout);
} }
/** Read the next line in the input printed content.
* <p>
* This corresponds to the {@link #prompt(String)} messages.
*
* @return the content of the next line written by the application
* @throws IOException if the reading failed */
public String readNextLine() throws IOException {
return reading.getMessage();
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override @Override
public void setPrompt(final String prompt) { public void setPrompt(final String prompt) {
innerManager.setPrompt(prompt); innerManager.setPrompt(prompt);
} }
@Override
public void setPrompt(StringProvider string) {
innerManager.setPrompt(string);
}
/** Type a message in the input. /** Type a message in the input.
* *
* @param content the content to type to the application * @param content the content to type to the application

View File

@@ -33,11 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc-test:fr.bigeon.gclc.test.TestConsoleManager.java * gclc-test:net.bigeon.gclc.test.TestConsoleManager.java
* Created on: Nov 18, 2016 * Created on: Nov 18, 2016
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.utils;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
import java.io.InputStreamReader; import java.io.InputStreamReader;
@@ -46,6 +79,8 @@ import java.io.PipedOutputStream;
import java.io.PrintStream; import java.io.PrintStream;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import net.bigeon.gclc.manager.ConsoleOutput;
/** This console output allows to retrieve the output as an input. /** This console output allows to retrieve the output as an input.
* <p> * <p>
* This console output is used to internally pilot an application. This can be * This console output is used to internally pilot an application. This can be
@@ -79,7 +114,7 @@ public final class PipedConsoleOutput
outPrint = new PrintStream(out, true, UTF_8); outPrint = new PrintStream(out, true, UTF_8);
innerManager = new StreamConsoleOutput(outPrint); innerManager = new StreamConsoleOutput(outPrint);
reading = new ReadingRunnable(commandBuffOutput); reading = new ReadingRunnable(commandBuffOutput);
final Thread th = new Thread(reading, "read"); //$NON-NLS-1$ final Thread th = new Thread(reading, "GCLC console output forward"); //$NON-NLS-1$
th.setDaemon(true); th.setDaemon(true);
th.start(); th.start();
} }
@@ -110,34 +145,34 @@ public final class PipedConsoleOutput
* *
* @param message the message * @param message the message
* @return the thread to join to wait for message delivery * @return the thread to join to wait for message delivery
* @see fr.bigeon.gclc.manager.ReadingRunnable#getWaitForDelivery(java.lang.String) */ * @see net.bigeon.gclc.utils.ReadingRunnable#getWaitForDelivery(java.lang.String) */
public Thread getWaitForDelivery(final String message) { public Thread getWaitForDelivery(final String message) {
return reading.getWaitForDelivery(message); return reading.getWaitForDelivery(message);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleOutput#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return innerManager.isClosed(); return innerManager.isClosed();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
@Override @Override
public void print(final String object) throws IOException { public void print(final String object) throws IOException {
innerManager.print(object); innerManager.print(object);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */ * @see net.bigeon.gclc.manager.ConsoleOutput#println() */
@Override @Override
public void println() throws IOException { public void println() throws IOException {
innerManager.println(); innerManager.println();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
@Override @Override
public void println(final String object) throws IOException { public void println(final String object) throws IOException {
innerManager.println(object); innerManager.println(object);

View File

@@ -33,11 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.test.utils.WritingRunnable.java * gclc:net.bigeon.gclc.test.utils.WritingRunnable.java
* Created on: Nov 29, 2016 * Created on: Nov 29, 2016
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.utils;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
import java.io.InterruptedIOException; import java.io.InterruptedIOException;
@@ -89,7 +122,6 @@ public final class ReadingRunnable implements Runnable {
/* (non-Javadoc) /* (non-Javadoc)
* @see java.lang.Runnable#run() */ * @see java.lang.Runnable#run() */
@SuppressWarnings("synthetic-access")
@Override @Override
public void run() { public void run() {
synchronized (obj) { synchronized (obj) {

View File

@@ -33,11 +33,46 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.manager.SinkOutput.java * gclc:net.bigeon.gclc.manager.SinkOutput.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.utils;
import net.bigeon.gclc.manager.ConsoleOutput;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** A console output that absorbs every message. /** A console output that absorbs every message.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
@@ -51,35 +86,35 @@ public final class SinkOutput implements ConsoleOutput {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#close() */ * @see net.bigeon.gclc.manager.ConsoleOutput#close() */
@Override @Override
public void close() { public void close() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleOutput#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return false; return false;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
@Override @Override
public void print(final String text) { public void print(final String text) {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */ * @see net.bigeon.gclc.manager.ConsoleOutput#println() */
@Override @Override
public void println() { public void println() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) * @see net.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String)
*/ */
@Override @Override
public void println(final String message) { public void println(final String message) {

View File

@@ -33,11 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.system.SystemConsoleManager.java * gclc:net.bigeon.gclc.system.SystemConsoleManager.java
* Created on: Dec 19, 2014 * Created on: Dec 19, 2014
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.utils;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
@@ -45,6 +78,10 @@ import java.io.InputStreamReader;
import java.io.PrintStream; import java.io.PrintStream;
import java.nio.charset.Charset; import java.nio.charset.Charset;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.tools.StringProvider;
/** A console using the input stream and print stream. /** A console using the input stream and print stream.
* <p> * <p>
* The default constructor will use the system standart input and output. * The default constructor will use the system standart input and output.
@@ -53,10 +90,10 @@ import java.nio.charset.Charset;
public final class StreamConsoleInput implements ConsoleInput { public final class StreamConsoleInput implements ConsoleInput {
/** The default prompt. */ /** The default prompt. */
public static final String DEFAULT_PROMPT = "> "; //$NON-NLS-1$ public static final StringProvider DEFAULT_PROMPT = new ConstantString("> "); //$NON-NLS-1$
/** The command prompt. It can be changed. */ /** The command prompt. It can be changed. */
private String prompt = DEFAULT_PROMPT; private StringProvider prompt = DEFAULT_PROMPT;
/** The print stream. */ /** The print stream. */
private final PrintStream out; private final PrintStream out;
@@ -104,75 +141,84 @@ public final class StreamConsoleInput implements ConsoleInput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */ * @see net.bigeon.gclc.manager.ConsoleManager#close() */
@Override @Override
public void close() throws IOException { public void close() throws IOException {
closed = true; closed = true;
reading.setRunning(false); reading.setRunning(false);
promptThread.interrupt(); promptThread.interrupt();
in.close();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override @Override
public String getPrompt() { public StringProvider getPrompt() {
return prompt; return prompt;
} }
/** Beware, in this implementation this is the same as closing the manager. /** Beware, in this implementation this is the same as closing the manager.
* *
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
@Override @Override
public void interruptPrompt() { public void interruptPrompt() {
reading.interrupt(); reading.interrupt();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleManager#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return closed; return closed;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#prompt() */ * @see net.bigeon.gclc.ConsoleManager#prompt() */
@Override @Override
public String prompt() throws IOException { public String prompt() throws IOException {
return prompt(prompt); return prompt(prompt.apply());
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */ * @see net.bigeon.gclc.manager.ConsoleManager#prompt(long) */
@Override @Override
public String prompt(final long timeout) throws IOException { public String prompt(final long timeout) throws IOException {
return prompt(prompt, timeout); return prompt(prompt.apply(), timeout);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */ * @see net.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
@Override @Override
public String prompt(final String message) throws IOException { public String prompt(final String message) throws IOException {
checkOpen(); checkOpen();
if (out != null) {
out.print(message); out.print(message);
out.flush();
}
return reading.getMessage(); return reading.getMessage();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */ * @see net.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
@Override @Override
public String prompt(final String message, public String prompt(final String message,
final long timeout) throws IOException { final long timeout) throws IOException {
checkOpen(); checkOpen();
if (out != null) {
out.print(message); out.print(message);
out.flush();
}
return reading.getNextMessage(timeout); return reading.getNextMessage(timeout);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override @Override
public void setPrompt(final String prompt) { public void setPrompt(final String prompt) {
this.prompt = prompt; this.prompt = new ConstantString(prompt);
} }
@Override
public void setPrompt(StringProvider string) {
this.prompt = string;
}
} }

View File

@@ -33,14 +33,49 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.system.SystemConsoleManager.java * gclc:net.bigeon.gclc.system.SystemConsoleManager.java
* Created on: Dec 19, 2014 * Created on: Dec 19, 2014
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.utils;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import java.io.PrintStream; import java.io.PrintStream;
import net.bigeon.gclc.manager.ConsoleOutput;
/** A console using the input stream and print stream. /** A console using the input stream and print stream.
* <p> * <p>
* The default constructor will use the system standart input and output. * The default constructor will use the system standart input and output.
@@ -76,21 +111,21 @@ public final class StreamConsoleOutput implements ConsoleOutput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */ * @see net.bigeon.gclc.manager.ConsoleManager#close() */
@Override @Override
public void close() { public void close() {
closed = true; closed = true;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleManager#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return closed; return closed;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#print(java.lang.Object) */ * @see net.bigeon.gclc.ConsoleManager#print(java.lang.Object) */
@Override @Override
public void print(final String object) throws IOException { public void print(final String object) throws IOException {
checkOpen(); checkOpen();
@@ -98,7 +133,7 @@ public final class StreamConsoleOutput implements ConsoleOutput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#println() */ * @see net.bigeon.gclc.ConsoleManager#println() */
@Override @Override
public void println() throws IOException { public void println() throws IOException {
checkOpen(); checkOpen();
@@ -106,7 +141,7 @@ public final class StreamConsoleOutput implements ConsoleOutput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#println(java.lang.Object) */ * @see net.bigeon.gclc.ConsoleManager#println(java.lang.Object) */
@Override @Override
public void println(final String object) throws IOException { public void println(final String object) throws IOException {
checkOpen(); checkOpen();

View File

@@ -33,11 +33,44 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.test.utils.WritingRunnable.java * gclc:net.bigeon.gclc.test.utils.WritingRunnable.java
* Created on: Nov 29, 2016 * Created on: Nov 29, 2016
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.utils;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException; import java.io.IOException;
import java.io.OutputStream; import java.io.OutputStream;
import java.nio.ByteBuffer; import java.nio.ByteBuffer;

View File

@@ -0,0 +1,39 @@
/**
* @author Emmanuel Bigeon
*
*/
package net.bigeon.gclc.utils;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/

View File

@@ -1,2 +0,0 @@
CommandProvider.unrecognized=Unrecognized command "{0}"
ConsoleApplication.cmd.failed=The command "{0}" failed due to :

View File

@@ -1,32 +0,0 @@
Copyright ${owner} (${project.inceptionYear})
${email}
This software is a computer program whose purpose is to
${project.description}.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.

View File

@@ -1,26 +0,0 @@
exit.tip=Exit the application
help.cmd.tip=Display an help tip
prompt.lineprompt=>\
promptlist.exit.defaultkey=\\q
promptlist.exit.dispkey=\ (exit with a new line made of "{0}")
promptlist.prompt=>\
promptlist.multi.sepkey=\
promptbool.choices=\ (Y/N)
promptbool.choices.invalid=Invalid input. Please input one of {0}.
promptbool.choices.yes1=Y
promptbool.choices.yes2=yes
promptbool.choices.no1=N
promptbool.choices.no2=no
promptchoice.outofbounds=Please choose something between {0} and {1}. The choices were:
promptchoice.formaterr=The input seems to be something that is not an integer.\
Please choose something between {0} and {1}. The choices were:
promptlongtext.exit.defaultkey=\\q
promptlongtext.exit.dispkey=\ (exit with a new line made of "{0}")
unrecognized.cmd=Unrecognized command "{0}"
expected.cmd=A Command was expected but nothing was provided...

View File

@@ -0,0 +1,35 @@
###
# #%L
# Generic Command Ligne console
# %%
# Copyright (C) 2014 - 2018 bigeon.fr
# %%
# This software is governed by the CeCILL license under French law and
# abiding by the rules of distribution of free software. You can use,
# modify and/ or redistribute the software under the terms of the CeCILL
# license as circulated by CEA, CNRS and INRIA at the following URL
# "http://www.cecill.info".
#
# As a counterpart to the access to the source code and rights to copy,
# modify and redistribute granted by the license, users are provided only
# with a limited warranty and the software's author, the holder of the
# economic rights, and the successive licensors have only limited
# liability.
#
# In this respect, the user's attention is drawn to the risks associated
# with loading, using, modifying and/or developing or reproducing the
# software by the user in light of its specific status of free software,
# that may mean that it is complicated to manipulate, and that also
# therefore means that it is reserved for developers and experienced
# professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their
# requirements in conditions enabling the security of their systems and/or
# data to be ensured and, more generally, to use and operate it in the
# same conditions as regards security.
#
# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL license and that you accept its terms.
# #L%
###
CommandProvider.unrecognized=Unrecognized command "{0}"
ConsoleApplication.cmd.failed=The command "{0}" failed due to :

View File

@@ -0,0 +1,59 @@
###
# #%L
# Generic Command Ligne console
# %%
# Copyright (C) 2014 - 2018 bigeon.fr
# %%
# This software is governed by the CeCILL license under French law and
# abiding by the rules of distribution of free software. You can use,
# modify and/ or redistribute the software under the terms of the CeCILL
# license as circulated by CEA, CNRS and INRIA at the following URL
# "http://www.cecill.info".
#
# As a counterpart to the access to the source code and rights to copy,
# modify and redistribute granted by the license, users are provided only
# with a limited warranty and the software's author, the holder of the
# economic rights, and the successive licensors have only limited
# liability.
#
# In this respect, the user's attention is drawn to the risks associated
# with loading, using, modifying and/or developing or reproducing the
# software by the user in light of its specific status of free software,
# that may mean that it is complicated to manipulate, and that also
# therefore means that it is reserved for developers and experienced
# professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their
# requirements in conditions enabling the security of their systems and/or
# data to be ensured and, more generally, to use and operate it in the
# same conditions as regards security.
#
# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL license and that you accept its terms.
# #L%
###
exit.tip=Exit the application
help.cmd.tip=Display an help tip
prompt.lineprompt=>\
promptlist.exit.defaultkey=\\q
promptlist.exit.dispkey=\ (exit with a new line made of "{0}")
promptlist.prompt=>\
promptlist.multi.sepkey=\
promptbool.choices=\ (Y/N)
promptbool.choices.invalid=Invalid input. Please input one of {0}.
promptbool.choices.yes1=Y
promptbool.choices.yes2=yes
promptbool.choices.no1=N
promptbool.choices.no2=no
promptchoice.outofbounds=Please choose something between {0} and {1}. The choices were:
promptchoice.formaterr=The input seems to be something that is not an integer.\
Please choose something between {0} and {1}. The choices were:
promptlongtext.exit.defaultkey=\\q
promptlongtext.exit.dispkey=\ (exit with a new line made of "{0}")
unrecognized.cmd=Unrecognized command "{0}"
expected.cmd=A Command was expected but nothing was provided...

Some files were not shown because too many files have changed in this diff Show More