Compare commits

..

171 Commits

Author SHA1 Message Date
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
6bb937342e [maven-release-plugin] prepare release gclc-2.0.0 2017-11-13 22:40:38 -05:00
283090d361 Fix test, license, minor code cmpliance
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-13 22:38:32 -05:00
83c02f82ec Adding javadoc and code compliance
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-13 22:01:33 -05:00
fce2b01914 Share a project for process management in console
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-13 22:00:45 -05:00
9b071a378f Fixed test
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-13 19:13:56 -05:00
89e849c27f Update to next mechanism, with stream passed at command execution
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-13 19:09:00 -05:00
9747cf21b2 Add Code compliance
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-05 16:19:50 -05:00
6f8c536f55 Licensing of tests
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-08-19 23:23:35 -04:00
b3224ad689 Added test on processes
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-08-19 23:19:41 -04:00
0feb069878 Update to last version of gclc
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-08-19 16:35:06 -04:00
b5f1463864 Extract nested trys
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-08-19 16:17:55 -04:00
0bbe9d321d [maven-release-plugin] prepare for next development iteration 2017-08-19 15:48:11 -04:00
2e28e269e1 [maven-release-plugin] prepare release gclc-1.5.0 2017-08-19 15:48:07 -04:00
e11d90378f Removed deprecation, comments. Update major version
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-08-19 15:25:31 -04:00
6a0e68d312 [maven-release-plugin] prepare for next development iteration 2017-08-19 14:48:21 -04:00
3534e817e2 [maven-release-plugin] prepare release gclc-socket-1.1.8 2017-08-19 14:48:15 -04:00
20193dd1e4 Added comment 2017-08-19 14:38:04 -04:00
5df8321dee [maven-release-plugin] prepare for next development iteration 2017-05-10 18:15:03 -04:00
629d07bc32 [maven-release-plugin] prepare release gclc-1.4.0 2017-05-10 18:14:56 -04:00
e32e2428e5 Add task mechanism for the console
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-05-10 18:03:34 -04:00
db9f81c6a8 [maven-release-plugin] prepare for next development iteration 2017-04-23 09:41:23 -04:00
0a995394f9 [maven-release-plugin] prepare release gclc-1.3.7 2017-04-23 09:41:08 -04:00
0ca055db8e Licensing 2017-04-23 09:38:46 -04:00
b93c2b5220 Add prompt with timeout
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-04-20 13:23:28 -04:00
8322454f72 Adapted applications to make only attachement to the framework
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-04-19 13:14:04 -04:00
ab47d6573b Added a wait for application closing before closing of manager
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-21 16:37:24 -05:00
6d496d701d NLS fixes in script command definition
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-18 12:21:31 -05:00
b4df39491e Added pattern to script execution help
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-18 12:18:21 -05:00
775a71b2ec [maven-release-plugin] prepare for next development iteration 2016-12-16 11:54:30 -05:00
c9eb221d31 [maven-release-plugin] prepare release gclc-swt-1.1.3 2016-12-16 11:54:25 -05:00
340a0317af Removing focus forwarder from output field to input.
It seems to trouble the Ctrl-C mechanism in the output.

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-16 11:32:32 -05:00
35959a8d8a [maven-release-plugin] prepare for next development iteration 2016-12-06 14:47:02 -05:00
07645d7c0c [maven-release-plugin] prepare release gclc-socket-1.1.7 2016-12-06 14:47:00 -05:00
99c0c9008b Upgrade gclc-socket dependency on gclc 2016-12-06 14:34:40 -05:00
26265ad7e6 [maven-release-plugin] prepare for next development iteration 2016-12-06 14:27:22 -05:00
092883f4c3 [maven-release-plugin] prepare release gclc-1.3.6 2016-12-06 14:27:15 -05:00
25904c907d upgrade test to avoid memory leaks 2016-12-06 14:23:31 -05:00
ae55ebea29 Upgrade the gclc pom
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-06 13:05:11 -05:00
e989aff2f4 [maven-release-plugin] rollback the release of gclc-1.3.4 2016-12-06 13:03:29 -05:00
2f0c03a73b [maven-release-plugin] prepare release gclc-1.3.4 2016-12-06 12:59:04 -05:00
ff9ace1033 Fix test for getWaitRunnable 2016-12-06 12:56:42 -05:00
ffa54af3be [maven-release-plugin] rollback the release of gclc-1.3.4 2016-12-06 12:56:22 -05:00
269704f5a2 [maven-release-plugin] prepare for next development iteration 2016-12-06 12:51:25 -05:00
aecc18cc83 [maven-release-plugin] prepare release gclc-1.3.4 2016-12-06 12:51:15 -05:00
063cad61cd Upgrade dependency on gclc, fixed test. 2016-12-06 12:27:50 -05:00
201b6ad366 Added test on reading runnable 2016-12-06 11:39:36 -05:00
bf8d76750f Cleanup for release stage
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-06 11:35:38 -05:00
17ac47f15e [maven-release-plugin] prepare for next development iteration 2016-12-06 10:58:48 -05:00
7de2dadbe0 [maven-release-plugin] prepare release gclc-socket-1.1.6 2016-12-06 10:58:46 -05:00
50395ba852 upgrade dependencies on gclc
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-06 10:57:58 -05:00
248c82cf50 Systematic end of communication phase by sending 'Bye.'. modify tests.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-06 10:38:16 -05:00
6289ca1db9 [maven-release-plugin] prepare for next development iteration 2016-12-06 00:14:51 -05:00
5b6634eaf0 [maven-release-plugin] prepare release gclc-socket-1.1.5 2016-12-06 00:14:47 -05:00
4737a16874 [maven-release-plugin] prepare for next development iteration 2016-12-05 23:57:46 -05:00
bf0a3b30e5 [maven-release-plugin] prepare release gclc-1.3.3 2016-12-05 23:57:38 -05:00
5d25971b56 Fix the non delivery of Bye message
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-05 23:51:50 -05:00
c27872de94 Added parameters parsing exception rather than boolean
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-05 19:21:39 -05:00
a12484a72a [maven-release-plugin] prepare for next development iteration 2016-12-04 13:06:39 -05:00
ee0d91e455 [maven-release-plugin] prepare release gclc-socket-1.1.4 2016-12-04 13:06:30 -05:00
719d7ada3f Communication loop now interrupts after clearing the output of appli
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-04 12:41:05 -05:00
c877450b2b [maven-release-plugin] prepare for next development iteration 2016-12-04 10:10:30 -05:00
f3a8aafce1 [maven-release-plugin] prepare release gclc-swt-1.1.2 2016-12-04 10:10:25 -05:00
d2bc86fffc Removed duplicate method. Added test on swt console view
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-04 09:55:51 -05:00
3b6ba337f1 [maven-release-plugin] prepare for next development iteration 2016-12-04 09:54:32 -05:00
6a117afcb3 [maven-release-plugin] prepare release gclc-socket-1.1.3 2016-12-04 09:54:25 -05:00
7d41a9f4c6 Closing of socket application throw only an IOException, no generic one
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-04 09:44:29 -05:00
90579d79a9 [maven-release-plugin] prepare for next development iteration 2016-12-04 09:38:27 -05:00
b2c98ae940 [maven-release-plugin] prepare release gclc-socket-1.1.2 2016-12-04 09:38:18 -05:00
1d6569cf69 Upgrade dependency to gclc-1.3.2
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-04 09:27:19 -05:00
072653c944 [maven-release-plugin] prepare for next development iteration 2016-12-03 22:24:04 -05:00
ad17c7d5d7 [maven-release-plugin] prepare release gclc-1.3.2 2016-12-03 22:23:52 -05:00
e469313baf minor warn fix
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-03 20:19:22 -05:00
543b1ef605 Fixed thread surviving the application lifespan.
+tests in swt.

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-03 20:18:20 -05:00
24f1fba97e [maven-release-plugin] prepare for next development iteration 2016-12-03 16:53:44 -05:00
88fe564e24 [maven-release-plugin] prepare release gclc-socket-1.1.1 2016-12-03 16:53:29 -05:00
efa492570e Corrections on the socket closing.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-03 16:47:26 -05:00
d07795cb6a Removed unreachable code, set test output in fine grain logging
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-03 11:12:02 -05:00
f3c3580855 [maven-release-plugin] prepare for next development iteration 2016-12-02 15:39:53 -05:00
62f59722a6 [maven-release-plugin] prepare release gclc-swt-1.1.1 2016-12-02 15:39:51 -05:00
3e31a38eb9 Skip version 1.1.0
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-02 15:39:03 -05:00
549ddc3e6f [maven-release-plugin] prepare release gclc-swt-1.1.0 2016-12-02 15:37:01 -05:00
d300e896e8 Synchronized swt widgets
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-02 15:35:19 -05:00
16514f9c25 [maven-release-plugin] rollback the release of gclc-swt-1.1.0 2016-12-02 15:34:09 -05:00
bb9f9c515b [maven-release-plugin] prepare for next development iteration 2016-12-02 15:27:42 -05:00
77c5ae64dd [maven-release-plugin] prepare release gclc-swt-1.1.0 2016-12-02 15:27:33 -05:00
18c7f89564 Made gclc-swt and -system compatible with gclc-1.3.1
Added an abstract runnable for output forwarding from piped output

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-01 13:48:20 -05:00
5f185b52e9 [maven-release-plugin] prepare for next development iteration 2016-11-30 21:46:33 -05:00
2f5ea369b7 [maven-release-plugin] prepare release gclc-socket-1.1.0 2016-11-30 21:46:17 -05:00
ef708c3291 Code compliance
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 20:46:14 -05:00
9e040d80c4 Temp remove of test for console runnable as it does not fit new version
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 20:24:25 -05:00
e3ced7b961 Set version of gclc to stable
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 20:18:46 -05:00
c9b2270786 [maven-release-plugin] prepare for next development iteration 2016-11-30 20:10:00 -05:00
99ebb23138 [maven-release-plugin] prepare release gclc-1.3.1 2016-11-30 20:09:49 -05:00
d4f428d311 Factor constant string and comments added to ReadingRunnable
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 20:07:28 -05:00
e602a269f8 Made socket comply with new version of gclc. Fixed piped console manager
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 20:00:36 -05:00
d432914828 [maven-release-plugin] prepare for next development iteration 2016-11-30 09:55:45 -05:00
0cf54c4837 [maven-release-plugin] prepare release gclc-1.3.0 2016-11-30 09:55:33 -05:00
c1692019a6 Commentings and minors
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 09:53:20 -05:00
72362936be Added piped stream manager
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 09:49:16 -05:00
65b6be8283 Added prompting interruption, add exception in parameterized commands
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-29 16:37:20 -05:00
fd8dde32f1 Removed deprecated code
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-19 19:50:36 -05:00
fff9f4ea74 [maven-release-plugin] prepare for next development iteration 2016-11-19 17:40:22 -05:00
9e5d8c4ca4 [maven-release-plugin] prepare release gclc-1.2.6 2016-11-19 17:40:09 -05:00
a70be63894 Separation of concerns between SWTConsole and Key listener.
made an interface for the listener to use. Added test of the listener
effects.

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-19 17:36:51 -05:00
c2fa0f2c0b Added charset for communication
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-19 17:35:16 -05:00
5280ee98bd Code compliance huge changes.
* Fixed issues
CliPrompter:
------------
- print list size
- long text line prompt is in CliPromptMessages
- multi chhoice prompt from map gets the currect choice

CommandParameters:
------------------
- Get boolean null pointer exception fixed
- Access to arguments keys.

CommandProvider:
----------------
- Check command name on addition

ConsoleApplication
------------------
- run status update when exiting start()

HelpExecutor
------------
- help content depends on whether the element is a subed command or not

ParametrizedCommand
-------------------
- Check parameter for modification when adding already existing
parameter
- Remove need status for boolean arguments
- Added invalid command exception
- Fail if not interactive and missing needed parameter
- Added getters

PrintUtils
----------
- Remove last empty line in wrap

SystemConsoleManager
--------------------
- Added charset for streams
- Removal of NULL characters from stream

* Added test elements. Use test console manager rather that system one.

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-19 17:28:25 -05:00
1a207c8100 Script line number tracking, bug fix in cmd reading
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-10-19 13:40:27 -04:00
80d10d7d85 Set socket closing by interruption trace as FINE level
Additional comments, extract exec command default name to constant

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-08-30 12:16:58 -04:00
ecc10994ca New project for the system command execution command in gclc
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-08-05 09:54:35 -04:00
7289fc12ad Update of dependencies versionx
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-08-05 09:54:01 -04:00
f44366ff05 [maven-release-plugin] prepare for next development iteration 2016-06-20 20:12:53 -04:00
70a71c06a7 [maven-release-plugin] prepare release gclc-1.2.5 2016-06-20 20:12:50 -04:00
a0202de532 Removed faulty test class
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-06-20 20:11:35 -04:00
caa00f2a61 Order of commands preserved in command provider implementation
Minor correction in the CLIPrompter to avoid null pointer exception when
cancel on promptChoice

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-06-13 15:49:05 -04:00
eed6f43aea Fixed error message for SubedCommand run exceptions 2016-06-12 23:02:03 -04:00
59ab689a36 [maven-release-plugin] prepare for next development iteration 2016-06-12 22:39:43 -04:00
2bf1fa7c80 [maven-release-plugin] prepare release gclc-1.2.4 2016-06-12 22:39:36 -04:00
32e5f777fe licensing 2016-06-12 22:38:53 -04:00
f8aeef14e3 Corrected ScriptExecution and added tests 2016-06-12 22:36:09 -04:00
763b7361ec Update gclc-swt and -socket for gclc-1.2.3 2016-06-12 16:11:44 -04:00
c151107207 [maven-release-plugin] prepare for next development iteration 2016-06-12 16:08:19 -04:00
f95d2f114a [maven-release-plugin] prepare release gclc-1.2.3 2016-06-12 16:08:17 -04:00
e04e7ceaa5 Code compliance 2016-06-12 16:07:14 -04:00
3c1c8e85c8 Adding simple script command. Improving run exception.
Adding a simple script command implementation in ScriptExecution
The CommandRunException now embeds a type for usage, interaction or
running and the source
2016-06-12 15:59:50 -04:00
095a363520 [maven-release-plugin] prepare for next development iteration 2016-06-12 12:47:08 -04:00
932780e9d9 [maven-release-plugin] prepare release gclc-socket-1.0.6 2016-06-12 12:47:06 -04:00
d404d0ab69 Set parent to update release-plugin version 2016-06-12 12:43:59 -04:00
8038db26f3 release-prepare 2016-06-12 12:19:38 -04:00
a29fe4b458 pom 2016-06-12 12:17:54 -04:00
4ddce780e0 Escape character prepare for platform dependent... 2016-06-12 12:15:11 -04:00
12326b7cba Prepare for next development 2016-06-11 18:10:27 -04:00
04fcb5bedd Update dependencies to match platform by profiles 2016-06-11 18:10:03 -04:00
fef08dd29a Released gclc-swt-1.0.3 2016-06-11 16:38:26 -04:00
801189fdeb GCLC swt code compliance 2016-06-11 16:35:34 -04:00
04ca80f1b5 Update POM 2016-06-09 20:10:15 -04:00
2dbdf55694 Update l10n for message format 2016-06-09 19:20:15 -04:00
3ac978bdc1 Correction of message key test long run command 2016-06-09 19:09:17 -04:00
130 changed files with 18738 additions and 4876 deletions

4
gclc-process/.gitignore vendored Normal file
View File

@@ -0,0 +1,4 @@
/target/
/.classpath
/.project
/.settings/

95
gclc-process/pom.xml Normal file
View File

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

