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,60 +1,95 @@
<!-- 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 -->
<!-- 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". -->
<!-- --> <!-- -->
<!-- As a counterpart to the access to the source code and rights to copy, --> <!-- 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 --> <!-- modify and redistribute granted by the license, users are provided only -->
<!-- with a limited warranty and the software's author, the holder of the --> <!-- with a limited warranty and the software's author, the holder of the -->
<!-- economic rights, and the successive licensors have only limited --> <!-- economic rights, and the successive licensors have only limited -->
<!-- liability. --> <!-- liability. -->
<!-- --> <!-- -->
<!-- In this respect, the user's attention is drawn to the risks associated --> <!-- In this respect, the user's attention is drawn to the risks associated -->
<!-- with loading, using, modifying and/or developing or reproducing the --> <!-- with loading, using, modifying and/or developing or reproducing the -->
<!-- software by the user in light of its specific status of free software, --> <!-- 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 --> <!-- that may mean that it is complicated to manipulate, and that also -->
<!-- therefore means that it is reserved for developers and experienced --> <!-- therefore means that it is reserved for developers and experienced -->
<!-- professionals having in-depth computer knowledge. Users are therefore --> <!-- professionals having in-depth computer knowledge. Users are therefore -->
<!-- encouraged to load and test the software's suitability as regards their --> <!-- encouraged to load and test the software's suitability as regards their -->
<!-- requirements in conditions enabling the security of their systems and/or --> <!-- 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 --> <!-- data to be ensured and, more generally, to use and operate it in the -->
<!-- same conditions as regards security. --> <!-- same conditions as regards security. -->
<!-- --> <!-- -->
<!-- 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/xsd/maven-4.0.0.xsd"> <!-- process, Distribution repositories and basic setup for Emmanuel Bigeon projects -->
<modelVersion>4.0.0</modelVersion> <!-- Copyright (C) 2014-2017 E. Bigeon -->
<!-- mailto:emmanuel@bigeon.fr -->
<groupId>fr.bigeon.gclc</groupId> <!-- -->
<artifactId>process</artifactId> <!-- This software is governed by the CeCILL license under French law and -->
<version>0.0.1-SNAPSHOT</version> <!-- abiding by the rules of distribution of free software. You can use, -->
<packaging>jar</packaging> <!-- modify and/or redistribute the software under the terms of the CeCILL -->
<!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
<name>process</name> <!-- "http://www.cecill.info". -->
<url>http://maven.apache.org</url> <!-- -->
<!-- As a counterpart to the access to the source code and rights to copy, -->
<properties> <!-- modify and redistribute granted by the license, users are provided only -->
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <!-- with a limited warranty and the software's author, the holder of the -->
</properties> <!-- economic rights, and the successive licensors have only limited -->
<!-- liability. -->
<parent> <!-- -->
<groupId>fr.bigeon</groupId> <!-- In this respect, the user's attention is drawn to the risks associated -->
<artifactId>ebigeon-config</artifactId> <!-- with loading, using, modifying and/or developing or reproducing the -->
<version>1.8.0</version> <!-- software by the user in light of its specific status of free software, -->
</parent> <!-- that may mean that it is complicated to manipulate, and that also -->
<dependencies> <!-- therefore means that it is reserved for developers and experienced -->
<dependency> <!-- professionals having in-depth computer knowledge. Users are therefore -->
<groupId>fr.bigeon</groupId> <!-- encouraged to load and test the software's suitability as regards their -->
<artifactId>gclc</artifactId> <!-- requirements in conditions enabling the security of their systems and/or -->
<version>2.0.0-SNAPSHOT</version> <!-- data to be ensured and, more generally, to use and operate it in the -->
</dependency> <!-- same conditions as regards security. -->
</dependencies> <!-- -->
</project> <!-- 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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>fr.bigeon.gclc</groupId>
<artifactId>process</artifactId>
<version>0.0.3-SNAPSHOT</version>
<packaging>jar</packaging>
<name>process</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<parent>
<groupId>fr.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.2</version>
</parent>
<dependencies>
<dependency>
<groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.5</version>
</dependency>
</dependencies>
<scm>
<tag>process-0.0.1</tag>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
</scm>
</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 string = parameters.get("join"); final String[] inner = Arrays.copyOfRange(args, 1, args.length);
if (string != null) { final ForkTask task = new ForkCommandTask(cmd, inner, lines);
// 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() {
return running; synchronized (runLock) {
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() {
running = true; synchronized (runLock) {
try { running = true;
// 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) {
this.running = running; synchronized (runLock) {
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 return;
public String getCommandName() {
return name;
}
/* (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
@@ -47,13 +47,29 @@ public final class TaskPool {
/** The running processes. */ /** The running processes. */
private final Map<String, Task> running = new HashMap<>(); private final Map<String, Task> running = new HashMap<>();
/** The count for process id. */ /** The count for process id. */
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);
} }
cmd.addInterruptionListener(new InterruptionListener() { if (autoClear) {
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,103 +1,171 @@
<!-- Copyright E. Bigeon (2014) --> <!-- GCLC Socket, Socket implementation of GCLC -->
<!-- --> <!-- Copyright (C) 2014-2017 E. Bigeon -->
<!-- emmanuel@bigeon.fr --> <!-- mailto:emmanuel@bigeon.fr -->
<!-- --> <!-- -->
<!-- This software is a computer program whose purpose is to --> <!-- This software is governed by the CeCILL license under French law and -->
<!-- Socket implementation of GCLC. --> <!-- abiding by the rules of distribution of free software. You can use, -->
<!-- --> <!-- modify and/or redistribute the software under the terms of the CeCILL -->
<!-- This software is governed by the CeCILL license under French law and --> <!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
<!-- abiding by the rules of distribution of free software. You can use, --> <!-- "http://www.cecill.info". -->
<!-- modify and/or redistribute the software under the terms of the CeCILL --> <!-- -->
<!-- license as circulated by CEA, CNRS and INRIA at the following URL --> <!-- As a counterpart to the access to the source code and rights to copy, -->
<!-- "http://www.cecill.info". --> <!-- modify and redistribute granted by the license, users are provided only -->
<!-- --> <!-- with a limited warranty and the software's author, the holder of the -->
<!-- As a counterpart to the access to the source code and rights to copy, --> <!-- economic rights, and the successive licensors have only limited -->
<!-- modify and redistribute granted by the license, users are provided only --> <!-- liability. -->
<!-- with a limited warranty and the software's author, the holder of the --> <!-- -->
<!-- economic rights, and the successive licensors have only limited --> <!-- In this respect, the user's attention is drawn to the risks associated -->
<!-- liability. --> <!-- with loading, using, modifying and/or developing or reproducing the -->
<!-- --> <!-- software by the user in light of its specific status of free software, -->
<!-- In this respect, the user's attention is drawn to the risks associated --> <!-- that may mean that it is complicated to manipulate, and that also -->
<!-- with loading, using, modifying and/or developing or reproducing the --> <!-- therefore means that it is reserved for developers and experienced -->
<!-- software by the user in light of its specific status of free software, --> <!-- professionals having in-depth computer knowledge. Users are therefore -->
<!-- that may mean that it is complicated to manipulate, and that also --> <!-- encouraged to load and test the software's suitability as regards their -->
<!-- therefore means that it is reserved for developers and experienced --> <!-- requirements in conditions enabling the security of their systems and/or -->
<!-- professionals having in-depth computer knowledge. Users are therefore --> <!-- data to be ensured and, more generally, to use and operate it in the -->
<!-- encouraged to load and test the software's suitability as regards their --> <!-- same conditions as regards security. -->
<!-- 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 --> <!-- The fact that you are presently reading this means that you have had -->
<!-- same conditions as regards security. --> <!-- knowledge of the CeCILL license and that you accept its terms. -->
<!-- -->
<!-- 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 -->
<!-- --> <!-- -->
<!-- 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 <!-- Socket implementation of GCLC. -->
of 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, --> <!-- 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". --> <!-- -->
<!-- --> <!-- As a counterpart to the access to the source code and rights to copy, -->
<!-- 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 -->
<!-- modify and redistribute granted by the license, users are provided only --> <!-- with a limited warranty and the software's author, the holder of the -->
<!-- with a limited warranty and the software's author, the holder of the --> <!-- economic rights, and the successive licensors have only limited -->
<!-- economic rights, and the successive licensors have only limited --> <!-- liability. -->
<!-- liability. --> <!-- -->
<!-- --> <!-- In this respect, the user's attention is drawn to the risks associated -->
<!-- In this respect, the user's attention is drawn to the risks associated --> <!-- with loading, using, modifying and/or developing or reproducing the -->
<!-- with loading, using, modifying and/or developing or reproducing the --> <!-- software by the user in light of its specific status of free software, -->
<!-- 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 -->
<!-- that may mean that it is complicated to manipulate, and that also --> <!-- therefore means that it is reserved for developers and experienced -->
<!-- therefore means that it is reserved for developers and experienced --> <!-- professionals having in-depth computer knowledge. Users are therefore -->
<!-- professionals having in-depth computer knowledge. Users are therefore --> <!-- encouraged to load and test the software's suitability as regards their -->
<!-- encouraged to load and test the software's suitability as regards their --> <!-- requirements in conditions enabling the security of their systems and/or -->
<!-- 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 -->
<!-- data to be ensured and, more generally, to use and operate it in the --> <!-- same conditions as regards security. -->
<!-- same conditions as regards security. --> <!-- -->
<!-- --> <!-- 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">
<modelVersion>4.0.0</modelVersion> <!-- Copyright E. Bigeon (2014) -->
<artifactId>gclc-socket</artifactId> <!-- -->
<version>1.1.9-SNAPSHOT</version> <!-- emmanuel@bigeon.fr -->
<packaging>jar</packaging> <!-- -->
<url>http://www.bigeon.fr/emmanuel</url> <!-- This software is a computer program whose purpose is to -->
<properties> <!-- Defines the distribution repositories and basic setup for projects of
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> Emmanuel Bigeon. -->
<project.scm.id>git.bigeon.net</project.scm.id> <!-- -->
</properties> <!-- This software is governed by the CeCILL license under French law and -->
<dependencies> <!-- abiding by the rules of distribution of free software. You can use, -->
<dependency> <!-- modify and/or redistribute the software under the terms of the CeCILL -->
<groupId>fr.bigeon</groupId> <!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
<artifactId>gclc</artifactId> <!-- "http://www.cecill.info". -->
<version>1.5.0</version> <!-- -->
</dependency> <!-- As a counterpart to the access to the source code and rights to copy, -->
<dependency> <!-- modify and redistribute granted by the license, users are provided only -->
<groupId>fr.bigeon</groupId> <!-- with a limited warranty and the software's author, the holder of the -->
<artifactId>smu</artifactId> <!-- economic rights, and the successive licensors have only limited -->
<version>0.0.5</version> <!-- liability. -->
</dependency> <!-- -->
</dependencies> <!-- In this respect, the user's attention is drawn to the risks associated -->
<parent> <!-- with loading, using, modifying and/or developing or reproducing the -->
<groupId>fr.bigeon</groupId> <!-- software by the user in light of its specific status of free software, -->
<artifactId>ebigeon-config</artifactId> <!-- that may mean that it is complicated to manipulate, and that also -->
<version>1.7.1</version> <!-- therefore means that it is reserved for developers and experienced -->
</parent> <!-- professionals having in-depth computer knowledge. Users are therefore -->
<name>GCLC Socket</name> <!-- encouraged to load and test the software's suitability as regards their -->
<description>Socket implementation of GCLC</description> <!-- requirements in conditions enabling the security of their systems and/or -->
<scm> <!-- data to be ensured and, more generally, to use and operate it in the -->
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> <!-- same conditions as regards security. -->
<tag>HEAD</tag> <!-- -->
</scm> <!-- 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">
<modelVersion>4.0.0</modelVersion>
<artifactId>gclc-socket</artifactId>
<version>1.1.10-SNAPSHOT</version>
<packaging>jar</packaging>
<url>http://www.bigeon.net</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<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>
<dependencies>
<dependency>
<groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.5</version>
</dependency>
<dependency>
<groupId>fr.bigeon</groupId>
<artifactId>smu</artifactId>
<version>0.0.9</version>
</dependency>
</dependencies>
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.3</version>
</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>
<description>Socket implementation of GCLC</description>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag>
</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,403 +1,200 @@
/* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.BufferedReader; import java.net.InetAddress;
import java.io.IOException; import java.net.ServerSocket;
import java.io.InputStreamReader; import java.net.Socket;
import java.io.OutputStreamWriter; import java.net.SocketException;
import java.io.PrintWriter; import java.util.logging.Level;
import java.net.ServerSocket; import java.util.logging.Logger;
import java.net.Socket;
import java.net.SocketException; import fr.bigeon.gclc.ConsoleApplication;
import java.nio.charset.Charset;
import java.util.logging.Level; /** This is a socket communicating console consoleManager.
import java.util.logging.Logger; * <p>
* To use this application, the following flow should be used:
import fr.bigeon.gclc.ConsoleApplication; *
import fr.bigeon.gclc.manager.ConsoleManager; * <pre>
import fr.bigeon.gclc.manager.PipedConsoleManager; * SocketConsoleApplicationShell shell = new SocketConsoleApplicationShell();
import fr.bigeon.gclc.manager.ReadingRunnable; * ConsoleApplication myApplication = new MyConsoleApplication(shell.getConsoleManager(), ...);
* shell.setApplication(myApplication);
/** This is a socket communicating console consoleManager * Thread th = new Thread(shell);
* <p> * th.start();
* To use this application, the following flow should be used: * </pre>
* * <p>
* <pre> * This will start the application in a separate thread. The application will be
* SocketConsoleApplicationShell shell = new SocketConsoleApplicationShell(); * listening on the given socket and writing back on it. If this is all your
* ConsoleApplication myApplication = new MyConsoleApplication(shell.getConsoleManager(), ...); * application, you should then {@link Thread#join()} the thread to wait for the
* shell.setApplication(myApplication); * end of the execution.
* Thread th = new Thread(shell); *
* th.start(); * @author Emmanuel Bigeon */
* </pre> public final class SocketConsoleApplicationShell implements Runnable {
* <p>
* This will start the application in a separate thread. The application will be /** The class logger. */
* listening on the given socket and writing back on it. If this is all your private static final Logger LOGGER = Logger
* application, you should then {@link Thread#join()} the thread to wait for the .getLogger(SocketConsoleApplicationShell.class.getName());
* end of the execution. /** The listening port. */
* private final int port;
* @author Emmanuel Bigeon */ /** The running status. */
public class SocketConsoleApplicationShell implements Runnable, AutoCloseable { private boolean running;
/** The socket console interface. */
/** The runnable to forward output of application to socket. private SocketConsoleInterface sci;
* /** The remote disconnection command. */
* @author Emmanuel Bigeon */ private ConnexionManager<Socket> rdc;
private final class OutputForwardRunnable implements Runnable { /** The application. */
/** private ConsoleApplication app;
*
*/ /** The server socket. */
private final PrintWriter writer; private ServerSocket serverSocket;
/** /** THe server address. */
* private final InetAddress addr;
*/
private final Socket socket; /** Create a socket application shell which will listen on the given port
* and network interface.
/** @param writer the writer *
* @param socket the socket */ * @param port the part
protected OutputForwardRunnable(PrintWriter writer, Socket socket) { * @param addr the inet address */
this.writer = writer; public SocketConsoleApplicationShell(final int port,
this.socket = socket; final InetAddress addr) {
} super();
this.port = port;
@SuppressWarnings("synthetic-access") this.addr = addr;
@Override }
public void run() {
try { /** Wait for the identified connection to disconnect.
while (!socket.isClosed()) { *
while (!socket.isClosed() && !consoleManager.available()) { * @param id the connexion id. */
waitASec(); private void awaitDisconnexion(final String id) {
} while (rdc.isConnected(id)) {
if (socket.isClosed()) { try {
return; rdc.waitDisconnexion(id);
} } catch (final InterruptedException e) {
String m = consoleManager.readNextLine(); LOGGER.log(Level.SEVERE, "Unexpected interruption", e); //$NON-NLS-1$
writer.println(m); Thread.currentThread().interrupt();
} }
} catch (IOException e) { }
LOGGER.log(Level.SEVERE, "Unexpected problem in manager", //$NON-NLS-1$ sci.disconnect();
e); }
}
} /** If the port provided was 0, this allows to get the actual port.
* @return the local port
} * @see java.net.ServerSocket#getLocalPort()
*/
/** The end of line character */ public int getLocalPort() {
protected static final String EOL = "\n"; //$NON-NLS-1$ return serverSocket.getLocalPort();
/** The class logger */ }
private static final Logger LOGGER = Logger
.getLogger(SocketConsoleApplicationShell.class.getName()); /* (non-Javadoc)
/** Time of wait */ * @see java.lang.Runnable#run() */
protected static final long ONE_TENTH_OF_SECOND = 100; @Override
/** The listening port */ public void run() {
private final int port; // Create the server
/** The application */ try (ServerSocket actualServerSocket = new ServerSocket(port, 1,
private ConsoleApplication app; addr)) {
/** The session closing command */ serverSocket = actualServerSocket;
private final String close; running = true;
/** The running status */ // Create the streams
private boolean running; runSokectServer();
} catch (final IOException e) {
/** The console manager implementation */ LOGGER.severe("Communication error between client and server"); //$NON-NLS-1$
private final PipedConsoleManager consoleManager; LOGGER.log(Level.FINE,
/** The auto close flag. if this is true, every request closes the session "Communication error between client and server", e); //$NON-NLS-1$
* after its call */ }
private final boolean autoClose; }
/** The server socket */
private ServerSocket serverSocket; /** Acctually run the server loop on connexion.
/** The application shutdown string */ *
private final String applicationShutdown; * @throws IOException if the communication with the client failed */
/** The charset for the communication. */ private void runSokectServer() throws IOException {
private final Charset charset; while (running && app.isRunning()) {
LOGGER.info("Waiting client"); //$NON-NLS-1$
/** Create a socket application shell which will listen on the given port try (Socket clientSocket = serverSocket.accept();) {
* and close session upon the provided string reception by client
* sci.connect(clientSocket);
* @param port the port to listen to
* @param close the session closing command final String id = rdc.addConnexion(clientSocket);
* @param applicationShutdown the appication shut down command rdc.lockDisconnexion(id);
* @param charset the charset for communication awaitDisconnexion(id);
* @throws IOException if the manager could not be created */ rdc.releaseDisconnexionLock(id);
public SocketConsoleApplicationShell(int port, String close, } catch (final SocketException e) {
String applicationShutdown, Charset charset) throws IOException { LOGGER.log(Level.INFO, "Socket closed"); //$NON-NLS-1$
this.port = port; LOGGER.log(Level.FINE,
this.close = close; "Socket closed with exception (probably due to server interruption)", //$NON-NLS-1$
this.applicationShutdown = applicationShutdown; e);
this.autoClose = false; } catch (final IOException e) {
this.charset = charset; throw e;
// }
consoleManager = new PipedConsoleManager(); LOGGER.info("Closing client"); //$NON-NLS-1$
} }
LOGGER.info("Closing Server"); //$NON-NLS-1$
/** Create a socket application shell which will listen on the given port }
* and auto close session after one instruction
* /** Set the application.
* @param port the port to listen to * <p>
* @param autoClose if the session must be closed once the request has been * If the application is closed, the server will also close.
* sent *
* @param applicationShutdown the appication shut down command * @param app the app to set */
* @param charset the charset for communication public void setApplication(final ConsoleApplication app) {
* @throws IOException if the manager could not be created */ this.app = app;
public SocketConsoleApplicationShell(int port, boolean autoClose, }
String applicationShutdown, Charset charset) throws IOException {
this.port = port; /** Set the connexion manager.
this.autoClose = autoClose; *
this.applicationShutdown = applicationShutdown; * @param rdc the rdc to set */
this.close = autoClose ? null : "close"; //$NON-NLS-1$ public void setConnexionManager(final ConnexionManager<Socket> rdc) {
this.charset = charset; this.rdc = rdc;
// }
consoleManager = new PipedConsoleManager();
} /** Set the socket console interface.
*
/* (non-Javadoc) * @param sci the console interface to set */
* @see java.lang.Runnable#run() */ public void setInterface(final SocketConsoleInterface sci) {
@Override this.sci = sci;
public void run() { }
// Create the server
try (ServerSocket actualServerSocket = new ServerSocket(port)) { /** This method will request the server to stop.
this.serverSocket = actualServerSocket; * <p>
running = true; * In most cases, this will terminate communication on every client. On some
// Create the streams * cases, the */
runSokectServer(); public void stop() {
} catch (final IOException e) { running = false;
LOGGER.severe("Communication error between client and server"); //$NON-NLS-1$ try {
LOGGER.log(Level.FINE, serverSocket.close();
"Communication error between client and server", e); //$NON-NLS-1$ } catch (final IOException e) {
} LOGGER.log(Level.SEVERE, "Exception in closing socket server", e); //$NON-NLS-1$
} }
}
/** @throws IOException if the communication with the client failed */ }
private void runSokectServer() throws IOException {
final ConsoleRunnable runnable = new ConsoleRunnable(app);
Thread appThNext = new Thread(runnable, "gclc-ctrl"); //$NON-NLS-1$
appThNext.start();
while (running) {
LOGGER.info("Waiting client"); //$NON-NLS-1$
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
if (!runnable.isApplicationRunning()) {
LOGGER.info("Start application"); //$NON-NLS-1$
startApplication(runnable);
} else {
LOGGER.info("Reconnect to application"); //$NON-NLS-1$
out.println("Reconnected"); //$NON-NLS-1$
out.println(consoleManager.getPrompt());
}
communicate(clientSocket, out, in);
} catch (SocketException e) {
LOGGER.log(Level.INFO, "Socket closed"); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"Socket closed with exception (probably due to server interruption)", //$NON-NLS-1$
e);
} catch (IOException e) {
throw e;
}
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$
}
/** Close the console manager after writing the application shutdown
* command.
*
* @param appThNext the thread containing the application
* @throws IOException if the typyng or closing failed */
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 method will request the server to stop.
* <p>
* In most cases, this will terminate communication on every client. On some
* cases, the */
public void stop() {
running = false;
try {
serverSocket.close();
} catch (IOException e) {
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,107 +1,160 @@
/* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.command.Command; import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.command.ExitCommand; import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.command.HelpExecutor; import fr.bigeon.gclc.command.ExitCommand;
import fr.bigeon.gclc.exception.CommandRunException; import fr.bigeon.gclc.command.HelpExecutor;
import fr.bigeon.gclc.exception.InvalidCommandName; import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleManager; import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.manager.ConsoleInput;
/** A test-purpose application import fr.bigeon.gclc.manager.ConsoleOutput;
*
* @author Emmanuel Bigeon */ /** A test-purpose application
public class ConsoleTestApplication { *
* @author Emmanuel Bigeon */
/** Exit command */ public class ConsoleTestApplication {
public static final String EXIT = "exit"; //$NON-NLS-1$
/** Exit command */
/** @param manager the manager public static final String EXIT = "exit"; //$NON-NLS-1$
* @return create the application */
@SuppressWarnings("nls") /** Create the test application.
public static ConsoleApplication create(final ConsoleManager manager) { *
try { * @param output the output
ConsoleApplication application = new ConsoleApplication(manager, * @param input the input
"Welcome to the test application. Type help or test.", * @param manager the manager
"See you"); * @return create the application */
application.add(new ExitCommand(EXIT, application)); @SuppressWarnings("nls")
application.add( public static ConsoleApplication create(final ConsoleOutput output,
new HelpExecutor("help", manager, application.root)); final ConsoleInput input,
application.add(new Command("test") { final ConnexionManager<Socket> manager) {
try {
@Override final ConsoleApplication application = new ConsoleApplication(
public String tip() { output, input,
return "A test command"; "Welcome to the test application. Type help or test.",
} "See you");
application.add(new ExitCommand(EXIT, application) {
@Override /* (non-Javadoc)
public void execute(String... args) throws CommandRunException { * @see fr.bigeon.gclc.command.ExitCommand#beforeExit() */
try { @Override
manager.println("Test command ran fine"); protected void beforeExit() {
} catch (IOException e) { final Collection<String> coll = manager.getConnected();
throw new CommandRunException("manager closed", e, for (final String string : coll) {
this); manager.disconnect(string);
} }
} }
}); });
application.add(new Command("long") { application
.add(new HelpExecutor("help", application.root));
@Override application.add(new Command("test") {
public String tip() {
return "A long run test command"; /* (non-Javadoc)
} * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
@Override * java.lang.String[]) */
public void execute(String... args) throws CommandRunException { @Override
try { public void execute(final ConsoleOutput out,
Thread.sleep(2000); final ConsoleInput in,
manager.println("Test command ran fine"); final String... args) throws CommandRunException {
} catch (IOException | InterruptedException e) { try {
throw new CommandRunException("manager closed", e, output.println("Test command ran fine");
this); } catch (final IOException e) {
} throw new CommandRunException("manager closed", e,
} this);
}); }
return application; }
} catch (final InvalidCommandName e) {
e.printStackTrace(); @Override
} public String tip() {
return null; return "A test 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");
}
});
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 {
Thread.sleep(2000);
output.println("Test command ran fine");
} catch (IOException | InterruptedException e) {
throw new CommandRunException("manager closed", e,
this);
}
}
@Override
public String tip() {
return "A long run test 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");
}
});
application.add(
new RemoteDisconnectCommand<>("out", manager, true));
return application;
} catch (final InvalidCommandName e) {
e.printStackTrace();
}
return null;
}
}

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,241 +1,171 @@
/* /**
* 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
* This software is governed by the CeCILL license under French law and * GCLC Socket
* abiding by the rules of distribution of free software. You can use, * %%
* modify and/or redistribute the software under the terms of the CeCILL * Copyright (C) 2016 - 2018 Bigeon
* license as circulated by CEA, CNRS and INRIA at the following URL * %%
* "http://www.cecill.info". * This software is governed by the CeCILL license under French law and
* * abiding by the rules of distribution of free software. You can use,
* As a counterpart to the access to the source code and rights to copy, * modify and/ or redistribute the software under the terms of the CeCILL
* modify and redistribute granted by the license, users are provided only * license as circulated by CEA, CNRS and INRIA at the following URL
* with a limited warranty and the software's author, the holder of the * "http://www.cecill.info".
* economic rights, and the successive licensors have only limited *
* liability. * 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
* In this respect, the user's attention is drawn to the risks associated * with a limited warranty and the software's author, the holder of the
* with loading, using, modifying and/or developing or reproducing the * economic rights, and the successive licensors have only limited
* software by the user in light of its specific status of free software, * liability.
* that may mean that it is complicated to manipulate, and that also *
* therefore means that it is reserved for developers and experienced * In this respect, the user's attention is drawn to the risks associated
* professionals having in-depth computer knowledge. Users are therefore * with loading, using, modifying and/or developing or reproducing the
* encouraged to load and test the software's suitability as regards their * software by the user in light of its specific status of free software,
* requirements in conditions enabling the security of their systems and/or * that may mean that it is complicated to manipulate, and that also
* data to be ensured and, more generally, to use and operate it in the * therefore means that it is reserved for developers and experienced
* same conditions as regards security. * professionals having in-depth computer knowledge. Users are therefore
* * encouraged to load and test the software's suitability as regards their
* The fact that you are presently reading this means that you have had * requirements in conditions enabling the security of their systems and/or
* knowledge of the CeCILL license and that you accept its terms. * data to be ensured and, more generally, to use and operate it in the
*/ * same conditions as regards security.
/** *
* gclc-socket:fr.bigeon.gclc.socket.SocketConsoleApplicationTest.java * The fact that you are presently reading this means that you have had
* Created on: Jun 1, 2016 * knowledge of the CeCILL license and that you accept its terms.
*/ * #L%
package fr.bigeon.gclc.socket; */
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull; import java.io.BufferedReader;
import static org.junit.Assert.assertTrue; import java.io.IOException;
import static org.junit.Assert.fail; import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.BufferedReader; import java.net.Socket;
import java.io.IOException; import java.util.logging.Logger;
import java.io.InputStreamReader;
import java.io.PrintWriter; import org.junit.Test;
import java.net.Socket;
import java.util.logging.Logger; /** Test class for {@link SocketConsoleApplicationShell}
*
import org.junit.Test; * @author Emmanuel Bigeon */
@SuppressWarnings({"static-method", "javadoc", "nls"})
/** Test class for {@link SocketConsoleApplicationShell} public class SocketConsoleApplicationTest {
*
* @author Emmanuel Bigeon */ private static final Logger LOGGER = Logger
@SuppressWarnings({"static-method", "unused", "javadoc", "nls"}) .getLogger(SocketConsoleApplicationTest.class.getName());
public class SocketConsoleApplicationTest {
/** @param in the input
private static final Logger LOGGER = Logger * @return the string
.getLogger(SocketConsoleApplicationTest.class.getName()); * @throws IOException if the input reading failed */
private String consumeToPrompt(final String server,
@Test final BufferedReader in) throws IOException {
public void integrationTest() { String fromServer = server;
Thread server; LOGGER.fine("Server: \n" + fromServer);
try { while (fromServer != null && !fromServer.equals("Bye.") &&
server = TestServer.startServer("bye"); !fromServer.equals("> ")) {
} catch (IOException e3) { fromServer = in.readLine();
assertNull(e3); LOGGER.fine("Server: \n" + fromServer);
fail("unable to start server"); }
} return fromServer;
try { }
Thread.sleep(1000);
} catch (InterruptedException e1) { @Test
e1.printStackTrace(); public void testIntegration() throws IOException, InterruptedException {
} Thread server;
final String hostName = "127.0.0.1"; server = TestServer.getServer();
final int portNumber = 3300; Thread.sleep(1000);
final String hostName = "127.0.0.1";
try (Socket kkSocket = new Socket(hostName, portNumber); final int portNumber = 3300;
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true); try (Socket kkSocket = new Socket(hostName, portNumber);
BufferedReader in = new BufferedReader( PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
new InputStreamReader(kkSocket.getInputStream()));) { true);
BufferedReader in = new BufferedReader(
String fromServer; new InputStreamReader(kkSocket.getInputStream()));) {
int i = -1;
String[] cmds = {"help", "toto", "test", "bye"}; String fromServer;
while ((fromServer = in.readLine()) != null) { int i = -1;
i++; final String[] cmds = {"help", "toto", "test", "out"};
fromServer = consumeToPrompt(fromServer, in); while ((fromServer = in.readLine()) != null) {
if (fromServer == null || fromServer.equals("Bye.")) { i++;
break; fromServer = consumeToPrompt(fromServer, in);
} if (fromServer == null || fromServer.equals("Bye.")) {
break;
final String fromUser = cmds[i]; }
if (fromUser != null) {
LOGGER.fine("Client: " + fromUser); final String fromUser = cmds[i];
out.println(fromUser); if (fromUser != null) {
} LOGGER.fine("Client: " + fromUser);
} out.println(fromUser);
assertEquals(4, i); }
} catch (final IOException e) { }
e.printStackTrace(); assertEquals("Disconnection command should close connection", 3, i);
} }
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(),
true); true);
BufferedReader in = new BufferedReader( BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) { new InputStreamReader(kkSocket.getInputStream()));) {
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);
if (fromServer == null || fromServer.equals("Bye.")) { if (fromServer == null || fromServer.equals("Bye.")) {
break; break;
} }
LOGGER.info("Server: \n" + fromServer); LOGGER.info("Server: \n" + fromServer);
final String fromUser = cmds[i]; final String fromUser = cmds[i];
if (fromUser != null) { if (fromUser != null) {
LOGGER.info("Client: " + fromUser); LOGGER.info("Client: " + fromUser);
out.println(fromUser); out.println(fromUser);
} }
i++; i++;
} }
assertEquals(4, i); assertEquals("Application exit command should close connection", 4,
} catch (final IOException e) { i);
e.printStackTrace(); }
} Thread.sleep(100);
try { TestServer.closeServer();
Thread.sleep(100); server.join();
} catch (InterruptedException e1) { server = TestServer.getServer();
e1.printStackTrace(); 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(),
true); true);
BufferedReader in = new BufferedReader( BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) { new InputStreamReader(kkSocket.getInputStream()));) {
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);
if (fromServer == null || fromServer.equals("Bye.")) { if (fromServer == null || fromServer.equals("Bye.")) {
break; break;
} }
final String fromUser = cmds[i]; final String fromUser = cmds[i];
if (fromUser != null) { if (fromUser != null) {
LOGGER.fine("Client: " + fromUser); LOGGER.fine("Client: " + fromUser);
out.println(fromUser); out.println(fromUser);
} }
i++; i++;
} }
assertEquals(4, i); assertEquals("Application exit command should close connection", 4,
} catch (final IOException e) { i);
e.printStackTrace(); }
} TestServer.closeServer();
TestServer.closeServer(); server.join();
try { }
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,95 +1,94 @@
/* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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; import java.io.PrintWriter;
import java.io.PrintWriter; import java.net.Socket;
import java.net.Socket; import java.util.ArrayList;
import java.util.ArrayList; import java.util.Collection;
import java.util.Collection;
import fr.bigeon.smu.StringEncoder;
import fr.bigeon.smu.StringEncoder;
/** TODO Describe TestConsoleClient.java
/** TODO Describe TestConsoleClient.java * @author Emmanuel Bigeon
* @author Emmanuel Bigeon *
* */
*/ @SuppressWarnings("nls")
@SuppressWarnings("nls") public class TestConsoleClient {
public class TestConsoleClient { @SuppressWarnings("javadoc")
@SuppressWarnings("javadoc") private static final Collection<String> TO_ENCODE = new ArrayList<>();
private static final Collection<String> TO_ENCODE = new ArrayList<>(); static {
static { TO_ENCODE.add("\n");
TO_ENCODE.add("\n"); }
}
@SuppressWarnings("javadoc")
@SuppressWarnings("javadoc") private static final StringEncoder ENCODER = new StringEncoder("%",
private static final StringEncoder ENCODER = new StringEncoder("%", TO_ENCODE);
TO_ENCODE);
@SuppressWarnings("javadoc")
@SuppressWarnings("javadoc") public static void main(String[] args) {
public static void main(String[] args) { final String hostName = "127.0.0.1";
final String hostName = "127.0.0.1"; final int portNumber = 3300;
final int portNumber = 3300;
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(), true);
true); BufferedReader in = new BufferedReader(new InputStreamReader(
BufferedReader in = new BufferedReader(new InputStreamReader( kkSocket.getInputStream()));) {
kkSocket.getInputStream()));) {
String fromServer;
String fromServer; while ((fromServer = in.readLine()) != null) {
while ((fromServer = in.readLine()) != null) { System.out.println("Server: \n" + ENCODER.decode(fromServer));
System.out.println("Server: \n" + ENCODER.decode(fromServer)); if (fromServer.equals("Bye.")) {
if (fromServer.equals("Bye.")) { break;
break; }
}
final BufferedReader stdIn = new BufferedReader(
final BufferedReader stdIn = new BufferedReader( new InputStreamReader(System.in));
new InputStreamReader(System.in)); final String fromUser = stdIn.readLine();
final String fromUser = stdIn.readLine(); if (fromUser != null) {
if (fromUser != null) { System.out.println("Client: " + fromUser);
System.out.println("Client: " + fromUser); out.println(fromUser);
out.println(fromUser); }
} }
} } catch (final IOException e) {
} catch (final IOException e) { // TODO Auto-generated catch block
// TODO Auto-generated catch block e.printStackTrace();
e.printStackTrace(); }
}
}
} }
}

