Compare commits

...

95 Commits

Author SHA1 Message Date
89847738e5 [maven-release-plugin] prepare release gclc-socket-1.1.11 2018-10-15 09:35:58 -04:00
cd76d438c1 Update config
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:34:59 -04:00
fa46939c54 Added doc. Clean up code
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:34:51 -04:00
fe4851053a Update configurations
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:14:06 -04:00
6a7d0b11a0 Removed thread sleeping lock
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:10:31 -04:00
93589c750e Reformatting
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 23:07:41 -04:00
c23af20b17 Update version of configuration
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 19:05:49 -04:00
c7625c8006 Update dependencies, organize imports
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 18:58:17 -04:00
ad65165169 [maven-release-plugin] prepare for next development iteration 2018-10-14 18:28:48 -04:00
0814ab5740 [maven-release-plugin] prepare release gclc-2.0.9 2018-10-14 18:28:43 -04:00
ba26a70daa Minor javadoc
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 18:24:54 -04:00
4301f2a15e Fix test and wait
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 18:15:49 -04:00
2a05366e31 REmoved unnecessary boolean variable
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 11:04:13 -04:00
bd44b5bf85 Added empty else for readability
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 11:02:14 -04:00
4e804325e6 Removed initialisation to default
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 11:02:05 -04:00
ae5dc1aeba Move help command to package of defined commands
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 10:55:55 -04:00
d5a7d4a16f Avoid contains and get calls on same key in map
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 10:04:08 -04:00
de593c00a1 Update config, remove site descriptor, to use inherited one 2018-10-14 09:29:42 -04:00
50ac6eec06 Moved out increments
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 09:28:04 -04:00
74c66dcbdd Moved listeners from list to set 2018-10-14 09:26:55 -04:00
7c94dea7b5 Avoid multiple creation of empty array 2018-10-14 09:26:27 -04:00
a580133945 Removed method with constant return 2018-10-14 09:26:07 -04:00
38fe457f47 Formating in logs 2018-10-11 12:50:19 -04:00
159805701c Fixed run lockings
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-11 12:43:17 -04:00
f7876dc964 Remove unused final modifiers 2018-10-11 12:38:09 -04:00
c4db9f43fb Clean up and format 2018-10-11 12:29:49 -04:00
67abd91f72 Use concurrent hash map, where possible
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-11 12:13:21 -04:00
7934ab7435 Removed unnecessary exception 2018-10-11 12:09:42 -04:00
761d640f0b Synchronization organisation 2018-10-11 12:09:24 -04:00
98d22782c1 Collections initial size 2018-10-11 12:08:59 -04:00
f8da1c0119 Move from list to linked set for order conservation and use efficiency 2018-10-11 11:33:15 -04:00
438727e7b9 Fix stream for efficient garbage collection 2018-10-11 11:32:49 -04:00
a2a87eb0d7 Added site definition 2018-10-11 11:32:32 -04:00
7ba8b38624 Added synchronize block 2018-10-11 11:32:23 -04:00
6bcf2b0c91 [maven-release-plugin] prepare for next development iteration 2018-10-11 11:11:23 -04:00
3a568d3723 [maven-release-plugin] prepare release gclc-2.0.8 2018-10-11 11:10:37 -04:00
7e81105785 Remove unecessary imports and site resources, update configurations 2018-10-11 11:04:05 -04:00
bb7c01a7f2 [maven-release-plugin] prepare for next development iteration 2018-10-08 15:05:15 -04:00
d3064f18b6 [maven-release-plugin] prepare release process-0.0.3 2018-10-08 15:05:11 -04:00
7a7bf0b019 Update versions, configuration, license, refactor package
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 15:04:22 -04:00
a69c4a777f [maven-release-plugin] prepare for next development iteration 2018-10-08 15:03:52 -04:00
bf50a4eaa4 [maven-release-plugin] prepare release system-0.0.1 2018-10-08 15:03:46 -04:00
fda1bad1c7 License
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 14:59:04 -04:00
a585414982 Update configuration
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 14:58:26 -04:00
e8cf6eb68f Added license properties
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 14:57:36 -04:00
afb773636f [maven-release-plugin] prepare for next development iteration 2018-10-08 14:54:14 -04:00
a999d5f55b [maven-release-plugin] prepare release gclc-swt-1.1.5 2018-10-08 14:54:10 -04:00
c97c8735eb [maven-release-plugin] prepare for next development iteration 2018-10-08 14:52:36 -04:00
0ce31ff752 [maven-release-plugin] prepare release gclc-socket-1.1.10 2018-10-08 14:52:31 -04:00
c433175aa5 License and refactoring of packages
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 14:50:54 -04:00
a368e21668 Update configuration
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 14:49:40 -04:00
e6b4766d89 interrupt prompt by closing correctly
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 14:44:41 -04:00
dd3072615a Fix type in string
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 14:44:12 -04:00
d3c1a55a41 Update dependencies and configuration
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 14:14:53 -04:00
5d8d7b23ea Remove old license
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 14:11:48 -04:00
383ba0e702 Refactor packages. Update configuration
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 13:54:57 -04:00
0bb2103f85 [maven-release-plugin] prepare for next development iteration 2018-10-08 13:48:52 -04:00
3bed05c53f [maven-release-plugin] prepare release gclc-2.0.7 2018-10-08 13:48:47 -04:00
27bc7cc07b Configure site.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 13:46:19 -04:00
c83a598abb moved package
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 13:45:58 -04:00
829445bf74 [maven-release-plugin] prepare for next development iteration 2018-10-08 12:24:10 -04:00
02ea720bb9 [maven-release-plugin] prepare release gclc-2.0.6 2018-10-08 12:24:01 -04:00
41c9c9cd0d Licensing, upgrade configuration, use official license-plugin.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 12:21:43 -04:00
d99d97b9d5 Reorganize code to avoid cyclic dependencies.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 11:49:14 -04:00
c8745e00a9 [maven-release-plugin] prepare for next development iteration 2018-05-10 11:34:15 -04:00
8ca2905b2a [maven-release-plugin] prepare release process-0.0.2 2018-05-10 11:34:08 -04:00
37cbe2eb95 Skip release 0.0.1. Add scm
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-05-10 11:33:52 -04:00
9bc46c93a6 [maven-release-plugin] prepare release process-0.0.1 2018-05-10 11:32:07 -04:00
00c0e86d72 Fork process
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-05-10 11:29:38 -04:00
eae7e0d69f Fix prompting mechanics
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-05-10 11:29:11 -04:00
926a8d72fa Update dependency, parent pom and group id
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-05-10 11:28:45 -04:00
95ec674528 [maven-release-plugin] prepare for next development iteration 2018-05-10 11:20:32 -04:00
4d30402a42 [maven-release-plugin] prepare release gclc-2.0.5 2018-05-10 11:20:25 -04:00
cdcf9f0fae Update command parameterization mechanics 2018-05-10 11:18:10 -04:00
cce8a9504d [maven-release-plugin] prepare for next development iteration 2018-01-30 13:50:27 -05:00
119afe1660 [maven-release-plugin] prepare release gclc-2.0.4 2018-01-30 13:50:17 -05:00
7517251d1c Update prompt for dynamic value
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-01-30 12:54:40 -05:00
f8a37e7eee [maven-release-plugin] prepare for next development iteration 2017-11-25 10:50:57 -05:00
3598bb359e [maven-release-plugin] prepare release gclc-2.0.3 2017-11-25 10:50:44 -05:00
e9fa6e209f Update help of sub command in case the command is unknown 2017-11-25 10:46:28 -05:00
d4b695f60b [maven-release-plugin] prepare for next development iteration 2017-11-19 07:57:03 -05:00
8a8d298485 [maven-release-plugin] prepare release gclc-2.0.2 2017-11-19 07:56:45 -05:00
50887f44bb Fixed close closing non possessed resource
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-19 07:49:30 -05:00
3a5250d987 [maven-release-plugin] prepare for next development iteration 2017-11-18 18:31:56 -05:00
ddc60652f1 [maven-release-plugin] prepare release gclc-swt-1.1.4 2017-11-18 18:31:37 -05:00
206df88506 Update to gclc-2.0.1
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-18 18:29:24 -05:00
d2cd059c01 [maven-release-plugin] prepare for next development iteration 2017-11-18 16:38:21 -05:00
90dab5a809 [maven-release-plugin] prepare release gclc-socket-1.1.9 2017-11-18 16:37:59 -05:00
d5f2d39808 Update gclc-socket.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-18 16:37:06 -05:00
36f39df87e [maven-release-plugin] prepare for next development iteration 2017-11-18 08:54:25 -05:00
82e8d1e1b7 [maven-release-plugin] prepare release gclc-2.0.1 2017-11-18 08:54:00 -05:00
0ebcd7b210 Update thread namings.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-18 08:51:54 -05:00
d32ea6b4b0 Fixed tests
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-18 08:13:51 -05:00
e5d5edcf63 Update gclc version in secondary pakages
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2017-11-17 17:46:22 -05:00
b80a3fc5b8 [maven-release-plugin] prepare for next development iteration 2017-11-13 22:40:53 -05:00
151 changed files with 21466 additions and 13971 deletions

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

View File