@@ -0,0 +1,119 @@
/*
* 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.Arrays;
import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.command.ICommandProvider;
import fr.bigeon.gclc.exception.CommandRunException;
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 CommandFork extends Command {
private final TaskPool pool;
private final ICommandProvider provider;
private final int lines;
/** Add the fork command.
*
* @param name the command name
* @param provider the allowed command collection */
public CommandFork(final String name, ICommandProvider provider, TaskPool pool) {
this(name, provider, pool, -1);
}
/** Add the fork command.
*
* @param name the command name
* @param provider the allowed command collection */
public CommandFork(final String name, ICommandProvider provider, TaskPool pool,
int lines) {
super(name);
this.provider = provider;
this.pool = pool;
this.lines = lines;
}
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in, String... args)
throws CommandRunException {
if (args.length < 1) {
throw new CommandRunException("No command to fork", this);
}
final ICommand cmd = provider.get(args[0]);
final String[] inner = Arrays.copyOfRange(args, 1, args.length);
final ForkTask task = new ForkCommandTask(cmd, inner, lines);
final Thread th = new Thread(task);
pool.add(task);
th.start();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Command background launch";
}
/* (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() + " <command>";
}
}

View File

@@ -0,0 +1,73 @@
/*
* 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 java.util.Arrays;
import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.exception.CommandRunException;
/**
* @author Emmanuel Bigeon
*
*/
public class ForkCommandTask extends ForkTask {
private final ICommand command;
private final String[] args;
/** @param cmd the command
* @param args the arguements
* @param lines the number of print to store in the output */
public ForkCommandTask(final ICommand cmd, final String[] args, int lines) {
super(lines);
command = cmd;
this.args = Arrays.copyOf(args, args.length);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#getName() */
@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

@@ -0,0 +1,155 @@
/*
* 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.ForkTask.java
* Created on: Nov 13, 2017
*/
package fr.bigeon.gclc.process;
import java.util.HashSet;
import java.util.Set;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
import fr.bigeon.gclc.process.io.ConnectingConsoleInput;
import fr.bigeon.gclc.process.io.ConnectingConsoleOutput;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
public abstract class ForkTask implements Task {
private final Set<InterruptionListener> listeners = new HashSet<>();
private boolean running = false;
protected final ConnectingConsoleInput in = new ConnectingConsoleInput();
protected final ConnectingConsoleOutput out;
private CommandRunException exception;
private final Object runLock = new Object();
/** @param lines the number of print to store in the output */
public ForkTask(int lines) {
out = new ConnectingConsoleOutput(ConnectingConsoleOutput.PERSIST, lines);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#addInterruptionListener(fr.bigeon.gclc.
* process.InterruptionListener) */
@Override
public final void addInterruptionListener(final InterruptionListener listener) {
listeners.add(listener);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#isRunning() */
@Override
public final boolean isRunning() {
synchronized (runLock) {
return running;
}
}
/** @param out the console output
* @param in the console input
* @param timeout the maximal wait (0 for ever) */
public final void join(final ConsoleOutput out, final ConsoleInput in, long timeout) {
synchronized (runLock) {
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)
* @see
* fr.bigeon.gclc.process.Task#rmInterruptionListener(fr.bigeon.gclc.process
* .InterruptionListener) */
@Override
public final void rmInterruptionListener(final InterruptionListener listener) {
listeners.remove(listener);
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public final void run() {
synchronized (runLock) {
running = true;
}
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)
* @see fr.bigeon.gclc.process.Task#setRunning(boolean) */
@Override
public final void setRunning(final boolean running) {
synchronized (runLock) {
this.running = running;
runLock.notifyAll();
}
}
protected final Object getRunningLock() {
return runLock;
}
}

View File

@@ -0,0 +1,44 @@
/*
* 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:fr.bigeon.gclc.proc.InterruptionListener.java
* Created on: May 10, 2017
*/
package fr.bigeon.gclc.process;
/** A listener for interruption
*
* @author Emmanuel Bigeon */
public interface InterruptionListener {
/** Notification of an interuption of a listened object */
void interrupted();
}

View File

@@ -0,0 +1,64 @@
/*
* 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 ProcessAttachement implements ApplicationAttachement {
private final TaskPool pool;
/** @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)
*/
@Override
public void attach(ICommandProvider application) throws InvalidCommandName {
application.add(new ProcessKill("kill", pool));
application.add(new ProcessList("list", pool));
}
}

View File

@@ -0,0 +1,87 @@
/*
* 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:fr.bigeon.gclc.proc.ProcessList.java
* Created on: May 10, 2017
*/
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.ConsoleOutput;
/** A command that will flag a task to stop
*
* @author Emmanuel Bigeon */
public final class ProcessClear extends Command {
/** The taskpool */
private final TaskPool pool;
/** @param name the command name
* @param pool the pool */
public ProcessClear(final String name, final TaskPool pool) {
super(name);
this.pool = pool;
}
/* (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 {
for (final String id : pool.getPIDs()) {
if (!pool.get(id).isRunning()) {
pool.remove(id);
}
}
return;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@SuppressWarnings("nls")
@Override
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;
}
}

View File

@@ -0,0 +1,82 @@
/*
* 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:fr.bigeon.gclc.proc.ProcessList.java
* Created on: May 10, 2017
*/
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.ConsoleOutput;
/** A command that will flag a task to stop
*
* @author Emmanuel Bigeon */
public final class ProcessKill extends Command {
/** The taskpool */
private final TaskPool pool;
/** @param name the command name
* @param pool the pool */
public ProcessKill(final String name, final TaskPool pool) {
super(name);
this.pool = pool;
}
/* (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 {
pool.get(args[0]).setRunning(false);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@SuppressWarnings("nls")
@Override
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;
}
}

View File

@@ -0,0 +1,100 @@
/*
* 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:fr.bigeon.gclc.proc.ProcessList.java
* Created on: May 10, 2017
*/
package fr.bigeon.gclc.process;
import java.io.IOException;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Collections;
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 command to list current processes
*
* @author Emmanuel Bigeon */
public final class ProcessList extends Command {
/** The process pool */
private final TaskPool pool;
/** @param name the command name
* @param pool the pool */
public ProcessList(final String name, final TaskPool pool) {
super(name);
this.pool = pool;
}
/* (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 {
final ArrayList<String> pids = new ArrayList<>(pool.getPIDs());
Collections.sort(pids);
for (final String string : pids) {
try {
out.println(MessageFormat.format("{0}\t{1}", string, //$NON-NLS-1$
pool.get(string).getName()));
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"Unable to communicate with user", e, this); //$NON-NLS-1$
}
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@SuppressWarnings("nls")
@Override
public String tip() {
return "List all processes";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return null;
}
}

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

@@ -0,0 +1,78 @@
/*
* 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:fr.bigeon.gclc.proc.ThreadCommand.java
* Created on: May 10, 2017
*/
package fr.bigeon.gclc.process;
/** Tasks are named runnable that can be interrupted.
* <p>
* Good practice for those objects include an absence of interaction with the
* user (otherwise the user may not know from which running command comes
* information and requests) and unicity of the object to have a coherent
* control through the {@link #setRunning(boolean)} method.
* <p>
* Typical cases where such command can be useful is for an application that
* does long computations.
*
* @author Emmanuel Bigeon */
public interface Task extends Runnable {
/** Add a listener for this command end of execution
*
* @param listener the listener */
void addInterruptionListener(InterruptionListener listener);
/** Get the task name.
*
* @return the task name */
String getName();
/** Test the running status of the task.
*
* @return if the command is supposed to be running */
boolean isRunning();
/** Remove a listener of this command end of execution
*
* @param listener the listener */
void rmInterruptionListener(InterruptionListener listener);
/** Set the running state.
* <p>
* This method should be only called by external objects with the false
* argument. Calling this method with true has unspecified behavior and
* could do nothing as well as restart the command for example.
*
* @param running the running state */
void setRunning(boolean running);
}

View File

@@ -0,0 +1,149 @@
/*
* 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:fr.bigeon.gclc.proc.TaskPool.java
* Created on: May 10, 2017
*/
package fr.bigeon.gclc.process;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
/** A process pool.
*
* @author Emmanuel Bigeon */
public final class TaskPool {
/** The running processes. */
private final Map<String, Task> running = new HashMap<>();
/** The count for process id. */
private int count = 0;
/** The lock for pid attribution synchronization. */
private final Object lock = new Object();
private final boolean autoClear;
/** Default constructor. */
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.
*
* @param cmd the process
* @return the pid */
public String add(final Task cmd) {
if (cmd == null) {
throw new IllegalArgumentException("Task cannot be null"); //$NON-NLS-1$
}
final String pid;
synchronized (lock) {
pid = getPID();
running.put(pid, cmd);
}
if (autoClear) {
cmd.addInterruptionListener(new InterruptionListener() {
@SuppressWarnings("synthetic-access")
@Override
public void interrupted() {
synchronized (lock) {
remove(pid);
}
cmd.rmInterruptionListener(this);
}
});
}
return pid;
}
/** Get a process by it associated identifier.
*
* @param pid the task id
* @return the task, if any, associated to this id */
public Task get(final String pid) {
synchronized (lock) {
return running.get(pid);
}
}
/** Get the next process id.
*
* @return the process id */
private String getPID() {
synchronized (lock) {
String pid;
do {
pid = Integer.toString(count++);
} while (running.containsKey(pid));
return pid;
}
}
/** Get the running processes' identifiers.
*
* @return the pids */
public Collection<String> getPIDs() {
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

@@ -0,0 +1,82 @@
/*
* 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:fr.bigeon.gclc.proc.ProcessList.java
* Created on: May 10, 2017
*/
package fr.bigeon.gclc.process;
import java.util.concurrent.ExecutorService;
import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** An abstract command to generate a task and return the control to the user
*
* @author Emmanuel Bigeon */
public abstract class TaskSpawner extends Command {
/** The process pool */
private final TaskPool pool;
private final ExecutorService threadPool;
/** @param name the command name
* @param pool the pool */
public TaskSpawner(final String name, final TaskPool pool,
ExecutorService threadPool) {
super(name);
this.pool = pool;
this.threadPool = threadPool;
}
/** @param in the input
* @param out the output
* @param args the arguments
* @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,
String... args) throws CommandRunException;
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public final void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final Task task = createTask(out, in, args);
final Thread th = new Thread(task);
pool.add(task);
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,105 +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"> <!-- Copyright E. Bigeon (2014) -->
<modelVersion>4.0.0</modelVersion> <!-- -->
<artifactId>gclc-socket</artifactId> <!-- emmanuel@bigeon.fr -->
<version>1.0.4-SNAPSHOT</version> <!-- -->
<packaging>jar</packaging> <!-- This software is a computer program whose purpose is to -->
<url>http://www.bigeon.fr/emmanuel</url> <!-- Defines the distribution repositories and basic setup for projects of
<properties> Emmanuel Bigeon. -->
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <!-- -->
</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>junit</groupId> <!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
<artifactId>junit</artifactId> <!-- "http://www.cecill.info". -->
<version>4.11</version> <!-- -->
<scope>test</scope> <!-- 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 -->
<dependency> <!-- with a limited warranty and the software's author, the holder of the -->
<groupId>fr.bigeon</groupId> <!-- economic rights, and the successive licensors have only limited -->
<artifactId>gclc</artifactId> <!-- liability. -->
<version>1.2.0</version> <!-- -->
</dependency> <!-- In this respect, the user's attention is drawn to the risks associated -->
<dependency> <!-- 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>smu</artifactId> <!-- that may mean that it is complicated to manipulate, and that also -->
<version>0.0.4</version> <!-- therefore means that it is reserved for developers and experienced -->
</dependency> <!-- professionals having in-depth computer knowledge. Users are therefore -->
</dependencies> <!-- encouraged to load and test the software's suitability as regards their -->
<parent> <!-- requirements in conditions enabling the security of their systems and/or -->
<groupId>fr.bigeon</groupId> <!-- data to be ensured and, more generally, to use and operate it in the -->
<artifactId>ebigeon-config</artifactId> <!-- same conditions as regards security. -->
<version>1.6.0</version> <!-- -->
</parent> <!-- The fact that you are presently reading this means that you have had -->
<name>GCLC Socket</name> <!-- knowledge of the CeCILL license and that you accept its terms. -->
<description>Socket implementation of GCLC</description>
<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

@@ -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,296 +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.BufferedWriter; import java.net.ServerSocket;
import java.io.IOException; import java.net.Socket;
import java.io.InputStreamReader; import java.net.SocketException;
import java.io.OutputStreamWriter; import java.util.logging.Level;
import java.io.PipedInputStream; import java.util.logging.Logger;
import java.io.PipedOutputStream;
import java.io.PrintWriter; import fr.bigeon.gclc.ConsoleApplication;
import java.net.ServerSocket;
import java.net.Socket; /** This is a socket communicating console consoleManager.
import java.net.SocketException; * <p>
import java.util.Arrays; * To use this application, the following flow should be used:
import java.util.logging.Level; *
import java.util.logging.Logger; * <pre>
* SocketConsoleApplicationShell shell = new SocketConsoleApplicationShell();
import fr.bigeon.gclc.ConsoleApplication; * ConsoleApplication myApplication = new MyConsoleApplication(shell.getConsoleManager(), ...);
import fr.bigeon.gclc.manager.ConsoleManager; * shell.setApplication(myApplication);
import fr.bigeon.smu.StringEncoder; * Thread th = new Thread(shell);
* th.start();
/** This is a socket communicating console consoleManager * </pre>
* <p> * <p>
* To use this application, the following flow should be used: * This will start the application in a separate thread. The application will be
* * listening on the given socket and writing back on it. If this is all your
* <pre> * application, you should then {@link Thread#join()} the thread to wait for the
* SocketConsoleApplicationShell shell = new SocketConsoleApplicationShell(); * end of the execution.
* ConsoleApplication myApplication = new MyConsoleApplication(shell.getConsoleManager(), ...); *
* shell.setApplication(myApplication); * @author Emmanuel Bigeon */
* Thread th = new Thread(shell); public final class SocketConsoleApplicationShell implements Runnable {
* th.start();
* </pre> /** The class logger. */
* <p> private static final Logger LOGGER = Logger
* This will start the application in a separate thread. The application will be .getLogger(SocketConsoleApplicationShell.class.getName());
* listening on the given socket and writing back on it. If this is all your /** The listening port. */
* application, you should then {@link Thread#join()} the thread to wait for the private final int port;
* end of the execution. /** The running status. */
* private boolean running;
* @author Emmanuel Bigeon */ /** The socket console interface. */
public class SocketConsoleApplicationShell implements Runnable { private SocketConsoleInterface sci;
/** The remote disconnection command. */
/** private ConnexionManager<Socket> rdc;
* /** The application. */
*/ private ConsoleApplication app;
private static final String INTERRUPTION_WHILE_WORKING = "Interruption while application was working"; //$NON-NLS-1$
/** The end of line character */ /** The server socket. */
protected static final String EOL = "\n"; //$NON-NLS-1$ private ServerSocket serverSocket;
/** The encoder */ /** THe server address. */
private static final StringEncoder ENCODER = new StringEncoder("%", //$NON-NLS-1$ private final InetAddress addr;
Arrays.asList(EOL));
/** The class logger */ /** Create a socket application shell which will listen on the given port
private static final Logger LOGGER = Logger * and network interface.
.getLogger(SocketConsoleApplicationShell.class.getName()); *
/** The listening port */ * @param port the part
private final int port; * @param addr the inet address */
/** The input */ public SocketConsoleApplicationShell(final int port,
private final PipedInputStream consoleInput = new PipedInputStream(); final InetAddress addr) {
/** The application */ super();
private ConsoleApplication app; this.port = port;
/** The session closing command */ this.addr = addr;
private final String close; }
/** The running status */
private boolean running; /** Wait for the identified connection to disconnect.
/** An object to lock on for prompt */ *
private final Object promptingLock = new Object(); * @param id the connexion id. */
private void awaitDisconnexion(final String id) {
/** The console manager implementation */ while (rdc.isConnected(id)) {
private final ThreadedServerConsoleManager consoleManager = new ThreadedServerConsoleManager( try {
ENCODER, promptingLock); rdc.waitDisconnexion(id);
/** The auto close flag. if this is true, every request closes the session } catch (final InterruptedException e) {
* after its call */ LOGGER.log(Level.SEVERE, "Unexpected interruption", e); //$NON-NLS-1$
private final boolean autoClose; Thread.currentThread().interrupt();
/** The server socket */ }
private ServerSocket serverSocket; }
/** The application shutdown string */ sci.disconnect();
private final String applicationShutdown; }
/** Create a socket application shell which will listen on the given port /** If the port provided was 0, this allows to get the actual port.
* and close session upon the provided string reception by client * @return the local port
* * @see java.net.ServerSocket#getLocalPort()
* @param port the port to listen to */
* @param close the session closing command public int getLocalPort() {
* @param applicationShutdown the appication shut down command */ return serverSocket.getLocalPort();
public SocketConsoleApplicationShell(int port, String close, }
String applicationShutdown) {
this.port = port; /* (non-Javadoc)
this.close = close; * @see java.lang.Runnable#run() */
this.applicationShutdown = applicationShutdown; @Override
this.autoClose = false; public void run() {
} // Create the server
try (ServerSocket actualServerSocket = new ServerSocket(port, 1,
/** Create a socket application shell which will listen on the given port addr)) {
* and auto close session after one instruction serverSocket = actualServerSocket;
* running = true;
* @param port the port to listen to // Create the streams
* @param autoClose if the session must be closed once the request has been runSokectServer();
* sent } catch (final IOException e) {
* @param applicationShutdown the application shutdown command */ LOGGER.severe("Communication error between client and server"); //$NON-NLS-1$
public SocketConsoleApplicationShell(int port, boolean autoClose, LOGGER.log(Level.FINE,
String applicationShutdown) { "Communication error between client and server", e); //$NON-NLS-1$
this.port = port; }
this.autoClose = autoClose; }
this.applicationShutdown = applicationShutdown;
this.close = autoClose ? null : "close"; //$NON-NLS-1$ /** Acctually run the server loop on connexion.
} *
* @throws IOException if the communication with the client failed */
/* (non-Javadoc) private void runSokectServer() throws IOException {
* @see java.lang.Runnable#run() */ while (running && app.isRunning()) {
@Override LOGGER.info("Waiting client"); //$NON-NLS-1$
public void run() { try (Socket clientSocket = serverSocket.accept();) {
try (ServerSocket actualServerSocket = new ServerSocket(port)) {
this.serverSocket = actualServerSocket; sci.connect(clientSocket);
final ConsoleRunnable runnable = new ConsoleRunnable(app,
promptingLock); final String id = rdc.addConnexion(clientSocket);
final Thread appTh = new Thread(runnable); rdc.lockDisconnexion(id);
running = true; awaitDisconnexion(id);
try (PipedOutputStream outStream = new PipedOutputStream(); rdc.releaseDisconnexionLock(id);
BufferedWriter writer = new BufferedWriter( } catch (final SocketException e) {
new OutputStreamWriter(outStream))) { LOGGER.log(Level.INFO, "Socket closed"); //$NON-NLS-1$
consoleInput.connect(outStream); LOGGER.log(Level.FINE,
try (InputStreamReader isr = new InputStreamReader( "Socket closed with exception (probably due to server interruption)", //$NON-NLS-1$
consoleInput); e);
BufferedReader inBuf = new BufferedReader(isr);) { } catch (final IOException e) {
consoleManager.setInput(inBuf); throw e;
runSokectServer(appTh, writer); }
// Close the application LOGGER.info("Closing client"); //$NON-NLS-1$
// Pass command to application }
writer.write(applicationShutdown + EOL); LOGGER.info("Closing Server"); //$NON-NLS-1$
writer.flush(); }
}
} /** Set the application.
} catch (final IOException e) { * <p>
LOGGER.log(Level.SEVERE, * If the application is closed, the server will also close.
"Communication error between client and server", e); //$NON-NLS-1$ *
} * @param app the app to set */
} public void setApplication(final ConsoleApplication app) {
this.app = app;
/** @param appTh the application thread }
* @param writer the writer to the application
* @throws IOException if the communication with the client failed */ /** Set the connexion manager.
private void runSokectServer(Thread appTh, *
BufferedWriter writer) throws IOException { * @param rdc the rdc to set */
while (running) { public void setConnexionManager(final ConnexionManager<Socket> rdc) {
try (Socket clientSocket = serverSocket.accept(); this.rdc = rdc;
PrintWriter out = new PrintWriter( }
clientSocket.getOutputStream(), true);
BufferedReader in = new BufferedReader(new InputStreamReader( /** Set the socket console interface.
clientSocket.getInputStream()));) { *
// this is not threaded to avoid several clients at the same * @param sci the console interface to set */
// time public void setInterface(final SocketConsoleInterface sci) {
consoleManager.setOutput(out); this.sci = sci;
// Initiate application }
if (!appTh.isAlive()) {
appTh.start(); /** This method will request the server to stop.
} else { * <p>
out.println("Reconnected"); //$NON-NLS-1$ * In most cases, this will terminate communication on every client. On some
} * cases, the */
communicate(writer, in); public void stop() {
} catch (SocketException e) { running = false;
LOGGER.log(Level.INFO, "Socket closed", e); //$NON-NLS-1$ try {
} serverSocket.close();
} } catch (final IOException e) {
} LOGGER.log(Level.SEVERE, "Exception in closing socket server", e); //$NON-NLS-1$
}
/** active communication between server and client }
* }
* @param writer the writer to the application
* @param in the input from the client
* @throws IOException if the communication failed */
private void communicate(BufferedWriter writer,
BufferedReader in) throws IOException {
synchronized (promptingLock) {
if (!consoleManager.isPrompting()) {
try {
// wait for application to finish its operation
promptingLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, INTERRUPTION_WHILE_WORKING, e);
}
}
if (autoClose) {
communicateOnce(in, writer);
} else {
communicateLoop(in, writer);
}
}
}
/** @param in the input from the client
* @param writer the output to the client
* @throws IOException if the communication failed */
private void communicateOnce(BufferedReader in,
BufferedWriter writer) throws IOException {
String ln;
if ((ln = in.readLine()) != null) {
if (ln.equals(close)) {
return;
}
// Pass command to application
writer.write(ln + EOL);
writer.flush();
try {
// Wait for application process to
// finish
promptingLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, INTERRUPTION_WHILE_WORKING, e);
}
}
}
/** @param in the input from the client
* @param writer the output to the client
* @throws IOException if the communication failed */
private void communicateLoop(BufferedReader in,
BufferedWriter writer) throws IOException {
String ln;
while (running && (ln = in.readLine()) != null) {
if (ln.equals(close)) {
break;
}
// Pass command to application
writer.write(ln + EOL);
writer.flush();
try {
// Wait for application process to
// finish
promptingLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, INTERRUPTION_WHILE_WORKING, e);
}
}
}
/** @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$
}
synchronized (promptingLock) {
promptingLock.notifyAll();
}
app.exit();
}
}

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

@@ -1,176 +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.ThreadedServerConsoleManager.java
* Created on: Jun 1, 2016
*/
package fr.bigeon.gclc.socket;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.manager.ConsoleManager;
import fr.bigeon.smu.StringEncoder;
/** The console manager for socket communication
*
* @author Emmanuel Bigeon */
public class ThreadedServerConsoleManager implements ConsoleManager {
/** The eol character */
private static final String EOL = "\n"; //$NON-NLS-1$
/** The class logger */
private static final Logger LOGGER = Logger
.getLogger(ThreadedServerConsoleManager.class.getName());
/** The prompting sequence */
private String prompt = new String();
/** The buffer of data to send to the user */
private StringBuilder buffer = new StringBuilder();
/** The synchronized object */
private final Object promptingLock;
/** The output to write data comming from the application */
private PrintWriter output;
/** The encoder to encode data coming from the application */
private final StringEncoder encoder;
/** The input to wait data from the user */
private BufferedReader input;
/** the prompting status */
private boolean doPrompt;
/**
*
*/
private boolean closed = false;
/** Create the console manager.
*
* @param encoder the encoder for output
* @param promptingLock the synchronization object */
public ThreadedServerConsoleManager(StringEncoder encoder,
Object promptingLock) {
super();
this.encoder = encoder;
this.promptingLock = promptingLock;
}
/** @param input the input to set */
public void setInput(BufferedReader input) {
this.input = input;
}
/** @param output the output to set */
public void setOutput(PrintWriter output) {
this.output = output;
}
@Override
public void setPrompt(String prompt) {
this.prompt = prompt;
}
@Override
public String prompt(String message) {
buffer.append(message);
String userInput = new String();
boolean prompting = true;
while (prompting) {
// Send buffer content
output.println(encoder.encode(buffer.toString()));
try {
synchronized (promptingLock) {
doPrompt = true;
promptingLock.notify();
}
userInput = input.readLine();
doPrompt = false;
prompting = false;
} catch (final IOException e) {
LOGGER.log(Level.SEVERE, "input reading error", e); //$NON-NLS-1$
}
}
// Renew buffer
buffer = new StringBuilder();
return userInput;
}
/** @return the prompting status */
public synchronized boolean isPrompting() {
return doPrompt;
}
@Override
public String prompt() {
return prompt(prompt);
}
@Override
public void println(String message) {
buffer.append(message + EOL);
}
@Override
public void println() {
buffer.append(EOL);
}
@Override
public void print(String text) {
buffer.append(text);
}
@Override
public String getPrompt() {
return prompt;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */
@Override
public void close() throws IOException {
// Do nothing
this.closed = true;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
@Override
public boolean isClosed() {
return closed;
}
}

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,181 +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.ConsoleApplication;
import fr.bigeon.gclc.manager.ConsoleManager;
import fr.bigeon.gclc.manager.SystemConsoleManager;
/** Test class for {@link ConsoleRunnable}
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"static-method", "unused", "javadoc"})
public class ConsoleRunnableTest {
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
private static final class ConsoleManagerTestImplementation
implements ConsoleManager {
int i = 0;
String[] cmds;
/** @param cmds */
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;
}
}
/** Test method for
* {@link fr.bigeon.gclc.socket.ConsoleRunnable#ConsoleRunnable(fr.bigeon.gclc.ConsoleApplication, java.lang.Object)}
* . */
@Test
public void testConsoleRunnable() {
Object lock = new Object();
ConsoleApplication app = new ConsoleTestApplication(
new SystemConsoleManager());
ConsoleRunnable runnable = new ConsoleRunnable(app, lock);
}
/** Test method for {@link fr.bigeon.gclc.socket.ConsoleRunnable#run()}. */
@Test
public void testRunFlow() {
Object lock = new Object();
ConsoleApplication app = new ConsoleTestApplication(
new ConsoleManagerTestImplementation(
new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
ConsoleRunnable runnable = new ConsoleRunnable(app, lock);
Thread th = new Thread(runnable);
th.start();
runnable.stop();
}
/** Test method for {@link fr.bigeon.gclc.socket.ConsoleRunnable#stop()}. */
@Test
public void testStop() {
Object lock = new Object();
ConsoleApplication app = new ConsoleTestApplication(
new ConsoleManagerTestImplementation(
new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
ConsoleRunnable runnable = new ConsoleRunnable(app, lock);
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() {
Object lock = new Object();
ConsoleApplication app = new ConsoleTestApplication(
new ConsoleManagerTestImplementation(
new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
ConsoleRunnable runnable = new ConsoleRunnable(app, lock);
runnable.run();
}
}

View File

@@ -1,83 +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 extends ConsoleApplication { *
* @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$
@SuppressWarnings("nls")
public ConsoleTestApplication(final ConsoleManager manager) { /** Create the test application.
super(manager, "Welcome to the test application. Type help or test.", *
"See you"); * @param output the output
try { * @param input the input
add(new ExitCommand(EXIT, this)); * @param manager the manager
add(new HelpExecutor("help", manager, this.getRoot())); * @return create the application */
add(new Command("test") { @SuppressWarnings("nls")
public static ConsoleApplication create(final ConsoleOutput output,
@Override final ConsoleInput input,
public String tip() { final ConnexionManager<Socket> manager) {
return "A test command"; try {
} final ConsoleApplication application = new ConsoleApplication(
output, input,
@Override "Welcome to the test application. Type help or test.",
public void execute(String... args) throws CommandRunException { "See you");
try { application.add(new ExitCommand(EXIT, application) {
manager.println("Test command ran fine"); /* (non-Javadoc)
} catch (IOException e) { * @see fr.bigeon.gclc.command.ExitCommand#beforeExit() */
throw new CommandRunException("manager closed", e); @Override
} protected void beforeExit() {
} final Collection<String> coll = manager.getConnected();
}); for (final String string : coll) {
} catch (final InvalidCommandName e) { manager.disconnect(string);
e.printStackTrace(); }
} }
} });
} application
.add(new HelpExecutor("help", application.root));
application.add(new Command("test") {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
try {
output.println("Test command ran fine");
} catch (final IOException e) {
throw new CommandRunException("manager closed", e,
this);
}
}
@Override
public String tip() {
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,138 +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 java.io.BufferedReader;
import java.io.IOException; import java.io.BufferedReader;
import java.io.InputStreamReader; import java.io.IOException;
import java.io.PrintWriter; import java.io.InputStreamReader;
import java.net.Socket; import java.io.PrintWriter;
import java.util.Arrays; import java.net.Socket;
import java.util.logging.Logger;
import org.junit.Test;
import org.junit.Test;
import fr.bigeon.smu.StringEncoder;
/** Test class for {@link SocketConsoleApplicationShell}
/** Test class for {@link SocketConsoleApplicationShell} *
* * @author Emmanuel Bigeon */
* @author Emmanuel Bigeon */ @SuppressWarnings({"static-method", "javadoc", "nls"})
@SuppressWarnings({"static-method", "unused", "javadoc", "nls"}) public class SocketConsoleApplicationTest {
public class SocketConsoleApplicationTest {
private static final Logger LOGGER = Logger
private static final StringEncoder ENCODER = new StringEncoder("%", .getLogger(SocketConsoleApplicationTest.class.getName());
Arrays.asList("\n")); //$NON-NLS-1$
/** @param in the input
@Test * @return the string
public void integrationTest() { * @throws IOException if the input reading failed */
Thread server = TestServer.startServer(false); private String consumeToPrompt(final String server,
try { final BufferedReader in) throws IOException {
Thread.sleep(100); String fromServer = server;
} catch (InterruptedException e1) { LOGGER.fine("Server: \n" + fromServer);
e1.printStackTrace(); while (fromServer != null && !fromServer.equals("Bye.") &&
} !fromServer.equals("> ")) {
final String hostName = "127.0.0.1"; fromServer = in.readLine();
final int portNumber = 3300; LOGGER.fine("Server: \n" + fromServer);
}
try (Socket kkSocket = new Socket(hostName, portNumber); return fromServer;
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), }
true);
BufferedReader in = new BufferedReader( @Test
new InputStreamReader(kkSocket.getInputStream()));) { public void testIntegration() throws IOException, InterruptedException {
Thread server;
String fromServer; server = TestServer.getServer();
int i = 0; Thread.sleep(1000);
String[] cmds = {"help", "test", "close"}; final String hostName = "127.0.0.1";
while ((fromServer = in.readLine()) != null) { final int portNumber = 3300;
System.out.println("Server: \n" + ENCODER.decode(fromServer));
if (fromServer.equals("Bye.")) { try (Socket kkSocket = new Socket(hostName, portNumber);
break; PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
} true);
BufferedReader in = new BufferedReader(
final String fromUser = cmds[i]; new InputStreamReader(kkSocket.getInputStream()));) {
if (fromUser != null) {
System.out.println("Client: " + fromUser); String fromServer;
out.println(fromUser); int i = -1;
} final String[] cmds = {"help", "toto", "test", "out"};
i++; while ((fromServer = in.readLine()) != null) {
} i++;
} catch (final IOException e) { fromServer = consumeToPrompt(fromServer, in);
e.printStackTrace(); if (fromServer == null || fromServer.equals("Bye.")) {
} break;
TestServer.closeServer(); }
try {
Thread.sleep(100); final String fromUser = cmds[i];
} catch (InterruptedException e2) { if (fromUser != null) {
e2.printStackTrace(); LOGGER.fine("Client: " + fromUser);
} out.println(fromUser);
server = TestServer.startServer(true); }
try { }
Thread.sleep(100); assertEquals("Disconnection command should close connection", 3, i);
} catch (InterruptedException e1) { }
e1.printStackTrace();
} try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
try (Socket kkSocket = new Socket(hostName, portNumber); true);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), BufferedReader in = new BufferedReader(
true); new InputStreamReader(kkSocket.getInputStream()));) {
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) { String fromServer;
int i = 0;
String fromServer; final String[] cmds = {"help", "toto", "test",
int i = 0; ConsoleTestApplication.EXIT};
String[] cmds = {"help", "test", "close"}; while ((fromServer = in.readLine()) != null) {
while ((fromServer = in.readLine()) != null) { fromServer = consumeToPrompt(fromServer, in);
// System.out.println("Server: \n" + ENCODER.decode(fromServer)); if (fromServer == null || fromServer.equals("Bye.")) {
if (fromServer.equals("Bye.")) { break;
break; }
} LOGGER.info("Server: \n" + fromServer);
final String fromUser = cmds[i]; final String fromUser = cmds[i];
if (fromUser != null) { if (fromUser != null) {
// System.out.println("Client: " + fromUser); LOGGER.info("Client: " + fromUser);
out.println(fromUser); out.println(fromUser);
} }
i++; i++;
} }
} catch (final IOException e) { assertEquals("Application exit command should close connection", 4,
e.printStackTrace(); i);
} }
TestServer.closeServer(); Thread.sleep(100);
TestServer.closeServer();
} server.join();
} server = TestServer.getServer();
Thread.sleep(1000);
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;
final String[] cmds = {"help", "toto", "test",
ConsoleTestApplication.EXIT};
while ((fromServer = in.readLine()) != null) {
fromServer = consumeToPrompt(fromServer, in);
if (fromServer == null || fromServer.equals("Bye.")) {
break;
}
final String fromUser = cmds[i];
if (fromUser != null) {
LOGGER.fine("Client: " + fromUser);
out.println(fromUser);
}
i++;
}
assertEquals("Application exit command should close connection", 4,
i);
}
TestServer.closeServer();
server.join();
}
}

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,91 +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;
/** A test server import java.net.InetAddress;
* import java.net.Socket;
* @author Emmanuel Bigeon */ import java.net.UnknownHostException;
@SuppressWarnings({"javadoc", "nls"})
public class TestServer { import fr.bigeon.gclc.ConsoleApplication;
private static SocketConsoleApplicationShell SHELL; /** A test server
private static Thread server; *
* @author Emmanuel Bigeon */
/** @param args no argument */ @SuppressWarnings({"javadoc", "nls"})
public static void main(String... args) { public class TestServer {
try {
startServer(false).join(); private static SocketConsoleApplicationShell SHELL;
} catch (final InterruptedException e) { private static ConnexionManager<Socket> manager;
e.printStackTrace();
} private static Thread server;
} private static PluggableConsoleInput input;
private static PluggableConsoleOutput output;
public static Thread getServer() {
if (server == null) { public static synchronized void closeServer() {
server = new Thread(getShell(), "gclcServer"); SHELL.stop();
server.start(); input.close();
} output.close();
return server; SHELL = null;
} server = null;
}
/** @return */
private static SocketConsoleApplicationShell getShell() { public static synchronized Thread getServer() throws IOException {
if (SHELL == null) { if (server == null) {
SHELL = new SocketConsoleApplicationShell(3300, "close", server = new Thread(getShell(), "gclcServer");
ConsoleTestApplication.EXIT); server.start();
final ConsoleTestApplication app = new ConsoleTestApplication( }
SHELL.getConsoleManager()); return server;
SHELL.setApplication(app); }
}
return SHELL; private static SocketConsoleApplicationShell getShell() throws UnknownHostException {
} if (SHELL == null) {
input = new PluggableConsoleInput();
public static Thread startServer(boolean autoClose) { input.setPrompt("> \n");
if (SHELL == null) { output = new PluggableConsoleOutput();
SHELL = new SocketConsoleApplicationShell(3300, autoClose, manager = new DConnexionManager<>();
ConsoleTestApplication.EXIT); SHELL = new SocketConsoleApplicationShell(3300,
final ConsoleTestApplication app = new ConsoleTestApplication( InetAddress.getByName("127.0.0.1"));
SHELL.getConsoleManager()); final ConsoleApplication app = ConsoleTestApplication
SHELL.setApplication(app); .create(output, input, manager);
server = null; SHELL.setInterface(new SocketConsoleInterface(input, output));
} SHELL.setConnexionManager(manager);
return getServer(); SHELL.setApplication(app);
} final Thread th = new Thread(new Runnable() {
public static void closeServer() { @Override
SHELL.stop(); public void run() {
SHELL = null; app.start();
} }
} });
th.start();
}
return SHELL;
}
/** @param args no argument
* @throws IOException if the server starting failed */
public static void main(final String... args) throws IOException {
try {
getServer().join();
} catch (final InterruptedException e) {
e.printStackTrace();
}
}
}

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 -->
@@ -32,12 +63,10 @@
<!-- The fact that you are presently reading this means that you have had --> <!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. --> <!-- knowledge of the CeCILL license and that you accept its terms. -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
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.0.2-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>
@@ -45,30 +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.6.0</version> <version>1.8.2</version>
</parent> </parent>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>fr.bigeon</groupId> <groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId> <artifactId>gclc</artifactId>
<version>1.2.0</version> <version>2.0.5</version>
</dependency>
<dependency>
<groupId>org.eclipse.swt</groupId>
<artifactId>org.eclipse.swt.gtk.linux.x86_64</artifactId>
<version>4.3</version>
</dependency>
<dependency>
<groupId>org.eclipse.swt</groupId>
<artifactId>org.eclipse.swt.win32.win32.x86_64</artifactId>
<version>4.3</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>
@@ -78,4 +97,37 @@
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag> <tag>HEAD</tag>
</scm> </scm>
<profiles>
<profile>
<id>linux-deps</id>
<activation>
<os>
<family>Linux</family>
</os>
</activation>
<dependencies>
<dependency>
<groupId>org.eclipse.swt</groupId>
<artifactId>org.eclipse.swt.gtk.linux.x86_64</artifactId>
<version>4.3</version>
</dependency>
</dependencies>
</profile>
<profile>
<id>windows-deps</id>
<activation>
<os>
<family>Windows</family>
</os>
</activation>
<dependencies>
<dependency>
<groupId>org.eclipse.swt</groupId>
<artifactId>org.eclipse.swt.win32.win32.x86_64</artifactId>
<version>4.3</version>
</dependency>
</dependencies>
</profile>
</profiles>
<groupId>fr.bigeon.gclc</groupId>
</project> </project>

View File

@@ -0,0 +1,57 @@
/*
* 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.
*/
/**
* gclc-swt:fr.bigeon.gclc.swt.ConsoleDelayIO.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.swt;
/** This class represents an object used to send commands to a console
* application.
* <p>
* The sending of command is done in two phases. Define the input through get
* and set, and then validate the input.
*
* @author Emmanuel Bigeon */
public interface ConsoleDelayIO {
/** Get the input text.
* @return the non validated input */
String getInput();
/** Set the input text.
*
* @param input the input to set */
void setInput(String input);
/** Actually send the input as the prompt next input. */
void validateInput();
}

View File

@@ -0,0 +1,112 @@
/*
* 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.
*/
/**
* gclc-swt:fr.bigeon.gclc.swt.HistoryTextKeyListener.java
* Created on: Jun 9, 2016
*/
package fr.bigeon.gclc.swt;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyAdapter;
import org.eclipse.swt.events.KeyEvent;
import fr.bigeon.collections.ArrayRibbon;
import fr.bigeon.collections.Ribbon;
/** A key listener to validate commands and manage the history of commands.
*
* @author Emmanuel Bigeon */
public final class HistoryTextKeyListener extends KeyAdapter {
/** The size of commands history. */
private static final int DEFAULT_HISTORY_SIZE = 10;
/** The empty string constant. */
private static final String EMPTY = ""; //$NON-NLS-1$
/** The history ribbon. */
private final Ribbon<String> commands;
/** The current index in history search. */
private int currentIndex = 0;
/** The console to notify of command validation. */
private final ConsoleDelayIO console;
/** Create the key listener that cycle the history.
*
* @param console the console delayed */
public HistoryTextKeyListener(final ConsoleDelayIO console) {
super();
this.console = console;
commands = new ArrayRibbon<>(DEFAULT_HISTORY_SIZE);
}
/* (non-Javadoc)
* @see org.eclipse.swt.events.KeyAdapter#keyPressed(org.eclipse.swt.events.
* KeyEvent) */
@Override
public void keyPressed(final KeyEvent e) {
pressedKeyCode(e.keyCode);
}
/** Indicate a pressed key combination.
*
* @param keyCode the pressed key code */
public void pressedKeyCode(final int keyCode) {
// Enter validates the command if prompting
if (keyCode == '\r') {
final String input = console.getInput();
if (!input.isEmpty()) {
commands.add(input);
}
console.validateInput();
currentIndex = -1;
}
// Upper arrow retrieves previous commands
if (keyCode == SWT.ARROW_UP &&
currentIndex < commands.size() - 1) {
currentIndex++;
final String cmd = commands.get(commands.size() - currentIndex - 1);
console.setInput(cmd);
}
// Lower arrow retrieves next commands
if (keyCode == SWT.ARROW_DOWN) {
if (currentIndex == 0) {
currentIndex--;
console.setInput(EMPTY);
} else if (currentIndex > 0) {
final String cmd = commands
.get(commands.size() - (--currentIndex) - 1);
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,
@@ -39,12 +36,10 @@
package fr.bigeon.gclc.swt; package fr.bigeon.gclc.swt;
import java.io.IOException; import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.eclipse.swt.SWT; import org.eclipse.swt.SWT;
import org.eclipse.swt.events.FocusAdapter;
import org.eclipse.swt.events.FocusEvent;
import org.eclipse.swt.events.KeyAdapter;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.layout.GridData; import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Composite;
@@ -52,157 +47,115 @@ import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label; import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text; import org.eclipse.swt.widgets.Text;
import fr.bigeon.collections.ArrayRibbon;
import fr.bigeon.collections.Ribbon;
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 implements ConsoleManager { public final class SWTConsole extends Composite
/** A key listener to validate commands and manage the history of commands implements ConsoleDelayIO, ConsoleInput, ConsoleOutput {
* /** The number of columns of the layout. */
* @author Emmanuel Bigeon */ private static final int LAYOUT_NB_COLUMNS = 2;
public static final class HistoryTextKeyListener extends KeyAdapter { /** The cmd prefix in the output console. */
private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$
/** The size of commands history */ /** The class logger. */
private static final int DEFAULT_HISTORY_SIZE = 10; private static final Logger LOGGER = Logger
/** The history ribbon */ .getLogger(SWTConsole.class.getName());
private final Ribbon<String> commands; /** The empty string constant. */
/** The current index in history search */ private static final String EMPTY = ""; //$NON-NLS-1$
private int currentIndex = 0; /** The console output text field. */
/** The console to write the commands in */ private final Text consoleOutput;
private final Text consoleInput; /** The console input text field. */
/** The console to notify of command validation */ private final Text consoleInput;
private final SWTConsole console; /** The prompt label. */
private final Label lblPromptlabel;
/** @param console the console /** The prompt text. */
* @param consoleInput the text to write commands in */ private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
public HistoryTextKeyListener(SWTConsole console, Text consoleInput) { /** The command entered by the user. */
super(); private String command = null;
this.console = console; /** If the prompt should be active. */
this.consoleInput = consoleInput; private boolean prompting = false;
this.commands = new ArrayRibbon<>(DEFAULT_HISTORY_SIZE); /** The object for thread synchronization with the prompt. */
} private final Object promptLock = new Object();
@Override
public void keyPressed(KeyEvent e) {
// Enter validates the command if prompting
if (e.keyCode == '\r') {
commands.add(consoleInput.getText());
console.validateInput();
currentIndex = -1;
}
// Upper arrow retrieves previous commands
if (e.keyCode == SWT.ARROW_UP &&
currentIndex < commands.size() - 1) {
currentIndex++;
String cmd = commands.get(commands.size() - currentIndex - 1);
consoleInput.setText(cmd);
consoleInput.setSelection(cmd.length());
}
// Lower arrow retrieves next commands
if (e.keyCode == SWT.ARROW_DOWN) {
if (currentIndex == 0) {
currentIndex--;
consoleInput.setText(new String());
} else if (currentIndex > 0) {
String cmd = commands
.get(commands.size() - (--currentIndex) - 1);
consoleInput.setText(cmd);
consoleInput.setSelection(cmd.length());
}
}
}
}
/**
*
*/
private static final int LAYOUT_NB_COLUMNS = 2;
/** The cmd prefix in the output console */
private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$
/** The console output text field */
private final Text consoleOutput;
/** The console input text field */
private final Text consoleInput;
/** The prompt label */
private final Label lblPromptlabel;
/** The prompt text */
private String prompt = ">"; //$NON-NLS-1$
/** The command entered by the user */
private String command = null;
/** If the prompt should be active */
private boolean prompting = false;
/** The object for thread synchronization with the prompt */
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);
consoleOutput.addFocusListener(new FocusAdapter() {
@SuppressWarnings("synthetic-access")
@Override
public void focusGained(FocusEvent e) {
consoleInput.setFocus();
}
});
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, consoleInput));
} }
/**
*
*/
protected void validateInput() {
if (prompting) {
synchronized (promptLock) {
command = consoleInput.getText();
prompting = false;
consoleInput.setText(new String());
consoleInput.setEnabled(false);
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
@@ -211,7 +164,9 @@ public class SWTConsole extends Composite implements ConsoleManager {
@SuppressWarnings("synthetic-access") @SuppressWarnings("synthetic-access")
@Override @Override
public void run() { public void run() {
consoleOutput.append(text); if (!consoleOutput.isDisposed()) {
consoleOutput.append(text);
}
} }
}); });
} }
@@ -224,7 +179,9 @@ public class SWTConsole extends Composite implements ConsoleManager {
@SuppressWarnings("synthetic-access") @SuppressWarnings("synthetic-access")
@Override @Override
public void run() { public void run() {
consoleOutput.append(System.lineSeparator()); if (!consoleOutput.isDisposed()) {
consoleOutput.append(System.lineSeparator());
}
} }
}); });
} }
@@ -237,7 +194,9 @@ public class SWTConsole extends Composite implements ConsoleManager {
@SuppressWarnings("synthetic-access") @SuppressWarnings("synthetic-access")
@Override @Override
public void run() { public void run() {
consoleOutput.append(message + System.lineSeparator()); if (!consoleOutput.isDisposed()) {
consoleOutput.append(message + System.lineSeparator());
}
} }
}); });
@@ -253,19 +212,73 @@ public class SWTConsole extends Composite implements ConsoleManager {
} }
try { try {
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override @Override
public void run() { public void run() {
consoleInput.setEnabled(true); if (!consoleInput.isDisposed()) {
consoleInput.setFocus(); consoleInput.setEnabled(true);
lblPromptlabel.setText(prompt.apply());
// relayout
SWTConsole.this.layout();
consoleInput.setFocus();
}
} }
}); });
prompting = true; prompting = true;
promptLock.wait(); promptLock.notifyAll();
while (prompting) {
promptLock.wait();
}
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, "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()) {
throw new IOException("Input closed"); //$NON-NLS-1$
}
return command; return command;
} }
@@ -282,11 +295,13 @@ public class SWTConsole extends Composite implements ConsoleManager {
@SuppressWarnings("synthetic-access") @SuppressWarnings("synthetic-access")
@Override @Override
public void run() { public void run() {
lblPromptlabel.setText(message); if (!consoleOutput.isDisposed()) {
// relayout lblPromptlabel.setText(message);
SWTConsole.this.layout(); // relayout
consoleInput.setEnabled(true); SWTConsole.this.layout();
consoleInput.setFocus(); consoleInput.setEnabled(true);
consoleInput.setFocus();
}
} }
}); });
prompting = true; prompting = true;
@@ -295,15 +310,19 @@ public class SWTConsole extends Composite implements ConsoleManager {
throw new IOException(); throw new IOException();
} }
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, "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() {
lblPromptlabel.setText(prompt); if (!consoleOutput.isDisposed()) {
// relayout lblPromptlabel.setText(prompt.apply());
SWTConsole.this.layout(); // relayout
SWTConsole.this.layout();
}
} }
}); });
} }
@@ -311,6 +330,15 @@ public class SWTConsole extends Composite implements ConsoleManager {
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
@@ -318,41 +346,81 @@ public class SWTConsole extends Composite implements ConsoleManager {
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() {
lblPromptlabel.setText(prompt); if (!consoleOutput.isDisposed()) {
// relayout lblPromptlabel.setText(prompt.apply());
SWTConsole.this.layout(); // relayout
SWTConsole.this.layout();
}
} }
}); });
} }
/* (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) /** @param string the text */
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */ public void setText(final String string) {
consoleInput.setText(string);
}
/**
*
*/
public void validateCommand() {
validateInput();
}
/**
*
*/
@Override @Override
public boolean isClosed() { public void validateInput() {
return isDisposed(); Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleInput.setEnabled(false);
}
});
synchronized (promptLock) {
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

@@ -0,0 +1,190 @@
/*
* 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.
*/
/**
* gclc-swt:fr.bigeon.gclc.swt.SWTConsole.java
* Created on: Apr 18, 2015
*/
package fr.bigeon.gclc.swt;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Text;
import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.manager.PipedConsoleInput;
import fr.bigeon.gclc.manager.PipedConsoleOutput;
import fr.bigeon.gclc.tools.AOutputForwardRunnable;
/** A SWT component to connect to gclc {@link ConsoleApplication}
* <p>
*
* @author Emmanuel Bigeon */
public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
/** The local implementation of the forwarding runnable
*
* @author Emmanuel Bigeon */
private final class ToSWTConsoleForwardRunnable
extends AOutputForwardRunnable {
/** The running status */
private boolean running = true;
/** @param manager the manager */
public ToSWTConsoleForwardRunnable(final PipedConsoleOutput manager) {
super(manager);
}
@Override
protected void forwardLine(final String m) {
appendConsoleOutput(m);
}
@Override
protected boolean isRunning() {
return running && !isDisposed();
}
/** @param running the running to set */
public void setRunning(final boolean running) {
this.running = running;
}
}
/** The class logger */
private static final Logger LOGGER = Logger
.getLogger(SWTConsoleView.class.getName());
/** The console output text field */
private final Text consoleOutput;
/** The console input text field */
private final Text consoleInput;
/** The input. */
private PipedConsoleInput input;
/** The forwarding runnable */
private ToSWTConsoleForwardRunnable forward;
/** Create the composite.
*
* @param parent the prent composite
* @param style the composite style */
public SWTConsoleView(final Composite parent, final int style) {
super(parent, style);
setLayout(new GridLayout(1, false));
consoleOutput = new Text(this, SWT.BORDER | SWT.READ_ONLY | SWT.WRAP |
SWT.V_SCROLL | SWT.MULTI);
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true,
1, 1));
consoleOutput.setRedraw(true);
consoleInput = new Text(this, SWT.BORDER);
consoleInput.setLayoutData(
new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
consoleInput.addKeyListener(new HistoryTextKeyListener(this));
}
/** @param next the next message */
protected void appendConsoleOutput(final String next) {
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleOutput.append(System.lineSeparator() + next);
}
});
}
@Override
protected void checkSubclass() {
// 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)
* @see org.eclipse.swt.widgets.Composite#setFocus() */
@Override
public boolean 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());
}
/** Set the input and output.
*
* @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
public void validateInput() {
try {
input.type(getInput());
} catch (final IOException e) {
LOGGER.log(Level.SEVERE, "Unable to input value to console", e); //$NON-NLS-1$
}
}
}

View File

@@ -0,0 +1,39 @@
/*
* 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.
*/
/**
* gclc-swt:fr.bigeon.gclc.swt.package-info.java
* Created on: Nov 18, 2017
*/
/** SWT components for a frontend of GCLC applications.
*
* @author Emmanuel Bigeon */
package fr.bigeon.gclc.swt;