View File

@@ -1,108 +1,107 @@
/* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.InetAddress;
import java.nio.charset.Charset; import java.net.Socket;
import java.net.UnknownHostException;
import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.ConsoleApplication;
/** A test server
* /** A test server
* @author Emmanuel Bigeon */ *
@SuppressWarnings({"javadoc", "nls"}) * @author Emmanuel Bigeon */
public class TestServer { @SuppressWarnings({"javadoc", "nls"})
public class TestServer {
private static SocketConsoleApplicationShell SHELL;
private static Thread server; private static SocketConsoleApplicationShell SHELL;
private static ConnexionManager<Socket> manager;
/** @param args no argument
* @throws IOException if the server starting failed */ private static Thread server;
public static void main(String... args) throws IOException { private static PluggableConsoleInput input;
try { private static PluggableConsoleOutput output;
startServer(false).join();
} catch (final InterruptedException e) { public static synchronized void closeServer() {
e.printStackTrace(); SHELL.stop();
} input.close();
} output.close();
SHELL = null;
public static Thread getServer() throws IOException { server = null;
if (server == null) { }
server = new Thread(getShell(), "gclcServer");
server.start(); public static synchronized Thread getServer() throws IOException {
} if (server == null) {
return server; server = new Thread(getShell(), "gclcServer");
} server.start();
}
private static SocketConsoleApplicationShell getShell() throws IOException { return server;
if (SHELL == null) { }
SHELL = new SocketConsoleApplicationShell(3300, "close",
ConsoleTestApplication.EXIT, Charset.forName("UTF-8")); private static SocketConsoleApplicationShell getShell() throws UnknownHostException {
final ConsoleApplication app = ConsoleTestApplication if (SHELL == null) {
.create(SHELL.getConsoleManager()); input = new PluggableConsoleInput();
SHELL.setApplication(app); input.setPrompt("> \n");
} output = new PluggableConsoleOutput();
return SHELL; manager = new DConnexionManager<>();
} SHELL = new SocketConsoleApplicationShell(3300,
InetAddress.getByName("127.0.0.1"));
public static Thread startServer(boolean autoClose) throws IOException { final ConsoleApplication app = ConsoleTestApplication
if (SHELL == null) { .create(output, input, manager);
SHELL = new SocketConsoleApplicationShell(3300, autoClose, SHELL.setInterface(new SocketConsoleInterface(input, output));
ConsoleTestApplication.EXIT, Charset.forName("UTF-8")); SHELL.setConnexionManager(manager);
final ConsoleApplication app = ConsoleTestApplication SHELL.setApplication(app);
.create(SHELL.getConsoleManager()); final Thread th = new Thread(new Runnable() {
SHELL.setApplication(app);
server = null; @Override
} public void run() {
return getServer(); app.start();
} }
});
public static Thread startServer(String closeConnection) throws IOException { th.start();
if (SHELL == null) { }
SHELL = new SocketConsoleApplicationShell(3300, closeConnection, return SHELL;
ConsoleTestApplication.EXIT, Charset.forName("UTF-8")); }
final ConsoleApplication app = ConsoleTestApplication
.create(SHELL.getConsoleManager()); /** @param args no argument
SHELL.setApplication(app); * @throws IOException if the server starting failed */
server = null; public static void main(final String... args) throws IOException {
} try {
return getServer(); getServer().join();
} } catch (final InterruptedException e) {
e.printStackTrace();
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;
*/ /** The cmd prefix in the output console. */
private static final int LAYOUT_NB_COLUMNS = 2; private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$
/** The cmd prefix in the output console */ /** The class logger. */
private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$ private static final Logger LOGGER = Logger
/** The class 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();
promptLock.wait(); while (prompting) {
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,60 +372,54 @@ 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);
} }
/** /**
* *
*/ */
public void validateCommand() { public void validateCommand() {
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() {
/* (non-Javadoc) consoleInput.setEnabled(false);
* @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,16 +47,17 @@ 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 */
private final class ToSWTConsoleForwardRunnable private final class ToSWTConsoleForwardRunnable
extends AOutputForwardRunnable { extends AOutputForwardRunnable {
@@ -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,88 +1,80 @@
<!-- Copyright Bigeon Emmanuel (2014) --> <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>
<!-- emmanuel@bigeon.fr --> <artifactId>gclc</artifactId>
<!-- --> <version>2.0.7</version>
<!-- This software is a computer program whose purpose is to --> <packaging>jar</packaging>
<!-- provide a generic framework for console applications. --> <url>http://bigeon.net</url>
<!-- --> <properties>
<!-- This software is governed by the CeCILL license under French law and --> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- abiding by the rules of distribution of free software. You can use, --> <project.scm.id>git.code.bigeon.net</project.scm.id>
<!-- modify and/or redistribute the software under the terms of the CeCILL --> <copyright.email>emmanuel@bigeon.fr</copyright.email>
<!-- license as circulated by CEA, CNRS and INRIA at the following URL --> <license.licenseName>cecill_2.1</license.licenseName>
<!-- "http://www.cecill.info". --> </properties>
<!-- --> <dependencies>
<!-- As a counterpart to the access to the source code and rights to copy, --> <dependency>
<!-- modify and redistribute granted by the license, users are provided only --> <groupId>junit</groupId>
<!-- with a limited warranty and the software's author, the holder of the --> <artifactId>junit</artifactId>
<!-- economic rights, and the successive licensors have only limited --> <version>4.11</version>
<!-- liability. --> <scope>test</scope>
<!-- --> </dependency>
<!-- In this respect, the user's attention is drawn to the risks associated --> </dependencies>
<!-- with loading, using, modifying and/or developing or reproducing the --> <parent>
<!-- software by the user in light of its specific status of free software, --> <groupId>net.bigeon.config</groupId>
<!-- that may mean that it is complicated to manipulate, and that also --> <artifactId>ebigeon-config</artifactId>
<!-- therefore means that it is reserved for developers and experienced --> <version>1.8.3</version>
<!-- professionals having in-depth computer knowledge. Users are therefore --> </parent>
<!-- encouraged to load and test the software's suitability as regards their --> <build>
<!-- requirements in conditions enabling the security of their systems and/or --> <plugins>
<!-- data to be ensured and, more generally, to use and operate it in the --> <plugin>
<!-- same conditions as regards security. --> <groupId>org.codehaus.mojo</groupId>
<!-- --> <artifactId>license-maven-plugin</artifactId>
<!-- The fact that you are presently reading this means that you have had --> <configuration>
<!-- knowledge of the CeCILL license and that you accept its terms. --> <extraExtensions>
<gclc>properties</gclc>
<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"> <txt>properties</txt>
<modelVersion>4.0.0</modelVersion> </extraExtensions>
<artifactId>gclc</artifactId> </configuration>
<version>2.0.0</version> </plugin>
<packaging>jar</packaging> </plugins>
<url>http://www.bigeon.fr/emmanuel</url> </build>
<properties> <licenses>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <license>
<project.scm.id>git.bigeon.net</project.scm.id> <distribution>manual</distribution>
</properties> <name>CeCILL 2.1</name>
<dependencies> <url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
<dependency> </license>
<groupId>junit</groupId> </licenses>
<artifactId>junit</artifactId> <reporting>
<version>4.11</version> <plugins>
<scope>test</scope> <plugin>
</dependency> <groupId>org.apache.maven.plugins</groupId>
</dependencies> <artifactId>maven-javadoc-plugin</artifactId>
<parent> <version>2.10.3</version>
<groupId>fr.bigeon</groupId> </plugin>
<artifactId>ebigeon-config</artifactId> <plugin>
<version>1.7.1</version> <groupId>com.github.sevntu-checkstyle</groupId>
</parent> <artifactId>dsm-maven-plugin</artifactId>
<build> <version>2.2.0</version>
<plugins> </plugin>
<plugin> </plugins>
<groupId>com.mycila</groupId> </reporting>
<artifactId>license-maven-plugin</artifactId> <developers>
<configuration> <developer>
<header>fr/bigeon/gclc/licensing/cecill/CeCILL-header.txt</header> <email>emmanuel@bigeon.fr</email>
<properties> <name>Emmanuel Bigeon</name>
<owner>Bigeon Emmanuel</owner> <url>bigeon.net</url>
<email>emmanuel@bigeon.fr</email> <roles>
</properties> <role>PM</role>
</configuration> </roles>
<executions> </developer>
<execution> </developers>
<goals> <inceptionYear>2014</inceptionYear>
<goal>check</goal> <name>Generic Command Ligne console</name>
</goals> <description>A generic framework for console applications, with customized command input and output streams.</description>
</execution> <scm>
</executions> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
</plugin> <tag>gclc-2.0.7</tag>
</plugins> </scm>
</build> <groupId>net.bigeon</groupId>
<inceptionYear>2014</inceptionYear> </project>
<name>Generic Command Ligne console</name>
<description>provide a generic framework for console applications</description>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>gclc-2.0.0</tag>
</scm>
</project>

View File

@@ -1,58 +1,59 @@
/* /**
* 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
* This software is governed by the CeCILL license under French law and * Generic Command Ligne console
* abiding by the rules of distribution of free software. You can use, * %%
* modify and/or redistribute the software under the terms of the CeCILL * Copyright (C) 2014 - 2018 Bigeon
* license as circulated by CEA, CNRS and INRIA at the following URL * %%
* "http://www.cecill.info". * This software is governed by the CeCILL license under French law and
* * abiding by the rules of distribution of free software. You can use,
* As a counterpart to the access to the source code and rights to copy, * modify and/ or redistribute the software under the terms of the CeCILL
* modify and redistribute granted by the license, users are provided only * license as circulated by CEA, CNRS and INRIA at the following URL
* with a limited warranty and the software's author, the holder of the * "http://www.cecill.info".
* economic rights, and the successive licensors have only limited *
* liability. * 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
* In this respect, the user's attention is drawn to the risks associated * with a limited warranty and the software's author, the holder of the
* with loading, using, modifying and/or developing or reproducing the * economic rights, and the successive licensors have only limited
* software by the user in light of its specific status of free software, * liability.
* that may mean that it is complicated to manipulate, and that also *
* therefore means that it is reserved for developers and experienced * In this respect, the user's attention is drawn to the risks associated
* professionals having in-depth computer knowledge. Users are therefore * with loading, using, modifying and/or developing or reproducing the
* encouraged to load and test the software's suitability as regards their * software by the user in light of its specific status of free software,
* requirements in conditions enabling the security of their systems and/or * that may mean that it is complicated to manipulate, and that also
* data to be ensured and, more generally, to use and operate it in the * therefore means that it is reserved for developers and experienced
* same conditions as regards security. * professionals having in-depth computer knowledge. Users are therefore
* * encouraged to load and test the software's suitability as regards their
* The fact that you are presently reading this means that you have had * requirements in conditions enabling the security of their systems and/or
* knowledge of the CeCILL license and that you accept its terms. * data to be ensured and, more generally, to use and operate it in the
*/ * same conditions as regards security.
/** *
* gclc:fr.bigeon.gclc.ApplicationAttachement.java * The fact that you are presently reading this means that you have had
* Created on: Apr 19, 2017 * knowledge of the CeCILL license and that you accept its terms.
*/ * #L%
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.
* @author Emmanuel Bigeon */ *
public interface ApplicationAttachement { * @author Emmanuel Bigeon */
/** Attach this object to a console application. public interface ApplicationAttachement {
* <p> /** Attach this object to a console application.
* The attaching usually consist in the addition of commands in the console * <p>
* application. The attached command should be specific to the attachement * The attaching usually consist in the addition of commands in the console
* (typically, the generic help command or the script command should not be * application. The attached command should be specific to the attachement
* added through this mechanism). * (typically, the generic help command or the script command should not be
* * added through this mechanism).
* @param application the application *
* @throws InvalidCommandName if a command name is invalid for the * @param application the application
* application. */ * @throws InvalidCommandName if a command name is invalid for the
void attach(ConsoleApplication application) throws InvalidCommandName; * application. */
} void attach(ICommandProvider application) throws InvalidCommandName;
}

View File

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

View File

@@ -1,261 +1,294 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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;
import java.io.IOException; /*-
import java.io.InterruptedIOException; * #%L
import java.util.ArrayList; * Generic Command Ligne console
import java.util.Arrays; * %%
import java.util.List; * Copyright (C) 2014 - 2018 bigeon.fr
import java.util.logging.Level; * %%
import java.util.logging.Logger; * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
import fr.bigeon.gclc.command.ICommand; * modify and/ or redistribute the software under the terms of the CeCILL
import fr.bigeon.gclc.command.ICommandProvider; * license as circulated by CEA, CNRS and INRIA at the following URL
import fr.bigeon.gclc.command.SubedCommand; * "http://www.cecill.info".
import fr.bigeon.gclc.exception.CommandParsingException; *
import fr.bigeon.gclc.exception.CommandRunException; * As a counterpart to the access to the source code and rights to copy,
import fr.bigeon.gclc.exception.CommandRunExceptionType; * modify and redistribute granted by the license, users are provided only
import fr.bigeon.gclc.exception.InvalidCommandName; * with a limited warranty and the software's author, the holder of the
import fr.bigeon.gclc.i18n.Messages; * economic rights, and the successive licensors have only limited
import fr.bigeon.gclc.manager.ConsoleInput; * liability.
import fr.bigeon.gclc.manager.ConsoleOutput; *
* In this respect, the user's attention is drawn to the risks associated
/** * with loading, using, modifying and/or developing or reproducing the
* A {@link ConsoleApplication} is an application that require the user to input * software by the user in light of its specific status of free software,
* commands. * that may mean that it is complicated to manipulate, and that also
* <p> * therefore means that it is reserved for developers and experienced
* A typical use case is the following: * professionals having in-depth computer knowledge. Users are therefore
* * encouraged to load and test the software's suitability as regards their
* <pre> * requirements in conditions enabling the security of their systems and/or
* {@link ConsoleOutput} out = new {@link fr.bigeon.gclc.manager.StreamConsoleOutput StreamConsoleOutput}(); * data to be ensured and, more generally, to use and operate it in the
* {@link ConsoleInput} in = new {@link fr.bigeon.gclc.manager.StreamConsoleInput StreamConsoleInput}(); * same conditions as regards security.
* {@link ConsoleApplication} app = new {@link ConsoleApplication}(out, in, "welcome", "see you latter")}; *
* app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()}); * The fact that you are presently reading this means that you have had
* app.{@link ConsoleApplication#start() start()}; * knowledge of the CeCILL license and that you accept its terms.
* </pre> * #L%
* <p> */
* That will launch in the console application that will display "welcome", import java.io.IOException;
* return a line and prompt the user for the command until he inputs the import java.io.InterruptedIOException;
* <code>exit</code> command. Then it will print "see you latter" and exit the import java.util.ArrayList;
* start method. import java.util.Arrays;
* import java.util.List;
* @author Emmanuel BIGEON */ import java.util.logging.Level;
public final class ConsoleApplication implements ICommandProvider { import java.util.logging.Logger;
/** The class logger. */ import net.bigeon.gclc.command.ICommand;
private static final Logger LOGGER = Logger import net.bigeon.gclc.command.ICommandProvider;
.getLogger(ConsoleApplication.class.getName()); import net.bigeon.gclc.command.SubedCommand;
/** The welcome message. */ import net.bigeon.gclc.exception.CommandParsingException;
public final String header; import net.bigeon.gclc.exception.CommandRunException;
/** The good bye message. */ import net.bigeon.gclc.exception.CommandRunExceptionType;
public final String footer; import net.bigeon.gclc.exception.InvalidCommandName;
/** The standard output for the application. */ import net.bigeon.gclc.i18n.Messages;
private final ConsoleOutput out; import net.bigeon.gclc.manager.ConsoleInput;
/** The standard input for the application. */ import net.bigeon.gclc.manager.ConsoleOutput;
private final ConsoleInput in;
/** The container of commands. */ /**
public final SubedCommand root; * A {@link ConsoleApplication} is an application that require the user to input
/** The state of this application. */ * commands.
private boolean running; * <p>
/** The listeners. */ * A typical use case is the following:
private final List<CommandRequestListener> listeners = new ArrayList<>(); *
* <pre>
/** Create a console application. * {@link ConsoleOutput} out = new {@link net.bigeon.gclc.utils.StreamConsoleOutput StreamConsoleOutput}();
* * {@link ConsoleInput} in = new {@link net.bigeon.gclc.utils.StreamConsoleInput StreamConsoleInput}();
* @param out the output * {@link ConsoleApplication} app = new {@link ConsoleApplication}(out, in, "welcome", "see you latter")};
* @param in the input * app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()});
* @param welcome the welcoming message * app.{@link ConsoleApplication#start() start()};
* @param goodbye the goodbye message */ * </pre>
public ConsoleApplication(final ConsoleOutput out, final ConsoleInput in, * <p>
final String welcome, * That will launch in the console application that will display "welcome",
final String goodbye) { * return a line and prompt the user for the command until he inputs the
header = welcome; * <code>exit</code> command. Then it will print "see you latter" and exit the
footer = goodbye; * start method.
this.in = in; *
this.out = out; * @author Emmanuel BIGEON */
root = new SubedCommand(""); //$NON-NLS-1$ public final class ConsoleApplication implements ICommandProvider {
}
/** The class logger. */
@Override private static final Logger LOGGER = Logger
public boolean add(final ICommand cmd) throws InvalidCommandName { .getLogger(ConsoleApplication.class.getName());
return root.add(cmd); /** The welcome message. */
} public final String header;
/** The good bye message. */
/** Add a listener for command requests. public final String footer;
* /** The standard output for the application. */
* @param listener the command listener */ private final ConsoleOutput out;
public void addListener(final CommandRequestListener listener) { /** The standard input for the application. */
listeners.add(listener); private final ConsoleInput in;
} /** The container of commands. */
public final SubedCommand root;
/* (non-Javadoc) /** The state of this application. */
* @see fr.bigeon.gclc.command.ICommandProvider#executeSub(java.lang.String, private boolean running;
* java.lang.String[]) */ /** The listeners. */
@Override private final List<CommandRequestListener> listeners = new ArrayList<>();
public void executeSub(final ConsoleOutput output, final ConsoleInput input,
final String command, /** Create a console application.
final String... args) throws CommandRunException { *
root.executeSub(output, input, command, args); * @param out the output
} * @param in the input
* @param welcome the welcoming message
/** Signify to the application that no command should be inputed anymore. */ * @param goodbye the goodbye message */
public void exit() { public ConsoleApplication(final ConsoleOutput out, final ConsoleInput in,
LOGGER.fine("Request exiting application..."); //$NON-NLS-1$ final String welcome,
running = false; final String goodbye) {
in.interruptPrompt(); header = welcome;
} footer = goodbye;
this.in = in;
/* (non-Javadoc) this.out = out;
* @see fr.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */ root = new SubedCommand(""); //$NON-NLS-1$
@Override }
public ICommand get(final String command) {
return root.get(command); @Override
} public boolean add(final ICommand cmd) throws InvalidCommandName {
return root.add(cmd);
/** Interpret a command line. }
* <p>
* This method will split the command in its part and execute the command /** Add a listener for command requests.
* with {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}. *
* * @param listener the command listener */
* @param cmd the command public void addListener(final CommandRequestListener listener) {
* @throws IOException if the command could not be parsed */ listeners.add(listener);
public void interpretCommand(final String cmd) throws IOException { }
List<String> args;
try { /* (non-Javadoc)
args = GCLCConstants.splitCommand(cmd); * @see net.bigeon.gclc.command.ICommandProvider#executeSub(java.lang.String,
} catch (final CommandParsingException e1) { * java.lang.String[]) */
out.println("Command line cannot be parsed"); //$NON-NLS-1$ @Override
LOGGER.log(Level.FINE, "Invalid user command " + cmd, e1); //$NON-NLS-1$ public void executeSub(final ConsoleOutput output, final ConsoleInput input,
return; final String command,
} final String... args) throws CommandRunException {
if (!args.isEmpty()) { root.executeSub(output, input, command, args);
try { }
executeSub(out, in, args.get(0), Arrays.copyOfRange(
args.toArray(new String[0]), 1, args.size())); /** Signify to the application that no command should be inputed anymore. */
} catch (final CommandRunException e) { public void exit() {
LOGGER.log(Level.FINE, "Command failed: " + cmd, e); //$NON-NLS-1$ LOGGER.fine("Request exiting application..."); //$NON-NLS-1$
out.println(Messages running = false;
.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$ in.interruptPrompt();
out.println(e.getLocalizedMessage()); }
if (e.getType() == CommandRunExceptionType.USAGE) {
e.getSource().help(out); /* (non-Javadoc)
} * @see net.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */
} @Override
} public ICommand get(final String command) {
} return root.get(command);
}
/** Test if the application is running.
* /** Interpret a command line.
* @return the running status */ * <p>
public boolean isRunning() { * This method will split the command in its part and execute the command
return running; * with {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}.
} *
* @param cmd the command
/** Remove a listener from this application. * @throws IOException if the command could not be parsed */
* public void interpretCommand(final String cmd) throws IOException {
* @param listener the command listener to remove */ List<String> args;
public void removeListener(final CommandRequestListener listener) { try {
listeners.remove(listener); args = GCLCConstants.splitCommand(cmd);
} } catch (final CommandParsingException e1) {
out.println("Command line cannot be parsed"); //$NON-NLS-1$
/** The running loop content. LOGGER.log(Level.FINE, "Invalid user command " + cmd, e1); //$NON-NLS-1$
* <p> return;
* This consisting in getting the command, executing it and exiting }
* (restarting the loop). */ if (!args.isEmpty()) {
private void runLoop() { try {
try { executeSub(out, in, args.get(0), Arrays.copyOfRange(
final String cmd = in.prompt(); args.toArray(new String[0]), 1, args.size()));
if (cmd == null || cmd.isEmpty()) { } catch (final CommandRunException e) {
return; LOGGER.log(Level.FINE, "Command failed: " + cmd, e); //$NON-NLS-1$
} out.println(Messages
for (final CommandRequestListener listener : listeners) { .getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
listener.commandRequest(cmd); out.println(e.getLocalizedMessage());
} if (e.getType() == CommandRunExceptionType.USAGE) {
interpretCommand(cmd); get(args.get(0)).help(out);
} catch (final InterruptedIOException e) { }
LOGGER.info( }
"Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$ }
LOGGER.log(Level.FINER, "Interruption of the prompt.", //$NON-NLS-1$ }
e);
} catch (final IOException e) { /** Test if the application is running.
// The manager was closed *
running = false; * @return the running status */
LOGGER.warning( public boolean isRunning() {
"The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$ return running;
LOGGER.log(Level.FINE, }
"An exception caused the closing of the application", //$NON-NLS-1$
e); /** Remove a listener from this application.
} *
} * @param listener the command listener to remove */
public void removeListener(final CommandRequestListener listener) {
/** Start the application. */ listeners.remove(listener);
public void start() { }
try {
running = true; /** The running loop content.
if (header != null) { * <p>
out.println(header); * This consisting in getting the command, executing it and exiting
} * (restarting the loop). */
} catch (final IOException e) { private void runLoop() {
// The manager was closed try {
running = false; final String cmd = in.prompt();
LOGGER.warning( if (cmd == null || cmd.isEmpty()) {
"The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$ return;
LOGGER.log(Level.FINE, }
"An exception caused the closing of the application", //$NON-NLS-1$ for (final CommandRequestListener listener : listeners) {
e); listener.commandRequest(cmd);
return; }
} interpretCommand(cmd);
do { } catch (final InterruptedIOException e) {
runLoop(); LOGGER.info(
} while (running); "Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
if (footer != null) { LOGGER.log(Level.FINER, "Interruption of the prompt.", //$NON-NLS-1$
try { e);
out.println(footer); } catch (final IOException e) {
} catch (final IOException e) { // The manager was closed
// The manager was closed running = false;
running = false; LOGGER.warning(
LOGGER.warning("Console manager alreaady closed."); //$NON-NLS-1$ "The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
LOGGER.log(Level.FINE, LOGGER.log(Level.FINE,
"Exception raised by goodbye message printing... Application will still close.", //$NON-NLS-1$ "An exception caused the closing of the application", //$NON-NLS-1$
e); e);
} }
} }
running = false;
LOGGER.fine("Exiting application."); //$NON-NLS-1$ /** Start the application. */
} public void start() {
} try {
running = true;
if (header != null) {
out.println(header);
}
} catch (final IOException e) {
// The manager was closed
running = false;
LOGGER.warning(
"The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"An exception caused the closing of the application", //$NON-NLS-1$
e);
return;
}
do {
runLoop();
} while (running);
if (footer != null) {
try {
out.println(footer);
} catch (final IOException e) {
// The manager was closed
running = false;
LOGGER.warning("Console manager alreaady closed."); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"Exception raised by goodbye message printing... Application will still close.", //$NON-NLS-1$
e);
}
}
running = false;
LOGGER.fine("Exiting application."); //$NON-NLS-1$
}
}

View File

@@ -1,143 +1,176 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
import java.util.ArrayList; /*-
import java.util.List; * #%L
* Generic Command Ligne console
import fr.bigeon.gclc.exception.CommandParsingException; * %%
* Copyright (C) 2014 - 2018 bigeon.fr
/** A Utility class for GCLC * %%
* <p> * This software is governed by the CeCILL license under French law and
* This class offers a method to split a line or arguments into the list of * abiding by the rules of distribution of free software. You can use,
* arguments. * modify and/ or redistribute the software under the terms of the CeCILL
* * license as circulated by CEA, CNRS and INRIA at the following URL
* @author Emmanuel Bigeon */ * "http://www.cecill.info".
public final class GCLCConstants { *
* As a counterpart to the access to the source code and rights to copy,
/** The escaping character. */ * modify and redistribute granted by the license, users are provided only
private static final char ESCAPING_CHAR = getSystemEscapingChar(); * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
/** Hide utility class constructor. */ * liability.
private GCLCConstants() { *
// utility class * 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,
/** Get the end of a string argument. * that may mean that it is complicated to manipulate, and that also
* * therefore means that it is reserved for developers and experienced
* @param cmd the command to parse * professionals having in-depth computer knowledge. Users are therefore
* @param startIndex the starting point of the parsing * encouraged to load and test the software's suitability as regards their
* @param index the index of the current position * requirements in conditions enabling the security of their systems and/or
* @return the argument * data to be ensured and, more generally, to use and operate it in the
* @throws CommandParsingException if the end of string does not mark end of * same conditions as regards security.
* command and is not followed by a space */ *
private static String endOfString(final String cmd, final int startIndex, * The fact that you are presently reading this means that you have had
final int index) throws CommandParsingException { * knowledge of the CeCILL license and that you accept its terms.
if (index < cmd.length() && cmd.charAt(index) != ' ') { * #L%
throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$ */
} import java.util.ArrayList;
return cmd.substring(startIndex + 1, index - 1); import java.util.List;
}
import net.bigeon.gclc.exception.CommandParsingException;
/** Get the excaping character.
* /** A Utility class for GCLC
* @return the escaping character */ * <p>
private static char getSystemEscapingChar() { * This class offers a method to split a line or arguments into the list of
return '\\'; * arguments.
} *
* @author Emmanuel Bigeon */
/** Remove escaping characters from the string. public final class GCLCConstants {
*
* @param arg the string to remove excaping character from /** The escaping character. */
* @return the string without escape character */ private static final char ESCAPING_CHAR = getSystemEscapingChar();
private static String removeEscaped(final String arg) {
final StringBuilder builder = new StringBuilder(); /** Hide utility class constructor. */
int index = 0; private GCLCConstants() {
int endIndex = arg.indexOf(ESCAPING_CHAR); // utility class
while (endIndex != -1) { }
builder.append(arg.subSequence(index, endIndex));
index = endIndex + 1; /** Get the end of a string argument.
endIndex = arg.indexOf(ESCAPING_CHAR, index + 1); *
} * @param cmd the command to parse
builder.append(arg.substring(index)); * @param startIndex the starting point of the parsing
return builder.toString(); * @param index the index of the current position
} * @return the argument
* @throws CommandParsingException if the end of string does not mark end of
/** Splits a command in the diferrent arguments. * command and is not followed by a space */
* private static String endOfString(final String cmd, final int startIndex,
* @param cmd the command to split in its parts final int index) throws CommandParsingException {
* @return the list of argument preceded by the command name if (index < cmd.length() && cmd.charAt(index) != ' ') {
* @throws CommandParsingException if the parsing of the command failed */ throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$
public static List<String> splitCommand(final String cmd) throws CommandParsingException { }
final List<String> args = new ArrayList<>(); return cmd.substring(startIndex + 1, index - 1);
// parse the string to separate arguments }
int index = 0;
int startIndex = 0; /** Get the excaping character.
boolean escaped = false; *
boolean inString = false; * @return the escaping character */
while (index < cmd.length()) { private static char getSystemEscapingChar() {
final char c = cmd.charAt(index); return '\\';
index++; }
if (escaped || c == ESCAPING_CHAR) {
escaped = !escaped; /** Remove escaping characters from the string.
continue; *
} * @param arg the string to remove excaping character from
if (c == ' ' && !inString) { * @return the string without escape character */
final String arg = cmd.substring(startIndex, index - 1); private static String removeEscaped(final String arg) {
if (!arg.isEmpty()) { final StringBuilder builder = new StringBuilder();
args.add(removeEscaped(arg)); int index = 0;
} int endIndex = arg.indexOf(ESCAPING_CHAR);
startIndex = index; while (endIndex != -1) {
} else if (c == '"') { builder.append(arg.subSequence(index, endIndex));
if (inString) { index = endIndex + 1;
args.add(endOfString(cmd, startIndex, index)); endIndex = arg.indexOf(ESCAPING_CHAR, index + 1);
index++; }
startIndex = index; builder.append(arg.substring(index));
} return builder.toString();
inString = startIndex == index - 1; }
}
} /** Splits a command in the diferrent arguments.
if (startIndex < cmd.length()) { *
final String arg = cmd.substring(startIndex, cmd.length()); * @param cmd the command to split in its parts
args.add(arg); * @return the list of argument preceded by the command name
} * @throws CommandParsingException if the parsing of the command failed */
return args; public static List<String> splitCommand(final String cmd) throws CommandParsingException {
} final List<String> args = new ArrayList<>();
// parse the string to separate arguments
} int index = 0;
int startIndex = 0;
boolean escaped = false;
boolean inString = false;
while (index < cmd.length()) {
final char c = cmd.charAt(index);
index++;
if (escaped || c == ESCAPING_CHAR) {
escaped = !escaped;
continue;
}
if (c == ' ' && !inString) {
final String arg = cmd.substring(startIndex, index - 1);
if (!arg.isEmpty()) {
args.add(removeEscaped(arg));
}
startIndex = index;
} else if (c == '"') {
if (inString) {
args.add(endOfString(cmd, startIndex, index));
index++;
startIndex = index;
}
inString = startIndex == index - 1;
}
}
if (startIndex < cmd.length()) {
final String arg = cmd.substring(startIndex, cmd.length());
args.add(arg);
}
return args;
}
}

View File

@@ -1,149 +1,148 @@
/* /**
* 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
* This software is governed by the CeCILL license under French law and * Generic Command Ligne console
* abiding by the rules of distribution of free software. You can use, * %%
* modify and/or redistribute the software under the terms of the CeCILL * Copyright (C) 2014 - 2018 bigeon.fr
* license as circulated by CEA, CNRS and INRIA at the following URL * %%
* "http://www.cecill.info". * This software is governed by the CeCILL license under French law and
* * abiding by the rules of distribution of free software. You can use,
* As a counterpart to the access to the source code and rights to copy, * modify and/ or redistribute the software under the terms of the CeCILL
* modify and redistribute granted by the license, users are provided only * license as circulated by CEA, CNRS and INRIA at the following URL
* with a limited warranty and the software's author, the holder of the * "http://www.cecill.info".
* economic rights, and the successive licensors have only limited *
* liability. * 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
* In this respect, the user's attention is drawn to the risks associated * with a limited warranty and the software's author, the holder of the
* with loading, using, modifying and/or developing or reproducing the * economic rights, and the successive licensors have only limited
* software by the user in light of its specific status of free software, * liability.
* that may mean that it is complicated to manipulate, and that also *
* therefore means that it is reserved for developers and experienced * In this respect, the user's attention is drawn to the risks associated
* professionals having in-depth computer knowledge. Users are therefore * with loading, using, modifying and/or developing or reproducing the
* encouraged to load and test the software's suitability as regards their * software by the user in light of its specific status of free software,
* requirements in conditions enabling the security of their systems and/or * that may mean that it is complicated to manipulate, and that also
* data to be ensured and, more generally, to use and operate it in the * therefore means that it is reserved for developers and experienced
* same conditions as regards security. * professionals having in-depth computer knowledge. Users are therefore
* * encouraged to load and test the software's suitability as regards their
* The fact that you are presently reading this means that you have had * requirements in conditions enabling the security of their systems and/or
* knowledge of the CeCILL license and that you accept its terms. * data to be ensured and, more generally, to use and operate it in the
*/ * same conditions as regards security.
/** *
* acide:fr.bigeon.acide.Command.java * The fact that you are presently reading this means that you have had
* Created on: Jul 31, 2014 * knowledge of the CeCILL license and that you accept its terms.
*/ * #L%
package fr.bigeon.gclc.command; */
import java.io.IOException;
import java.io.IOException;
import net.bigeon.gclc.manager.ConsoleOutput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** A command to execute.
/** A command to execute. * <p>
* <p> * It is mandatory that it has a name and that name cannot start with minus
* It is mandatory that it has a name and that name cannot start with minus * character or contain spaces.
* character or contain spaces. * <p>
* <p> * A command can be executed, with parameters that will be provided as an array
* A command can be executed, with parameters that will be provided as an array * of strings.
* of strings. * <p>
* <p> * The help mechanism is doing the following:
* The help mechanism is doing the following: * <ul>
* <ul> * <li>Print the command name
* <li>Print the command name * <li>Print the {@link #brief()} message
* <li>Print the {@link #brief()} message * <li>Print a blank line
* <li>Print a blank line * <li>Print "Usage:"
* <li>Print "Usage:" * <li>Print the {@link #usagePattern() usage pattern}
* <li>Print the {@link #usagePattern() usage pattern} * <li>Print the {@link #usageDetail() usage details}
* <li>Print the {@link #usageDetail() usage details} * </ul>
* </ul> * <p>
* <p> * The default behavior for the brief message is to print the tip preceeded by a
* The default behavior for the brief message is to print the tip preceeded by a * couple of spaces.
* couple of spaces. *
* * @author Emmanuel BIGEON */
* @author Emmanuel BIGEON */ public abstract class Command implements ICommand {
public abstract class Command implements ICommand {
/** The linux end of line character. */
/** The linux end of line character. */ private static final String EOL_LINUX = "\n"; //$NON-NLS-1$
private static final String EOL_LINUX = "\n"; //$NON-NLS-1$ /** The name of the command. */
/** The name of the command. */ protected final String name;
protected final String name;
/** Create the command.
/** Create the command. *
* * @param name the command name */
* @param name the command name */ public Command(final String name) {
public Command(final String name) { super();
super(); this.name = name;
this.name = name; }
}
/** Get the brief part of the command help.
/** Get the brief part of the command help. * <p>
* <p> * This method may be overriden by implementations to improve the help
* This method may be overriden by implementations to improve the help * content. The default behavior is to print the tip.
* content. The default behavior is to print the tip. *
* * @return a brief description of the command
* @return a brief description of the command * @see Command#help(ConsoleOutput, String...) */
* @see Command#help(ConsoleOutput, String...) */ protected String brief() {
protected String brief() { return " " + tip(); //$NON-NLS-1$
return " " + tip(); //$NON-NLS-1$ }
}
/* (non-Javadoc)
/* (non-Javadoc) * @see net.bigeon.gclc.command.ICommand#getCommandName() */
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ @Override
@Override public final String getCommandName() {
public final String getCommandName() { return name;
return name; }
}
/** Prints a help content for this command to the console output.
/** Prints a help content for this command to the console output. * <p>
* <p> * This help is following the given format:
* This help is following the given format: *
* * <pre>
* <pre> * [Command name]
* [Command name] * [brief message]
* [brief message] *
* * Usage:
* Usage: * [Usage pattern]
* [Usage pattern] *
* * [Usage details]
* [Usage details] * </pre>
* </pre> *
* * @see net.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */
* @see fr.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 { manager.println(getCommandName());
manager.println(getCommandName()); manager.println(brief());
manager.println(brief()); manager.println();
manager.println(); manager.println("Usage:"); //$NON-NLS-1$
manager.println("Usage:"); //$NON-NLS-1$ manager.println(usagePattern());
manager.println(usagePattern()); manager.println();
manager.println(); final String details = usageDetail();
final String details = usageDetail(); if (details != null && !details.isEmpty()) {
if (details != null && !details.isEmpty()) { manager.print(details);
manager.print(details); if (!(details.endsWith(EOL_LINUX) ||
if (!(details.endsWith(EOL_LINUX) || details.endsWith(System.lineSeparator()))) {
details.endsWith(System.lineSeparator()))) { manager.println();
manager.println(); }
} }
} }
}
/** This method return the detail of the help.
/** This method return the detail of the help. * <p>
* <p> * It immediatly follows the {@link #usagePattern() usage pattern}.
* It immediatly follows the {@link #usagePattern() usage pattern}. *
* * @return the detailed help (should end with end of line or be empty) */
* @return the detailed help (should end with end of line or be empty) */ protected abstract String usageDetail();
protected abstract String usageDetail();
/** This prints the usage pattern for the command.
/** This prints the usage pattern for the command. * <p>
* <p> * It follows the brief introduction on the command ({@link #brief()})
* It follows the brief introduction on the command ({@link #brief()}) *
* * @return the usage pattern */
* @return the usage pattern */ protected String usagePattern() {
protected String usagePattern() { return getCommandName();
return getCommandName(); }
} }
}

View File

@@ -1,210 +1,213 @@
/* /**
* 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
* This software is governed by the CeCILL license under French law and * Generic Command Ligne console
* abiding by the rules of distribution of free software. You can use, * %%
* modify and/or redistribute the software under the terms of the CeCILL * Copyright (C) 2014 - 2018 bigeon.fr
* license as circulated by CEA, CNRS and INRIA at the following URL * %%
* "http://www.cecill.info". * This software is governed by the CeCILL license under French law and
* * abiding by the rules of distribution of free software. You can use,
* As a counterpart to the access to the source code and rights to copy, * modify and/ or redistribute the software under the terms of the CeCILL
* modify and redistribute granted by the license, users are provided only * license as circulated by CEA, CNRS and INRIA at the following URL
* with a limited warranty and the software's author, the holder of the * "http://www.cecill.info".
* economic rights, and the successive licensors have only limited *
* liability. * 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
* In this respect, the user's attention is drawn to the risks associated * with a limited warranty and the software's author, the holder of the
* with loading, using, modifying and/or developing or reproducing the * economic rights, and the successive licensors have only limited
* software by the user in light of its specific status of free software, * liability.
* that may mean that it is complicated to manipulate, and that also *
* therefore means that it is reserved for developers and experienced * In this respect, the user's attention is drawn to the risks associated
* professionals having in-depth computer knowledge. Users are therefore * with loading, using, modifying and/or developing or reproducing the
* encouraged to load and test the software's suitability as regards their * software by the user in light of its specific status of free software,
* requirements in conditions enabling the security of their systems and/or * that may mean that it is complicated to manipulate, and that also
* data to be ensured and, more generally, to use and operate it in the * therefore means that it is reserved for developers and experienced
* same conditions as regards security. * professionals having in-depth computer knowledge. Users are therefore
* * encouraged to load and test the software's suitability as regards their
* The fact that you are presently reading this means that you have had * requirements in conditions enabling the security of their systems and/or
* knowledge of the CeCILL license and that you accept its terms. * data to be ensured and, more generally, to use and operate it in the
*/ * same conditions as regards security.
/** *
* gclc:fr.bigeon.gclc.command.CommandParameters.java * The fact that you are presently reading this means that you have had
* Created on: Dec 24, 2014 * knowledge of the CeCILL license and that you accept its terms.
*/ * #L%
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; import java.util.List;
import java.util.List; import java.util.Map;
import java.util.Map; import java.util.Set;
import java.util.Set;
import net.bigeon.gclc.exception.CommandParsingException;
import fr.bigeon.gclc.exception.CommandParsingException;
/** An object representing a collection of parameters.
/** An object representing a collection of parameters. * <p>
* <p> * It is used for defaulting values.
* It is used for defaulting values. *
* * @author Emmanuel BIGEON */
* @author Emmanuel BIGEON */ public final class CommandParameters {
public final class CommandParameters { /** Number of element for a string argument. */
/** Number of element for a string argument. */ private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2;
private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2; /** Boolean arguments. */
/** Boolean arguments. */ private final Map<String, Boolean> booleanArguments = new HashMap<>();
private final Map<String, Boolean> booleanArguments = new HashMap<>(); /** String arguments. */
/** String arguments. */ private final Map<String, String> stringArguments = new HashMap<>();
private final Map<String, String> stringArguments = new HashMap<>(); /** Arguments restriction on the named ones. */
/** Arguments restriction on the named ones. */ private final boolean strict;
private final boolean strict; /** additional (unnamed) parameters. */
/** additional (unnamed) parameters. */ private final List<String> additional = new ArrayList<>();
private final List<String> additional = new ArrayList<>();
/** Create a command parameter object.
/** Create a command parameter object. *
* * @param bools the boolean parameters
* @param bools the boolean parameters * @param strings the string parameters
* @param strings the string parameters * @param strict if the argument are restricted to the declared ones */
* @param strict if the argument are restricted to the declared ones */ public CommandParameters(final Set<String> bools, final Set<String> strings,
public CommandParameters(final Set<String> bools, final Set<String> strings, final boolean strict) {
final boolean strict) { for (final String string : bools) {
for (final String string : bools) { booleanArguments.put(string, Boolean.FALSE);
booleanArguments.put(string, Boolean.FALSE); }
} for (final String string : strings) {
for (final String string : strings) { stringArguments.put(string, null);
stringArguments.put(string, null); }
} this.strict = strict;
this.strict = strict; }
}
/** Get the value of a string argument.
/** Get the value of a string argument. *
* * @param key the key
* @param key the key * @return the associated value, null if it was not specified */
* @return the associated value, null if it was not specified */ public String get(final String key) {
public String get(final String key) { return stringArguments.get(key);
return stringArguments.get(key); }
}
/** Get the additional (unrecognized) arguments.
/** Get the additional (unrecognized) arguments. *
* * @return additional non parsed parameters */
* @return additional non parsed parameters */ public List<String> getAdditionals() {
public List<String> getAdditionals() { return Collections.unmodifiableList(additional);
return Collections.unmodifiableList(additional); }
}
/** Get the value of a boolean argument.
/** Get the value of a boolean argument. *
* * @param key the key
* @param key the key * @return if the key was specified */
* @return if the key was specified */ public boolean getBool(final String key) {
public boolean getBool(final String key) { return booleanArguments.containsKey(key) &&
return booleanArguments.containsKey(key) && booleanArguments.get(key).booleanValue();
booleanArguments.get(key).booleanValue(); }
}
/** Get the boolean arguments.
/** Get the boolean arguments. *
* * @return the boolean arguments */
* @return the boolean arguments */ public Set<String> getBooleanArgumentKeys() {
public Set<String> getBooleanArgumentKeys() { return booleanArguments.keySet();
return booleanArguments.keySet(); }
}
/** Get the string arguments.
/** Get the string arguments. *
* * @return the boolean arguments */
* @return the boolean arguments */ public Set<String> getStringArgumentKeys() {
public Set<String> getStringArgumentKeys() { return stringArguments.keySet();
return stringArguments.keySet(); }
}
/** Test if an argument exists in this object.
/** Test if an argument exists in this object. *
* * @param key the key
* @param key the key * @return if the key is present in string arguments or boolean ones. */
* @return if the key is present in string arguments or boolean ones. */ public boolean hasArgument(final String key) {
public boolean hasArgument(final String key) { return stringArguments.containsKey(key) ||
return stringArguments.containsKey(key) || booleanArguments.containsKey(key);
booleanArguments.containsKey(key); }
}
/** Attempt to parse an argument.
/** Attempt to parse an argument. * <p>
* <p> * This method return 0 if the parsing was incorrect, or the number of
* This method return 0 if the parsing was incorrect, or the number of * parsed elements.
* parsed elements. *
* * @param arg the argument
* @param arg the argument * @param next the next element
* @param next the next element * @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$ if (strict) {
return strict ? 0 : 1; return 0;
} }
final String name = arg.substring(1); additional.add(arg);
if (booleanArguments.containsKey(name)) { return 1;
booleanArguments.put(name, Boolean.TRUE); }
return 1; final String name = arg.substring(1);
} if (booleanArguments.containsKey(name)) {
if (stringArguments.containsKey(name)) { booleanArguments.put(name, Boolean.TRUE);
return parseStringArg(name, next); return 1;
} }
if (strict) { if (stringArguments.containsKey(name)) {
return 0; return parseStringArg(name, next);
} }
additional.add(name); if (strict) {
return 1; return 0;
} }
additional.add(name);
/** Parse arguments. return 1;
* }
* @param args the arguments to parse
* @throws CommandParsingException if the arguments parsing failed */ /** Parse arguments.
public void parseArgs(final String... args) throws CommandParsingException { *
int i = 0; * @param args the arguments to parse
while (i < args.length) { * @throws CommandParsingException if the arguments parsing failed */
String next = null; public void parseArgs(final String... args) throws CommandParsingException {
if (i < args.length - 1) { int i = 0;
next = args[i + 1]; while (i < args.length) {
} String next = null;
final int p = parseArg(args[i], next); if (i < args.length - 1) {
if (p == 0) { next = args[i + 1];
throw new CommandParsingException( }
"Invalid parameter " + args[i]); //$NON-NLS-1$ final int p = parseArg(args[i], next);
} if (p == 0) {
i += p; throw new CommandParsingException(
} "Invalid parameter " + args[i]); //$NON-NLS-1$
}
} i += p;
}
/** Add a string arg value.
* }
* @param name the string arg name
* @param next the string arg value /** Add a string arg value.
* @return 2 or 0 if next is invalid */ *
private int parseStringArg(final String name, final String next) { * @param name the string arg name
if (next == null) { * @param next the string arg value
return 0; * @return 2 or 0 if next is invalid */
} private int parseStringArg(final String name, final String next) {
stringArguments.put(name, next); if (next == null) {
return STRINGARG_NUMBER_OF_ELEMENTS; return 0;
} }
stringArguments.put(name, next);
/** Set a boolean parameter value. return STRINGARG_NUMBER_OF_ELEMENTS;
* }
* @param string the key
* @param value the value */ /** Set a boolean parameter value.
public void set(final String string, final boolean value) { *
if (booleanArguments.containsKey(string)) { * @param string the key
booleanArguments.put(string, Boolean.valueOf(value)); * @param value the value */
} public void set(final String string, final boolean value) {
} if (booleanArguments.containsKey(string)) {
booleanArguments.put(string, Boolean.valueOf(value));
/** Set a string parameter value. }
* }
* @param string the key
* @param value the value */ /** Set a string parameter value.
public void set(final String string, final String value) { *
if (stringArguments.containsKey(string)) { * @param string the key
stringArguments.put(string, value); * @param value the value */
} public void set(final String string, final String value) {
} if (stringArguments.containsKey(string)) {
} stringArguments.put(string, value);
}
}
}

View File

@@ -1,125 +1,121 @@
/* /** 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
* * %%
* This software is governed by the CeCILL license under French law and * Copyright (C) 2014 - 2018 bigeon.fr
* abiding by the rules of distribution of free software. You can use, * %%
* modify and/or redistribute the software under the terms of the CeCILL * This software is governed by the CeCILL license under French law and
* license as circulated by CEA, CNRS and INRIA at the following URL * abiding by the rules of distribution of free software. You can use,
* "http://www.cecill.info". * modify and/ or redistribute the software under the terms of the CeCILL
* * license as circulated by CEA, CNRS and INRIA at the following URL
* As a counterpart to the access to the source code and rights to copy, * "http://www.cecill.info".
* modify and redistribute granted by the license, users are provided only *
* with a limited warranty and the software's author, the holder of the * As a counterpart to the access to the source code and rights to copy,
* economic rights, and the successive licensors have only limited * modify and redistribute granted by the license, users are provided only
* liability. * with a limited warranty and the software's author, the holder of the
* * economic rights, and the successive licensors have only limited
* In this respect, the user's attention is drawn to the risks associated * liability.
* with loading, using, modifying and/or developing or reproducing the *
* software by the user in light of its specific status of free software, * In this respect, the user's attention is drawn to the risks associated
* that may mean that it is complicated to manipulate, and that also * with loading, using, modifying and/or developing or reproducing the
* therefore means that it is reserved for developers and experienced * software by the user in light of its specific status of free software,
* professionals having in-depth computer knowledge. Users are therefore * that may mean that it is complicated to manipulate, and that also
* encouraged to load and test the software's suitability as regards their * therefore means that it is reserved for developers and experienced
* requirements in conditions enabling the security of their systems and/or * professionals having in-depth computer knowledge. Users are therefore
* data to be ensured and, more generally, to use and operate it in the * encouraged to load and test the software's suitability as regards their
* same conditions as regards security. * 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
* The fact that you are presently reading this means that you have had * same conditions as regards security.
* knowledge of the CeCILL license and that you accept its terms. *
*/ * The fact that you are presently reading this means that you have had
/** acide:fr.bigeon.acide.CommandProvider.java * knowledge of the CeCILL license and that you accept its terms.
* Created on: Aug 6, 2014 */ * #L%
package fr.bigeon.gclc.command; */
import java.util.ArrayList;
import java.util.ArrayList; import java.util.List;
import java.util.List;
import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.i18n.Messages;
import fr.bigeon.gclc.i18n.Messages; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleOutput;
import fr.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. *
* * @author Emmanuel BIGEON */
* @author Emmanuel BIGEON */ public class CommandProvider implements ICommandProvider {
public class CommandProvider implements ICommandProvider { /** The minus character. */
/** The minus character. */ private static final String MINUS = "-"; //$NON-NLS-1$
private static final String MINUS = "-"; //$NON-NLS-1$ /** The space character. */
/** The space character. */ private static final String SPACE = " "; //$NON-NLS-1$
private static final String SPACE = " "; //$NON-NLS-1$ /** The commands map. */
/** The commands map. */ protected final List<ICommand> commands;
protected final List<ICommand> commands;
/** Create a command provider. */
/** Create a command provider. */ public CommandProvider() {
public CommandProvider() { super();
super(); commands = new ArrayList<>();
commands = new ArrayList<>(); }
}
/** Test the command name validity.
/** Test the command name validity. *
* * @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 net.bigeon.gclc.command.ICommandProvider#add(java.lang.String,
* @see fr.bigeon.gclc.command.ICommandProvider#add(java.lang.String, * net.bigeon.gclc.command.Command) */
* fr.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(); testCommandName(name);
testCommandName(name); if (commands.contains(value)) {
if (commands.contains(value)) { return true;
return true; }
} for (final ICommand iCommand : commands) {
for (final ICommand iCommand : commands) { if (iCommand.getCommandName().equals(value.getCommandName())) {
if (iCommand.getCommandName().equals(value.getCommandName())) { throw new InvalidCommandName(
throw new InvalidCommandName( "Name already used: " + value.getCommandName()); //$NON-NLS-1$
"Name already used: " + value.getCommandName()); //$NON-NLS-1$ }
} }
} return commands.add(value);
return commands.add(value); }
}
/* (non-Javadoc)
/* (non-Javadoc) * @see
* @see * net.bigeon.gclc.command.ICommandProvider#executeSub(net.bigeon.gclc.manager
* fr.bigeon.gclc.command.ICommandProvider#executeSub(fr.bigeon.gclc.manager * .ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String,
* .ConsoleOutput, fr.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... args) throws CommandRunException {
final String cmd, final ICommand command = get(cmd);
final String... args) throws CommandRunException { if (command == null) {
for (final ICommand command : commands) { throw new CommandRunException(
if (command.getCommandName().equals(cmd)) { Messages.getString("CommandProvider.unrecognized", cmd), null); //$NON-NLS-1$
command.execute(out, in, args); }
return; command.execute(out, in, args);
} }
}
throw new CommandRunException( /* (non-Javadoc)
Messages.getString("CommandProvider.unrecognized", cmd), null); //$NON-NLS-1$ * @see net.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */
} @Override
public final ICommand get(final String commandName) {
/* (non-Javadoc) for (final ICommand command : commands) {
* @see fr.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */ if (command.getCommandName().equals(commandName)) {
@Override return command;
public final ICommand get(final String commandName) { }
for (final ICommand command : commands) { }
if (command.getCommandName().equals(commandName)) { return null;
return command; }
} }
}
return null;
}
}

View File

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

View File

@@ -1,80 +1,113 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
import java.io.IOException; /*-
* #%L
import fr.bigeon.gclc.exception.CommandRunException; * Generic Command Ligne console
import fr.bigeon.gclc.manager.ConsoleInput; * %%
import fr.bigeon.gclc.manager.ConsoleOutput; * Copyright (C) 2014 - 2018 bigeon.fr
* %%
/** The contract of commands. * This software is governed by the CeCILL license under French law and
* <p> * abiding by the rules of distribution of free software. You can use,
* This interface describe the contract of commands * modify and/ or redistribute the software under the terms of the CeCILL
* * license as circulated by CEA, CNRS and INRIA at the following URL
* @author Emmanuel Bigeon */ * "http://www.cecill.info".
public interface ICommand { *
* As a counterpart to the access to the source code and rights to copy,
/** Execute the command on the given output and input. * modify and redistribute granted by the license, users are provided only
* * with a limited warranty and the software's author, the holder of the
* @param out the normal output * economic rights, and the successive licensors have only limited
* @param in the input * liability.
* @param args the arguments *
* @throws CommandRunException if the command failed */ * In this respect, the user's attention is drawn to the risks associated
void execute(ConsoleOutput out, ConsoleInput in, * with loading, using, modifying and/or developing or reproducing the
String... args) throws CommandRunException; * 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
/** Get teh command name. * therefore means that it is reserved for developers and experienced
* * professionals having in-depth computer knowledge. Users are therefore
* @return the command's name */ * encouraged to load and test the software's suitability as regards their
String getCommandName(); * 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
/** This prints the help associated to this command. * same conditions as regards security.
* *
* @param output the output to print the data * The fact that you are presently reading this means that you have had
* @param args the arguments called with the help * knowledge of the CeCILL license and that you accept its terms.
* @throws IOException if the manager was closed */ * #L%
void help(ConsoleOutput output, String... args) throws IOException; */
import java.io.IOException;
/** Get a tip (brief helping message) for the command.
* import net.bigeon.gclc.exception.CommandRunException;
* @return a tip on the command */ import net.bigeon.gclc.manager.ConsoleInput;
String tip(); import net.bigeon.gclc.manager.ConsoleOutput;
} /** The contract of commands.
* <p>
* This interface describe the contract of commands
*
* @author Emmanuel Bigeon */
public interface ICommand {
/** Execute the command on the given output and input.
*
* @param out the normal output
* @param in the input
* @param args the arguments
* @throws CommandRunException if the command failed */
void execute(ConsoleOutput out, ConsoleInput in,
String... args) throws CommandRunException;
/** Get teh command name.
*
* @return the command's name */
String getCommandName();
/** This prints the help associated to this command.
*
* @param output the output to print the data
* @param args the arguments called with the help
* @throws IOException if the manager was closed */
void help(ConsoleOutput output, String... args) throws IOException;
/** Get a tip (brief helping message) for the command.
*
* @return a tip on the command */
String tip();
}

View File

@@ -1,84 +1,118 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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
/** An ICommadProvider is a provider of commands that can register commands * %%
* under some keywords. * This software is governed by the CeCILL license under French law and
* * abiding by the rules of distribution of free software. You can use,
* @author Emmanuel BIGEON */ * modify and/ or redistribute the software under the terms of the CeCILL
public interface ICommandProvider { * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
/** Adds a command to this provider, if no command was associated with the *
* given key. * 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
* @param value the command to execute * with a limited warranty and the software's author, the holder of the
* @return if the command was added * economic rights, and the successive licensors have only limited
* @throws InvalidCommandName if the command name is invalid */ * liability.
boolean add(ICommand value) throws InvalidCommandName; *
* In this respect, the user's attention is drawn to the risks associated
/** Execute the command with the given name. * with loading, using, modifying and/or developing or reproducing the
* <p> * software by the user in light of its specific status of free software,
* If no command with this name is found, an error command is usually * that may mean that it is complicated to manipulate, and that also
* executed. If there are several commands with the same name, the behavior * therefore means that it is reserved for developers and experienced
* is unspecified. Depending on the implementation, it may run an error * professionals having in-depth computer knowledge. Users are therefore
* command or prompt the user for a choice. * encouraged to load and test the software's suitability as regards their
* * requirements in conditions enabling the security of their systems and/or
* @param out the output * data to be ensured and, more generally, to use and operate it in the
* @param in the input * same conditions as regards security.
* @param command the name of the command the user wishes to execute *
* @param args the arguments for the command * The fact that you are presently reading this means that you have had
* @throws CommandRunException if the command failed to run */ * knowledge of the CeCILL license and that you accept its terms.
void executeSub(ConsoleOutput out, ConsoleInput in, String command, * #L%
String... args) throws CommandRunException; */
/** Get the command with the given name. import net.bigeon.gclc.exception.CommandRunException;
* <p> import net.bigeon.gclc.exception.InvalidCommandName;
* If no command with this name is found, an error command is usually import net.bigeon.gclc.manager.ConsoleInput;
* returned. If there are several commands with the same name, the behavior import net.bigeon.gclc.manager.ConsoleOutput;
* is unspecified. Depending on the implementation, it may return an error
* command or the first command with this name found. /** An ICommadProvider is a provider of commands that can register commands
* * under some keywords.
* @param command the name of the command the user wishes to execute *
* @return the command to execute */ * @author Emmanuel BIGEON */
ICommand get(String command); public interface ICommandProvider {
} /** Adds a command to this provider, if no command was associated with the
* given key.
*
* @param value the command to execute
* @return if the command was added
* @throws InvalidCommandName if the command name is invalid */
boolean add(ICommand value) throws InvalidCommandName;
/** Execute the command with the given name.
* <p>
* If no command with this name is found, an error command is usually
* executed. If there are several commands with the same name, the behavior
* is unspecified. Depending on the implementation, it may run an error
* command or prompt the user for a choice.
*
* @param out the output
* @param in the input
* @param command the name of the command the user wishes to execute
* @param args the arguments for the command
* @throws CommandRunException if the command failed to run */
void executeSub(ConsoleOutput out, ConsoleInput in, String command,
String... args) throws CommandRunException;
/** Get the command with the given name.
* <p>
* If no command with this name is found, an error command is usually
* returned. If there are several commands with the same name, the behavior
* is unspecified. Depending on the implementation, it may return an error
* command or the first command with this name found.
*
* @param command the name of the command the user wishes to execute
* @return the command to execute */
ICommand get(String command);
}

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

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

View File

@@ -1,186 +1,218 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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;
import java.io.IOException; /*-
import java.util.Arrays; * #%L
* Generic Command Ligne console
import fr.bigeon.gclc.exception.CommandRunException; * %%
import fr.bigeon.gclc.exception.CommandRunExceptionType; * Copyright (C) 2014 - 2018 bigeon.fr
import fr.bigeon.gclc.manager.ConsoleInput; * %%
import fr.bigeon.gclc.manager.ConsoleOutput; * 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
* <p> * license as circulated by CEA, CNRS and INRIA at the following URL
* A subed command is a command that can execute sub commands depending on the * "http://www.cecill.info".
* first argument. *
* * As a counterpart to the access to the source code and rights to copy,
* @author Emmanuel BIGEON */ * modify and redistribute granted by the license, users are provided only
public final class SubedCommand extends CommandProvider implements ICommand { * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
/** The tab character. */ * liability.
private static final String TAB = "\t"; //$NON-NLS-1$ *
/** The command to execute when this command is called with no sub * In this respect, the user's attention is drawn to the risks associated
* arguments. * with loading, using, modifying and/or developing or reproducing the
* <p> * software by the user in light of its specific status of free software,
* This may be null, in which case the command should have arguments. */ * that may mean that it is complicated to manipulate, and that also
private final ICommand noArgCommand; * therefore means that it is reserved for developers and experienced
/** A tip on this command. */ * professionals having in-depth computer knowledge. Users are therefore
private final String tip; * encouraged to load and test the software's suitability as regards their
/** The name of the command. */ * requirements in conditions enabling the security of their systems and/or
private final String name; * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
/** Create the command that defines sub commands. *
* * The fact that you are presently reading this means that you have had
* @param name the name of the command */ * knowledge of the CeCILL license and that you accept its terms.
public SubedCommand(final String name) { * #L%
super(); */
this.name = name; import java.io.IOException;
noArgCommand = null; import java.util.Arrays;
tip = null;
} import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.CommandRunExceptionType;
/** Create the command that defines sub commands. import net.bigeon.gclc.manager.ConsoleInput;
* import net.bigeon.gclc.manager.ConsoleOutput;
* @param name the name of the command
* @param noArgCommand the command to execute when no extra parameter are /**
* provided */ * <p>
public SubedCommand(final String name, final ICommand noArgCommand) { * A subed command is a command that can execute sub commands depending on the
super(); * first argument.
this.name = name; *
this.noArgCommand = noArgCommand; * @author Emmanuel BIGEON */
tip = null; public final class SubedCommand extends CommandProvider implements ICommand {
}
/** The tab character. */
/** Create the command that defines sub commands. private static final String TAB = "\t"; //$NON-NLS-1$
* /** The command to execute when this command is called with no sub
* @param name the name of the command * arguments.
* @param noArgCommand the command to execute * <p>
* @param tip the help tip associated */ * This may be null, in which case the command should have arguments. */
public SubedCommand(final String name, final ICommand noArgCommand, private final ICommand noArgCommand;
final String tip) { /** A tip on this command. */
super(); private final String tip;
this.name = name; /** The name of the command. */
this.noArgCommand = noArgCommand; private final String name;
this.tip = tip;
} /** Create the command that defines sub commands.
*
/** Create the command that defines sub commands. * @param name the name of the command */
* public SubedCommand(final String name) {
* @param name the name of the command super();
* @param tip the help tip associated */ this.name = name;
public SubedCommand(final String name, final String tip) { noArgCommand = null;
super(); tip = null;
this.name = name; }
noArgCommand = null;
this.tip = tip; /** Create the command that defines sub commands.
} *
* @param name the name of the command
/* (non-Javadoc) * @param noArgCommand the command to execute when no extra parameter are
* @see fr.bigeon.acide.Command#execute(java.lang.String[]) */ * provided */
@Override public SubedCommand(final String name, final ICommand noArgCommand) {
public void execute(final ConsoleOutput output, final ConsoleInput input, super();
final String... args) throws CommandRunException { this.name = name;
if (args.length == 0 || args[0].startsWith("-")) { //$NON-NLS-1$ this.noArgCommand = noArgCommand;
if (noArgCommand != null) { tip = null;
noArgCommand.execute(output, input, args); }
} else {
throw new CommandRunException("Unrecognized command", this); //$NON-NLS-1$ /** Create the command that defines sub commands.
} *
} else { * @param name the name of the command
* @param noArgCommand the command to execute
try { * @param tip the help tip associated */
executeSub(output, input, args[0], public SubedCommand(final String name, final ICommand noArgCommand,
Arrays.copyOfRange(args, 1, args.length)); final String tip) {
} catch (final CommandRunException e) { super();
if (e.getSource() != null) { this.name = name;
throw e; this.noArgCommand = noArgCommand;
} this.tip = tip;
throw new CommandRunException(CommandRunExceptionType.USAGE, }
e.getLocalizedMessage(), e, this);
} /** Create the command that defines sub commands.
} *
} * @param name the name of the command
* @param tip the help tip associated */
/* (non-Javadoc) public SubedCommand(final String name, final String tip) {
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ super();
@Override this.name = name;
public String getCommandName() { noArgCommand = null;
return name; this.tip = tip;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#help() */ * @see fr.bigeon.acide.Command#execute(java.lang.String[]) */
@Override @Override
public void help(final ConsoleOutput manager, public void execute(final ConsoleOutput output, final ConsoleInput input,
final String... args) throws IOException { final String... args) throws CommandRunException {
if (args.length != 0 && !args[0].startsWith("-")) { //$NON-NLS-1$ if (args.length == 0 || args[0].startsWith("-")) { //$NON-NLS-1$
// Specific if (noArgCommand != null) {
final ICommand c = get(args[0]); noArgCommand.execute(output, input, args);
if (c != null) { } else {
c.help(manager, Arrays.copyOfRange(args, 1, args.length)); throw new CommandRunException("Unrecognized command"); //$NON-NLS-1$
} }
} else { } else {
// Generic
if (noArgCommand != null && noArgCommand.tip() != null) { try {
manager.println(TAB + noArgCommand.tip()); executeSub(output, input, args[0],
} Arrays.copyOfRange(args, 1, args.length));
for (final ICommand cmd : commands) { } catch (final CommandRunException e) {
if (cmd.tip() == null) { throw new CommandRunException(CommandRunExceptionType.USAGE,
manager.println(TAB + cmd.getCommandName()); e.getLocalizedMessage(), e);
} else { }
manager.println(TAB + cmd.getCommandName() + ": " + //$NON-NLS-1$ }
cmd.tip()); }
}
} /* (non-Javadoc)
} * @see net.bigeon.gclc.command.ICommand#getCommandName() */
} @Override
public String getCommandName() {
/* (non-Javadoc) return name;
* @see fr.bigeon.gclc.command.Command#tip() */ }
@Override
public String tip() { /* (non-Javadoc)
return tip; * @see net.bigeon.gclc.command.Command#help() */
} @Override
public void help(final ConsoleOutput manager,
/* (non-Javadoc) final String... args) throws IOException {
* @see java.lang.Object#toString() */ if (args.length != 0 && !args[0].startsWith("-")) { //$NON-NLS-1$
@Override // Specific
public String toString() { final ICommand c = get(args[0]);
return "SubedCommand " + super.toString(); //$NON-NLS-1$ if (c != null) {
} c.help(manager, Arrays.copyOfRange(args, 1, args.length));
} } else {
manager.println("No command "+Arrays.toString(args));
}
} else {
// Generic
if (noArgCommand != null && noArgCommand.tip() != null) {
manager.println(TAB + noArgCommand.tip());
}
for (final ICommand cmd : commands) {
if (cmd.tip() == null) {
manager.println(TAB + cmd.getCommandName());
} else {
manager.println(TAB + cmd.getCommandName() + ": " + //$NON-NLS-1$
cmd.tip());
}
}
}
}
/* (non-Javadoc)
* @see net.bigeon.gclc.command.Command#tip() */
@Override
public String tip() {
return tip;
}
/* (non-Javadoc)
* @see java.lang.Object#toString() */
@Override
public String toString() {
return "SubedCommand " + super.toString(); //$NON-NLS-1$
}
}

View File

@@ -1,101 +1,135 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
import java.io.IOException; /*-
* #%L
import fr.bigeon.gclc.ConsoleApplication; * Generic Command Ligne console
import fr.bigeon.gclc.manager.ConsoleInput; * %%
import fr.bigeon.gclc.manager.ConsoleOutput; * Copyright (C) 2014 - 2018 bigeon.fr
import fr.bigeon.gclc.prompt.CLIPrompterMessages; * %%
* This software is governed by the CeCILL license under French law and
/** A command to exit a {@link ConsoleApplication}. * abiding by the rules of distribution of free software. You can use,
* * modify and/ or redistribute the software under the terms of the CeCILL
* @author Emmanuel BIGEON */ * license as circulated by CEA, CNRS and INRIA at the following URL
public class ExitCommand implements ICommand { * "http://www.cecill.info".
/** The exit command manual message key. */ *
private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$ * As a counterpart to the access to the source code and rights to copy,
/** The tip of the exit command. */ * modify and redistribute granted by the license, users are provided only
private static final String EXIT = "exit.tip"; //$NON-NLS-1$ * with a limited warranty and the software's author, the holder of the
/** The application that will be exited when this command runs. */ * economic rights, and the successive licensors have only limited
private final ConsoleApplication app; * liability.
/** The exit command name. */ *
private final String name; * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
/** Create the exiting command. * 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
* @param name the name of the command * therefore means that it is reserved for developers and experienced
* @param app the application to exit */ * professionals having in-depth computer knowledge. Users are therefore
public ExitCommand(final String name, final ConsoleApplication app) { * encouraged to load and test the software's suitability as regards their
this.name = name; * requirements in conditions enabling the security of their systems and/or
this.app = app; * data to be ensured and, more generally, to use and operate it in the
} * same conditions as regards security.
*
/** The actions to take before exiting. * The fact that you are presently reading this means that you have had
* <p> * knowledge of the CeCILL license and that you accept its terms.
* This method is intended to be overriden by sub classes. */ * #L%
protected void beforeExit() { */
// Do nothing by default import java.io.IOException;
}
import net.bigeon.gclc.ConsoleApplication;
@Override import net.bigeon.gclc.command.ICommand;
public final void execute(final ConsoleOutput output, import net.bigeon.gclc.manager.ConsoleInput;
final ConsoleInput input, final String... args) { import net.bigeon.gclc.manager.ConsoleOutput;
beforeExit(); import net.bigeon.gclc.prompt.CLIPrompterMessages;
app.exit();
} /** A command to exit a {@link ConsoleApplication}.
*
/* (non-Javadoc) * @author Emmanuel BIGEON */
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ public class ExitCommand implements ICommand {
@Override /** The exit command manual message key. */
public final String getCommandName() { private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$
return name; /** The tip of the exit command. */
} private static final String EXIT = "exit.tip"; //$NON-NLS-1$
/** The application that will be exited when this command runs. */
@Override private final ConsoleApplication app;
public final void help(final ConsoleOutput manager, /** The exit command name. */
final String... args) throws IOException { private final String name;
manager.println(
CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args)); /** Create the exiting command.
} *
@Override * @param name the name of the command
public final String tip() { * @param app the application to exit */
return CLIPrompterMessages.getString(EXIT); public ExitCommand(final String name, final ConsoleApplication app) {
} this.name = name;
} this.app = app;
}
/** The actions to take before exiting.
* <p>
* This method is intended to be overriden by sub classes. */
protected void beforeExit() {
// Do nothing by default
}
@Override
public final void execute(final ConsoleOutput output,
final ConsoleInput input, final String... args) {
beforeExit();
app.exit();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.command.ICommand#getCommandName() */
@Override
public final String getCommandName() {
return name;
}
@Override
public final void help(final ConsoleOutput manager,
final String... args) throws IOException {
manager.println(
CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args));
}
@Override
public final String tip() {
return CLIPrompterMessages.getString(EXIT);
}
}

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

@@ -1,217 +1,246 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
import java.io.BufferedReader; /*-
import java.io.FileInputStream; * #%L
import java.io.IOException; * Generic Command Ligne console
import java.io.InputStreamReader; * %%
import java.nio.charset.Charset; * Copyright (C) 2014 - 2018 bigeon.fr
import java.text.MessageFormat; * %%
import java.util.Arrays; * This software is governed by the CeCILL license under French law and
import java.util.List; * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
import fr.bigeon.gclc.ConsoleApplication; * license as circulated by CEA, CNRS and INRIA at the following URL
import fr.bigeon.gclc.GCLCConstants; * "http://www.cecill.info".
import fr.bigeon.gclc.exception.CommandParsingException; *
import fr.bigeon.gclc.exception.CommandRunException; * As a counterpart to the access to the source code and rights to copy,
import fr.bigeon.gclc.exception.CommandRunExceptionType; * modify and redistribute granted by the license, users are provided only
import fr.bigeon.gclc.manager.ConsoleInput; * with a limited warranty and the software's author, the holder of the
import fr.bigeon.gclc.manager.ConsoleOutput; * economic rights, and the successive licensors have only limited
* liability.
/** A command that will launch a series of command from a file. *
* <p> * In this respect, the user's attention is drawn to the risks associated
* This command will read a file and execute each non empty non commented line * with loading, using, modifying and/or developing or reproducing the
* as a command of the application. * 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
* @author Emmanuel Bigeon */ * therefore means that it is reserved for developers and experienced
public final class ScriptExecution extends Command { * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
/** The tab character. */ * requirements in conditions enabling the security of their systems and/or
private static final String TAB = "\t"; //$NON-NLS-1$ * data to be ensured and, more generally, to use and operate it in the
/** the space character. */ * same conditions as regards security.
private static final String SPACE = " "; //$NON-NLS-1$ *
/** The application. */ * The fact that you are presently reading this means that you have had
private final ConsoleApplication application; * knowledge of the CeCILL license and that you accept its terms.
/** The commenting prefix. */ * #L%
private final String commentPrefix; */
/** The charset for files. */ import java.io.BufferedReader;
private final Charset charset; import java.io.FileInputStream;
import java.io.IOException;
/** Create the script command. import java.io.InputStreamReader;
* import java.nio.charset.Charset;
* @param name the name of the command import java.text.MessageFormat;
* @param application the application import java.util.Arrays;
* @param commentPrefix the comment prefix in the script files import java.util.List;
* @param charset the charset to use for files */
public ScriptExecution(final String name, final ConsoleApplication application, import net.bigeon.gclc.ConsoleApplication;
final String commentPrefix, final Charset charset) { import net.bigeon.gclc.GCLCConstants;
super(name); import net.bigeon.gclc.command.Command;
this.application = application; import net.bigeon.gclc.exception.CommandParsingException;
this.commentPrefix = commentPrefix; import net.bigeon.gclc.exception.CommandRunException;
this.charset = charset; import net.bigeon.gclc.exception.CommandRunExceptionType;
} import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/** Check the arguments.
* /** A command that will launch a series of command from a file.
* @param args the arguments * <p>
* @throws CommandRunException if the arguments were not the ones * This command will read a file and execute each non empty non commented line
* expected */ * as a command of the application.
private void checkArgs(final String[] args) throws CommandRunException { *
if (args.length == 0) { * @author Emmanuel Bigeon */
throw new CommandRunException(CommandRunExceptionType.USAGE, public final class ScriptExecution extends Command {
"Expecting a file", this); //$NON-NLS-1$
} /** The tab character. */
} private static final String TAB = "\t"; //$NON-NLS-1$
/** the space character. */
private static final String SPACE = " "; //$NON-NLS-1$
/** The application. */
/* (non-Javadoc) private final ConsoleApplication application;
* @see fr.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */ /** The commenting prefix. */
@Override private final String commentPrefix;
public void execute(final ConsoleOutput out, final ConsoleInput in, /** The charset for files. */
final String... args) throws CommandRunException { private final Charset charset;
checkArgs(args);
final String scriptFile = args[0]; /** Create the script command.
final String[] params = Arrays.copyOfRange(args, 1, args.length); *
String cmd; * @param name the name of the command
int lineNo = -1; * @param application the application
try (InputStreamReader fReader = new InputStreamReader( * @param commentPrefix the comment prefix in the script files
new FileInputStream(scriptFile), charset); * @param charset the charset to use for files */
BufferedReader reader = new BufferedReader(fReader)) { public ScriptExecution(final String name, final ConsoleApplication application,
while ((cmd = reader.readLine()) != null) { final String commentPrefix, final Charset charset) {
lineNo++; super(name);
final String cmdLine = readCommandLine(cmd, params); this.application = application;
if (cmdLine == null) { this.commentPrefix = commentPrefix;
continue; this.charset = charset;
} }
final List<String> ps = GCLCConstants.splitCommand(cmdLine);
final String command = ps.remove(0); /** Check the arguments.
application.executeSub(out, in, command, *
ps.toArray(new String[0])); * @param args the arguments
} * @throws CommandRunException if the arguments were not the ones
} catch (final CommandParsingException e) { * expected */
throw new CommandRunException(MessageFormat.format( private static void checkArgs(final String[] args) throws CommandRunException {
"Invalid command in script ({0})", e.getLocalizedMessage()), //$NON-NLS-1$ if (args.length == 0) {
e, this); throw new CommandRunException(CommandRunExceptionType.USAGE,
} catch (final IOException e) { "Expecting a file"); //$NON-NLS-1$
throw new CommandRunException("Unable to read script", //$NON-NLS-1$ }
e, this); }
} catch (final CommandRunException e) {
throw manageRunException(e, lineNo);
}
} /* (non-Javadoc)
* @see net.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */
/** This method will create the correct exception. The exception source must @Override
* be this command. public void execute(final ConsoleOutput out, final ConsoleInput in,
* final String... args) throws CommandRunException {
* @param e the exception checkArgs(args);
* @param lineNo the line nu;ber final String scriptFile = args[0];
* @return the exception to actually throw */ final String[] params = Arrays.copyOfRange(args, 1, args.length);
private CommandRunException manageRunException(final CommandRunException e, String cmd;
final int lineNo) { int lineNo = -1;
if (e.getSource() == this) { try (InputStreamReader fReader = new InputStreamReader(
// ensure closing? new FileInputStream(scriptFile), charset);
return e; BufferedReader reader = new BufferedReader(fReader)) {
} while ((cmd = reader.readLine()) != null) {
return new CommandRunException(CommandRunExceptionType.EXECUTION, lineNo++;
MessageFormat.format( final String cmdLine = readCommandLine(cmd, params);
"The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$ if (cmdLine == null) {
Integer.valueOf(lineNo), e.getLocalizedMessage()), continue;
e, this); }
} final List<String> ps = GCLCConstants.splitCommand(cmdLine);
final String command = ps.remove(0);
/** Read a line of the script. application.executeSub(out, in, command,
* ps.toArray(new String[0]));
* @param cmd the line }
* @param params the formatting parameters } catch (final CommandParsingException e) {
* @return the command if it is indeed one, null otherwise throw new CommandRunException(MessageFormat.format(
* @throws CommandRunException if the line stqrted with a space character */ "Invalid command in script ({0})", e.getLocalizedMessage()), //$NON-NLS-1$
private String readCommandLine(final String cmd, e);
final Object[] params) throws CommandRunException { } catch (final IOException e) {
if (cmd.startsWith(SPACE) || cmd.startsWith(TAB)) { throw new CommandRunException("Unable to read script", //$NON-NLS-1$
throw new CommandRunException( e);
"Invalid line in script (line starts with space character)", //$NON-NLS-1$ } catch (final CommandRunException e) {
this); throw manageRunException(e, lineNo);
} }
if (cmd.isEmpty() || cmd.startsWith(commentPrefix)) { }
// Comment line
return null; /** This method will create the correct exception. The exception source must
} * be this command.
return MessageFormat.format(cmd, params); *
} * @param e the exception
* @param lineNo the line nu;ber
/* (non-Javadoc) * @return the exception to actually throw */
* @see fr.bigeon.gclc.command.ICommand#tip() */ private static CommandRunException manageRunException(final CommandRunException e,
@Override final int lineNo) {
public String tip() { return new CommandRunException(CommandRunExceptionType.EXECUTION,
return "Execute a script"; //$NON-NLS-1$ MessageFormat.format(
} "The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$
Integer.valueOf(lineNo), e.getLocalizedMessage()),
/* (non-Javadoc) e);
* @see fr.bigeon.gclc.command.Command#usageDetail() */ }
@Override
protected String usageDetail() { /** Read a line of the script.
final StringBuilder builder = new StringBuilder(); *
builder.append( * @param cmd the line
" scriptfile: path to the file containing the script to execute."); //$NON-NLS-1$ * @param params the formatting parameters
builder.append(System.lineSeparator()); * @return the command if it is indeed one, null otherwise
builder.append(System.lineSeparator()); * @throws CommandRunException if the line stqrted with a space character */
builder.append( private String readCommandLine(final String cmd,
" The script file must contain one line commands. The lines must never"); //$NON-NLS-1$ final Object[] params) throws CommandRunException {
builder.append(System.lineSeparator()); if (cmd.startsWith(SPACE) || cmd.startsWith(TAB)) {
builder.append( throw new CommandRunException(
"start with whitespace characters. The lines starting with"); //$NON-NLS-1$ "Invalid line in script (line starts with space character)");
builder.append(System.lineSeparator()); }
builder.append('"'); if (cmd.isEmpty() || cmd.startsWith(commentPrefix)) {
builder.append(commentPrefix); // Comment line
builder.append("\" will be ignored as well as empty lines."); //$NON-NLS-1$ return null;
builder.append(System.lineSeparator()); }
return MessageFormat.format(cmd, params);
return builder.toString(); }
}
/* (non-Javadoc)
/* (non-Javadoc) * @see net.bigeon.gclc.command.ICommand#tip() */
* @see fr.bigeon.gclc.command.Command#usagePattern() */ @Override
@Override public String tip() {
protected String usagePattern() { return "Execute a script"; //$NON-NLS-1$
return super.usagePattern() + " <scriptfile>"; //$NON-NLS-1$ }
}
/* (non-Javadoc)
} * @see net.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
final StringBuilder builder = new StringBuilder();
builder.append(
" scriptfile: path to the file containing the script to execute."); //$NON-NLS-1$
builder.append(System.lineSeparator());
builder.append(System.lineSeparator());
builder.append(
" The script file must contain one line commands. The lines must never"); //$NON-NLS-1$
builder.append(System.lineSeparator());
builder.append(
"start with whitespace characters. The lines starting with"); //$NON-NLS-1$
builder.append(System.lineSeparator());
builder.append('"');
builder.append(commentPrefix);
builder.append("\" will be ignored as well as empty lines."); //$NON-NLS-1$
builder.append(System.lineSeparator());
return builder.toString();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.command.Command#usagePattern() */
@Override
protected String usagePattern() {
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,49 +1,46 @@
/* /** 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
* This software is governed by the CeCILL license under French law and * help display of other commands and the
* abiding by the rules of distribution of free software. You can use, *
* modify and/or redistribute the software under the terms of the CeCILL * @author Emmanuel BIGEON */
* license as circulated by CEA, CNRS and INRIA at the following URL package net.bigeon.gclc.command;
* "http://www.cecill.info".
* /*-
* As a counterpart to the access to the source code and rights to copy, * #%L
* modify and redistribute granted by the license, users are provided only * Generic Command Ligne console
* with a limited warranty and the software's author, the holder of the * %%
* economic rights, and the successive licensors have only limited * Copyright (C) 2014 - 2018 bigeon.fr
* liability. * %%
* * This software is governed by the CeCILL license under French law and
* In this respect, the user's attention is drawn to the risks associated * abiding by the rules of distribution of free software. You can use,
* with loading, using, modifying and/or developing or reproducing the * modify and/ or redistribute the software under the terms of the CeCILL
* software by the user in light of its specific status of free software, * license as circulated by CEA, CNRS and INRIA at the following URL
* that may mean that it is complicated to manipulate, and that also * "http://www.cecill.info".
* therefore means that it is reserved for developers and experienced *
* professionals having in-depth computer knowledge. Users are therefore * As a counterpart to the access to the source code and rights to copy,
* encouraged to load and test the software's suitability as regards their * modify and redistribute granted by the license, users are provided only
* requirements in conditions enabling the security of their systems and/or * with a limited warranty and the software's author, the holder of the
* data to be ensured and, more generally, to use and operate it in the * economic rights, and the successive licensors have only limited
* same conditions as regards security. * liability.
* *
* The fact that you are presently reading this means that you have had * In this respect, the user's attention is drawn to the risks associated
* knowledge of the CeCILL license and that you accept its terms. * 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
/** gclc:fr.bigeon.gclc.command.package-info.java * therefore means that it is reserved for developers and experienced
* Created on: Sep 6, 2014 */ * professionals having in-depth computer knowledge. Users are therefore
/** This package groups elements related to * encouraged to load and test the software's suitability as regards their
* {@link fr.bigeon.gclc.command.ICommand} * requirements in conditions enabling the security of their systems and/or
* <p> * data to be ensured and, more generally, to use and operate it in the
* There are some implementations, such as the * same conditions as regards security.
* {@link fr.bigeon.gclc.command.ParametrizedCommand} for commands with a *
* predefined set of flags and option taking a string as value, the * The fact that you are presently reading this means that you have had
* {@link fr.bigeon.gclc.command.SubedCommand} for a command that is declined in * knowledge of the CeCILL license and that you accept its terms.
* a set of sub commands, the {@link fr.bigeon.gclc.command.HelpExecutor} for * #L%
* help display of other commands and the */
*
* @author Emmanuel BIGEON */
package fr.bigeon.gclc.command;

View File

@@ -1,71 +1,104 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
/** An exception raised during command parsing. /*-
* * #%L
* @author Emmanuel Bigeon */ * Generic Command Ligne console
public class CommandParsingException extends Exception { * %%
* Copyright (C) 2014 - 2018 bigeon.fr
/** svuid. */ * %%
private static final long serialVersionUID = 1L; * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
/** Create the exception with a message. * modify and/ or redistribute the software under the terms of the CeCILL
* * license as circulated by CEA, CNRS and INRIA at the following URL
* @param message the message */ * "http://www.cecill.info".
public CommandParsingException(final String message) { *
super(message); * 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
/** Create the exception with a message and a cause. * economic rights, and the successive licensors have only limited
* * liability.
* @param message the message *
* @param cause the cause */ * In this respect, the user's attention is drawn to the risks associated
public CommandParsingException(final String message, final Throwable cause) { * with loading, using, modifying and/or developing or reproducing the
super(message, cause); * 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
/** Create the exception with a message. * professionals having in-depth computer knowledge. Users are therefore
* * encouraged to load and test the software's suitability as regards their
* @param cause the cause */ * requirements in conditions enabling the security of their systems and/or
public CommandParsingException(final Throwable cause) { * data to be ensured and, more generally, to use and operate it in the
super(cause); * 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.
*
* @author Emmanuel Bigeon */
public class CommandParsingException extends Exception {
/** svuid. */
private static final long serialVersionUID = 1L;
/** Create the exception with a message.
*
* @param message the message */
public CommandParsingException(final String message) {
super(message);
}
/** Create the exception with a message and a cause.
*
* @param message the message
* @param cause the cause */
public CommandParsingException(final String message, final Throwable cause) {
super(message, cause);
}
/** Create the exception with a message.
*
* @param cause the cause */
public CommandParsingException(final Throwable cause) {
super(cause);
}
}

View File

@@ -1,130 +1,142 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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
/** An exception thrown when a command failed to run correctly. * Generic Command Ligne console
* * %%
* @author Emmanuel BIGEON */ * Copyright (C) 2014 - 2018 Bigeon
public final class CommandRunException extends Exception { * %%
* This software is governed by the CeCILL license under French law and
/** the SVUID. */ * abiding by the rules of distribution of free software. You can use,
private static final long serialVersionUID = 1L; * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
/** The type of run exception. */ * "http://www.cecill.info".
private final CommandRunExceptionType type; *
/** The command that caused the error. */ * As a counterpart to the access to the source code and rights to copy,
private transient ICommand source; * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
/** Create the exception. * economic rights, and the successive licensors have only limited
* * liability.
* @param type the type of exception *
* @param message the message * In this respect, the user's attention is drawn to the risks associated
* @param source the source */ * with loading, using, modifying and/or developing or reproducing the
public CommandRunException(final CommandRunExceptionType type, * software by the user in light of its specific status of free software,
final String message, final ICommand source) { * that may mean that it is complicated to manipulate, and that also
super(message); * therefore means that it is reserved for developers and experienced
this.type = type; * professionals having in-depth computer knowledge. Users are therefore
this.source = source; * 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
/** Create the exception with a cause. * same conditions as regards security.
* *
* @param type the type of exception * The fact that you are presently reading this means that you have had
* @param message a message * knowledge of the CeCILL license and that you accept its terms.
* @param cause the cause * #L%
* @param source the source */ */
public CommandRunException(final CommandRunExceptionType type,
final String message, final Throwable cause, /** An exception thrown when a command failed to run correctly.
final ICommand source) { *
super(message, cause); * @author Emmanuel BIGEON */
this.type = type; public final class CommandRunException extends Exception {
this.source = source;
} /** the SVUID. */
private static final long serialVersionUID = 1L;
/** Create the exception with type
* {@link CommandRunExceptionType#EXECUTION}. /** The type of run exception. */
* private final CommandRunExceptionType type;
* @param message a message
* @param source the source */ /** Create the exception.
public CommandRunException(final String message, final ICommand source) { *
super(message); * @param type the type of exception
type = CommandRunExceptionType.EXECUTION; * @param message the message */
this.source = source; public CommandRunException(final CommandRunExceptionType type,
} final String message) {
super(message);
/** Create the exception with type {@link CommandRunExceptionType#EXECUTION} this.type = type;
* and a cause. }
*
* @param message a message /** Create the exception with a cause.
* @param cause the cause *
* @param source the source */ * @param type the type of exception
public CommandRunException(final String message, final Throwable cause, * @param message a message
final ICommand source) { * @param cause the cause */
super(message, cause); public CommandRunException(final CommandRunExceptionType type,
type = CommandRunExceptionType.EXECUTION; final String message, final Throwable cause) {
this.source = source; super(message, cause);
} this.type = type;
}
/* (non-Javadoc)
* @see java.lang.Throwable#getLocalizedMessage() */ /** Create the exception with type {@link CommandRunExceptionType#EXECUTION}.
@Override *
public String getLocalizedMessage() { * @param message a message */
if (getCause() != null) { public CommandRunException(final String message) {
return super.getLocalizedMessage() + ": " + //$NON-NLS-1$ super(message);
getCause().getLocalizedMessage(); type = CommandRunExceptionType.EXECUTION;
} }
return super.getLocalizedMessage();
} /** Create the exception with type {@link CommandRunExceptionType#EXECUTION} and
* a cause.
/** Get the exception raising command. *
* * @param message a message
* @return the source */ * @param cause the cause */
public ICommand getSource() { public CommandRunException(final String message, final Throwable cause) {
return source; super(message, cause);
} type = CommandRunExceptionType.EXECUTION;
}
/** Get the exception type.
* /* (non-Javadoc)
* @return the type */ * @see java.lang.Throwable#getLocalizedMessage() */
public CommandRunExceptionType getType() { @Override
return type; public String getLocalizedMessage() {
} if (getCause() != null) {
} return super.getLocalizedMessage() + ": " + //$NON-NLS-1$
getCause().getLocalizedMessage();
}
return super.getLocalizedMessage();
}
/** Get the exception type.
*
* @return the type */
public CommandRunExceptionType getType() {
return type;
}
}

View File

@@ -1,51 +1,84 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
/** The command run exception possible types. /*-
* * #%L
* @author Emmanuel Bigeon */ * Generic Command Ligne console
public enum CommandRunExceptionType { * %%
/** Type of exception due to a wrong usage. */ * Copyright (C) 2014 - 2018 bigeon.fr
USAGE, * %%
/** Type of exception due to a problem in execution. */ * This software is governed by the CeCILL license under French law and
EXECUTION, * abiding by the rules of distribution of free software. You can use,
/** Type of exception due to the impossibility to interact with user. */ * modify and/ or redistribute the software under the terms of the CeCILL
INTERACTION; * 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.
*
* @author Emmanuel Bigeon */
public enum CommandRunExceptionType {
/** Type of exception due to a wrong usage. */
USAGE,
/** Type of exception due to a problem in execution. */
EXECUTION,
/** Type of exception due to the impossibility to interact with user. */
INTERACTION;
}

View File

@@ -1,77 +1,110 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
/** Exception sent from the application when a command is added but the name of /*-
* the command is already used. * #%L
* * Generic Command Ligne console
* @author Emmanuel BIGEON */ * %%
public class InvalidCommandName extends Exception { * Copyright (C) 2014 - 2018 bigeon.fr
* %%
/** the SVUID. */ * This software is governed by the CeCILL license under French law and
private static final long serialVersionUID = 1L; * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
/** Default constructor. */ * license as circulated by CEA, CNRS and INRIA at the following URL
public InvalidCommandName() { * "http://www.cecill.info".
super(); *
} * 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
/** Create the exception with a message. * with a limited warranty and the software's author, the holder of the
* * economic rights, and the successive licensors have only limited
* @param message the message */ * liability.
public InvalidCommandName(final String message) { *
super(message); * 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,
/** Create the exception with a message and a cause. * that may mean that it is complicated to manipulate, and that also
* * therefore means that it is reserved for developers and experienced
* @param message the message * professionals having in-depth computer knowledge. Users are therefore
* @param cause the cause */ * encouraged to load and test the software's suitability as regards their
public InvalidCommandName(final String message, final Throwable cause) { * requirements in conditions enabling the security of their systems and/or
super(message, cause); * data to be ensured and, more generally, to use and operate it in the
} * same conditions as regards security.
*
/** Create the exception with a cause. * The fact that you are presently reading this means that you have had
* * knowledge of the CeCILL license and that you accept its terms.
* @param cause the cause */ * #L%
public InvalidCommandName(final Throwable cause) { */
super(cause); /** Exception sent from the application when a command is added but the name of
} * the command is already used.
*
} * @author Emmanuel BIGEON */
public class InvalidCommandName extends Exception {
/** the SVUID. */
private static final long serialVersionUID = 1L;
/** Default constructor. */
public InvalidCommandName() {
super();
}
/** Create the exception with a message.
*
* @param message the message */
public InvalidCommandName(final String message) {
super(message);
}
/** Create the exception with a message and a cause.
*
* @param message the message
* @param cause the cause */
public InvalidCommandName(final String message, final Throwable cause) {
super(message, cause);
}
/** Create the exception with a cause.
*
* @param cause the cause */
public InvalidCommandName(final Throwable cause) {
super(cause);
}
}

View File

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

View File

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

View File

@@ -1,81 +1,114 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
import java.text.MessageFormat; /*-
import java.util.MissingResourceException; * #%L
import java.util.ResourceBundle; * Generic Command Ligne console
import java.util.logging.Level; * %%
import java.util.logging.Logger; * Copyright (C) 2014 - 2018 bigeon.fr
* %%
/** Internationalization class. * This software is governed by the CeCILL license under French law and
* * abiding by the rules of distribution of free software. You can use,
* @author Emmanuel Bigeon */ * modify and/ or redistribute the software under the terms of the CeCILL
public final class Messages { * license as circulated by CEA, CNRS and INRIA at the following URL
/** The resource bundle name. */ * "http://www.cecill.info".
private static final String BUNDLE_NAME = "fr.bigeon.gclc.l10n.messages"; //$NON-NLS-1$ *
* As a counterpart to the access to the source code and rights to copy,
/** The resource bundle. */ * modify and redistribute granted by the license, users are provided only
private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle * with a limited warranty and the software's author, the holder of the
.getBundle(BUNDLE_NAME); * economic rights, and the successive licensors have only limited
* liability.
/** The class logger. */ *
private static final Logger LOGGER = Logger * In this respect, the user's attention is drawn to the risks associated
.getLogger(Messages.class.getName()); * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
/** Utility class. */ * that may mean that it is complicated to manipulate, and that also
private Messages() { * therefore means that it is reserved for developers and experienced
// Utility class * 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
/** Get formatted internationalized messages. * data to be ensured and, more generally, to use and operate it in the
* * same conditions as regards security.
* @param key the message key *
* @param args the formatting arguments * The fact that you are presently reading this means that you have had
* @return the formatted internationalized message */ * knowledge of the CeCILL license and that you accept its terms.
public static String getString(final String key, final Object... args) { * #L%
try { */
return MessageFormat.format(RESOURCE_BUNDLE.getString(key), args); import java.text.MessageFormat;
} catch (final MissingResourceException e) { import java.util.MissingResourceException;
LOGGER.log(Level.WARNING, import java.util.ResourceBundle;
"Unrecognized internationalization message key: " + key, e); //$NON-NLS-1$ import java.util.logging.Level;
return '!' + key + '!'; import java.util.logging.Logger;
}
} /** Internationalization class.
} *
* @author Emmanuel Bigeon */
public final class Messages {
/** The resource bundle name. */
private static final String BUNDLE_NAME = "net.bigeon.gclc.l10n.messages"; //$NON-NLS-1$
/** The resource bundle. */
private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
.getBundle(BUNDLE_NAME);
/** The class logger. */
private static final Logger LOGGER = Logger
.getLogger(Messages.class.getName());
/** Utility class. */
private Messages() {
// Utility class
}
/** Get formatted internationalized messages.
*
* @param key the message key
* @param args the formatting arguments
* @return the formatted internationalized message */
public static String getString(final String key, final Object... args) {
try {
return MessageFormat.format(RESOURCE_BUNDLE.getString(key), args);
} catch (final MissingResourceException e) {
LOGGER.log(Level.WARNING,
"Unrecognized internationalization message key: " + key, e); //$NON-NLS-1$
return '!' + key + '!';
}
}
}

View File

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

View File

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

View File

@@ -1,76 +1,109 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
import java.io.IOException; /*-
* #%L
/** A console output definition. * Generic Command Ligne console
* * %%
* @author Emmanuel Bigeon */ * Copyright (C) 2014 - 2018 bigeon.fr
public interface ConsoleOutput extends AutoCloseable { * %%
* This software is governed by the CeCILL license under French law and
/** Test if the output is closed. * abiding by the rules of distribution of free software. You can use,
* * modify and/ or redistribute the software under the terms of the CeCILL
* @return if the manager is closed. */ * license as circulated by CEA, CNRS and INRIA at the following URL
boolean isClosed(); * "http://www.cecill.info".
*
/** Print a string. * 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
* @param text the message to print (without line break at the end). * with a limited warranty and the software's author, the holder of the
* @throws IOException if the manager is closed or could not read the * economic rights, and the successive licensors have only limited
* prompt */ * liability.
void print(String text) throws IOException; *
* In this respect, the user's attention is drawn to the risks associated
/** Prints an end of line. * with loading, using, modifying and/or developing or reproducing the
* * software by the user in light of its specific status of free software,
* @throws IOException if the manager is closed or could not read the * that may mean that it is complicated to manipulate, and that also
* prompt */ * therefore means that it is reserved for developers and experienced
void println() throws IOException; * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
/** Print a string followed by an end of line. * requirements in conditions enabling the security of their systems and/or
* <p> * data to be ensured and, more generally, to use and operate it in the
* This is the same as calling successively {@link #print(String)} and * same conditions as regards security.
* {@link #println()}. *
* * The fact that you are presently reading this means that you have had
* @param message the message to print * knowledge of the CeCILL license and that you accept its terms.
* @throws IOException if the manager is closed or could not read the * #L%
* prompt */ */
void println(String message) throws IOException; import java.io.IOException;
} /** A console output definition.
*
* @author Emmanuel Bigeon */
public interface ConsoleOutput extends AutoCloseable {
/** Test if the output is closed.
*
* @return if the manager is closed. */
boolean isClosed();
/** Print a string.
*
* @param text the message to print (without line break at the end).
* @throws IOException if the manager is closed or could not read the
* prompt */
void print(String text) throws IOException;
/** Prints an end of line.
*
* @throws IOException if the manager is closed or could not read the
* prompt */
void println() throws IOException;
/** Print a string followed by an end of line.
* <p>
* This is the same as calling successively {@link #print(String)} and
* {@link #println()}.
*
* @param message the message to print
* @throws IOException if the manager is closed or could not read the
* prompt */
void println(String message) throws IOException;
}

View File

@@ -1,117 +1,158 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
/** A console input that return empty to all prompting. /*-
* * #%L
* @author Emmanuel Bigeon */ * Generic Command Ligne console
public final class EmptyInput implements ConsoleInput { * %%
* Copyright (C) 2014 - 2018 Bigeon
/** The empty prompter. */ * %%
public static final ConsoleInput INSTANCE = new EmptyInput(); * This software is governed by the CeCILL license under French law and
/** The empty input. */ * abiding by the rules of distribution of free software. You can use,
private EmptyInput() { * 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".
/* (non-Javadoc) *
* @see fr.bigeon.gclc.manager.ConsoleInput#close() */ * As a counterpart to the access to the source code and rights to copy,
@Override * modify and redistribute granted by the license, users are provided only
public void close() { * with a limited warranty and the software's author, the holder of the
// * economic rights, and the successive licensors have only limited
} * liability.
*
/* (non-Javadoc) * In this respect, the user's attention is drawn to the risks associated
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */ * with loading, using, modifying and/or developing or reproducing the
@Override * software by the user in light of its specific status of free software,
public String getPrompt() { * that may mean that it is complicated to manipulate, and that also
return ""; //$NON-NLS-1$ * 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
/* (non-Javadoc) * requirements in conditions enabling the security of their systems and/or
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */ * data to be ensured and, more generally, to use and operate it in the
@Override * same conditions as regards security.
public void interruptPrompt() { *
// * 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%
/* (non-Javadoc) */
* @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */
@Override import net.bigeon.gclc.tools.ConstantString;
public boolean isClosed() { import net.bigeon.gclc.tools.StringProvider;
return false;
} /** A console input that return empty to all prompting.
*
/* (non-Javadoc) * @author Emmanuel Bigeon */
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */ public final class EmptyInput implements ConsoleInput {
@Override
public String prompt() { /** The empty prompter. */
return ""; //$NON-NLS-1$ public static final ConsoleInput INSTANCE = new EmptyInput();
} /** The empty input. */
private EmptyInput() {
/* (non-Javadoc) //
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */ }
@Override /* (non-Javadoc)
public String prompt(final long timeout) { * @see net.bigeon.gclc.manager.ConsoleInput#close() */
return ""; //$NON-NLS-1$ @Override
} public void close() {
//
/* (non-Javadoc) }
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
@Override /* (non-Javadoc)
public String prompt(final String message) { * @see net.bigeon.gclc.manager.ConsoleInput#getPrompt() */
return ""; //$NON-NLS-1$ @Override
} public StringProvider getPrompt() {
return new ConstantString(""); //$NON-NLS-1$
/* (non-Javadoc) }
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
* long) */ /* (non-Javadoc)
@Override * @see net.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
public String prompt(final String message, @Override
final long timeout) { public void interruptPrompt() {
return ""; //$NON-NLS-1$ //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleInput#isClosed() */
@Override @Override
public void setPrompt(final String prompt) { public boolean isClosed() {
// return false;
} }
} /* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override
public String prompt() {
return ""; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override
public String prompt(final long timeout) {
return ""; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
@Override
public String prompt(final String message) {
return ""; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
* long) */
@Override
public String prompt(final String message,
final long timeout) {
return ""; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override
public void setPrompt(final String prompt) {
//
}
@Override
public void setPrompt(StringProvider string) {
//
}
}

View File

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

View File

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

View File

@@ -1,79 +1,112 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.
*/ */
/** /**
* 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;
import java.text.MessageFormat; /*-
import java.util.MissingResourceException; * #%L
import java.util.ResourceBundle; * Generic Command Ligne console
import java.util.logging.Level; * %%
import java.util.logging.Logger; * Copyright (C) 2014 - 2018 bigeon.fr
* %%
/** Utility class for the messages of the CLIPrompter. * This software is governed by the CeCILL license under French law and
* * abiding by the rules of distribution of free software. You can use,
* @author Emmanuel BIGEON */ * modify and/ or redistribute the software under the terms of the CeCILL
public final class CLIPrompterMessages { * license as circulated by CEA, CNRS and INRIA at the following URL
/** The resource name. */ * "http://www.cecill.info".
private static final String BUNDLE_NAME = "fr.bigeon.gclc.messages"; //$NON-NLS-1$ *
/** The resource. */ * As a counterpart to the access to the source code and rights to copy,
private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle * modify and redistribute granted by the license, users are provided only
.getBundle(BUNDLE_NAME); * with a limited warranty and the software's author, the holder of the
/** The logger. */ * economic rights, and the successive licensors have only limited
private static final Logger LOGGER = Logger * liability.
.getLogger(CLIPrompterMessages.class.getName()); *
* In this respect, the user's attention is drawn to the risks associated
/** Utility class. */ * with loading, using, modifying and/or developing or reproducing the
private CLIPrompterMessages() { * software by the user in light of its specific status of free software,
// Utility constructor * 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
/** Return the formatted message corresponding to the given key. * encouraged to load and test the software's suitability as regards their
* * requirements in conditions enabling the security of their systems and/or
* @param key the message's key * data to be ensured and, more generally, to use and operate it in the
* @param args the arguments * same conditions as regards security.
* @return the formatted message */ *
public static String getString(final String key, final Object... args) { * The fact that you are presently reading this means that you have had
try { * knowledge of the CeCILL license and that you accept its terms.
return MessageFormat.format(RESOURCE_BUNDLE.getString(key), args); * #L%
} catch (final MissingResourceException e) { */
LOGGER.warning("Unrecognized key: " + key); //$NON-NLS-1$ import java.text.MessageFormat;
LOGGER.log(Level.FINE, "Missing key in " + BUNDLE_NAME, e); //$NON-NLS-1$ import java.util.MissingResourceException;
return '!' + key + '!'; import java.util.ResourceBundle;
} import java.util.logging.Level;
} import java.util.logging.Logger;
}
/** Utility class for the messages of the CLIPrompter.
*
* @author Emmanuel BIGEON */
public final class CLIPrompterMessages {
/** The resource name. */
private static final String BUNDLE_NAME = "net.bigeon.gclc.messages"; //$NON-NLS-1$
/** The resource. */
private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
.getBundle(BUNDLE_NAME);
/** The logger. */
private static final Logger LOGGER = Logger
.getLogger(CLIPrompterMessages.class.getName());
/** Utility class. */
private CLIPrompterMessages() {
// Utility constructor
}
/** Return the formatted message corresponding to the given key.
*
* @param key the message's key
* @param args the arguments
* @return the formatted message */
public static String getString(final String key, final Object... args) {
try {
return MessageFormat.format(RESOURCE_BUNDLE.getString(key), args);
} catch (final MissingResourceException e) {
LOGGER.warning("Unrecognized key: " + key); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Missing key in " + BUNDLE_NAME, e); //$NON-NLS-1$
return '!' + key + '!';
}
}
}

View File

@@ -1,47 +1,45 @@
/* /** 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.
* This software is governed by the CeCILL license under French law and *
* abiding by the rules of distribution of free software. You can use, * @author Emmanuel BIGEON */
* modify and/or redistribute the software under the terms of the CeCILL package net.bigeon.gclc.prompt;
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". /*-
* * #%L
* As a counterpart to the access to the source code and rights to copy, * Generic Command Ligne console
* modify and redistribute granted by the license, users are provided only * %%
* with a limited warranty and the software's author, the holder of the * Copyright (C) 2014 - 2018 bigeon.fr
* economic rights, and the successive licensors have only limited * %%
* liability. * This software is governed by the CeCILL license under French law and
* * abiding by the rules of distribution of free software. You can use,
* In this respect, the user's attention is drawn to the risks associated * modify and/ or redistribute the software under the terms of the CeCILL
* with loading, using, modifying and/or developing or reproducing the * license as circulated by CEA, CNRS and INRIA at the following URL
* software by the user in light of its specific status of free software, * "http://www.cecill.info".
* that may mean that it is complicated to manipulate, and that also *
* therefore means that it is reserved for developers and experienced * As a counterpart to the access to the source code and rights to copy,
* professionals having in-depth computer knowledge. Users are therefore * modify and redistribute granted by the license, users are provided only
* encouraged to load and test the software's suitability as regards their * with a limited warranty and the software's author, the holder of the
* requirements in conditions enabling the security of their systems and/or * economic rights, and the successive licensors have only limited
* data to be ensured and, more generally, to use and operate it in the * liability.
* same conditions as regards security. *
* * In this respect, the user's attention is drawn to the risks associated
* The fact that you are presently reading this means that you have had * with loading, using, modifying and/or developing or reproducing the
* knowledge of the CeCILL license and that you accept its terms. * 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
/** gclc:fr.bigeon.gclc.prompt.package-info.java * therefore means that it is reserved for developers and experienced
* Created on: Sep 6, 2014 */ * professionals having in-depth computer knowledge. Users are therefore
/** Client prompting related objects. * encouraged to load and test the software's suitability as regards their
* <p> * requirements in conditions enabling the security of their systems and/or
* This package is used for the formatting of prompts for the user. The * data to be ensured and, more generally, to use and operate it in the
* {@link fr.bigeon.gclc.prompt.CLIPrompter} class provides utility methods to * same conditions as regards security.
* retrieve certain basic type of data from the user or to give list choices. *
* <p> * The fact that you are presently reading this means that you have had
* The {@link fr.bigeon.gclc.prompt.CLIPrompterMessages} class is used for * knowledge of the CeCILL license and that you accept its terms.
* internationalization of the prompting methods. * #L%
* */
* @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

@@ -1,116 +1,149 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.
*/ */
/** /**
* 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;
import java.util.ArrayList; /*-
import java.util.List; * #%L
* Generic Command Ligne console
/** A tool class for printing text in a console. * %%
* * Copyright (C) 2014 - 2018 bigeon.fr
* @author Emmanuel BIGEON */ * %%
public final class PrintUtils { * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
/** The continuation dot string. */ * modify and/ or redistribute the software under the terms of the CeCILL
private static final String CONT_DOT = "..."; //$NON-NLS-1$ * license as circulated by CEA, CNRS and INRIA at the following URL
/** The continuation dot string length. */ * "http://www.cecill.info".
private static final int CONT_DOT_LENGTH = CONT_DOT.length(); *
/** The empty string constant. */ * As a counterpart to the access to the source code and rights to copy,
private static final String EMPTY = ""; //$NON-NLS-1$ * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
/** Utility class. */ * economic rights, and the successive licensors have only limited
private PrintUtils() { * liability.
// Utility class *
} * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
/** Print the text possibly cutting it if it goes over the authorized length * software by the user in light of its specific status of free software,
* and adding a mark of continuation. * that may mean that it is complicated to manipulate, and that also
* * therefore means that it is reserved for developers and experienced
* @param text the text to print * professionals having in-depth computer knowledge. Users are therefore
* @param nbCharacters the number of characters of the resulting text * encouraged to load and test the software's suitability as regards their
* @param indicateTooLong if an indication shell be given that the text * requirements in conditions enabling the security of their systems and/or
* didn't fit * data to be ensured and, more generally, to use and operate it in the
* @return the text to print (will be of exactly nbCharacters). */ * same conditions as regards security.
public static String print(final String text, final int nbCharacters, *
final boolean indicateTooLong) { * The fact that you are presently reading this means that you have had
StringBuilder res = new StringBuilder(text); * knowledge of the CeCILL license and that you accept its terms.
if (res.length() > nbCharacters) { * #L%
// Cut */
if (indicateTooLong) { import java.util.ArrayList;
// With suspension dots import java.util.List;
res = res.replace(nbCharacters - CONT_DOT_LENGTH, text.length(),
CONT_DOT); /** A tool class for printing text in a console.
} else { *
res = res.replace(nbCharacters, text.length(), ""); //$NON-NLS-1$ * @author Emmanuel BIGEON */
} public final class PrintUtils {
}
while (res.length() < nbCharacters) { /** The continuation dot string. */
// Add trailing space private static final String CONT_DOT = "..."; //$NON-NLS-1$
res.append(' '); /** The continuation dot string length. */
} private static final int CONT_DOT_LENGTH = CONT_DOT.length();
return res.toString(); /** The empty string constant. */
} private static final String EMPTY = ""; //$NON-NLS-1$
/** Wrap the text, cutting at spaces. /** Utility class. */
* private PrintUtils() {
* @param description the element to wrap in lines // Utility class
* @param i the length of the wrap }
* @return the list of resulting strings */
public static List<String> wrap(final String description, final int i) { /** Print the text possibly cutting it if it goes over the authorized length
final String[] originalLines = description * and adding a mark of continuation.
.split(System.lineSeparator()); *
final List<String> result = new ArrayList<>(); * @param text the text to print
for (final String string : originalLines) { * @param nbCharacters the number of characters of the resulting text
String toCut = string; * @param indicateTooLong if an indication shell be given that the text
while (toCut.length() > i) { * didn't fit
int index = toCut.lastIndexOf(' ', i); * @return the text to print (will be of exactly nbCharacters). */
if (index == -1) { public static String print(final String text, final int nbCharacters,
result.add(toCut.substring(0, i)); final boolean indicateTooLong) {
index = i - 1; StringBuilder res = new StringBuilder(text);
} else { if (res.length() > nbCharacters) {
result.add(toCut.substring(0, index)); // Cut
} if (indicateTooLong) {
toCut = toCut.substring(index + 1); // With suspension dots
} res = res.replace(nbCharacters - CONT_DOT_LENGTH, text.length(),
result.add(toCut); CONT_DOT);
result.add(EMPTY); } else {
} res = res.replace(nbCharacters, text.length(), ""); //$NON-NLS-1$
result.remove(result.size() - 1); }
return result; }
} while (res.length() < nbCharacters) {
} // Add trailing space
res.append(' ');
}
return res.toString();
}
/** Wrap the text, cutting at spaces.
*
* @param description the element to wrap in lines
* @param i the length of the wrap
* @return the list of resulting strings */
public static List<String> wrap(final String description, final int i) {
final String[] originalLines = description
.split(System.lineSeparator());
final List<String> result = new ArrayList<>();
for (final String string : originalLines) {
String toCut = string;
while (toCut.length() > i) {
int index = toCut.lastIndexOf(' ', i);
if (index == -1) {
result.add(toCut.substring(0, i));
index = i - 1;
} else {
result.add(toCut.substring(0, index));
}
toCut = toCut.substring(index + 1);
}
result.add(toCut);
result.add(EMPTY);
}
result.remove(result.size() - 1);
return result;
}
}

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

@@ -1,137 +1,168 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
import java.io.IOException; /*-
import java.util.logging.Level; * #%L
import java.util.logging.Logger; * Generic Command Ligne console
* %%
import fr.bigeon.gclc.manager.PipedConsoleOutput; * Copyright (C) 2014 - 2018 bigeon.fr
* %%
/** An incomplete implematation used to forward messages from a piped console. * This software is governed by the CeCILL license under French law and
* <p> * abiding by the rules of distribution of free software. You can use,
* This forwarding can be interrupted without closing the piped manager. * modify and/ or redistribute the software under the terms of the CeCILL
* * license as circulated by CEA, CNRS and INRIA at the following URL
* @author Emmanuel Bigeon */ * "http://www.cecill.info".
public abstract class AOutputForwardRunnable implements Runnable { *
* As a counterpart to the access to the source code and rights to copy,
/** The class logger. */ * modify and redistribute granted by the license, users are provided only
private static final Logger LOGGER = Logger * with a limited warranty and the software's author, the holder of the
.getLogger(AOutputForwardRunnable.class.getName()); * economic rights, and the successive licensors have only limited
/** The default timeout (one tenth of second). */ * liability.
private static final long DEFAULT_TIMEOUT = 100; *
/** The manager. */ * In this respect, the user's attention is drawn to the risks associated
private final PipedConsoleOutput manager; * with loading, using, modifying and/or developing or reproducing the
/** The timeout. */ * software by the user in light of its specific status of free software,
private final long timeout; * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
/** Create a forwarding runnable. * professionals having in-depth computer knowledge. Users are therefore
* * encouraged to load and test the software's suitability as regards their
* @param manager the manager */ * requirements in conditions enabling the security of their systems and/or
public AOutputForwardRunnable(final PipedConsoleOutput manager) { * data to be ensured and, more generally, to use and operate it in the
super(); * same conditions as regards security.
this.manager = manager; *
timeout = DEFAULT_TIMEOUT; * 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%
/** Create a forward runnable with the given timeout. */
* <p> import java.io.IOException;
* Short timeout will be very responsive to the application actual messages, import java.util.logging.Level;
* but may use computation time if the application is not verbose. Long import java.util.logging.Logger;
* timeout will save computation time, but will read batches of messages at
* once if the application is verbose. The right length for the timeout is /** An incomplete implematation used to forward messages from a piped console.
* likely to depend on the application and the use of it. * <p>
* <p> * This forwarding can be interrupted without closing the piped manager.
* If you do not know what timeout length to use, please use the *
* {@link #AOutputForwardRunnable(PipedConsoleOutput)} constructor. * @author Emmanuel Bigeon */
* public abstract class AOutputForwardRunnable implements Runnable {
* @param manager the manager
* @param timeout the timeout between message requests. */ /** The class logger. */
public AOutputForwardRunnable(final PipedConsoleOutput manager, private static final Logger LOGGER = Logger
final long timeout) { .getLogger(AOutputForwardRunnable.class.getName());
super(); /** The default timeout (one tenth of second). */
this.manager = manager; private static final long DEFAULT_TIMEOUT = 100;
this.timeout = timeout; /** The manager. */
} private final PipedConsoleOutput manager;
/** The timeout. */
/** Do forward the line. private final long timeout;
*
* @param m the line to forward */ /** Create a forwarding runnable.
protected abstract void forwardLine(String m); *
* @param manager the manager */
/** Test if the runable is still running. public AOutputForwardRunnable(final PipedConsoleOutput manager) {
* super();
* @return if the thread should keep running */ this.manager = manager;
protected abstract boolean isRunning(); timeout = DEFAULT_TIMEOUT;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */ /** Create a forward runnable with the given timeout.
@Override * <p>
public final void run() { * Short timeout will be very responsive to the application actual messages,
try { * but may use computation time if the application is not verbose. Long
while (isRunning()) { * timeout will save computation time, but will read batches of messages at
while (isRunning() && !manager.available()) { * once if the application is verbose. The right length for the timeout is
waitASec(); * likely to depend on the application and the use of it.
} * <p>
if (!isRunning()) { * If you do not know what timeout length to use, please use the
return; * {@link #AOutputForwardRunnable(PipedConsoleOutput)} constructor.
} *
final String m = manager.readNextLine(); * @param manager the manager
forwardLine(m); * @param timeout the timeout between message requests. */
} public AOutputForwardRunnable(final PipedConsoleOutput manager,
} catch (final IOException e) { final long timeout) {
LOGGER.log(Level.SEVERE, "Unexpected problem in manager", //$NON-NLS-1$ super();
e); this.manager = manager;
} this.timeout = timeout;
} }
/** a method to wait some time. */ /** Do forward the line.
protected final void waitASec() { *
try { * @param m the line to forward */
synchronized (this) { protected abstract void forwardLine(String m);
wait(timeout);
} /** Test if the runable is still running.
} catch (final InterruptedException e) { *
LOGGER.log(Level.SEVERE, "Interrupted wait", //$NON-NLS-1$ * @return if the thread should keep running */
e); protected abstract boolean isRunning();
Thread.currentThread().interrupt();
} /* (non-Javadoc)
} * @see java.lang.Runnable#run() */
@Override
} public final void run() {
try {
while (isRunning()) {
while (isRunning() && !manager.available()) {
waitASec();
}
if (!isRunning()) {
return;
}
final String m = manager.readNextLine();
forwardLine(m);
}
} catch (final IOException e) {
LOGGER.log(Level.SEVERE, "Unexpected problem in manager", //$NON-NLS-1$
e);
}
}
/** a method to wait some time. */
protected final void waitASec() {
try {
synchronized (this) {
wait(timeout);
}
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interrupted wait", //$NON-NLS-1$
e);
Thread.currentThread().interrupt();
}
}
}

View File

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

View File

@@ -1,153 +1,188 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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-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; /*-
import java.io.IOException; * #%L
import java.io.InputStreamReader; * Generic Command Ligne console
import java.io.PipedInputStream; * %%
import java.io.PipedOutputStream; * Copyright (C) 2014 - 2018 bigeon.fr
import java.io.PrintStream; * %%
import java.nio.charset.StandardCharsets; * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
/** This console output allows to retrieve the output as an input. * modify and/ or redistribute the software under the terms of the CeCILL
* <p> * license as circulated by CEA, CNRS and INRIA at the following URL
* This console output is used to internally pilot an application. This can be * "http://www.cecill.info".
* used to test application behavior. *
* * As a counterpart to the access to the source code and rights to copy,
* @author Emmanuel Bigeon */ * modify and redistribute granted by the license, users are provided only
public final class PipedConsoleOutput * with a limited warranty and the software's author, the holder of the
implements ConsoleOutput { * economic rights, and the successive licensors have only limited
* liability.
/** The encoding between streams. */ *
private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$ * In this respect, the user's attention is drawn to the risks associated
/** THe inner manager. */ * with loading, using, modifying and/or developing or reproducing the
private final StreamConsoleOutput innerManager; * software by the user in light of its specific status of free software,
/** The reader to get application return from. */ * that may mean that it is complicated to manipulate, and that also
private final BufferedReader commandBuffOutput; * therefore means that it is reserved for developers and experienced
/** The stream to get application return from. */ * professionals having in-depth computer knowledge. Users are therefore
private final PipedInputStream commandOutput; * encouraged to load and test the software's suitability as regards their
/** The print writer for application to write return to. */ * requirements in conditions enabling the security of their systems and/or
private final PrintStream outPrint; * data to be ensured and, more generally, to use and operate it in the
/** The reading thread. */ * same conditions as regards security.
private final ReadingRunnable reading; *
* The fact that you are presently reading this means that you have had
/** Create a manager that will write and read through piped stream. * knowledge of the CeCILL license and that you accept its terms.
* * #L%
* @throws IOException if the piping failed for streams */ */
public PipedConsoleOutput() throws IOException { import java.io.BufferedReader;
commandOutput = new PipedInputStream(); import java.io.IOException;
final PipedOutputStream out = new PipedOutputStream(commandOutput); import java.io.InputStreamReader;
commandBuffOutput = new BufferedReader( import java.io.PipedInputStream;
new InputStreamReader(commandOutput, StandardCharsets.UTF_8)); import java.io.PipedOutputStream;
outPrint = new PrintStream(out, true, UTF_8); import java.io.PrintStream;
innerManager = new StreamConsoleOutput(outPrint); import java.nio.charset.StandardCharsets;
reading = new ReadingRunnable(commandBuffOutput);
final Thread th = new Thread(reading, "read"); //$NON-NLS-1$ import net.bigeon.gclc.manager.ConsoleOutput;
th.setDaemon(true);
th.start(); /** This console output allows to retrieve the output as an input.
} * <p>
* This console output is used to internally pilot an application. This can be
/** Test if there is available data. * used to test application behavior.
* *
* @return the content of the next line written by the application * @author Emmanuel Bigeon */
* @throws IOException if the reading failed */ public final class PipedConsoleOutput
public boolean available() throws IOException { implements ConsoleOutput {
return reading.hasMessage();
} /** The encoding between streams. */
private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$
/* (non-Javadoc) /** THe inner manager. */
* @see java.lang.AutoCloseable#close() */ private final StreamConsoleOutput innerManager;
@Override /** The reader to get application return from. */
public void close() throws IOException { private final BufferedReader commandBuffOutput;
reading.setRunning(false); /** The stream to get application return from. */
innerManager.close(); private final PipedInputStream commandOutput;
outPrint.close(); /** The print writer for application to write return to. */
commandBuffOutput.close(); private final PrintStream outPrint;
commandOutput.close(); /** The reading thread. */
} private final ReadingRunnable reading;
/** Wait for a specific message to arrive. /** Create a manager that will write and read through piped stream.
* <p> *
* When this method returns, the message was appended to the data, it * @throws IOException if the piping failed for streams */
* <em>may or may not</em> be the next line of data. public PipedConsoleOutput() throws IOException {
* commandOutput = new PipedInputStream();
* @param message the message final PipedOutputStream out = new PipedOutputStream(commandOutput);
* @return the thread to join to wait for message delivery commandBuffOutput = new BufferedReader(
* @see fr.bigeon.gclc.manager.ReadingRunnable#getWaitForDelivery(java.lang.String) */ new InputStreamReader(commandOutput, StandardCharsets.UTF_8));
public Thread getWaitForDelivery(final String message) { outPrint = new PrintStream(out, true, UTF_8);
return reading.getWaitForDelivery(message); innerManager = new StreamConsoleOutput(outPrint);
} reading = new ReadingRunnable(commandBuffOutput);
final Thread th = new Thread(reading, "GCLC console output forward"); //$NON-NLS-1$
/* (non-Javadoc) th.setDaemon(true);
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */ th.start();
@Override }
public boolean isClosed() {
return innerManager.isClosed(); /** Test if there is available data.
} *
* @return the content of the next line written by the application
/* (non-Javadoc) * @throws IOException if the reading failed */
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */ public boolean available() throws IOException {
@Override return reading.hasMessage();
public void print(final String object) throws IOException { }
innerManager.print(object);
} /* (non-Javadoc)
* @see java.lang.AutoCloseable#close() */
/* (non-Javadoc) @Override
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */ public void close() throws IOException {
@Override reading.setRunning(false);
public void println() throws IOException { innerManager.close();
innerManager.println(); outPrint.close();
} commandBuffOutput.close();
commandOutput.close();
/* (non-Javadoc) }
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
@Override /** Wait for a specific message to arrive.
public void println(final String object) throws IOException { * <p>
innerManager.println(object); * When this method returns, the message was appended to the data, it
} * <em>may or may not</em> be the next line of data.
*
/** Read the next line of data. * @param message the message
* * @return the thread to join to wait for message delivery
* @return the content of the next line written by the application * @see net.bigeon.gclc.utils.ReadingRunnable#getWaitForDelivery(java.lang.String) */
* @throws IOException if the reading failed */ public Thread getWaitForDelivery(final String message) {
public String readNextLine() throws IOException { return reading.getWaitForDelivery(message);
return reading.getMessage(); }
}
} /* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#isClosed() */
@Override
public boolean isClosed() {
return innerManager.isClosed();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
@Override
public void print(final String object) throws IOException {
innerManager.print(object);
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#println() */
@Override
public void println() throws IOException {
innerManager.println();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
@Override
public void println(final String object) throws IOException {
innerManager.println(object);
}
/** Read the next line of data.
*
* @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();
}
}

View File

@@ -1,354 +1,386 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
import java.io.BufferedReader; /*-
import java.io.IOException; * #%L
import java.io.InterruptedIOException; * Generic Command Ligne console
import java.util.ArrayDeque; * %%
import java.util.Deque; * Copyright (C) 2014 - 2018 bigeon.fr
import java.util.HashMap; * %%
import java.util.Map; * This software is governed by the CeCILL license under French law and
import java.util.logging.Level; * abiding by the rules of distribution of free software. You can use,
import java.util.logging.Logger; * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
/** A runnable to read the piped output. * "http://www.cecill.info".
* *
* @author Emmanuel Bigeon */ * As a counterpart to the access to the source code and rights to copy,
public final class ReadingRunnable implements Runnable { * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
/** The runnable to wait for arrival of a message in the queue. * economic rights, and the successive licensors have only limited
* * liability.
* @author Emmanuel Bigeon */ *
private final class ToWaitRunnable implements Runnable { * In this respect, the user's attention is drawn to the risks associated
/** The Object. */ * with loading, using, modifying and/or developing or reproducing the
private final Object obj; * software by the user in light of its specific status of free software,
/** The locking object. */ * that may mean that it is complicated to manipulate, and that also
private final Object start; * therefore means that it is reserved for developers and experienced
/** The message. */ * professionals having in-depth computer knowledge. Users are therefore
private final String message; * encouraged to load and test the software's suitability as regards their
/** The started status. */ * requirements in conditions enabling the security of their systems and/or
private boolean started = false; * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
/** Create the waiting runnable. *
* * The fact that you are presently reading this means that you have had
* @param obj the object to lock on * knowledge of the CeCILL license and that you accept its terms.
* @param start the object to notify when ready to wait * #L%
* @param message the message to wait for */ */
public ToWaitRunnable(final Object obj, final Object start, import java.io.BufferedReader;
final String message) { import java.io.IOException;
this.obj = obj; import java.io.InterruptedIOException;
this.start = start; import java.util.ArrayDeque;
this.message = message; import java.util.Deque;
} import java.util.HashMap;
import java.util.Map;
/** Test if the waiting runnable is started. import java.util.logging.Level;
* import java.util.logging.Logger;
* @return the started */
public boolean isStarted() { /** A runnable to read the piped output.
synchronized (start) { *
return started; * @author Emmanuel Bigeon */
} public final class ReadingRunnable implements Runnable {
}
/** The runnable to wait for arrival of a message in the queue.
/* (non-Javadoc) *
* @see java.lang.Runnable#run() */ * @author Emmanuel Bigeon */
@SuppressWarnings("synthetic-access") private final class ToWaitRunnable implements Runnable {
@Override /** The Object. */
public void run() { private final Object obj;
synchronized (obj) { /** The locking object. */
synchronized (start) { private final Object start;
started = true; /** The message. */
start.notifyAll(); private final String message;
} /** The started status. */
while (isRunning()) { private boolean started = false;
try {
obj.wait(); /** Create the waiting runnable.
if (delivering.equals(message)) { *
return; * @param obj the object to lock on
} * @param start the object to notify when ready to wait
} catch (final InterruptedException e) { * @param message the message to wait for */
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, public ToWaitRunnable(final Object obj, final Object start,
e); final String message) {
Thread.currentThread().interrupt(); this.obj = obj;
} this.start = start;
} this.message = message;
} }
}
} /** Test if the waiting runnable is started.
*
/** The thread intteruption logging message. */ * @return the started */
private static final String THREAD_INTERRUPTION_EXCEPTION = "Thread interruption exception."; //$NON-NLS-1$ public boolean isStarted() {
/** The closed pipe message. */ synchronized (start) {
private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$ return started;
/** Wait timeout. */ }
private static final long TIMEOUT = 1000; }
/** Class logger. */
private static final Logger LOGGER = Logger /* (non-Javadoc)
.getLogger(ReadingRunnable.class.getName()); * @see java.lang.Runnable#run() */
/** Read messages. */ @Override
private final Deque<String> messages = new ArrayDeque<>(); public void run() {
/** the reader. */ synchronized (obj) {
private final BufferedReader reader; synchronized (start) {
/** the state of this runnable. */ started = true;
private boolean running = true; start.notifyAll();
/** Synchro object. */ }
private final Object lock = new Object(); while (isRunning()) {
/** The waiting status for a message. */ try {
private boolean waiting; obj.wait();
/** The blocker for a given message. */ if (delivering.equals(message)) {
private final Map<String, Object> messageBlocker = new HashMap<>(); return;
/** The lock. */ }
private final Object messageBlockerLock = new Object(); } catch (final InterruptedException e) {
/** The message being delivered. */ LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
private String delivering; e);
Thread.currentThread().interrupt();
/** Create a reading runnable. }
* }
* @param reader the input to read from */ }
public ReadingRunnable(final BufferedReader reader) { }
super(); }
this.reader = reader;
} /** The thread intteruption logging message. */
private static final String THREAD_INTERRUPTION_EXCEPTION = "Thread interruption exception."; //$NON-NLS-1$
/** Strip the string from head NULL characters. /** The closed pipe message. */
* private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$
* @param line the line to strip the null character from /** Wait timeout. */
* @return the resulting string */ private static final long TIMEOUT = 1000;
private static String stripNull(final String line) { /** Class logger. */
String res = line; private static final Logger LOGGER = Logger
while (res.length() > 0 && res.charAt(0) == 0) { .getLogger(ReadingRunnable.class.getName());
LOGGER.severe( /** Read messages. */
"NULL character heading the result of the read. This is a stream problem..."); //$NON-NLS-1$ private final Deque<String> messages = new ArrayDeque<>();
res = res.substring(1); /** the reader. */
} private final BufferedReader reader;
return res; /** the state of this runnable. */
} private boolean running = true;
/** Synchro object. */
/** do wait for a message. private final Object lock = new Object();
* <p>This method should only be called inside a loop. /** The waiting status for a message. */
* @param timeout the timeout of the wait. private boolean waiting;
* @throws IOException if the runnable was stopped and no essage was found. /** The blocker for a given message. */
*/ private final Map<String, Object> messageBlocker = new HashMap<>();
private void doWaitMessage(final long timeout) throws IOException { /** The lock. */
try { private final Object messageBlockerLock = new Object();
lock.wait(timeout); /** The message being delivered. */
} catch (final InterruptedException e) { private String delivering;
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e);
Thread.currentThread().interrupt(); /** Create a reading runnable.
} *
if (messages.isEmpty() && !running) { * @param reader the input to read from */
throw new IOException(CLOSED_PIPE); public ReadingRunnable(final BufferedReader reader) {
} super();
} this.reader = reader;
}
/** Get the next message.
* /** Strip the string from head NULL characters.
* @return the next read message *
* @throws IOException if the pipe is closed */ * @param line the line to strip the null character from
public String getMessage() throws IOException { * @return the resulting string */
synchronized (lock) { private static String stripNull(final String line) {
if (!running) { String res = line;
throw new IOException(CLOSED_PIPE); while (res.length() > 0 && res.charAt(0) == 0) {
} LOGGER.severe(
waiting = true; "NULL character heading the result of the read. This is a stream problem..."); //$NON-NLS-1$
waitMessage(TIMEOUT); res = res.substring(1);
LOGGER.finest("Polled: " + messages.peek()); //$NON-NLS-1$ }
waiting = false; return res;
notifyMessage(messages.peek()); }
return messages.poll();
} /** do wait for a message.
} * <p>This method should only be called inside a loop.
* @param timeout the timeout of the wait.
/** Get the next message, but wait only a given time for it. * @throws IOException if the runnable was stopped and no essage was found.
* */
* @param timeout the read time out private void doWaitMessage(final long timeout) throws IOException {
* @return The next message that was in the input try {
* @throws IOException if the input was closed */ lock.wait(timeout);
public String getNextMessage(final long timeout) throws IOException { } catch (final InterruptedException e) {
synchronized (lock) { LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e);
if (!running) { Thread.currentThread().interrupt();
throw new IOException(CLOSED_PIPE); }
} if (messages.isEmpty() && !running) {
waiting = true; throw new IOException(CLOSED_PIPE);
doWaitMessage(timeout); }
waiting = false; }
if (messages.isEmpty()) {
return null; /** Get the next message.
} *
return messages.poll(); * @return the next read message
} * @throws IOException if the pipe is closed */
} public String getMessage() throws IOException {
synchronized (lock) {
/** Get a waiting thread for a specific message delivery. if (!running) {
* throw new IOException(CLOSED_PIPE);
* @param message the message }
* @return the thread to join to wait for message delivery */ waiting = true;
public Thread getWaitForDelivery(final String message) { waitMessage(TIMEOUT);
synchronized (messageBlockerLock) { LOGGER.finest("Polled: " + messages.peek()); //$NON-NLS-1$
if (!messageBlocker.containsKey(message)) { waiting = false;
messageBlocker.put(message, new Object()); notifyMessage(messages.peek());
} return messages.poll();
final Object obj = messageBlocker.get(message); }
final Object start = new Object(); }
final ToWaitRunnable waitRunn = new ToWaitRunnable(obj, start,
message); /** Get the next message, but wait only a given time for it.
final Thread th = new Thread(waitRunn); *
* @param timeout the read time out
synchronized (start) { * @return The next message that was in the input
th.start(); * @throws IOException if the input was closed */
while (!waitRunn.isStarted()) { public String getNextMessage(final long timeout) throws IOException {
try { synchronized (lock) {
start.wait(TIMEOUT); if (!running) {
} catch (final InterruptedException e) { throw new IOException(CLOSED_PIPE);
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, }
e); waiting = true;
Thread.currentThread().interrupt(); doWaitMessage(timeout);
} waiting = false;
} if (messages.isEmpty()) {
} return null;
return th; }
} return messages.poll();
} }
}
/** Test if some data is available.
* /** Get a waiting thread for a specific message delivery.
* @return if a message is waiting *
* @throws IOException if the pipe is closed */ * @param message the message
public boolean hasMessage() throws IOException { * @return the thread to join to wait for message delivery */
synchronized (lock) { public Thread getWaitForDelivery(final String message) {
if (!running) { synchronized (messageBlockerLock) {
throw new IOException(CLOSED_PIPE); if (!messageBlocker.containsKey(message)) {
} messageBlocker.put(message, new Object());
return !messages.isEmpty(); }
} final Object obj = messageBlocker.get(message);
} final Object start = new Object();
final ToWaitRunnable waitRunn = new ToWaitRunnable(obj, start,
/** Interrupts the wait on the next message by providing an empty message);
* message. */ final Thread th = new Thread(waitRunn);
public void interrupt() {
synchronized (lock) { synchronized (start) {
if (waiting) { th.start();
messages.offer(""); //$NON-NLS-1$ while (!waitRunn.isStarted()) {
lock.notifyAll(); try {
} start.wait(TIMEOUT);
} } catch (final InterruptedException e) {
} LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
e);
/** Test if this element is still running. Thread.currentThread().interrupt();
* }
* @return the running */ }
public boolean isRunning() { }
synchronized (lock) { return th;
return running; }
} }
}
/** Test if some data is available.
/** Notify the arrival of a given message. *
* * @return if a message is waiting
* @param message the message */ * @throws IOException if the pipe is closed */
private void notifyMessage(final String message) { public boolean hasMessage() throws IOException {
synchronized (messageBlockerLock) { synchronized (lock) {
delivering = message; if (!running) {
if (messageBlocker.containsKey(message)) { throw new IOException(CLOSED_PIPE);
final Object mLock = messageBlocker.get(message); }
synchronized (mLock) { return !messages.isEmpty();
mLock.notifyAll(); }
} }
messageBlocker.remove(message);
} /** Interrupts the wait on the next message by providing an empty
} * message. */
} public void interrupt() {
synchronized (lock) {
/* (non-Javadoc) if (waiting) {
* @see java.lang.Runnable#run() */ messages.offer(""); //$NON-NLS-1$
@Override lock.notifyAll();
public void run() { }
while (running) { }
try { }
String line = reader.readLine();
if (line == null) { /** Test if this element is still running.
// Buffer end *
running = false; * @return the running */
return; public boolean isRunning() {
} synchronized (lock) {
LOGGER.finer("Read: " + line); //$NON-NLS-1$ return running;
line = stripNull(line); }
synchronized (lock) { }
messages.add(line);
lock.notifyAll(); /** Notify the arrival of a given message.
} *
} catch (final InterruptedIOException e) { * @param message the message */
if (running) { private void notifyMessage(final String message) {
LOGGER.info("Reading interrupted"); //$NON-NLS-1$ synchronized (messageBlockerLock) {
} delivering = message;
LOGGER.log(Level.FINER, if (messageBlocker.containsKey(message)) {
"Read interruption was caused by an exception", e); //$NON-NLS-1$ final Object mLock = messageBlocker.get(message);
} catch (final IOException e) { synchronized (mLock) {
LOGGER.log(Level.FINE, "The stream reading threw an exception", //$NON-NLS-1$ mLock.notifyAll();
e); }
if (running) { messageBlocker.remove(message);
LOGGER.severe("Unable to read from stream"); //$NON-NLS-1$ }
running = false; }
} }
return;
} /* (non-Javadoc)
} * @see java.lang.Runnable#run() */
} @Override
public void run() {
/** Set the running status for this reading runnable. while (running) {
* try {
* @param running the running to set */ String line = reader.readLine();
public void setRunning(final boolean running) { if (line == null) {
synchronized (lock) { // Buffer end
this.running = running; running = false;
} return;
} }
LOGGER.finer("Read: " + line); //$NON-NLS-1$
/** Wait for the next message to be integratted. line = stripNull(line);
* synchronized (lock) {
* @param timeout the timeout to wait messages.add(line);
* @throws IOException if the next message was not delivered and the lock.notifyAll();
* runnable stopped. */ }
private void waitMessage(final long timeout) throws IOException { } catch (final InterruptedIOException e) {
while (messages.isEmpty()) { if (running) {
doWaitMessage(timeout); LOGGER.info("Reading interrupted"); //$NON-NLS-1$
} }
} LOGGER.log(Level.FINER,
} "Read interruption was caused by an exception", e); //$NON-NLS-1$
} catch (final IOException e) {
LOGGER.log(Level.FINE, "The stream reading threw an exception", //$NON-NLS-1$
e);
if (running) {
LOGGER.severe("Unable to read from stream"); //$NON-NLS-1$
running = false;
}
return;
}
}
}
/** Set the running status for this reading runnable.
*
* @param running the running to set */
public void setRunning(final boolean running) {
synchronized (lock) {
this.running = running;
}
}
/** Wait for the next message to be integratted.
*
* @param timeout the timeout to wait
* @throws IOException if the next message was not delivered and the
* runnable stopped. */
private void waitMessage(final long timeout) throws IOException {
while (messages.isEmpty()) {
doWaitMessage(timeout);
}
}
}

View File

@@ -1,89 +1,124 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
/** A console output that absorbs every message. import net.bigeon.gclc.manager.ConsoleOutput;
*
* @author Emmanuel Bigeon */ /*-
public final class SinkOutput implements ConsoleOutput { * #%L
* Generic Command Ligne console
/** The sink output. */ * %%
public static final ConsoleOutput INSTANCE = new SinkOutput(); * Copyright (C) 2014 - 2018 bigeon.fr
* %%
/** Singleton constructor. */ * This software is governed by the CeCILL license under French law and
private SinkOutput() { * 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
/* (non-Javadoc) * "http://www.cecill.info".
* @see fr.bigeon.gclc.manager.ConsoleOutput#close() */ *
@Override * As a counterpart to the access to the source code and rights to copy,
public void close() { * 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.
/* (non-Javadoc) *
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */ * In this respect, the user's attention is drawn to the risks associated
@Override * with loading, using, modifying and/or developing or reproducing the
public boolean isClosed() { * software by the user in light of its specific status of free software,
return false; * 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
/* (non-Javadoc) * encouraged to load and test the software's suitability as regards their
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */ * requirements in conditions enabling the security of their systems and/or
@Override * data to be ensured and, more generally, to use and operate it in the
public void print(final String text) { * 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.
/* (non-Javadoc) * #L%
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */ */
@Override /** A console output that absorbs every message.
public void println() { *
// * @author Emmanuel Bigeon */
} public final class SinkOutput implements ConsoleOutput {
/* (non-Javadoc) /** The sink output. */
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) public static final ConsoleOutput INSTANCE = new SinkOutput();
*/
@Override /** Singleton constructor. */
public void println(final String message) { private SinkOutput() {
// //
} }
/* (non-Javadoc)
} * @see net.bigeon.gclc.manager.ConsoleOutput#close() */
@Override
public void close() {
//
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#isClosed() */
@Override
public boolean isClosed() {
return false;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
@Override
public void print(final String text) {
//
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#println() */
@Override
public void println() {
//
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String)
*/
@Override
public void println(final String message) {
//
}
}

View File

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

View File

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

View File

@@ -1,160 +1,193 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * Copyright Bigeon Emmanuel (2014)
* *
* 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
* provide a generic framework for console applications. * 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,
* 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".
* *
* As a counterpart to the access to the source code and rights to copy, * 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 * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * 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 * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * 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 * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* 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.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;
import java.io.IOException; /*-
import java.io.OutputStream; * #%L
import java.nio.ByteBuffer; * Generic Command Ligne console
import java.nio.charset.Charset; * %%
import java.util.ArrayDeque; * Copyright (C) 2014 - 2018 bigeon.fr
import java.util.Deque; * %%
import java.util.logging.Level; * This software is governed by the CeCILL license under French law and
import java.util.logging.Logger; * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
/** The runnable in charge of writing messages as they are read. * license as circulated by CEA, CNRS and INRIA at the following URL
* <p> * "http://www.cecill.info".
* Messages are queued to be retrieved latter on. *
* * As a counterpart to the access to the source code and rights to copy,
* @author Emmanuel Bigeon */ * modify and redistribute granted by the license, users are provided only
public final class WritingRunnable implements Runnable { * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
/** Wait timeout. */ * liability.
private static final long TIMEOUT = 1000; *
/** Class logger. */ * In this respect, the user's attention is drawn to the risks associated
private static final Logger LOGGER = Logger * with loading, using, modifying and/or developing or reproducing the
.getLogger(WritingRunnable.class.getName()); * software by the user in light of its specific status of free software,
/** Messages to write. */ * that may mean that it is complicated to manipulate, and that also
private final Deque<String> messages = new ArrayDeque<>(); * therefore means that it is reserved for developers and experienced
/** Stream to write to. */ * professionals having in-depth computer knowledge. Users are therefore
private final OutputStream outPrint; * encouraged to load and test the software's suitability as regards their
/** The charset. */ * requirements in conditions enabling the security of their systems and/or
private final Charset charset; * data to be ensured and, more generally, to use and operate it in the
/** Runnable state. */ * same conditions as regards security.
private boolean running = true; *
* The fact that you are presently reading this means that you have had
/** Synchro object. */ * knowledge of the CeCILL license and that you accept its terms.
private final Object lock = new Object(); * #L%
*/
/** Create the writing runnable. import java.io.IOException;
* import java.io.OutputStream;
* @param outPrint the output to print to import java.nio.ByteBuffer;
* @param charset the charset of the stream */ import java.nio.charset.Charset;
public WritingRunnable(final OutputStream outPrint, final Charset charset) { import java.util.ArrayDeque;
super(); import java.util.Deque;
this.outPrint = outPrint; import java.util.logging.Level;
this.charset = charset; import java.util.logging.Logger;
}
/** The runnable in charge of writing messages as they are read.
/** Add a message in the queue. * <p>
* * Messages are queued to be retrieved latter on.
* @param message the message *
* @throws IOException if the pipe is closed */ * @author Emmanuel Bigeon */
public void addMessage(final String message) throws IOException { public final class WritingRunnable implements Runnable {
synchronized (lock) {
if (!running) { /** Wait timeout. */
throw new IOException("Closed pipe"); //$NON-NLS-1$ private static final long TIMEOUT = 1000;
} /** Class logger. */
messages.offer(message); private static final Logger LOGGER = Logger
lock.notifyAll(); .getLogger(WritingRunnable.class.getName());
} /** Messages to write. */
} private final Deque<String> messages = new ArrayDeque<>();
/** Stream to write to. */
/** Test if the message is running. private final OutputStream outPrint;
* /** The charset. */
* @return the running */ private final Charset charset;
public boolean isRunning() { /** Runnable state. */
synchronized (lock) { private boolean running = true;
return running;
} /** Synchro object. */
} private final Object lock = new Object();
/* (non-Javadoc) /** Create the writing runnable.
* @see java.lang.Runnable#run() */ *
@Override * @param outPrint the output to print to
public void run() { * @param charset the charset of the stream */
while (running) { public WritingRunnable(final OutputStream outPrint, final Charset charset) {
synchronized (lock) { super();
while (messages.isEmpty()) { this.outPrint = outPrint;
waitNextMessage(); this.charset = charset;
if (!running) { }
return;
} /** Add a message in the queue.
} *
writeMessage(); * @param message the message
} * @throws IOException if the pipe is closed */
} public void addMessage(final String message) throws IOException {
} synchronized (lock) {
if (!running) {
/** Set the running status. throw new IOException("Closed pipe"); //$NON-NLS-1$
* }
* @param running the running to set */ messages.offer(message);
public void setRunning(final boolean running) { lock.notifyAll();
synchronized (lock) { }
this.running = running; }
}
} /** Test if the message is running.
*
/** Wait for next message. */ * @return the running */
private void waitNextMessage() { public boolean isRunning() {
try { synchronized (lock) {
lock.wait(TIMEOUT); return running;
} catch (final InterruptedException e) { }
if (running) { }
LOGGER.log(Level.SEVERE,
"Thread interruption exception.", e); //$NON-NLS-1$ /* (non-Javadoc)
} * @see java.lang.Runnable#run() */
Thread.currentThread().interrupt(); @Override
} public void run() {
} while (running) {
synchronized (lock) {
/** Write next message to output. */ while (messages.isEmpty()) {
private void writeMessage() { waitNextMessage();
final String message = messages.poll(); if (!running) {
final ByteBuffer buff = charset return;
.encode(message + System.lineSeparator()); }
if (buff.hasArray()) { }
try { writeMessage();
outPrint.write(buff.array()); }
} catch (final IOException e) { }
LOGGER.log(Level.SEVERE, "Unable to write to stream", //$NON-NLS-1$ }
e);
} /** Set the running status.
} *
} * @param running the running to set */
} public void setRunning(final boolean running) {
synchronized (lock) {
this.running = running;
}
}
/** Wait for next message. */
private void waitNextMessage() {
try {
lock.wait(TIMEOUT);
} catch (final InterruptedException e) {
if (running) {
LOGGER.log(Level.SEVERE,
"Thread interruption exception.", e); //$NON-NLS-1$
}
Thread.currentThread().interrupt();
}
}
/** Write next message to output. */
private void writeMessage() {
final String message = messages.poll();
final ByteBuffer buff = charset
.encode(message + System.lineSeparator());
if (buff.hasArray()) {
try {
outPrint.write(buff.array());
} catch (final IOException e) {
LOGGER.log(Level.SEVERE, "Unable to write to stream", //$NON-NLS-1$
e);
}
}
}
}

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