@@ -1,148 +0,0 @@
/*
* 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.
*/
/**
* gclc-process:fr.bigeon.gclc.process.CommandFork.java
* Created on: Nov 13, 2017
*/
package fr.bigeon.gclc.process;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import fr.bigeon.gclc.command.CommandParameters;
import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.command.ICommandProvider;
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 forled command will actually print again all
* the command history to the output console.
* </ul>
*
* @author Emmanuel Bigeon */
public class CommandFork extends ParametrizedCommand {
private final TaskPool pool = new TaskPool();
private ICommandProvider provider;
/** Add the fork command.
*
* @param name the command name */
public CommandFork(final String name) {
super(name);
addParameters();
}
/**
*
*/
private void addParameters() {
try {
addStringParameter("join", false);
addBooleanParameter("list");
} 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 {
if (parameters.getBool("list")) {
for (final String id : pool.getPIDs()) {
try {
out.println(id + "\t" + pool.get(id).getName());
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"Failed to write to console", e, this);
}
}
}
final String string = parameters.get("join");
if (string != null) {
// Join the command.
final ForkTask cmd = (ForkTask) pool.get(string);
if (cmd == null) {
throw new CommandRunException("No such fork process", this);
}
cmd.join(out, in);
return;
}
final List<String> strings = parameters.getAdditionals();
final ICommand cmd = provider.get(strings.get(0));
final String[] args = Arrays.copyOfRange(strings.toArray(new String[0]),
1, strings.size());
final ForkTask task = new ForkTask(cmd, args);
final Thread th = new Thread(task);
pool.add(task);
th.start();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
// TODO Auto-generated method stub
// return null;
throw new RuntimeException("Not implemented yet");
}
/* (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");
}
}

View File

@@ -1,127 +0,0 @@
/*
* 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.
*/
/**
* gclc-process:fr.bigeon.gclc.process.ForkTask.java
* Created on: Nov 13, 2017
*/
package fr.bigeon.gclc.process;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon
*
*/
public class ForkTask implements Task {
private final ICommand command;
private final String[] args;
private final Set<InterruptionListener> listeners = new HashSet<>();
private boolean running = false;
/** @param cmd the command
* @param args the arguements */
public ForkTask(final ICommand cmd, final String[] args) {
command = cmd;
this.args = Arrays.copyOf(args, args.length);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#addInterruptionListener(fr.bigeon.gclc.
* process.InterruptionListener) */
@Override
public void addInterruptionListener(final InterruptionListener listener) {
listeners.add(listener);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#getName() */
@Override
public String getName() {
return command.getCommandName();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#isRunning() */
@Override
public boolean isRunning() {
return running;
}
/** @param out the console output
* @param in the console input */
public void join(final ConsoleOutput out, final ConsoleInput in) {
// TODO Auto-generated method stub
//
throw new RuntimeException("Not implemented yet");
}
/* (non-Javadoc)
* @see
* fr.bigeon.gclc.process.Task#rmInterruptionListener(fr.bigeon.gclc.process
* .InterruptionListener) */
@Override
public void rmInterruptionListener(final InterruptionListener listener) {
listeners.remove(listener);
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
running = true;
try {
// TODO Auto-generated method stub
//
throw new RuntimeException("Not implemented yet");
} finally {
running = false;
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#setRunning(boolean) */
@Override
public void setRunning(final boolean running) {
this.running = running;
}
}

View File

@@ -1,115 +0,0 @@
/*
* 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.
*/
/**
* 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();
/** Default constructor. */
public TaskPool() {
//
}
/** 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 = getPID();
synchronized (lock) {
running.put(pid, cmd);
}
cmd.addInterruptionListener(new InterruptionListener() {
@SuppressWarnings("synthetic-access")
@Override
public void interrupted() {
synchronized (lock) {
running.remove(pid);
count = Math.min(count, Integer.parseInt(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());
}
}

View File

@@ -1,76 +0,0 @@
/*
* 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.
*/
/**
* 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;
/** 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;
/** @param name the command name
* @param pool the pool */
public TaskSpawner(final String name, final TaskPool pool) {
super(name);
this.pool = pool;
}
/** @param in the input
* @param out the output
* @param args the arguments
* @return the process to start and add to the pool */
protected abstract Task createTask(ConsoleOutput out, ConsoleInput in,
String... args);
/* (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 Task task = createTask(out, in, args);
final Thread th = new Thread(task);
pool.add(task);
th.start();
}
}

View File

@@ -0,0 +1,172 @@
/*
* 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:net.bigeon.gclc.process.CommandFork.java
* Created on: Nov 13, 2017
*/
package net.bigeon.gclc.process;
/*-
* #%L
* process
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.util.List;
import net.bigeon.gclc.command.CommandParameters;
import net.bigeon.gclc.command.ParametrizedCommand;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.exception.InvalidParameterException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.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");
}
// Join the command.
final Task cmd = pool.get(string);
if (!(cmd instanceof ForkTask)) {
throw new CommandRunException("No such forked process");
}
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");
}
((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,152 @@
/*
* 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:net.bigeon.gclc.process.CommandFork.java
* Created on: Nov 13, 2017
*/
package net.bigeon.gclc.process;
/*-
* #%L
* process
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.util.Arrays;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.command.ICommandProvider;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.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");
}
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,103 @@
/*
* 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 net.bigeon.gclc.process;
/*-
* #%L
* process
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.util.Arrays;
import net.bigeon.gclc.command.ICommand;
import net.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 net.bigeon.gclc.process.ForkTask#doRun() */
@Override
protected void doRun() throws CommandRunException {
command.execute(out, in, args);
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.Task#getName() */
@Override
public String getName() {
return command.getCommandName();
}
}

View File

@@ -0,0 +1,188 @@
/*
* 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:net.bigeon.gclc.process.ForkTask.java
* Created on: Nov 13, 2017
*/
package net.bigeon.gclc.process;
/*-
* #%L
* process
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.util.HashSet;
import java.util.Set;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.process.io.ConnectingConsoleInput;
import net.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 net.bigeon.gclc.process.Task#addInterruptionListener(fr.bigeon.gclc.
* process.InterruptionListener) */
@Override
public final void addInterruptionListener(final InterruptionListener listener) {
listeners.add(listener);
}
/** 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;
}
protected final Object getRunningLock() {
return runLock;
}
/* (non-Javadoc)
* @see net.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
* net.bigeon.gclc.process.Task#rmInterruptionListener(net.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();
}
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.Task#setRunning(boolean) */
@Override
public final void setRunning(final boolean running) {
synchronized (runLock) {
this.running = running;
runLock.notifyAll();
}
}
}

View File

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

View File

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

@@ -1,82 +1,114 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.proc.ProcessList.java * gclc:fr.bigeon.gclc.proc.ProcessList.java
* Created on: May 10, 2017 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import fr.bigeon.gclc.command.Command; /*-
import fr.bigeon.gclc.exception.CommandRunException; * #%L
import fr.bigeon.gclc.manager.ConsoleInput; * process
import fr.bigeon.gclc.manager.ConsoleOutput; * %%
* Copyright (C) 2014 - 2018 Bigeon
/** A command that will flag a task to stop * %%
* * This software is governed by the CeCILL license under French law and
* @author Emmanuel Bigeon */ * abiding by the rules of distribution of free software. You can use,
public final class ProcessKill extends Command { * modify and/ or redistribute the software under the terms of the CeCILL
/** The taskpool */ * license as circulated by CEA, CNRS and INRIA at the following URL
private final TaskPool pool; * "http://www.cecill.info".
*
/** @param name the command name * As a counterpart to the access to the source code and rights to copy,
* @param pool the pool */ * modify and redistribute granted by the license, users are provided only
public ProcessKill(final String name, final TaskPool pool) { * with a limited warranty and the software's author, the holder of the
super(name); * economic rights, and the successive licensors have only limited
this.pool = pool; * liability.
} *
* In this respect, the user's attention is drawn to the risks associated
/* (non-Javadoc) * with loading, using, modifying and/or developing or reproducing the
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager. * software by the user in light of its specific status of free software,
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * that may mean that it is complicated to manipulate, and that also
* java.lang.String[]) */ * therefore means that it is reserved for developers and experienced
@Override * professionals having in-depth computer knowledge. Users are therefore
public void execute(final ConsoleOutput out, final ConsoleInput in, * encouraged to load and test the software's suitability as regards their
final String... args) throws CommandRunException { * requirements in conditions enabling the security of their systems and/or
pool.get(args[0]).setRunning(false); * data to be ensured and, more generally, to use and operate it in the
} * same conditions as regards security.
*
/* (non-Javadoc) * The fact that you are presently reading this means that you have had
* @see fr.bigeon.gclc.command.ICommand#tip() */ * knowledge of the CeCILL license and that you accept its terms.
@SuppressWarnings("nls") * #L%
@Override */
public String tip() { import net.bigeon.gclc.command.Command;
return "Request a process to stop (softly)"; import net.bigeon.gclc.exception.CommandRunException;
} import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */ /** A command that will flag a task to stop
@Override *
protected String usageDetail() { * @author Emmanuel Bigeon */
return null; 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

@@ -1,100 +1,131 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.proc.ProcessList.java * gclc:fr.bigeon.gclc.proc.ProcessList.java
* Created on: May 10, 2017 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.io.IOException; /*-
import java.text.MessageFormat; * #%L
import java.util.ArrayList; * process
import java.util.Collections; * %%
* Copyright (C) 2014 - 2018 Bigeon
import fr.bigeon.gclc.command.Command; * %%
import fr.bigeon.gclc.exception.CommandRunException; * This software is governed by the CeCILL license under French law and
import fr.bigeon.gclc.exception.CommandRunExceptionType; * abiding by the rules of distribution of free software. You can use,
import fr.bigeon.gclc.manager.ConsoleInput; * modify and/ or redistribute the software under the terms of the CeCILL
import fr.bigeon.gclc.manager.ConsoleOutput; * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
/** A command to list current processes *
* * As a counterpart to the access to the source code and rights to copy,
* @author Emmanuel Bigeon */ * modify and redistribute granted by the license, users are provided only
public final class ProcessList extends Command { * with a limited warranty and the software's author, the holder of the
/** The process pool */ * economic rights, and the successive licensors have only limited
private final TaskPool pool; * liability.
*
/** @param name the command name * In this respect, the user's attention is drawn to the risks associated
* @param pool the pool */ * with loading, using, modifying and/or developing or reproducing the
public ProcessList(final String name, final TaskPool pool) { * software by the user in light of its specific status of free software,
super(name); * that may mean that it is complicated to manipulate, and that also
this.pool = pool; * therefore means that it is reserved for developers and experienced
} * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
/* (non-Javadoc) * requirements in conditions enabling the security of their systems and/or
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager. * data to be ensured and, more generally, to use and operate it in the
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * same conditions as regards security.
* java.lang.String[]) */ *
@Override * The fact that you are presently reading this means that you have had
public void execute(final ConsoleOutput out, final ConsoleInput in, * knowledge of the CeCILL license and that you accept its terms.
final String... args) throws CommandRunException { * #L%
final ArrayList<String> pids = new ArrayList<>(pool.getPIDs()); */
Collections.sort(pids); import java.io.IOException;
for (final String string : pids) { import java.text.MessageFormat;
try { import java.util.ArrayList;
out.println(MessageFormat.format("{0}\t{1}", string, //$NON-NLS-1$ import java.util.Collections;
pool.get(string).getName()));
} catch (final IOException e) { import net.bigeon.gclc.command.Command;
throw new CommandRunException( import net.bigeon.gclc.exception.CommandRunException;
CommandRunExceptionType.INTERACTION, import net.bigeon.gclc.exception.CommandRunExceptionType;
"Unable to communicate with user", e, this); //$NON-NLS-1$ import net.bigeon.gclc.manager.ConsoleInput;
} import net.bigeon.gclc.manager.ConsoleOutput;
}
/** A command to list current processes
} *
* @author Emmanuel Bigeon */
/* (non-Javadoc) public final class ProcessList extends Command {
* @see fr.bigeon.gclc.command.ICommand#tip() */ /** The process pool */
@SuppressWarnings("nls") private final TaskPool pool;
@Override
public String tip() { /** @param name the command name
return "List all processes"; * @param pool the pool */
} public ProcessList(final String name, final TaskPool pool) {
super(name);
/* (non-Javadoc) this.pool = pool;
* @see fr.bigeon.gclc.command.Command#usageDetail() */ }
@Override
protected String usageDetail() { /* (non-Javadoc)
return null; * @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); //$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,98 @@
/*
* 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 net.bigeon.gclc.process;
/*-
* #%L
* process
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import net.bigeon.gclc.ApplicationAttachement;
import net.bigeon.gclc.command.ICommandProvider;
import net.bigeon.gclc.exception.InvalidCommandName;
/** @author Emmanuel Bigeon */
public class ScreenAttachement implements ApplicationAttachement {
private final TaskPool pool;
private final int lines;
/** @param pool the task pool to manage */
public ScreenAttachement(TaskPool pool, int lines) {
super();
this.pool = pool;
this.lines = lines;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc.
* ConsoleApplication) */
@Override
public void attach(ICommandProvider application) throws InvalidCommandName {
application.add(new ProcessKill("terminate", pool));
application.add(new ProcessList("list", pool));
application.add(new ProcessClear("clear", pool));
application.add(new CommandForeground("fg", pool));
application.add(new CommandFork("fork", application, pool, lines));
}
}

View File

@@ -1,78 +1,111 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.proc.ThreadCommand.java * gclc:fr.bigeon.gclc.proc.ThreadCommand.java
* Created on: May 10, 2017 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
/** Tasks are named runnable that can be interrupted. /*-
* <p> * #%L
* Good practice for those objects include an absence of interaction with the * process
* user (otherwise the user may not know from which running command comes * %%
* information and requests) and unicity of the object to have a coherent * Copyright (C) 2014 - 2018 Bigeon
* control through the {@link #setRunning(boolean)} method. * %%
* <p> * This software is governed by the CeCILL license under French law and
* Typical cases where such command can be useful is for an application that * abiding by the rules of distribution of free software. You can use,
* does long computations. * modify and/ or redistribute the software under the terms of the CeCILL
* * license as circulated by CEA, CNRS and INRIA at the following URL
* @author Emmanuel Bigeon */ * "http://www.cecill.info".
public interface Task extends Runnable { *
/** Add a listener for this command end of execution * 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 listener the listener */ * with a limited warranty and the software's author, the holder of the
void addInterruptionListener(InterruptionListener listener); * economic rights, and the successive licensors have only limited
* liability.
/** Get the task name. *
* * In this respect, the user's attention is drawn to the risks associated
* @return the task name */ * with loading, using, modifying and/or developing or reproducing the
String 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
/** Test the running status of the task. * therefore means that it is reserved for developers and experienced
* * professionals having in-depth computer knowledge. Users are therefore
* @return if the command is supposed to be running */ * encouraged to load and test the software's suitability as regards their
boolean isRunning(); * 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
/** Remove a listener of this command end of execution * same conditions as regards security.
* *
* @param listener the listener */ * The fact that you are presently reading this means that you have had
void rmInterruptionListener(InterruptionListener listener); * knowledge of the CeCILL license and that you accept its terms.
* #L%
/** Set the running state. */
* <p> /** Tasks are named runnable that can be interrupted.
* This method should be only called by external objects with the false * <p>
* argument. Calling this method with true has unspecified behavior and * Good practice for those objects include an absence of interaction with the
* could do nothing as well as restart the command for example. * user (otherwise the user may not know from which running command comes
* * information and requests) and unicity of the object to have a coherent
* @param running the running state */ * control through the {@link #setRunning(boolean)} method.
void setRunning(boolean running); * <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,182 @@
/*
* 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 net.bigeon.gclc.process;
/*-
* #%L
* process
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import 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;
}
/** 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;
}
/** 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));
}
}
/** 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,114 @@
/*
* 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 net.bigeon.gclc.process;
/*-
* #%L
* process
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.util.concurrent.ExecutorService;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.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,244 @@
/*
* 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 net.bigeon.gclc.process.io;
/*-
* #%L
* process
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import net.bigeon.gclc.manager.ConsoleInput;
import net.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;
}
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;
}
}
}
/* (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#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;
}
};
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools.
* StringProvider) */
@Override
public void setPrompt(StringProvider string) {
prompt = string;
}
}

View File

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

View File

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

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

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

View File

@@ -1,103 +1,96 @@
<!-- 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. --> <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>
<!-- Copyright E. Bigeon (2014) --> <version>1.1.11</version>
<!-- --> <packaging>jar</packaging>
<!-- emmanuel@bigeon.fr --> <url>http://www.bigeon.net</url>
<!-- --> <properties>
<!-- This software is a computer program whose purpose is to --> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- Defines the distribution repositories and basic setup for projects <project.scm.id>git.code.bigeon.net</project.scm.id>
of Emmanuel Bigeon. --> <license.licenseName>cecill_2.1</license.licenseName>
<!-- --> <copyright.email>emmanuel@bigeon.fr</copyright.email>
<!-- This software is governed by the CeCILL license under French law and --> </properties>
<!-- abiding by the rules of distribution of free software. You can use, --> <dependencies>
<!-- modify and/or redistribute the software under the terms of the CeCILL --> <dependency>
<!-- license as circulated by CEA, CNRS and INRIA at the following URL --> <groupId>net.bigeon</groupId>
<!-- "http://www.cecill.info". --> <artifactId>gclc</artifactId>
<!-- --> <version>2.0.9</version>
<!-- 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>net.bigeon</groupId>
<!-- economic rights, and the successive licensors have only limited --> <artifactId>smu</artifactId>
<!-- liability. --> <version>1.0.5</version>
<!-- --> </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.12</version>
<!-- professionals having in-depth computer knowledge. Users are therefore --> </parent>
<!-- encouraged to load and test the software's suitability as regards their --> <licenses>
<!-- requirements in conditions enabling the security of their systems and/or --> <license>
<!-- data to be ensured and, more generally, to use and operate it in the --> <distribution>manual</distribution>
<!-- same conditions as regards security. --> <name>CeCILL 2.1</name>
<!-- --> <url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
<!-- The fact that you are presently reading this means that you have had --> </license>
<!-- knowledge of the CeCILL license and that you accept its terms. --> </licenses>
<reporting>
<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"> <plugins>
<modelVersion>4.0.0</modelVersion> <plugin>
<artifactId>gclc-socket</artifactId> <groupId>com.github.sevntu-checkstyle</groupId>
<version>1.1.9-SNAPSHOT</version> <artifactId>dsm-maven-plugin</artifactId>
<packaging>jar</packaging> <version>2.2.0</version>
<url>http://www.bigeon.fr/emmanuel</url> </plugin>
<properties> </plugins>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </reporting>
<project.scm.id>git.bigeon.net</project.scm.id> <developers>
</properties> <developer>
<dependencies> <email>emmanuel@bigeon.fr</email>
<dependency> <name>Emmanuel Bigeon</name>
<groupId>fr.bigeon</groupId> <url>bigeon.net</url>
<artifactId>gclc</artifactId> <roles>
<version>1.5.0</version> <role>PM</role>
</dependency> </roles>
<dependency> </developer>
<groupId>fr.bigeon</groupId> </developers>
<artifactId>smu</artifactId> <name>GCLC Socket</name>
<version>0.0.5</version> <description>Socket implementation of GCLC</description>
</dependency> <scm>
</dependencies> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<parent> <tag>gclc-socket-1.1.11</tag>
<groupId>fr.bigeon</groupId> </scm>
<artifactId>ebigeon-config</artifactId> <groupId>net.bigeon.gclc</groupId>
<version>1.7.1</version> <inceptionYear>2016</inceptionYear>
</parent> </project>
<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>
</project>

View File

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

View File

@@ -1,403 +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.
*/
package fr.bigeon.gclc.socket;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.SocketException;
import java.nio.charset.Charset;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.manager.ConsoleManager;
import fr.bigeon.gclc.manager.PipedConsoleManager;
import fr.bigeon.gclc.manager.ReadingRunnable;
/** This is a socket communicating console consoleManager
* <p>
* To use this application, the following flow should be used:
*
* <pre>
* SocketConsoleApplicationShell shell = new SocketConsoleApplicationShell();
* ConsoleApplication myApplication = new MyConsoleApplication(shell.getConsoleManager(), ...);
* shell.setApplication(myApplication);
* Thread th = new Thread(shell);
* th.start();
* </pre>
* <p>
* 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
* application, you should then {@link Thread#join()} the thread to wait for the
* end of the execution.
*
* @author Emmanuel Bigeon */
public class SocketConsoleApplicationShell implements Runnable, AutoCloseable {
/** The runnable to forward output of application to socket.
*
* @author Emmanuel Bigeon */
private final class OutputForwardRunnable implements Runnable {
/**
*
*/
private final PrintWriter writer;
/**
*
*/
private final Socket socket;
/** @param writer the writer
* @param socket the socket */
protected OutputForwardRunnable(PrintWriter writer, Socket socket) {
this.writer = writer;
this.socket = socket;
}
@SuppressWarnings("synthetic-access")
@Override
public void run() {
try {
while (!socket.isClosed()) {
while (!socket.isClosed() && !consoleManager.available()) {
waitASec();
}
if (socket.isClosed()) {
return;
}
String m = consoleManager.readNextLine();
writer.println(m);
}
} catch (IOException e) {
LOGGER.log(Level.SEVERE, "Unexpected problem in manager", //$NON-NLS-1$
e);
}
}
}
/** The end of line character */
protected static final String EOL = "\n"; //$NON-NLS-1$
/** The class logger */
private static final Logger LOGGER = Logger
.getLogger(SocketConsoleApplicationShell.class.getName());
/** Time of wait */
protected static final long ONE_TENTH_OF_SECOND = 100;
/** The listening port */
private final int port;
/** The application */
private ConsoleApplication app;
/** The session closing command */
private final String close;
/** The running status */
private boolean running;
/** The console manager implementation */
private final PipedConsoleManager consoleManager;
/** The auto close flag. if this is true, every request closes the session
* after its call */
private final boolean autoClose;
/** The server socket */
private ServerSocket serverSocket;
/** The application shutdown string */
private final String applicationShutdown;
/** The charset for the communication. */
private final Charset charset;
/** Create a socket application shell which will listen on the given port
* and close session upon the provided string reception by client
*
* @param port the port to listen to
* @param close the session closing command
* @param applicationShutdown the appication shut down command
* @param charset the charset for communication
* @throws IOException if the manager could not be created */
public SocketConsoleApplicationShell(int port, String close,
String applicationShutdown, Charset charset) throws IOException {
this.port = port;
this.close = close;
this.applicationShutdown = applicationShutdown;
this.autoClose = false;
this.charset = charset;
//
consoleManager = new PipedConsoleManager();
}
/** Create a socket application shell which will listen on the given port
* and auto close session after one instruction
*
* @param port the port to listen to
* @param autoClose if the session must be closed once the request has been
* sent
* @param applicationShutdown the appication shut down command
* @param charset the charset for communication
* @throws IOException if the manager could not be created */
public SocketConsoleApplicationShell(int port, boolean autoClose,
String applicationShutdown, Charset charset) throws IOException {
this.port = port;
this.autoClose = autoClose;
this.applicationShutdown = applicationShutdown;
this.close = autoClose ? null : "close"; //$NON-NLS-1$
this.charset = charset;
//
consoleManager = new PipedConsoleManager();
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
// Create the server
try (ServerSocket actualServerSocket = new ServerSocket(port)) {
this.serverSocket = actualServerSocket;
running = true;
// Create the streams
runSokectServer();
} catch (final IOException e) {
LOGGER.severe("Communication error between client and server"); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"Communication error between client and server", e); //$NON-NLS-1$
}
}
/** @throws IOException if the communication with the client failed */
private void runSokectServer() throws IOException {
final ConsoleRunnable runnable = new ConsoleRunnable(app);
Thread appThNext = new Thread(runnable, "gclc-ctrl"); //$NON-NLS-1$
appThNext.start();
while (running) {
LOGGER.info("Waiting client"); //$NON-NLS-1$
try (Socket clientSocket = serverSocket.accept();
PrintWriter out = new PrintWriter(new OutputStreamWriter(
clientSocket.getOutputStream(), charset), true);
InputStreamReader isr = new InputStreamReader(
clientSocket.getInputStream(), charset);
BufferedReader in = new BufferedReader(isr);) {
// this is not threaded to avoid several clients at the same
// time
LOGGER.info("Opening client"); //$NON-NLS-1$
// Initiate application
if (!runnable.isApplicationRunning()) {
LOGGER.info("Start application"); //$NON-NLS-1$
startApplication(runnable);
} else {
LOGGER.info("Reconnect to application"); //$NON-NLS-1$
out.println("Reconnected"); //$NON-NLS-1$
out.println(consoleManager.getPrompt());
}
communicate(clientSocket, out, in);
} catch (SocketException e) {
LOGGER.log(Level.INFO, "Socket closed"); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"Socket closed with exception (probably due to server interruption)", //$NON-NLS-1$
e);
} catch (IOException e) {
throw e;
}
LOGGER.info("Closing client"); //$NON-NLS-1$
}
runnable.setRunning(false);
try {
closeManager(appThNext);
} catch (IOException e) {
LOGGER.warning("Unable to close application correctly"); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Application closing caused an exception", //$NON-NLS-1$
e);
}
LOGGER.info("Closing Server"); //$NON-NLS-1$
}
/** Close the console manager after writing the application shutdown
* command.
*
* @param appThNext the thread containing the application
* @throws IOException if the typyng or closing failed */
private void closeManager(Thread appThNext) throws IOException {
consoleManager.type(applicationShutdown);
try {
appThNext.join(ONE_TENTH_OF_SECOND);
} catch (InterruptedException e) {
LOGGER.warning("Application thread was interrupted!"); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"Application thread was interrupted while closing", //$NON-NLS-1$
e);
}
consoleManager.close();
}
/** @param runnable the runnable */
private void startApplication(ConsoleRunnable runnable) {
runnable.restart();
synchronized (this) {
try {
wait(ONE_TENTH_OF_SECOND);
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interruption in application start", //$NON-NLS-1$
e);
}
}
}
/** active communication between server and client
*
* @param socket the socket
* @param writer the writer to the application
* @param in the input from the client
* @throws IOException if the communication failed */
private void communicate(final Socket socket, final PrintWriter writer,
BufferedReader in) throws IOException {
OutputForwardRunnable cc = new OutputForwardRunnable(writer, socket);
Thread th = new Thread(cc, "ClientComm"); //$NON-NLS-1$
th.start();
if (autoClose) {
communicateOnce(in);
} else {
communicateLoop(in);
}
}
/** @param in the input from the client
* @throws IOException if the communication failed */
private void communicateOnce(BufferedReader in) throws IOException {
ReadingRunnable reading = new ReadingRunnable(in);
Thread th = new Thread(reading, "gclcToApp"); //$NON-NLS-1$
th.start();
communicationContent(reading);
doEndCommunication(reading);
}
/** @param reading the reading runnable
* @throws IOException if the end of communication failed */
private void doEndCommunication(ReadingRunnable reading) throws IOException {
reading.setRunning(false);
Thread wait = consoleManager.getWaitForDelivery("Bye."); //$NON-NLS-1$
consoleManager.println("Bye."); //$NON-NLS-1$
try {
wait.join();
} catch (InterruptedException e) {
LOGGER.warning("The Bye wait was interrupted."); //$NON-NLS-1$
LOGGER.log(Level.FINE, "An interruption occured", e); //$NON-NLS-1$
}
}
/** @param in the input from the client
* @throws IOException if the communication failed */
private void communicateLoop(BufferedReader in) throws IOException {
ReadingRunnable reading = new ReadingRunnable(in);
Thread th = new Thread(reading, "gclcToApp"); //$NON-NLS-1$
th.start();
while (app.isRunning() && communicationContent(reading)) {
// keep on going
}
doEndCommunication(reading);
}
/** @param reading the reading
* @return if the communication should be stopped.
* @throws IOException if the reading failed */
private boolean communicationContent(ReadingRunnable reading) throws IOException {
try {
while (app.isRunning() && !reading.hasMessage()) {
synchronized (this) {
waitASec();
}
}
} catch (IOException e) {
LOGGER.warning("Client seems dead. Closing communication"); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Wait on message from client failed", e); //$NON-NLS-1$
return false;
}
if (!app.isRunning()) {
return false;
}
String ln = reading.getMessage();
if (ln.equals(close)) {
return false;
}
// Pass command to application
consoleManager.type(ln);
return true;
}
/** @return the consoleManager */
public synchronized ConsoleManager getConsoleManager() {
return consoleManager;
}
/** @param app the application to set */
public synchronized void setApplication(ConsoleApplication app) {
this.app = app;
}
/** This method will request the server to stop.
* <p>
* In most cases, this will terminate communication on every client. On some
* cases, the */
public void stop() {
running = false;
try {
serverSocket.close();
} catch (IOException e) {
LOGGER.log(Level.SEVERE, "Exception in closing socket server", e); //$NON-NLS-1$
}
app.exit();
}
/** a method to wait some time */
protected void waitASec() {
try {
synchronized (this) {
wait(ONE_TENTH_OF_SECOND);
}
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interrupted wait", //$NON-NLS-1$
e);
return;
}
}
/* (non-Javadoc)
* @see java.lang.AutoCloseable#close() */
@Override
public void close() throws IOException {
consoleManager.close();
}
}

View File

@@ -0,0 +1,100 @@
/**
* gclc-socket:net.bigeon.gclc.socket.ConnexionManager.java
* Created on: Nov 18, 2017
*/
package net.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,174 @@
/**
* gclc-socket:net.bigeon.gclc.socket.DConnexionManager.java
* Created on: Nov 18, 2017
*/
package net.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;
/** Default.constructor. */
public DConnexionManager() {
//
}
/* (non-Javadoc)
* @see
* net.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 net.bigeon.gclc.socket.ConnexionManager#disconnect(java.lang.String) */
@Override
public T disconnect(final String id) {
if (!connecteds.containsKey(id)) {
return null;
}
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;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.socket.ConnexionManager#get(java.lang.String) */
@Override
public T get(final String id) {
return connecteds.get(id);
}
/* (non-Javadoc)
* @see net.bigeon.gclc.socket.ConnexionManager#getConnected() */
@Override
public Collection<String> getConnected() {
return connecteds.keySet();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.socket.ConnexionManager#isConnected(java.lang.String) */
@Override
public boolean isConnected(final String id) {
return connecteds.containsKey(id);
}
/* (non-Javadoc)
* @see
* net.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
* net.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
* net.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,280 @@
/**
* gclc-socket:net.bigeon.gclc.socket.PlugableConsoleInput.java
* Created on: Nov 18, 2017
*/
package net.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 net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.tools.StringProvider;
import net.bigeon.gclc.utils.ReadingRunnable;
/** 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(String prompt) {
setPrompt(new ConstantString(prompt));
}
@Override
public void setPrompt(final StringProvider prompt) {
this.prompt = prompt;
}
/** Wait for a hint or connection.
*
* @param messageTimeout the timeout on the current connection hint waiting
* @param connexionTimeout the timeout on the new connection 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,129 @@
/**
* gclc-socket:net.bigeon.gclc.socket.PluggableConsoleOutput.java
* Created on: Nov 18, 2017
*/
package net.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 net.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,130 @@
/**
* gclc-socket:net.bigeon.gclc.socket.RemoteDisconnectCommand.java
* Created on: Nov 18, 2017
*/
package net.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 net.bigeon.gclc.command.Command;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.manager.ConsoleInput;
import net.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 static 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); //$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() */
@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

@@ -0,0 +1,197 @@
package net.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.net.InetAddress;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.SocketException;
import java.util.logging.Level;
import java.util.logging.Logger;
import net.bigeon.gclc.ConsoleApplication;
/** This is a socket communicating console consoleManager.
* <p>
* To use this application, the following flow should be used:
*
* <pre>
* SocketConsoleApplicationShell shell = new SocketConsoleApplicationShell();
* ConsoleApplication myApplication = new MyConsoleApplication(shell.getConsoleManager(), ...);
* shell.setApplication(myApplication);
* Thread th = new Thread(shell);
* th.start();
* </pre>
* <p>
* 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
* application, you should then {@link Thread#join()} the thread to wait for the
* end of the execution.
*
* @author Emmanuel Bigeon */
public final class SocketConsoleApplicationShell implements Runnable {
/** The class logger. */
private static final Logger LOGGER = Logger
.getLogger(SocketConsoleApplicationShell.class.getName());
/** The listening port. */
private final int port;
/** The running status. */
private boolean running;
/** The socket console interface. */
private SocketConsoleInterface sci;
/** The remote disconnection command. */
private ConnexionManager<Socket> rdc;
/** The application. */
private ConsoleApplication app;
/** The server socket. */
private ServerSocket serverSocket;
/** THe server address. */
private final InetAddress addr;
/** Create a socket application shell which will listen on the given port and
* network interface.
*
* @param port the part
* @param addr the inet address */
public SocketConsoleApplicationShell(final int port, final InetAddress addr) {
super();
this.port = port;
this.addr = addr;
}
/** Wait for the identified connection to disconnect.
*
* @param id the connexion id. */
private void awaitDisconnexion(final String id) {
while (rdc.isConnected(id)) {
try {
rdc.waitDisconnexion(id);
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, "Unexpected interruption", e); //$NON-NLS-1$
Thread.currentThread().interrupt();
}
}
sci.disconnect();
}
/** If the port provided was 0, this allows to get the actual port.
*
* @return the local port
* @see java.net.ServerSocket#getLocalPort() */
public int getLocalPort() {
return serverSocket.getLocalPort();
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
// Create the server
try (ServerSocket actualServerSocket = new ServerSocket(port, 1, addr)) {
serverSocket = actualServerSocket;
running = true;
// Create the streams
runSokectServer();
} catch (final IOException e) {
LOGGER.severe("Communication error between client and server"); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Communication error between client and server", e); //$NON-NLS-1$
}
}
/** Acctually run the server loop on connexion.
*
* @throws IOException if the communication with the client failed */
private void runSokectServer() throws IOException {
while (running && app.isRunning()) {
LOGGER.info("Waiting client"); //$NON-NLS-1$
try (Socket clientSocket = serverSocket.accept()) {
sci.connect(clientSocket);
final String id = rdc.addConnexion(clientSocket);
rdc.lockDisconnexion(id);
awaitDisconnexion(id);
rdc.releaseDisconnexionLock(id);
} catch (final SocketException e) {
LOGGER.log(Level.INFO, "Socket closed"); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"Socket closed with exception (probably due to server interruption)", //$NON-NLS-1$
e);
} catch (final IOException e) {
throw e;
}
LOGGER.info("Closing client"); //$NON-NLS-1$
}
LOGGER.info("Closing Server"); //$NON-NLS-1$
}
/** Set the application.
* <p>
* If the application is closed, the server will also close.
*
* @param app the app to set */
public void setApplication(final ConsoleApplication app) {
this.app = app;
}
/** Set the connexion manager.
*
* @param rdc the rdc to set */
public void setConnexionManager(final ConnexionManager<Socket> rdc) {
this.rdc = rdc;
}
/** Set the socket console interface.
*
* @param sci the console interface to set */
public void setInterface(final SocketConsoleInterface sci) {
this.sci = sci;
}
/** This method will request the server to stop.
* <p>
* In most cases, this will terminate communication on every client. On some
* cases, the */
public void stop() {
running = false;
try {
serverSocket.close();
} catch (final IOException e) {
LOGGER.log(Level.SEVERE, "Exception in closing socket server", e); //$NON-NLS-1$
}
}
}

View File

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

View File

@@ -0,0 +1,39 @@
/** This package define a framework to access
* {@link net.bigeon.gclc.ConsoleApplication} through a socket.
*
* @author Emmanuel Bigeon */
package net.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

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

View File

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

View File

@@ -1,107 +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.
*/
package fr.bigeon.gclc.socket;
import java.io.IOException;
import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.command.ExitCommand;
import fr.bigeon.gclc.command.HelpExecutor;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.manager.ConsoleManager;
/** A test-purpose application
*
* @author Emmanuel Bigeon */
public class ConsoleTestApplication {
/** Exit command */
public static final String EXIT = "exit"; //$NON-NLS-1$
/** @param manager the manager
* @return create the application */
@SuppressWarnings("nls")
public static ConsoleApplication create(final ConsoleManager manager) {
try {
ConsoleApplication application = new ConsoleApplication(manager,
"Welcome to the test application. Type help or test.",
"See you");
application.add(new ExitCommand(EXIT, application));
application.add(
new HelpExecutor("help", manager, application.root));
application.add(new Command("test") {
@Override
public String tip() {
return "A test command";
}
@Override
public void execute(String... args) throws CommandRunException {
try {
manager.println("Test command ran fine");
} catch (IOException e) {
throw new CommandRunException("manager closed", e,
this);
}
}
});
application.add(new Command("long") {
@Override
public String tip() {
return "A long run test command";
}
@Override
public void execute(String... args) throws CommandRunException {
try {
Thread.sleep(2000);
manager.println("Test command ran fine");
} catch (IOException | InterruptedException e) {
throw new CommandRunException("manager closed", e,
this);
}
}
});
return application;
} catch (final InvalidCommandName e) {
e.printStackTrace();
}
return null;
}
}

View File

@@ -1,241 +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.SocketConsoleApplicationTest.java
* Created on: Jun 1, 2016
*/
package fr.bigeon.gclc.socket;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.logging.Logger;
import org.junit.Test;
/** Test class for {@link SocketConsoleApplicationShell}
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"static-method", "unused", "javadoc", "nls"})
public class SocketConsoleApplicationTest {
private static final Logger LOGGER = Logger
.getLogger(SocketConsoleApplicationTest.class.getName());
@Test
public void integrationTest() {
Thread server;
try {
server = TestServer.startServer("bye");
} catch (IOException e3) {
assertNull(e3);
fail("unable to start server");
}
try {
Thread.sleep(1000);
} catch (InterruptedException e1) {
e1.printStackTrace();
}
final String hostName = "127.0.0.1";
final int portNumber = 3300;
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 = -1;
String[] cmds = {"help", "toto", "test", "bye"};
while ((fromServer = in.readLine()) != null) {
i++;
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);
}
}
assertEquals(4, i);
} catch (final IOException e) {
e.printStackTrace();
}
try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer;
int i = 0;
String[] cmds = {"help", "toto", "test",
ConsoleTestApplication.EXIT};
while ((fromServer = in.readLine()) != null) {
fromServer = consumeToPrompt(fromServer, in);
if (fromServer == null || fromServer.equals("Bye.")) {
break;
}
LOGGER.info("Server: \n" + fromServer);
final String fromUser = cmds[i];
if (fromUser != null) {
LOGGER.info("Client: " + fromUser);
out.println(fromUser);
}
i++;
}
assertEquals(4, i);
} catch (final IOException e) {
e.printStackTrace();
}
try {
Thread.sleep(100);
} catch (InterruptedException e1) {
e1.printStackTrace();
}
try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer;
int i = 0;
String[] cmds = {"help", "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(4, i);
} catch (final IOException e) {
e.printStackTrace();
}
TestServer.closeServer();
try {
Thread.sleep(100);
} catch (InterruptedException e2) {
e2.printStackTrace();
}
try {
server = TestServer.startServer(true);
} catch (IOException e2) {
assertNull(e2);
}
try {
Thread.sleep(100);
} catch (InterruptedException e1) {
e1.printStackTrace();
}
try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer;
int i = 0;
String[] cmds = {"help", "test", "close"};
while ((fromServer = in.readLine()) != null) {
fromServer = consumeToPrompt(fromServer, in);
if (fromServer == null || fromServer.equals("Bye.")) {
break;
}
assertTrue(i < 1);
final String fromUser = cmds[i];
if (fromUser != null) {
LOGGER.fine("Client: " + fromUser);
out.println(fromUser);
}
i++;
}
assertEquals(1, i);
} catch (final IOException e) {
e.printStackTrace();
}
Thread srv = null;
try {
srv = TestServer.getServer();
} catch (IOException e1) {
assertNull(e1);
}
TestServer.closeServer();
try {
srv.join();
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/** @param in the input
* @return the string
* @throws IOException if the input reading failed */
private String consumeToPrompt(String server,
BufferedReader in) throws IOException {
String fromServer = server;
LOGGER.fine("Server: \n" + fromServer);
while (fromServer != null && !fromServer.equals("Bye.") &&
!fromServer.equals("> ")) {
fromServer = in.readLine();
LOGGER.fine("Server: \n" + fromServer);
}
return fromServer;
}
}

View File

@@ -0,0 +1,152 @@
package net.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.net.Socket;
import java.util.Collection;
import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.base.ExitCommand;
import net.bigeon.gclc.command.base.HelpExecutor;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/** A test-purpose application
*
* @author Emmanuel Bigeon */
public class ConsoleTestApplication {
/** Exit command */
public static final String EXIT = "exit"; //$NON-NLS-1$
/** Create the test application.
*
* @param output the output
* @param input the input
* @param manager the manager
* @return create the application */
@SuppressWarnings("nls")
public static ConsoleApplication create(final ConsoleOutput output,
final ConsoleInput input, final ConnexionManager<Socket> manager) {
try {
final ConsoleApplication application = new ConsoleApplication(output, input,
"Welcome to the test application. Type help or test.", "See you");
application.add(new ExitCommand(EXIT, application) {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ExitCommand#beforeExit() */
@Override
protected void beforeExit() {
final Collection<String> coll = manager.getConnected();
for (final String string : coll) {
manager.disconnect(string);
}
}
});
application.add(new HelpExecutor("help", application.root));
application.add(new Command("test") {
/* (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);
}
}
@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 {
Object obj = new Object();
synchronized (obj) {
obj.wait(2000);
}
output.println("Test command ran fine");
} catch (IOException | InterruptedException e) {
throw new CommandRunException("manager closed", e);
}
}
@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,218 @@
/**
* gclc-socket:net.bigeon.gclc.socket.PluggableConsoleInputTest.java
* Created on: Nov 18, 2017
*/
package net.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.assertNotNull;
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 java.util.concurrent.atomic.AtomicReference;
import org.junit.Test;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
public class PluggableConsoleInputTest {
/** Test method for
* {@link net.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 {
Object obj = new Object();
synchronized (obj) {
obj.wait(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 {
Object obj = new Object();
synchronized (obj) {
obj.wait(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();
Object obj = new Object();
synchronized (obj) {
while (!input.isPrompting()) {
obj.wait(10);
}
}
input.connect(pis, out);
testIn.println("tac");
final AtomicReference<IOException> ref = new AtomicReference<>();
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
ref.set(e);
}
}
});
th2.start();
synchronized (obj) {
while (!input.isPrompting()) {
obj.wait(10);
}
}
input.close();
th2.join();
assertNotNull("Prompt should io", ref.get());
}
}
/** Test method for
* {@link net.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:net.bigeon.gclc.socket.RemoteDisconnectCommandTest.java
* Created on: Nov 18, 2017
*/
package net.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 net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.utils.PipedConsoleOutput;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
public class RemoteDisconnectCommandTest {
/** Test method for
* {@link net.bigeon.gclc.socket.RemoteDisconnectCommand#execute(net.bigeon.gclc.manager.ConsoleOutput, net.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

@@ -0,0 +1,160 @@
/**
* gclc-socket:net.bigeon.gclc.socket.SocketConsoleApplicationTest.java
* Created on: Jun 1, 2016
*/
package net.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 java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.logging.Logger;
import org.junit.Test;
/** Test class for {@link SocketConsoleApplicationShell}
*
* @author Emmanuel Bigeon */
@SuppressWarnings({ "static-method", "javadoc", "nls" })
public class SocketConsoleApplicationTest {
private static final Logger LOGGER = Logger
.getLogger(SocketConsoleApplicationTest.class.getName());
/** @param in the input
* @return the string
* @throws IOException if the input reading failed */
private String consumeToPrompt(final String server, final BufferedReader in)
throws IOException {
String fromServer = server;
LOGGER.fine("Server: \n" + fromServer);
while (fromServer != null && !fromServer.equals("Bye.")
&& !fromServer.equals("> ")) {
fromServer = in.readLine();
LOGGER.fine("Server: \n" + fromServer);
}
return fromServer;
}
@Test
public void testIntegration() throws IOException, InterruptedException {
Thread server;
server = TestServer.getServer();
final String hostName = "127.0.0.1";
final int portNumber = 3300;
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 = -1;
final String[] cmds = { "help", "toto", "test", "out" };
while ((fromServer = in.readLine()) != null) {
i++;
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);
}
}
assertEquals("Disconnection command should close connection", 3, i);
}
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;
}
LOGGER.info("Server: \n" + fromServer);
final String fromUser = cmds[i];
if (fromUser != null) {
LOGGER.info("Client: " + fromUser);
out.println(fromUser);
}
i++;
}
assertEquals("Application exit command should close connection", 4, i);
}
TestServer.closeServer();
server.join();
server = TestServer.getServer();
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,91 @@
/* package net.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 net.bigeon.smu.StringEncoder;
import fr.bigeon.smu.StringEncoder;
/** TODO Describe TestConsoleClient.java
/** TODO Describe TestConsoleClient.java *
* @author Emmanuel Bigeon * @author Emmanuel Bigeon */
* @SuppressWarnings("nls")
*/ public class TestConsoleClient {
@SuppressWarnings("nls") @SuppressWarnings("javadoc")
public class TestConsoleClient { private static final Collection<String> TO_ENCODE = new ArrayList<>();
@SuppressWarnings("javadoc") static {
private static final Collection<String> TO_ENCODE = new ArrayList<>(); TO_ENCODE.add("\n");
static { }
TO_ENCODE.add("\n");
} @SuppressWarnings("javadoc")
private static final StringEncoder ENCODER = new StringEncoder("%", TO_ENCODE);
@SuppressWarnings("javadoc")
private static final StringEncoder ENCODER = new StringEncoder("%", @SuppressWarnings("javadoc")
TO_ENCODE); public static void main(String[] args) {
final String hostName = "127.0.0.1";
@SuppressWarnings("javadoc") final int portNumber = 3300;
public static void main(String[] args) {
final String hostName = "127.0.0.1"; try (Socket kkSocket = new Socket(hostName, portNumber);
final int portNumber = 3300; PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
BufferedReader in = new BufferedReader(
try (Socket kkSocket = new Socket(hostName, portNumber); new InputStreamReader(kkSocket.getInputStream()));) {
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true); String fromServer;
BufferedReader in = new BufferedReader(new InputStreamReader( while ((fromServer = in.readLine()) != null) {
kkSocket.getInputStream()));) { System.out.println("Server: \n" + ENCODER.decode(fromServer));
if (fromServer.equals("Bye.")) {
String fromServer; break;
while ((fromServer = in.readLine()) != null) { }
System.out.println("Server: \n" + ENCODER.decode(fromServer));
if (fromServer.equals("Bye.")) { final BufferedReader stdIn = new BufferedReader(
break; new InputStreamReader(System.in));
} final String fromUser = stdIn.readLine();
if (fromUser != null) {
final BufferedReader stdIn = new BufferedReader( System.out.println("Client: " + fromUser);
new InputStreamReader(System.in)); out.println(fromUser);
final String fromUser = stdIn.readLine(); }
if (fromUser != null) { }
System.out.println("Client: " + fromUser); } catch (final IOException e) {
out.println(fromUser); // TODO Auto-generated catch block
} e.printStackTrace();
} }
} catch (final IOException e) {
// TODO Auto-generated catch block }
e.printStackTrace(); }
}
}
}

View File

@@ -1,108 +1,117 @@
/* package net.bigeon.gclc.socket;
* Copyright E. Bigeon (2014)
* /*-
* emmanuel@bigeon.fr * #%L
* * GCLC Socket
* This software is a computer program whose purpose is to * %%
* Socket implementation of GCLC. * Copyright (C) 2016 - 2018 Bigeon
* * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ * #L%
package fr.bigeon.gclc.socket; */
import java.io.IOException;
import java.io.IOException; import java.net.InetAddress;
import java.nio.charset.Charset; import java.net.Socket;
import java.net.UnknownHostException;
import fr.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.ConsoleApplication;
/** A test server
* /** A test server
* @author Emmanuel Bigeon */ *
@SuppressWarnings({"javadoc", "nls"}) * @author Emmanuel Bigeon */
public class TestServer { @SuppressWarnings({ "javadoc", "nls" })
public class TestServer {
private static SocketConsoleApplicationShell SHELL;
private static Thread server; private static SocketConsoleApplicationShell SHELL;
private static ConnexionManager<Socket> manager;
/** @param args no argument
* @throws IOException if the server starting failed */ private static Thread server;
public static void main(String... args) throws IOException { private static PluggableConsoleInput input;
try { private static PluggableConsoleOutput output;
startServer(false).join();
} catch (final InterruptedException e) { public static synchronized void closeServer() {
e.printStackTrace(); SHELL.stop();
} input.close();
} output.close();
SHELL = null;
public static Thread getServer() throws IOException { server = null;
if (server == null) { }
server = new Thread(getShell(), "gclcServer");
server.start(); public static synchronized Thread getServer() throws IOException {
} if (server == null) {
return server; server = new Thread(getShell(), "gclcServer");
} server.start();
}
private static SocketConsoleApplicationShell getShell() throws IOException { return server;
if (SHELL == null) { }
SHELL = new SocketConsoleApplicationShell(3300, "close",
ConsoleTestApplication.EXIT, Charset.forName("UTF-8")); private static SocketConsoleApplicationShell getShell() throws UnknownHostException {
final ConsoleApplication app = ConsoleTestApplication if (SHELL == null) {
.create(SHELL.getConsoleManager()); input = new PluggableConsoleInput();
SHELL.setApplication(app); input.setPrompt("> \n");
} output = new PluggableConsoleOutput();
return SHELL; manager = new DConnexionManager<>();
} SHELL = new SocketConsoleApplicationShell(3300,
InetAddress.getByName("127.0.0.1"));
public static Thread startServer(boolean autoClose) throws IOException { final ConsoleApplication app = ConsoleTestApplication.create(output, input,
if (SHELL == null) { manager);
SHELL = new SocketConsoleApplicationShell(3300, autoClose, SHELL.setInterface(new SocketConsoleInterface(input, output));
ConsoleTestApplication.EXIT, Charset.forName("UTF-8")); SHELL.setConnexionManager(manager);
final ConsoleApplication app = ConsoleTestApplication SHELL.setApplication(app);
.create(SHELL.getConsoleManager()); final Thread th = new Thread(new Runnable() {
SHELL.setApplication(app);
server = null; @Override
} public void run() {
return getServer(); app.start();
} }
});
public static Thread startServer(String closeConnection) throws IOException { th.start();
if (SHELL == null) { try {
SHELL = new SocketConsoleApplicationShell(3300, closeConnection, Object waiting = new Object();
ConsoleTestApplication.EXIT, Charset.forName("UTF-8")); synchronized (waiting) {
final ConsoleApplication app = ConsoleTestApplication while (!input.isPrompting()) {
.create(SHELL.getConsoleManager()); waiting.wait(50);
SHELL.setApplication(app); }
server = null; }
} } catch (InterruptedException e) {
return getServer(); Thread.currentThread().interrupt();
} }
}
public static void closeServer() { return SHELL;
SHELL.stop(); }
SHELL = null;
} /** @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();
}
}
}

517
gclc-swt/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,101 +1,98 @@
<!-- 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 --> <!-- This software is governed by the CeCILL license under French law and -->
<!-- provide a swt window for console applications. --> <!-- 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 --> <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">
<!-- knowledge of the CeCILL license and that you accept its terms. --> <modelVersion>4.0.0</modelVersion>
<groupId>net.bigeon.gclc</groupId>
<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"> <artifactId>gclc-swt</artifactId>
<modelVersion>4.0.0</modelVersion> <version>1.1.6-SNAPSHOT</version>
<artifactId>gclc-swt</artifactId> <packaging>jar</packaging>
<version>1.1.4-SNAPSHOT</version> <inceptionYear>2015</inceptionYear>
<packaging>jar</packaging> <name>GCLC swt</name>
<url>http://www.bigeon.fr/emmanuel</url> <description>A swt window for console applications</description>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <parent>
<project.scm.id>git.bigeon.net</project.scm.id> <groupId>net.bigeon.config</groupId>
</properties> <artifactId>swt-config</artifactId>
<parent> <version>1.8.9</version>
<groupId>fr.bigeon</groupId> </parent>
<artifactId>ebigeon-config</artifactId>
<version>1.7.1</version> <properties>
</parent> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<dependencies> <copyright.email>emmanuel@bigeon.fr</copyright.email>
<dependency> <license.licenseName>cecill_2.1</license.licenseName>
<groupId>fr.bigeon</groupId> </properties>
<artifactId>gclc</artifactId>
<version>1.3.6</version> <dependencies>
</dependency> <dependency>
<dependency> <groupId>net.bigeon</groupId>
<groupId>fr.bigeon</groupId> <artifactId>gclc</artifactId>
<artifactId>collections</artifactId> <version>2.0.9</version>
<version>1.0.1</version> </dependency>
</dependency> <dependency>
</dependencies> <groupId>net.bigeon</groupId>
<inceptionYear>2015</inceptionYear> <artifactId>collections</artifactId>
<name>GCLC swt</name> <version>1.1.1</version>
<description>provide a swt window for console applications</description> </dependency>
<scm> </dependencies>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag> <licenses>
</scm> <license>
<profiles> <distribution>manual</distribution>
<profile> <name>CeCILL 2.1</name>
<id>linux-deps</id> <url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
<activation> </license>
<os> </licenses>
<family>Linux</family> <reporting>
</os> <plugins>
</activation> <plugin>
<dependencies> <groupId>com.github.sevntu-checkstyle</groupId>
<dependency> <artifactId>dsm-maven-plugin</artifactId>
<groupId>org.eclipse.swt</groupId> <version>2.2.0</version>
<artifactId>org.eclipse.swt.gtk.linux.x86_64</artifactId> </plugin>
<version>4.3</version> </plugins>
</dependency> </reporting>
</dependencies> <developers>
</profile> <developer>
<profile> <email>emmanuel@bigeon.fr</email>
<id>windows-deps</id> <name>Emmanuel Bigeon</name>
<activation> <url>bigeon.net</url>
<os> <roles>
<family>Windows</family> <role>PM</role>
</os> </roles>
</activation> </developer>
<dependencies> </developers>
<dependency>
<groupId>org.eclipse.swt</groupId> <scm>
<artifactId>org.eclipse.swt.win32.win32.x86_64</artifactId> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<version>4.3</version> <tag>HEAD</tag>
</dependency> </scm>
</dependencies> </project>
</profile>
</profiles>
</project>

View File

@@ -1,57 +0,0 @@
/*
* Copyright E. Bigeon (2015)
*
* 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
* 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 {
/** Actually send the input as the prompt next input. */
void validateInput();
/** @param input the input to set */
void setInput(String input);
/** @return the non validated input */
String getInput();
}

View File

@@ -1,109 +0,0 @@
/*
* Copyright E. Bigeon (2015)
*
* 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
* 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;
/** @param console the console delayed */
public HistoryTextKeyListener(ConsoleDelayIO console) {
super();
this.console = console;
this.commands = new ArrayRibbon<>(DEFAULT_HISTORY_SIZE);
}
@Override
public void keyPressed(KeyEvent e) {
pressedKeyCode(e.keyCode);
}
/** @param keyCode the pressed key code */
public void pressedKeyCode(int keyCode) {
// Enter validates the command if prompting
if (keyCode == '\r') {
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++;
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) {
String cmd = commands
.get(commands.size() - (--currentIndex) - 1);
console.setInput(cmd);
}
}
}
}

View File

@@ -0,0 +1,91 @@
/*
* 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:net.bigeon.gclc.swt.ConsoleDelayIO.java
* Created on: Nov 19, 2016
*/
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 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%
*/
/** 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,143 @@
/*
* 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:net.bigeon.gclc.swt.HistoryTextKeyListener.java
* Created on: Jun 9, 2016
*/
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 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 org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyAdapter;
import org.eclipse.swt.events.KeyEvent;
import net.bigeon.collections.ArrayRibbon;
import net.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,371 +1,469 @@
/* /*
* 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 * This software is governed by the CeCILL license under French law and
* provide a swt window for console applications. * 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. * gclc-swt:net.bigeon.gclc.swt.SWTConsole.java
*/ * Created on: Apr 18, 2015
/** */
* gclc-swt:fr.bigeon.gclc.swt.SWTConsole.java package net.bigeon.gclc.swt;
* Created on: Apr 18, 2015
*/ /*-
package fr.bigeon.gclc.swt; * #%L
* GCLC swt
import java.io.IOException; * %%
import java.util.logging.Level; * Copyright (C) 2015 - 2018 Bigeon
import java.util.logging.Logger; * %%
* This software is governed by the CeCILL license under French law and
import org.eclipse.swt.SWT; * abiding by the rules of distribution of free software. You can use,
import org.eclipse.swt.layout.GridData; * modify and/ or redistribute the software under the terms of the CeCILL
import org.eclipse.swt.layout.GridLayout; * license as circulated by CEA, CNRS and INRIA at the following URL
import org.eclipse.swt.widgets.Composite; * "http://www.cecill.info".
import org.eclipse.swt.widgets.Display; *
import org.eclipse.swt.widgets.Label; * As a counterpart to the access to the source code and rights to copy,
import org.eclipse.swt.widgets.Text; * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
import fr.bigeon.gclc.ConsoleApplication; * economic rights, and the successive licensors have only limited
import fr.bigeon.gclc.manager.ConsoleManager; * liability.
*
/** A SWT component to connect to gclc {@link ConsoleApplication} * In this respect, the user's attention is drawn to the risks associated
* <p> * with loading, using, modifying and/or developing or reproducing the
* * software by the user in light of its specific status of free software,
* @author Emmanuel Bigeon */ * that may mean that it is complicated to manipulate, and that also
public class SWTConsole extends Composite * therefore means that it is reserved for developers and experienced
implements ConsoleDelayIO, ConsoleManager { * 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
private static final int LAYOUT_NB_COLUMNS = 2; * same conditions as regards security.
/** The cmd prefix in the output console */ *
private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$ * The fact that you are presently reading this means that you have had
/** The class logger */ * knowledge of the CeCILL license and that you accept its terms.
private static final Logger LOGGER = Logger * #L%
.getLogger(SWTConsole.class.getName()); */
/** The empty string constant */ import java.io.IOException;
private static final String EMPTY = ""; //$NON-NLS-1$ import java.util.logging.Level;
/** The console output text field */ import java.util.logging.Logger;
private final Text consoleOutput;
/** The console input text field */ import org.eclipse.swt.SWT;
private final Text consoleInput; import org.eclipse.swt.layout.GridData;
/** The prompt label */ import org.eclipse.swt.layout.GridLayout;
private final Label lblPromptlabel; import org.eclipse.swt.widgets.Composite;
/** The prompt text */ import org.eclipse.swt.widgets.Display;
private String prompt = ">"; //$NON-NLS-1$ import org.eclipse.swt.widgets.Label;
/** The command entered by the user */ import org.eclipse.swt.widgets.Text;
private String command = null;
/** If the prompt should be active */ import net.bigeon.gclc.ConsoleApplication;
private boolean prompting = false; import net.bigeon.gclc.manager.ConsoleInput;
/** The object for thread synchronization with the prompt */ import net.bigeon.gclc.manager.ConsoleOutput;
private final Object promptLock = new Object(); import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.tools.StringProvider;
/** Create the composite.
* /** A SWT component to connect to gclc {@link ConsoleApplication}.
* @param parent the prent composite * <p>
* @param style the composite style */ *
public SWTConsole(Composite parent, int style) { * @author Emmanuel Bigeon */
super(parent, style); public final class SWTConsole extends Composite
implements ConsoleDelayIO, ConsoleInput, ConsoleOutput {
setLayout(new GridLayout(LAYOUT_NB_COLUMNS, false)); /** The number of columns of the layout. */
private static final int LAYOUT_NB_COLUMNS = 2;
consoleOutput = new Text(this, SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | /** The cmd prefix in the output console. */
SWT.V_SCROLL | SWT.MULTI); private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, /** The class logger. */
LAYOUT_NB_COLUMNS, 1)); private static final Logger LOGGER = Logger
consoleOutput.setRedraw(true); .getLogger(SWTConsole.class.getName());
/** The empty string constant. */
lblPromptlabel = new Label(this, SWT.NONE); private static final String EMPTY = ""; //$NON-NLS-1$
lblPromptlabel.setText(prompt); /** The console output text field. */
private final Text consoleOutput;
consoleInput = new Text(this, SWT.BORDER); /** The console input text field. */
consoleInput.setLayoutData( private final Text consoleInput;
new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1)); /** The prompt label. */
consoleInput.addKeyListener(new HistoryTextKeyListener(this)); private final Label lblPromptlabel;
/** The prompt text. */
} private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
/** The command entered by the user. */
/** private String command = null;
* /** If the prompt should be active. */
*/ private boolean prompting = false;
@Override /** The object for thread synchronization with the prompt. */
public void validateInput() { private final Object promptLock = new Object();
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access") /** Create the composite.
@Override *
public void run() { * @param parent the prent composite
consoleInput.setEnabled(false); * @param style the composite style */
} public SWTConsole(final Composite parent, final int style) {
}); super(parent, style);
synchronized (promptLock) {
while (!prompting) { setLayout(new GridLayout(LAYOUT_NB_COLUMNS, false));
try {
promptLock.wait(); consoleOutput = new Text(this,
} catch (InterruptedException e) { SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | SWT.V_SCROLL | SWT.MULTI);
LOGGER.log(Level.SEVERE, consoleOutput.setLayoutData(
"Interruption while waiting prompt", e); //$NON-NLS-1$ new GridData(SWT.FILL, SWT.FILL, true, true, LAYOUT_NB_COLUMNS, 1));
} consoleOutput.setRedraw(true);
}
Display.getDefault().syncExec(new Runnable() { lblPromptlabel = new Label(this, SWT.NONE);
@SuppressWarnings("synthetic-access") lblPromptlabel.setText(prompt.apply());
@Override
public void run() { consoleInput = new Text(this, SWT.BORDER);
command = consoleInput.getText(); consoleInput.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
prompting = false; consoleInput.addKeyListener(new HistoryTextKeyListener(this));
consoleInput.setText(EMPTY);
consoleOutput.append( }
CMD_PREFIX + command + System.lineSeparator());
} @Override
}); protected void checkSubclass() {
promptLock.notifyAll(); // Disable the check that prevents subclassing of SWT components
} }
}
/* (non-Javadoc)
@Override * @see fr.bigeon.gclc.manager.ConsoleManager#close() */
protected void checkSubclass() { @Override
// Disable the check that prevents subclassing of SWT components public void close() {
} synchronized (promptLock) {
prompting = false;
/* (non-Javadoc) promptLock.notifyAll();
* @see fr.bigeon.gclc.ConsoleManager#getPrompt() */ }
@Override if (consoleInput.isDisposed()) {
public String getPrompt() { return;
return prompt; }
} consoleInput.setEnabled(false);
consoleOutput.setEnabled(false);
/* (non-Javadoc) }
* @see fr.bigeon.gclc.ConsoleManager#print(java.lang.String) */
@Override /* (non-Javadoc)
public void print(final String text) { * @see net.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
Display.getDefault().syncExec(new Runnable() { @Override
@SuppressWarnings("synthetic-access") public String getInput() {
@Override return consoleInput.getText();
public void run() { }
if (!consoleOutput.isDisposed()) {
consoleOutput.append(text); /* (non-Javadoc)
} * @see fr.bigeon.gclc.ConsoleManager#getPrompt() */
} @Override
}); public StringProvider getPrompt() {
} return prompt;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#println() */ /* (non-Javadoc)
@Override * @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
public void println() { @Override
Display.getDefault().syncExec(new Runnable() { public void interruptPrompt() {
@SuppressWarnings("synthetic-access") synchronized (promptLock) {
@Override promptLock.notifyAll();
public void run() { }
if (!consoleOutput.isDisposed()) { }
consoleOutput.append(System.lineSeparator());
} /* (non-Javadoc)
} * @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
}); @Override
} public boolean isClosed() {
return isDisposed();
/* (non-Javadoc) }
* @see fr.bigeon.gclc.ConsoleManager#println(java.lang.String) */
@Override /* (non-Javadoc)
public void println(final String message) { * @see fr.bigeon.gclc.ConsoleManager#print(java.lang.String) */
Display.getDefault().syncExec(new Runnable() { @Override
@SuppressWarnings("synthetic-access") public void print(final String text) throws IOException {
@Override if (isDisposed()) {
public void run() { throw new IOException();
if (!consoleOutput.isDisposed()) { }
consoleOutput.append(message + System.lineSeparator()); Display.getDefault().syncExec(new Runnable() {
} @SuppressWarnings("synthetic-access")
} @Override
}); public void run() {
if (!consoleOutput.isDisposed()) {
} consoleOutput.append(text);
}
/* (non-Javadoc) }
* @see fr.bigeon.gclc.ConsoleManager#prompt() */ });
@Override }
public String prompt() throws IOException {
synchronized (promptLock) { /* (non-Javadoc)
if (isDisposed()) { * @see fr.bigeon.gclc.ConsoleManager#println() */
throw new IOException(); @Override
} public void println() throws IOException {
try { if (isDisposed()) {
Display.getDefault().syncExec(new Runnable() { throw new IOException();
@SuppressWarnings("synthetic-access") }
@Override Display.getDefault().syncExec(new Runnable() {
public void run() { @SuppressWarnings("synthetic-access")
if (!consoleInput.isDisposed()) { @Override
consoleInput.setEnabled(true); public void run() {
consoleInput.setFocus(); if (!consoleOutput.isDisposed()) {
} consoleOutput.append(System.lineSeparator());
} }
}); }
prompting = true; });
promptLock.notifyAll(); }
promptLock.wait();
} catch (final InterruptedException e) { /* (non-Javadoc)
LOGGER.log(Level.WARNING, * @see fr.bigeon.gclc.ConsoleManager#println(java.lang.String) */
"Error in synchronization of prompting", e); //$NON-NLS-1$ @Override
command = null; public void println(final String message) throws IOException {
} if (isDisposed()) {
} throw new IOException();
if (isDisposed()) { }
throw new IOException("Input closed"); //$NON-NLS-1$ Display.getDefault().syncExec(new Runnable() {
} @SuppressWarnings("synthetic-access")
return command; @Override
} public void run() {
if (!consoleOutput.isDisposed()) {
/* (non-Javadoc) consoleOutput.append(message + System.lineSeparator());
* @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */ }
@Override }
public String prompt(final String message) throws IOException { });
synchronized (promptLock) {
if (isDisposed()) { }
throw new IOException();
} /* (non-Javadoc)
try { * @see fr.bigeon.gclc.ConsoleManager#prompt() */
Display.getDefault().syncExec(new Runnable() { @Override
@SuppressWarnings("synthetic-access") public String prompt() throws IOException {
@Override synchronized (promptLock) {
public void run() { if (isDisposed()) {
if (!consoleOutput.isDisposed()) { throw new IOException();
lblPromptlabel.setText(message); }
// relayout try {
SWTConsole.this.layout(); Display.getDefault().syncExec(new Runnable() {
consoleInput.setEnabled(true); @Override
consoleInput.setFocus(); public void run() {
} if (!consoleInput.isDisposed()) {
} consoleInput.setEnabled(true);
}); lblPromptlabel.setText(prompt.apply());
prompting = true; // relayout
promptLock.wait(); SWTConsole.this.layout();
if (isDisposed()) { consoleInput.setFocus();
throw new IOException(); }
} }
} catch (final InterruptedException e) { });
LOGGER.log(Level.WARNING, prompting = true;
"Error in synchronization of prompting", e); //$NON-NLS-1$ promptLock.notifyAll();
command = null; while (prompting) {
} finally { promptLock.wait();
Display.getDefault().syncExec(new Runnable() { }
@SuppressWarnings("synthetic-access") } catch (final InterruptedException e) {
@Override LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$
public void run() { command = null;
if (!consoleOutput.isDisposed()) { Thread.currentThread().interrupt();
lblPromptlabel.setText(prompt); }
// relayout }
SWTConsole.this.layout(); if (isDisposed()) {
} throw new IOException("Input closed"); //$NON-NLS-1$
} }
}); return command;
} }
}
return command; /* (non-Javadoc)
} * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override
/* (non-Javadoc) public String prompt(final long timeout) throws IOException {
* @see org.eclipse.swt.widgets.Composite#setFocus() */ synchronized (promptLock) {
@Override if (isDisposed()) {
public boolean setFocus() { throw new IOException();
return consoleInput.setFocus(); }
} try {
Display.getDefault().syncExec(new Runnable() {
/* (non-Javadoc) @Override
* @see fr.bigeon.gclc.ConsoleManager#setPrompt(java.lang.String) */ public void run() {
@Override if (!consoleInput.isDisposed()) {
public void setPrompt(final String prompt) { consoleInput.setEnabled(true);
this.prompt = prompt; lblPromptlabel.setText(prompt.apply());
Display.getDefault().syncExec(new Runnable() { // relayout
@SuppressWarnings("synthetic-access") SWTConsole.this.layout();
@Override consoleInput.setFocus();
public void run() { }
if (!consoleOutput.isDisposed()) { }
lblPromptlabel.setText(prompt); });
// relayout prompting = true;
SWTConsole.this.layout(); command = null;
} promptLock.notifyAll();
} final long start = System.currentTimeMillis();
}); long cur = start;
} while (prompting && start + timeout > cur) {
promptLock.wait((cur - start - timeout) / 2);
/* (non-Javadoc) cur = System.currentTimeMillis();
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */ }
@Override } catch (final InterruptedException e) {
public void close() { LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$
synchronized (promptLock) { command = null;
promptLock.notify(); Thread.currentThread().interrupt();
} }
if (consoleInput.isDisposed()) { }
return; if (isDisposed()) {
} throw new IOException("Input closed"); //$NON-NLS-1$
consoleInput.setEnabled(false); }
consoleOutput.setEnabled(false); return command;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */ * @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
@Override @Override
public boolean isClosed() { public String prompt(final String message) throws IOException {
return isDisposed(); synchronized (promptLock) {
} if (isDisposed()) {
throw new IOException();
/** @param string the text */ }
public void setText(String string) { try {
consoleInput.setText(string); Display.getDefault().syncExec(new Runnable() {
} @SuppressWarnings("synthetic-access")
@Override
/** public void run() {
* if (!consoleOutput.isDisposed()) {
*/ lblPromptlabel.setText(message);
public void validateCommand() { // relayout
validateInput(); SWTConsole.this.layout();
} consoleInput.setEnabled(true);
consoleInput.setFocus();
/* (non-Javadoc) }
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */ }
@Override });
public void setInput(String input) { prompting = true;
consoleInput.setText(input); promptLock.wait();
consoleInput.setSelection(input.length()); if (isDisposed()) {
} throw new IOException();
}
/* (non-Javadoc) } catch (final InterruptedException e) {
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#getInput() */ LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$
@Override command = null;
public String getInput() { Thread.currentThread().interrupt();
return consoleInput.getText(); } finally {
} Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
/* (non-Javadoc) @Override
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */ public void run() {
@Override if (!consoleOutput.isDisposed()) {
public void interruptPrompt() { lblPromptlabel.setText(prompt.apply());
synchronized (promptLock) { // relayout
promptLock.notify(); SWTConsole.this.layout();
} }
} }
});
} }
}
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)
* @see org.eclipse.swt.widgets.Composite#setFocus() */
@Override
public boolean setFocus() {
return consoleInput.setFocus();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
@Override
public void setInput(final String input) {
consoleInput.setText(input);
consoleInput.setSelection(input.length());
}
@Override
public void setPrompt(String prompt) {
setPrompt(new ConstantString(prompt));
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#setPrompt(java.lang.String) */
@Override
public void setPrompt(final StringProvider prompt) {
this.prompt = prompt;
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(prompt.apply());
// relayout
SWTConsole.this.layout();
}
}
});
}
/** @param string the text */
public void setText(final String string) {
consoleInput.setText(string);
}
/**
*
*/
public void validateCommand() {
validateInput();
}
/**
*
*/
@Override
public void validateInput() {
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleInput.setEnabled(false);
}
});
synchronized (promptLock) {
while (!prompting) {
try {
promptLock.wait();
} catch (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,90 +1,118 @@
/* /*
* 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 * This software is governed by the CeCILL license under French law and
* provide a swt window for console applications. * 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. * gclc-swt:net.bigeon.gclc.swt.SWTConsoleShell.java
*/ * Created on: Apr 18, 2015
/** */
* gclc-swt:fr.bigeon.gclc.swt.SWTConsoleShell.java package net.bigeon.gclc.swt;
* Created on: Apr 18, 2015
*/ /*-
package fr.bigeon.gclc.swt; * #%L
* GCLC swt
import org.eclipse.swt.SWT; * %%
import org.eclipse.swt.layout.FillLayout; * Copyright (C) 2015 - 2018 Bigeon
import org.eclipse.swt.widgets.Display; * %%
import org.eclipse.swt.widgets.Shell; * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
import fr.bigeon.gclc.manager.ConsoleManager; * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
/** A shell containing a {@link SWTConsole} * "http://www.cecill.info".
* <p> *
* * 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 SWTConsoleShell extends Shell { * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
/** The console component */ * liability.
private SWTConsole console; *
* In this respect, the user's attention is drawn to the risks associated
/** Create the shell. * with loading, using, modifying and/or developing or reproducing the
* * software by the user in light of its specific status of free software,
* @param display the display */ * that may mean that it is complicated to manipulate, and that also
public SWTConsoleShell(Display display) { * therefore means that it is reserved for developers and experienced
super(display, SWT.SHELL_TRIM); * professionals having in-depth computer knowledge. Users are therefore
setLayout(new FillLayout(SWT.HORIZONTAL)); * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
createContents(); * data to be ensured and, more generally, to use and operate it in the
} * same conditions as regards security.
*
@Override * The fact that you are presently reading this means that you have had
protected void checkSubclass() { * knowledge of the CeCILL license and that you accept its terms.
// Disable the check that prevents subclassing of SWT components * #L%
} */
import org.eclipse.swt.SWT;
/** Create contents of the shell. */ import org.eclipse.swt.layout.FillLayout;
protected void createContents() { import org.eclipse.swt.widgets.Display;
console = new SWTConsole(this, SWT.NONE); import org.eclipse.swt.widgets.Shell;
setText("Console Application"); //$NON-NLS-1$
} /** A shell containing a {@link SWTConsole}
* <p>
/** @return the console manager */ *
public ConsoleManager getManager() { * @author Emmanuel Bigeon */
return console; public final class SWTConsoleShell extends Shell {
}
/** The console component */
/* (non-Javadoc) private SWTConsole console;
* @see org.eclipse.swt.widgets.Shell#dispose() */
@Override /** Create the shell.
public void dispose() { *
super.dispose(); * @param display the display */
console.close(); public SWTConsoleShell(final Display display) {
} super(display, SWT.SHELL_TRIM);
} setLayout(new FillLayout(SWT.HORIZONTAL));
createContents();
}
@Override
protected void checkSubclass() {
// Disable the check that prevents subclassing of SWT components
}
/** Create contents of the shell. */
protected void createContents() {
console = new SWTConsole(this, SWT.NONE);
setText("Console Application"); //$NON-NLS-1$
}
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Shell#dispose() */
@Override
public void dispose() {
super.dispose();
console.close();
}
/** @return the input and output. */
public SWTConsole getManager() {
return console;
}
}

View File

@@ -1,188 +1,220 @@
/* /*
* 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 * This software is governed by the CeCILL license under French law and
* provide a swt window for console applications. * 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. * gclc-swt:net.bigeon.gclc.swt.SWTConsole.java
*/ * Created on: Apr 18, 2015
/** */
* gclc-swt:fr.bigeon.gclc.swt.SWTConsole.java package net.bigeon.gclc.swt;
* Created on: Apr 18, 2015
*/ /*-
package fr.bigeon.gclc.swt; * #%L
* GCLC swt
import java.io.IOException; * %%
import java.util.logging.Level; * Copyright (C) 2015 - 2018 Bigeon
import java.util.logging.Logger; * %%
* This software is governed by the CeCILL license under French law and
import org.eclipse.swt.SWT; * abiding by the rules of distribution of free software. You can use,
import org.eclipse.swt.layout.GridData; * modify and/ or redistribute the software under the terms of the CeCILL
import org.eclipse.swt.layout.GridLayout; * license as circulated by CEA, CNRS and INRIA at the following URL
import org.eclipse.swt.widgets.Composite; * "http://www.cecill.info".
import org.eclipse.swt.widgets.Display; *
import org.eclipse.swt.widgets.Text; * 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
import fr.bigeon.gclc.ConsoleApplication; * with a limited warranty and the software's author, the holder of the
import fr.bigeon.gclc.manager.PipedConsoleManager; * economic rights, and the successive licensors have only limited
import fr.bigeon.gclc.tools.AOutputForwardRunnable; * liability.
*
/** A SWT component to connect to gclc {@link ConsoleApplication} * In this respect, the user's attention is drawn to the risks associated
* <p> * with loading, using, modifying and/or developing or reproducing the
* * software by the user in light of its specific status of free software,
* @author Emmanuel Bigeon */ * that may mean that it is complicated to manipulate, and that also
public class SWTConsoleView extends Composite implements ConsoleDelayIO { * therefore means that it is reserved for developers and experienced
/** The local implementation of the forwarding runnable * professionals having in-depth computer knowledge. Users are therefore
* * encouraged to load and test the software's suitability as regards their
* @author Emmanuel Bigeon */ * requirements in conditions enabling the security of their systems and/or
private final class ToSWTConsoleForwardRunnable * data to be ensured and, more generally, to use and operate it in the
extends AOutputForwardRunnable { * same conditions as regards security.
/** The running status */ *
private boolean running = true; * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
/** @param manager the manager */ * #L%
public ToSWTConsoleForwardRunnable(PipedConsoleManager manager) { */
super(manager); import java.io.IOException;
} import java.util.logging.Level;
import java.util.logging.Logger;
@Override
protected void forwardLine(String m) { import org.eclipse.swt.SWT;
appendConsoleOutput(m); import org.eclipse.swt.layout.GridData;
} import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
@Override import org.eclipse.swt.widgets.Display;
protected boolean isRunning() { import org.eclipse.swt.widgets.Text;
return running && !isDisposed();
} import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.utils.AOutputForwardRunnable;
/** @param running the running to set */ import net.bigeon.gclc.utils.PipedConsoleInput;
public void setRunning(boolean running) { import net.bigeon.gclc.utils.PipedConsoleOutput;
this.running = running;
} /** A SWT component to connect to gclc {@link ConsoleApplication}
} * <p>
*
/** The class logger */ * @author Emmanuel Bigeon */
private static final Logger LOGGER = Logger public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
.getLogger(SWTConsoleView.class.getName()); /** The local implementation of the forwarding runnable
/** The console output text field */ *
private final Text consoleOutput; * @author Emmanuel Bigeon */
/** The console input text field */ private final class ToSWTConsoleForwardRunnable extends AOutputForwardRunnable {
private final Text consoleInput; /** The running status */
/** The actual manager */ private boolean running = true;
private PipedConsoleManager manager;
/** The forwarding runnable */ /** @param manager the manager */
private ToSWTConsoleForwardRunnable forward; public ToSWTConsoleForwardRunnable(final PipedConsoleOutput manager) {
super(manager);
/** Create the composite. }
*
* @param parent the prent composite @Override
* @param style the composite style */ protected void forwardLine(final String m) {
public SWTConsoleView(Composite parent, int style) { appendConsoleOutput(m);
super(parent, style); }
setLayout(new GridLayout(1, false)); @Override
protected boolean isRunning() {
consoleOutput = new Text(this, SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | return running && !isDisposed();
SWT.V_SCROLL | SWT.MULTI); }
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true,
1, 1)); /** @param running the running to set */
consoleOutput.setRedraw(true); public void setRunning(final boolean running) {
this.running = running;
consoleInput = new Text(this, SWT.BORDER); }
consoleInput.setLayoutData( }
new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
consoleInput.addKeyListener(new HistoryTextKeyListener(this)); /** The class logger */
} private static final Logger LOGGER = Logger
.getLogger(SWTConsoleView.class.getName());
/** @param manager the manager to set */ /** The console output text field */
public void setManager(PipedConsoleManager manager) { private final Text consoleOutput;
this.manager = manager; /** The console input text field */
if (forward != null) { private final Text consoleInput;
forward.setRunning(false); /** The input. */
} private PipedConsoleInput input;
forward = new ToSWTConsoleForwardRunnable(manager); /** The forwarding runnable */
Thread th = new Thread(forward, "gclcToSWT"); //$NON-NLS-1$ private ToSWTConsoleForwardRunnable forward;
th.start();
} /** Create the composite.
*
/** @param next the next message */ * @param parent the prent composite
protected void appendConsoleOutput(final String next) { * @param style the composite style */
Display.getDefault().syncExec(new Runnable() { public SWTConsoleView(final Composite parent, final int style) {
@SuppressWarnings("synthetic-access") super(parent, style);
@Override
public void run() { setLayout(new GridLayout(1, false));
consoleOutput.append(System.lineSeparator() + next);
} 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));
@Override consoleInput.addKeyListener(new HistoryTextKeyListener(this));
public void validateInput() { }
try {
manager.type(getInput()); /** @param next the next message */
} catch (IOException e) { protected void appendConsoleOutput(final String next) {
LOGGER.log(Level.SEVERE, "Unable to input value to console", e); //$NON-NLS-1$ Display.getDefault().syncExec(new Runnable() {
} @SuppressWarnings("synthetic-access")
} @Override
public void run() {
@Override consoleOutput.append(System.lineSeparator() + next);
protected void checkSubclass() { }
// Disable the check that prevents subclassing of SWT components });
} }
/* (non-Javadoc) @Override
* @see org.eclipse.swt.widgets.Composite#setFocus() */ protected void checkSubclass() {
@Override // Disable the check that prevents subclassing of SWT components
public boolean setFocus() { }
return consoleInput.setFocus();
} /* (non-Javadoc)
* @see net.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
/** @param string the text */ @Override
public void setText(String string) { public String getInput() {
consoleInput.setText(string); return consoleInput.getText();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */ * @see org.eclipse.swt.widgets.Composite#setFocus() */
@Override @Override
public void setInput(String input) { public boolean setFocus() {
consoleInput.setText(input); return consoleInput.setFocus();
consoleInput.setSelection(input.length()); }
}
/* (non-Javadoc)
/* (non-Javadoc) * @see net.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#getInput() */ @Override
@Override public void setInput(final String input) {
public String getInput() { consoleInput.setText(input);
return consoleInput.getText(); 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,38 @@
/** SWT components for a frontend of GCLC applications.
*
* @author Emmanuel Bigeon */
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 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

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

View File

@@ -1,111 +1,142 @@
/* /*
* 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 * This software is governed by the CeCILL license under French law and
* provide a swt window for console applications. * 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. * gclc-swt:net.bigeon.gclc.swt.HistoryTextKeyListenerTest.java
*/ * Created on: Nov 19, 2016
/** */
* gclc-swt:fr.bigeon.gclc.swt.HistoryTextKeyListenerTest.java package net.bigeon.gclc.swt;
* Created on: Nov 19, 2016
*/ /*-
package fr.bigeon.gclc.swt; * #%L
* GCLC swt
import static org.junit.Assert.assertEquals; * %%
* Copyright (C) 2015 - 2018 Bigeon
import org.eclipse.swt.SWT; * %%
import org.junit.Test; * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
/** <p> * modify and/ or redistribute the software under the terms of the CeCILL
* TODO * license as circulated by CEA, CNRS and INRIA at the following URL
* * "http://www.cecill.info".
* @author Emmanuel Bigeon */ *
public class HistoryTextKeyListenerTest { * 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
/** Test method for * with a limited warranty and the software's author, the holder of the
* {@link fr.bigeon.gclc.swt.HistoryTextKeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)}. */ * economic rights, and the successive licensors have only limited
@Test * liability.
public final void testKeyPressedKeyEvent() { *
ConsoleDelayIO io = new ConsoleDelayIO() { * In this respect, the user's attention is drawn to the risks associated
private String input = ""; * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
@Override * that may mean that it is complicated to manipulate, and that also
public void validateInput() { * therefore means that it is reserved for developers and experienced
input = ""; * 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
@Override * data to be ensured and, more generally, to use and operate it in the
public void setInput(String input) { * same conditions as regards security.
this.input = input; *
} * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
@Override * #L%
public String getInput() { */
return input; import static org.junit.Assert.assertEquals;
}
}; import org.eclipse.swt.SWT;
HistoryTextKeyListener listener = new HistoryTextKeyListener(io); import org.junit.Test;
// no effects /**
assertEquals("", io.getInput()); * <p>
listener.pressedKeyCode(SWT.ARROW_UP); * TODO
assertEquals("", io.getInput()); *
listener.pressedKeyCode(SWT.ARROW_DOWN); * @author Emmanuel Bigeon */
assertEquals("", io.getInput()); public class HistoryTextKeyListenerTest {
listener.pressedKeyCode('\r');
assertEquals("", io.getInput()); /** Test method for
* {@link net.bigeon.gclc.swt.HistoryTextKeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)}. */
io.setInput("cmd arg"); @Test
listener.pressedKeyCode(SWT.ARROW_UP); public final void testKeyPressedKeyEvent() {
assertEquals("cmd arg", io.getInput()); ConsoleDelayIO io = new ConsoleDelayIO() {
listener.pressedKeyCode(SWT.ARROW_DOWN); private String input = "";
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode('\r'); @Override
assertEquals("", io.getInput()); public String getInput() {
return input;
io.setInput("cmd arg2"); }
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput()); @Override
listener.pressedKeyCode(SWT.ARROW_DOWN); public void setInput(String input) {
assertEquals("", io.getInput()); this.input = input;
io.setInput("cmd arg2"); }
listener.pressedKeyCode('\r');
assertEquals("", io.getInput()); @Override
listener.pressedKeyCode(SWT.ARROW_UP); public void validateInput() {
assertEquals("cmd arg2", io.getInput()); input = "";
listener.pressedKeyCode(SWT.ARROW_UP); }
assertEquals("cmd arg", io.getInput()); };
listener.pressedKeyCode(SWT.ARROW_UP); HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN); // no effects
assertEquals("cmd arg2", io.getInput()); 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,290 +1,363 @@
/* /*
* 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 * This software is governed by the CeCILL license under French law and
* provide a swt window for console applications. * 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. * gclc-swt:net.bigeon.gclc.swt.SWTConsoleShellTest.java
*/ * Created on: Jun 8, 2016
/** */
* gclc-swt:fr.bigeon.gclc.swt.SWTConsoleShellTest.java package net.bigeon.gclc.swt;
* Created on: Jun 8, 2016
*/ /*-
package fr.bigeon.gclc.swt; * #%L
* GCLC swt
import static org.junit.Assert.assertFalse; * %%
import static org.junit.Assert.assertNotNull; * Copyright (C) 2015 - 2018 Bigeon
import static org.junit.Assert.assertTrue; * %%
import static org.junit.Assert.fail; * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
import java.io.IOException; * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
import org.eclipse.swt.widgets.Display; * "http://www.cecill.info".
import org.junit.Test; *
* As a counterpart to the access to the source code and rights to copy,
import fr.bigeon.gclc.ConsoleApplication; * modify and redistribute granted by the license, users are provided only
import fr.bigeon.gclc.command.Command; * with a limited warranty and the software's author, the holder of the
import fr.bigeon.gclc.command.ExitCommand; * economic rights, and the successive licensors have only limited
import fr.bigeon.gclc.exception.CommandRunException; * liability.
import fr.bigeon.gclc.exception.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
* TODO * software by the user in light of its specific status of free software,
* * that may mean that it is complicated to manipulate, and that also
* @author Emmanuel Bigeon */ * therefore means that it is reserved for developers and experienced
@SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"}) * professionals having in-depth computer knowledge. Users are therefore
public class SWTConsoleShellTest { * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
protected static final long TWO_SECONDS = 2000; * data to be ensured and, more generally, to use and operate it in the
private static final Display DISPLAY = Display.getDefault(); * same conditions as regards security.
*
@Test * The fact that you are presently reading this means that you have had
public void testConsoleClose() { * knowledge of the CeCILL license and that you accept its terms.
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY); * #L%
final SWTConsole swtConsole = (SWTConsole) shell.getManager(); */
swtConsole.close(); import static org.junit.Assert.assertFalse;
swtConsole.setPrompt(":"); import static org.junit.Assert.assertNotNull;
try { import static org.junit.Assert.assertTrue;
final ConsoleApplication appl = new ConsoleApplication(swtConsole, import static org.junit.Assert.fail;
"Hello", "See you");
appl.add(new ExitCommand("exit", appl)); import java.io.IOException;
appl.add(new Command("long") {
import org.eclipse.swt.widgets.Display;
@Override import org.junit.Test;
public String tip() {
return "a long running command"; import net.bigeon.gclc.ConsoleApplication;
} import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.base.ExitCommand;
@Override import net.bigeon.gclc.exception.CommandRunException;
public void execute(String... args) { import net.bigeon.gclc.exception.InvalidCommandName;
try { import net.bigeon.gclc.manager.ConsoleInput;
Thread.sleep(TWO_SECONDS); import net.bigeon.gclc.manager.ConsoleOutput;
} catch (InterruptedException e) {
// TODO Auto-generated catch block /**
e.printStackTrace(); * <p>
} * TODO
} *
}); * @author Emmanuel Bigeon */
appl.add(new Command("test") { @SuppressWarnings({ "javadoc", "static-method", "nls", "deprecation" })
public class SWTConsoleShellTest {
@Override
public String tip() { protected static final long TWO_SECONDS = 2000;
return "a prompting running command"; private static final Display DISPLAY = Display.getDefault();
}
@Test
@Override public void test() {
public void execute(String... args) throws CommandRunException { final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
try { final SWTConsole swtConsole = shell.getManager();
appl.getManager().prompt("Test"); try {
} catch (IOException e) { final ConsoleApplication appl = new ConsoleApplication(swtConsole, swtConsole,
throw new CommandRunException("No input", e, this); "Hello", "See you");
} appl.add(new ExitCommand("exit", appl));
} appl.add(new Command("long") {
});
// shell.pack(); /* (non-Javadoc)
shell.open(); * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
Thread applThread = new Thread(new Runnable() { * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override @Override
public void run() { public void execute(final ConsoleOutput out, final ConsoleInput in,
appl.start(); final String... args) throws CommandRunException {
} try {
}); Thread.sleep(TWO_SECONDS);
Thread testThread = new Thread(new Runnable() { } catch (final InterruptedException e) {
// TODO Auto-generated catch block
@Override e.printStackTrace();
public void run() { }
try { }
Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) { @Override
// TODO Auto-generated catch block public String tip() {
e.printStackTrace(); return "a long running command";
} }
Display.getDefault().syncExec(new Runnable() {
@Override /* (non-Javadoc)
public void run() { * @see fr.bigeon.gclc.command.Command#usageDetail() */
swtConsole.setText("test"); //$NON-NLS-1$ @Override
swtConsole.validateCommand(); protected String usageDetail() {
} // TODO Auto-generated method stub
}); // return null;
Display.getDefault().syncExec(new Runnable() { throw new RuntimeException("Not implemented yet");
@Override }
public void run() { });
swtConsole.setText("ok"); //$NON-NLS-1$ // shell.pack();
} shell.open();
}); final Thread applThread = new Thread(new Runnable() {
swtConsole.validateCommand();
Display.getDefault().syncExec(new Runnable() { @Override
@Override public void run() {
public void run() { appl.start();
swtConsole.setText("long"); //$NON-NLS-1$ }
} });
}); final Thread testThread = new Thread(new Runnable() {
swtConsole.validateCommand();
Display.getDefault().syncExec(new Runnable() { @Override
@Override public void run() {
public void run() { try {
swtConsole.setText("test"); //$NON-NLS-1$ Thread.sleep(TWO_SECONDS);
} } catch (final InterruptedException e) {
}); // TODO Auto-generated catch block
swtConsole.validateCommand(); e.printStackTrace();
Display.getDefault().syncExec(new Runnable() { }
@Override Display.getDefault().syncExec(new Runnable() {
public void run() { @Override
swtConsole.setText("test"); //$NON-NLS-1$ public void run() {
} swtConsole.setText("test"); //$NON-NLS-1$
}); swtConsole.validateCommand();
swtConsole.validateCommand(); }
try { });
Thread.sleep(TWO_SECONDS); try {
} catch (InterruptedException e) { Thread.sleep(TWO_SECONDS);
// TODO Auto-generated catch block } catch (final InterruptedException e) {
e.printStackTrace(); // TODO Auto-generated catch block
} e.printStackTrace();
Display.getDefault().syncExec(new Runnable() { }
@Override Display.getDefault().syncExec(new Runnable() {
public void run() { @Override
shell.dispose(); public void run() {
} shell.dispose();
}); }
});
} }
}); });
applThread.start(); applThread.start();
testThread.start(); testThread.start();
while (!shell.isDisposed()) { while (!shell.isDisposed()) {
if (!DISPLAY.readAndDispatch()) { if (!DISPLAY.readAndDispatch()) {
DISPLAY.sleep(); DISPLAY.sleep();
} }
} }
swtConsole.setPrompt(">"); // DISPLAY.dispose();
try { assertTrue(swtConsole.isClosed());
swtConsole.prompt(); Thread.sleep(TWO_SECONDS);
fail("Prompting when closed should fail!"); assertFalse(appl.isRunning());
} catch (IOException e) { } catch (final InvalidCommandName e) {
assertNotNull(e); // TODO Auto-generated catch block
} e.printStackTrace();
// DISPLAY.dispose(); } catch (final InterruptedException e) {
assertTrue(appl.getManager().isClosed()); // TODO Auto-generated catch block
Thread.sleep(TWO_SECONDS); e.printStackTrace();
assertFalse(appl.isRunning()); }
} catch (InvalidCommandName e) { }
// TODO Auto-generated catch block
e.printStackTrace(); @Test
} catch (InterruptedException e) { public void testConsoleClose() {
// TODO Auto-generated catch block final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
e.printStackTrace(); final SWTConsole swtConsole = shell.getManager();
} swtConsole.close();
} swtConsole.setPrompt(":");
try {
@Test final ConsoleApplication appl = new ConsoleApplication(swtConsole, swtConsole,
public void test() { "Hello", "See you");
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY); appl.add(new ExitCommand("exit", appl));
final SWTConsole swtConsole = (SWTConsole) shell.getManager(); appl.add(new Command("long") {
try { /* (non-Javadoc)
final ConsoleApplication appl = new ConsoleApplication(swtConsole, * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
"Hello", "See you"); * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
appl.add(new ExitCommand("exit", appl)); * java.lang.String[]) */
appl.add(new Command("long") { @Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
@Override final String... args) throws CommandRunException {
public String tip() { try {
return "a long running command"; Thread.sleep(TWO_SECONDS);
} } catch (final InterruptedException e) {
// TODO Auto-generated catch block
@Override e.printStackTrace();
public void execute(String... args) { }
try { }
Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) { @Override
// TODO Auto-generated catch block public String tip() {
e.printStackTrace(); return "a long running command";
} }
}
}); /* (non-Javadoc)
// shell.pack(); * @see fr.bigeon.gclc.command.Command#usageDetail() */
shell.open(); @Override
Thread applThread = new Thread(new Runnable() { protected String usageDetail() {
// TODO Auto-generated method stub
@Override // return null;
public void run() { throw new RuntimeException("Not implemented yet");
appl.start(); }
} });
}); appl.add(new Command("test") {
Thread testThread = new Thread(new Runnable() { /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
@Override * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
public void run() { * java.lang.String[]) */
try { @Override
Thread.sleep(TWO_SECONDS); public void execute(final ConsoleOutput out, final ConsoleInput in,
} catch (InterruptedException e) { final String... args) throws CommandRunException {
// TODO Auto-generated catch block try {
e.printStackTrace(); swtConsole.prompt("Test");
} } catch (final IOException e) {
Display.getDefault().syncExec(new Runnable() { throw new CommandRunException("No input", e);
@Override }
public void run() { }
swtConsole.setText("test"); //$NON-NLS-1$
swtConsole.validateCommand(); @Override
} public String tip() {
}); return "a prompting running command";
try { }
Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) { /* (non-Javadoc)
// TODO Auto-generated catch block * @see fr.bigeon.gclc.command.Command#usageDetail() */
e.printStackTrace(); @Override
} protected String usageDetail() {
Display.getDefault().syncExec(new Runnable() { // TODO Auto-generated method stub
@Override // return null;
public void run() { throw new RuntimeException("Not implemented yet");
shell.dispose(); }
} });
}); // shell.pack();
} shell.open();
}); final Thread applThread = new Thread(new Runnable() {
applThread.start();
testThread.start(); @Override
while (!shell.isDisposed()) { public void run() {
if (!DISPLAY.readAndDispatch()) { appl.start();
DISPLAY.sleep(); }
} });
} final Thread testThread = new Thread(new Runnable() {
// DISPLAY.dispose();
assertTrue(appl.getManager().isClosed()); @Override
Thread.sleep(TWO_SECONDS); public void run() {
assertFalse(appl.isRunning()); try {
} catch (InvalidCommandName e) { Thread.sleep(TWO_SECONDS);
// TODO Auto-generated catch block } catch (final InterruptedException e) {
e.printStackTrace(); // TODO Auto-generated catch block
} catch (InterruptedException e) { e.printStackTrace();
// 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
e.printStackTrace();
}
}
}

View File

@@ -1,152 +1,203 @@
/* /*
* 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 * This software is governed by the CeCILL license under French law and
* provide a swt window for console applications. * 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. * gclc-swt:net.bigeon.gclc.swt.SWTConsoleShellTest.java
*/ * Created on: Jun 8, 2016
/** */
* gclc-swt:fr.bigeon.gclc.swt.SWTConsoleShellTest.java package net.bigeon.gclc.swt;
* Created on: Jun 8, 2016
*/ /*-
package fr.bigeon.gclc.swt; * #%L
* GCLC swt
import static org.junit.Assert.assertNull; * %%
* Copyright (C) 2015 - 2018 Bigeon
import java.io.IOException; * %%
* This software is governed by the CeCILL license under French law and
import org.eclipse.swt.SWT; * abiding by the rules of distribution of free software. You can use,
import org.eclipse.swt.widgets.Display; * modify and/ or redistribute the software under the terms of the CeCILL
import org.eclipse.swt.widgets.Shell; * license as circulated by CEA, CNRS and INRIA at the following URL
import org.junit.Test; * "http://www.cecill.info".
*
import fr.bigeon.gclc.ConsoleApplication; * As a counterpart to the access to the source code and rights to copy,
import fr.bigeon.gclc.command.Command; * modify and redistribute granted by the license, users are provided only
import fr.bigeon.gclc.command.ExitCommand; * 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.manager.PipedConsoleManager; * liability.
*
/** <p> * In this respect, the user's attention is drawn to the risks associated
* TODO * with loading, using, modifying and/or developing or reproducing the
* * software by the user in light of its specific status of free software,
* @author Emmanuel Bigeon */ * that may mean that it is complicated to manipulate, and that also
@SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"}) * therefore means that it is reserved for developers and experienced
public class SWTConsoleViewTest { * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
protected static final long TWO_SECONDS = 2000; * requirements in conditions enabling the security of their systems and/or
private static final Display DISPLAY = Display.getDefault(); * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
@Test *
public void test() { * The fact that you are presently reading this means that you have had
final Shell shell = new Shell(DISPLAY); * knowledge of the CeCILL license and that you accept its terms.
final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE); * #L%
try (PipedConsoleManager manager = new PipedConsoleManager()) { */
swtConsole.setManager(manager); import static org.junit.Assert.assertNull;
} catch (IOException e2) {
assertNull(e2); import java.io.IOException;
}
try (PipedConsoleManager manager = new PipedConsoleManager()) { import org.eclipse.swt.SWT;
swtConsole.setManager(manager); import org.eclipse.swt.widgets.Display;
final ConsoleApplication appl = new ConsoleApplication(manager, import org.eclipse.swt.widgets.Shell;
"Hello", "See you"); import org.junit.Test;
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") { import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.command.Command;
@Override import net.bigeon.gclc.command.base.ExitCommand;
public String tip() { import net.bigeon.gclc.exception.CommandRunException;
return "a long running command"; import net.bigeon.gclc.exception.InvalidCommandName;
} import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
@Override import net.bigeon.gclc.utils.PipedConsoleInput;
public void execute(String... args) { import net.bigeon.gclc.utils.PipedConsoleOutput;
try {
Thread.sleep(TWO_SECONDS); /**
} catch (InterruptedException e) { * <p>
// TODO Auto-generated catch block * TODO
e.printStackTrace(); *
} * @author Emmanuel Bigeon */
} @SuppressWarnings({ "javadoc", "static-method", "nls", "deprecation" })
}); public class SWTConsoleViewTest {
// shell.pack();
shell.open(); protected static final long TWO_SECONDS = 2000;
Thread applThread = new Thread(new Runnable() { private static final Display DISPLAY = Display.getDefault();
@Override @Test
public void run() { public void test() {
appl.start(); final Shell shell = new Shell(DISPLAY);
} final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE);
}); try (PipedConsoleOutput manager = new PipedConsoleOutput();
Thread testThread = new Thread(new Runnable() { PipedConsoleInput input = new PipedConsoleInput(System.out)) {
swtConsole.setManager(manager, input);
@Override } catch (final IOException e2) {
public void run() { assertNull(e2);
try { }
Thread.sleep(TWO_SECONDS); try (PipedConsoleOutput manager = new PipedConsoleOutput();
} catch (InterruptedException e) { PipedConsoleInput input = new PipedConsoleInput(System.out)) {
// TODO Auto-generated catch block swtConsole.setManager(manager, input);
e.printStackTrace(); final ConsoleApplication appl = new ConsoleApplication(manager, input,
} "Hello", "See you");
Display.getDefault().syncExec(new Runnable() { appl.add(new ExitCommand("exit", appl));
@Override appl.add(new Command("long") {
public void run() {
swtConsole.setText("test"); //$NON-NLS-1$ /* (non-Javadoc)
swtConsole.validateInput(); * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
} * ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
}); * java.lang.String[]) */
try { @Override
Thread.sleep(TWO_SECONDS); public void execute(final ConsoleOutput out, final ConsoleInput in,
} catch (InterruptedException e) { final String... args) throws CommandRunException {
// TODO Auto-generated catch block try {
e.printStackTrace(); Thread.sleep(TWO_SECONDS);
} } catch (final InterruptedException e) {
Display.getDefault().syncExec(new Runnable() { // TODO Auto-generated catch block
@Override e.printStackTrace();
public void run() { }
shell.dispose(); }
}
}); @Override
} public String tip() {
}); return "a long running command";
applThread.start(); }
testThread.start();
while (!shell.isDisposed()) { /* (non-Javadoc)
if (!DISPLAY.readAndDispatch()) { * @see fr.bigeon.gclc.command.Command#usageDetail() */
DISPLAY.sleep(); @Override
} protected String usageDetail() {
} // TODO Auto-generated method stub
} catch (InvalidCommandName e) { // return null;
// TODO Auto-generated catch block throw new RuntimeException("Not implemented yet");
e.printStackTrace(); }
} catch (IOException e1) { });
// TODO Auto-generated catch block // shell.pack();
e1.printStackTrace(); 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();
}
}
}

517
gclc.system/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,41 +1,64 @@
<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> <groupId>net.bigeon.gclc</groupId>
<groupId>net.bigeon</groupId> <artifactId>system</artifactId>
<artifactId>gclc.system</artifactId> <version>0.0.2-SNAPSHOT</version>
<version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging>
<packaging>jar</packaging> <url>http://www.bigeon.net</url>
<url>http://www.bigeon.net</url> <properties>
<properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <copyright.email>emmanuel@bigeon.fr</copyright.email>
</properties> <license.licenseName>cecill_2.1</license.licenseName>
<build> </properties>
<plugins> <build>
</plugins> <plugins>
</build> </plugins>
<dependencies> </build>
<dependency> <dependencies>
<groupId>junit</groupId> <dependency>
<artifactId>junit</artifactId> <groupId>net.bigeon</groupId>
<version>4.11</version> <artifactId>gclc</artifactId>
<scope>test</scope> <version>2.0.9</version>
</dependency> </dependency>
<dependency> </dependencies>
<groupId>fr.bigeon</groupId> <name>GCLC system command</name>
<artifactId>gclc</artifactId> <description>Provide an exec command to execute system commands</description>
<version>1.3.1</version> <inceptionYear>2016</inceptionYear>
</dependency>
</dependencies> <licenses>
<name>GCLC system command</name> <license>
<description>Provide an exec command to execute system commands</description> <distribution>manual</distribution>
<inceptionYear>2016</inceptionYear> <name>CeCILL 2.1</name>
<scm> <url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> </license>
<tag>HEAD</tag> </licenses>
</scm> <reporting>
<parent> <plugins>
<groupId>fr.bigeon</groupId> <plugin>
<artifactId>ebigeon-config</artifactId> <groupId>com.github.sevntu-checkstyle</groupId>
<version>1.7.1</version> <artifactId>dsm-maven-plugin</artifactId>
</parent> <version>2.2.0</version>
</project> </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>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag>
</scm>
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.12</version>
</parent>
</project>

View File

@@ -1,149 +1,181 @@
/** /**
* gclc.system:net.bigeon.gclc.system.ExecSystemCommand.java * gclc.system:net.bigeon.gclc.system.ExecSystemCommand.java
* Created on: Jun 20, 2016 * Created on: Jun 20, 2016
*/ */
package net.bigeon.gclc.system; package net.bigeon.gclc.system;
import java.io.BufferedWriter; /*-
import java.io.IOException; * #%L
import java.io.InputStream; * GCLC system command
import java.io.OutputStream; * %%
import java.io.OutputStreamWriter; * Copyright (C) 2016 - 2018 Bigeon
import java.util.logging.Level; * %%
import java.util.logging.Logger; * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
import fr.bigeon.gclc.command.Command; * modify and/ or redistribute the software under the terms of the CeCILL
import fr.bigeon.gclc.exception.CommandRunException; * license as circulated by CEA, CNRS and INRIA at the following URL
import fr.bigeon.gclc.exception.CommandRunExceptionType; * "http://www.cecill.info".
import fr.bigeon.gclc.manager.ConsoleManager; *
* As a counterpart to the access to the source code and rights to copy,
/** A command that will execute a system 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
* @author Emmanuel Bigeon */ * economic rights, and the successive licensors have only limited
public class ExecSystemCommand extends Command { * liability.
*
/** The command default name */ * In this respect, the user's attention is drawn to the risks associated
private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$ * with loading, using, modifying and/or developing or reproducing the
/** The end of line separator */ * software by the user in light of its specific status of free software,
private static final String EOL = System.lineSeparator(); * that may mean that it is complicated to manipulate, and that also
/** The class logger */ * therefore means that it is reserved for developers and experienced
private static final Logger LOGGER = Logger * professionals having in-depth computer knowledge. Users are therefore
.getLogger(ExecSystemCommand.class.getName()); * encouraged to load and test the software's suitability as regards their
/** The manager for the application's user interface */ * requirements in conditions enabling the security of their systems and/or
private final ConsoleManager manager; * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
/** @param name the name of the command (the input from the manager that *
* should trigger this command) * The fact that you are presently reading this means that you have had
* @param manager the console manager for input and outputs */ * knowledge of the CeCILL license and that you accept its terms.
public ExecSystemCommand(String name, ConsoleManager manager) { * #L%
super(name); */
this.manager = manager; import java.io.BufferedWriter;
} import java.io.IOException;
import java.io.InputStream;
/** @param manager the console manager for input and outputs */ import java.io.OutputStream;
public ExecSystemCommand(ConsoleManager manager) { import java.io.OutputStreamWriter;
super(COMMAND_DEFAULT_NAME); import java.util.logging.Level;
this.manager = manager; import java.util.logging.Logger;
}
import net.bigeon.gclc.command.Command;
/* (non-Javadoc) import net.bigeon.gclc.exception.CommandRunException;
* @see fr.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */ import net.bigeon.gclc.exception.CommandRunExceptionType;
@SuppressWarnings("resource") import net.bigeon.gclc.manager.ConsoleInput;
@Override import net.bigeon.gclc.manager.ConsoleOutput;
public void execute(String... args) throws CommandRunException {
Process proc; /** A command that will execute a system command.
try { *
proc = Runtime.getRuntime().exec(args); * @author Emmanuel Bigeon */
} catch (IOException e2) { public class ExecSystemCommand extends Command {
LOGGER.log(Level.SEVERE, "Unable to run process", e2); //$NON-NLS-1$
return; /** Error message for the manager closed. */
} private static final String MANAGER_WAS_CLOSED = "manager was closed";
/** The command default name */
final InputStream is = proc private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$
.getInputStream(); /** The end of line separator */
Thread th = new Thread(new Runnable() { private static final String EOL = System.lineSeparator();
/** The class logger */
@SuppressWarnings("synthetic-access") private static final Logger LOGGER = Logger
@Override .getLogger(ExecSystemCommand.class.getName());
public void run() {
try { /** Create the command with the name 'exec'. */
readToEnd(is); public ExecSystemCommand() {
is.close(); super(COMMAND_DEFAULT_NAME);
} catch (CommandRunException e) { }
LOGGER.log(Level.WARNING,
"Manager was closed in the meantime...", e); //$NON-NLS-1$ /** Create the command with a custom name.
} catch (IOException e) { *
LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$ * @param name the name of the command (the input from the manager that should
} * trigger this command) */
} public ExecSystemCommand(final String name) {
}); super(name);
th.start(); }
manager.setPrompt(""); //$NON-NLS-1$
final OutputStream os = proc.getOutputStream(); /* (non-Javadoc)
try (BufferedWriter writer = new BufferedWriter( * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
new OutputStreamWriter(os))) { * ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
while (th.isAlive()) { @Override
String user; public void execute(final ConsoleOutput out, final ConsoleInput in,
try { final String... args) throws CommandRunException {
user = manager.prompt(); Process proc;
} catch (IOException e) { try {
throw new CommandRunException( proc = Runtime.getRuntime().exec(args);
CommandRunExceptionType.INTERACTION, } catch (final IOException e2) {
"manager was closed", e, this); //$NON-NLS-1$ LOGGER.log(Level.SEVERE, "Unable to run process", e2); //$NON-NLS-1$
} return;
writer.write(user + EOL); }
}
} catch (IOException e1) { final InputStream is = proc.getInputStream();
throw new CommandRunException(CommandRunExceptionType.INTERACTION, final Thread th = new Thread(new Runnable() {
"manager was closed", e1, this); //$NON-NLS-1$
} @Override
} public void run() {
try {
/** @param is the input stream readToEnd(out, is);
* @throws CommandRunException if the manager was closed while writing the is.close();
* stream */ } catch (final CommandRunException e) {
protected void readToEnd(InputStream is) throws CommandRunException { LOGGER.log(Level.WARNING, "Manager was closed in the meantime...", e); //$NON-NLS-1$
int c; } catch (final IOException e) {
try { LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$
while ((c = is.read()) != -1) { }
try { }
manager.print(Character.valueOf((char) c).toString()); });
} catch (IOException e) { th.start();
throw new CommandRunException( in.setPrompt(""); //$NON-NLS-1$
CommandRunExceptionType.INTERACTION, final OutputStream os = proc.getOutputStream();
"manager was closed", e, this); //$NON-NLS-1$ try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os))) {
} while (th.isAlive()) {
} String user = in.prompt();
} catch (IOException e) { writer.write(user + EOL);
LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$ }
} } catch (final IOException e1) {
} throw new CommandRunException(CommandRunExceptionType.INTERACTION,
MANAGER_WAS_CLOSED, e1); // $NON-NLS-1$
/* (non-Javadoc) }
* @see fr.bigeon.gclc.command.Command#usageDetail() */ }
@Override
protected String usageDetail() { /** @param is the input stream
return " The system command is a system dependend command like sh on linux or" + //$NON-NLS-1$ * @throws CommandRunException if the manager was closed while writing the
System.lineSeparator() + "powershell on windows." + //$NON-NLS-1$ * stream */
System.lineSeparator() + System.lineSeparator() + protected void readToEnd(final ConsoleOutput out, final InputStream is)
" As an example if you give \"cat /etc/hostname\" as argument, on a linux" + //$NON-NLS-1$ throws CommandRunException {
System.lineSeparator() + int c;
"system, you would get the computer name." + //$NON-NLS-1$ try {
System.lineSeparator(); while ((c = is.read()) != -1) {
} printCharacter(out, (char) c);
}
/* (non-Javadoc) } catch (final IOException e) {
* @see fr.bigeon.gclc.command.Command#usagePattern() */ LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$
@Override }
protected String usagePattern() { }
return " CMD <system command>"; //$NON-NLS-1$
} /** Print a character on the console.
*
/* (non-Javadoc) * @param out the console
* @see fr.bigeon.gclc.command.ICommand#tip() */ * @param c the character
@Override * @throws CommandRunException if the console failed to print the character. */
public String tip() { private void printCharacter(final ConsoleOutput out, char c)
return "Execute a system command"; //$NON-NLS-1$ throws CommandRunException {
} try {
out.print(Character.toString(c));
} } catch (final IOException e) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
MANAGER_WAS_CLOSED, 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$
}
}

