Compare commits

...

52 Commits

Author SHA1 Message Date
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
124 changed files with 8371 additions and 6054 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

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

View File

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

@@ -1,119 +1,152 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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-process:fr.bigeon.gclc.process.CommandFork.java * gclc-process:net.bigeon.gclc.process.CommandFork.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.util.Arrays; /*-
* #%L
import fr.bigeon.gclc.command.Command; * process
import fr.bigeon.gclc.command.ICommand; * %%
import fr.bigeon.gclc.command.ICommandProvider; * Copyright (C) 2014 - 2018 Bigeon
import fr.bigeon.gclc.exception.CommandRunException; * %%
import fr.bigeon.gclc.manager.ConsoleInput; * This software is governed by the CeCILL license under French law and
import fr.bigeon.gclc.manager.ConsoleOutput; * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
/** A command that is launched inside an internal terminal. * license as circulated by CEA, CNRS and INRIA at the following URL
* <p> * "http://www.cecill.info".
* Several things are to be considered before adding this command to an *
* application: * As a counterpart to the access to the source code and rights to copy,
* <ul> * modify and redistribute granted by the license, users are provided only
* <li>The commands will be able to run in parallel. * with a limited warranty and the software's author, the holder of the
* <li>The managing of the commands will be handled through piped systems and * economic rights, and the successive licensors have only limited
* buffered in so switching to a forked command will actually print again all * liability.
* the command history to the output console. *
* </ul> * In this respect, the user's attention is drawn to the risks associated
* * with loading, using, modifying and/or developing or reproducing the
* @author Emmanuel Bigeon */ * software by the user in light of its specific status of free software,
public class CommandFork extends Command { * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
private final TaskPool pool; * professionals having in-depth computer knowledge. Users are therefore
private final ICommandProvider provider; * encouraged to load and test the software's suitability as regards their
private final int lines; * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
/** Add the fork command. * same conditions as regards security.
* *
* @param name the command name * The fact that you are presently reading this means that you have had
* @param provider the allowed command collection */ * knowledge of the CeCILL license and that you accept its terms.
public CommandFork(final String name, ICommandProvider provider, TaskPool pool) { * #L%
this(name, provider, pool, -1); */
} import java.util.Arrays;
/** Add the fork command. import net.bigeon.gclc.command.Command;
* import net.bigeon.gclc.command.ICommand;
* @param name the command name import net.bigeon.gclc.command.ICommandProvider;
* @param provider the allowed command collection */ import net.bigeon.gclc.exception.CommandRunException;
public CommandFork(final String name, ICommandProvider provider, TaskPool pool, import net.bigeon.gclc.manager.ConsoleInput;
int lines) { import net.bigeon.gclc.manager.ConsoleOutput;
super(name);
this.provider = provider; /** A command that is launched inside an internal terminal.
this.pool = pool; * <p>
this.lines = lines; * Several things are to be considered before adding this command to an
} * application:
* <ul>
@Override * <li>The commands will be able to run in parallel.
public void execute(final ConsoleOutput out, final ConsoleInput in, String... args) * <li>The managing of the commands will be handled through piped systems and
throws CommandRunException { * buffered in so switching to a forked command will actually print again all
if (args.length < 1) { * the command history to the output console.
throw new CommandRunException("No command to fork", this); * </ul>
} *
final ICommand cmd = provider.get(args[0]); * @author Emmanuel Bigeon */
final String[] inner = Arrays.copyOfRange(args, 1, args.length); public class CommandFork extends Command {
final ForkTask task = new ForkCommandTask(cmd, inner, lines);
final Thread th = new Thread(task); private final TaskPool pool;
pool.add(task); private final ICommandProvider provider;
th.start(); private final int lines;
}
/** Add the fork command.
/* (non-Javadoc) *
* @see fr.bigeon.gclc.command.ICommand#tip() */ * @param name the command name
@Override * @param provider the allowed command collection */
public String tip() { public CommandFork(final String name, ICommandProvider provider, TaskPool pool) {
return "Command background launch"; this(name, provider, pool, -1);
} }
/* (non-Javadoc) /** Add the fork command.
* @see fr.bigeon.gclc.command.Command#usageDetail() */ *
@Override * @param name the command name
protected String usageDetail() { * @param provider the allowed command collection */
return ""; public CommandFork(final String name, ICommandProvider provider, TaskPool pool,
} int lines) {
super(name);
/* (non-Javadoc) this.provider = provider;
* @see fr.bigeon.gclc.command.Command#usagePattern() */ this.pool = pool;
@Override this.lines = lines;
protected String usagePattern() { }
return super.usagePattern() + " <command>";
} @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

@@ -1,73 +1,106 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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.
*/ */
/** /**
* *
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.util.Arrays; /*-
* #%L
import fr.bigeon.gclc.command.ICommand; * process
import fr.bigeon.gclc.exception.CommandRunException; * %%
* Copyright (C) 2014 - 2018 Bigeon
/** * %%
* @author Emmanuel 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
public class ForkCommandTask extends ForkTask { * license as circulated by CEA, CNRS and INRIA at the following URL
private final ICommand command; * "http://www.cecill.info".
private final String[] args; *
* As a counterpart to the access to the source code and rights to copy,
/** @param cmd the command * modify and redistribute granted by the license, users are provided only
* @param args the arguements * with a limited warranty and the software's author, the holder of the
* @param lines the number of print to store in the output */ * economic rights, and the successive licensors have only limited
public ForkCommandTask(final ICommand cmd, final String[] args, int lines) { * liability.
super(lines); *
command = cmd; * In this respect, the user's attention is drawn to the risks associated
this.args = Arrays.copyOf(args, args.length); * with loading, using, modifying and/or developing or reproducing the
} * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
/* (non-Javadoc) * therefore means that it is reserved for developers and experienced
* @see fr.bigeon.gclc.process.Task#getName() */ * professionals having in-depth computer knowledge. Users are therefore
@Override * encouraged to load and test the software's suitability as regards their
public String getName() { * requirements in conditions enabling the security of their systems and/or
return command.getCommandName(); * 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.process.ForkTask#doRun() */ * knowledge of the CeCILL license and that you accept its terms.
@Override * #L%
protected void doRun() throws CommandRunException { */
command.execute(out, in, args); 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.Task#getName() */
@Override
public String getName() {
return command.getCommandName();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.ForkTask#doRun() */
@Override
protected void doRun() throws CommandRunException {
command.execute(out, in, args);
}
}

View File

@@ -1,155 +1,188 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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-process:fr.bigeon.gclc.process.ForkTask.java * gclc-process:net.bigeon.gclc.process.ForkTask.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.util.HashSet; /*-
import java.util.Set; * #%L
* process
import fr.bigeon.gclc.exception.CommandRunException; * %%
import fr.bigeon.gclc.manager.ConsoleInput; * Copyright (C) 2014 - 2018 Bigeon
import fr.bigeon.gclc.manager.ConsoleOutput; * %%
import fr.bigeon.gclc.process.io.ConnectingConsoleInput; * This software is governed by the CeCILL license under French law and
import fr.bigeon.gclc.process.io.ConnectingConsoleOutput; * 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
* <p> * "http://www.cecill.info".
* TODO *
* * 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 abstract class ForkTask implements Task { * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
private final Set<InterruptionListener> listeners = new HashSet<>(); * liability.
private boolean running = false; *
* In this respect, the user's attention is drawn to the risks associated
protected final ConnectingConsoleInput in = new ConnectingConsoleInput(); * with loading, using, modifying and/or developing or reproducing the
protected final ConnectingConsoleOutput out; * software by the user in light of its specific status of free software,
private CommandRunException exception; * that may mean that it is complicated to manipulate, and that also
private final Object runLock = new Object(); * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
/** @param lines the number of print to store in the output */ * encouraged to load and test the software's suitability as regards their
public ForkTask(int lines) { * requirements in conditions enabling the security of their systems and/or
out = new ConnectingConsoleOutput(ConnectingConsoleOutput.PERSIST, lines); * 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.process.Task#addInterruptionListener(fr.bigeon.gclc. * knowledge of the CeCILL license and that you accept its terms.
* process.InterruptionListener) */ * #L%
@Override */
public final void addInterruptionListener(final InterruptionListener listener) { import java.util.HashSet;
listeners.add(listener); import java.util.Set;
}
import net.bigeon.gclc.exception.CommandRunException;
/* (non-Javadoc) import net.bigeon.gclc.manager.ConsoleInput;
* @see fr.bigeon.gclc.process.Task#isRunning() */ import net.bigeon.gclc.manager.ConsoleOutput;
@Override import net.bigeon.gclc.process.io.ConnectingConsoleInput;
public final boolean isRunning() { import net.bigeon.gclc.process.io.ConnectingConsoleOutput;
synchronized (runLock) {
return running; /**
} * <p>
} * TODO
*
/** @param out the console output * @author Emmanuel Bigeon */
* @param in the console input public abstract class ForkTask implements Task {
* @param timeout the maximal wait (0 for ever) */
public final void join(final ConsoleOutput out, final ConsoleInput in, long timeout) { private final Set<InterruptionListener> listeners = new HashSet<>();
synchronized (runLock) { private boolean running = false;
this.out.connect(out);
this.in.connect(in); protected final ConnectingConsoleInput in = new ConnectingConsoleInput();
try { protected final ConnectingConsoleOutput out;
if (running) { private CommandRunException exception;
runLock.wait(timeout); private final Object runLock = new Object();
}
} catch (final InterruptedException e) { /** @param lines the number of print to store in the output */
// TODO log. public ForkTask(int lines) {
Thread.currentThread().interrupt(); out = new ConnectingConsoleOutput(ConnectingConsoleOutput.PERSIST, lines);
} }
this.out.disconnect();
this.in.disconnect(); /* (non-Javadoc)
} * @see net.bigeon.gclc.process.Task#addInterruptionListener(fr.bigeon.gclc.
} * process.InterruptionListener) */
@Override
/* (non-Javadoc) public final void addInterruptionListener(final InterruptionListener listener) {
* @see listeners.add(listener);
* fr.bigeon.gclc.process.Task#rmInterruptionListener(fr.bigeon.gclc.process }
* .InterruptionListener) */
@Override /* (non-Javadoc)
public final void rmInterruptionListener(final InterruptionListener listener) { * @see net.bigeon.gclc.process.Task#isRunning() */
listeners.remove(listener); @Override
} public final boolean isRunning() {
synchronized (runLock) {
/* (non-Javadoc) return running;
* @see java.lang.Runnable#run() */ }
@Override }
public final void run() {
synchronized (runLock) { /** @param out the console output
running = true; * @param in the console input
} * @param timeout the maximal wait (0 for ever) */
try { public final void join(final ConsoleOutput out, final ConsoleInput in, long timeout) {
doRun(); synchronized (runLock) {
} catch (final CommandRunException e) { this.out.connect(out);
exception = e; this.in.connect(in);
} finally { try {
setRunning(false); if (running) {
} runLock.wait(timeout);
for (final InterruptionListener interruptionListener : listeners) { }
interruptionListener.interrupted(); } catch (final InterruptedException e) {
} // TODO log.
} Thread.currentThread().interrupt();
}
/** Actually run the fork. */ this.out.disconnect();
protected abstract void doRun() throws CommandRunException; this.in.disconnect();
}
/** Get the excepion that caused a failure. }
*
* @return the exception */ /* (non-Javadoc)
public final CommandRunException getException() { * @see
return exception; * net.bigeon.gclc.process.Task#rmInterruptionListener(net.bigeon.gclc.process
} * .InterruptionListener) */
@Override
/* (non-Javadoc) public final void rmInterruptionListener(final InterruptionListener listener) {
* @see fr.bigeon.gclc.process.Task#setRunning(boolean) */ listeners.remove(listener);
@Override }
public final void setRunning(final boolean running) {
synchronized (runLock) { /* (non-Javadoc)
this.running = running; * @see java.lang.Runnable#run() */
runLock.notifyAll(); @Override
} public final void run() {
} synchronized (runLock) {
running = true;
protected final Object getRunningLock() { }
return runLock; try {
} doRun();
} } catch (final CommandRunException e) {
exception = e;
} finally {
setRunning(false);
}
for (final InterruptionListener interruptionListener : listeners) {
interruptionListener.interrupted();
}
}
/** Actually run the fork. */
protected abstract void doRun() throws CommandRunException;
/** Get the excepion that caused a failure.
*
* @return the exception */
public final CommandRunException getException() {
return exception;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.Task#setRunning(boolean) */
@Override
public final void setRunning(final boolean running) {
synchronized (runLock) {
this.running = running;
runLock.notifyAll();
}
}
protected final Object getRunningLock() {
return runLock;
}
}

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* * Copyright (C) 2014-2018 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -32,25 +29,17 @@
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** gclc:fr.bigeon.gclc.prompt.package-info.java /**
* Created on: Sep 6, 2014 */ * gclc:fr.bigeon.gclc.proc.InterruptionListener.java
/** Client prompting related objects. * Created on: May 10, 2017
* <p> */
* This package is used for the formatting of prompts for the user. The package net.bigeon.gclc.process;
* {@link fr.bigeon.gclc.prompt.CLIPrompter} class provides utility methods to
* retrieve certain basic type of data from the user or to give list choices.
* <p>
* The {@link fr.bigeon.gclc.prompt.CLIPrompterMessages} class is used for
* internationalization of the prompting methods.
*
* @author Emmanuel BIGEON */
package fr.bigeon.gclc.prompt;
/*- /*-
* #%L * #%L
* Generic Command Ligne console * process
* %% * %%
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -79,3 +68,10 @@ package fr.bigeon.gclc.prompt;
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L% * #L%
*/ */
/** A listener for interruption
*
* @author Emmanuel Bigeon */
public interface InterruptionListener {
/** Notification of an interuption of a listened object */
void interrupted();
}

View File

@@ -1,64 +1,97 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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.
*/ */
/** /**
* *
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import fr.bigeon.gclc.ApplicationAttachement; /*-
import fr.bigeon.gclc.command.ICommandProvider; * #%L
import fr.bigeon.gclc.exception.InvalidCommandName; * process
* %%
/** * Copyright (C) 2014 - 2018 Bigeon
* @author Emmanuel 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,
public class ProcessAttachement implements ApplicationAttachement { * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
private final TaskPool pool; * "http://www.cecill.info".
*
/** @param pool the task pool to manage */ * As a counterpart to the access to the source code and rights to copy,
public ProcessAttachement(TaskPool pool) { * modify and redistribute granted by the license, users are provided only
super(); * with a limited warranty and the software's author, the holder of the
this.pool = pool; * economic rights, and the successive licensors have only limited
} * liability.
*
/* (non-Javadoc) * In this respect, the user's attention is drawn to the risks associated
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc.ConsoleApplication) * 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 attach(ICommandProvider application) throws InvalidCommandName { * therefore means that it is reserved for developers and experienced
application.add(new ProcessKill("kill", pool)); * professionals having in-depth computer knowledge. Users are therefore
application.add(new ProcessList("list", pool)); * 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

@@ -1,87 +1,120 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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 ProcessClear 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 ProcessClear(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
for (final String id : pool.getPIDs()) { * data to be ensured and, more generally, to use and operate it in the
if (!pool.get(id).isRunning()) { * same conditions as regards security.
pool.remove(id); *
} * The fact that you are presently reading this means that you have had
} * knowledge of the CeCILL license and that you accept its terms.
return; * #L%
} */
import net.bigeon.gclc.command.Command;
/* (non-Javadoc) import net.bigeon.gclc.exception.CommandRunException;
* @see fr.bigeon.gclc.command.ICommand#tip() */ import net.bigeon.gclc.manager.ConsoleInput;
@SuppressWarnings("nls") import net.bigeon.gclc.manager.ConsoleOutput;
@Override
public String tip() { /** A command that will flag a task to stop
return "Request a process to stop (softly)"; *
} * @author Emmanuel Bigeon */
public final class ProcessClear extends Command {
/* (non-Javadoc) /** The taskpool */
* @see fr.bigeon.gclc.command.Command#usageDetail() */ private final TaskPool pool;
@Override
protected String usageDetail() { /** @param name the command name
return null; * @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,115 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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,133 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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

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

@@ -1,149 +1,182 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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.TaskPool.java * gclc:fr.bigeon.gclc.proc.TaskPool.java
* Created on: May 10, 2017 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.util.Collection; /*-
import java.util.HashMap; * #%L
import java.util.HashSet; * process
import java.util.Map; * %%
* Copyright (C) 2014 - 2018 Bigeon
/** A process pool. * %%
* * 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 TaskPool { * modify and/ or redistribute the software under the terms of the CeCILL
/** The running processes. */ * license as circulated by CEA, CNRS and INRIA at the following URL
private final Map<String, Task> running = new HashMap<>(); * "http://www.cecill.info".
/** The count for process id. */ *
private int count = 0; * As a counterpart to the access to the source code and rights to copy,
/** The lock for pid attribution synchronization. */ * modify and redistribute granted by the license, users are provided only
private final Object lock = new Object(); * with a limited warranty and the software's author, the holder of the
private final boolean autoClear; * economic rights, and the successive licensors have only limited
* liability.
/** Default constructor. */ *
public TaskPool() { * In this respect, the user's attention is drawn to the risks associated
this(true); * 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
/** Default constructor. */ * therefore means that it is reserved for developers and experienced
public TaskPool(boolean autoClear) { * professionals having in-depth computer knowledge. Users are therefore
this.autoClear = autoClear; * 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
/** Remove a task from the pool * same conditions as regards security.
* *
* @param pid the task id */ * The fact that you are presently reading this means that you have had
public void remove(String pid) { * knowledge of the CeCILL license and that you accept its terms.
synchronized (lock) { * #L%
running.remove(pid); */
count = Math.min(count, Integer.parseInt(pid)); import java.util.Collection;
} import java.util.HashMap;
} import java.util.HashSet;
import java.util.Map;
/** Add a process in the pool.
* /** A process pool.
* @param cmd the process *
* @return the pid */ * @author Emmanuel Bigeon */
public String add(final Task cmd) { public final class TaskPool {
if (cmd == null) { /** The running processes. */
throw new IllegalArgumentException("Task cannot be null"); //$NON-NLS-1$ private final Map<String, Task> running = new HashMap<>();
} /** The count for process id. */
final String pid; private int count = 0;
synchronized (lock) { /** The lock for pid attribution synchronization. */
pid = getPID(); private final Object lock = new Object();
running.put(pid, cmd); private final boolean autoClear;
}
if (autoClear) { /** Default constructor. */
cmd.addInterruptionListener(new InterruptionListener() { public TaskPool() {
@SuppressWarnings("synthetic-access") this(true);
@Override }
public void interrupted() {
synchronized (lock) { /** Default constructor. */
remove(pid); public TaskPool(boolean autoClear) {
} this.autoClear = autoClear;
cmd.rmInterruptionListener(this); }
}
}); /** Remove a task from the pool
} *
return pid; * @param pid the task id */
} public void remove(String pid) {
synchronized (lock) {
/** Get a process by it associated identifier. running.remove(pid);
* count = Math.min(count, Integer.parseInt(pid));
* @param pid the task id }
* @return the task, if any, associated to this id */ }
public Task get(final String pid) {
synchronized (lock) { /** Add a process in the pool.
return running.get(pid); *
} * @param cmd the process
} * @return the pid */
public String add(final Task cmd) {
/** Get the next process id. if (cmd == null) {
* throw new IllegalArgumentException("Task cannot be null"); //$NON-NLS-1$
* @return the process id */ }
private String getPID() { final String pid;
synchronized (lock) { synchronized (lock) {
String pid; pid = getPID();
do { running.put(pid, cmd);
pid = Integer.toString(count++); }
} while (running.containsKey(pid)); if (autoClear) {
return pid; cmd.addInterruptionListener(new InterruptionListener() {
} @SuppressWarnings("synthetic-access")
} @Override
public void interrupted() {
/** Get the running processes' identifiers. synchronized (lock) {
* remove(pid);
* @return the pids */ }
public Collection<String> getPIDs() { cmd.rmInterruptionListener(this);
return new HashSet<>(running.keySet()); }
} });
}
/** @return if the clearing of ended task is automatic */ return pid;
public boolean isAutoClearing() { }
return autoClear;
} /** Get a process by it associated identifier.
*
/** Request all task to stop running. * @param pid the task id
* <p> * @return the task, if any, associated to this id */
* This call does not guaranty end of execution, it is up to the task public Task get(final String pid) {
* implementation to actually take into account the termination request. */ synchronized (lock) {
public void shutdown() { return running.get(pid);
synchronized (lock) { }
for (final Task task : running.values()) { }
task.setRunning(false);
} /** Get the next process id.
} *
} * @return the process id */
} private String getPID() {
synchronized (lock) {
String pid;
do {
pid = Integer.toString(count++);
} while (running.containsKey(pid));
return pid;
}
}
/** Get the running processes' identifiers.
*
* @return the pids */
public Collection<String> getPIDs() {
return new HashSet<>(running.keySet());
}
/** @return if the clearing of ended task is automatic */
public boolean isAutoClearing() {
return autoClear;
}
/** Request all task to stop running.
* <p>
* This call does not guaranty end of execution, it is up to the task
* implementation to actually take into account the termination request. */
public void shutdown() {
synchronized (lock) {
for (final Task task : running.values()) {
task.setRunning(false);
}
}
}
}

View File

@@ -1,82 +1,115 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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.util.concurrent.ExecutorService; /*-
* #%L
import fr.bigeon.gclc.command.Command; * process
import fr.bigeon.gclc.exception.CommandRunException; * %%
import fr.bigeon.gclc.manager.ConsoleInput; * Copyright (C) 2014 - 2018 Bigeon
import fr.bigeon.gclc.manager.ConsoleOutput; * %%
* This software is governed by the CeCILL license under French law and
/** An abstract command to generate a task and return the control to the user * 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 abstract class TaskSpawner extends Command { * "http://www.cecill.info".
/** The process pool */ *
private final TaskPool pool; * As a counterpart to the access to the source code and rights to copy,
private final ExecutorService threadPool; * 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
* @param pool the pool */ * liability.
public TaskSpawner(final String name, final TaskPool pool, *
ExecutorService threadPool) { * In this respect, the user's attention is drawn to the risks associated
super(name); * with loading, using, modifying and/or developing or reproducing the
this.pool = pool; * software by the user in light of its specific status of free software,
this.threadPool = threadPool; * 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
/** @param in the input * encouraged to load and test the software's suitability as regards their
* @param out the output * requirements in conditions enabling the security of their systems and/or
* @param args the arguments * data to be ensured and, more generally, to use and operate it in the
* @return the process to start and add to the pool * same conditions as regards security.
* @throws CommandRunException if the task creation failed */ *
protected abstract Task createTask(ConsoleOutput out, ConsoleInput in, * The fact that you are presently reading this means that you have had
String... args) throws CommandRunException; * knowledge of the CeCILL license and that you accept its terms.
* #L%
/* (non-Javadoc) */
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager. import java.util.concurrent.ExecutorService;
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */ import net.bigeon.gclc.command.Command;
@Override import net.bigeon.gclc.exception.CommandRunException;
public final void execute(final ConsoleOutput out, final ConsoleInput in, import net.bigeon.gclc.manager.ConsoleInput;
final String... args) throws CommandRunException { import net.bigeon.gclc.manager.ConsoleOutput;
final Task task = createTask(out, in, args);
final Thread th = new Thread(task); /** An abstract command to generate a task and return the control to the user
pool.add(task); *
threadPool.execute(th); * @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

@@ -1,211 +1,244 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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.
*/ */
/** /**
* *
*/ */
package fr.bigeon.gclc.process.io; package net.bigeon.gclc.process.io;
import java.io.IOException; /*-
import java.util.logging.Level; * #%L
import java.util.logging.Logger; * process
* %%
import fr.bigeon.gclc.manager.ConsoleInput; * Copyright (C) 2014 - 2018 Bigeon
import fr.bigeon.gclc.tools.StringProvider; * %%
* 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 ConnectingConsoleInput implements ConsoleInput { * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
private static final Logger LOGGER = Logger * "http://www.cecill.info".
.getLogger(ConnectingConsoleInput.class.getName()); *
private boolean close = false; * As a counterpart to the access to the source code and rights to copy,
private StringProvider prompt; * modify and redistribute granted by the license, users are provided only
private boolean prompting; * with a limited warranty and the software's author, the holder of the
private final Object promptLock = new Object(); * economic rights, and the successive licensors have only limited
private final Object connectionLock = new Object(); * liability.
private ConsoleInput connected; *
private boolean disconnection; * 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.manager.ConsoleInput#close() */ * that may mean that it is complicated to manipulate, and that also
@Override * therefore means that it is reserved for developers and experienced
public void close() throws IOException { * professionals having in-depth computer knowledge. Users are therefore
close = true; * 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
/* (non-Javadoc) * same conditions as regards security.
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */ *
@Override * The fact that you are presently reading this means that you have had
public StringProvider getPrompt() { * knowledge of the CeCILL license and that you accept its terms.
return prompt; * #L%
} */
import java.io.IOException;
/* (non-Javadoc) import java.util.logging.Level;
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */ import java.util.logging.Logger;
@Override
public void interruptPrompt() { import net.bigeon.gclc.manager.ConsoleInput;
synchronized (promptLock) { import net.bigeon.gclc.tools.StringProvider;
prompting = false;
if (connected != null) { /** @author Emmanuel Bigeon */
connected.interruptPrompt(); public final class ConnectingConsoleInput implements ConsoleInput {
}
promptLock.notifyAll(); private static final Logger LOGGER = Logger
} .getLogger(ConnectingConsoleInput.class.getName());
} private boolean close = false;
private StringProvider prompt;
/* (non-Javadoc) private boolean prompting;
* @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */ private final Object promptLock = new Object();
@Override private final Object connectionLock = new Object();
public boolean isClosed() { private ConsoleInput connected;
return close; private boolean disconnection;
}
/* (non-Javadoc)
/* (non-Javadoc) * @see fr.bigeon.gclc.manager.ConsoleInput#close() */
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */ @Override
@Override public void close() throws IOException {
public String prompt() throws IOException { close = true;
return prompt(prompt.apply()); }
}
/* (non-Javadoc)
/* (non-Javadoc) * @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools. @Override
* StringProvider) */ public StringProvider getPrompt() {
@Override return prompt;
public void setPrompt(StringProvider string) { }
prompt = string;
} /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
/* (non-Javadoc) @Override
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */ public void interruptPrompt() {
@Override synchronized (promptLock) {
public String prompt(long timeout) throws IOException { prompting = false;
return prompt(prompt.apply(), timeout); if (connected != null) {
} connected.interruptPrompt();
}
/* (non-Javadoc) promptLock.notifyAll();
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */ }
@Override }
public String prompt(String message) throws IOException {
synchronized (promptLock) { /* (non-Javadoc)
prompting = true; * @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */
} @Override
while (prompting) { public boolean isClosed() {
synchronized (promptLock) { return close;
if (connected == null) { }
try {
promptLock.wait(); /* (non-Javadoc)
} catch (final InterruptedException e) { * @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
LOGGER.log(Level.WARNING, "Inerruption of console thread", e); @Override
Thread.currentThread().interrupt(); public String prompt() throws IOException {
} return prompt(prompt.apply());
} else { }
final String res = connected.prompt(message);
synchronized (connectionLock) { /* (non-Javadoc)
if (disconnection) { * @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools.
disconnection = false; * StringProvider) */
} else if (prompting) { @Override
return res; public void setPrompt(StringProvider string) {
} prompt = string;
} }
}
} /* (non-Javadoc)
} * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
return null; @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, long) */
@Override /* (non-Javadoc)
public String prompt(String message, long timeout) throws IOException { * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
if (timeout <= 0) { @Override
return prompt(message); public String prompt(String message) throws IOException {
} synchronized (promptLock) {
final long end = System.currentTimeMillis() + timeout; prompting = true;
synchronized (promptLock) { }
prompting = true; while (prompting) {
} synchronized (promptLock) {
while (prompting) { if (connected == null) {
synchronized (promptLock) { try {
if (connected == null) { promptLock.wait();
try { } catch (final InterruptedException e) {
promptLock.wait(); LOGGER.log(Level.WARNING, "Inerruption of console thread", e);
} catch (final InterruptedException e) { Thread.currentThread().interrupt();
LOGGER.log(Level.WARNING, "Inerruption of console thread", e); }
Thread.currentThread().interrupt(); } else {
} final String res = connected.prompt(message);
} else { synchronized (connectionLock) {
final String res = connected.prompt(message, if (disconnection) {
end - System.currentTimeMillis()); disconnection = false;
synchronized (connectionLock) { } else if (prompting) {
if (disconnection) { return res;
disconnection = false; }
} else if (prompting) { }
return res; }
} }
} }
} return null;
} }
}
return null; /* (non-Javadoc)
} * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override
/* (non-Javadoc) public String prompt(String message, long timeout) throws IOException {
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */ if (timeout <= 0) {
@Override return prompt(message);
public void setPrompt(final String prompt) { }
this.prompt = new StringProvider() { final long end = System.currentTimeMillis() + timeout;
@Override synchronized (promptLock) {
public String apply() { prompting = true;
return prompt; }
} while (prompting) {
}; synchronized (promptLock) {
} if (connected == null) {
try {
public void connect(ConsoleInput input) { promptLock.wait();
disconnect(); } catch (final InterruptedException e) {
synchronized (promptLock) { LOGGER.log(Level.WARNING, "Inerruption of console thread", e);
connected = input; Thread.currentThread().interrupt();
promptLock.notifyAll(); }
} } else {
} final String res = connected.prompt(message,
end - System.currentTimeMillis());
public void disconnect() { synchronized (connectionLock) {
synchronized (connectionLock) { if (disconnection) {
if (connected != null) { disconnection = false;
disconnection = true; } else if (prompting) {
synchronized (promptLock) { return res;
connected.interruptPrompt(); }
} }
connected = null; }
} }
} }
} return null;
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override
public void setPrompt(final String prompt) {
this.prompt = new StringProvider() {
@Override
public String apply() {
return prompt;
}
};
}
public void connect(ConsoleInput input) {
disconnect();
synchronized (promptLock) {
connected = input;
promptLock.notifyAll();
}
}
public void disconnect() {
synchronized (connectionLock) {
if (connected != null) {
disconnection = true;
synchronized (promptLock) {
connected.interruptPrompt();
}
connected = null;
}
}
}
}

View File

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

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

View File

@@ -1,8 +1,8 @@
/** /**
* gclc-socket:fr.bigeon.gclc.socket.ConnexionManager.java * gclc-socket:net.bigeon.gclc.socket.ConnexionManager.java
* Created on: Nov 18, 2017 * Created on: Nov 18, 2017
*/ */
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L

View File

@@ -1,8 +1,8 @@
/** /**
* gclc-socket:fr.bigeon.gclc.socket.DConnexionManager.java * gclc-socket:net.bigeon.gclc.socket.DConnexionManager.java
* Created on: Nov 18, 2017 * Created on: Nov 18, 2017
*/ */
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L
@@ -69,7 +69,7 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see * @see
* fr.bigeon.gclc.socket.ConnexionManager#addConnexion(java.lang.Object) */ * net.bigeon.gclc.socket.ConnexionManager#addConnexion(java.lang.Object) */
@Override @Override
public String addConnexion(final T handle) { public String addConnexion(final T handle) {
final String newID = newID(); final String newID = newID();
@@ -81,7 +81,7 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
/* (non-Javadoc) /* (non-Javadoc)
* @see * @see
* fr.bigeon.gclc.socket.ConnexionManager#disconnect(java.lang.String) */ * net.bigeon.gclc.socket.ConnexionManager#disconnect(java.lang.String) */
@Override @Override
public T disconnect(final String id) { public T disconnect(final String id) {
if (connecteds.containsKey(id)) { if (connecteds.containsKey(id)) {
@@ -106,14 +106,14 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.socket.ConnexionManager#get(java.lang.String) */ * @see net.bigeon.gclc.socket.ConnexionManager#get(java.lang.String) */
@Override @Override
public T get(final String id) { public T get(final String id) {
return connecteds.get(id); return connecteds.get(id);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.socket.ConnexionManager#getConnected() */ * @see net.bigeon.gclc.socket.ConnexionManager#getConnected() */
@Override @Override
public Collection<String> getConnected() { public Collection<String> getConnected() {
return connecteds.keySet(); return connecteds.keySet();
@@ -121,7 +121,7 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
/* (non-Javadoc) /* (non-Javadoc)
* @see * @see
* fr.bigeon.gclc.socket.ConnexionManager#isConnected(java.lang.String) */ * net.bigeon.gclc.socket.ConnexionManager#isConnected(java.lang.String) */
@Override @Override
public boolean isConnected(final String id) { public boolean isConnected(final String id) {
return connecteds.containsKey(id); return connecteds.containsKey(id);
@@ -129,7 +129,7 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
/* (non-Javadoc) /* (non-Javadoc)
* @see * @see
* fr.bigeon.gclc.socket.ConnexionManager#lockDisconnexion(java.lang.String) */ * net.bigeon.gclc.socket.ConnexionManager#lockDisconnexion(java.lang.String) */
@Override @Override
public void lockDisconnexion(final String id) { public void lockDisconnexion(final String id) {
if (!connecteds.containsKey(id)) { if (!connecteds.containsKey(id)) {
@@ -149,7 +149,7 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
/* (non-Javadoc) /* (non-Javadoc)
* @see * @see
* fr.bigeon.gclc.socket.ConnexionManager#releaseDisconnexionLock(java.lang. * net.bigeon.gclc.socket.ConnexionManager#releaseDisconnexionLock(java.lang.
* String) */ * String) */
@Override @Override
public void releaseDisconnexionLock(final String id) { public void releaseDisconnexionLock(final String id) {
@@ -162,7 +162,7 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
/* (non-Javadoc) /* (non-Javadoc)
* @see * @see
* fr.bigeon.gclc.socket.ConnexionManager#waitDisconnexion(java.lang.String) */ * net.bigeon.gclc.socket.ConnexionManager#waitDisconnexion(java.lang.String) */
@Override @Override
public void waitDisconnexion(final String id) throws InterruptedException { public void waitDisconnexion(final String id) throws InterruptedException {
final Object lock = locks.get(id); final Object lock = locks.get(id);

View File

@@ -1,8 +1,8 @@
/** /**
* gclc-socket:fr.bigeon.gclc.socket.PlugableConsoleInput.java * gclc-socket:net.bigeon.gclc.socket.PlugableConsoleInput.java
* Created on: Nov 18, 2017 * Created on: Nov 18, 2017
*/ */
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L
@@ -46,10 +46,10 @@ import java.nio.charset.StandardCharsets;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ReadingRunnable; import net.bigeon.gclc.tools.ConstantString;
import fr.bigeon.gclc.tools.ConstantString; import net.bigeon.gclc.tools.StringProvider;
import fr.bigeon.gclc.tools.StringProvider; import net.bigeon.gclc.utils.ReadingRunnable;
/** A console input where the stream can be plugged. /** A console input where the stream can be plugged.
* <p> * <p>

View File

@@ -1,8 +1,8 @@
/** /**
* gclc-socket:fr.bigeon.gclc.socket.PluggableConsoleOutput.java * gclc-socket:net.bigeon.gclc.socket.PluggableConsoleOutput.java
* Created on: Nov 18, 2017 * Created on: Nov 18, 2017
*/ */
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L
@@ -42,7 +42,7 @@ import java.io.PrintStream;
import java.util.ArrayDeque; import java.util.ArrayDeque;
import java.util.Deque; import java.util.Deque;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** An output that can be hotplugged to an actual output. /** An output that can be hotplugged to an actual output.
* *

View File

@@ -1,8 +1,8 @@
/** /**
* gclc-socket:fr.bigeon.gclc.socket.RemoteDisconnectCommand.java * gclc-socket:net.bigeon.gclc.socket.RemoteDisconnectCommand.java
* Created on: Nov 18, 2017 * Created on: Nov 18, 2017
*/ */
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L
@@ -41,11 +41,11 @@ import java.io.IOException;
import java.text.MessageFormat; import java.text.MessageFormat;
import java.util.Collection; import java.util.Collection;
import fr.bigeon.gclc.command.Command; import net.bigeon.gclc.command.Command;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType; import net.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** A {@link Command} to disconnect elements from a {@link ConnexionManager}. /** A {@link Command} to disconnect elements from a {@link ConnexionManager}.
* *
@@ -109,7 +109,7 @@ public final class RemoteDisconnectCommand<T> extends Command {
} catch (final IOException e) { } catch (final IOException e) {
throw new CommandRunException( throw new CommandRunException(
CommandRunExceptionType.INTERACTION, CommandRunExceptionType.INTERACTION,
"Unable to print to existing output", e, this); //$NON-NLS-1$ "Unable to print to existing output", e); //$NON-NLS-1$
} }
} }
} }

View File

@@ -1,4 +1,4 @@
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L
@@ -41,7 +41,7 @@ import java.net.SocketException;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
import fr.bigeon.gclc.ConsoleApplication; import net.bigeon.gclc.ConsoleApplication;
/** This is a socket communicating console consoleManager. /** This is a socket communicating console consoleManager.
* <p> * <p>

View File

@@ -1,8 +1,8 @@
/** /**
* gclc-socket:fr.bigeon.gclc.socket.SocketConsoleInterface.java * gclc-socket:net.bigeon.gclc.socket.SocketConsoleInterface.java
* Created on: Nov 18, 2017 * Created on: Nov 18, 2017
*/ */
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L

View File

@@ -1,8 +1,8 @@
/** This package define a framework to access /** This package define a framework to access
* {@link fr.bigeon.gclc.ConsoleApplication} through a socket. * {@link net.bigeon.gclc.ConsoleApplication} through a socket.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%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,4 +1,4 @@
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L
@@ -37,14 +37,16 @@ import java.io.IOException;
import java.net.Socket; import java.net.Socket;
import java.util.Collection; import java.util.Collection;
import fr.bigeon.gclc.ConsoleApplication; import net.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.command.Command; import net.bigeon.gclc.command.Command;
import fr.bigeon.gclc.command.ExitCommand; import net.bigeon.gclc.command.HelpExecutor;
import fr.bigeon.gclc.command.HelpExecutor; import net.bigeon.gclc.command.base.ExitCommand;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.socket.ConnexionManager;
import net.bigeon.gclc.socket.RemoteDisconnectCommand;
/** A test-purpose application /** A test-purpose application
* *
@@ -95,8 +97,7 @@ public class ConsoleTestApplication {
try { try {
output.println("Test command ran fine"); output.println("Test command ran fine");
} catch (final IOException e) { } catch (final IOException e) {
throw new CommandRunException("manager closed", e, throw new CommandRunException("manager closed", e);
this);
} }
} }
@@ -129,8 +130,7 @@ public class ConsoleTestApplication {
Thread.sleep(2000); Thread.sleep(2000);
output.println("Test command ran fine"); output.println("Test command ran fine");
} catch (IOException | InterruptedException e) { } catch (IOException | InterruptedException e) {
throw new CommandRunException("manager closed", e, throw new CommandRunException("manager closed", e);
this);
} }
} }

View File

@@ -1,8 +1,8 @@
/** /**
* gclc-socket:fr.bigeon.gclc.socket.PluggableConsoleInputTest.java * gclc-socket:net.bigeon.gclc.socket.PluggableConsoleInputTest.java
* Created on: Nov 18, 2017 * Created on: Nov 18, 2017
*/ */
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L
@@ -49,6 +49,8 @@ import java.io.PrintStream;
import org.junit.Test; import org.junit.Test;
import net.bigeon.gclc.socket.PluggableConsoleInput;
/** /**
* <p> * <p>
* TODO * TODO
@@ -57,7 +59,7 @@ import org.junit.Test;
public class PluggableConsoleInputTest { public class PluggableConsoleInputTest {
/** Test method for /** Test method for
* {@link fr.bigeon.gclc.socket.PluggableConsoleInput#close()}. */ * {@link net.bigeon.gclc.socket.PluggableConsoleInput#close()}. */
@Test @Test
public final void testClose() { public final void testClose() {
final PluggableConsoleInput input = new PluggableConsoleInput(); final PluggableConsoleInput input = new PluggableConsoleInput();
@@ -191,7 +193,7 @@ public class PluggableConsoleInputTest {
} }
/** Test method for /** Test method for
* {@link fr.bigeon.gclc.socket.PluggableConsoleInput#getPrompt()}. */ * {@link net.bigeon.gclc.socket.PluggableConsoleInput#getPrompt()}. */
@Test @Test
public final void testGetPrompt() { public final void testGetPrompt() {
final PluggableConsoleInput input = new PluggableConsoleInput(); final PluggableConsoleInput input = new PluggableConsoleInput();

View File

@@ -1,8 +1,8 @@
/** /**
* gclc-socket:fr.bigeon.gclc.socket.RemoteDisconnectCommandTest.java * gclc-socket:net.bigeon.gclc.socket.RemoteDisconnectCommandTest.java
* Created on: Nov 18, 2017 * Created on: Nov 18, 2017
*/ */
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L
@@ -45,8 +45,10 @@ import java.io.IOException;
import org.junit.Test; import org.junit.Test;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.PipedConsoleOutput; import net.bigeon.gclc.socket.DConnexionManager;
import net.bigeon.gclc.socket.RemoteDisconnectCommand;
import net.bigeon.gclc.utils.PipedConsoleOutput;
/** /**
* <p> * <p>
@@ -56,7 +58,7 @@ import fr.bigeon.gclc.manager.PipedConsoleOutput;
public class RemoteDisconnectCommandTest { public class RemoteDisconnectCommandTest {
/** Test method for /** Test method for
* {@link fr.bigeon.gclc.socket.RemoteDisconnectCommand#execute(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[])}. * {@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 CommandRunException if the command unexpectedly failed.
* @throws IOException if the output could not be written to */ * @throws IOException if the output could not be written to */

View File

@@ -1,8 +1,8 @@
/** /**
* gclc-socket:fr.bigeon.gclc.socket.SocketConsoleApplicationTest.java * gclc-socket:net.bigeon.gclc.socket.SocketConsoleApplicationTest.java
* Created on: Jun 1, 2016 * Created on: Jun 1, 2016
*/ */
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L
@@ -48,6 +48,8 @@ import java.util.logging.Logger;
import org.junit.Test; import org.junit.Test;
import net.bigeon.gclc.socket.SocketConsoleApplicationShell;
/** Test class for {@link SocketConsoleApplicationShell} /** Test class for {@link SocketConsoleApplicationShell}
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */

View File

@@ -1,4 +1,4 @@
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L
@@ -41,7 +41,7 @@ import java.net.Socket;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collection; import java.util.Collection;
import fr.bigeon.smu.StringEncoder; import net.bigeon.smu.StringEncoder;
/** TODO Describe TestConsoleClient.java /** TODO Describe TestConsoleClient.java
* @author Emmanuel Bigeon * @author Emmanuel Bigeon

View File

@@ -1,4 +1,4 @@
package fr.bigeon.gclc.socket; package net.bigeon.gclc.socket;
/*- /*-
* #%L * #%L
@@ -38,7 +38,13 @@ import java.net.InetAddress;
import java.net.Socket; import java.net.Socket;
import java.net.UnknownHostException; import java.net.UnknownHostException;
import fr.bigeon.gclc.ConsoleApplication; import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.socket.ConnexionManager;
import net.bigeon.gclc.socket.DConnexionManager;
import net.bigeon.gclc.socket.PluggableConsoleInput;
import net.bigeon.gclc.socket.PluggableConsoleOutput;
import net.bigeon.gclc.socket.SocketConsoleApplicationShell;
import net.bigeon.gclc.socket.SocketConsoleInterface;
/** A test server /** A test server
* *

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,133 +1,103 @@
<!-- GCLC swt, provide a swt window for console applications --> <!-- GCLC swt, provide a swt window for console applications -->
<!-- Copyright (C) 2015-2017 E. Bigeon --> <!-- Copyright (C) 2015-2017 E. Bigeon -->
<!-- mailto:emmanuel@bigeon.fr --> <!-- mailto:emmanuel@bigeon.fr -->
<!-- --> <!-- -->
<!-- This software is governed by the CeCILL license under French law and --> <!-- This software is governed by the CeCILL license under French law and -->
<!-- abiding by the rules of distribution of free software. You can use, --> <!-- abiding by the rules of distribution of free software. You can use, -->
<!-- modify and/or redistribute the software under the terms of the CeCILL --> <!-- modify and/or redistribute the software under the terms of the CeCILL -->
<!-- license as circulated by CEA, CNRS and INRIA at the following URL --> <!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
<!-- "http://www.cecill.info". --> <!-- "http://www.cecill.info". -->
<!-- --> <!-- -->
<!-- As a counterpart to the access to the source code and rights to copy, --> <!-- As a counterpart to the access to the source code and rights to copy, -->
<!-- modify and redistribute granted by the license, users are provided only --> <!-- modify and redistribute granted by the license, users are provided only -->
<!-- with a limited warranty and the software's author, the holder of the --> <!-- with a limited warranty and the software's author, the holder of the -->
<!-- economic rights, and the successive licensors have only limited --> <!-- economic rights, and the successive licensors have only limited -->
<!-- liability. --> <!-- liability. -->
<!-- --> <!-- -->
<!-- In this respect, the user's attention is drawn to the risks associated --> <!-- In this respect, the user's attention is drawn to the risks associated -->
<!-- with loading, using, modifying and/or developing or reproducing the --> <!-- with loading, using, modifying and/or developing or reproducing the -->
<!-- software by the user in light of its specific status of free software, --> <!-- software by the user in light of its specific status of free software, -->
<!-- that may mean that it is complicated to manipulate, and that also --> <!-- that may mean that it is complicated to manipulate, and that also -->
<!-- therefore means that it is reserved for developers and experienced --> <!-- therefore means that it is reserved for developers and experienced -->
<!-- professionals having in-depth computer knowledge. Users are therefore --> <!-- professionals having in-depth computer knowledge. Users are therefore -->
<!-- encouraged to load and test the software's suitability as regards their --> <!-- encouraged to load and test the software's suitability as regards their -->
<!-- requirements in conditions enabling the security of their systems and/or --> <!-- requirements in conditions enabling the security of their systems and/or -->
<!-- data to be ensured and, more generally, to use and operate it in the --> <!-- data to be ensured and, more generally, to use and operate it in the -->
<!-- same conditions as regards security. --> <!-- same conditions as regards security. -->
<!-- --> <!-- -->
<!-- The fact that you are presently reading this means that you have had --> <!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. --> <!-- knowledge of the CeCILL license and that you accept its terms. -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<!-- Copyright E. Bigeon (2015) --> <modelVersion>4.0.0</modelVersion>
<!-- --> <groupId>net.bigeon.gclc</groupId>
<!-- emmanuel@bigeon.fr --> <artifactId>gclc-swt</artifactId>
<!-- --> <version>1.1.6-SNAPSHOT</version>
<!-- This software is a computer program whose purpose is to --> <packaging>jar</packaging>
<!-- provide a swt window for console applications. --> <inceptionYear>2015</inceptionYear>
<!-- --> <name>GCLC swt</name>
<!-- This software is governed by the CeCILL license under French law and --> <description>A swt window for console applications</description>
<!-- abiding by the rules of distribution of free software. You can use, -->
<!-- modify and/or redistribute the software under the terms of the CeCILL --> <parent>
<!-- license as circulated by CEA, CNRS and INRIA at the following URL --> <groupId>net.bigeon.config</groupId>
<!-- "http://www.cecill.info". --> <artifactId>swt-config</artifactId>
<!-- --> <version>1.8.7</version>
<!-- As a counterpart to the access to the source code and rights to copy, --> </parent>
<!-- modify and redistribute granted by the license, users are provided only -->
<!-- with a limited warranty and the software's author, the holder of the --> <properties>
<!-- economic rights, and the successive licensors have only limited --> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- liability. --> <copyright.email>emmanuel@bigeon.fr</copyright.email>
<!-- --> <license.licenseName>cecill_2.1</license.licenseName>
<!-- In this respect, the user's attention is drawn to the risks associated --> </properties>
<!-- with loading, using, modifying and/or developing or reproducing the -->
<!-- software by the user in light of its specific status of free software, --> <dependencies>
<!-- that may mean that it is complicated to manipulate, and that also --> <dependency>
<!-- therefore means that it is reserved for developers and experienced --> <groupId>net.bigeon</groupId>
<!-- professionals having in-depth computer knowledge. Users are therefore --> <artifactId>gclc</artifactId>
<!-- encouraged to load and test the software's suitability as regards their --> <version>2.0.7</version>
<!-- requirements in conditions enabling the security of their systems and/or --> </dependency>
<!-- data to be ensured and, more generally, to use and operate it in the --> <dependency>
<!-- same conditions as regards security. --> <groupId>net.bigeon</groupId>
<!-- --> <artifactId>collections</artifactId>
<!-- The fact that you are presently reading this means that you have had --> <version>1.1.1</version>
<!-- knowledge of the CeCILL license and that you accept its terms. --> </dependency>
</dependencies>
<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> <licenses>
<artifactId>gclc-swt</artifactId> <license>
<version>1.1.5-SNAPSHOT</version> <distribution>manual</distribution>
<packaging>jar</packaging> <name>CeCILL 2.1</name>
<url>http://www.bigeon.fr/emmanuel</url> <url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
<properties> </license>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </licenses>
<project.scm.id>git.bigeon.net</project.scm.id> <reporting>
</properties> <plugins>
<parent> <plugin>
<groupId>fr.bigeon.config</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>ebigeon-config</artifactId> <artifactId>maven-javadoc-plugin</artifactId>
<version>1.8.2</version> <version>2.10.3</version>
</parent> </plugin>
<dependencies> <plugin>
<dependency> <groupId>com.github.sevntu-checkstyle</groupId>
<groupId>fr.bigeon</groupId> <artifactId>dsm-maven-plugin</artifactId>
<artifactId>gclc</artifactId> <version>2.2.0</version>
<version>2.0.5</version> </plugin>
</dependency> </plugins>
<dependency> </reporting>
<groupId>fr.bigeon</groupId> <developers>
<artifactId>collections</artifactId> <developer>
<version>1.1.0</version> <email>emmanuel@bigeon.fr</email>
</dependency> <name>Emmanuel Bigeon</name>
</dependencies> <url>bigeon.net</url>
<inceptionYear>2015</inceptionYear> <roles>
<name>GCLC swt</name> <role>PM</role>
<description>provide a swt window for console applications</description> </roles>
<scm> </developer>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> </developers>
<tag>HEAD</tag>
</scm> <scm>
<profiles> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<profile> <tag>HEAD</tag>
<id>linux-deps</id> </scm>
<activation> </project>
<os>
<family>Linux</family>
</os>
</activation>
<dependencies>
<dependency>
<groupId>org.eclipse.swt</groupId>
<artifactId>org.eclipse.swt.gtk.linux.x86_64</artifactId>
<version>4.3</version>
</dependency>
</dependencies>
</profile>
<profile>
<id>windows-deps</id>
<activation>
<os>
<family>Windows</family>
</os>
</activation>
<dependencies>
<dependency>
<groupId>org.eclipse.swt</groupId>
<artifactId>org.eclipse.swt.win32.win32.x86_64</artifactId>
<version>4.3</version>
</dependency>
</dependencies>
</profile>
</profiles>
<groupId>fr.bigeon.gclc</groupId>
</project>

View File

@@ -1,57 +0,0 @@
/*
* GCLC swt, provide a swt window for console applications
* Copyright (C) 2015-2017 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
* gclc-swt:fr.bigeon.gclc.swt.ConsoleDelayIO.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.swt;
/** This class represents an object used to send commands to a console
* application.
* <p>
* The sending of command is done in two phases. Define the input through get
* and set, and then validate the input.
*
* @author Emmanuel Bigeon */
public interface ConsoleDelayIO {
/** Get the input text.
* @return the non validated input */
String getInput();
/** Set the input text.
*
* @param input the input to set */
void setInput(String input);
/** Actually send the input as the prompt next input. */
void validateInput();
}

View File

@@ -1,10 +1,7 @@
/* /*
* Copyright Bigeon Emmanuel (2014) * GCLC swt, provide a swt window for console applications
* * Copyright (C) 2015-2017 E. Bigeon
* emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
@@ -32,27 +29,17 @@
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/**
/** gclc:fr.bigeon.gclc.command.package-info.java * gclc-swt:net.bigeon.gclc.swt.ConsoleDelayIO.java
* Created on: Sep 6, 2014 */ * Created on: Nov 19, 2016
/** This package groups elements related to */
* {@link fr.bigeon.gclc.command.ICommand} package net.bigeon.gclc.swt;
* <p>
* There are some implementations, such as the
* {@link fr.bigeon.gclc.command.ParametrizedCommand} for commands with a
* predefined set of flags and option taking a string as value, the
* {@link fr.bigeon.gclc.command.SubedCommand} for a command that is declined in
* a set of sub commands, the {@link fr.bigeon.gclc.command.HelpExecutor} for
* help display of other commands and the
*
* @author Emmanuel BIGEON */
package fr.bigeon.gclc.command;
/*- /*-
* #%L * #%L
* Generic Command Ligne console * GCLC swt
* %% * %%
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2015 - 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,
@@ -81,3 +68,23 @@ package fr.bigeon.gclc.command;
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
* #L% * #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

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

View File

@@ -0,0 +1,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,108 +1,141 @@
/* /*
* GCLC swt, provide a swt window for console applications * GCLC swt, provide a swt window for console applications
* Copyright (C) 2015-2017 E. Bigeon * Copyright (C) 2015-2017 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-swt:fr.bigeon.gclc.swt.HistoryTextKeyListenerTest.java * gclc-swt:net.bigeon.gclc.swt.HistoryTextKeyListenerTest.java
* Created on: Nov 19, 2016 * Created on: Nov 19, 2016
*/ */
package fr.bigeon.gclc.swt; package net.bigeon.gclc.swt;
import static org.junit.Assert.assertEquals; /*-
* #%L
import org.eclipse.swt.SWT; * GCLC swt
import org.junit.Test; * %%
* Copyright (C) 2015 - 2018 Bigeon
/** <p> * %%
* TODO * This software is governed by the CeCILL license under French law and
* * abiding by the rules of distribution of free software. You can use,
* @author Emmanuel Bigeon */ * modify and/ or redistribute the software under the terms of the CeCILL
public class HistoryTextKeyListenerTest { * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
/** Test method for *
* {@link fr.bigeon.gclc.swt.HistoryTextKeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)}. */ * As a counterpart to the access to the source code and rights to copy,
@Test * modify and redistribute granted by the license, users are provided only
public final void testKeyPressedKeyEvent() { * with a limited warranty and the software's author, the holder of the
ConsoleDelayIO io = new ConsoleDelayIO() { * economic rights, and the successive licensors have only limited
private String input = ""; * liability.
*
@Override * In this respect, the user's attention is drawn to the risks associated
public void validateInput() { * with loading, using, modifying and/or developing or reproducing the
input = ""; * software 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
@Override * professionals having in-depth computer knowledge. Users are therefore
public void setInput(String input) { * encouraged to load and test the software's suitability as regards their
this.input = input; * requirements 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.
@Override *
public String getInput() { * The fact that you are presently reading this means that you have had
return input; * knowledge of the CeCILL license and that you accept its terms.
} * #L%
}; */
HistoryTextKeyListener listener = new HistoryTextKeyListener(io); import static org.junit.Assert.assertEquals;
// no effects import org.eclipse.swt.SWT;
assertEquals("", io.getInput()); import org.junit.Test;
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("", io.getInput()); /** <p>
listener.pressedKeyCode(SWT.ARROW_DOWN); * TODO
assertEquals("", io.getInput()); *
listener.pressedKeyCode('\r'); * @author Emmanuel Bigeon */
assertEquals("", io.getInput()); public class HistoryTextKeyListenerTest {
io.setInput("cmd arg"); /** Test method for
listener.pressedKeyCode(SWT.ARROW_UP); * {@link net.bigeon.gclc.swt.HistoryTextKeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)}. */
assertEquals("cmd arg", io.getInput()); @Test
listener.pressedKeyCode(SWT.ARROW_DOWN); public final void testKeyPressedKeyEvent() {
assertEquals("cmd arg", io.getInput()); ConsoleDelayIO io = new ConsoleDelayIO() {
listener.pressedKeyCode('\r'); private String input = "";
assertEquals("", io.getInput());
@Override
io.setInput("cmd arg2"); public void validateInput() {
listener.pressedKeyCode(SWT.ARROW_UP); input = "";
assertEquals("cmd arg", io.getInput()); }
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("", io.getInput()); @Override
io.setInput("cmd arg2"); public void setInput(String input) {
listener.pressedKeyCode('\r'); this.input = input;
assertEquals("", io.getInput()); }
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg2", io.getInput()); @Override
listener.pressedKeyCode(SWT.ARROW_UP); public String getInput() {
assertEquals("cmd arg", io.getInput()); return input;
listener.pressedKeyCode(SWT.ARROW_UP); }
assertEquals("cmd arg", io.getInput()); };
listener.pressedKeyCode(SWT.ARROW_DOWN); HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
assertEquals("cmd arg2", io.getInput());
} // no effects
assertEquals("", io.getInput());
} listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("", io.getInput());
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
io.setInput("cmd arg");
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
io.setInput("cmd arg2");
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("", io.getInput());
io.setInput("cmd arg2");
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg2", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("cmd arg2", io.getInput());
}
}

View File

@@ -1,333 +1,366 @@
/* /*
* GCLC swt, provide a swt window for console applications * GCLC swt, provide a swt window for console applications
* Copyright (C) 2015-2017 E. Bigeon * Copyright (C) 2015-2017 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-swt:fr.bigeon.gclc.swt.SWTConsoleShellTest.java * gclc-swt:net.bigeon.gclc.swt.SWTConsoleShellTest.java
* Created on: Jun 8, 2016 * Created on: Jun 8, 2016
*/ */
package fr.bigeon.gclc.swt; package net.bigeon.gclc.swt;
import static org.junit.Assert.assertFalse; /*-
import static org.junit.Assert.assertNotNull; * #%L
import static org.junit.Assert.assertTrue; * GCLC swt
import static org.junit.Assert.fail; * %%
* 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.widgets.Display; * abiding by the rules of distribution of free software. You can use,
import org.junit.Test; * 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 fr.bigeon.gclc.ConsoleApplication; * "http://www.cecill.info".
import fr.bigeon.gclc.command.Command; *
import fr.bigeon.gclc.command.ExitCommand; * As a counterpart to the access to the source code and rights to copy,
import fr.bigeon.gclc.exception.CommandRunException; * 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.manager.ConsoleInput; * economic rights, and the successive licensors have only limited
import fr.bigeon.gclc.manager.ConsoleOutput; * liability.
*
/** * 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 test() { * knowledge of the CeCILL license and that you accept its terms.
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY); * #L%
final SWTConsole swtConsole = shell.getManager(); */
try { import static org.junit.Assert.assertFalse;
final ConsoleApplication appl = new ConsoleApplication(swtConsole, import static org.junit.Assert.assertNotNull;
swtConsole, "Hello", "See you"); import static org.junit.Assert.assertTrue;
appl.add(new ExitCommand("exit", appl)); import static org.junit.Assert.fail;
appl.add(new Command("long") {
import java.io.IOException;
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc. import org.eclipse.swt.widgets.Display;
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, import org.junit.Test;
* java.lang.String[]) */
@Override import net.bigeon.gclc.ConsoleApplication;
public void execute(final ConsoleOutput out, import net.bigeon.gclc.command.Command;
final ConsoleInput in, import net.bigeon.gclc.command.base.ExitCommand;
final String... args) throws CommandRunException { import net.bigeon.gclc.exception.CommandRunException;
try { import net.bigeon.gclc.exception.InvalidCommandName;
Thread.sleep(TWO_SECONDS); import net.bigeon.gclc.manager.ConsoleInput;
} catch (final InterruptedException e) { import net.bigeon.gclc.manager.ConsoleOutput;
// TODO Auto-generated catch block
e.printStackTrace(); /**
} * <p>
} * TODO
*
@Override * @author Emmanuel Bigeon */
public String tip() { @SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"})
return "a long running command"; public class SWTConsoleShellTest {
}
protected static final long TWO_SECONDS = 2000;
/* (non-Javadoc) private static final Display DISPLAY = Display.getDefault();
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override @Test
protected String usageDetail() { public void test() {
// TODO Auto-generated method stub final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
// return null; final SWTConsole swtConsole = shell.getManager();
throw new RuntimeException("Not implemented yet"); try {
} final ConsoleApplication appl = new ConsoleApplication(swtConsole,
}); swtConsole, "Hello", "See you");
// shell.pack(); appl.add(new ExitCommand("exit", appl));
shell.open(); appl.add(new Command("long") {
final Thread applThread = new Thread(new Runnable() {
/* (non-Javadoc)
@Override * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
public void run() { * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
appl.start(); * java.lang.String[]) */
} @Override
}); public void execute(final ConsoleOutput out,
final Thread testThread = new Thread(new Runnable() { final ConsoleInput in,
final String... args) throws CommandRunException {
@Override try {
public void run() { Thread.sleep(TWO_SECONDS);
try { } catch (final 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
@Override public String tip() {
public void run() { return "a long running command";
swtConsole.setText("test"); //$NON-NLS-1$ }
swtConsole.validateCommand();
} /* (non-Javadoc)
}); * @see fr.bigeon.gclc.command.Command#usageDetail() */
try { @Override
Thread.sleep(TWO_SECONDS); protected String usageDetail() {
} catch (final InterruptedException e) { // TODO Auto-generated method stub
// TODO Auto-generated catch block // return null;
e.printStackTrace(); throw new RuntimeException("Not implemented yet");
} }
Display.getDefault().syncExec(new Runnable() { });
@Override // shell.pack();
public void run() { shell.open();
shell.dispose(); final Thread applThread = new Thread(new Runnable() {
}
}); @Override
} public void run() {
}); appl.start();
applThread.start(); }
testThread.start(); });
while (!shell.isDisposed()) { final Thread testThread = new Thread(new Runnable() {
if (!DISPLAY.readAndDispatch()) {
DISPLAY.sleep(); @Override
} public void run() {
} try {
// DISPLAY.dispose(); Thread.sleep(TWO_SECONDS);
assertTrue(swtConsole.isClosed()); } catch (final InterruptedException e) {
Thread.sleep(TWO_SECONDS); // TODO Auto-generated catch block
assertFalse(appl.isRunning()); e.printStackTrace();
} catch (final InvalidCommandName e) { }
// TODO Auto-generated catch block Display.getDefault().syncExec(new Runnable() {
e.printStackTrace(); @Override
} catch (final InterruptedException e) { public void run() {
// TODO Auto-generated catch block swtConsole.setText("test"); //$NON-NLS-1$
e.printStackTrace(); swtConsole.validateCommand();
} }
} });
try {
@Test Thread.sleep(TWO_SECONDS);
public void testConsoleClose() { } catch (final InterruptedException e) {
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY); // TODO Auto-generated catch block
final SWTConsole swtConsole = shell.getManager(); e.printStackTrace();
swtConsole.close(); }
swtConsole.setPrompt(":"); Display.getDefault().syncExec(new Runnable() {
try { @Override
final ConsoleApplication appl = new ConsoleApplication(swtConsole, public void run() {
swtConsole, "Hello", "See you"); shell.dispose();
appl.add(new ExitCommand("exit", appl)); }
appl.add(new Command("long") { });
/* (non-Javadoc) }
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc. });
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, applThread.start();
* java.lang.String[]) */ testThread.start();
@Override while (!shell.isDisposed()) {
public void execute(final ConsoleOutput out, if (!DISPLAY.readAndDispatch()) {
final ConsoleInput in, DISPLAY.sleep();
final String... args) throws CommandRunException { }
try { }
Thread.sleep(TWO_SECONDS); // DISPLAY.dispose();
} catch (final InterruptedException e) { assertTrue(swtConsole.isClosed());
// TODO Auto-generated catch block Thread.sleep(TWO_SECONDS);
e.printStackTrace(); assertFalse(appl.isRunning());
} } catch (final InvalidCommandName e) {
} // TODO Auto-generated catch block
e.printStackTrace();
@Override } catch (final InterruptedException e) {
public String tip() { // TODO Auto-generated catch block
return "a long running command"; e.printStackTrace();
} }
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */ @Test
@Override public void testConsoleClose() {
protected String usageDetail() { final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
// TODO Auto-generated method stub final SWTConsole swtConsole = shell.getManager();
// return null; swtConsole.close();
throw new RuntimeException("Not implemented yet"); swtConsole.setPrompt(":");
} try {
}); final ConsoleApplication appl = new ConsoleApplication(swtConsole,
appl.add(new Command("test") { swtConsole, "Hello", "See you");
/* (non-Javadoc) appl.add(new ExitCommand("exit", appl));
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc. appl.add(new Command("long") {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, /* (non-Javadoc)
* java.lang.String[]) */ * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
@Override * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
public void execute(final ConsoleOutput out, * java.lang.String[]) */
final ConsoleInput in, @Override
final String... args) throws CommandRunException { public void execute(final ConsoleOutput out,
try { final ConsoleInput in,
swtConsole.prompt("Test"); final String... args) throws CommandRunException {
} catch (final IOException e) { try {
throw new CommandRunException("No input", e, this); Thread.sleep(TWO_SECONDS);
} } catch (final InterruptedException e) {
} // TODO Auto-generated catch block
e.printStackTrace();
@Override }
public String tip() { }
return "a prompting running command";
} @Override
public String tip() {
/* (non-Javadoc) return "a long running command";
* @see fr.bigeon.gclc.command.Command#usageDetail() */ }
@Override
protected String usageDetail() { /* (non-Javadoc)
// TODO Auto-generated method stub * @see fr.bigeon.gclc.command.Command#usageDetail() */
// return null; @Override
throw new RuntimeException("Not implemented yet"); protected String usageDetail() {
} // TODO Auto-generated method stub
}); // return null;
// shell.pack(); throw new RuntimeException("Not implemented yet");
shell.open(); }
final Thread applThread = new Thread(new Runnable() { });
appl.add(new Command("test") {
@Override /* (non-Javadoc)
public void run() { * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
appl.start(); * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
} * java.lang.String[]) */
}); @Override
final Thread testThread = new Thread(new Runnable() { public void execute(final ConsoleOutput out,
final ConsoleInput in,
@Override final String... args) throws CommandRunException {
public void run() { try {
try { swtConsole.prompt("Test");
Thread.sleep(TWO_SECONDS); } catch (final IOException e) {
} catch (final InterruptedException e) { throw new CommandRunException("No input", e);
// TODO Auto-generated catch block }
e.printStackTrace(); }
}
Display.getDefault().syncExec(new Runnable() { @Override
@Override public String tip() {
public void run() { return "a prompting running command";
swtConsole.setText("test"); //$NON-NLS-1$ }
swtConsole.validateCommand();
} /* (non-Javadoc)
}); * @see fr.bigeon.gclc.command.Command#usageDetail() */
Display.getDefault().syncExec(new Runnable() { @Override
@Override protected String usageDetail() {
public void run() { // TODO Auto-generated method stub
swtConsole.setText("ok"); //$NON-NLS-1$ // return null;
} throw new RuntimeException("Not implemented yet");
}); }
swtConsole.validateCommand(); });
Display.getDefault().syncExec(new Runnable() { // shell.pack();
@Override shell.open();
public void run() { final Thread applThread = new Thread(new Runnable() {
swtConsole.setText("long"); //$NON-NLS-1$
} @Override
}); public void run() {
swtConsole.validateCommand(); appl.start();
Display.getDefault().syncExec(new Runnable() { }
@Override });
public void run() { final Thread testThread = new Thread(new Runnable() {
swtConsole.setText("test"); //$NON-NLS-1$
} @Override
}); public void run() {
swtConsole.validateCommand(); try {
Display.getDefault().syncExec(new Runnable() { Thread.sleep(TWO_SECONDS);
@Override } catch (final InterruptedException e) {
public void run() { // TODO Auto-generated catch block
swtConsole.setText("test"); //$NON-NLS-1$ e.printStackTrace();
} }
}); Display.getDefault().syncExec(new Runnable() {
swtConsole.validateCommand(); @Override
try { public void run() {
Thread.sleep(TWO_SECONDS); swtConsole.setText("test"); //$NON-NLS-1$
} catch (final InterruptedException e) { swtConsole.validateCommand();
// TODO Auto-generated catch block }
e.printStackTrace(); });
} Display.getDefault().syncExec(new Runnable() {
Display.getDefault().syncExec(new Runnable() { @Override
@Override public void run() {
public void run() { swtConsole.setText("ok"); //$NON-NLS-1$
shell.dispose(); }
} });
}); swtConsole.validateCommand();
Display.getDefault().syncExec(new Runnable() {
} @Override
}); public void run() {
applThread.start(); swtConsole.setText("long"); //$NON-NLS-1$
testThread.start(); }
while (!shell.isDisposed()) { });
if (!DISPLAY.readAndDispatch()) { swtConsole.validateCommand();
DISPLAY.sleep(); Display.getDefault().syncExec(new Runnable() {
} @Override
} public void run() {
swtConsole.setPrompt(">"); swtConsole.setText("test"); //$NON-NLS-1$
try { }
swtConsole.prompt(); });
fail("Prompting when closed should fail!"); swtConsole.validateCommand();
} catch (final IOException e) { Display.getDefault().syncExec(new Runnable() {
assertNotNull(e); @Override
} public void run() {
// DISPLAY.dispose(); swtConsole.setText("test"); //$NON-NLS-1$
assertTrue(swtConsole.isClosed()); }
Thread.sleep(TWO_SECONDS); });
assertFalse(appl.isRunning()); swtConsole.validateCommand();
} catch (final InvalidCommandName e) { try {
// TODO Auto-generated catch block Thread.sleep(TWO_SECONDS);
e.printStackTrace(); } catch (final InterruptedException e) {
} catch (final InterruptedException e) { // TODO Auto-generated catch block
// TODO Auto-generated catch block e.printStackTrace();
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,169 +1,202 @@
/* /*
* GCLC swt, provide a swt window for console applications * GCLC swt, provide a swt window for console applications
* Copyright (C) 2015-2017 E. Bigeon * Copyright (C) 2015-2017 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-swt:fr.bigeon.gclc.swt.SWTConsoleShellTest.java * gclc-swt:net.bigeon.gclc.swt.SWTConsoleShellTest.java
* Created on: Jun 8, 2016 * Created on: Jun 8, 2016
*/ */
package fr.bigeon.gclc.swt; package net.bigeon.gclc.swt;
import static org.junit.Assert.assertNull; /*-
* #%L
import java.io.IOException; * GCLC swt
* %%
import org.eclipse.swt.SWT; * 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
import org.junit.Test; * 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.command.Command; * "http://www.cecill.info".
import fr.bigeon.gclc.command.ExitCommand; *
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.InvalidCommandName; * 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
import fr.bigeon.gclc.manager.PipedConsoleInput; * liability.
import fr.bigeon.gclc.manager.PipedConsoleOutput; *
* 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 SWTConsoleViewTest { * 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 test() { * knowledge of the CeCILL license and that you accept its terms.
final Shell shell = new Shell(DISPLAY); * #L%
final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE); */
try (PipedConsoleOutput manager = new PipedConsoleOutput(); import static org.junit.Assert.assertNull;
PipedConsoleInput input = new PipedConsoleInput(System.out)) {
swtConsole.setManager(manager, input); import java.io.IOException;
} catch (final IOException e2) {
assertNull(e2); import org.eclipse.swt.SWT;
} import org.eclipse.swt.widgets.Display;
try (PipedConsoleOutput manager = new PipedConsoleOutput(); import org.eclipse.swt.widgets.Shell;
PipedConsoleInput input = new PipedConsoleInput(System.out)) { import org.junit.Test;
swtConsole.setManager(manager, input);
final ConsoleApplication appl = new ConsoleApplication(manager, import net.bigeon.gclc.ConsoleApplication;
input, import net.bigeon.gclc.command.Command;
"Hello", "See you"); import net.bigeon.gclc.command.base.ExitCommand;
appl.add(new ExitCommand("exit", appl)); import net.bigeon.gclc.exception.CommandRunException;
appl.add(new Command("long") { import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput;
/* (non-Javadoc) import net.bigeon.gclc.manager.ConsoleOutput;
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) import net.bigeon.gclc.utils.PipedConsoleInput;
*/ import net.bigeon.gclc.utils.PipedConsoleOutput;
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in, /** <p>
final String... args) throws CommandRunException { * TODO
try { *
Thread.sleep(TWO_SECONDS); * @author Emmanuel Bigeon */
} catch (final InterruptedException e) { @SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"})
// TODO Auto-generated catch block public class SWTConsoleViewTest {
e.printStackTrace();
} protected static final long TWO_SECONDS = 2000;
} private static final Display DISPLAY = Display.getDefault();
@Override @Test
public String tip() { public void test() {
return "a long running command"; final Shell shell = new Shell(DISPLAY);
} final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE);
try (PipedConsoleOutput manager = new PipedConsoleOutput();
/* (non-Javadoc) PipedConsoleInput input = new PipedConsoleInput(System.out)) {
* @see fr.bigeon.gclc.command.Command#usageDetail() */ swtConsole.setManager(manager, input);
@Override } catch (final IOException e2) {
protected String usageDetail() { assertNull(e2);
// TODO Auto-generated method stub }
// return null; try (PipedConsoleOutput manager = new PipedConsoleOutput();
throw new RuntimeException("Not implemented yet"); PipedConsoleInput input = new PipedConsoleInput(System.out)) {
} swtConsole.setManager(manager, input);
}); final ConsoleApplication appl = new ConsoleApplication(manager,
// shell.pack(); input,
shell.open(); "Hello", "See you");
final Thread applThread = new Thread(new Runnable() { appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
@Override
public void run() { /* (non-Javadoc)
appl.start(); * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[])
} */
}); @Override
final Thread testThread = new Thread(new Runnable() { public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
@Override try {
public void run() { Thread.sleep(TWO_SECONDS);
try { } catch (final 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
@Override public String tip() {
public void run() { return "a long running command";
swtConsole.setText("test"); //$NON-NLS-1$ }
swtConsole.validateInput();
} /* (non-Javadoc)
}); * @see fr.bigeon.gclc.command.Command#usageDetail() */
try { @Override
Thread.sleep(TWO_SECONDS); protected String usageDetail() {
} catch (final InterruptedException e) { // TODO Auto-generated method stub
// TODO Auto-generated catch block // return null;
e.printStackTrace(); throw new RuntimeException("Not implemented yet");
} }
Display.getDefault().syncExec(new Runnable() { });
@Override // shell.pack();
public void run() { shell.open();
shell.dispose(); final Thread applThread = new Thread(new Runnable() {
}
}); @Override
} public void run() {
}); appl.start();
applThread.start(); }
testThread.start(); });
while (!shell.isDisposed()) { final Thread testThread = new Thread(new Runnable() {
if (!DISPLAY.readAndDispatch()) {
DISPLAY.sleep(); @Override
} public void run() {
} try {
} catch (final InvalidCommandName e) { Thread.sleep(TWO_SECONDS);
// TODO Auto-generated catch block } catch (final InterruptedException e) {
e.printStackTrace(); // TODO Auto-generated catch block
} catch (final IOException e1) { e.printStackTrace();
// TODO Auto-generated catch block }
e1.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,70 @@
<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>junit</groupId>
<version>4.11</version> <artifactId>junit</artifactId>
<scope>test</scope> <version>4.11</version>
</dependency> <scope>test</scope>
<dependency> </dependency>
<groupId>fr.bigeon</groupId> <dependency>
<artifactId>gclc</artifactId> <groupId>net.bigeon</groupId>
<version>2.0.0</version> <artifactId>gclc</artifactId>
</dependency> <version>2.0.7</version>
</dependencies> </dependency>
<name>GCLC system command</name> </dependencies>
<description>Provide an exec command to execute system commands</description> <name>GCLC system command</name>
<inceptionYear>2016</inceptionYear> <description>Provide an exec command to execute system commands</description>
<scm> <inceptionYear>2016</inceptionYear>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag> <licenses>
</scm> <license>
<parent> <distribution>manual</distribution>
<groupId>fr.bigeon</groupId> <name>CeCILL 2.1</name>
<artifactId>ebigeon-config</artifactId> <url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
<version>1.7.1</version> </license>
</parent> </licenses>
</project> <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>
<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.9</version>
</parent>
</project>

View File

@@ -1,148 +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.ConsoleInput; *
import fr.bigeon.gclc.manager.ConsoleOutput; * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
/** A command that will execute a system command. * with a limited warranty and the software's author, the holder of the
* * economic rights, and the successive licensors have only limited
* @author Emmanuel Bigeon */ * liability.
public class ExecSystemCommand extends Command { *
* In this respect, the user's attention is drawn to the risks associated
/** The command default name */ * with loading, using, modifying and/or developing or reproducing the
private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$ * software by the user in light of its specific status of free software,
/** The end of line separator */ * that may mean that it is complicated to manipulate, and that also
private static final String EOL = System.lineSeparator(); * therefore means that it is reserved for developers and experienced
/** The class logger */ * professionals having in-depth computer knowledge. Users are therefore
private static final Logger LOGGER = Logger * encouraged to load and test the software's suitability as regards their
.getLogger(ExecSystemCommand.class.getName()); * requirements 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.
public ExecSystemCommand() { *
super(COMMAND_DEFAULT_NAME); * 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%
/** @param name the name of the command (the input from the manager that */
* should trigger this command) */ import java.io.BufferedWriter;
public ExecSystemCommand(final String name) { import java.io.IOException;
super(name); import java.io.InputStream;
} import java.io.OutputStream;
import java.io.OutputStreamWriter;
/* (non-Javadoc) import java.util.logging.Level;
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager. import java.util.logging.Logger;
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */ import net.bigeon.gclc.command.Command;
@Override import net.bigeon.gclc.exception.CommandRunException;
public void execute(final ConsoleOutput out, final ConsoleInput in, import net.bigeon.gclc.exception.CommandRunExceptionType;
final String... args) throws CommandRunException { import net.bigeon.gclc.manager.ConsoleInput;
Process proc; import net.bigeon.gclc.manager.ConsoleOutput;
try {
proc = Runtime.getRuntime().exec(args); /** A command that will execute a system command.
} catch (final IOException e2) { *
LOGGER.log(Level.SEVERE, "Unable to run process", e2); //$NON-NLS-1$ * @author Emmanuel Bigeon */
return; public class ExecSystemCommand extends Command {
}
/** 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 */
final 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 { /***/
readToEnd(out, is); public ExecSystemCommand() {
is.close(); super(COMMAND_DEFAULT_NAME);
} catch (final CommandRunException e) { }
LOGGER.log(Level.WARNING,
"Manager was closed in the meantime...", e); //$NON-NLS-1$ /** @param name the name of the command (the input from the manager that
} catch (final IOException e) { * should trigger this command) */
LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$ public ExecSystemCommand(final String name) {
} super(name);
} }
});
th.start(); /* (non-Javadoc)
in.setPrompt(""); //$NON-NLS-1$ * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
final OutputStream os = proc.getOutputStream(); * ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
try (BufferedWriter writer = new BufferedWriter( * java.lang.String[]) */
new OutputStreamWriter(os))) { @Override
while (th.isAlive()) { public void execute(final ConsoleOutput out, final ConsoleInput in,
String user; final String... args) throws CommandRunException {
try { Process proc;
user = in.prompt(); try {
} catch (final IOException e) { proc = Runtime.getRuntime().exec(args);
throw new CommandRunException( } catch (final IOException e2) {
CommandRunExceptionType.INTERACTION, LOGGER.log(Level.SEVERE, "Unable to run process", e2); //$NON-NLS-1$
"manager was closed", e, this); //$NON-NLS-1$ return;
} }
writer.write(user + EOL);
} final InputStream is = proc
} catch (final IOException e1) { .getInputStream();
throw new CommandRunException(CommandRunExceptionType.INTERACTION, final Thread th = new Thread(new Runnable() {
"manager was closed", e1, this); //$NON-NLS-1$
} @SuppressWarnings("synthetic-access")
} @Override
public void run() {
/** @param is the input stream try {
* @throws CommandRunException if the manager was closed while writing the readToEnd(out, is);
* stream */ is.close();
protected void readToEnd(final ConsoleOutput out, } catch (final CommandRunException e) {
final InputStream is) throws CommandRunException { LOGGER.log(Level.WARNING,
int c; "Manager was closed in the meantime...", e); //$NON-NLS-1$
try { } catch (final IOException e) {
while ((c = is.read()) != -1) { LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$
try { }
out.print(Character.valueOf((char) c).toString()); }
} catch (final IOException e) { });
throw new CommandRunException( th.start();
CommandRunExceptionType.INTERACTION, in.setPrompt(""); //$NON-NLS-1$
"manager was closed", e, this); //$NON-NLS-1$ final OutputStream os = proc.getOutputStream();
} try (BufferedWriter writer = new BufferedWriter(
} new OutputStreamWriter(os))) {
} catch (final IOException e) { while (th.isAlive()) {
LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$ String user;
} try {
} user = in.prompt();
} catch (final IOException e) {
/* (non-Javadoc) throw new CommandRunException(
* @see fr.bigeon.gclc.command.ICommand#tip() */ CommandRunExceptionType.INTERACTION,
@Override "manager was closed", e); //$NON-NLS-1$
public String tip() { }
return "Execute a system command"; //$NON-NLS-1$ writer.write(user + EOL);
} }
} catch (final IOException e1) {
/* (non-Javadoc) throw new CommandRunException(CommandRunExceptionType.INTERACTION,
* @see fr.bigeon.gclc.command.Command#usageDetail() */ "manager was closed", e1); //$NON-NLS-1$
@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$ /** @param is the input stream
System.lineSeparator() + System.lineSeparator() + * @throws CommandRunException if the manager was closed while writing the
" As an example if you give \"cat /etc/hostname\" as argument, on a linux" + //$NON-NLS-1$ * stream */
System.lineSeparator() + protected void readToEnd(final ConsoleOutput out,
"system, you would get the computer name." + //$NON-NLS-1$ final InputStream is) throws CommandRunException {
System.lineSeparator(); int c;
} try {
while ((c = is.read()) != -1) {
/* (non-Javadoc) try {
* @see fr.bigeon.gclc.command.Command#usagePattern() */ out.print(Character.valueOf((char) c).toString());
@Override } catch (final IOException e) {
protected String usagePattern() { throw new CommandRunException(
return " CMD <system command>"; //$NON-NLS-1$ CommandRunExceptionType.INTERACTION,
} "manager was closed", e); //$NON-NLS-1$
}
} }
} catch (final IOException e) {
LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Execute a system command"; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return " The system command is a system dependend command like sh on linux or" + //$NON-NLS-1$
System.lineSeparator() + "powershell on windows." + //$NON-NLS-1$
System.lineSeparator() + System.lineSeparator() +
" As an example if you give \"cat /etc/hostname\" as argument, on a linux" + //$NON-NLS-1$
System.lineSeparator() +
"system, you would get the computer name." + //$NON-NLS-1$
System.lineSeparator();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */
@Override
protected String usagePattern() {
return " CMD <system command>"; //$NON-NLS-1$
}
}

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

@@ -2,9 +2,9 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<artifactId>gclc</artifactId> <artifactId>gclc</artifactId>
<version>2.0.6</version> <version>2.0.9</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<url>http://www.bigeon.net</url> <url>http://bigeon.net</url>
<properties> <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.scm.id>git.code.bigeon.net</project.scm.id> <project.scm.id>git.code.bigeon.net</project.scm.id>
@@ -22,7 +22,7 @@
<parent> <parent>
<groupId>net.bigeon.config</groupId> <groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId> <artifactId>ebigeon-config</artifactId>
<version>1.8.3</version> <version>1.8.11</version>
</parent> </parent>
<build> <build>
<plugins> <plugins>
@@ -47,16 +47,16 @@
</licenses> </licenses>
<reporting> <reporting>
<plugins> <plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
</plugin>
<plugin> <plugin>
<groupId>com.github.sevntu-checkstyle</groupId> <groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>dsm-maven-plugin</artifactId> <artifactId>dsm-maven-plugin</artifactId>
<version>2.2.0</version> <version>2.2.0</version>
</plugin> </plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jdepend-maven-plugin</artifactId>
<version>2.0</version>
</plugin>
</plugins> </plugins>
</reporting> </reporting>
<developers> <developers>
@@ -74,7 +74,7 @@
<description>A generic framework for console applications, with customized command input and output streams.</description> <description>A generic framework for console applications, with customized command input and output streams.</description>
<scm> <scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>gclc-2.0.6</tag> <tag>gclc-2.0.9</tag>
</scm> </scm>
<groupId>net.bigeon</groupId> <groupId>net.bigeon</groupId>
</project> </project>

View File

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

View File

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

View File

@@ -1,27 +1,27 @@
/** /**
* gclc:fr.bigeon.gclc.ApplicationAttachement.java * gclc:net.bigeon.gclc.ApplicationAttachement.java
* Created on: Apr 19, 2017 * Created on: Apr 19, 2017
*/ */
package fr.bigeon.gclc; package net.bigeon.gclc;
/*- /*-
* #%L * #%L
* Generic Command Ligne console * Generic Command Ligne console
* %% * %%
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -29,16 +29,17 @@ package fr.bigeon.gclc;
* 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% * #L%
*/ */
import fr.bigeon.gclc.command.ICommandProvider;
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.
* *
@@ -50,7 +51,7 @@ public interface ApplicationAttachement {
* application. The attached command should be specific to the attachement * application. The attached command should be specific to the attachement
* (typically, the generic help command or the script command should not be * (typically, the generic help command or the script command should not be
* added through this mechanism). * added through this mechanism).
* *
* @param application the application * @param application the application
* @throws InvalidCommandName if a command name is invalid for the * @throws InvalidCommandName if a command name is invalid for the
* application. */ * application. */

View File

@@ -1,8 +1,8 @@
/** /**
* gclc:fr.bigeon.gclc.CommandRequestListener.java * gclc:net.bigeon.gclc.CommandRequestListener.java
* Created on: Mar 19, 2015 * Created on: Mar 19, 2015
*/ */
package fr.bigeon.gclc; package net.bigeon.gclc;
/*- /*-
* #%L * #%L
@@ -11,17 +11,17 @@ package fr.bigeon.gclc;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -29,10 +29,10 @@ package fr.bigeon.gclc;
* 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% * #L%

View File

@@ -32,9 +32,9 @@
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** gclc:fr.bigeon.gclc.ConsoleApplication.java /** gclc:net.bigeon.gclc.ConsoleApplication.java
* Created on: Sep 6, 2014 */ * Created on: Sep 6, 2014 */
package fr.bigeon.gclc; package net.bigeon.gclc;
/*- /*-
* #%L * #%L
@@ -43,17 +43,17 @@ package fr.bigeon.gclc;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -61,42 +61,42 @@ package fr.bigeon.gclc;
* 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% * #L%
*/ */
import java.io.IOException; import java.io.IOException;
import java.io.InterruptedIOException; import java.io.InterruptedIOException;
import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.List; import java.util.List;
import java.util.Set;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
import fr.bigeon.gclc.command.ICommand; import net.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.command.ICommandProvider; import net.bigeon.gclc.command.ICommandProvider;
import fr.bigeon.gclc.command.SubedCommand; import net.bigeon.gclc.command.SubedCommand;
import fr.bigeon.gclc.exception.CommandParsingException; import net.bigeon.gclc.exception.CommandParsingException;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType; import net.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.i18n.Messages; import net.bigeon.gclc.i18n.Messages;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** /** A {@link ConsoleApplication} is an application that require the user to
* A {@link ConsoleApplication} is an application that require the user to input * input commands.
* commands.
* <p> * <p>
* A typical use case is the following: * A typical use case is the following:
* *
* <pre> * <pre>
* {@link ConsoleOutput} out = new {@link fr.bigeon.gclc.utils.StreamConsoleOutput StreamConsoleOutput}(); * {@link ConsoleOutput} out = new {@link net.bigeon.gclc.utils.StreamConsoleOutput StreamConsoleOutput}();
* {@link ConsoleInput} in = new {@link fr.bigeon.gclc.utils.StreamConsoleInput StreamConsoleInput}(); * {@link ConsoleInput} in = new {@link net.bigeon.gclc.utils.StreamConsoleInput StreamConsoleInput}();
* {@link ConsoleApplication} app = new {@link ConsoleApplication}(out, in, "welcome", "see you latter")}; * {@link ConsoleApplication} app = new {@link ConsoleApplication}(out, in, "welcome", "see you latter")};
* app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()}); * app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()});
* app.{@link ConsoleApplication#start() start()}; * app.{@link ConsoleApplication#start() start()};
@@ -111,22 +111,22 @@ import fr.bigeon.gclc.manager.ConsoleOutput;
public final class ConsoleApplication implements ICommandProvider { public final class ConsoleApplication implements ICommandProvider {
/** The class logger. */ /** The class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(ConsoleApplication.class.getName()); .getLogger(ConsoleApplication.class.getName());
/** The welcome message. */ /** The welcome message. */
public final String header; public final String header;
/** The good bye message. */ /** The good bye message. */
public final String footer; public final String footer;
/** The standard output for the application. */ /** The standard output for the application. */
private final ConsoleOutput out; private final ConsoleOutput out;
/** The standard input for the application. */ /** The standard input for the application. */
private final ConsoleInput in; private final ConsoleInput in;
/** The container of commands. */ /** The container of commands. */
public final SubedCommand root; public final SubedCommand root;
/** The state of this application. */ /** The state of this application. */
private boolean running; private boolean running;
/** The listeners. */ /** The listeners. */
private final List<CommandRequestListener> listeners = new ArrayList<>(); private final Set<CommandRequestListener> listeners = new LinkedHashSet<>();
/** Create a console application. /** Create a console application.
* *
@@ -135,8 +135,7 @@ public final class ConsoleApplication implements ICommandProvider {
* @param welcome the welcoming message * @param welcome the welcoming message
* @param goodbye the goodbye message */ * @param goodbye the goodbye message */
public ConsoleApplication(final ConsoleOutput out, final ConsoleInput in, public ConsoleApplication(final ConsoleOutput out, final ConsoleInput in,
final String welcome, final String welcome, final String goodbye) {
final String goodbye) {
header = welcome; header = welcome;
footer = goodbye; footer = goodbye;
this.in = in; this.in = in;
@@ -157,12 +156,11 @@ public final class ConsoleApplication implements ICommandProvider {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommandProvider#executeSub(java.lang.String, * @see net.bigeon.gclc.command.ICommandProvider#executeSub(java.lang.String,
* java.lang.String[]) */ * java.lang.String[]) */
@Override @Override
public void executeSub(final ConsoleOutput output, final ConsoleInput input, public void executeSub(final ConsoleOutput output, final ConsoleInput input,
final String command, final String command, final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
root.executeSub(output, input, command, args); root.executeSub(output, input, command, args);
} }
@@ -174,7 +172,7 @@ public final class ConsoleApplication implements ICommandProvider {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */ * @see net.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */
@Override @Override
public ICommand get(final String command) { public ICommand get(final String command) {
return root.get(command); return root.get(command);
@@ -182,8 +180,8 @@ public final class ConsoleApplication implements ICommandProvider {
/** Interpret a command line. /** Interpret a command line.
* <p> * <p>
* This method will split the command in its part and execute the command * This method will split the command in its part and execute the command with
* with {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}. * {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}.
* *
* @param cmd the command * @param cmd the command
* @throws IOException if the command could not be parsed */ * @throws IOException if the command could not be parsed */
@@ -191,19 +189,18 @@ public final class ConsoleApplication implements ICommandProvider {
List<String> args; List<String> args;
try { try {
args = GCLCConstants.splitCommand(cmd); args = GCLCConstants.splitCommand(cmd);
} catch (final CommandParsingException e1) { } catch (final CommandParsingException e) {
out.println("Command line cannot be parsed"); //$NON-NLS-1$ out.println("Command line cannot be parsed"); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Invalid user command " + cmd, e1); //$NON-NLS-1$ LOGGER.log(Level.FINE, "Invalid user command " + cmd, e); //$NON-NLS-1$
return; return;
} }
if (!args.isEmpty()) { if (!args.isEmpty()) {
try { try {
executeSub(out, in, args.get(0), Arrays.copyOfRange( executeSub(out, in, args.get(0),
args.toArray(new String[0]), 1, args.size())); Arrays.copyOfRange(args.toArray(new String[0]), 1, args.size()));
} catch (final CommandRunException e) { } catch (final CommandRunException e) {
LOGGER.log(Level.FINE, "Command failed: " + cmd, e); //$NON-NLS-1$ LOGGER.log(Level.FINE, "Command failed: " + cmd, e); //$NON-NLS-1$
out.println(Messages out.println(Messages.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
out.println(e.getLocalizedMessage()); out.println(e.getLocalizedMessage());
if (e.getType() == CommandRunExceptionType.USAGE) { if (e.getType() == CommandRunExceptionType.USAGE) {
get(args.get(0)).help(out); get(args.get(0)).help(out);
@@ -228,8 +225,8 @@ public final class ConsoleApplication implements ICommandProvider {
/** The running loop content. /** The running loop content.
* <p> * <p>
* This consisting in getting the command, executing it and exiting * This consisting in getting the command, executing it and exiting (restarting
* (restarting the loop). */ * the loop). */
private void runLoop() { private void runLoop() {
try { try {
final String cmd = in.prompt(); final String cmd = in.prompt();
@@ -241,8 +238,7 @@ public final class ConsoleApplication implements ICommandProvider {
} }
interpretCommand(cmd); interpretCommand(cmd);
} catch (final InterruptedIOException e) { } catch (final InterruptedIOException e) {
LOGGER.info( LOGGER.info("Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
"Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
LOGGER.log(Level.FINER, "Interruption of the prompt.", //$NON-NLS-1$ LOGGER.log(Level.FINER, "Interruption of the prompt.", //$NON-NLS-1$
e); e);
} catch (final IOException e) { } catch (final IOException e) {
@@ -250,8 +246,7 @@ public final class ConsoleApplication implements ICommandProvider {
running = false; running = false;
LOGGER.warning( LOGGER.warning(
"The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$ "The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
LOGGER.log(Level.FINE, LOGGER.log(Level.FINE, "An exception caused the closing of the application", //$NON-NLS-1$
"An exception caused the closing of the application", //$NON-NLS-1$
e); e);
} }
} }
@@ -268,8 +263,7 @@ public final class ConsoleApplication implements ICommandProvider {
running = false; running = false;
LOGGER.warning( LOGGER.warning(
"The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$ "The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
LOGGER.log(Level.FINE, LOGGER.log(Level.FINE, "An exception caused the closing of the application", //$NON-NLS-1$
"An exception caused the closing of the application", //$NON-NLS-1$
e); e);
return; return;
} }
@@ -282,7 +276,7 @@ public final class ConsoleApplication implements ICommandProvider {
} catch (final IOException e) { } catch (final IOException e) {
// The manager was closed // The manager was closed
running = false; running = false;
LOGGER.warning("Console manager alreaady closed."); //$NON-NLS-1$ LOGGER.warning("Console manager already closed."); //$NON-NLS-1$
LOGGER.log(Level.FINE, LOGGER.log(Level.FINE,
"Exception raised by goodbye message printing... Application will still close.", //$NON-NLS-1$ "Exception raised by goodbye message printing... Application will still close.", //$NON-NLS-1$
e); e);

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.GCLCConstants.java * gclc:net.bigeon.gclc.GCLCConstants.java
* Created on: Jun 8, 2016 * Created on: Jun 8, 2016
*/ */
package fr.bigeon.gclc; package net.bigeon.gclc;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc;
* 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% * #L%
@@ -74,7 +74,7 @@ package fr.bigeon.gclc;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import fr.bigeon.gclc.exception.CommandParsingException; import net.bigeon.gclc.exception.CommandParsingException;
/** A Utility class for GCLC /** A Utility class for GCLC
* <p> * <p>
@@ -85,7 +85,7 @@ import fr.bigeon.gclc.exception.CommandParsingException;
public final class GCLCConstants { public final class GCLCConstants {
/** The escaping character. */ /** The escaping character. */
private static final char ESCAPING_CHAR = getSystemEscapingChar(); private static final char ESCAPING_CHAR = '\\';
/** Hide utility class constructor. */ /** Hide utility class constructor. */
private GCLCConstants() { private GCLCConstants() {
@@ -99,22 +99,15 @@ public final class GCLCConstants {
* @param index the index of the current position * @param index the index of the current position
* @return the argument * @return the argument
* @throws CommandParsingException if the end of string does not mark end of * @throws CommandParsingException if the end of string does not mark end of
* command and is not followed by a space */ * command and is not followed by a space */
private static String endOfString(final String cmd, final int startIndex, private static String endOfString(final String cmd, final int startIndex,
final int index) throws CommandParsingException { final int index) throws CommandParsingException {
if (index < cmd.length() && cmd.charAt(index) != ' ') { if (index < cmd.length() && cmd.charAt(index) != ' ') {
throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$ throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$
} }
return cmd.substring(startIndex + 1, index - 1); return cmd.substring(startIndex + 1, index - 1);
} }
/** Get the excaping character.
*
* @return the escaping character */
private static char getSystemEscapingChar() {
return '\\';
}
/** Remove escaping characters from the string. /** Remove escaping characters from the string.
* *
* @param arg the string to remove excaping character from * @param arg the string to remove excaping character from
@@ -137,7 +130,8 @@ public final class GCLCConstants {
* @param cmd the command to split in its parts * @param cmd the command to split in its parts
* @return the list of argument preceded by the command name * @return the list of argument preceded by the command name
* @throws CommandParsingException if the parsing of the command failed */ * @throws CommandParsingException if the parsing of the command failed */
public static List<String> splitCommand(final String cmd) throws CommandParsingException { public static List<String> splitCommand(final String cmd)
throws CommandParsingException {
final List<String> args = new ArrayList<>(); final List<String> args = new ArrayList<>();
// parse the string to separate arguments // parse the string to separate arguments
int index = 0; int index = 0;
@@ -164,6 +158,8 @@ public final class GCLCConstants {
startIndex = index; startIndex = index;
} }
inString = startIndex == index - 1; inString = startIndex == index - 1;
} else {
// No special processing
} }
} }
if (startIndex < cmd.length()) { if (startIndex < cmd.length()) {

View File

@@ -2,7 +2,7 @@
* acide:fr.bigeon.acide.Command.java * acide:fr.bigeon.acide.Command.java
* Created on: Jul 31, 2014 * Created on: Jul 31, 2014
*/ */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
/*- /*-
* #%L * #%L
@@ -11,17 +11,17 @@ package fr.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -29,17 +29,17 @@ package fr.bigeon.gclc.command;
* 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% * #L%
*/ */
import java.io.IOException; import java.io.IOException;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** A command to execute. /** A command to execute.
* <p> * <p>
@@ -68,7 +68,7 @@ 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.
* *
@@ -80,8 +80,8 @@ public abstract class Command implements ICommand {
/** Get the brief part of the command help. /** Get the brief part of the command help.
* <p> * <p>
* This method may be overriden by implementations to improve the help * This method may be overriden by implementations to improve the help content.
* content. The default behavior is to print the tip. * 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...) */
@@ -90,7 +90,7 @@ public abstract class Command implements ICommand {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ * @see net.bigeon.gclc.command.ICommand#getCommandName() */
@Override @Override
public final String getCommandName() { public final String getCommandName() {
return name; return name;
@@ -110,10 +110,10 @@ public abstract class Command implements ICommand {
* [Usage details] * [Usage details]
* </pre> * </pre>
* *
* @see fr.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */ * @see net.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */
@Override @Override
public final void help(final ConsoleOutput manager, public final void help(final ConsoleOutput manager, final String... args)
final String... args) throws IOException { throws IOException {
manager.println(getCommandName()); manager.println(getCommandName());
manager.println(brief()); manager.println(brief());
manager.println(); manager.println();
@@ -123,8 +123,8 @@ public abstract class Command implements ICommand {
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();
} }
} }

View File

@@ -1,8 +1,8 @@
/** /**
* gclc:fr.bigeon.gclc.command.CommandParameters.java * gclc:net.bigeon.gclc.command.CommandParameters.java
* Created on: Dec 24, 2014 * Created on: Dec 24, 2014
*/ */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
/*- /*-
* #%L * #%L
@@ -11,17 +11,17 @@ package fr.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -29,10 +29,10 @@ package fr.bigeon.gclc.command;
* 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% * #L%
@@ -43,8 +43,9 @@ 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>
@@ -53,15 +54,15 @@ import fr.bigeon.gclc.exception.CommandParsingException;
* @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.
* *
@@ -69,10 +70,13 @@ public final class CommandParameters {
* @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) {
booleanArguments = new ConcurrentHashMap<>(bools.size());
for (final String string : bools) { for (final String string : bools) {
booleanArguments.put(string, Boolean.FALSE); booleanArguments.put(string, Boolean.FALSE);
} }
// Cannot use concurrent because of the null values.
stringArguments = new HashMap<>(strings.size());
for (final String string : strings) { for (final String string : strings) {
stringArguments.put(string, null); stringArguments.put(string, null);
} }
@@ -98,9 +102,9 @@ public final class CommandParameters {
* *
* @param key the key * @param key the key
* @return if the key was specified */ * @return if the key was specified */
public boolean getBool(final String key) { public boolean isActive(final String key) {
return booleanArguments.containsKey(key) && Boolean val = booleanArguments.get(key);
booleanArguments.get(key).booleanValue(); return val != null && val.booleanValue();
} }
/** Get the boolean arguments. /** Get the boolean arguments.
@@ -122,14 +126,13 @@ public final class CommandParameters {
* @param key the key * @param key the key
* @return if the key is present in string arguments or boolean ones. */ * @return if the key is present in string arguments or boolean ones. */
public boolean hasArgument(final String key) { public boolean hasArgument(final String key) {
return stringArguments.containsKey(key) || return stringArguments.containsKey(key) || booleanArguments.containsKey(key);
booleanArguments.containsKey(key);
} }
/** Attempt to parse an argument. /** Attempt to parse an argument.
* <p> * <p>
* This method return 0 if the parsing was incorrect, or the number of * This method return 0 if the parsing was incorrect, or the number of parsed
* parsed elements. * elements.
* *
* @param arg the argument * @param arg the argument
* @param next the next element * @param next the next element
@@ -170,8 +173,7 @@ public final class CommandParameters {
} }
final int p = parseArg(args[i], next); final int p = parseArg(args[i], next);
if (p == 0) { if (p == 0) {
throw new CommandParsingException( throw new CommandParsingException("Invalid parameter " + args[i]); //$NON-NLS-1$
"Invalid parameter " + args[i]); //$NON-NLS-1$
} }
i += p; i += p;
} }

View File

@@ -1,6 +1,6 @@
/** acide:fr.bigeon.acide.CommandProvider.java /** acide:fr.bigeon.acide.CommandProvider.java
* Created on: Aug 6, 2014 */ * Created on: Aug 6, 2014 */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
/*- /*-
* #%L * #%L
@@ -9,17 +9,17 @@ package fr.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -27,54 +27,47 @@ package fr.bigeon.gclc.command;
* 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% * #L%
*/ */
import java.util.ArrayList; import java.util.LinkedHashSet;
import java.util.List; import java.util.Set;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.i18n.Messages; import net.bigeon.gclc.i18n.Messages;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** A command provider is a map of key word to command to execute. /** A command provider is a map of key word to command to execute.
* *
* @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. */
protected final List<ICommand> commands; /** The commands set.
* <p>
* The insertion order is conserved through the use of a
* {@link LinkedHashSet}. */
protected final Set<ICommand> commands;
/** Create a command provider. */ /** Create a command provider. */
public CommandProvider() { public CommandProvider() {
super(); super();
commands = new ArrayList<>(); commands = new LinkedHashSet<>();
}
/** Test the command name validity.
*
* @param name the command name
* @throws InvalidCommandName if the name is invalid */
private static void testCommandName(final String name) throws InvalidCommandName {
if (name == null || name.isEmpty() || name.startsWith(MINUS)
|| name.contains(SPACE)) {
throw new InvalidCommandName();
}
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommandProvider#add(java.lang.String, * @see net.bigeon.gclc.command.ICommandProvider#add(java.lang.String,
* fr.bigeon.gclc.command.Command) */ * net.bigeon.gclc.command.Command) */
@Override @Override
public final boolean add(final ICommand value) throws InvalidCommandName { public final boolean add(final ICommand value) throws InvalidCommandName {
final String name = value.getCommandName(); final String name = value.getCommandName();
@@ -93,8 +86,8 @@ public class CommandProvider implements ICommandProvider {
/* (non-Javadoc) /* (non-Javadoc)
* @see * @see
* fr.bigeon.gclc.command.ICommandProvider#executeSub(fr.bigeon.gclc.manager * net.bigeon.gclc.command.ICommandProvider#executeSub(net.bigeon.gclc.manager
* .ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String, * .ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String,
* java.lang.String[]) */ * java.lang.String[]) */
@Override @Override
public final void executeSub(final ConsoleOutput out, final ConsoleInput in, public final void executeSub(final ConsoleOutput out, final ConsoleInput in,
@@ -108,7 +101,7 @@ public class CommandProvider implements ICommandProvider {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */ * @see net.bigeon.gclc.command.ICommandProvider#get(java.lang.String) */
@Override @Override
public final ICommand get(final String commandName) { public final ICommand get(final String commandName) {
for (final ICommand command : commands) { for (final ICommand command : commands) {
@@ -118,4 +111,15 @@ public class CommandProvider implements ICommandProvider {
} }
return null; return null;
} }
/** Test the command name validity.
*
* @param name the command name
* @throws InvalidCommandName if the name is invalid */
private static void testCommandName(final String name) throws InvalidCommandName {
if (name == null || name.isEmpty() || name.startsWith(MINUS)
|| name.contains(SPACE)) {
throw new InvalidCommandName();
}
}
} }

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.command.ICommand.java * gclc:net.bigeon.gclc.command.ICommand.java
* Created on: May 31, 2016 * Created on: May 31, 2016
*/ */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,19 +63,19 @@ package fr.bigeon.gclc.command;
* 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% * #L%
*/ */
import java.io.IOException; import java.io.IOException;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** The contract of commands. /** The contract of commands.
* <p> * <p>
@@ -90,11 +90,11 @@ public interface ICommand {
* @param in the input * @param in the input
* @param args the arguments * @param args the arguments
* @throws CommandRunException if the command failed */ * @throws CommandRunException if the command failed */
void execute(ConsoleOutput out, ConsoleInput in, void execute(ConsoleOutput out, ConsoleInput in, String... args)
String... args) throws CommandRunException; throws CommandRunException;
/** Get teh command name. /** Get teh command name.
* *
* @return the command's name */ * @return the command's name */
String getCommandName(); String getCommandName();

View File

@@ -32,28 +32,28 @@
* 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;
/*- /*-
* #%L * #%L
* Generic Command Ligne console * Generic Command Ligne console
* %% * %%
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -61,18 +61,19 @@ package fr.bigeon.gclc.command;
* 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% * #L%
*/ */
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/** An ICommadProvider is a provider of commands that can register commands /** An ICommadProvider is a provider of commands that can register commands
* under some keywords. * under some keywords.
@@ -80,8 +81,8 @@ import fr.bigeon.gclc.manager.ConsoleOutput;
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
public interface ICommandProvider { public interface ICommandProvider {
/** Adds a command to this provider, if no command was associated with the /** Adds a command to this provider, if no command was associated with the given
* given key. * key.
* *
* @param value the command to execute * @param value the command to execute
* @return if the command was added * @return if the command was added
@@ -90,25 +91,25 @@ public interface ICommandProvider {
/** Execute the command with the given name. /** Execute the command with the given name.
* <p> * <p>
* If no command with this name is found, an error command is usually * If no command with this name is found, an error command is usually executed.
* executed. If there are several commands with the same name, the behavior * If there are several commands with the same name, the behavior is
* is unspecified. Depending on the implementation, it may run an error * unspecified. Depending on the implementation, it may run an error command or
* command or prompt the user for a choice. * prompt the user for a choice.
* *
* @param out the output * @param out the output
* @param in the input * @param in the input
* @param command the name of the command the user wishes to execute * @param command the name of the command the user wishes to execute
* @param args the arguments for the command * @param args the arguments for the command
* @throws CommandRunException if the command failed to run */ * @throws CommandRunException if the command failed to run */
void executeSub(ConsoleOutput out, ConsoleInput in, String command, void executeSub(ConsoleOutput out, ConsoleInput in, String command, String... args)
String... args) throws CommandRunException; throws CommandRunException;
/** Get the command with the given name. /** Get the command with the given name.
* <p> * <p>
* If no command with this name is found, an error command is usually * If no command with this name is found, an error command is usually returned.
* returned. If there are several commands with the same name, the behavior * If there are several commands with the same name, the behavior is
* is unspecified. Depending on the implementation, it may return an error * unspecified. Depending on the implementation, it may return an error command
* command or the first command with this name found. * or the first command with this name found.
* *
* @param command the name of the command the user wishes to execute * @param command the name of the command the user wishes to execute
* @return the command to execute */ * @return the command to execute */

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.command.ParametrizedCommand.java * gclc:net.bigeon.gclc.command.ParametrizedCommand.java
* Created on: Dec 24, 2014 * Created on: Dec 24, 2014
*/ */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.command;
* 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% * #L%
@@ -74,10 +74,10 @@ package fr.bigeon.gclc.command;
import java.io.IOException; import java.io.IOException;
import java.util.Set; import java.util.Set;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidParameterException; import net.bigeon.gclc.exception.InvalidParameterException;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** A command relying on the {@link CommandParameters} to store parameters /** A command relying on the {@link CommandParameters} to store parameters
* values. * values.
@@ -89,9 +89,8 @@ public abstract class ParametrizedCommand extends Command {
/** Create a parametrized command. /** Create a parametrized command.
* <p> * <p>
* Implementation are supposed to call the * Implementation are supposed to call the {@link #addBooleanParameter(String)}
* {@link #addBooleanParameter(String)} and * and {@link #addStringParameter(String, boolean)} method to set the
* {@link #addStringParameter(String, boolean)} method to set the
* parameters. * parameters.
* *
* @param name the name */ * @param name the name */
@@ -101,9 +100,8 @@ public abstract class ParametrizedCommand extends Command {
/** Create a parametrized command. /** Create a parametrized command.
* <p> * <p>
* Implementation are supposed to call the * Implementation are supposed to call the {@link #addBooleanParameter(String)}
* {@link #addBooleanParameter(String)} and * and {@link #addStringParameter(String, boolean)} method to set the
* {@link #addStringParameter(String, boolean)} method to set the
* parameters. * parameters.
* *
* @param name the name * @param name the name
@@ -116,9 +114,10 @@ public abstract class ParametrizedCommand extends Command {
/** Add a boolean parameter to defined parmaters. /** Add a boolean parameter to defined parmaters.
* *
* @param flag the boolean flag * @param flag the boolean flag
* @throws InvalidParameterException if the parameter is already defined as * @throws InvalidParameterException if the parameter is already defined as a
* a string parameter */ * string parameter */
protected final void addBooleanParameter(final String flag) throws InvalidParameterException { protected final void addBooleanParameter(final String flag)
throws InvalidParameterException {
data.addBooleanParameter(flag); data.addBooleanParameter(flag);
} }
@@ -126,28 +125,27 @@ public abstract class ParametrizedCommand extends Command {
* *
* @param flag the parameter flag * @param flag the parameter flag
* @param needed if the parameter's absence should cause an exception * @param needed if the parameter's absence should cause an exception
* @throws InvalidParameterException if the parameter is already defined as * @throws InvalidParameterException if the parameter is already defined as a
* a boolean parameter */ * boolean parameter */
protected final void addStringParameter(final String flag, protected final void addStringParameter(final String flag, final boolean needed)
final boolean needed) throws InvalidParameterException { throws InvalidParameterException {
data.addStringParameter(flag, needed); data.addStringParameter(flag, needed);
} }
/** Actually performs the execution after parsing the parameters. /** Actually performs the execution after parsing the parameters.
* *
* @param out the output * @param out the output
* @param in the input * @param in the input
* @param parameters the command parameters * @param parameters the command parameters
* @throws CommandRunException if the command failed */ * @throws CommandRunException if the command failed */
protected abstract void doExecute(ConsoleOutput out, ConsoleInput in, protected abstract void doExecute(ConsoleOutput out, ConsoleInput in,
CommandParameters parameters) throws CommandRunException; CommandParameters parameters) throws CommandRunException;
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#execute(java.lang.String[]) */ * @see net.bigeon.gclc.command.Command#execute(java.lang.String[]) */
@Override @Override
public final void execute(final ConsoleOutput output, public final void execute(final ConsoleOutput output, final ConsoleInput input,
final ConsoleInput input, final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
try { try {
doExecute(output, input, data.getParameters(input, args)); doExecute(output, input, data.getParameters(input, args));
} catch (final IOException e) { } catch (final IOException e) {

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.command.ParametrizedCommand.java * gclc:net.bigeon.gclc.command.ParametrizedCommand.java
* Created on: Dec 24, 2014 * Created on: Dec 24, 2014
*/ */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.command;
* 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% * #L%
@@ -75,17 +75,17 @@ import java.io.IOException;
import java.text.MessageFormat; import java.text.MessageFormat;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections; import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet; import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Map.Entry; import java.util.Map.Entry;
import java.util.Set; import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import fr.bigeon.gclc.exception.CommandParsingException; import net.bigeon.gclc.exception.CommandParsingException;
import fr.bigeon.gclc.exception.InvalidParameterException; import net.bigeon.gclc.exception.InvalidParameterException;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.EmptyInput; import net.bigeon.gclc.utils.EmptyInput;
/** An object to handle standardized command parameters. /** An object to handle standardized command parameters.
* *
@@ -93,11 +93,12 @@ import fr.bigeon.gclc.manager.EmptyInput;
public final class ParametrizedCommandData { public final class ParametrizedCommandData {
/** The boolean parameters mandatory status. */ /** The boolean parameters mandatory status. */
private final Set<String> boolParams = new HashSet<>(); private final Set<String> boolParams = new HashSet<>();
/** The string parameters mandatory status. */ /** The string parameters mandatory status. */
private final Map<String, Boolean> stringParams = new HashMap<>(); private final Map<String, Boolean> stringParams = new ConcurrentHashMap<>();
/** The parameters mandatory status. */ /** The parameters mandatory status. */
private final Map<String, Boolean> params = new HashMap<>(); private final Map<String, Boolean> params = new ConcurrentHashMap<>();
/** The restriction of provided parameters on execution to declared paramters in /** The restriction of provided parameters on execution to declared paramters in
* the status maps. */ * the status maps. */
private final boolean strict; private final boolean strict;
@@ -108,7 +109,7 @@ public final class ParametrizedCommandData {
} }
/** The data for a parametrized command. /** The data for a parametrized command.
* *
* @param strict if the command was refusing unrecognized parameters */ * @param strict if the command was refusing unrecognized parameters */
public ParametrizedCommandData(final boolean strict) { public ParametrizedCommandData(final boolean strict) {
this.strict = strict; this.strict = strict;
@@ -119,8 +120,7 @@ public final class ParametrizedCommandData {
* @param flag the boolean flag * @param flag the boolean flag
* @throws InvalidParameterException if the parameter is already defined as a * @throws InvalidParameterException if the parameter is already defined as a
* string parameter */ * string parameter */
public final void addBooleanParameter(final String flag) public void addBooleanParameter(final String flag) throws InvalidParameterException {
throws InvalidParameterException {
if (params.containsKey(flag) && stringParams.containsKey(flag)) { if (params.containsKey(flag) && stringParams.containsKey(flag)) {
throw new InvalidParameterException("Parameter is already defined as string"); //$NON-NLS-1$ throw new InvalidParameterException("Parameter is already defined as string"); //$NON-NLS-1$
} }
@@ -134,7 +134,7 @@ public final class ParametrizedCommandData {
* @param needed if the parameter's absence should cause an exception * @param needed if the parameter's absence should cause an exception
* @throws InvalidParameterException if the parameter is already defined as a * @throws InvalidParameterException if the parameter is already defined as a
* boolean parameter */ * boolean parameter */
public final void addStringParameter(final String flag, final boolean needed) public void addStringParameter(final String flag, final boolean needed)
throws InvalidParameterException { throws InvalidParameterException {
if (params.containsKey(flag)) { if (params.containsKey(flag)) {
checkParam(flag, needed); checkParam(flag, needed);
@@ -151,9 +151,9 @@ public final class ParametrizedCommandData {
* @throws InvalidParameterException if the new definition is invalid */ * @throws InvalidParameterException if the new definition is invalid */
private void checkParam(final String param, final boolean needed) private void checkParam(final String param, final boolean needed)
throws InvalidParameterException { throws InvalidParameterException {
if (stringParams.containsKey(param)) { Boolean val = stringParams.get(param);
final Boolean need = Boolean if (val != null) {
.valueOf(needed || stringParams.get(param).booleanValue()); final Boolean need = Boolean.valueOf(needed || val.booleanValue());
stringParams.put(param, need); stringParams.put(param, need);
params.put(param, need); params.put(param, need);
return; return;
@@ -161,14 +161,28 @@ public final class ParametrizedCommandData {
throw new InvalidParameterException("Parameter is already defined as boolean"); //$NON-NLS-1$ throw new InvalidParameterException("Parameter is already defined as boolean"); //$NON-NLS-1$
} }
/** Retrieve the boolean parameters (aka flags).
*
* @return the set of boolean parameters */
public Set<String> getBooleanParameters() {
return Collections.unmodifiableSet(boolParams);
}
/** Retrieve the parameter names.
*
* @return the stringParams */
public Set<String> getParameters() {
return params.keySet();
}
/** Get the parameters from an input. /** Get the parameters from an input.
* *
* @param input the input * @param input the input
* @param args the command arguments * @param args the command arguments
* @return the command object * @return the command object
* @throws IOException if the command could not be filled. */ * @throws IOException if the command could not be filled. */
public final CommandParameters getParameters(final ConsoleInput input, public CommandParameters getParameters(final ConsoleInput input, final String... args)
final String... args) throws IOException { throws IOException {
final CommandParameters parameters = new CommandParameters(boolParams, final CommandParameters parameters = new CommandParameters(boolParams,
stringParams.keySet(), strict); stringParams.keySet(), strict);
try { try {
@@ -191,6 +205,29 @@ public final class ParametrizedCommandData {
return parameters; return parameters;
} }
/** Get the string parameters names.
*
* @return the stringParams */
public Set<String> getStringParameters() {
return stringParams.keySet();
}
/** Test if a parameter is needed.
*
* @param param the parameter name
* @return if the parameter is needed */
public boolean isNeeded(final String param) {
Boolean val = params.get(param);
return val != null && val.booleanValue();
}
/** If the command refuse unrecognized parameters.
*
* @return the strict */
public boolean isStrict() {
return strict;
}
/** Fill the undefined parameters. /** Fill the undefined parameters.
* <p> * <p>
* This method prompts the user to fill the needed parameters. * This method prompts the user to fill the needed parameters.
@@ -199,7 +236,7 @@ public final class ParametrizedCommandData {
* @param parameters the parameter list to complete * @param parameters the parameter list to complete
* @param toProvide the parameters to ask for * @param toProvide the parameters to ask for
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
private final static void fillParameters(final ConsoleInput input, private static void fillParameters(final ConsoleInput input,
final List<String> toProvide, final CommandParameters parameters) final List<String> toProvide, final CommandParameters parameters)
throws IOException { throws IOException {
for (final String string : toProvide) { for (final String string : toProvide) {
@@ -213,40 +250,4 @@ public final class ParametrizedCommandData {
parameters.set(string, value); parameters.set(string, value);
} }
} }
/** Retrieve the boolean parameters (aka flags).
*
* @return the set of boolean parameters */
public final Set<String> getBooleanParameters() {
return Collections.unmodifiableSet(boolParams);
}
/** Retrieve the parameter names.
*
* @return the stringParams */
public final Set<String> getParameters() {
return params.keySet();
}
/** Get the string parameters names.
*
* @return the stringParams */
public final Set<String> getStringParameters() {
return stringParams.keySet();
}
/** Test if a parameter is needed.
*
* @param param the parameter name
* @return if the parameter is needed */
public final boolean isNeeded(final String param) {
return params.containsKey(param) && params.get(param).booleanValue();
}
/** If the command refuse unrecognized parameters.
*
* @return the strict */
public final boolean isStrict() {
return strict;
}
} }

View File

@@ -32,9 +32,9 @@
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** gclc:fr.bigeon.gclc.command.SubedCommand.java /** gclc:net.bigeon.gclc.command.SubedCommand.java
* Created on: Sep 6, 2014 */ * Created on: Sep 6, 2014 */
package fr.bigeon.gclc.command; package net.bigeon.gclc.command;
/*- /*-
* #%L * #%L
@@ -43,17 +43,17 @@ package fr.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -61,10 +61,10 @@ package fr.bigeon.gclc.command;
* 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% * #L%
@@ -72,10 +72,10 @@ package fr.bigeon.gclc.command;
import java.io.IOException; import java.io.IOException;
import java.util.Arrays; import java.util.Arrays;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType; import net.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** /**
* <p> * <p>
@@ -86,16 +86,15 @@ import fr.bigeon.gclc.manager.ConsoleOutput;
public final class SubedCommand extends CommandProvider implements ICommand { public final class SubedCommand extends CommandProvider implements ICommand {
/** The tab character. */ /** The tab character. */
private static final String TAB = "\t"; //$NON-NLS-1$ private static final String TAB = "\t"; //$NON-NLS-1$
/** The command to execute when this command is called with no sub /** The command to execute when this command is called with no sub arguments.
* arguments.
* <p> * <p>
* This may be null, in which case the command should have arguments. */ * This may be null, in which case the command should have arguments. */
private final ICommand noArgCommand; private final ICommand noArgCommand;
/** A tip on this command. */ /** A tip on this command. */
private final String tip; private final String tip;
/** The name of the command. */ /** The name of the command. */
private final String name; private final String name;
/** Create the command that defines sub commands. /** Create the command that defines sub commands.
* *
@@ -111,7 +110,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
* *
* @param name the name of the command * @param name the name of the command
* @param noArgCommand the command to execute when no extra parameter are * @param noArgCommand the command to execute when no extra parameter are
* provided */ * provided */
public SubedCommand(final String name, final ICommand noArgCommand) { public SubedCommand(final String name, final ICommand noArgCommand) {
super(); super();
this.name = name; this.name = name;
@@ -125,7 +124,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
* @param noArgCommand the command to execute * @param noArgCommand the command to execute
* @param tip the help tip associated */ * @param tip the help tip associated */
public SubedCommand(final String name, final ICommand noArgCommand, public SubedCommand(final String name, final ICommand noArgCommand,
final String tip) { final String tip) {
super(); super();
this.name = name; this.name = name;
this.noArgCommand = noArgCommand; this.noArgCommand = noArgCommand;
@@ -147,7 +146,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
* @see fr.bigeon.acide.Command#execute(java.lang.String[]) */ * @see fr.bigeon.acide.Command#execute(java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput output, final ConsoleInput input, public void execute(final ConsoleOutput output, final ConsoleInput input,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
if (args.length == 0 || args[0].startsWith("-")) { //$NON-NLS-1$ if (args.length == 0 || args[0].startsWith("-")) { //$NON-NLS-1$
if (noArgCommand != null) { if (noArgCommand != null) {
noArgCommand.execute(output, input, args); noArgCommand.execute(output, input, args);
@@ -167,24 +166,24 @@ public final class SubedCommand extends CommandProvider implements ICommand {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ * @see net.bigeon.gclc.command.ICommand#getCommandName() */
@Override @Override
public String getCommandName() { public String getCommandName() {
return name; return name;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#help() */ * @see net.bigeon.gclc.command.Command#help() */
@Override @Override
public void help(final ConsoleOutput manager, public void help(final ConsoleOutput manager, final String... args)
final String... args) throws IOException { throws IOException {
if (args.length != 0 && !args[0].startsWith("-")) { //$NON-NLS-1$ if (args.length != 0 && !args[0].startsWith("-")) { //$NON-NLS-1$
// Specific // Specific
final ICommand c = get(args[0]); final ICommand c = get(args[0]);
if (c != null) { if (c != null) {
c.help(manager, Arrays.copyOfRange(args, 1, args.length)); c.help(manager, Arrays.copyOfRange(args, 1, args.length));
} else { } else {
manager.println("No command "+Arrays.toString(args)); manager.println("No command " + Arrays.toString(args));
} }
} else { } else {
// Generic // Generic
@@ -196,14 +195,14 @@ public final class SubedCommand extends CommandProvider implements ICommand {
manager.println(TAB + cmd.getCommandName()); manager.println(TAB + cmd.getCommandName());
} else { } else {
manager.println(TAB + cmd.getCommandName() + ": " + //$NON-NLS-1$ manager.println(TAB + cmd.getCommandName() + ": " + //$NON-NLS-1$
cmd.tip()); cmd.tip());
} }
} }
} }
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#tip() */ * @see net.bigeon.gclc.command.Command#tip() */
@Override @Override
public String tip() { public String tip() {
return tip; return tip;

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc: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.base; package net.bigeon.gclc.command.base;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.command.base;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,34 +63,34 @@ package fr.bigeon.gclc.command.base;
* 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% * #L%
*/ */
import java.io.IOException; import java.io.IOException;
import fr.bigeon.gclc.ConsoleApplication; import net.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.command.ICommand; import net.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
import fr.bigeon.gclc.prompt.CLIPrompterMessages; import net.bigeon.gclc.prompt.CLIPrompterMessages;
/** A command to exit a {@link ConsoleApplication}. /** A command to exit a {@link ConsoleApplication}.
* *
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
public final class ExitCommand implements ICommand { public class ExitCommand implements ICommand {
/** The exit command manual message key. */ /** The exit command manual message key. */
private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$ private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$
/** The tip of the exit command. */ /** The tip of the exit command. */
private static final String EXIT = "exit.tip"; //$NON-NLS-1$ private static final String EXIT = "exit.tip"; //$NON-NLS-1$
/** The application that will be exited when this command runs. */ /** The application that will be exited when this command runs. */
private final ConsoleApplication app; private final ConsoleApplication app;
/** The exit command name. */ /** The exit command name. */
private final String name; private final String name;
/** Create the exiting command. /** Create the exiting command.
* *
@@ -109,25 +109,25 @@ public final class ExitCommand implements ICommand {
} }
@Override @Override
public final void execute(final ConsoleOutput output, public final void execute(final ConsoleOutput output, final ConsoleInput input,
final ConsoleInput input, final String... args) { final String... args) {
beforeExit(); beforeExit();
app.exit(); app.exit();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ * @see net.bigeon.gclc.command.ICommand#getCommandName() */
@Override @Override
public final String getCommandName() { public final String getCommandName() {
return name; return name;
} }
@Override @Override
public final void help(final ConsoleOutput manager, public final void help(final ConsoleOutput manager, final String... args)
final String... args) throws IOException { throws IOException {
manager.println( manager.println(CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args));
CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args));
} }
@Override @Override
public final String tip() { public final String tip() {
return CLIPrompterMessages.getString(EXIT); return CLIPrompterMessages.getString(EXIT);

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc: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;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,21 +63,24 @@ package fr.bigeon.gclc.command;
* 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% * #L%
*/ */
import java.io.IOException; import java.io.IOException;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.command.Command;
import fr.bigeon.gclc.exception.CommandRunExceptionType; import net.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.command.SubedCommand;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.prompt.CLIPrompterMessages; import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.prompt.CLIPrompterMessages;
/** A command to print help of an other command. /** A command to print help of an other command.
* <p> * <p>
@@ -93,14 +96,13 @@ public final class HelpExecutor extends Command {
* *
* @param cmdName the command name * @param cmdName the command name
* @param cmd the command to execute the help of */ * @param cmd the command to execute the help of */
public HelpExecutor(final String cmdName, public HelpExecutor(final String cmdName, final ICommand cmd) {
final ICommand cmd) {
super(cmdName); super(cmdName);
this.cmd = cmd; this.cmd = cmd;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#brief() */ * @see net.bigeon.gclc.command.Command#brief() */
@Override @Override
protected String brief() { protected String brief() {
if (cmd instanceof SubedCommand) { if (cmd instanceof SubedCommand) {
@@ -110,11 +112,11 @@ public final class HelpExecutor extends Command {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput, * @see net.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput,
* String[]) */ * String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
try { try {
cmd.help(out, args); cmd.help(out, args);
} catch (final IOException e) { } catch (final IOException e) {
@@ -124,22 +126,21 @@ public final class HelpExecutor extends Command {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#tip() */ * @see net.bigeon.gclc.command.Command#tip() */
@Override @Override
public String tip() { public String tip() {
return CLIPrompterMessages.getString("help.cmd.tip"); //$NON-NLS-1$ return CLIPrompterMessages.getString("help.cmd.tip"); //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() * @see net.bigeon.gclc.command.Command#usageDetail() */
*/
@Override @Override
protected String usageDetail() { protected String usageDetail() {
return null; return null;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */ * @see net.bigeon.gclc.command.Command#usagePattern() */
@Override @Override
protected String usagePattern() { protected String usagePattern() {
if (cmd instanceof SubedCommand) { if (cmd instanceof SubedCommand) {

View File

@@ -33,30 +33,29 @@
* 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.base; package net.bigeon.gclc.command.base;
import fr.bigeon.gclc.command.ICommand;
/*- /*-
* #%L * #%L
* Generic Command Ligne console * Generic Command Ligne console
* %% * %%
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -64,16 +63,18 @@ import fr.bigeon.gclc.command.ICommand;
* 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% * #L%
*/ */
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/** This implement a command that does nothing. /** This implement a command that does nothing.
* <p> * <p>
@@ -93,32 +94,31 @@ public final class MockCommand implements ICommand {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput, * @see net.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput,
* String[]) */ * String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) { final String... args) {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */ * @see net.bigeon.gclc.command.ICommand#getCommandName() */
@Override @Override
public String getCommandName() { public String getCommandName() {
return name; return name;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#help(fr.bigeon.gclc.manager. * @see net.bigeon.gclc.command.ICommand#help(net.bigeon.gclc.manager.
* ConsoleManager, java.lang.String[]) */ * ConsoleManager, java.lang.String[]) */
@Override @Override
public void help(final ConsoleOutput manager, public void help(final ConsoleOutput manager, final String... args) {
final String... args) {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */ * @see net.bigeon.gclc.command.ICommand#tip() */
@Override @Override
public String tip() { public String tip() {
return null; return null;

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc: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.base; package net.bigeon.gclc.command.base;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.command.base;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,31 +63,32 @@ package fr.bigeon.gclc.command.base;
* 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% * #L%
*/ */
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException; import java.io.IOException;
import java.io.InputStreamReader; import java.io.InputStreamReader;
import java.nio.charset.Charset; import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.text.MessageFormat; import java.text.MessageFormat;
import java.util.Arrays; import java.util.Arrays;
import java.util.List; import java.util.List;
import fr.bigeon.gclc.ConsoleApplication; import net.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.GCLCConstants; import net.bigeon.gclc.GCLCConstants;
import fr.bigeon.gclc.command.Command; import net.bigeon.gclc.command.Command;
import fr.bigeon.gclc.exception.CommandParsingException; import net.bigeon.gclc.exception.CommandParsingException;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType; import net.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** A command that will launch a series of command from a file. /** A command that will launch a series of command from a file.
* <p> * <p>
@@ -98,13 +99,16 @@ import fr.bigeon.gclc.manager.ConsoleOutput;
public final class ScriptExecution extends Command { public final class ScriptExecution extends Command {
/** The tab character. */ /** The tab character. */
private static final String TAB = "\t"; //$NON-NLS-1$ private static final String TAB = "\t"; //$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 application. */ /** The application. */
private final ConsoleApplication application; private final ConsoleApplication application;
/** The commenting prefix. */ /** The commenting prefix. */
private final String commentPrefix; private final String commentPrefix;
/** The charset for files. */ /** The charset for files. */
private final Charset charset; private final Charset charset;
@@ -115,40 +119,27 @@ public final class ScriptExecution extends Command {
* @param commentPrefix the comment prefix in the script files * @param commentPrefix the comment prefix in the script files
* @param charset the charset to use for files */ * @param charset the charset to use for files */
public ScriptExecution(final String name, final ConsoleApplication application, public ScriptExecution(final String name, final ConsoleApplication application,
final String commentPrefix, final Charset charset) { final String commentPrefix, final Charset charset) {
super(name); super(name);
this.application = application; this.application = application;
this.commentPrefix = commentPrefix; this.commentPrefix = commentPrefix;
this.charset = charset; this.charset = charset;
} }
/** Check the arguments.
*
* @param args the arguments
* @throws CommandRunException if the arguments were not the ones
* expected */
private static void checkArgs(final String[] args) throws CommandRunException {
if (args.length == 0) {
throw new CommandRunException(CommandRunExceptionType.USAGE,
"Expecting a file"); //$NON-NLS-1$
}
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */ * @see net.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
checkArgs(args); checkArgs(args);
final String scriptFile = args[0]; final String scriptFile = args[0];
final String[] params = Arrays.copyOfRange(args, 1, args.length); final String[] params = Arrays.copyOfRange(args, 1, args.length);
String cmd; String cmd;
int lineNo = -1; int lineNo = -1;
try (InputStreamReader fReader = new InputStreamReader( try (InputStreamReader fReader = new InputStreamReader(
new FileInputStream(scriptFile), charset); Files.newInputStream(Paths.get(scriptFile)), charset);
BufferedReader reader = new BufferedReader(fReader)) { BufferedReader reader = new BufferedReader(fReader)) {
String[] emptyArray = new String[0];
while ((cmd = reader.readLine()) != null) { while ((cmd = reader.readLine()) != null) {
lineNo++; lineNo++;
final String cmdLine = readCommandLine(cmd, params); final String cmdLine = readCommandLine(cmd, params);
@@ -157,12 +148,12 @@ public final class ScriptExecution extends Command {
} }
final List<String> ps = GCLCConstants.splitCommand(cmdLine); final List<String> ps = GCLCConstants.splitCommand(cmdLine);
final String command = ps.remove(0); final String command = ps.remove(0);
application.executeSub(out, in, command, application.executeSub(out, in, command, ps.toArray(emptyArray));
ps.toArray(new String[0]));
} }
} catch (final CommandParsingException e) { } catch (final CommandParsingException e) {
throw new CommandRunException(MessageFormat.format( throw new CommandRunException(
"Invalid command in script ({0})", e.getLocalizedMessage()), //$NON-NLS-1$ MessageFormat.format("Invalid command in script ({0})", //$NON-NLS-1$
e.getLocalizedMessage()),
e); e);
} catch (final IOException e) { } catch (final IOException e) {
throw new CommandRunException("Unable to read script", //$NON-NLS-1$ throw new CommandRunException("Unable to read script", //$NON-NLS-1$
@@ -172,29 +163,14 @@ public final class ScriptExecution extends Command {
} }
} }
/** This method will create the correct exception. The exception source must
* be this command.
*
* @param e the exception
* @param lineNo the line nu;ber
* @return the exception to actually throw */
private static CommandRunException manageRunException(final CommandRunException e,
final int lineNo) {
return new CommandRunException(CommandRunExceptionType.EXECUTION,
MessageFormat.format(
"The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$
Integer.valueOf(lineNo), e.getLocalizedMessage()),
e);
}
/** Read a line of the script. /** Read a line of the script.
* *
* @param cmd the line * @param cmd the line
* @param params the formatting parameters * @param params the formatting parameters
* @return the command if it is indeed one, null otherwise * @return the command if it is indeed one, null otherwise
* @throws CommandRunException if the line stqrted with a space character */ * @throws CommandRunException if the line stqrted with a space character */
private String readCommandLine(final String cmd, private String readCommandLine(final String cmd, final Object[] params)
final Object[] params) throws CommandRunException { throws CommandRunException {
if (cmd.startsWith(SPACE) || cmd.startsWith(TAB)) { if (cmd.startsWith(SPACE) || cmd.startsWith(TAB)) {
throw new CommandRunException( throw new CommandRunException(
"Invalid line in script (line starts with space character)"); "Invalid line in script (line starts with space character)");
@@ -207,14 +183,14 @@ public final class ScriptExecution extends Command {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */ * @see net.bigeon.gclc.command.ICommand#tip() */
@Override @Override
public String tip() { public String tip() {
return "Execute a script"; //$NON-NLS-1$ return "Execute a script"; //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */ * @see net.bigeon.gclc.command.Command#usageDetail() */
@Override @Override
protected String usageDetail() { protected String usageDetail() {
final StringBuilder builder = new StringBuilder(); final StringBuilder builder = new StringBuilder();
@@ -225,8 +201,7 @@ public final class ScriptExecution extends Command {
builder.append( builder.append(
" The script file must contain one line commands. The lines must never"); //$NON-NLS-1$ " The script file must contain one line commands. The lines must never"); //$NON-NLS-1$
builder.append(System.lineSeparator()); builder.append(System.lineSeparator());
builder.append( builder.append("start with whitespace characters. The lines starting with"); //$NON-NLS-1$
"start with whitespace characters. The lines starting with"); //$NON-NLS-1$
builder.append(System.lineSeparator()); builder.append(System.lineSeparator());
builder.append('"'); builder.append('"');
builder.append(commentPrefix); builder.append(commentPrefix);
@@ -237,10 +212,36 @@ public final class ScriptExecution extends Command {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */ * @see net.bigeon.gclc.command.Command#usagePattern() */
@Override @Override
protected String usagePattern() { protected String usagePattern() {
return super.usagePattern() + " <scriptfile>"; //$NON-NLS-1$ return super.usagePattern() + " <scriptfile>"; //$NON-NLS-1$
} }
/** 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

@@ -1,39 +1,36 @@
/* /** @author Emmanuel Bigeon */
* GCLC swt, provide a swt window for console applications package net.bigeon.gclc.command.base;
* Copyright (C) 2015-2017 E. Bigeon
* mailto:emmanuel@bigeon.fr /*-
* * #%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-swt:fr.bigeon.gclc.swt.package-info.java * The fact that you are presently reading this means that you have had
* Created on: Nov 18, 2017 * knowledge of the CeCILL license and that you accept its terms.
*/ * #L%
/** SWT components for a frontend of GCLC applications. */
*
* @author Emmanuel Bigeon */
package fr.bigeon.gclc.swt;

View File

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

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.exception.CommandParsingException.java * gclc:net.bigeon.gclc.exception.CommandParsingException.java
* Created on: Jun 1, 2016 * Created on: Jun 1, 2016
*/ */
package fr.bigeon.gclc.exception; package net.bigeon.gclc.exception;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.exception;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.exception;
* 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% * #L%
@@ -80,16 +80,16 @@ public class CommandParsingException extends Exception {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** Create the exception with a message. /** Create the exception with a message.
* *
* @param message the message */ * @param message the message */
public CommandParsingException(final String message) { public CommandParsingException(final String message) {
super(message); super(message);
} }
/** Create the exception with a message and a cause. /** Create the exception with a message and a cause.
* *
* @param message the message * @param message the message
* @param cause the cause */ * @param cause the cause */
public CommandParsingException(final String message, final Throwable cause) { public CommandParsingException(final String message, final Throwable cause) {
super(message, cause); super(message, cause);
} }

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc: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;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.exception;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.exception;
* 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% * #L%
@@ -87,8 +87,7 @@ public final class CommandRunException extends Exception {
* *
* @param type the type of exception * @param type the type of exception
* @param message the message */ * @param message the message */
public CommandRunException(final CommandRunExceptionType type, public CommandRunException(final CommandRunExceptionType type, final String message) {
final String message) {
super(message); super(message);
this.type = type; this.type = type;
} }
@@ -98,8 +97,8 @@ public final class CommandRunException extends Exception {
* @param type the type of exception * @param type the type of exception
* @param message a message * @param message a message
* @param cause the cause */ * @param cause the cause */
public CommandRunException(final CommandRunExceptionType type, public CommandRunException(final CommandRunExceptionType type, final String message,
final String message, final Throwable cause) { final Throwable cause) {
super(message, cause); super(message, cause);
this.type = type; this.type = type;
} }
@@ -128,7 +127,7 @@ public final class CommandRunException extends Exception {
public String getLocalizedMessage() { public String getLocalizedMessage() {
if (getCause() != null) { if (getCause() != null) {
return super.getLocalizedMessage() + ": " + //$NON-NLS-1$ return super.getLocalizedMessage() + ": " + //$NON-NLS-1$
getCause().getLocalizedMessage(); getCause().getLocalizedMessage();
} }
return super.getLocalizedMessage(); return super.getLocalizedMessage();
} }

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.exception.CommandRunExceptionType.java * gclc:net.bigeon.gclc.exception.CommandRunExceptionType.java
* Created on: Jun 12, 2016 * Created on: Jun 12, 2016
*/ */
package fr.bigeon.gclc.exception; package net.bigeon.gclc.exception;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.exception;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.exception;
* 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% * #L%

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.exception.InvalidCommandName.java * gclc:net.bigeon.gclc.exception.InvalidCommandName.java
* Created on: Dec 23, 2014 * Created on: Dec 23, 2014
*/ */
package fr.bigeon.gclc.exception; package net.bigeon.gclc.exception;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.exception;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.exception;
* 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% * #L%

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.exception.InvalidParameterException.java * gclc:net.bigeon.gclc.exception.InvalidParameterException.java
* Created on: Nov 19, 2016 * Created on: Nov 19, 2016
*/ */
package fr.bigeon.gclc.exception; package net.bigeon.gclc.exception;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.exception;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.exception;
* 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% * #L%

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

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.i18n.Messages.java * gclc:net.bigeon.gclc.i18n.Messages.java
* Created on: Jun 1, 2016 * Created on: Jun 1, 2016
*/ */
package fr.bigeon.gclc.i18n; package net.bigeon.gclc.i18n;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.i18n;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.i18n;
* 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% * #L%
@@ -82,15 +82,14 @@ import java.util.logging.Logger;
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class Messages { public final class Messages {
/** The resource bundle name. */ /** The resource bundle name. */
private static final String BUNDLE_NAME = "fr.bigeon.gclc.l10n.messages"; //$NON-NLS-1$ private static final String BUNDLE_NAME = "net.bigeon.gclc.l10n.messages"; //$NON-NLS-1$
/** The resource bundle. */ /** The resource bundle. */
private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
.getBundle(BUNDLE_NAME); .getBundle(BUNDLE_NAME);
/** The class logger. */ /** The class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger.getLogger(Messages.class.getName());
.getLogger(Messages.class.getName());
/** Utility class. */ /** Utility class. */
private Messages() { private Messages() {

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

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.manager.ConsoleInput.java * gclc:net.bigeon.gclc.manager.ConsoleInput.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.manager;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.manager;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.manager;
* 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% * #L%
@@ -74,7 +74,7 @@ package fr.bigeon.gclc.manager;
import java.io.IOException; import java.io.IOException;
import java.io.InterruptedIOException; import java.io.InterruptedIOException;
import fr.bigeon.gclc.tools.StringProvider; import net.bigeon.gclc.tools.StringProvider;
/** A console application input. /** A console application input.
* *
@@ -146,7 +146,7 @@ public interface ConsoleInput extends AutoCloseable {
void setPrompt(String prompt); void setPrompt(String prompt);
/** Set the prompting string. /** Set the prompting string.
* *
* @param string the prompt string */ * @param string the prompt string */
void setPrompt(StringProvider string); void setPrompt(StringProvider string);
} }

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.manager.ConsoleOutput.java * gclc:net.bigeon.gclc.manager.ConsoleOutput.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.manager;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.manager;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.manager;
* 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% * #L%
@@ -86,14 +86,12 @@ public interface ConsoleOutput extends AutoCloseable {
/** Print a string. /** Print a string.
* *
* @param text the message to print (without line break at the end). * @param text the message to print (without line break at the end).
* @throws IOException if the manager is closed or could not read the * @throws IOException if the manager is closed or could not read the prompt */
* prompt */
void print(String text) throws IOException; void print(String text) throws IOException;
/** Prints an end of line. /** Prints an end of line.
* *
* @throws IOException if the manager is closed or could not read the * @throws IOException if the manager is closed or could not read the prompt */
* prompt */
void println() throws IOException; void println() throws IOException;
/** Print a string followed by an end of line. /** Print a string followed by an end of line.
@@ -102,8 +100,7 @@ public interface ConsoleOutput extends AutoCloseable {
* {@link #println()}. * {@link #println()}.
* *
* @param message the message to print * @param message the message to print
* @throws IOException if the manager is closed or could not read the * @throws IOException if the manager is closed or could not read the prompt */
* prompt */
void println(String message) throws IOException; 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

@@ -34,7 +34,7 @@
*/ */
/** acide:fr.bigeon.acide.tool.CLIPrompter.java /** acide:fr.bigeon.acide.tool.CLIPrompter.java
* Created on: Jul 31, 2014 */ * Created on: Jul 31, 2014 */
package fr.bigeon.gclc.prompt; package net.bigeon.gclc.prompt;
/*- /*-
* #%L * #%L
@@ -43,17 +43,17 @@ package fr.bigeon.gclc.prompt;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -61,23 +61,24 @@ package fr.bigeon.gclc.prompt;
* 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% * #L%
*/ */
import java.io.IOException; import java.io.IOException;
import java.text.MessageFormat;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** The {@link CLIPrompter} class is a utility class that provides method to /** The {@link CLIPrompter} class is a utility class that provides method to
* prompt the user. * prompt the user.
@@ -86,25 +87,25 @@ import fr.bigeon.gclc.manager.ConsoleOutput;
public final class CLIPrompter { public final class CLIPrompter {
/** The zero integer. */ /** The zero integer. */
private static final Integer ZERO = Integer.valueOf(0); private static final Integer ZERO = Integer.valueOf(0);
/** message key for format error in prompting a choice. */ /** message key for format error in prompting a choice. */
private static final String PROMPTCHOICE_FORMATERR = "promptchoice.formaterr"; //$NON-NLS-1$ private static final String PROMPTCHOICE_FORMATERR = "promptchoice.formaterr"; //$NON-NLS-1$
/** message key for out of bound error in prompting a choice. */ /** message key for out of bound error in prompting a choice. */
private static final String PROMPTCHOICE_OUTOFBOUNDS = "promptchoice.outofbounds"; //$NON-NLS-1$ private static final String PROMPTCHOICE_OUTOFBOUNDS = "promptchoice.outofbounds"; //$NON-NLS-1$
/** message key for first form of no in prompting a choice. */ /** message key for first form of no in prompting a choice. */
private static final String PROMPTBOOL_CHOICES_NO1 = "promptbool.choices.no1"; //$NON-NLS-1$ private static final String PROMPTBOOL_CHOICES_NO1 = "promptbool.choices.no1"; //$NON-NLS-1$
/** message key for first form of yes in prompting a choice. */ /** message key for first form of yes in prompting a choice. */
private static final String PROMPTBOOL_CHOICES_YES1 = "promptbool.choices.yes1"; //$NON-NLS-1$ private static final String PROMPTBOOL_CHOICES_YES1 = "promptbool.choices.yes1"; //$NON-NLS-1$
/** Message key for boolean choosing. */ /** Message key for boolean choosing. */
private static final String BOOL_CHOICES = "promptbool.choices"; //$NON-NLS-1$ private static final String BOOL_CHOICES = "promptbool.choices"; //$NON-NLS-1$
/** Message key for the list end of prompt symbol. */ /** Message key for the list end of prompt symbol. */
private static final String LIST_DISP_KEY = "promptlist.exit.dispkey"; //$NON-NLS-1$ private static final String LIST_DISP_KEY = "promptlist.exit.dispkey"; //$NON-NLS-1$
/** Message key for the line prompt. */ /** Message key for the line prompt. */
private static final String PROMPT = "prompt.lineprompt"; //$NON-NLS-1$ private static final String PROMPT = "prompt.lineprompt"; //$NON-NLS-1$
/** Message key for the separation of choices selection. */ /** Message key for the separation of choices selection. */
private static final String LIST_CHOICE_SEP = "promptlist.multi.sepkey"; //$NON-NLS-1$ private static final String LIST_CHOICE_SEP = "promptlist.multi.sepkey"; //$NON-NLS-1$
/** The class logger. */ /** The class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(CLIPrompter.class.getName()); .getLogger(CLIPrompter.class.getName());
/** Utility class. */ /** Utility class. */
@@ -118,9 +119,8 @@ public final class CLIPrompter {
* @param chs the list of integers * @param chs the list of integers
* @param index the max index of choice * @param index the max index of choice
* @return if the parsing was done correctly */ * @return if the parsing was done correctly */
private static boolean addUserChoice(final String val, private static boolean addUserChoice(final String val, final List<Integer> chs,
final List<Integer> chs, final int index) {
final int index) {
if (val.isEmpty()) { if (val.isEmpty()) {
return true; return true;
} }
@@ -138,18 +138,18 @@ public final class CLIPrompter {
* @param output the manager * @param output the manager
* @param choices the choices * @param choices the choices
* @param cancel the cancel option if it exists * @param cancel the cancel option if it exists
* @return the number of choices plus one (or the number of choices if there * @return the index of last choice
* is a cancel)
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
private static <U> Integer listChoices(final ConsoleOutput output, private static <U> Integer listChoices(final ConsoleOutput output,
final List<U> choices, final List<U> choices, final String cancel) throws IOException {
final String cancel) throws IOException {
int index = 0; int index = 0;
for (final U u : choices) { for (final U u : choices) {
output.println(index++ + ") " + u); //$NON-NLS-1$ output.println(index + ") " + u); //$NON-NLS-1$
index++;
} }
if (cancel != null) { if (cancel != null) {
output.println(index++ + ") " + cancel); //$NON-NLS-1$ output.println(index + ") " + cancel); //$NON-NLS-1$
index++;
} }
return Integer.valueOf(index - 1); return Integer.valueOf(index - 1);
} }
@@ -162,36 +162,28 @@ public final class CLIPrompter {
* @return the choice * @return the choice
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static boolean promptBoolean(final ConsoleOutput manager, public static boolean promptBoolean(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final String message) throws IOException {
final String message) throws IOException { String booleanChoices = message + CLIPrompterMessages.getString(BOOL_CHOICES);
String result = input String result = input.prompt(booleanChoices);
.prompt(message + CLIPrompterMessages.getString(BOOL_CHOICES));
boolean first = true; boolean first = true;
final String choices = CLIPrompterMessages String booleanYesChoice = CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1);
.getString(PROMPTBOOL_CHOICES_YES1) + ", " + //$NON-NLS-1$ String booleanNoChoice = CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_NO1);
CLIPrompterMessages final String choices = MessageFormat.format("{0}, {1}", booleanYesChoice,
.getString(PROMPTBOOL_CHOICES_NO1); booleanNoChoice);
while (!(result.equalsIgnoreCase( String yes2 = CLIPrompterMessages.getString("promptbool.choices.yes2");
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1)) || String no2 = CLIPrompterMessages.getString("promptbool.choices.no2");
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_NO1) while (!(result.equalsIgnoreCase(booleanYesChoice)
.equalsIgnoreCase(result) || || booleanNoChoice.equalsIgnoreCase(result)
CLIPrompterMessages.getString("promptbool.choices.no2") //$NON-NLS-1$ || no2.equalsIgnoreCase(result) || yes2.equalsIgnoreCase(result))) {
.equalsIgnoreCase(result) ||
CLIPrompterMessages.getString("promptbool.choices.yes2") //$NON-NLS-1$
.equalsIgnoreCase(result))) {
if (!first) { if (!first) {
manager.println(CLIPrompterMessages manager.println(CLIPrompterMessages
.getString("promptbool.choices.invalid", choices)); //$NON-NLS-1$ .getString("promptbool.choices.invalid", choices)); //$NON-NLS-1$
result = input.prompt( result = input.prompt(booleanChoices);
message + CLIPrompterMessages.getString(BOOL_CHOICES));
} }
first = false; first = false;
} }
return result.equalsIgnoreCase( return result.equalsIgnoreCase(booleanYesChoice) || result.equalsIgnoreCase(yes2); // $NON-NLS-1$
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1)) ||
result.equalsIgnoreCase(CLIPrompterMessages
.getString("promptbool.choices.yes2")); //$NON-NLS-1$
} }
/** Prompt for a choice. /** Prompt for a choice.
@@ -206,13 +198,9 @@ public final class CLIPrompter {
* @return the choice * @return the choice
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U> U promptChoice(final ConsoleOutput manager, public static <U> U promptChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<String> keys, final List<U> choices,
final List<String> keys, final String message, final String cancel) throws IOException {
final List<U> choices, final Integer index = promptChoice(manager, input, keys, message, cancel);
final String message,
final String cancel) throws IOException {
final Integer index = promptChoice(manager, input, keys, message,
cancel);
if (index == null) { if (index == null) {
return null; return null;
} }
@@ -232,13 +220,9 @@ public final class CLIPrompter {
* @return the chosen object * @return the chosen object
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U, T> T promptChoice(final ConsoleOutput manager, public static <U, T> T promptChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<U> choices, final Map<U, T> choicesMap,
final List<U> choices, final String message, final String cancel) throws IOException {
final Map<U, T> choicesMap, final Integer res = promptChoice(manager, input, choices, message, cancel);
final String message,
final String cancel) throws IOException {
final Integer res = promptChoice(manager, input, choices, message,
cancel);
if (res == null) { if (res == null) {
return null; return null;
} }
@@ -256,10 +240,8 @@ public final class CLIPrompter {
* @return the index of the choice * @return the index of the choice
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U> Integer promptChoice(final ConsoleOutput manager, public static <U> Integer promptChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<U> choices, final String message,
final List<U> choices, final String cancel) throws IOException {
final String message,
final String cancel) throws IOException {
manager.println(message); manager.println(message);
final Integer index = listChoices(manager, choices, cancel); final Integer index = listChoices(manager, choices, cancel);
String result; String result;
@@ -271,13 +253,12 @@ public final class CLIPrompter {
if (r >= 0 && r <= index.intValue()) { if (r >= 0 && r <= index.intValue()) {
break; break;
} }
manager.println(CLIPrompterMessages manager.println(CLIPrompterMessages.getString(PROMPTCHOICE_OUTOFBOUNDS,
.getString(PROMPTCHOICE_OUTOFBOUNDS, ZERO, index)); ZERO, index));
} catch (final NumberFormatException e) { } catch (final NumberFormatException e) {
LOGGER.log(Level.FINER, LOGGER.log(Level.FINER, "Unrecognized number. Prompting user again.", e); //$NON-NLS-1$
"Unrecognized number. Prompting user again.", e); //$NON-NLS-1$ manager.println(CLIPrompterMessages.getString(PROMPTCHOICE_FORMATERR,
manager.println(CLIPrompterMessages ZERO, index));
.getString(PROMPTCHOICE_FORMATERR, ZERO, index));
} }
listChoices(manager, choices, cancel); listChoices(manager, choices, cancel);
} }
@@ -299,13 +280,10 @@ public final class CLIPrompter {
* @return the chosen object * @return the chosen object
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U, T> T promptChoice(final ConsoleOutput manager, public static <U, T> T promptChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final Map<U, T> choicesMap, final String message,
final Map<U, T> choicesMap, final String cancel) throws IOException {
final String message, return promptChoice(manager, input, new ArrayList<>(choicesMap.keySet()),
final String cancel) throws IOException { choicesMap, message, cancel);
return promptChoice(manager, input,
new ArrayList<>(choicesMap.keySet()), choicesMap, message,
cancel);
} }
/** Prompt for an integer. /** Prompt for an integer.
@@ -314,8 +292,8 @@ public final class CLIPrompter {
* @param message the prompt message * @param message the prompt message
* @return the integer * @return the integer
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static int promptInteger(final ConsoleInput manager, public static int promptInteger(final ConsoleInput manager, final String message)
final String message) throws IOException { throws IOException {
boolean still = true; boolean still = true;
int r = 0; int r = 0;
while (still) { while (still) {
@@ -344,8 +322,7 @@ public final class CLIPrompter {
* @return the list of user inputs * @return the list of user inputs
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static List<String> promptList(final ConsoleOutput manager, public static List<String> promptList(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final String message) throws IOException {
final String message) throws IOException {
return promptList(manager, input, message, return promptList(manager, input, message,
CLIPrompterMessages.getString("promptlist.exit.defaultkey")); //$NON-NLS-1$ CLIPrompterMessages.getString("promptlist.exit.defaultkey")); //$NON-NLS-1$
} }
@@ -359,12 +336,10 @@ public final class CLIPrompter {
* @return the list of user inputs * @return the list of user inputs
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static List<String> promptList(final ConsoleOutput manager, public static List<String> promptList(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final String message, final String ender)
final String message, throws IOException {
final String ender) throws IOException {
final List<String> strings = new ArrayList<>(); final List<String> strings = new ArrayList<>();
manager.println( manager.println(message + CLIPrompterMessages.getString(LIST_DISP_KEY, ender));
message + CLIPrompterMessages.getString(LIST_DISP_KEY, ender));
String res = null; String res = null;
while (!ender.equals(res)) { while (!ender.equals(res)) {
res = input.prompt(CLIPrompterMessages.getString(PROMPT)); res = input.prompt(CLIPrompterMessages.getString(PROMPT));
@@ -383,10 +358,9 @@ public final class CLIPrompter {
* @return the text * @return the text
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static String promptLongText(final ConsoleOutput manager, public static String promptLongText(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final String message) throws IOException {
final String message) throws IOException { return promptLongText(manager, input, message,
return promptLongText(manager, input, message, CLIPrompterMessages CLIPrompterMessages.getString("promptlongtext.exit.defaultkey")); //$NON-NLS-1$
.getString("promptlongtext.exit.defaultkey")); //$NON-NLS-1$
} }
/** Prompt for a text with several lines. /** Prompt for a text with several lines.
@@ -398,11 +372,10 @@ public final class CLIPrompter {
* @return the text * @return the text
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static String promptLongText(final ConsoleOutput manager, public static String promptLongText(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final String message, final String ender)
final String message, throws IOException {
final String ender) throws IOException { manager.println(message
manager.println(message + CLIPrompterMessages + CLIPrompterMessages.getString("promptlongtext.exit.dispkey", ender)); //$NON-NLS-1$
.getString("promptlongtext.exit.dispkey", ender)); //$NON-NLS-1$
final StringBuilder res = new StringBuilder(); final StringBuilder res = new StringBuilder();
String line; String line;
do { do {
@@ -426,13 +399,10 @@ public final class CLIPrompter {
* @return the choice * @return the choice
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U> List<U> promptMultiChoice(final ConsoleOutput manager, public static <U> List<U> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<String> keys, final List<U> choices,
final List<String> keys, final String message) throws IOException {
final List<U> choices, final List<Integer> indices = promptMultiChoice(manager, input, keys, message);
final String message) throws IOException { final List<U> userChoices = new ArrayList<>(indices.size());
final List<Integer> indices = promptMultiChoice(manager, input, keys,
message);
final List<U> userChoices = new ArrayList<>();
for (final Integer integer : indices) { for (final Integer integer : indices) {
userChoices.add(choices.get(integer.intValue())); userChoices.add(choices.get(integer.intValue()));
} }
@@ -451,13 +421,10 @@ public final class CLIPrompter {
* @return the chosen objects (or an empty list) * @return the chosen objects (or an empty list)
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager, public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<U> choices, final Map<U, T> choicesMap,
final List<U> choices, final String message) throws IOException {
final Map<U, T> choicesMap, final List<Integer> chs = promptMultiChoice(manager, input, choices, message);
final String message) throws IOException { final List<T> userChoices = new ArrayList<>(chs.size());
final List<Integer> chs = promptMultiChoice(manager, input, choices,
message);
final List<T> userChoices = new ArrayList<>();
for (final Integer integer : chs) { for (final Integer integer : chs) {
userChoices.add(choicesMap.get(choices.get(integer.intValue()))); userChoices.add(choicesMap.get(choices.get(integer.intValue())));
} }
@@ -474,9 +441,8 @@ public final class CLIPrompter {
* @return the indices of the choices * @return the indices of the choices
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U> List<Integer> promptMultiChoice(final ConsoleOutput manager, public static <U> List<Integer> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<U> choices, final String message)
final List<U> choices, throws IOException {
final String message) throws IOException {
manager.println(message); manager.println(message);
final Integer index = listChoices(manager, choices, null); final Integer index = listChoices(manager, choices, null);
String result; String result;
@@ -492,11 +458,11 @@ public final class CLIPrompter {
try { try {
added = addUserChoice(val, chs, index.intValue()); added = addUserChoice(val, chs, index.intValue());
} catch (final NumberFormatException e) { } catch (final NumberFormatException e) {
LOGGER.log(Level.FINER, LOGGER.log(Level.FINER, "Unrecognized number. Prompting user again.", //$NON-NLS-1$
"Unrecognized number. Prompting user again.", e); //$NON-NLS-1$ e);
keepOn = true; keepOn = true;
manager.println(CLIPrompterMessages manager.println(CLIPrompterMessages.getString(PROMPTCHOICE_FORMATERR,
.getString(PROMPTCHOICE_FORMATERR, ZERO, index)); ZERO, index));
listChoices(manager, choices, null); listChoices(manager, choices, null);
break; break;
} }
@@ -522,11 +488,10 @@ public final class CLIPrompter {
* @return the chosen objects * @return the chosen objects
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager, public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final Map<U, T> choicesMap, final String message)
final Map<U, T> choicesMap, throws IOException {
final String message) throws IOException { return promptMultiChoice(manager, input, new ArrayList<>(choicesMap.keySet()),
return promptMultiChoice(manager, input, choicesMap, message);
new ArrayList<>(choicesMap.keySet()), choicesMap, message);
} }
/** Prompt the user for a non empty text. /** Prompt the user for a non empty text.
@@ -536,9 +501,8 @@ public final class CLIPrompter {
* @param reprompt the prompting message after empty input * @param reprompt the prompting message after empty input
* @return the non empty input * @return the non empty input
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static String promptNonEmpty(final ConsoleInput manager, public static String promptNonEmpty(final ConsoleInput manager, final String prompt,
final String prompt, final String reprompt) throws IOException {
final String reprompt) throws IOException {
String res = manager.prompt(prompt); String res = manager.prompt(prompt);
while (res.isEmpty()) { while (res.isEmpty()) {
res = manager.prompt(reprompt); res = manager.prompt(reprompt);

View File

@@ -36,7 +36,7 @@
* acide:fr.bigeon.acide.tool.CLIPrompterMessages.java * acide:fr.bigeon.acide.tool.CLIPrompterMessages.java
* Created on: Aug 6, 2014 * Created on: Aug 6, 2014
*/ */
package fr.bigeon.gclc.prompt; package net.bigeon.gclc.prompt;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.prompt;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.prompt;
* 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% * #L%
@@ -82,12 +82,12 @@ import java.util.logging.Logger;
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
public final class CLIPrompterMessages { public final class CLIPrompterMessages {
/** The resource name. */ /** The resource name. */
private static final String BUNDLE_NAME = "fr.bigeon.gclc.messages"; //$NON-NLS-1$ private static final String BUNDLE_NAME = "net.bigeon.gclc.messages"; //$NON-NLS-1$
/** The resource. */ /** The resource. */
private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
.getBundle(BUNDLE_NAME); .getBundle(BUNDLE_NAME);
/** The logger. */ /** The logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(CLIPrompterMessages.class.getName()); .getLogger(CLIPrompterMessages.class.getName());
/** Utility class. */ /** Utility class. */

View File

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

View File

@@ -32,7 +32,7 @@
* 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.
*/ */
package fr.bigeon.gclc.tools; package net.bigeon.gclc.tools;
/*- /*-
* #%L * #%L
@@ -41,17 +41,17 @@ package fr.bigeon.gclc.tools;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -59,32 +59,32 @@ package fr.bigeon.gclc.tools;
* 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% * #L%
*/ */
/** A {@link StringProvider} that hold a constant string. /** A {@link StringProvider} that hold a constant string.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public class ConstantString implements StringProvider { public class ConstantString implements StringProvider {
private final String string; private final String string;
/* (non-Javadoc)
* @see fr.bigeon.gclc.tools.StringProvider#apply() */
@Override
public String apply() {
return string;
}
/** Create a provider for a string. /** Create a provider for a string.
* *
* @param string the string */ * @param string the string */
public ConstantString(String string) { public ConstantString(String string) {
this.string = string; this.string = string;
} }
/* (non-Javadoc)
* @see net.bigeon.gclc.tools.StringProvider#apply() */
@Override
public String apply() {
return string;
}
} }

View File

@@ -36,7 +36,7 @@
* acide:fr.bigeon.acide.tools.PrintUtils.java * acide:fr.bigeon.acide.tools.PrintUtils.java
* Created on: Jan 20, 2015 * Created on: Jan 20, 2015
*/ */
package fr.bigeon.gclc.tools; package net.bigeon.gclc.tools;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.tools;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.tools;
* 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% * #L%
@@ -80,27 +80,27 @@ import java.util.List;
public final class PrintUtils { public final class PrintUtils {
/** The continuation dot string. */ /** The continuation dot string. */
private static final String CONT_DOT = "..."; //$NON-NLS-1$ private static final String CONT_DOT = "..."; //$NON-NLS-1$
/** The continuation dot string length. */ /** The continuation dot string length. */
private static final int CONT_DOT_LENGTH = CONT_DOT.length(); private static final int CONT_DOT_LENGTH = CONT_DOT.length();
/** The empty string constant. */ /** The empty string constant. */
private static final String EMPTY = ""; //$NON-NLS-1$ private static final String EMPTY = ""; //$NON-NLS-1$
/** Utility class. */ /** Utility class. */
private PrintUtils() { private PrintUtils() {
// Utility class // Utility class
} }
/** Print the text possibly cutting it if it goes over the authorized length /** Print the text possibly cutting it if it goes over the authorized length and
* and adding a mark of continuation. * adding a mark of continuation.
* *
* @param text the text to print * @param text the text to print
* @param nbCharacters the number of characters of the resulting text * @param nbCharacters the number of characters of the resulting text
* @param indicateTooLong if an indication shell be given that the text * @param indicateTooLong if an indication shell be given that the text didn't
* didn't fit * fit
* @return the text to print (will be of exactly nbCharacters). */ * @return the text to print (will be of exactly nbCharacters). */
public static String print(final String text, final int nbCharacters, public static String print(final String text, final int nbCharacters,
final boolean indicateTooLong) { final boolean indicateTooLong) {
StringBuilder res = new StringBuilder(text); StringBuilder res = new StringBuilder(text);
if (res.length() > nbCharacters) { if (res.length() > nbCharacters) {
// Cut // Cut
@@ -125,8 +125,7 @@ public final class PrintUtils {
* @param i the length of the wrap * @param i the length of the wrap
* @return the list of resulting strings */ * @return the list of resulting strings */
public static List<String> wrap(final String description, final int i) { public static List<String> wrap(final String description, final int i) {
final String[] originalLines = description final String[] originalLines = description.split(System.lineSeparator());
.split(System.lineSeparator());
final List<String> result = new ArrayList<>(); final List<String> result = new ArrayList<>();
for (final String string : originalLines) { for (final String string : originalLines) {
String toCut = string; String toCut = string;

View File

@@ -32,7 +32,7 @@
* 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.
*/ */
package fr.bigeon.gclc.tools; package net.bigeon.gclc.tools;
/*- /*-
* #%L * #%L
@@ -41,17 +41,17 @@ package fr.bigeon.gclc.tools;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -59,10 +59,10 @@ package fr.bigeon.gclc.tools;
* 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% * #L%
@@ -73,11 +73,11 @@ package fr.bigeon.gclc.tools;
* Implementations of this interface will provide a string, this internal state * Implementations of this interface will provide a string, this internal state
* of the object may be so that successive calls to the apply method return * of the object may be so that successive calls to the apply method return
* different results. * different results.
* *
* @author Emmanuel */ * @author Emmanuel */
public interface StringProvider { public interface StringProvider {
/** Provide a string. /** Provide a string.
* *
* @return the string */ * @return the string */
String apply(); String apply();
} }

View File

@@ -1,42 +1,38 @@
/* /** Tool classes.
* Copyright Bigeon Emmanuel (2014) *
* * @author Emmanuel Bigeon */
* emmanuel@bigeon.fr package net.bigeon.gclc.tools;
*
* 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.tools.package-info.java * knowledge of the CeCILL license and that you accept its terms.
* Created on: Nov 13, 2017 * #L%
*/ */
/** Tool classes.
*
* @author Emmanuel Bigeon */
package fr.bigeon.gclc.tools;

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.tools.AOutputForwardRunnable.java * gclc:net.bigeon.gclc.tools.AOutputForwardRunnable.java
* Created on: Dec 1, 2016 * Created on: Dec 1, 2016
*/ */
package fr.bigeon.gclc.utils; package net.bigeon.gclc.utils;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.utils;
* 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% * #L%
@@ -83,14 +83,14 @@ import java.util.logging.Logger;
public abstract class AOutputForwardRunnable implements Runnable { public abstract class AOutputForwardRunnable implements Runnable {
/** The class logger. */ /** The class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(AOutputForwardRunnable.class.getName()); .getLogger(AOutputForwardRunnable.class.getName());
/** The default timeout (one tenth of second). */ /** The default timeout (one tenth of second). */
private static final long DEFAULT_TIMEOUT = 100; private static final long DEFAULT_TIMEOUT = 100;
/** The manager. */ /** The manager. */
private final PipedConsoleOutput manager; private final PipedConsoleOutput manager;
/** The timeout. */ /** The timeout. */
private final long timeout; private final long timeout;
/** Create a forwarding runnable. /** Create a forwarding runnable.
* *
@@ -103,19 +103,18 @@ public abstract class AOutputForwardRunnable implements Runnable {
/** Create a forward runnable with the given timeout. /** Create a forward runnable with the given timeout.
* <p> * <p>
* Short timeout will be very responsive to the application actual messages, * Short timeout will be very responsive to the application actual messages, but
* but may use computation time if the application is not verbose. Long * may use computation time if the application is not verbose. Long timeout will
* timeout will save computation time, but will read batches of messages at * save computation time, but will read batches of messages at once if the
* once if the application is verbose. The right length for the timeout is * application is verbose. The right length for the timeout is likely to depend
* likely to depend on the application and the use of it. * on the application and the use of it.
* <p> * <p>
* If you do not know what timeout length to use, please use the * If you do not know what timeout length to use, please use the
* {@link #AOutputForwardRunnable(PipedConsoleOutput)} constructor. * {@link #AOutputForwardRunnable(PipedConsoleOutput)} constructor.
* *
* @param manager the manager * @param manager the manager
* @param timeout the timeout between message requests. */ * @param timeout the timeout between message requests. */
public AOutputForwardRunnable(final PipedConsoleOutput manager, public AOutputForwardRunnable(final PipedConsoleOutput manager, final long timeout) {
final long timeout) {
super(); super();
this.manager = manager; this.manager = manager;
this.timeout = timeout; this.timeout = timeout;

View File

@@ -33,29 +33,31 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.manager.EmptyInput.java * gclc:net.bigeon.gclc.manager.EmptyInput.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.manager; package net.bigeon.gclc.utils;
import net.bigeon.gclc.manager.ConsoleInput;
/*- /*-
* #%L * #%L
* Generic Command Ligne console * Generic Command Ligne console
* %% * %%
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,88 +65,90 @@ package fr.bigeon.gclc.manager;
* 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% * #L%
*/ */
import fr.bigeon.gclc.tools.ConstantString;
import fr.bigeon.gclc.tools.StringProvider; import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.tools.StringProvider;
/** A console input that return empty to all prompting. /** A console input that return empty to all prompting.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class EmptyInput implements ConsoleInput { public final class EmptyInput implements ConsoleInput {
private static final ConstantString CONSTANT_STRING = new ConstantString("");
/** The empty prompter. */ /** The empty prompter. */
public static final ConsoleInput INSTANCE = new EmptyInput(); public static final ConsoleInput INSTANCE = new EmptyInput();
/** The empty input. */ /** The empty input. */
private EmptyInput() { private EmptyInput() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#close() */ * @see net.bigeon.gclc.manager.ConsoleInput#close() */
@Override @Override
public void close() { public void close() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override @Override
public StringProvider getPrompt() { public StringProvider getPrompt() {
return new ConstantString(""); //$NON-NLS-1$ return CONSTANT_STRING; //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
@Override @Override
public void interruptPrompt() { public void interruptPrompt() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleInput#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return false; return false;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override @Override
public String prompt() { public String prompt() {
return ""; //$NON-NLS-1$ return ""; //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */ * @see net.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override @Override
public String prompt(final long timeout) { public String prompt(final long timeout) {
return ""; //$NON-NLS-1$ return ""; //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
@Override @Override
public String prompt(final String message) { public String prompt(final String message) {
return ""; //$NON-NLS-1$ return ""; //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, * @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
* long) */
@Override @Override
public String prompt(final String message, public String prompt(final String message, final long timeout) {
final long timeout) {
return ""; //$NON-NLS-1$ return ""; //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override @Override
public void setPrompt(final String prompt) { public void setPrompt(final String prompt) {
// //
@@ -152,6 +156,6 @@ public final class EmptyInput implements ConsoleInput {
@Override @Override
public void setPrompt(StringProvider string) { public void setPrompt(StringProvider string) {
// //
} }
} }

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc-test:fr.bigeon.gclc.test.TestConsoleManager.java * gclc-test:net.bigeon.gclc.test.TestConsoleManager.java
* Created on: Nov 18, 2016 * Created on: Nov 18, 2016
*/ */
package fr.bigeon.gclc.utils; package net.bigeon.gclc.utils;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.utils;
* 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% * #L%
@@ -77,8 +77,8 @@ import java.io.PipedOutputStream;
import java.io.PrintStream; import java.io.PrintStream;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.tools.StringProvider; import net.bigeon.gclc.tools.StringProvider;
/** This console input allows to enter commands and retrieve the output as an /** This console input allows to enter commands and retrieve the output as an
* input. * input.
@@ -87,17 +87,16 @@ import fr.bigeon.gclc.tools.StringProvider;
* used to test application behavior. * used to test application behavior.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class PipedConsoleInput public final class PipedConsoleInput implements ConsoleInput {
implements ConsoleInput {
/** THe inner manager. */ /** THe inner manager. */
private final StreamConsoleInput innerManager; private final StreamConsoleInput innerManager;
/** The stream to pipe commands into. */ /** The stream to pipe commands into. */
private final PipedOutputStream commandInput; private final PipedOutputStream commandInput;
/** The stream for the application to read commands from. */ /** The stream for the application to read commands from. */
private final PipedInputStream in; private final PipedInputStream in;
/** The writing thread. */ /** The writing thread. */
private final WritingRunnable writing; private final WritingRunnable writing;
/** Create a manager that will write and read through piped stream. /** Create a manager that will write and read through piped stream.
* *
@@ -106,11 +105,9 @@ public final class PipedConsoleInput
public PipedConsoleInput(final PrintStream outPrint) throws IOException { public PipedConsoleInput(final PrintStream outPrint) throws IOException {
commandInput = new PipedOutputStream(); commandInput = new PipedOutputStream();
in = new PipedInputStream(commandInput); in = new PipedInputStream(commandInput);
innerManager = new StreamConsoleInput(outPrint, in, innerManager = new StreamConsoleInput(outPrint, in, StandardCharsets.UTF_8);
StandardCharsets.UTF_8);
writing = new WritingRunnable(commandInput, StandardCharsets.UTF_8); writing = new WritingRunnable(commandInput, StandardCharsets.UTF_8);
final Thread th = new Thread(writing, final Thread th = new Thread(writing, "GCLC console piped input stream"); //$NON-NLS-1$
"GCLC console piped input stream"); //$NON-NLS-1$
th.start(); th.start();
} }
@@ -128,59 +125,57 @@ public final class PipedConsoleInput
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */ * @see net.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
@Override @Override
public void interruptPrompt() { public void interruptPrompt() {
innerManager.interruptPrompt(); innerManager.interruptPrompt();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleInput#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return innerManager.isClosed(); return innerManager.isClosed();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override @Override
public String prompt() throws IOException { public String prompt() throws IOException {
return innerManager return innerManager.prompt(innerManager.getPrompt() + System.lineSeparator());
.prompt(innerManager.getPrompt() + System.lineSeparator());
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */ * @see net.bigeon.gclc.manager.ConsoleManager#prompt(long) */
@Override @Override
public String prompt(final long timeout) throws IOException { public String prompt(final long timeout) throws IOException {
return innerManager.prompt(timeout); return innerManager.prompt(timeout);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
@Override @Override
public String prompt(final String message) throws IOException { public String prompt(final String message) throws IOException {
return innerManager.prompt(message + System.lineSeparator()); return innerManager.prompt(message + System.lineSeparator());
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, * @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
* long) */
@Override @Override
public String prompt(final String message, final long timeout) throws IOException { public String prompt(final String message, final long timeout) throws IOException {
return innerManager.prompt(message + System.lineSeparator(), timeout); return innerManager.prompt(message + System.lineSeparator(), timeout);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override @Override
public void setPrompt(final String prompt) { public void setPrompt(final String prompt) {
innerManager.setPrompt(prompt); innerManager.setPrompt(prompt);
} }
@Override @Override
public void setPrompt(StringProvider string) { public void setPrompt(StringProvider string) {
innerManager.setPrompt(string); innerManager.setPrompt(string);
} }
/** Type a message in the input. /** Type a message in the input.

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc-test:fr.bigeon.gclc.test.TestConsoleManager.java * gclc-test:net.bigeon.gclc.test.TestConsoleManager.java
* Created on: Nov 18, 2016 * Created on: Nov 18, 2016
*/ */
package fr.bigeon.gclc.utils; package net.bigeon.gclc.utils;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.utils;
* 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% * #L%
@@ -79,7 +79,7 @@ import java.io.PipedOutputStream;
import java.io.PrintStream; import java.io.PrintStream;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** This console output allows to retrieve the output as an input. /** This console output allows to retrieve the output as an input.
* <p> * <p>
@@ -87,21 +87,20 @@ import fr.bigeon.gclc.manager.ConsoleOutput;
* used to test application behavior. * used to test application behavior.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class PipedConsoleOutput public final class PipedConsoleOutput implements ConsoleOutput {
implements ConsoleOutput {
/** The encoding between streams. */ /** The encoding between streams. */
private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$ private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$
/** THe inner manager. */ /** THe inner manager. */
private final StreamConsoleOutput innerManager; private final StreamConsoleOutput innerManager;
/** The reader to get application return from. */ /** The reader to get application return from. */
private final BufferedReader commandBuffOutput; private final BufferedReader commandBuffOutput;
/** The stream to get application return from. */ /** The stream to get application return from. */
private final PipedInputStream commandOutput; private final PipedInputStream commandOutput;
/** The print writer for application to write return to. */ /** The print writer for application to write return to. */
private final PrintStream outPrint; private final PrintStream outPrint;
/** The reading thread. */ /** The reading thread. */
private final ReadingRunnable reading; private final ReadingRunnable reading;
/** Create a manager that will write and read through piped stream. /** Create a manager that will write and read through piped stream.
* *
@@ -140,39 +139,39 @@ public final class PipedConsoleOutput
/** Wait for a specific message to arrive. /** Wait for a specific message to arrive.
* <p> * <p>
* When this method returns, the message was appended to the data, it * When this method returns, the message was appended to the data, it <em>may or
* <em>may or may not</em> be the next line of data. * may not</em> be the next line of data.
* *
* @param message the message * @param message the message
* @return the thread to join to wait for message delivery * @throws InterruptedException if the wait on the message was interrupted
* @see fr.bigeon.gclc.utils.ReadingRunnable#getWaitForDelivery(java.lang.String) */ * @see net.bigeon.gclc.utils.ReadingRunnable#waitForDelivery(String) */
public Thread getWaitForDelivery(final String message) { public void waitForDelivery(final String message) throws InterruptedException {
return reading.getWaitForDelivery(message); reading.waitForDelivery(message);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleOutput#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return innerManager.isClosed(); return innerManager.isClosed();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
@Override @Override
public void print(final String object) throws IOException { public void print(final String object) throws IOException {
innerManager.print(object); innerManager.print(object);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */ * @see net.bigeon.gclc.manager.ConsoleOutput#println() */
@Override @Override
public void println() throws IOException { public void println() throws IOException {
innerManager.println(); innerManager.println();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
@Override @Override
public void println(final String object) throws IOException { public void println(final String object) throws IOException {
innerManager.println(object); innerManager.println(object);

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.test.utils.WritingRunnable.java * gclc:net.bigeon.gclc.test.utils.WritingRunnable.java
* Created on: Nov 29, 2016 * Created on: Nov 29, 2016
*/ */
package fr.bigeon.gclc.utils; package net.bigeon.gclc.utils;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.utils;
* 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% * #L%
@@ -76,8 +76,8 @@ import java.io.IOException;
import java.io.InterruptedIOException; import java.io.InterruptedIOException;
import java.util.ArrayDeque; import java.util.ArrayDeque;
import java.util.Deque; import java.util.Deque;
import java.util.HashMap;
import java.util.Map; import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
@@ -86,91 +86,31 @@ import java.util.logging.Logger;
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class ReadingRunnable implements Runnable { public final class ReadingRunnable implements Runnable {
/** The runnable to wait for arrival of a message in the queue.
*
* @author Emmanuel Bigeon */
private final class ToWaitRunnable implements Runnable {
/** The Object. */
private final Object obj;
/** The locking object. */
private final Object start;
/** The message. */
private final String message;
/** The started status. */
private boolean started = false;
/** Create the waiting runnable.
*
* @param obj the object to lock on
* @param start the object to notify when ready to wait
* @param message the message to wait for */
public ToWaitRunnable(final Object obj, final Object start,
final String message) {
this.obj = obj;
this.start = start;
this.message = message;
}
/** Test if the waiting runnable is started.
*
* @return the started */
public boolean isStarted() {
synchronized (start) {
return started;
}
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
synchronized (obj) {
synchronized (start) {
started = true;
start.notifyAll();
}
while (isRunning()) {
try {
obj.wait();
if (delivering.equals(message)) {
return;
}
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
e);
Thread.currentThread().interrupt();
}
}
}
}
}
/** The thread intteruption logging message. */ /** The thread intteruption logging message. */
private static final String THREAD_INTERRUPTION_EXCEPTION = "Thread interruption exception."; //$NON-NLS-1$ private static final String THREAD_INTERRUPTION_EXCEPTION = "Thread interruption exception."; //$NON-NLS-1$
/** The closed pipe message. */ /** The closed pipe message. */
private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$ private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$
/** Wait timeout. */ /** Wait timeout. */
private static final long TIMEOUT = 1000; private static final long TIMEOUT = 1000;
/** Class logger. */ /** Class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(ReadingRunnable.class.getName()); .getLogger(ReadingRunnable.class.getName());
/** Read messages. */ /** Read messages. */
private final Deque<String> messages = new ArrayDeque<>(); private final Deque<String> messages = new ArrayDeque<>();
/** the reader. */
private final BufferedReader reader;
/** the state of this runnable. */
private boolean running = true;
/** Synchro object. */
private final Object lock = new Object();
/** The waiting status for a message. */
private boolean waiting;
/** The blocker for a given message. */
private final Map<String, Object> messageBlocker = new HashMap<>();
/** The lock. */
private final Object messageBlockerLock = new Object();
/** The message being delivered. */
private String delivering;
/** the reader. */
private final BufferedReader reader;
/** the state of this runnable. */
private boolean running = true;
/** Synchro object. */
private final Object lock = new Object();
/** The waiting status for a message. */
private boolean waiting;
/** The blocker for a given message. */
private final Map<String, Object> messageBlocker = new ConcurrentHashMap<>();
/** The lock. */
private final Object messageBlockerLock = new Object();
/** Create a reading runnable. /** Create a reading runnable.
* *
* @param reader the input to read from */ * @param reader the input to read from */
@@ -179,28 +119,17 @@ public final class ReadingRunnable implements Runnable {
this.reader = reader; this.reader = reader;
} }
/** Strip the string from head NULL characters. /** Do wait for a message.
* <p>
* This method should only be called inside a loop.
* *
* @param line the line to strip the null character from
* @return the resulting string */
private static String stripNull(final String line) {
String res = line;
while (res.length() > 0 && res.charAt(0) == 0) {
LOGGER.severe(
"NULL character heading the result of the read. This is a stream problem..."); //$NON-NLS-1$
res = res.substring(1);
}
return res;
}
/** do wait for a message.
* <p>This method should only be called inside a loop.
* @param timeout the timeout of the wait. * @param timeout the timeout of the wait.
* @throws IOException if the runnable was stopped and no essage was found. * @throws IOException if the runnable was stopped and no essage was found. */
*/
private void doWaitMessage(final long timeout) throws IOException { private void doWaitMessage(final long timeout) throws IOException {
try { try {
lock.wait(timeout); synchronized (lock) {
lock.wait(timeout);
}
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e); LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e);
Thread.currentThread().interrupt(); Thread.currentThread().interrupt();
@@ -221,7 +150,7 @@ public final class ReadingRunnable implements Runnable {
} }
waiting = true; waiting = true;
waitMessage(TIMEOUT); waitMessage(TIMEOUT);
LOGGER.finest("Polled: " + messages.peek()); //$NON-NLS-1$ LOGGER.log(Level.FINEST, "Polled: {0}", messages.peek()); //$NON-NLS-1$
waiting = false; waiting = false;
notifyMessage(messages.peek()); notifyMessage(messages.peek());
return messages.poll(); return messages.poll();
@@ -247,38 +176,20 @@ public final class ReadingRunnable implements Runnable {
return messages.poll(); return messages.poll();
} }
} }
/** Get a waiting thread for a specific message delivery. public void waitForDelivery(String message) throws InterruptedException {
* Object mLock;
* @param message the message
* @return the thread to join to wait for message delivery */
public Thread getWaitForDelivery(final String message) {
synchronized (messageBlockerLock) { synchronized (messageBlockerLock) {
if (!messageBlocker.containsKey(message)) { if (!messageBlocker.containsKey(message)) {
messageBlocker.put(message, new Object()); messageBlocker.put(message, new Object());
} }
final Object obj = messageBlocker.get(message); mLock = messageBlocker.get(message);
final Object start = new Object(); }
final ToWaitRunnable waitRunn = new ToWaitRunnable(obj, start, synchronized (mLock) {
message); mLock.wait();
final Thread th = new Thread(waitRunn);
synchronized (start) {
th.start();
while (!waitRunn.isStarted()) {
try {
start.wait(TIMEOUT);
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
e);
Thread.currentThread().interrupt();
}
}
}
return th;
} }
} }
/** Test if some data is available. /** Test if some data is available.
* *
* @return if a message is waiting * @return if a message is waiting
@@ -292,8 +203,7 @@ public final class ReadingRunnable implements Runnable {
} }
} }
/** Interrupts the wait on the next message by providing an empty /** Interrupts the wait on the next message by providing an empty message. */
* message. */
public void interrupt() { public void interrupt() {
synchronized (lock) { synchronized (lock) {
if (waiting) { if (waiting) {
@@ -317,9 +227,8 @@ public final class ReadingRunnable implements Runnable {
* @param message the message */ * @param message the message */
private void notifyMessage(final String message) { private void notifyMessage(final String message) {
synchronized (messageBlockerLock) { synchronized (messageBlockerLock) {
delivering = message; final Object mLock = messageBlocker.get(message);
if (messageBlocker.containsKey(message)) { if (mLock!=null) {
final Object mLock = messageBlocker.get(message);
synchronized (mLock) { synchronized (mLock) {
mLock.notifyAll(); mLock.notifyAll();
} }
@@ -332,32 +241,41 @@ public final class ReadingRunnable implements Runnable {
* @see java.lang.Runnable#run() */ * @see java.lang.Runnable#run() */
@Override @Override
public void run() { public void run() {
while (running) { while (true) {
synchronized (lock) {
if (!running) {
break;
}
}
try { try {
String line = reader.readLine(); String line = reader.readLine();
if (line == null) { if (line == null) {
// Buffer end // Buffer end
running = false; setRunning(false);
return; return;
} }
LOGGER.finer("Read: " + line); //$NON-NLS-1$ LOGGER.log(Level.FINER, "Read: {0}", line); //$NON-NLS-1$
line = stripNull(line); line = stripNull(line);
synchronized (lock) { synchronized (lock) {
messages.add(line); messages.add(line);
lock.notifyAll(); lock.notifyAll();
} }
} catch (final InterruptedIOException e) { } catch (final InterruptedIOException e) {
if (running) { synchronized (lock) {
LOGGER.info("Reading interrupted"); //$NON-NLS-1$ if (running) {
LOGGER.info("Reading interrupted"); //$NON-NLS-1$
}
} }
LOGGER.log(Level.FINER, LOGGER.log(Level.FINER, "Read interruption was caused by an exception", //$NON-NLS-1$
"Read interruption was caused by an exception", e); //$NON-NLS-1$ e);
} catch (final IOException e) { } catch (final IOException e) {
LOGGER.log(Level.FINE, "The stream reading threw an exception", //$NON-NLS-1$ LOGGER.log(Level.FINE, "The stream reading threw an exception", //$NON-NLS-1$
e); e);
if (running) { synchronized (lock) {
LOGGER.severe("Unable to read from stream"); //$NON-NLS-1$ if (running) {
running = false; LOGGER.severe("Unable to read from stream"); //$NON-NLS-1$
setRunning(false);
}
} }
return; return;
} }
@@ -373,14 +291,28 @@ public final class ReadingRunnable implements Runnable {
} }
} }
/** Wait for the next message to be integratted. /** Wait for the next message to be integrated.
* *
* @param timeout the timeout to wait * @param timeout the timeout to wait
* @throws IOException if the next message was not delivered and the * @throws IOException if the next message was not delivered and the runnable
* runnable stopped. */ * stopped. */
private void waitMessage(final long timeout) throws IOException { private void waitMessage(final long timeout) throws IOException {
while (messages.isEmpty()) { while (messages.isEmpty()) {
doWaitMessage(timeout); doWaitMessage(timeout);
} }
} }
/** Strip the string from head NULL characters.
*
* @param line the line to strip the null character from
* @return the resulting string */
private static String stripNull(final String line) {
String res = line;
while (res.length() > 0 && res.charAt(0) == 0) {
LOGGER.severe(
"NULL character heading the result of the read. This is a stream problem..."); //$NON-NLS-1$
res = res.substring(1);
}
return res;
}
} }

View File

@@ -33,12 +33,12 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.manager.SinkOutput.java * gclc:net.bigeon.gclc.manager.SinkOutput.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.utils; package net.bigeon.gclc.utils;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/*- /*-
* #%L * #%L
@@ -47,17 +47,17 @@ import fr.bigeon.gclc.manager.ConsoleOutput;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -65,10 +65,10 @@ import fr.bigeon.gclc.manager.ConsoleOutput;
* 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% * #L%
@@ -85,37 +85,37 @@ public final class SinkOutput implements ConsoleOutput {
private SinkOutput() { private SinkOutput() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#close() */ * @see net.bigeon.gclc.manager.ConsoleOutput#close() */
@Override @Override
public void close() { public void close() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleOutput#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return false; return false;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
@Override @Override
public void print(final String text) { public void print(final String text) {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */ * @see net.bigeon.gclc.manager.ConsoleOutput#println() */
@Override @Override
public void println() { public void println() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) * @see net.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
*/
@Override @Override
public void println(final String message) { public void println(final String message) {
// //

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.system.SystemConsoleManager.java * gclc:net.bigeon.gclc.system.SystemConsoleManager.java
* Created on: Dec 19, 2014 * Created on: Dec 19, 2014
*/ */
package fr.bigeon.gclc.utils; package net.bigeon.gclc.utils;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.utils;
* 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% * #L%
@@ -78,9 +78,9 @@ import java.io.InputStreamReader;
import java.io.PrintStream; import java.io.PrintStream;
import java.nio.charset.Charset; import java.nio.charset.Charset;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.tools.ConstantString; import net.bigeon.gclc.tools.ConstantString;
import fr.bigeon.gclc.tools.StringProvider; import net.bigeon.gclc.tools.StringProvider;
/** A console using the input stream and print stream. /** A console using the input stream and print stream.
* <p> * <p>
@@ -96,12 +96,12 @@ public final class StreamConsoleInput implements ConsoleInput {
private StringProvider prompt = DEFAULT_PROMPT; private StringProvider prompt = DEFAULT_PROMPT;
/** The print stream. */ /** The print stream. */
private final PrintStream out; private final PrintStream out;
/** The input stream. */ /** The input stream. */
private final BufferedReader in; private final BufferedReader in;
/** If the manager is closed. */ /** If the manager is closed. */
private boolean closed = false; private boolean closed;
/** The prompting thread. */ /** The prompting thread. */
private final Thread promptThread; private final Thread promptThread;
@@ -109,8 +109,8 @@ public final class StreamConsoleInput implements ConsoleInput {
/** The reading runnable. */ /** The reading runnable. */
private final ReadingRunnable reading; private final ReadingRunnable reading;
/** This default constructor relies on the system defined standart output /** This default constructor relies on the system defined standart output and
* and input stream. */ * input stream. */
public StreamConsoleInput() { public StreamConsoleInput() {
this(System.out, System.in, Charset.defaultCharset()); this(System.out, System.in, Charset.defaultCharset());
} }
@@ -121,7 +121,7 @@ public final class StreamConsoleInput implements ConsoleInput {
* @param in the input stream * @param in the input stream
* @param charset the charset for the input */ * @param charset the charset for the input */
public StreamConsoleInput(final PrintStream out, final InputStream in, public StreamConsoleInput(final PrintStream out, final InputStream in,
final Charset charset) { final Charset charset) {
super(); super();
this.out = out; this.out = out;
this.in = new BufferedReader(new InputStreamReader(in, charset)); this.in = new BufferedReader(new InputStreamReader(in, charset));
@@ -141,16 +141,16 @@ public final class StreamConsoleInput implements ConsoleInput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */ * @see net.bigeon.gclc.manager.ConsoleManager#close() */
@Override @Override
public void close() throws IOException { public void close() {
closed = true; closed = true;
reading.setRunning(false); reading.setRunning(false);
promptThread.interrupt(); promptThread.interrupt();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override @Override
public StringProvider getPrompt() { public StringProvider getPrompt() {
return prompt; return prompt;
@@ -158,35 +158,35 @@ public final class StreamConsoleInput implements ConsoleInput {
/** Beware, in this implementation this is the same as closing the manager. /** Beware, in this implementation this is the same as closing the manager.
* *
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
@Override @Override
public void interruptPrompt() { public void interruptPrompt() {
reading.interrupt(); reading.interrupt();
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleManager#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return closed; return closed;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#prompt() */ * @see net.bigeon.gclc.ConsoleManager#prompt() */
@Override @Override
public String prompt() throws IOException { public String prompt() throws IOException {
return prompt(prompt.apply()); return prompt(prompt.apply());
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */ * @see net.bigeon.gclc.manager.ConsoleManager#prompt(long) */
@Override @Override
public String prompt(final long timeout) throws IOException { public String prompt(final long timeout) throws IOException {
return prompt(prompt.apply(), timeout); return prompt(prompt.apply(), timeout);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */ * @see net.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
@Override @Override
public String prompt(final String message) throws IOException { public String prompt(final String message) throws IOException {
checkOpen(); checkOpen();
@@ -198,10 +198,9 @@ public final class StreamConsoleInput implements ConsoleInput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */ * @see net.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
@Override @Override
public String prompt(final String message, public String prompt(final String message, final long timeout) throws IOException {
final long timeout) throws IOException {
checkOpen(); checkOpen();
if (out != null) { if (out != null) {
out.print(message); out.print(message);
@@ -211,7 +210,7 @@ public final class StreamConsoleInput implements ConsoleInput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */ * @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override @Override
public void setPrompt(final String prompt) { public void setPrompt(final String prompt) {
this.prompt = new ConstantString(prompt); this.prompt = new ConstantString(prompt);
@@ -219,6 +218,6 @@ public final class StreamConsoleInput implements ConsoleInput {
@Override @Override
public void setPrompt(StringProvider string) { public void setPrompt(StringProvider string) {
this.prompt = string; prompt = string;
} }
} }

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.system.SystemConsoleManager.java * gclc:net.bigeon.gclc.system.SystemConsoleManager.java
* Created on: Dec 19, 2014 * Created on: Dec 19, 2014
*/ */
package fr.bigeon.gclc.utils; package net.bigeon.gclc.utils;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.utils;
* 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% * #L%
@@ -74,7 +74,7 @@ package fr.bigeon.gclc.utils;
import java.io.IOException; import java.io.IOException;
import java.io.PrintStream; import java.io.PrintStream;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** A console using the input stream and print stream. /** A console using the input stream and print stream.
* <p> * <p>
@@ -85,10 +85,10 @@ public final class StreamConsoleOutput implements ConsoleOutput {
/** The print stream. */ /** The print stream. */
private final PrintStream out; private final PrintStream out;
/** If the manager is closed. */ /** If the manager is closed. */
private boolean closed = false; private boolean closed;
/** This default constructor relies on the system defined standart output /** This default constructor relies on the system defined standart output and
* and input stream. */ * input stream. */
public StreamConsoleOutput() { public StreamConsoleOutput() {
this(System.out); this(System.out);
} }
@@ -111,21 +111,21 @@ public final class StreamConsoleOutput implements ConsoleOutput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */ * @see net.bigeon.gclc.manager.ConsoleManager#close() */
@Override @Override
public void close() { public void close() {
closed = true; closed = true;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */ * @see net.bigeon.gclc.manager.ConsoleManager#isClosed() */
@Override @Override
public boolean isClosed() { public boolean isClosed() {
return closed; return closed;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#print(java.lang.Object) */ * @see net.bigeon.gclc.ConsoleManager#print(java.lang.Object) */
@Override @Override
public void print(final String object) throws IOException { public void print(final String object) throws IOException {
checkOpen(); checkOpen();
@@ -133,7 +133,7 @@ public final class StreamConsoleOutput implements ConsoleOutput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#println() */ * @see net.bigeon.gclc.ConsoleManager#println() */
@Override @Override
public void println() throws IOException { public void println() throws IOException {
checkOpen(); checkOpen();
@@ -141,7 +141,7 @@ public final class StreamConsoleOutput implements ConsoleOutput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#println(java.lang.Object) */ * @see net.bigeon.gclc.ConsoleManager#println(java.lang.Object) */
@Override @Override
public void println(final String object) throws IOException { public void println(final String object) throws IOException {
checkOpen(); checkOpen();

View File

@@ -33,10 +33,10 @@
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.test.utils.WritingRunnable.java * gclc:net.bigeon.gclc.test.utils.WritingRunnable.java
* Created on: Nov 29, 2016 * Created on: Nov 29, 2016
*/ */
package fr.bigeon.gclc.utils; package net.bigeon.gclc.utils;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package fr.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 bigeon.fr
* %% * %%
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* 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,
@@ -63,10 +63,10 @@ package fr.bigeon.gclc.utils;
* 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% * #L%
@@ -88,18 +88,18 @@ import java.util.logging.Logger;
public final class WritingRunnable implements Runnable { public final class WritingRunnable implements Runnable {
/** Wait timeout. */ /** Wait timeout. */
private static final long TIMEOUT = 1000; private static final long TIMEOUT = 1000;
/** Class logger. */ /** Class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(WritingRunnable.class.getName()); .getLogger(WritingRunnable.class.getName());
/** Messages to write. */ /** Messages to write. */
private final Deque<String> messages = new ArrayDeque<>(); private final Deque<String> messages = new ArrayDeque<>();
/** Stream to write to. */ /** Stream to write to. */
private final OutputStream outPrint; private final OutputStream outPrint;
/** The charset. */ /** The charset. */
private final Charset charset; private final Charset charset;
/** Runnable state. */ /** Runnable state. */
private boolean running = true; private boolean running = true;
/** Synchro object. */ /** Synchro object. */
private final Object lock = new Object(); private final Object lock = new Object();
@@ -143,15 +143,14 @@ public final class WritingRunnable implements Runnable {
public void run() { public void run() {
while (running) { while (running) {
synchronized (lock) { synchronized (lock) {
while (messages.isEmpty()) { waitNextMessage();
waitNextMessage(); if (!running) {
if (!running) { return;
return;
}
} }
writeMessage(); writeMessage();
} }
} }
} }
/** Set the running status. /** Set the running status.
@@ -166,11 +165,16 @@ public final class WritingRunnable implements Runnable {
/** Wait for next message. */ /** Wait for next message. */
private void waitNextMessage() { private void waitNextMessage() {
try { try {
lock.wait(TIMEOUT); synchronized (lock) {
while (running && messages.isEmpty()) {
lock.wait(TIMEOUT);
}
}
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
if (running) { synchronized (lock) {
LOGGER.log(Level.SEVERE, if (running) {
"Thread interruption exception.", e); //$NON-NLS-1$ LOGGER.log(Level.SEVERE, "Thread interruption exception.", e); //$NON-NLS-1$
}
} }
Thread.currentThread().interrupt(); Thread.currentThread().interrupt();
} }
@@ -179,8 +183,7 @@ public final class WritingRunnable implements Runnable {
/** Write next message to output. */ /** Write next message to output. */
private void writeMessage() { private void writeMessage() {
final String message = messages.poll(); final String message = messages.poll();
final ByteBuffer buff = charset final ByteBuffer buff = charset.encode(message + System.lineSeparator());
.encode(message + System.lineSeparator());
if (buff.hasArray()) { if (buff.hasArray()) {
try { try {
outPrint.write(buff.array()); outPrint.write(buff.array());

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