View File

@@ -0,0 +1,108 @@
/*
* 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.
*/
/**
* gclc-swt:fr.bigeon.gclc.swt.HistoryTextKeyListenerTest.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.swt;
import static org.junit.Assert.assertEquals;
import org.eclipse.swt.SWT;
import org.junit.Test;
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
public class HistoryTextKeyListenerTest {
/** Test method for
* {@link fr.bigeon.gclc.swt.HistoryTextKeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)}. */
@Test
public final void testKeyPressedKeyEvent() {
ConsoleDelayIO io = new ConsoleDelayIO() {
private String input = "";
@Override
public void validateInput() {
input = "";
}
@Override
public void setInput(String input) {
this.input = input;
}
@Override
public String getInput() {
return input;
}
};
HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
// no effects
assertEquals("", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("", io.getInput());
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
io.setInput("cmd arg");
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
io.setInput("cmd arg2");
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("", io.getInput());
io.setInput("cmd arg2");
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg2", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("cmd arg2", io.getInput());
}
}

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,
@@ -39,68 +36,103 @@
package fr.bigeon.gclc.swt; package fr.bigeon.gclc.swt;
import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue; import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.IOException;
import org.eclipse.swt.widgets.Display; import org.eclipse.swt.widgets.Display;
import org.junit.Test; 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.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName; import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.manager.ConsoleManager; import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** /**
* <p> * <p>
* TODO * TODO
* *
* @author Emmanuel Bigeon * @author Emmanuel Bigeon */
* @SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"})
*/
public class SWTConsoleShellTest { public class SWTConsoleShellTest {
protected static final long TWO_SECONDS = 2000; protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = Display.getDefault();
@Test @Test
public void test() { public void test() {
Display display = new Display(); final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
final SWTConsoleShell shell = new SWTConsoleShell(display); final SWTConsole swtConsole = shell.getManager();
ConsoleManager swtConsole = shell.getManager();
try { try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole, final ConsoleApplication appl = new ConsoleApplication(swtConsole,
"exit", "Hello", "See you"); swtConsole, "Hello", "See you");
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
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 // TODO Auto-generated catch block
e.printStackTrace(); e.printStackTrace();
} }
@@ -115,18 +147,185 @@ public class SWTConsoleShellTest {
applThread.start(); applThread.start();
testThread.start(); testThread.start();
while (!shell.isDisposed()) { while (!shell.isDisposed()) {
if (!display.readAndDispatch()) { if (!DISPLAY.readAndDispatch()) {
display.sleep(); DISPLAY.sleep();
} }
} }
// 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 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
e.printStackTrace();
}
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("test"); //$NON-NLS-1$
swtConsole.validateCommand();
}
});
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("ok"); //$NON-NLS-1$
}
});
swtConsole.validateCommand();
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("long"); //$NON-NLS-1$
}
});
swtConsole.validateCommand();
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("test"); //$NON-NLS-1$
}
});
swtConsole.validateCommand();
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();
}
}
swtConsole.setPrompt(">");
try {
swtConsole.prompt();
fail("Prompting when closed should fail!");
} catch (final IOException e) {
assertNotNull(e);
}
// 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 // TODO Auto-generated catch block
e.printStackTrace(); e.printStackTrace();
} }