View File

@@ -0,0 +1,8 @@
/** This package contains classes for command execution on the system.
* <p>
* The class {@link net.bigeon.gclc.system.ExecSystemCommand} is, in the current
* version (0.0.1), a source of vulnerability and should probably be used only
* in private projects where the user is aware of the dangers.
*
* @author Emmanuel Bigeon */
package net.bigeon.gclc.system;

View File

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

517
gclc/LICENSE.txt Normal file
View File

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

View File

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

View File

@@ -1,117 +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.manager.EmptyInput.java
* Created on: Nov 13, 2017
*/
package fr.bigeon.gclc.manager;
/** 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 String getPrompt() {
return ""; //$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) {
//
}
}

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,210 +1,215 @@
/* /**
* Copyright Bigeon Emmanuel (2014) * gclc:net.bigeon.gclc.command.CommandParameters.java
* * Created on: Dec 24, 2014
* emmanuel@bigeon.fr */
* package net.bigeon.gclc.command;
* This software is a computer program whose purpose is to
* provide a generic framework for console applications. /*-
* * #%L
* This software is governed by the CeCILL license under French law and * Generic Command Ligne console
* abiding by the rules of distribution of free software. You can use, * %%
* modify and/or redistribute the software under the terms of the CeCILL * Copyright (C) 2014 - 2018 bigeon.fr
* license as circulated by CEA, CNRS and INRIA at the following URL * %%
* "http://www.cecill.info". * This software is governed by the CeCILL license under French law and
* * abiding by the rules of distribution of free software. You can use,
* As a counterpart to the access to the source code and rights to copy, * modify and/ or redistribute the software under the terms of the CeCILL
* modify and redistribute granted by the license, users are provided only * license as circulated by CEA, CNRS and INRIA at the following URL
* with a limited warranty and the software's author, the holder of the * "http://www.cecill.info".
* economic rights, and the successive licensors have only limited *
* liability. * As a counterpart to the access to the source code and rights to copy,
* * modify and redistribute granted by the license, users are provided only
* In this respect, the user's attention is drawn to the risks associated * with a limited warranty and the software's author, the holder of the
* with loading, using, modifying and/or developing or reproducing the * economic rights, and the successive licensors have only limited
* software by the user in light of its specific status of free software, * liability.
* that may mean that it is complicated to manipulate, and that also *
* therefore means that it is reserved for developers and experienced * In this respect, the user's attention is drawn to the risks associated
* professionals having in-depth computer knowledge. Users are therefore * with loading, using, modifying and/or developing or reproducing the
* encouraged to load and test the software's suitability as regards their * software by the user in light of its specific status of free software,
* requirements in conditions enabling the security of their systems and/or * that may mean that it is complicated to manipulate, and that also
* data to be ensured and, more generally, to use and operate it in the * therefore means that it is reserved for developers and experienced
* same conditions as regards security. * professionals having in-depth computer knowledge. Users are therefore
* * encouraged to load and test the software's suitability as regards their
* The fact that you are presently reading this means that you have had * requirements in conditions enabling the security of their systems and/or
* knowledge of the CeCILL license and that you accept its terms. * data to be ensured and, more generally, to use and operate it in the
*/ * same conditions as regards security.
/** *
* gclc:fr.bigeon.gclc.command.CommandParameters.java * The fact that you are presently reading this means that you have had
* Created on: Dec 24, 2014 * knowledge of the CeCILL license and that you accept its terms.
*/ * #L%
package fr.bigeon.gclc.command; */
import java.util.ArrayList;
import java.util.ArrayList; import java.util.Collections;
import java.util.Collections; import java.util.HashMap;
import java.util.HashMap; import java.util.List;
import java.util.List; import java.util.Map;
import java.util.Map; import java.util.Set;
import java.util.Set; import java.util.concurrent.ConcurrentHashMap;
import fr.bigeon.gclc.exception.CommandParsingException; import net.bigeon.gclc.exception.CommandParsingException;
/** An object representing a collection of parameters. /** An object representing a collection of parameters.
* <p> * <p>
* It is used for defaulting values. * It is used for defaulting values.
* *
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
public final class CommandParameters { public final class CommandParameters {
/** Number of element for a string argument. */ /** Number of element for a string argument. */
private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2; private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2;
/** Boolean arguments. */ /** Boolean arguments. */
private final Map<String, Boolean> booleanArguments = new HashMap<>(); private final Map<String, Boolean> booleanArguments;
/** String arguments. */ /** String arguments. */
private final Map<String, String> stringArguments = new HashMap<>(); private final Map<String, String> stringArguments;
/** Arguments restriction on the named ones. */ /** Arguments restriction on the named ones. */
private final boolean strict; private final boolean strict;
/** additional (unnamed) parameters. */ /** additional (unnamed) parameters. */
private final List<String> additional = new ArrayList<>(); private final List<String> additional = new ArrayList<>();
/** Create a command parameter object. /** Create a command parameter object.
* *
* @param bools the boolean parameters * @param bools the boolean parameters
* @param strings the string parameters * @param strings the string parameters
* @param strict if the argument are restricted to the declared ones */ * @param strict if the argument are restricted to the declared ones */
public CommandParameters(final Set<String> bools, final Set<String> strings, public CommandParameters(final Set<String> bools, final Set<String> strings,
final boolean strict) { final boolean strict) {
for (final String string : bools) { booleanArguments = new ConcurrentHashMap<>(bools.size());
booleanArguments.put(string, Boolean.FALSE); for (final String string : bools) {
} booleanArguments.put(string, Boolean.FALSE);
for (final String string : strings) { }
stringArguments.put(string, null); // Cannot use concurrent because of the null values.
} stringArguments = new HashMap<>(strings.size());
this.strict = strict; for (final String string : strings) {
} stringArguments.put(string, null);
}
/** Get the value of a string argument. this.strict = strict;
* }
* @param key the key
* @return the associated value, null if it was not specified */ /** Get the value of a string argument.
public String get(final String key) { *
return stringArguments.get(key); * @param key the key
} * @return the associated value, null if it was not specified */
public String get(final String key) {
/** Get the additional (unrecognized) arguments. return stringArguments.get(key);
* }
* @return additional non parsed parameters */
public List<String> getAdditionals() { /** Get the additional (unrecognized) arguments.
return Collections.unmodifiableList(additional); *
} * @return additional non parsed parameters */
public List<String> getAdditionals() {
/** Get the value of a boolean argument. return Collections.unmodifiableList(additional);
* }
* @param key the key
* @return if the key was specified */ /** Get the value of a boolean argument.
public boolean getBool(final String key) { *
return booleanArguments.containsKey(key) && * @param key the key
booleanArguments.get(key).booleanValue(); * @return if the key was specified */
} public boolean isActive(final String key) {
Boolean val = booleanArguments.get(key);
/** Get the boolean arguments. return val != null && val.booleanValue();
* }
* @return the boolean arguments */
public Set<String> getBooleanArgumentKeys() { /** Get the boolean arguments.
return booleanArguments.keySet(); *
} * @return the boolean arguments */
public Set<String> getBooleanArgumentKeys() {
/** Get the string arguments. return booleanArguments.keySet();
* }
* @return the boolean arguments */
public Set<String> getStringArgumentKeys() { /** Get the string arguments.
return stringArguments.keySet(); *
} * @return the boolean arguments */
public Set<String> getStringArgumentKeys() {
/** Test if an argument exists in this object. return stringArguments.keySet();
* }
* @param key the key
* @return if the key is present in string arguments or boolean ones. */ /** Test if an argument exists in this object.
public boolean hasArgument(final String key) { *
return stringArguments.containsKey(key) || * @param key the key
booleanArguments.containsKey(key); * @return if the key is present in string arguments or boolean ones. */
} public boolean hasArgument(final String key) {
return stringArguments.containsKey(key) || booleanArguments.containsKey(key);
/** Attempt to parse an argument. }
* <p>
* This method return 0 if the parsing was incorrect, or the number of /** Attempt to parse an argument.
* parsed elements. * <p>
* * This method return 0 if the parsing was incorrect, or the number of parsed
* @param arg the argument * elements.
* @param next the next element *
* @return the number of element read */ * @param arg the argument
private int parseArg(final String arg, final String next) { * @param next the next element
if (!arg.startsWith("-")) { //$NON-NLS-1$ * @return the number of element read */
return strict ? 0 : 1; private int parseArg(final String arg, final String next) {
} if (!arg.startsWith("-")) { //$NON-NLS-1$
final String name = arg.substring(1); if (strict) {
if (booleanArguments.containsKey(name)) { return 0;
booleanArguments.put(name, Boolean.TRUE); }
return 1; additional.add(arg);
} return 1;
if (stringArguments.containsKey(name)) { }
return parseStringArg(name, next); final String name = arg.substring(1);
} if (booleanArguments.containsKey(name)) {
if (strict) { booleanArguments.put(name, Boolean.TRUE);
return 0; return 1;
} }
additional.add(name); if (stringArguments.containsKey(name)) {
return 1; return parseStringArg(name, next);
} }
if (strict) {
/** Parse arguments. return 0;
* }
* @param args the arguments to parse additional.add(name);
* @throws CommandParsingException if the arguments parsing failed */ return 1;
public void parseArgs(final String... args) throws CommandParsingException { }
int i = 0;
while (i < args.length) { /** Parse arguments.
String next = null; *
if (i < args.length - 1) { * @param args the arguments to parse
next = args[i + 1]; * @throws CommandParsingException if the arguments parsing failed */
} public void parseArgs(final String... args) throws CommandParsingException {
final int p = parseArg(args[i], next); int i = 0;
if (p == 0) { while (i < args.length) {
throw new CommandParsingException( String next = null;
"Invalid parameter " + args[i]); //$NON-NLS-1$ if (i < args.length - 1) {
} next = args[i + 1];
i += p; }
} final int p = parseArg(args[i], next);
if (p == 0) {
} throw new CommandParsingException("Invalid parameter " + args[i]); //$NON-NLS-1$
}
/** Add a string arg value. i += p;
* }
* @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) { /** Add a string arg value.
if (next == null) { *
return 0; * @param name the string arg name
} * @param next the string arg value
stringArguments.put(name, next); * @return 2 or 0 if next is invalid */
return STRINGARG_NUMBER_OF_ELEMENTS; private int parseStringArg(final String name, final String next) {
} if (next == null) {
return 0;
/** Set a boolean parameter value. }
* stringArguments.put(name, next);
* @param string the key return STRINGARG_NUMBER_OF_ELEMENTS;
* @param value the value */ }
public void set(final String string, final boolean value) {
if (booleanArguments.containsKey(string)) { /** Set a boolean parameter value.
booleanArguments.put(string, Boolean.valueOf(value)); *
} * @param string the key
} * @param value the value */
public void set(final String string, final boolean value) {
/** Set a string parameter value. if (booleanArguments.containsKey(string)) {
* booleanArguments.put(string, Boolean.valueOf(value));
* @param string the key }
* @param value the value */ }
public void set(final String string, final String value) {
if (stringArguments.containsKey(string)) { /** Set a string parameter value.
stringArguments.put(string, 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,125 +1,125 @@
/* /** acide:fr.bigeon.acide.CommandProvider.java
* Copyright Bigeon Emmanuel (2014) * Created on: Aug 6, 2014 */
* package net.bigeon.gclc.command;
* emmanuel@bigeon.fr
* /*-
* This software is a computer program whose purpose is to * #%L
* provide a generic framework for console applications. * Generic Command Ligne console
* * %%
* This software is governed by the CeCILL license under French law and * Copyright (C) 2014 - 2018 bigeon.fr
* abiding by the rules of distribution of free software. You can use, * %%
* modify and/or redistribute the software under the terms of the CeCILL * This software is governed by the CeCILL license under French law and
* license as circulated by CEA, CNRS and INRIA at the following URL * abiding by the rules of distribution of free software. You can use,
* "http://www.cecill.info". * modify and/ or redistribute the software under the terms of the CeCILL
* * license as circulated by CEA, CNRS and INRIA at the following URL
* As a counterpart to the access to the source code and rights to copy, * "http://www.cecill.info".
* modify and redistribute granted by the license, users are provided only *
* with a limited warranty and the software's author, the holder of the * As a counterpart to the access to the source code and rights to copy,
* economic rights, and the successive licensors have only limited * modify and redistribute granted by the license, users are provided only
* liability. * with a limited warranty and the software's author, the holder of the
* * economic rights, and the successive licensors have only limited
* In this respect, the user's attention is drawn to the risks associated * liability.
* with loading, using, modifying and/or developing or reproducing the *
* software by the user in light of its specific status of free software, * In this respect, the user's attention is drawn to the risks associated
* that may mean that it is complicated to manipulate, and that also * with loading, using, modifying and/or developing or reproducing the
* therefore means that it is reserved for developers and experienced * software by the user in light of its specific status of free software,
* professionals having in-depth computer knowledge. Users are therefore * that may mean that it is complicated to manipulate, and that also
* encouraged to load and test the software's suitability as regards their * therefore means that it is reserved for developers and experienced
* requirements in conditions enabling the security of their systems and/or * professionals having in-depth computer knowledge. Users are therefore
* data to be ensured and, more generally, to use and operate it in the * encouraged to load and test the software's suitability as regards their
* same conditions as regards security. * requirements in conditions enabling the security of their systems and/or
* * data to be ensured and, more generally, to use and operate it in the
* The fact that you are presently reading this means that you have had * same conditions as regards security.
* knowledge of the CeCILL license and that you accept its terms. *
*/ * The fact that you are presently reading this means that you have had
/** acide:fr.bigeon.acide.CommandProvider.java * knowledge of the CeCILL license and that you accept its terms.
* Created on: Aug 6, 2014 */ * #L%
package fr.bigeon.gclc.command; */
import java.util.LinkedHashSet;
import java.util.ArrayList; import java.util.Set;
import java.util.List;
import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.i18n.Messages;
import fr.bigeon.gclc.i18n.Messages; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleOutput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/** A command provider is a map of key word to command to execute.
/** A command provider is a map of key word to command to execute. *
* * @author Emmanuel BIGEON */
* @author Emmanuel BIGEON */ public class CommandProvider implements ICommandProvider {
public class CommandProvider implements ICommandProvider { /** The minus character. */
/** The minus character. */ private static final String MINUS = "-"; //$NON-NLS-1$
private static final String MINUS = "-"; //$NON-NLS-1$ /** The space character. */
/** The space character. */ private static final String SPACE = " "; //$NON-NLS-1$
private static final String SPACE = " "; //$NON-NLS-1$
/** The commands map. */ /** The commands set.
protected final List<ICommand> commands; * <p>
* The insertion order is conserved through the use of a
/** Create a command provider. */ * {@link LinkedHashSet}. */
public CommandProvider() { protected final Set<ICommand> commands;
super();
commands = new ArrayList<>(); /** Create a command provider. */
} public CommandProvider() {
super();
/** Test the command name validity. commands = new LinkedHashSet<>();
* }
* @param name the command name
* @throws InvalidCommandName if the name is invalid */ /* (non-Javadoc)
private static void testCommandName(final String name) throws InvalidCommandName { * @see net.bigeon.gclc.command.ICommandProvider#add(java.lang.String,
if (name == null || name.isEmpty() || name.startsWith(MINUS) || * net.bigeon.gclc.command.Command) */
name.contains(SPACE)) { @Override
throw new InvalidCommandName(); public final boolean add(final ICommand value) throws InvalidCommandName {
} final String name = value.getCommandName();
} testCommandName(name);
if (commands.contains(value)) {
/* (non-Javadoc) return true;
* @see fr.bigeon.gclc.command.ICommandProvider#add(java.lang.String, }
* fr.bigeon.gclc.command.Command) */ for (final ICommand iCommand : commands) {
@Override if (iCommand.getCommandName().equals(value.getCommandName())) {
public final boolean add(final ICommand value) throws InvalidCommandName { throw new InvalidCommandName(
final String name = value.getCommandName(); "Name already used: " + value.getCommandName()); //$NON-NLS-1$
testCommandName(name); }
if (commands.contains(value)) { }
return true; return commands.add(value);
} }
for (final ICommand iCommand : commands) {
if (iCommand.getCommandName().equals(value.getCommandName())) { /* (non-Javadoc)
throw new InvalidCommandName( * @see
"Name already used: " + value.getCommandName()); //$NON-NLS-1$ * net.bigeon.gclc.command.ICommandProvider#executeSub(net.bigeon.gclc.manager
} * .ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String,
} * java.lang.String[]) */
return commands.add(value); @Override
} public final void executeSub(final ConsoleOutput out, final ConsoleInput in,
final String cmd, final String... args) throws CommandRunException {
/* (non-Javadoc) final ICommand command = get(cmd);
* @see if (command == null) {
* fr.bigeon.gclc.command.ICommandProvider#executeSub(fr.bigeon.gclc.manager throw new CommandRunException(
* .ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String, Messages.getString("CommandProvider.unrecognized", cmd), null); //$NON-NLS-1$
* java.lang.String[]) */ }
@Override command.execute(out, in, args);
public final void executeSub(final ConsoleOutput out, final ConsoleInput in, }
final String cmd,
final String... args) throws CommandRunException { /* (non-Javadoc)
for (final ICommand command : commands) { * @see net.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */
if (command.getCommandName().equals(cmd)) { @Override
command.execute(out, in, args); public final ICommand get(final String commandName) {
return; for (final ICommand command : commands) {
} if (command.getCommandName().equals(commandName)) {
} return command;
throw new CommandRunException( }
Messages.getString("CommandProvider.unrecognized", cmd), null); //$NON-NLS-1$ }
} return null;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */ /** Test the command name validity.
@Override *
public final ICommand get(final String commandName) { * @param name the command name
for (final ICommand command : commands) { * @throws InvalidCommandName if the name is invalid */
if (command.getCommandName().equals(commandName)) { private static void testCommandName(final String name) throws InvalidCommandName {
return command; if (name == null || name.isEmpty() || name.startsWith(MINUS)
} || name.contains(SPACE)) {
} throw new InvalidCommandName();
return null; }
} }
} }

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,49 +1,46 @@
/* /** This package groups elements related to
* Copyright Bigeon Emmanuel (2014) * {@link net.bigeon.gclc.command.ICommand}
* * <p>
* emmanuel@bigeon.fr * There are some implementations, such as the
* * {@link net.bigeon.gclc.command.ParametrizedCommand} for commands with a
* This software is a computer program whose purpose is to * predefined set of flags and option taking a string as value, the
* provide a generic framework for console applications. * {@link net.bigeon.gclc.command.SubedCommand} for a command that is declined
* * in a set of sub commands, the {@link net.bigeon.gclc.command.base.HelpExecutor}
* This software is governed by the CeCILL license under French law and * for help display of other commands and the
* abiding by the rules of distribution of free software. You can use, *
* modify and/or redistribute the software under the terms of the CeCILL * @author Emmanuel BIGEON */
* license as circulated by CEA, CNRS and INRIA at the following URL package net.bigeon.gclc.command;
* "http://www.cecill.info".
* /*-
* As a counterpart to the access to the source code and rights to copy, * #%L
* modify and redistribute granted by the license, users are provided only * Generic Command Ligne console
* with a limited warranty and the software's author, the holder of the * %%
* economic rights, and the successive licensors have only limited * Copyright (C) 2014 - 2018 bigeon.fr
* liability. * %%
* * This software is governed by the CeCILL license under French law and
* In this respect, the user's attention is drawn to the risks associated * abiding by the rules of distribution of free software. You can use,
* with loading, using, modifying and/or developing or reproducing the * modify and/ or redistribute the software under the terms of the CeCILL
* software by the user in light of its specific status of free software, * license as circulated by CEA, CNRS and INRIA at the following URL
* that may mean that it is complicated to manipulate, and that also * "http://www.cecill.info".
* therefore means that it is reserved for developers and experienced *
* professionals having in-depth computer knowledge. Users are therefore * As a counterpart to the access to the source code and rights to copy,
* encouraged to load and test the software's suitability as regards their * modify and redistribute granted by the license, users are provided only
* requirements in conditions enabling the security of their systems and/or * with a limited warranty and the software's author, the holder of the
* data to be ensured and, more generally, to use and operate it in the * economic rights, and the successive licensors have only limited
* same conditions as regards security. * liability.
* *
* The fact that you are presently reading this means that you have had * In this respect, the user's attention is drawn to the risks associated
* knowledge of the CeCILL license and that you accept its terms. * with loading, using, modifying and/or developing or reproducing the
*/ * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
/** gclc:fr.bigeon.gclc.command.package-info.java * therefore means that it is reserved for developers and experienced
* Created on: Sep 6, 2014 */ * professionals having in-depth computer knowledge. Users are therefore
/** This package groups elements related to * encouraged to load and test the software's suitability as regards their
* {@link fr.bigeon.gclc.command.ICommand} * requirements in conditions enabling the security of their systems and/or
* <p> * data to be ensured and, more generally, to use and operate it in the
* There are some implementations, such as the * same conditions as regards security.
* {@link fr.bigeon.gclc.command.ParametrizedCommand} for commands with a *
* predefined set of flags and option taking a string as value, the * The fact that you are presently reading this means that you have had
* {@link fr.bigeon.gclc.command.SubedCommand} for a command that is declined in * knowledge of the CeCILL license and that you accept its terms.
* a set of sub commands, the {@link fr.bigeon.gclc.command.HelpExecutor} for * #L%
* help display of other commands and the */
*
* @author Emmanuel BIGEON */
package fr.bigeon.gclc.command;

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

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