View File

@@ -0,0 +1,169 @@
/*
* 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.
*/
/**
* gclc-swt:fr.bigeon.gclc.swt.SWTConsoleShellTest.java
* Created on: Jun 8, 2016
*/
package fr.bigeon.gclc.swt;
import static org.junit.Assert.assertNull;
import java.io.IOException;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
import org.junit.Test;
import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.command.ExitCommand;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName;
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>
* TODO
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"})
public class SWTConsoleViewTest {
protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = Display.getDefault();
@Test
public void test() {
final Shell shell = new Shell(DISPLAY);
final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE);
try (PipedConsoleOutput manager = new PipedConsoleOutput();
PipedConsoleInput input = new PipedConsoleInput(System.out)) {
swtConsole.setManager(manager, input);
} catch (final IOException e2) {
assertNull(e2);
}
try (PipedConsoleOutput manager = new PipedConsoleOutput();
PipedConsoleInput input = new PipedConsoleInput(System.out)) {
swtConsole.setManager(manager, input);
final ConsoleApplication appl = new ConsoleApplication(manager,
input,
"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");
}
});
// 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
e.printStackTrace();
}
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("test"); //$NON-NLS-1$
swtConsole.validateInput();
}
});
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();
}
}
} catch (final InvalidCommandName e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (final IOException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
}
}

4
gclc.system/.gitignore vendored Normal file
View File

@@ -0,0 +1,4 @@
/target/
/.classpath
/.project
/.settings/

41
gclc.system/pom.xml Normal file
View File

@@ -0,0 +1,41 @@
<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>
<groupId>net.bigeon</groupId>
<artifactId>gclc.system</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<url>http://www.bigeon.net</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<build>
<plugins>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.0</version>
</dependency>
</dependencies>
<name>GCLC system command</name>
<description>Provide an exec command to execute system commands</description>
<inceptionYear>2016</inceptionYear>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag>
</scm>
<parent>
<groupId>fr.bigeon</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.7.1</version>
</parent>
</project>

View File

@@ -0,0 +1,148 @@
/**
* gclc.system:net.bigeon.gclc.system.ExecSystemCommand.java
* Created on: Jun 20, 2016
*/
package net.bigeon.gclc.system;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.util.logging.Level;
import java.util.logging.Logger;
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 command that will execute a system command.
*
* @author Emmanuel Bigeon */
public class ExecSystemCommand extends Command {
/** The command default name */
private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$
/** The end of line separator */
private static final String EOL = System.lineSeparator();
/** The class logger */
private static final Logger LOGGER = Logger
.getLogger(ExecSystemCommand.class.getName());
/***/
public ExecSystemCommand() {
super(COMMAND_DEFAULT_NAME);
}
/** @param name the name of the command (the input from the manager that
* should trigger this command) */
public ExecSystemCommand(final String name) {
super(name);
}
/* (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 {
Process proc;
try {
proc = Runtime.getRuntime().exec(args);
} catch (final IOException e2) {
LOGGER.log(Level.SEVERE, "Unable to run process", e2); //$NON-NLS-1$
return;
}
final InputStream is = proc
.getInputStream();
final Thread th = new Thread(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
try {
readToEnd(out, is);
is.close();
} catch (final CommandRunException e) {
LOGGER.log(Level.WARNING,
"Manager was closed in the meantime...", e); //$NON-NLS-1$
} catch (final IOException e) {
LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$
}
}
});
th.start();
in.setPrompt(""); //$NON-NLS-1$
final OutputStream os = proc.getOutputStream();
try (BufferedWriter writer = new BufferedWriter(
new OutputStreamWriter(os))) {
while (th.isAlive()) {
String user;
try {
user = in.prompt();
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"manager was closed", e, this); //$NON-NLS-1$
}
writer.write(user + EOL);
}
} catch (final IOException e1) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"manager was closed", e1, this); //$NON-NLS-1$
}
}
/** @param is the input stream
* @throws CommandRunException if the manager was closed while writing the
* stream */
protected void readToEnd(final ConsoleOutput out,
final InputStream is) throws CommandRunException {
int c;
try {
while ((c = is.read()) != -1) {
try {
out.print(Character.valueOf((char) c).toString());
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"manager was closed", e, this); //$NON-NLS-1$
}
}
} catch (final IOException e) {
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)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return " The system command is a system dependend command like sh on linux or" + //$NON-NLS-1$
System.lineSeparator() + "powershell on windows." + //$NON-NLS-1$
System.lineSeparator() + System.lineSeparator() +
" As an example if you give \"cat /etc/hostname\" as argument, on a linux" + //$NON-NLS-1$
System.lineSeparator() +
"system, you would get the computer name." + //$NON-NLS-1$
System.lineSeparator();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */
@Override
protected String usagePattern() {
return " CMD <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,3 +1,11 @@
## Version 1.2.6
* in script command failure report improved
### Bug fixes
* command line reading now succeed to parse last argument if it is a string
## Version 1.1.0 ## Version 1.1.0
* Parsing quoted string as one argument * Parsing quoted string as one argument

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.6</version>
<!-- This software is a computer program whose purpose is to --> <packaging>jar</packaging>
<!-- provide a generic framework for console applications. --> <url>http://www.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>1.2.1-SNAPSHOT</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.6.0</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.6</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>HEAD</tag>
</scm>
</project>

View File

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

View File

@@ -1,51 +1,49 @@
/* /**
* Copyright Bigeon Emmanuel (2014) * gclc:fr.bigeon.gclc.CommandRequestListener.java
* * Created on: Mar 19, 2015
* emmanuel@bigeon.fr */
* package fr.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
/** <p> * is executed by the ConsoleApplication.
* Command Request Listeners are listeners that are notified before a command is *
* executed by the ConsoleApplication, * @author Emmanuel Bigeon */
* public interface CommandRequestListener {
* @author Emmanuel Bigeon */ /** Indicates that the given command was requested to the application.
public interface CommandRequestListener { *
/** Indicates that the given command was requested to the application * @param command the command */
* void commandRequest(String command);
* @param command the command */ }
void commandRequest(String command);
}

View File

@@ -1,264 +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:fr.bigeon.gclc.ConsoleApplication.java
* Created on: Sep 6, 2014 */ * Created on: Sep 6, 2014 */
package fr.bigeon.gclc; package fr.bigeon.gclc;
import java.io.IOException; /*-
import java.util.ArrayList; * #%L
import java.util.Arrays; * Generic Command Ligne console
import java.util.List; * %%
import java.util.logging.Level; * Copyright (C) 2014 - 2018 bigeon.fr
import java.util.logging.Logger; * %%
* This software is governed by the CeCILL license under French law and
import fr.bigeon.gclc.command.ExitCommand; * abiding by the rules of distribution of free software. You can use,
import fr.bigeon.gclc.command.HelpExecutor; * modify and/ or redistribute the software under the terms of the CeCILL
import fr.bigeon.gclc.command.ICommand; * license as circulated by CEA, CNRS and INRIA at the following URL
import fr.bigeon.gclc.command.ICommandProvider; * "http://www.cecill.info".
import fr.bigeon.gclc.command.SubedCommand; *
import fr.bigeon.gclc.command.UnrecognizedCommand; * As a counterpart to the access to the source code and rights to copy,
import fr.bigeon.gclc.exception.CommandParsingException; * modify and redistribute granted by the license, users are provided only
import fr.bigeon.gclc.exception.CommandRunException; * with a limited warranty and the software's author, the holder of the
import fr.bigeon.gclc.exception.InvalidCommandName; * economic rights, and the successive licensors have only limited
import fr.bigeon.gclc.i18n.Messages; * liability.
import fr.bigeon.gclc.manager.ConsoleManager; *
import fr.bigeon.gclc.manager.SystemConsoleManager; * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
/** <p> * software by the user in light of its specific status of free software,
* A {@link ConsoleApplication} is an application that require the user to input * that may mean that it is complicated to manipulate, and that also
* commands. * therefore means that it is reserved for developers and experienced
* <p> * professionals having in-depth computer knowledge. Users are therefore
* A typical use case is the following: * encouraged to load and test the software's suitability as regards their
* * requirements in conditions enabling the security of their systems and/or
* <pre> * data to be ensured and, more generally, to use and operate it in the
* {@link ConsoleApplication} app = new {@link ConsoleApplication#ConsoleApplication(String, String, String) ConsoleApplication("exit", "welcome", "see you latter")}; * same conditions as regards security.
* app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()}); *
* app.{@link ConsoleApplication#start start}(); * The fact that you are presently reading this means that you have had
* </pre> * knowledge of the CeCILL license and that you accept its terms.
* <p> * #L%
* That will launch in the console application that will display "welcome", */
* return a line and prompt the user for the command until he inputs the import java.io.IOException;
* <code>exit</code> command. Then it will print "see you latter" and exit the import java.io.InterruptedIOException;
* start method. import java.util.ArrayList;
* import java.util.Arrays;
* @author Emmanuel BIGEON */ import java.util.List;
public class ConsoleApplication implements ICommandProvider { import java.util.logging.Level;
import java.util.logging.Logger;
/** The class logger */
private static final Logger LOGGER = Logger import fr.bigeon.gclc.command.ICommand;
.getLogger(ConsoleApplication.class.getName()); import fr.bigeon.gclc.command.ICommandProvider;
/** The welcome message */ import fr.bigeon.gclc.command.SubedCommand;
private final String header; import fr.bigeon.gclc.exception.CommandParsingException;
/** The good bye message */ import fr.bigeon.gclc.exception.CommandRunException;
private final String footer; import fr.bigeon.gclc.exception.CommandRunExceptionType;
/** The console manager */ import fr.bigeon.gclc.exception.InvalidCommandName;
protected final ConsoleManager manager; import fr.bigeon.gclc.i18n.Messages;
/** The container of commands */ import fr.bigeon.gclc.manager.ConsoleInput;
private final SubedCommand root; import fr.bigeon.gclc.manager.ConsoleOutput;
/** The state of this application */
private boolean running; /**
/** The listeners */ * A {@link ConsoleApplication} is an application that require the user to input
private final List<CommandRequestListener> listeners = new ArrayList<>(); * commands.
* <p>
/** @param manager the manager * A typical use case is the following:
* @param welcome the welcoming message *
* @param goodbye the goodbye message */ * <pre>
public ConsoleApplication(ConsoleManager manager, String welcome, * {@link ConsoleOutput} out = new {@link fr.bigeon.gclc.utils.StreamConsoleOutput StreamConsoleOutput}();
String goodbye) { * {@link ConsoleInput} in = new {@link fr.bigeon.gclc.utils.StreamConsoleInput StreamConsoleInput}();
this.header = welcome; * {@link ConsoleApplication} app = new {@link ConsoleApplication}(out, in, "welcome", "see you latter")};
this.footer = goodbye; * app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()});
this.manager = manager; * app.{@link ConsoleApplication#start() start()};
root = new SubedCommand(new String(), new UnrecognizedCommand(manager)); * </pre>
} * <p>
* That will launch in the console application that will display "welcome",
/** @param manager the manager * return a line and prompt the user for the command until he inputs the
* @param exit the keyword for the exit command of this application * <code>exit</code> command. Then it will print "see you latter" and exit the
* @param welcome the header message to display on launch of this * start method.
* application *
* @param goodbye the message to display on exit * @author Emmanuel BIGEON */
* @throws InvalidCommandName if the exit command name is invalid public final class ConsoleApplication implements ICommandProvider {
* @deprecated since 1.2.0, use the {@link #add(ICommand)} method to add the
* exit command */ /** The class logger. */
@Deprecated private static final Logger LOGGER = Logger
public ConsoleApplication(ConsoleManager manager, String exit, .getLogger(ConsoleApplication.class.getName());
String welcome, String goodbye) throws InvalidCommandName { /** The welcome message. */
this(manager, welcome, goodbye); public final String header;
root.add(new ExitCommand(exit, this)); /** The good bye message. */
} public final String footer;
/** The standard output for the application. */
/** @param exit the keyword for the exit command of this application private final ConsoleOutput out;
* @param welcome the header message to display on launch of this /** The standard input for the application. */
* application private final ConsoleInput in;
* @param goodbye the message to display on exit /** The container of commands. */
* @throws InvalidCommandName if the exit command name is invalid public final SubedCommand root;
* @deprecated since 1.2.0, use the {@link #add(ICommand)} method to add the /** The state of this application. */
* command and create this console using the private boolean running;
* {@link #ConsoleApplication(ConsoleManager, String, String)} /** The listeners. */
* method with a {@link SystemConsoleManager} as argument */ private final List<CommandRequestListener> listeners = new ArrayList<>();
@Deprecated
public ConsoleApplication(String exit, String welcome, /** Create a console application.
String goodbye) throws InvalidCommandName { *
this(new SystemConsoleManager(), welcome, goodbye); * @param out the output
root.add(new ExitCommand(exit, this)); * @param in the input
} * @param welcome the welcoming message
* @param goodbye the goodbye message */
@Override public ConsoleApplication(final ConsoleOutput out, final ConsoleInput in,
public final boolean add(ICommand cmd) throws InvalidCommandName { final String welcome,
return root.add(cmd); final String goodbye) {
} header = welcome;
footer = goodbye;
/** Adds help command on the given key this.in = in;
* this.out = out;
* @param cmd the handle for help root = new SubedCommand(""); //$NON-NLS-1$
* @return if the help command was added }
* @throws InvalidCommandName if the help command was not valid
* @deprecated since 1.2.0 use the {@link #add(ICommand)} with a @Override
* {@link HelpExecutor} instead */ public boolean add(final ICommand cmd) throws InvalidCommandName {
@Deprecated return root.add(cmd);
public final boolean addHelpCommand(String cmd) throws InvalidCommandName { }
return root.add(new HelpExecutor(cmd, manager, root));
} /** Add a listener for command requests.
*
/** Add a command request listener. * @param listener the command listener */
* <p> public void addListener(final CommandRequestListener listener) {
* A listener can listen several times to the same application. listeners.add(listener);
* }
* @param listener the listener to add. */
public final void addListener(CommandRequestListener listener) { /* (non-Javadoc)
listeners.add(listener); * @see fr.bigeon.gclc.command.ICommandProvider#executeSub(java.lang.String,
} * java.lang.String[]) */
@Override
/* (non-Javadoc) public void executeSub(final ConsoleOutput output, final ConsoleInput input,
* @see final String command,
* fr.bigeon.gclc.command.ICommandProvider#executeSub(java.lang.String, final String... args) throws CommandRunException {
* java.lang.String[]) */ root.executeSub(output, input, command, args);
@Override }
public final void executeSub(String command,
String... args) throws CommandRunException { /** Signify to the application that no command should be inputed anymore. */
root.executeSub(command, args); public void exit() {
} LOGGER.fine("Request exiting application..."); //$NON-NLS-1$
running = false;
/** Exit this running application before next command prompt */ in.interruptPrompt();
public final void exit() { }
LOGGER.fine("Request exiting application..."); //$NON-NLS-1$
running = false; /* (non-Javadoc)
} * @see fr.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */
@Override
/* (non-Javadoc) public ICommand get(final String command) {
* @see fr.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */ return root.get(command);
@Override }
public final ICommand get(String command) {
return root.get(command); /** Interpret a command line.
} * <p>
* This method will split the command in its part and execute the command
/** @return the manager */ * with {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}.
public final ConsoleManager getManager() { *
return manager; * @param cmd the command
} * @throws IOException if the command could not be parsed */
public void interpretCommand(final String cmd) throws IOException {
/** @param cmd the command to interpret List<String> args;
* @throws IOException if the manager was closed */ try {
public final void interpretCommand(String cmd) throws IOException { args = GCLCConstants.splitCommand(cmd);
List<String> args; } catch (final CommandParsingException e1) {
try { out.println("Command line cannot be parsed"); //$NON-NLS-1$
args = GCLCConstants.splitCommand(cmd); LOGGER.log(Level.FINE, "Invalid user command " + cmd, e1); //$NON-NLS-1$
} catch (CommandParsingException e1) { return;
manager.println("Command line cannot be parsed"); //$NON-NLS-1$ }
LOGGER.log(Level.INFO, "Invalid user command " + cmd, e1); //$NON-NLS-1$ if (!args.isEmpty()) {
return; try {
} executeSub(out, in, args.get(0), Arrays.copyOfRange(
if (!args.isEmpty()) { args.toArray(new String[0]), 1, args.size()));
try { } catch (final CommandRunException e) {
executeSub(args.get(0), Arrays.copyOfRange( LOGGER.log(Level.FINE, "Command failed: " + cmd, e); //$NON-NLS-1$
args.toArray(new String[0]), 1, args.size())); out.println(Messages
} catch (final CommandRunException e) { .getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
LOGGER.log(Level.WARNING, "Command failed: " + cmd, e); //$NON-NLS-1$ out.println(e.getLocalizedMessage());
manager.println(Messages if (e.getType() == CommandRunExceptionType.USAGE) {
.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$ get(args.get(0)).help(out);
manager.println(e.getLocalizedMessage()); }
} }
} }
} }
/** @param listener the listener to remove (once) */ /** Test if the application is running.
public final void removeListener(CommandRequestListener listener) { *
for (int i = 0; i < listeners.size(); i++) { * @return the running status */
if (listeners.get(i) == listener) { public boolean isRunning() {
listeners.remove(i); return running;
return; }
}
} /** Remove a listener from this application.
} *
* @param listener the command listener to remove */
/** Launches the prompting application */ public void removeListener(final CommandRequestListener listener) {
public final void start() { listeners.remove(listener);
try { }
running = true;
if (header != null) { /** The running loop content.
manager.println(header); * <p>
} * This consisting in getting the command, executing it and exiting
do { * (restarting the loop). */
final String cmd = manager.prompt(); private void runLoop() {
if (cmd == null || cmd.isEmpty()) { try {
continue; final String cmd = in.prompt();
} if (cmd == null || cmd.isEmpty()) {
for (final CommandRequestListener listener : listeners) { return;
listener.commandRequest(cmd); }
} for (final CommandRequestListener listener : listeners) {
interpretCommand(cmd); listener.commandRequest(cmd);
} while (running); }
if (footer != null) { interpretCommand(cmd);
manager.println(footer); } catch (final InterruptedIOException e) {
} LOGGER.info(
LOGGER.fine("Exiting application."); //$NON-NLS-1$ "Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
} catch (IOException e) { LOGGER.log(Level.FINER, "Interruption of the prompt.", //$NON-NLS-1$
// The manager was closed e);
running = false; } catch (final IOException e) {
LOGGER.log(Level.WARNING, // The manager was closed
"The console manager was closed. Closing the application as no one can reach it.", //$NON-NLS-1$ running = false;
e); 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$
/** @return if the application is running */ e);
public boolean isRunning() { }
return running; }
}
/** Start the application. */
/** @return the root */ public void start() {
public SubedCommand getRoot() { try {
return root; 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,129 +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:fr.bigeon.gclc.GCLCConstants.java
* Created on: Jun 8, 2016 * Created on: Jun 8, 2016
*/ */
package fr.bigeon.gclc; package fr.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 class GCLCConstants { *
* As a counterpart to the access to the source code and rights to copy,
/** Hide utility class constructor */ * modify and redistribute granted by the license, users are provided only
private GCLCConstants() { * with a limited warranty and the software's author, the holder of the
// utility class * economic rights, and the successive licensors have only limited
} * liability.
*
/** Splits a command in the diferrent arguments * In this respect, the user's attention is drawn to the risks associated
* * with loading, using, modifying and/or developing or reproducing the
* @param cmd the command to split in its parts * software by the user in light of its specific status of free software,
* @return the list of argument preceded by the command name * that may mean that it is complicated to manipulate, and that also
* @throws CommandParsingException if the parsing of the command failed */ * therefore means that it is reserved for developers and experienced
public static List<String> splitCommand(String cmd) throws CommandParsingException { * professionals having in-depth computer knowledge. Users are therefore
final List<String> args = new ArrayList<>(); * encouraged to load and test the software's suitability as regards their
// parse the string to separate arguments * requirements in conditions enabling the security of their systems and/or
int index = 0; * data to be ensured and, more generally, to use and operate it in the
int startIndex = 0; * same conditions as regards security.
boolean escaped = false; *
boolean inString = false; * The fact that you are presently reading this means that you have had
while (index < cmd.length()) { * knowledge of the CeCILL license and that you accept its terms.
char c = cmd.charAt(index); * #L%
index++; */
if (escaped || c == '\\') { import java.util.ArrayList;
escaped = !escaped; import java.util.List;
continue;
} import fr.bigeon.gclc.exception.CommandParsingException;
if (c == ' ' && !inString) {
final String arg = cmd.substring(startIndex, index - 1); /** A Utility class for GCLC
if (!arg.isEmpty()) { * <p>
args.add(removeEscaped(arg)); * This class offers a method to split a line or arguments into the list of
} * arguments.
startIndex = index; *
} else if (c == '"') { * @author Emmanuel Bigeon */
if (inString) { public final class GCLCConstants {
args.add(endOfString(cmd, startIndex, index));
index++; /** The escaping character. */
startIndex = index; private static final char ESCAPING_CHAR = getSystemEscapingChar();
}
inString = startIndex == index - 1; /** Hide utility class constructor. */
} private GCLCConstants() {
} // utility class
final String arg = cmd.substring(startIndex, cmd.length()); }
if (!arg.isEmpty()) {
args.add(arg); /** Get the end of a string argument.
} *
return args; * @param cmd the command to parse
} * @param startIndex the starting point of the parsing
* @param index the index of the current position
/** @param arg the string to remove excaping character from * @return the argument
* @return the string without escape character */ * @throws CommandParsingException if the end of string does not mark end of
private static String removeEscaped(String arg) { * command and is not followed by a space */
StringBuilder builder = new StringBuilder(); private static String endOfString(final String cmd, final int startIndex,
int index = 0; final int index) throws CommandParsingException {
int endIndex = arg.indexOf('\\'); if (index < cmd.length() && cmd.charAt(index) != ' ') {
while (endIndex != -1) { throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$
builder.append(arg.subSequence(index, endIndex)); }
index = endIndex + 1; return cmd.substring(startIndex + 1, index - 1);
endIndex = arg.indexOf('\\', index + 1); }
}
builder.append(arg.substring(index)); /** Get the excaping character.
return builder.toString(); *
} * @return the escaping character */
private static char getSystemEscapingChar() {
/** @param cmd the command to parse return '\\';
* @param startIndex the starting point of the parsing }
* @param index the index of the current position
* @return the argument /** Remove escaping characters from the string.
* @throws CommandParsingException if the end of string does not mark end of *
* command and is not followed by a space */ * @param arg the string to remove excaping character from
private static String endOfString(String cmd, int startIndex, * @return the string without escape character */
int index) throws CommandParsingException { private static String removeEscaped(final String arg) {
if (index < cmd.length() && cmd.charAt(index) != ' ') { final StringBuilder builder = new StringBuilder();
throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$ int index = 0;
} int endIndex = arg.indexOf(ESCAPING_CHAR);
return cmd.substring(startIndex + 1, index - 1); while (endIndex != -1) {
} builder.append(arg.subSequence(index, endIndex));
index = endIndex + 1;
} endIndex = arg.indexOf(ESCAPING_CHAR, index + 1);
}
builder.append(arg.substring(index));
return builder.toString();
}
/** Splits a command in the diferrent arguments.
*
* @param cmd the command to split in its parts
* @return the list of argument preceded by the command name
* @throws CommandParsingException if the parsing of the command failed */
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,133 +1,148 @@
/* /**
* Copyright Bigeon Emmanuel (2014) * acide:fr.bigeon.acide.Command.java
* * Created on: Jul 31, 2014
* emmanuel@bigeon.fr */
* package fr.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 fr.bigeon.gclc.manager.ConsoleOutput;
import fr.bigeon.gclc.manager.ConsoleManager;
/** A command to execute.
/** <p> * <p>
* A command to execute. It is mandatory that it has a name and that name cannot * It is mandatory that it has a name and that name cannot start with minus
* 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. */
* private static final String EOL_LINUX = "\n"; //$NON-NLS-1$
*/ /** The name of the command. */
private static final String EOL_LINUX = "\n"; //$NON-NLS-1$ protected final String name;
/** The name of the command */
protected final String name; /** Create the command.
*
/** @param name the command name */ * @param name the command name */
public Command(String name) { public Command(final String name) {
super(); super();
this.name = name; this.name = name;
} }
/** @return a brief description of the command */ /** Get the brief part of the command help.
protected String brief() { * <p>
return " " + tip(); //$NON-NLS-1$ * This method may be overriden by implementations to improve the help
} * content. The default behavior is to print the tip.
*
/* (non-Javadoc) * @return a brief description of the command
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ * @see Command#help(ConsoleOutput, String...) */
@Override protected String brief() {
public final String getCommandName() { return " " + tip(); //$NON-NLS-1$
return name; }
}
/* (non-Javadoc)
/* (non-Javadoc) * @see fr.bigeon.gclc.command.ICommand#getCommandName() */
* @see fr.bigeon.gclc.command.ICommand#help(fr.bigeon.gclc.ConsoleManager, @Override
* java.lang.String) */ public final String getCommandName() {
@Override return name;
public final void help(ConsoleManager manager, }
String... args) throws IOException {
manager.println(getCommandName()); /** Prints a help content for this command to the console output.
manager.println(brief()); * <p>
manager.println(); * This help is following the given format:
manager.println("Usage:"); //$NON-NLS-1$ *
manager.println(usagePattern()); * <pre>
manager.println(); * [Command name]
final String details = usageDetail(); * [brief message]
if (details != null && !details.isEmpty()) { *
manager.print(details); * Usage:
if (!(details.endsWith(EOL_LINUX) || * [Usage pattern]
details.endsWith(System.lineSeparator()))) { *
manager.println(); * [Usage details]
} * </pre>
} *
} * @see fr.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */
@Override
/** <p> public final void help(final ConsoleOutput manager,
* This method return the detail of the help. It immediatly follows the final String... args) throws IOException {
* {@link #usagePattern() usage pattern}. manager.println(getCommandName());
* manager.println(brief());
* @return the detailed help (should end with end of line or be empty) */ manager.println();
@SuppressWarnings("static-method") manager.println("Usage:"); //$NON-NLS-1$
protected String usageDetail() { manager.println(usagePattern());
return new String(); manager.println();
} final String details = usageDetail();
if (details != null && !details.isEmpty()) {
/** <p> manager.print(details);
* This prints the usage pattern for the command. It follows the brief if (!(details.endsWith(EOL_LINUX) ||
* introduction on the command ({@link #brief()}) details.endsWith(System.lineSeparator()))) {
* manager.println();
* @return the usage pattern */ }
protected String usagePattern() { }
return getCommandName(); }
}
} /** This method return the detail of the help.
* <p>
* It immediatly follows the {@link #usagePattern() usage pattern}.
*
* @return the detailed help (should end with end of line or be empty) */
protected abstract String usageDetail();
/** This prints the usage pattern for the command.
* <p>
* It follows the brief introduction on the command ({@link #brief()})
*
* @return the usage pattern */
protected String usagePattern() {
return getCommandName();
}
}

View File

@@ -1,175 +1,213 @@
/* /**
* Copyright Bigeon Emmanuel (2014) * gclc:fr.bigeon.gclc.command.CommandParameters.java
* * Created on: Dec 24, 2014
* emmanuel@bigeon.fr */
* package fr.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 fr.bigeon.gclc.exception.CommandParsingException;
/** <p>
* An object representing a collection of parameters. It is used for defaulting /** An object representing a collection of parameters.
* values. * <p>
* * It is used for defaulting values.
* @author Emmanuel BIGEON */ *
public class CommandParameters { * @author Emmanuel BIGEON */
/** public final class CommandParameters {
* /** 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> boolArgs = new HashMap<>(); /** String arguments. */
/** String arguments */ private final Map<String, String> stringArguments = new HashMap<>();
private final Map<String, String> stringArgs = 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.
/** @param bools the boolean parameters *
* @param strings the string parameters * @param bools the boolean parameters
* @param strict if the argument are restricted to the declared ones */ * @param strings the string parameters
@SuppressWarnings("boxing") * @param strict if the argument are restricted to the declared ones */
public CommandParameters(Set<String> bools, Set<String> strings, public CommandParameters(final Set<String> bools, final Set<String> strings,
boolean strict) { final boolean strict) {
for (final String string : bools) { for (final String string : bools) {
boolArgs.put(string, false); booleanArguments.put(string, Boolean.FALSE);
} }
for (final String string : strings) { for (final String string : strings) {
stringArgs.put(string, null); stringArguments.put(string, null);
} }
this.strict = strict; this.strict = strict;
} }
/** @param key the key /** Get the value of a string argument.
* @return the associated value, null if it was not specified */ *
public String get(String key) { * @param key the key
return stringArgs.get(key); * @return the associated value, null if it was not specified */
} public String get(final String key) {
return stringArguments.get(key);
/** @return additional non parsed parameters */ }
public List<String> getAdditionals() {
return Collections.unmodifiableList(additional); /** Get the additional (unrecognized) arguments.
} *
* @return additional non parsed parameters */
/** @param key the key public List<String> getAdditionals() {
* @return if the key was specified */ return Collections.unmodifiableList(additional);
@SuppressWarnings("boxing") }
public boolean getBool(String key) {
return boolArgs.get(key); /** Get the value of a boolean argument.
} *
* @param key the key
/** @param args the arguments to parse * @return if the key was specified */
* @return if the arguments were parsed */ public boolean getBool(final String key) {
public boolean parseArgs(String... args) { return booleanArguments.containsKey(key) &&
int i = 0; booleanArguments.get(key).booleanValue();
while (i < args.length) { }
String next = null;
if (i < args.length - 1) { /** Get the boolean arguments.
next = args[i + 1]; *
} * @return the boolean arguments */
int p = parseArg(args[i], next); public Set<String> getBooleanArgumentKeys() {
if (p == 0) { return booleanArguments.keySet();
return false; }
}
i += p; /** Get the string arguments.
} *
return true; * @return the boolean arguments */
public Set<String> getStringArgumentKeys() {
} return stringArguments.keySet();
}
/** Attempt to parse an argument.
* <p> /** Test if an argument exists in this object.
* This method return 0 if the parsing was incorrect, or the number of *
* parsed elements. * @param key the key
* * @return if the key is present in string arguments or boolean ones. */
* @param arg the argument public boolean hasArgument(final String key) {
* @param next the next element return stringArguments.containsKey(key) ||
* @return the number of element read */ booleanArguments.containsKey(key);
private int parseArg(String arg, String next) { }
if (!arg.startsWith("-")) { //$NON-NLS-1$
return 1; /** Attempt to parse an argument.
} * <p>
String name = arg.substring(1); * This method return 0 if the parsing was incorrect, or the number of
if (boolArgs.containsKey(name)) { * parsed elements.
boolArgs.put(name, Boolean.TRUE); *
return 1; * @param arg the argument
} * @param next the next element
if (stringArgs.containsKey(name)) { * @return the number of element read */
return parseStringArg(name, next); private int parseArg(final String arg, final String next) {
} if (!arg.startsWith("-")) { //$NON-NLS-1$
if (strict) { if (strict) {
return 0; return 0;
} }
additional.add(name); additional.add(arg);
return 1; return 1;
} }
final String name = arg.substring(1);
/** Add a string arg value if (booleanArguments.containsKey(name)) {
* booleanArguments.put(name, Boolean.TRUE);
* @param name the string arg name return 1;
* @param next the string arg value }
* @return 2 or 0 if next is invalid */ if (stringArguments.containsKey(name)) {
private int parseStringArg(String name, String next) { return parseStringArg(name, next);
if (next == null) { }
return 0; if (strict) {
} return 0;
stringArgs.put(name, next); }
return STRINGARG_NUMBER_OF_ELEMENTS; additional.add(name);
} return 1;
}
/** @param string the key
* @param value the value */ /** Parse arguments.
@SuppressWarnings("boxing") *
public void set(String string, boolean value) { * @param args the arguments to parse
if (boolArgs.containsKey(string)) { * @throws CommandParsingException if the arguments parsing failed */
boolArgs.put(string, value); public void parseArgs(final String... args) throws CommandParsingException {
} int i = 0;
} while (i < args.length) {
String next = null;
/** @param string the key if (i < args.length - 1) {
* @param value the value */ next = args[i + 1];
public void set(String string, String value) { }
if (stringArgs.containsKey(string)) { final int p = parseArg(args[i], next);
stringArgs.put(string, value); if (p == 0) {
} 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
* @return 2 or 0 if next is invalid */
private int parseStringArg(final String name, final String next) {
if (next == null) {
return 0;
}
stringArguments.put(name, next);
return STRINGARG_NUMBER_OF_ELEMENTS;
}
/** Set a boolean parameter value.
*
* @param string the key
* @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 */
public void set(final String string, final String value) {
if (stringArguments.containsKey(string)) {
stringArguments.put(string, value);
}
}
}

View File

@@ -1,100 +1,121 @@
/* /** acide:fr.bigeon.acide.CommandProvider.java
* Copyright Bigeon Emmanuel (2014) * Created on: Aug 6, 2014 */
* package fr.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.HashSet; import java.util.List;
import java.util.Set;
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.i18n.Messages;
import fr.bigeon.gclc.i18n.Messages; import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** <p>
* 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 Set<ICommand> commands; protected final List<ICommand> commands;
/** Create a command provider */ /** Create a command provider. */
public CommandProvider() { public CommandProvider() {
super(); super();
commands = new HashSet<>(); commands = new ArrayList<>();
} }
/* (non-Javadoc) /** Test the command name validity.
* @see fr.bigeon.gclc.command.ICommandProvider#add(java.lang.String, *
* fr.bigeon.gclc.command.Command) */ * @param name the command name
@Override * @throws InvalidCommandName if the name is invalid */
public boolean add(ICommand value) throws InvalidCommandName { private static void testCommandName(final String name) throws InvalidCommandName {
final String name = value.getCommandName(); if (name == null || name.isEmpty() || name.startsWith(MINUS)
if (name == null || name.startsWith(MINUS) || name.contains(SPACE)) { || name.contains(SPACE)) {
throw new InvalidCommandName(); throw new InvalidCommandName();
} }
return commands.add(value); }
}
/* (non-Javadoc)
@Override * @see fr.bigeon.gclc.command.ICommandProvider#add(java.lang.String,
public void executeSub(String cmd, * fr.bigeon.gclc.command.Command) */
String... args) throws CommandRunException { @Override
for (final ICommand command : commands) { public final boolean add(final ICommand value) throws InvalidCommandName {
if (command.getCommandName().equals(cmd)) { final String name = value.getCommandName();
command.execute(args); testCommandName(name);
return; if (commands.contains(value)) {
} return true;
} }
throw new CommandRunException( for (final ICommand iCommand : commands) {
Messages.getString("CommandProvider.unrecognized0", cmd)); //$NON-NLS-1$ if (iCommand.getCommandName().equals(value.getCommandName())) {
} throw new InvalidCommandName(
"Name already used: " + value.getCommandName()); //$NON-NLS-1$
/* (non-Javadoc) }
* @see fr.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */ }
@Override return commands.add(value);
public ICommand get(String commandName) { }
for (final ICommand command : commands) {
if (command.getCommandName().equals(commandName)) { /* (non-Javadoc)
return command; * @see
} * fr.bigeon.gclc.command.ICommandProvider#executeSub(fr.bigeon.gclc.manager
} * .ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String,
return null; * java.lang.String[]) */
} @Override
} public final void executeSub(final ConsoleOutput out, final ConsoleInput in,
final String cmd, final String... args) throws CommandRunException {
final ICommand command = get(cmd);
if (command == null) {
throw new CommandRunException(
Messages.getString("CommandProvider.unrecognized", cmd), null); //$NON-NLS-1$
}
command.execute(out, in, args);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */
@Override
public final ICommand get(final String commandName) {
for (final ICommand command : commands) {
if (command.getCommandName().equals(commandName)) {
return command;
}
}
return null;
}
}

View File

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

View File

@@ -1,83 +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:fr.bigeon.gclc.command.ICommand.java
* Created on: May 31, 2016 * Created on: May 31, 2016
*/ */
package fr.bigeon.gclc.command; package fr.bigeon.gclc.command;
import java.io.IOException; /*-
* #%L
import fr.bigeon.gclc.exception.CommandRunException; * Generic Command Ligne console
import fr.bigeon.gclc.manager.ConsoleManager; * %%
* Copyright (C) 2014 - 2018 bigeon.fr
/** The contract of commands * %%
* <p> * This software is governed by the CeCILL license under French law and
* This interface describe the contract of commands * 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 interface ICommand { * "http://www.cecill.info".
*
/** @param args the arguments of the command (some expect an empty array) * As a counterpart to the access to the source code and rights to copy,
* @throws CommandRunException if the execution of the command failed for * modify and redistribute granted by the license, users are provided only
* any reason */ * with a limited warranty and the software's author, the holder of the
void execute(String... args) throws CommandRunException; * economic rights, and the successive licensors have only limited
* liability.
/** @return the command's name */ *
String getCommandName(); * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
/** This prints the help associated to this command. * 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 default behavior is to print: * therefore means that it is reserved for developers and experienced
* * professionals having in-depth computer knowledge. Users are therefore
* <pre> * encouraged to load and test the software's suitability as regards their
* [Command name] * requirements in conditions enabling the security of their systems and/or
* [brief message] * data to be ensured and, more generally, to use and operate it in the
* * same conditions as regards security.
* Usage: *
* [Usage pattern] * The fact that you are presently reading this means that you have had
* * knowledge of the CeCILL license and that you accept its terms.
* [Usage details] * #L%
* </pre> */
* import java.io.IOException;
* @param manager the manager to print the data
* @param args the arguments called with the help import fr.bigeon.gclc.exception.CommandRunException;
* @throws IOException if the manager was closed */ import fr.bigeon.gclc.manager.ConsoleInput;
void help(ConsoleManager manager, String... args) throws IOException; import fr.bigeon.gclc.manager.ConsoleOutput;
/** @return a tip on the command */ /** The contract of commands.
String tip(); * <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,82 +1,117 @@
/* /*
* 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:fr.bigeon.gclc.command.ICommandProvider.java
* Created on: Sep 6, 2014 */ * Created on: Sep 6, 2014 */
package fr.bigeon.gclc.command; package fr.bigeon.gclc.command;
import fr.bigeon.gclc.exception.CommandRunException; /*-
import fr.bigeon.gclc.exception.InvalidCommandName; * #%L
* Generic Command Ligne console
/** <p> * %%
* An ICommadProvider is a provider of commands that can register commands under * Copyright (C) 2014 - 2018 bigeon.fr
* some keywords. * %%
* * 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 interface ICommandProvider { * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
/** <p> * "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.
public boolean add(ICommand value) throws InvalidCommandName; *
* In this respect, the user's attention is drawn to the risks associated
/** <p> * with loading, using, modifying and/or developing or reproducing the
* This method executes the command with the given name found. If no command * software by the user in light of its specific status of free software,
* with this name is found, an error command is usually executed. If there * that may mean that it is complicated to manipulate, and that also
* are several commands with the same name, the behavior is unspecified. * therefore means that it is reserved for developers and experienced
* Depending on the implementation, it may run an error command or prompt * professionals having in-depth computer knowledge. Users are therefore
* 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 command the name of the command the user wishes to execute * data to be ensured and, more generally, to use and operate it in the
* @param args the arguments for the command * same conditions as regards security.
* @throws CommandRunException if the command failed to run */ *
public void executeSub(String command, * The fact that you are presently reading this means that you have had
String... args) throws CommandRunException; * knowledge of the CeCILL license and that you accept its terms.
* #L%
/** <p> */
* This method provide the command with the given name found. If no command import fr.bigeon.gclc.exception.CommandRunException;
* with this name is found, an error command is usually returned. If there import fr.bigeon.gclc.exception.InvalidCommandName;
* are several commands with the same name, the behavior is unspecified. import fr.bigeon.gclc.manager.ConsoleInput;
* Depending on the implementation, it may return an error command or the import fr.bigeon.gclc.manager.ConsoleOutput;
* first command with this name found.
* /** An ICommadProvider is a provider of commands that can register commands
* @param command the name of the command the user wishes to execute * under some keywords.
* @return the command to execute */ *
public ICommand get(String command); * @author Emmanuel BIGEON */
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

@@ -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.command.ParametrizedCommand.java * gclc:fr.bigeon.gclc.command.ParametrizedCommand.java
* Created on: Dec 24, 2014 * Created on: Dec 24, 2014
*/ */
package fr.bigeon.gclc.command; package fr.bigeon.gclc.command;
import java.io.IOException; /*-
import java.util.ArrayList; * #%L
import java.util.HashMap; * Generic Command Ligne console
import java.util.List; * %%
import java.util.Map; * Copyright (C) 2014 - 2018 bigeon.fr
* %%
import fr.bigeon.gclc.exception.CommandRunException; * This software is governed by the CeCILL license under French law and
import fr.bigeon.gclc.manager.ConsoleManager; * 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 command relying on the {@link CommandParameters} to store parameters values * "http://www.cecill.info".
* *
* @author Emmanuel BIGEON */ * As a counterpart to the access to the source code and rights to copy,
public abstract class ParametrizedCommand 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
/** If the command may use interactive prompting for required parameters * economic rights, and the successive licensors have only limited
* that * liability.
* were not provided on execution */ *
private boolean interactive = true; * In this respect, the user's attention is drawn to the risks associated
/** The manager */ * with loading, using, modifying and/or developing or reproducing the
protected final ConsoleManager manager; * software by the user in light of its specific status of free software,
/** The boolean parameters mandatory status */ * that may mean that it is complicated to manipulate, and that also
private final Map<String, Boolean> boolParams = new HashMap<>(); * therefore means that it is reserved for developers and experienced
/** The string parameters mandatory status */ * professionals having in-depth computer knowledge. Users are therefore
private final Map<String, Boolean> stringParams = new HashMap<>(); * encouraged to load and test the software's suitability as regards their
/** The parameters mandatory status */ * requirements in conditions enabling the security of their systems and/or
private final Map<String, Boolean> params = new HashMap<>(); * data to be ensured and, more generally, to use and operate it in the
/** The restriction of provided parameters on execution to declared * same conditions as regards security.
* paramters *
* in the status maps. */ * The fact that you are presently reading this means that you have had
private final boolean strict; * knowledge of the CeCILL license and that you accept its terms.
* #L%
/** @param manager the manager */
* @param name the name */ import java.io.IOException;
public ParametrizedCommand(ConsoleManager manager, String name) { import java.util.Set;
this(manager, name, true);
} import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidParameterException;
/** @param manager the manager import fr.bigeon.gclc.manager.ConsoleInput;
* @param name the name import fr.bigeon.gclc.manager.ConsoleOutput;
* @param strict if the arguments are restricted to the declared ones */
public ParametrizedCommand(ConsoleManager manager, String name, /** A command relying on the {@link CommandParameters} to store parameters
boolean strict) { * values.
super(name); *
this.manager = manager; * @author Emmanuel BIGEON */
interactive = manager != null; public abstract class ParametrizedCommand extends Command {
this.strict = strict;
} private final ParametrizedCommandData data;
/** <p> /** Create a parametrized command.
* Add a parameter to the defined parameters * <p>
* * Implementation are supposed to call the
* @param param the parameter identification * {@link #addBooleanParameter(String)} and
* @param stringOrBool if the parameter is a parameter with an argument * {@link #addStringParameter(String, boolean)} method to set the
* @param needed if the parameter is required */ * parameters.
@SuppressWarnings("boxing") *
protected void addParameter(String param, boolean stringOrBool, * @param name the name */
boolean needed) { public ParametrizedCommand(final String name) {
if (params.containsKey(param)) { this(name, true);
return; }
}
params.put(param, needed); /** Create a parametrized command.
if (stringOrBool) { * <p>
stringParams.put(param, needed); * Implementation are supposed to call the
} else { * {@link #addBooleanParameter(String)} and
if (needed) { * {@link #addStringParameter(String, boolean)} method to set the
// ERROR the boolean parameters cannot be needed * parameters.
} *
boolParams.put(param, needed); * @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);
/** @param parameters the command parameters */ data = new ParametrizedCommandData(strict);
protected abstract void doExecute(CommandParameters parameters); }
/* (non-Javadoc) /** Add a boolean parameter to defined parmaters.
* @see fr.bigeon.gclc.command.Command#execute(java.lang.String[]) */ *
@SuppressWarnings("boxing") * @param flag the boolean flag
@Override * @throws InvalidParameterException if the parameter is already defined as
public final void execute(String... args) throws CommandRunException { * a string parameter */
final CommandParameters parameters = new CommandParameters( protected final void addBooleanParameter(final String flag) throws InvalidParameterException {
boolParams.keySet(), stringParams.keySet(), strict); data.addBooleanParameter(flag);
if (!parameters.parseArgs(args)) { }
// ERROR the parameters could not be correctly parsed
throw new CommandRunException("Unable to read arguments"); //$NON-NLS-1$ /** Add a string parameter to defined parmaters.
} *
final List<String> toProvide = new ArrayList<>(); * @param flag the parameter flag
for (final String string : params.keySet()) { * @param needed if the parameter's absence should cause an exception
if (params.get(string) && parameters.get(string) == null) { * @throws InvalidParameterException if the parameter is already defined as
if (!interactive) { * a boolean parameter */
return; protected final void addStringParameter(final String flag,
} final boolean needed) throws InvalidParameterException {
toProvide.add(string); data.addStringParameter(flag, needed);
} }
}
// for each needed parameters that is missing, prompt the user. /** Actually performs the execution after parsing the parameters.
fillParameters(toProvide, parameters); *
doExecute(parameters); * @param out the output
} * @param in the input
* @param parameters the command parameters
/** @param parameters the parameter list to complete * @throws CommandRunException if the command failed */
* @param toProvide the parameters to ask for protected abstract void doExecute(ConsoleOutput out, ConsoleInput in,
* @throws CommandRunException if the manager was closed */ CommandParameters parameters) throws CommandRunException;
private void fillParameters(List<String> toProvide,
CommandParameters parameters) throws CommandRunException { /* (non-Javadoc)
for (final String string : toProvide) { * @see fr.bigeon.gclc.command.Command#execute(java.lang.String[]) */
String value; @Override
try { public final void execute(final ConsoleOutput output,
value = manager.prompt(string); final ConsoleInput input,
while (value.isEmpty()) { final String... args) throws CommandRunException {
value = manager.prompt(string); try {
} doExecute(output, input, data.getParameters(input, args));
} catch (IOException e) { } catch (final IOException e) {
throw new CommandRunException( throw new CommandRunException("Unable to get parameters", e);
"Interactive command but manager closed...", e); //$NON-NLS-1$ }
} }
parameters.set(string, value);
} /** 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

@@ -0,0 +1,252 @@
/*
* 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:fr.bigeon.gclc.command.ParametrizedCommand.java
* Created on: Dec 24, 2014
*/
package fr.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.text.MessageFormat;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import fr.bigeon.gclc.exception.CommandParsingException;
import fr.bigeon.gclc.exception.InvalidParameterException;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.EmptyInput;
/** An object to handle standardized command parameters.
*
* @author Emmanuel BIGEON */
public final class ParametrizedCommandData {
/** The boolean parameters mandatory status. */
private final Set<String> boolParams = new HashSet<>();
/** The string parameters mandatory status. */
private final Map<String, Boolean> stringParams = new HashMap<>();
/** The parameters mandatory status. */
private final Map<String, Boolean> params = new HashMap<>();
/** The restriction of provided parameters on execution to declared paramters in
* the status maps. */
private final boolean strict;
/** The data for the parametrized command. */
public ParametrizedCommandData() {
this(true);
}
/** The data for a parametrized command.
*
* @param strict if the command was refusing unrecognized parameters */
public ParametrizedCommandData(final boolean strict) {
this.strict = 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 */
public final void addBooleanParameter(final String flag)
throws InvalidParameterException {
if (params.containsKey(flag) && stringParams.containsKey(flag)) {
throw new InvalidParameterException("Parameter is already defined as string"); //$NON-NLS-1$
}
boolParams.add(flag);
params.put(flag, Boolean.FALSE);
}
/** 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 */
public final void addStringParameter(final String flag, final boolean needed)
throws InvalidParameterException {
if (params.containsKey(flag)) {
checkParam(flag, needed);
return;
}
stringParams.put(flag, Boolean.valueOf(needed));
params.put(flag, Boolean.valueOf(needed));
}
/** Check a parameter.
*
* @param param the string parameter
* @param needed if the parameter is needed
* @throws InvalidParameterException if the new definition is invalid */
private void checkParam(final String param, final boolean needed)
throws InvalidParameterException {
if (stringParams.containsKey(param)) {
final Boolean need = Boolean
.valueOf(needed || stringParams.get(param).booleanValue());
stringParams.put(param, need);
params.put(param, need);
return;
}
throw new InvalidParameterException("Parameter is already defined as boolean"); //$NON-NLS-1$
}
/** Get the parameters from an input.
*
* @param input the input
* @param args the command arguments
* @return the command object
* @throws IOException if the command could not be filled. */
public final CommandParameters getParameters(final ConsoleInput input,
final String... args) throws IOException {
final CommandParameters parameters = new CommandParameters(boolParams,
stringParams.keySet(), strict);
try {
parameters.parseArgs(args);
} catch (final CommandParsingException e) {
throw new IOException(e);
}
final List<String> toProvide = new ArrayList<>();
for (final Entry<String, Boolean> string : params.entrySet()) {
if (string.getValue().booleanValue()
&& parameters.get(string.getKey()) == null) {
if (input == null || input == EmptyInput.INSTANCE) {
throw new IOException();
}
toProvide.add(string.getKey());
}
}
// for each needed parameters that is missing, prompt the user.
fillParameters(input, toProvide, parameters);
return parameters;
}
/** Fill the undefined parameters.
* <p>
* This method prompts the user to fill the needed parameters.
*
* @param input the input to prompt through
* @param parameters the parameter list to complete
* @param toProvide the parameters to ask for
* @throws IOException if the manager was closed */
private final static void fillParameters(final ConsoleInput input,
final List<String> toProvide, final CommandParameters parameters)
throws IOException {
for (final String string : toProvide) {
String value;
value = input.prompt(MessageFormat.format("value of {0}? ", string)); //$NON-NLS-1$
while (value.isEmpty()) {
value = input
.prompt(MessageFormat.format("value of {0}? (cannot be empty) ", //$NON-NLS-1$
string));
}
parameters.set(string, value);
}
}
/** Retrieve the boolean parameters (aka flags).
*
* @return the set of boolean parameters */
public final Set<String> getBooleanParameters() {
return Collections.unmodifiableSet(boolParams);
}
/** Retrieve the parameter names.
*
* @return the stringParams */
public final Set<String> getParameters() {
return params.keySet();
}
/** Get the string parameters names.
*
* @return the stringParams */
public final Set<String> getStringParameters() {
return stringParams.keySet();
}
/** 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 params.containsKey(param) && params.get(param).booleanValue();
}
/** If the command refuse unrecognized parameters.
*
* @return the strict */
public final boolean isStrict() {
return strict;
}
}

View File

@@ -1,187 +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:fr.bigeon.gclc.command.SubedCommand.java
* Created on: Sep 6, 2014 */ * Created on: Sep 6, 2014 */
package fr.bigeon.gclc.command; package fr.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.InvalidCommandName; * Copyright (C) 2014 - 2018 bigeon.fr
import fr.bigeon.gclc.manager.ConsoleManager; * %%
* 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,
* A subed command is a command that can execute sub commands depending on the * modify and/ or redistribute the software under the terms of the CeCILL
* first argument. * license as circulated by CEA, CNRS and INRIA at the following URL
* * "http://www.cecill.info".
* @author Emmanuel BIGEON */ *
public class SubedCommand implements ICommandProvider, ICommand { * 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 tab character */ * with a limited warranty and the software's author, the holder of the
private static final String TAB = "\t"; //$NON-NLS-1$ * economic rights, and the successive licensors have only limited
/** <p> * liability.
* The command to execute when this command is called with no sub arguments. *
* This may be null, in which case the command should have arguments. */ * In this respect, the user's attention is drawn to the risks associated
private final ICommand noArgCommand; * with loading, using, modifying and/or developing or reproducing the
/** A tip on this command. */ * software by the user in light of its specific status of free software,
private final String tip; * that may mean that it is complicated to manipulate, and that also
/** The provider */ * therefore means that it is reserved for developers and experienced
private final CommandProvider provider; * professionals having in-depth computer knowledge. Users are therefore
/** The name of the command */ * encouraged to load and test the software's suitability as regards their
private final String name; * 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
/** @param name the name of the command */ * same conditions as regards security.
public SubedCommand(String name) { *
this.name = name; * The fact that you are presently reading this means that you have had
provider = new CommandProvider(); * knowledge of the CeCILL license and that you accept its terms.
noArgCommand = null; * #L%
tip = null; */
} import java.io.IOException;
import java.util.Arrays;
/** @param name the name of the command
* @param noArgCommand the command to execute when no extra parameter are import fr.bigeon.gclc.exception.CommandRunException;
* provided */ import fr.bigeon.gclc.exception.CommandRunExceptionType;
public SubedCommand(String name, ICommand noArgCommand) { import fr.bigeon.gclc.manager.ConsoleInput;
this.name = name; import fr.bigeon.gclc.manager.ConsoleOutput;
provider = new CommandProvider();
this.noArgCommand = noArgCommand; /**
tip = null; * <p>
} * A subed command is a command that can execute sub commands depending on the
* first argument.
/** @param name the name of the command *
* @param noArgCommand the command to execute * @author Emmanuel BIGEON */
* @param tip the help tip associated */ public final class SubedCommand extends CommandProvider implements ICommand {
public SubedCommand(String name, ICommand noArgCommand,
String tip) { /** The tab character. */
this.name = name; private static final String TAB = "\t"; //$NON-NLS-1$
provider = new CommandProvider(); /** The command to execute when this command is called with no sub
this.noArgCommand = noArgCommand; * arguments.
this.tip = tip; * <p>
} * This may be null, in which case the command should have arguments. */
private final ICommand noArgCommand;
/** @param name the name of the command /** A tip on this command. */
* @param tip the help tip associated */ private final String tip;
public SubedCommand(String name, String tip) { /** The name of the command. */
this.name = name; private final String name;
provider = new CommandProvider();
noArgCommand = null; /** Create the command that defines sub commands.
this.tip = tip; *
} * @param name the name of the command */
public SubedCommand(final String name) {
@Override super();
public boolean add(ICommand value) throws InvalidCommandName { this.name = name;
return provider.add(value); noArgCommand = null;
} tip = null;
}
/* (non-Javadoc)
* @see fr.bigeon.acide.Command#execute(java.lang.String[]) */ /** Create the command that defines sub commands.
@Override *
public void execute(String... args) throws CommandRunException { * @param name the name of the command
if (args.length == 0 || args[0].startsWith("-")) { //$NON-NLS-1$ * @param noArgCommand the command to execute when no extra parameter are
if (noArgCommand != null) { * provided */
noArgCommand.execute(args); public SubedCommand(final String name, final ICommand noArgCommand) {
} else { super();
throw new CommandRunException("Unrecognized command"); //$NON-NLS-1$ this.name = name;
} this.noArgCommand = noArgCommand;
} else { tip = null;
executeSub(args[0], Arrays.copyOfRange(args, 1, args.length)); }
}
} /** Create the command that defines sub commands.
*
/* (non-Javadoc) * @param name the name of the command
* @see * @param noArgCommand the command to execute
* fr.bigeon.gclc.command.ICommandProvider#executeSub(java.lang.String, * @param tip the help tip associated */
* java.lang.String[]) */ public SubedCommand(final String name, final ICommand noArgCommand,
@Override final String tip) {
public void executeSub(String command, super();
String... args) throws CommandRunException { this.name = name;
provider.executeSub(command, args); this.noArgCommand = noArgCommand;
} this.tip = tip;
}
@Override
public ICommand get(String commandName) { /** Create the command that defines sub commands.
return provider.get(commandName); *
} * @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(ConsoleManager manager, public void execute(final ConsoleOutput output, final ConsoleInput input,
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 : provider.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 fr.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 fr.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 " + provider; //$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 fr.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,100 +0,0 @@
/*
* 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:fr.bigeon.gclc.UnrecognizedCommand.java
* Created on: Dec 23, 2014
*/
package fr.bigeon.gclc.command;
import java.io.IOException;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleManager;
import fr.bigeon.gclc.prompt.CLIPrompterMessages;
/** <p>
* The error message for unrecognized commands
*
* @author Emmanuel BIGEON */
public final class UnrecognizedCommand implements ICommand {
/** The unrecognized command key */
private static final String UNRECOGNIZED_CMD = "unrecognized.cmd"; //$NON-NLS-1$
/** The unrecognized command key */
private static final String EXPECTED_CMD = "expected.cmd"; //$NON-NLS-1$
/** The manager */
private final ConsoleManager manager;
/** @param manager the console manager to use */
public UnrecognizedCommand(ConsoleManager manager) {
if (manager == null) {
throw new NullPointerException("The argument cannot be null"); //$NON-NLS-1$
}
this.manager = manager;
}
@Override
public void execute(String... args) throws CommandRunException {
try {
if (args.length > 0) {
manager.println(CLIPrompterMessages.getString(UNRECOGNIZED_CMD,
(Object[]) args));
} else {
manager.println(CLIPrompterMessages.getString(EXPECTED_CMD));
}
} catch (IOException e) {
throw new CommandRunException("Manager closed", e); //$NON-NLS-1$
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */
@Override
public String getCommandName() {
return ""; //$NON-NLS-1$
}
@Override
public void help(@SuppressWarnings("hiding") ConsoleManager manager,
String... args) {
// Nothing to do (no help provided as this is not a user command
// (usually)
}
@Override
public String tip() {
return null;
}
}

View File

@@ -1,97 +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:fr.bigeon.gclc.ExitCommand.java
* Created on: Jun 8, 2016 * Created on: Jun 8, 2016
*/ */
package fr.bigeon.gclc.command; package fr.bigeon.gclc.command.base;
import java.io.IOException; /*-
* #%L
import fr.bigeon.gclc.ConsoleApplication; * Generic Command Ligne console
import fr.bigeon.gclc.manager.ConsoleManager; * %%
import fr.bigeon.gclc.prompt.CLIPrompterMessages; * Copyright (C) 2014 - 2018 bigeon.fr
* %%
/** <p> * 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
/** @param name the name of the command * software by the user in light of its specific status of free software,
* @param app the application to exit */ * that may mean that it is complicated to manipulate, and that also
public ExitCommand(String name, ConsoleApplication app) { * therefore means that it is reserved for developers and experienced
this.name = name; * professionals having in-depth computer knowledge. Users are therefore
this.app = app; * 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
/** The actions to take before exiting */ * same conditions as regards security.
public void beforeExit() { *
// Do nothing by default * 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%
@Override */
public final void execute(String... args) { import java.io.IOException;
beforeExit();
app.exit(); import fr.bigeon.gclc.ConsoleApplication;
} import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.manager.ConsoleInput;
/* (non-Javadoc) import fr.bigeon.gclc.manager.ConsoleOutput;
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ import fr.bigeon.gclc.prompt.CLIPrompterMessages;
@Override
public final String getCommandName() { /** A command to exit a {@link ConsoleApplication}.
return name; *
} * @author Emmanuel BIGEON */
public final class ExitCommand implements ICommand {
@Override /** The exit command manual message key. */
public void help(ConsoleManager manager, private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$
String... args) throws IOException { /** The tip of the exit command. */
manager.println( private static final String EXIT = "exit.tip"; //$NON-NLS-1$
CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args)); /** The application that will be exited when this command runs. */
} private final ConsoleApplication app;
/** The exit command name. */
@Override private final String name;
public String tip() {
return CLIPrompterMessages.getString(EXIT); /** Create the exiting command.
} *
} * @param name the name of the command
* @param app the application to 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 fr.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,127 @@
/*
* 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:fr.bigeon.gclc.command.MockCommand.java
* Created on: Nov 18, 2016
*/
package fr.bigeon.gclc.command.base;
import fr.bigeon.gclc.command.ICommand;
/*-
* #%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 fr.bigeon.gclc.manager.ConsoleInput;
import fr.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 fr.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput,
* String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) {
//
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */
@Override
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)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return null;
}
}

View File

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

View File

@@ -0,0 +1,8 @@
/**
*
*/
/**
* @author Emmanuel Bigeon
*
*/
package fr.bigeon.gclc.command.base;

View File

@@ -1,51 +1,83 @@
/* /*
* 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.package-info.java /** gclc:fr.bigeon.gclc.command.package-info.java
* Created on: Sep 6, 2014 */ * Created on: Sep 6, 2014 */
/** This package groups elements related to /** This package groups elements related to
* {@link fr.bigeon.gclc.command.ICommand} * {@link fr.bigeon.gclc.command.ICommand}
* <p> * <p>
* There are some implementations, such as the * There are some implementations, such as the
* {@link fr.bigeon.gclc.command.ParametrizedCommand} for commands with a * {@link fr.bigeon.gclc.command.ParametrizedCommand} for commands with a
* predefined set of flags and option taking a string as value, the * predefined set of flags and option taking a string as value, the
* {@link fr.bigeon.gclc.command.SubedCommand} for a command that is declined in * {@link fr.bigeon.gclc.command.SubedCommand} for a command that is declined in
* a set of sub commands, the {@link fr.bigeon.gclc.command.HelpExecutor} for * a set of sub commands, the {@link fr.bigeon.gclc.command.HelpExecutor} for
* help display of other commands and the * help display of other commands and the
* {@link fr.bigeon.gclc.command.UnrecognizedCommand} that should not be *
* directly accessible to the user, but will be used in case of error in typing. * @author Emmanuel BIGEON */
* package fr.bigeon.gclc.command;
* @author Emmanuel BIGEON */
package fr.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%
*/

View File

@@ -1,65 +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:fr.bigeon.gclc.exception.CommandParsingException.java
* Created on: Jun 1, 2016 * Created on: Jun 1, 2016
*/ */
package fr.bigeon.gclc.exception; package fr.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,
/** @param message an explaination * modify and/ or redistribute the software under the terms of the CeCILL
* @param cause the cause */ * license as circulated by CEA, CNRS and INRIA at the following URL
public CommandParsingException(String message, Throwable cause) { * "http://www.cecill.info".
super(message, cause); *
} * 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 an explaination */ * with a limited warranty and the software's author, the holder of the
public CommandParsingException(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
/** @param cause the cause */ * with loading, using, modifying and/or developing or reproducing the
public CommandParsingException(Throwable cause) { * software by the user in light of its specific status of free software,
super(cause); * that may mean that it is complicated to manipulate, and that also
} * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
} * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** An exception raised during command parsing.
*
* @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,74 +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:fr.bigeon.gclc.exception.CommandRunException.java
* Created on: Feb 10, 2015 * Created on: Feb 10, 2015
*/ */
package fr.bigeon.gclc.exception; package fr.bigeon.gclc.exception;
/** <p> /*-
* An exception thrown when a command failed to run correctly. * #%L
* * Generic Command Ligne console
* @author Emmanuel BIGEON */ * %%
public class CommandRunException extends Exception { * 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
private static final long serialVersionUID = 1L; * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
/** @param message a message */ *
public CommandRunException(String message) { * As a counterpart to the access to the source code and rights to copy,
super(message); * 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
/** @param message a message * liability.
* @param cause the cause */ *
public CommandRunException(String message, Throwable cause) { * In this respect, the user's attention is drawn to the risks associated
super(message, cause); * 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
/* (non-Javadoc) * therefore means that it is reserved for developers and experienced
* @see java.lang.Throwable#getLocalizedMessage() */ * professionals having in-depth computer knowledge. Users are therefore
@Override * encouraged to load and test the software's suitability as regards their
public String getLocalizedMessage() { * requirements in conditions enabling the security of their systems and/or
if (getCause() != null) { * data to be ensured and, more generally, to use and operate it in the
return super.getLocalizedMessage() + ": " + //$NON-NLS-1$ * same conditions as regards security.
getCause().getLocalizedMessage(); *
} * The fact that you are presently reading this means that you have had
return super.getLocalizedMessage(); * knowledge of the CeCILL license and that you accept its terms.
} * #L%
*/
}
/** An exception thrown when a command failed to run correctly.
*
* @author Emmanuel BIGEON */
public final class CommandRunException extends Exception {
/** the SVUID. */
private static final long serialVersionUID = 1L;
/** The type of run exception. */
private final CommandRunExceptionType type;
/** Create the exception.
*
* @param type the type of exception
* @param message the message */
public CommandRunException(final CommandRunExceptionType type,
final String message) {
super(message);
this.type = type;
}
/** Create the exception with a cause.
*
* @param type the type of exception
* @param message a message
* @param cause the cause */
public CommandRunException(final CommandRunExceptionType type,
final String message, final Throwable cause) {
super(message, cause);
this.type = type;
}
/** Create the exception with type {@link CommandRunExceptionType#EXECUTION}.
*
* @param message a message */
public CommandRunException(final String message) {
super(message);
type = CommandRunExceptionType.EXECUTION;
}
/** Create the exception with type {@link CommandRunExceptionType#EXECUTION} and
* a cause.
*
* @param message a message
* @param cause the cause */
public CommandRunException(final String message, final Throwable cause) {
super(message, cause);
type = CommandRunExceptionType.EXECUTION;
}
/* (non-Javadoc)
* @see java.lang.Throwable#getLocalizedMessage() */
@Override
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

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

@@ -0,0 +1,105 @@
/*
* 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:fr.bigeon.gclc.exception.InvalidParameterException.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.exception;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** This exception is thrown during command definitions to indicate a wrong
* 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,10 +1,10 @@
/* /*
* Copyright E. Bigeon (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
* Socket implementation of GCLC. * 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,45 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc-socket:fr.bigeon.gclc.socket.ConsoleRunnable.java * gclc:fr.bigeon.gclc.exception.package-info.java
* Created on: Jun 1, 2016 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.socket; /** Exceptions package.
import fr.bigeon.gclc.ConsoleApplication;
/** A runnable class that will actually have the application running.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public class ConsoleRunnable implements Runnable { package fr.bigeon.gclc.exception;
/** The actual application */
private final ConsoleApplication app;
/** The synchronization object */
private final Object promptingLock;
/** @param app the application
* @param promptingLock the synchronization object */
public ConsoleRunnable(ConsoleApplication app, Object promptingLock) {
super();
this.app = app;
this.promptingLock = promptingLock;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
app.start();
synchronized (promptingLock) {
// release all waiting elements before ending
promptingLock.notifyAll();
}
}
/** Stop the application (it will finish its current operation) */
public void stop() {
app.exit();
}
}

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:fr.bigeon.gclc.i18n.Messages.java
* Created on: Jun 1, 2016 * Created on: Jun 1, 2016
*/ */
package fr.bigeon.gclc.i18n; package fr.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 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(String key, Object... args) { * #L%
try { */
return MessageFormat.format(RESOURCE_BUNDLE.getString(key), args); import java.text.MessageFormat;
} catch (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 = "fr.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

@@ -0,0 +1,42 @@
/*
* 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:fr.bigeon.gclc.i18n.package-info.java
* Created on: Nov 13, 2017
*/
/** Internationalization package.
*
* @author Emmanuel Bigeon */
package fr.bigeon.gclc.i18n;

View File

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

View File

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

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

View File

@@ -0,0 +1,42 @@
/*
* 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:fr.bigeon.gclc.manager.package-info.java
* Created on: Nov 13, 2017
*/
/** The console input and output definitions.
*
* @author Emmanuel Bigeon */
package fr.bigeon.gclc.manager;

View File

@@ -0,0 +1,42 @@
/*
* 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:fr.bigeon.gclc.package-info.java
* Created on: Nov 5, 2017
*/
/** A framework for commad line applications.
*
* @author Emmanuel Bigeon */
package fr.bigeon.gclc;

View File

@@ -1,447 +1,549 @@
/* /*
* 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.CLIPrompter.java /** acide:fr.bigeon.acide.tool.CLIPrompter.java
* Created on: Jul 31, 2014 */ * Created on: Jul 31, 2014 */
package fr.bigeon.gclc.prompt; package fr.bigeon.gclc.prompt;
import java.io.IOException; /*-
import java.util.ArrayList; * #%L
import java.util.List; * Generic Command Ligne console
import java.util.Map; * %%
import java.util.logging.Level; * Copyright (C) 2014 - 2018 bigeon.fr
import java.util.logging.Logger; * %%
* This software is governed by the CeCILL license under French law and
import fr.bigeon.gclc.manager.ConsoleManager; * 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
* The {@link CLIPrompter} class is a utility class that provides method to * "http://www.cecill.info".
* prompt the user. *
* * 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 class CLIPrompter { * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
/** message key for format error in prompting a choice */ * liability.
private static final String PROMPTCHOICE_FORMATERR = "promptchoice.formaterr"; //$NON-NLS-1$ *
/** message key for out of bound error in prompting a choice */ * In this respect, the user's attention is drawn to the risks associated
private static final String PROMPTCHOICE_OUTOFBOUNDS = "promptchoice.outofbounds"; //$NON-NLS-1$ * with loading, using, modifying and/or developing or reproducing the
/** message key for first form of no in prompting a choice */ * software by the user in light of its specific status of free software,
private static final String PROMPTBOOL_CHOICES_NO1 = "promptbool.choices.no1"; //$NON-NLS-1$ * that may mean that it is complicated to manipulate, and that also
/** message key for first form of yes in prompting a choice */ * therefore means that it is reserved for developers and experienced
private static final String PROMPTBOOL_CHOICES_YES1 = "promptbool.choices.yes1"; //$NON-NLS-1$ * professionals having in-depth computer knowledge. Users are therefore
@SuppressWarnings("javadoc") * encouraged to load and test the software's suitability as regards their
private static final String BOOL_CHOICES = "promptbool.choices"; //$NON-NLS-1$ * requirements in conditions enabling the security of their systems and/or
@SuppressWarnings("javadoc") * data to be ensured and, more generally, to use and operate it in the
private static final String LIST_DISP_KEY = "promptlist.exit.dispkey"; //$NON-NLS-1$ * same conditions as regards security.
@SuppressWarnings("javadoc") *
private static final String PROMPT = "prompt.lineprompt"; //$NON-NLS-1$ * The fact that you are presently reading this means that you have had
@SuppressWarnings("javadoc") * knowledge of the CeCILL license and that you accept its terms.
private static final String LIST_CHOICE_SEP = "promptlist.multi.sepkey"; //$NON-NLS-1$ * #L%
/** The class logger */ */
private static final Logger LOGGER = Logger import java.io.IOException;
.getLogger(CLIPrompter.class.getName()); import java.util.ArrayList;
import java.util.List;
/** Utility class */ import java.util.Map;
private CLIPrompter() { import java.util.logging.Level;
// Utility class import java.util.logging.Logger;
}
import fr.bigeon.gclc.manager.ConsoleInput;
/** @param manager the manager import fr.bigeon.gclc.manager.ConsoleOutput;
* @param choices the choices
* @param cancel the cancel option if it exists /** The {@link CLIPrompter} class is a utility class that provides method to
* @return the number of choices plus one (or the number of choices if there * prompt the user.
* is a cancel) *
* @throws IOException if the manager was closed */ * @author Emmanuel BIGEON */
private static <U> int listChoices(ConsoleManager manager, List<U> choices, public final class CLIPrompter {
String cancel) throws IOException {
int index = 0; /** The zero integer. */
for (final U u : choices) { private static final Integer ZERO = Integer.valueOf(0);
manager.println(index++ + ") " + u); //$NON-NLS-1$ /** message key for format error in prompting a choice. */
} private static final String PROMPTCHOICE_FORMATERR = "promptchoice.formaterr"; //$NON-NLS-1$
if (cancel != null) { /** message key for out of bound error in prompting a choice. */
manager.println(index + ") " + cancel); //$NON-NLS-1$ private static final String PROMPTCHOICE_OUTOFBOUNDS = "promptchoice.outofbounds"; //$NON-NLS-1$
} /** message key for first form of no in prompting a choice. */
return index; private static final String PROMPTBOOL_CHOICES_NO1 = "promptbool.choices.no1"; //$NON-NLS-1$
} /** message key for first form of yes in prompting a choice. */
private static final String PROMPTBOOL_CHOICES_YES1 = "promptbool.choices.yes1"; //$NON-NLS-1$
/** @param manager the manager /** Message key for boolean choosing. */
* @param message the prompting message private static final String BOOL_CHOICES = "promptbool.choices"; //$NON-NLS-1$
* @return the choice /** Message key for the list end of prompt symbol. */
* @throws IOException if the manager was closed */ private static final String LIST_DISP_KEY = "promptlist.exit.dispkey"; //$NON-NLS-1$
public static boolean promptBoolean(ConsoleManager manager, /** Message key for the line prompt. */
String message) throws IOException { private static final String PROMPT = "prompt.lineprompt"; //$NON-NLS-1$
String result = manager /** Message key for the separation of choices selection. */
.prompt(message + CLIPrompterMessages.getString(BOOL_CHOICES)); private static final String LIST_CHOICE_SEP = "promptlist.multi.sepkey"; //$NON-NLS-1$
boolean first = true; /** The class logger. */
final String choices = CLIPrompterMessages private static final Logger LOGGER = Logger
.getString(PROMPTBOOL_CHOICES_YES1) + ", " + //$NON-NLS-1$ .getLogger(CLIPrompter.class.getName());
CLIPrompterMessages
.getString(PROMPTBOOL_CHOICES_NO1); /** Utility class. */
while (!(result.equalsIgnoreCase( private CLIPrompter() {
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1)) || // Utility class
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_NO1) }
.equalsIgnoreCase(result) ||
CLIPrompterMessages.getString("promptbool.choices.no2") //$NON-NLS-1$ /** Add a user choice to the list.
.equalsIgnoreCase(result) || *
CLIPrompterMessages.getString("promptbool.choices.yes2") //$NON-NLS-1$ * @param val the string to parse
.equalsIgnoreCase(result))) { * @param chs the list of integers
if (!first) { * @param index the max index of choice
* @return if the parsing was done correctly */
manager.println(CLIPrompterMessages private static boolean addUserChoice(final String val,
.getString("promptbool.choices.invalid", choices)); //$NON-NLS-1$ final List<Integer> chs,
result = manager.prompt( final int index) {
message + CLIPrompterMessages.getString(BOOL_CHOICES)); if (val.isEmpty()) {
} return true;
first = false; }
} final int r;
return result.equalsIgnoreCase( r = Integer.parseInt(val);
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1)) || if (r >= 0 && r <= index) {
result.equalsIgnoreCase(CLIPrompterMessages chs.add(Integer.valueOf(r));
.getString("promptbool.choices.yes2")); //$NON-NLS-1$ return true;
} }
return false;
/** @param manager the manager }
* @param keys the keys to be printed
* @param choices the real choices /** List the choices on the output.
* @param message the message *
* @param cancel the cancel option, or null * @param output the manager
* @param <U> the type of elements * @param choices the choices
* @return the choice * @param cancel the cancel option if it exists
* @throws IOException if the manager was closed */ * @return the number of choices plus one (or the number of choices if there
@SuppressWarnings("boxing") * is a cancel)
public static <U> U promptChoice(ConsoleManager manager, List<String> keys, * @throws IOException if the manager was closed */
List<U> choices, String message, private static <U> Integer listChoices(final ConsoleOutput output,
String cancel) throws IOException { final List<U> choices,
final Integer index = promptChoice(manager, keys, message, cancel); final String cancel) throws IOException {
if (index == null) { int index = 0;
return null; for (final U u : choices) {
} output.println(index++ + ") " + u); //$NON-NLS-1$
return choices.get(index); }
} if (cancel != null) {
output.println(index++ + ") " + cancel); //$NON-NLS-1$
/** @param manager the manager }
* @param <U> The choices labels type return Integer.valueOf(index - 1);
* @param <T> The real choices objects }
* @param choices the list of labels (in order to be displayed)
* @param choicesMap the map of label to actual objects /** Prompt for a boolean value.
* @param message the prompting message *
* @param cancel the cancel option if it exists (null otherwise) * @param manager the manager
* @return the chosen object * @param input the input
* @throws IOException if the manager was closed */ * @param message the prompting message
public static <U, T> T promptChoice(ConsoleManager manager, List<U> choices, * @return the choice
Map<U, T> choicesMap, String message, * @throws IOException if the manager was closed */
String cancel) throws IOException { public static boolean promptBoolean(final ConsoleOutput manager,
return choicesMap.get(choices.get( final ConsoleInput input,
promptChoice(manager, choices, message, cancel).intValue())); final String message) throws IOException {
} String result = input
.prompt(message + CLIPrompterMessages.getString(BOOL_CHOICES));
/** @param manager the manager boolean first = true;
* @param <U> the type of choices final String choices = CLIPrompterMessages
* @param choices the list of choices .getString(PROMPTBOOL_CHOICES_YES1) + ", " + //$NON-NLS-1$
* @param message the prompting message CLIPrompterMessages
* @param cancel the cancel option, or null .getString(PROMPTBOOL_CHOICES_NO1);
* @return the index of the choice while (!(result.equalsIgnoreCase(
* @throws IOException if the manager was closed */ CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1)) ||
@SuppressWarnings("boxing") CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_NO1)
public static <U> Integer promptChoice(ConsoleManager manager, .equalsIgnoreCase(result) ||
List<U> choices, String message, CLIPrompterMessages.getString("promptbool.choices.no2") //$NON-NLS-1$
String cancel) throws IOException { .equalsIgnoreCase(result) ||
manager.println(message); CLIPrompterMessages.getString("promptbool.choices.yes2") //$NON-NLS-1$
final int index = listChoices(manager, choices, cancel); .equalsIgnoreCase(result))) {
String result = ""; //$NON-NLS-1$ if (!first) {
boolean keepOn = true;
int r = -1; manager.println(CLIPrompterMessages
while (keepOn) { .getString("promptbool.choices.invalid", choices)); //$NON-NLS-1$
result = manager.prompt(CLIPrompterMessages.getString(PROMPT)); result = input.prompt(
try { message + CLIPrompterMessages.getString(BOOL_CHOICES));
r = Integer.parseInt(result); }
if (r >= 0 && r <= index) { first = false;
keepOn = false; }
} else { return result.equalsIgnoreCase(
manager.println(CLIPrompterMessages CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1)) ||
.getString(PROMPTCHOICE_OUTOFBOUNDS, 0, index)); result.equalsIgnoreCase(CLIPrompterMessages
listChoices(manager, choices, cancel); .getString("promptbool.choices.yes2")); //$NON-NLS-1$
} }
} catch (final NumberFormatException e) { /** Prompt for a choice.
keepOn = true; *
manager.println(CLIPrompterMessages * @param manager the manager
.getString(PROMPTCHOICE_FORMATERR, 0, index)); * @param input the input
listChoices(manager, choices, cancel); * @param keys the keys to be printed
} * @param choices the real choices
} * @param message the message
if (r == index && cancel != null) { * @param cancel the cancel option, or null
return null; * @param <U> the type of elements
} * @return the choice
return r; * @throws IOException if the manager was closed */
} public static <U> U promptChoice(final ConsoleOutput manager,
final ConsoleInput input,
/** @param manager the manager final List<String> keys,
* @param <U> The choices labels type final List<U> choices,
* @param <T> The real choices objects final String message,
* @param choicesMap the map of label to actual objects final String cancel) throws IOException {
* @param message the prompting message final Integer index = promptChoice(manager, input, keys, message,
* @param cancel the cancel option (or null) cancel);
* @return the chosen object if (index == null) {
* @throws IOException if the manager was closed */ return null;
public static <U, T> T promptChoice(ConsoleManager manager, }
Map<U, T> choicesMap, String message, return choices.get(index.intValue());
String cancel) throws IOException { }
return promptChoice(manager, new ArrayList<>(choicesMap.keySet()),
choicesMap, message, cancel); /** Prompt for a choice.
} *
* @param manager the manager
/** @param manager the manager * @param input the input
* @param message the prompt message * @param <U> The choices labels type
* @return the integer * @param <T> The real choices objects
* @throws IOException if the manager was closed */ * @param choices the list of labels (in order to be displayed)
public static int promptInteger(ConsoleManager manager, * @param choicesMap the map of label to actual objects
String message) throws IOException { * @param message the prompting message
boolean still = true; * @param cancel the cancel option if it exists (null otherwise)
int r = 0; * @return the chosen object
while (still) { * @throws IOException if the manager was closed */
final String result = manager.prompt(message); public static <U, T> T promptChoice(final ConsoleOutput manager,
try { final ConsoleInput input,
if (result.isEmpty()) { final List<U> choices,
still = true; final Map<U, T> choicesMap,
continue; final String message,
} final String cancel) throws IOException {
r = Integer.parseInt(result); final Integer res = promptChoice(manager, input, choices, message,
still = false; cancel);
} catch (final NumberFormatException e) { if (res == null) {
LOGGER.log(Level.INFO, return null;
"User input a non parsable integer: " + result, e); //$NON-NLS-1$ }
still = true; return choicesMap.get(choices.get(res.intValue()));
} }
}
return r; /** Prompt for a choice.
} *
* @param manager the manager
/** This methods prompt the user for a list of elements * @param input the input
* * @param <U> the type of choices
* @param manager the manager * @param choices the list of choices
* @param message the message * @param message the prompting message
* @return the list of user inputs * @param cancel the cancel option, or null
* @throws IOException if the manager was closed */ * @return the index of the choice
public static List<String> promptList(ConsoleManager manager, * @throws IOException if the manager was closed */
String message) throws IOException { public static <U> Integer promptChoice(final ConsoleOutput manager,
return promptList(manager, message, final ConsoleInput input,
CLIPrompterMessages.getString("promptlist.exit.defaultkey")); //$NON-NLS-1$ final List<U> choices,
} final String message,
final String cancel) throws IOException {
/** This methods prompt the user for a list of elements manager.println(message);
* final Integer index = listChoices(manager, choices, cancel);
* @param manager the manager String result;
* @param message the message int r = -1;
* @param ender the ending sequence for the list while (true) {
* @return the list of user inputs result = input.prompt(CLIPrompterMessages.getString(PROMPT));
* @throws IOException if the manager was closed */ try {
public static List<String> promptList(ConsoleManager manager, r = Integer.parseInt(result);
String message, if (r >= 0 && r <= index.intValue()) {
String ender) throws IOException { break;
final List<String> strings = new ArrayList<>(); }
manager.println( manager.println(CLIPrompterMessages
message + CLIPrompterMessages.getString(LIST_DISP_KEY, ender)); .getString(PROMPTCHOICE_OUTOFBOUNDS, ZERO, index));
String res = null; } catch (final NumberFormatException e) {
while (!ender.equals(res)) { LOGGER.log(Level.FINER,
res = manager.prompt(CLIPrompterMessages.getString(PROMPT)); "Unrecognized number. Prompting user again.", e); //$NON-NLS-1$
if (!res.equals(ender)) { manager.println(CLIPrompterMessages
strings.add(res); .getString(PROMPTCHOICE_FORMATERR, ZERO, index));
} }
} listChoices(manager, choices, cancel);
return strings; }
} if (r == index.intValue() && cancel != null) {
return null;
/** Prompt for a text with several lines. }
* return Integer.valueOf(r);
* @param manager the manager }
* @param message the prompting message
* @return the text /** Prompt for a choice.
* @throws IOException if the manager was closed */ *
public static String promptLongText(ConsoleManager manager, * @param manager the manager
String message) throws IOException { * @param input the input
return promptLongText(manager, message, CLIPrompterMessages * @param <U> The choices labels type
.getString("promptlongtext.exit.defaultkey")); //$NON-NLS-1$ * @param <T> The real choices objects
} * @param choicesMap the map of label to actual objects
* @param message the prompting message
/** Prompt for a text with several lines. * @param cancel the cancel option (or null)
* * @return the chosen object
* @param manager the manager * @throws IOException if the manager was closed */
* @param message the prompting message public static <U, T> T promptChoice(final ConsoleOutput manager,
* @param ender the ender character final ConsoleInput input,
* @return the text final Map<U, T> choicesMap,
* @throws IOException if the manager was closed */ final String message,
public static String promptLongText(ConsoleManager manager, String message, final String cancel) throws IOException {
String ender) throws IOException { return promptChoice(manager, input,
manager.println(message + CLIPrompterMessages new ArrayList<>(choicesMap.keySet()), choicesMap, message,
.getString("promptlongtext.exit.dispkey", ender)); //$NON-NLS-1$ cancel);
String res = manager.prompt(PROMPT); }
String line = res;
while (!line.equals(ender)) { /** Prompt for an integer.
line = manager.prompt(PROMPT); *
if (!line.equals(ender)) { * @param manager the manager
res += System.lineSeparator() + line; * @param message the prompt message
} * @return the integer
} * @throws IOException if the manager was closed */
return res.equals(ender) ? "" : res; //$NON-NLS-1$ public static int promptInteger(final ConsoleInput manager,
} final String message) throws IOException {
boolean still = true;
/** @param manager the manager int r = 0;
* @param keys the keys to be printed while (still) {
* @param choices the real choices final String result = manager.prompt(message);
* @param message the message try {
* @param <U> the type of elements if (result.isEmpty()) {
* @return the choice still = true;
* @throws IOException if the manager was closed */ continue;
public static <U> List<U> promptMultiChoice(ConsoleManager manager, }
List<String> keys, r = Integer.parseInt(result);
List<U> choices, still = false;
String message) throws IOException { } catch (final NumberFormatException e) {
final List<Integer> indices = promptMultiChoice(manager, keys, message); LOGGER.info("User input a non parsable integer: " + result); //$NON-NLS-1$
final List<U> userChoices = new ArrayList<>(); LOGGER.log(Level.FINEST, "Unrecognized integer", e); //$NON-NLS-1$
for (final Integer integer : indices) { still = true;
userChoices.add(choices.get(integer.intValue())); }
} }
return userChoices; return r;
} }
/** @param manager the manager /** This methods prompt the user for a list of elements.
* @param <U> The choices labels type *
* @param <T> The real choices objects * @param manager the manager
* @param choices the list of labels (in order to be displayed) * @param input the input
* @param choicesMap the map of label to actual objects * @param message the message
* @param message the prompting message * @return the list of user inputs
* @return the chosen objects (or an empty list) * @throws IOException if the manager was closed */
* @throws IOException if the manager was closed */ public static List<String> promptList(final ConsoleOutput manager,
public static <U, T> List<T> promptMultiChoice(ConsoleManager manager, final ConsoleInput input,
List<U> choices, final String message) throws IOException {
Map<U, T> choicesMap, return promptList(manager, input, message,
String message) throws IOException { CLIPrompterMessages.getString("promptlist.exit.defaultkey")); //$NON-NLS-1$
final List<Integer> chs = promptMultiChoice(manager, choices, message); }
final List<T> userChoices = new ArrayList<>();
for (final Integer integer : chs) { /** This methods prompt the user for a list of elements.
userChoices.add(choicesMap.get(integer)); *
} * @param manager the manager
return userChoices; * @param input the input
} * @param message the message
* @param ender the ending sequence for the list
/** @param manager the manager * @return the list of user inputs
* @param <U> the type of choices * @throws IOException if the manager was closed */
* @param choices the list of choices public static List<String> promptList(final ConsoleOutput manager,
* @param message the prompting message final ConsoleInput input,
* @return the indices of the choices final String message,
* @throws IOException if the manager was closed */ final String ender) throws IOException {
@SuppressWarnings("boxing") final List<String> strings = new ArrayList<>();
public static <U> List<Integer> promptMultiChoice(ConsoleManager manager, manager.println(
List<U> choices, message + CLIPrompterMessages.getString(LIST_DISP_KEY, ender));
String message) throws IOException { String res = null;
manager.println(message); while (!ender.equals(res)) {
final int index = listChoices(manager, choices, null); res = input.prompt(CLIPrompterMessages.getString(PROMPT));
String result = ""; //$NON-NLS-1$ if (!res.equals(ender)) {
boolean keepOn = true; strings.add(res);
final List<Integer> chs = new ArrayList<>(); }
while (keepOn) { }
keepOn = false; return strings;
result = manager.prompt(CLIPrompterMessages.getString(PROMPT)); }
final String[] vals = result
.split(CLIPrompterMessages.getString(LIST_CHOICE_SEP)); /** Prompt for a text with several lines.
for (final String val : vals) { *
boolean added; * @param manager the manager
try { * @param input the input
added = addUserChoice(val, chs, index); * @param message the prompting message
} catch (final NumberFormatException e) { * @return the text
keepOn = true; * @throws IOException if the manager was closed */
manager.println(CLIPrompterMessages public static String promptLongText(final ConsoleOutput manager,
.getString(PROMPTCHOICE_FORMATERR, 0, index)); final ConsoleInput input,
listChoices(manager, choices, null); final String message) throws IOException {
break; return promptLongText(manager, input, message, CLIPrompterMessages
} .getString("promptlongtext.exit.defaultkey")); //$NON-NLS-1$
if (!added) { }
manager.println(CLIPrompterMessages
.getString(PROMPTCHOICE_OUTOFBOUNDS, 0, index)); /** Prompt for a text with several lines.
listChoices(manager, choices, null); *
keepOn = true; * @param manager the manager
} * @param input the input
} * @param message the prompting message
} * @param ender the ender character
return chs; * @return the text
} * @throws IOException if the manager was closed */
public static String promptLongText(final ConsoleOutput manager,
/** @param val the string to parse final ConsoleInput input,
* @param chs the list of integers final String message,
* @param index the max index of choice final String ender) throws IOException {
* @return if the parsing was done correctly */ manager.println(message + CLIPrompterMessages
private static boolean addUserChoice(String val, List<Integer> chs, .getString("promptlongtext.exit.dispkey", ender)); //$NON-NLS-1$
int index) { final StringBuilder res = new StringBuilder();
if (val.isEmpty()) { String line;
return true; do {
} line = input.prompt(CLIPrompterMessages.getString(PROMPT));
final int r; if (!line.equals(ender)) {
r = Integer.parseInt(val); res.append(line);
if (r >= 0 && r < index) { res.append(System.lineSeparator());
chs.add(Integer.valueOf(r)); }
return true; } while (!line.equals(ender));
} return res.toString();
return false; }
}
/** Prompt the user to select zero or more elements from a list.
/** @param manager the manager *
* @param <U> The choices labels type * @param manager the manager
* @param <T> The real choices objects * @param input the input
* @param choicesMap the map of label to actual objects * @param keys the keys to be printed
* @param message the prompting message * @param choices the real choices
* @return the chosen objects * @param message the message
* @throws IOException if the manager was closed */ * @param <U> the type of elements
public static <U, T> List<T> promptMultiChoice(ConsoleManager manager, * @return the choice
Map<U, T> choicesMap, * @throws IOException if the manager was closed */
String message) throws IOException { public static <U> List<U> promptMultiChoice(final ConsoleOutput manager,
return promptMultiChoice(manager, new ArrayList<>(choicesMap.keySet()), final ConsoleInput input,
choicesMap, message); final List<String> keys,
} final List<U> choices,
final String message) throws IOException {
/** @param manager the manager final List<Integer> indices = promptMultiChoice(manager, input, keys,
* @param prompt the prompting message message);
* @param reprompt the prompting message after empty input final List<U> userChoices = new ArrayList<>();
* @return the non empty input for (final Integer integer : indices) {
* @throws IOException if the manager was closed */ userChoices.add(choices.get(integer.intValue()));
public static String promptNonEmpty(ConsoleManager manager, String prompt, }
String reprompt) throws IOException { return userChoices;
String res = manager.prompt(prompt); }
while (res.isEmpty()) {
res = manager.prompt(reprompt); /** Prompt the user to select zero or more elements from a list.
} *
return res; * @param manager the manager
} * @param input the input
* @param <U> The choices labels type
} * @param <T> The real choices objects
* @param choices the list of labels (in order to be displayed)
* @param choicesMap the map of label to actual objects
* @param message the prompting message
* @return the chosen objects (or an empty list)
* @throws IOException if the manager was closed */
public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input,
final List<U> choices,
final Map<U, T> choicesMap,
final String message) throws IOException {
final List<Integer> chs = promptMultiChoice(manager, input, choices,
message);
final List<T> userChoices = new ArrayList<>();
for (final Integer integer : chs) {
userChoices.add(choicesMap.get(choices.get(integer.intValue())));
}
return userChoices;
}
/** Prompt the user to select zero or more elements from a list.
*
* @param manager the manager
* @param input the input
* @param <U> the type of choices
* @param choices the list of choices
* @param message the prompting message
* @return the indices of the choices
* @throws IOException if the manager was closed */
public static <U> List<Integer> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input,
final List<U> choices,
final String message) throws IOException {
manager.println(message);
final Integer index = listChoices(manager, choices, null);
String result;
boolean keepOn = true;
final List<Integer> chs = new ArrayList<>();
while (keepOn) {
keepOn = false;
result = input.prompt(CLIPrompterMessages.getString(PROMPT));
final String[] vals = result
.split(CLIPrompterMessages.getString(LIST_CHOICE_SEP));
for (final String val : vals) {
boolean added;
try {
added = addUserChoice(val, chs, index.intValue());
} catch (final NumberFormatException e) {
LOGGER.log(Level.FINER,
"Unrecognized number. Prompting user again.", e); //$NON-NLS-1$
keepOn = true;
manager.println(CLIPrompterMessages
.getString(PROMPTCHOICE_FORMATERR, ZERO, index));
listChoices(manager, choices, null);
break;
}
if (!added) {
manager.println(CLIPrompterMessages
.getString(PROMPTCHOICE_OUTOFBOUNDS, ZERO, index));
listChoices(manager, choices, null);
keepOn = true;
}
}
}
return chs;
}
/** Prompt the user to select zero or more elements from a list.
*
* @param manager the manager
* @param input the input
* @param <U> The choices labels type
* @param <T> The real choices objects
* @param choicesMap the map of label to actual objects
* @param message the prompting message
* @return the chosen objects
* @throws IOException if the manager was closed */
public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input,
final Map<U, T> choicesMap,
final String message) throws IOException {
return promptMultiChoice(manager, input,
new ArrayList<>(choicesMap.keySet()), choicesMap, message);
}
/** Prompt the user for a non empty text.
*
* @param manager the manager
* @param prompt the prompting message
* @param reprompt the prompting message after empty input
* @return the non empty input
* @throws IOException if the manager was closed */
public static String promptNonEmpty(final ConsoleInput manager,
final String prompt,
final String reprompt) throws IOException {
String res = manager.prompt(prompt);
while (res.isEmpty()) {
res = manager.prompt(reprompt);
}
return res;
}
}

View File

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

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

View File

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

@@ -0,0 +1,194 @@
/*
* 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-test:fr.bigeon.gclc.test.TestConsoleManager.java
* Created on: Nov 18, 2016
*/
package fr.bigeon.gclc.utils;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 bigeon.fr
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.tools.StringProvider;
/** This console input allows to enter commands and retrieve the output as an
* input.
* <p>
* This console input is used to internally pilot an application. This can be
* used to test application behavior.
*
* @author Emmanuel Bigeon */
public final class PipedConsoleInput
implements ConsoleInput {
/** THe inner manager. */
private final StreamConsoleInput innerManager;
/** The stream to pipe commands into. */
private final PipedOutputStream commandInput;
/** The stream for the application to read commands from. */
private final PipedInputStream in;
/** The writing thread. */
private final WritingRunnable writing;
/** Create a manager that will write and read through piped stream.
*
* @param outPrint the stream to write the prompting messages to
* @throws IOException if the piping failed for streams */
public PipedConsoleInput(final PrintStream outPrint) throws IOException {
commandInput = new PipedOutputStream();
in = new PipedInputStream(commandInput);
innerManager = new StreamConsoleInput(outPrint, in,
StandardCharsets.UTF_8);
writing = new WritingRunnable(commandInput, StandardCharsets.UTF_8);
final Thread th = new Thread(writing,
"GCLC console piped input stream"); //$NON-NLS-1$
th.start();
}
@Override
public void close() throws IOException {
writing.setRunning(false);
in.close();
innerManager.close();
commandInput.close();
}
@Override
public StringProvider getPrompt() {
return innerManager.getPrompt();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
@Override
public void interruptPrompt() {
innerManager.interruptPrompt();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */
@Override
public boolean isClosed() {
return innerManager.isClosed();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override
public String prompt() throws IOException {
return innerManager
.prompt(innerManager.getPrompt() + System.lineSeparator());
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */
@Override
public String prompt(final long timeout) throws IOException {
return innerManager.prompt(timeout);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
@Override
public String prompt(final String message) throws IOException {
return innerManager.prompt(message + System.lineSeparator());
}
/* (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 {
return innerManager.prompt(message + System.lineSeparator(), timeout);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override
public void setPrompt(final String prompt) {
innerManager.setPrompt(prompt);
}
@Override
public void setPrompt(StringProvider string) {
innerManager.setPrompt(string);
}
/** 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

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

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

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

View File

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

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

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