Compare commits

..

75 Commits

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

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

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

View File

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

View File

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

View File

@@ -1,127 +0,0 @@
/*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
* gclc-process:fr.bigeon.gclc.process.ForkTask.java
* Created on: Nov 13, 2017
*/
package fr.bigeon.gclc.process;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.manager.ConsoleInput;
import fr.bigeon.gclc.manager.ConsoleOutput;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon
*
*/
public class ForkTask implements Task {
private final ICommand command;
private final String[] args;
private final Set<InterruptionListener> listeners = new HashSet<>();
private boolean running = false;
/** @param cmd the command
* @param args the arguements */
public ForkTask(final ICommand cmd, final String[] args) {
command = cmd;
this.args = Arrays.copyOf(args, args.length);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#addInterruptionListener(fr.bigeon.gclc.
* process.InterruptionListener) */
@Override
public void addInterruptionListener(final InterruptionListener listener) {
listeners.add(listener);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#getName() */
@Override
public String getName() {
return command.getCommandName();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#isRunning() */
@Override
public boolean isRunning() {
return running;
}
/** @param out the console output
* @param in the console input */
public void join(final ConsoleOutput out, final ConsoleInput in) {
// TODO Auto-generated method stub
//
throw new RuntimeException("Not implemented yet");
}
/* (non-Javadoc)
* @see
* fr.bigeon.gclc.process.Task#rmInterruptionListener(fr.bigeon.gclc.process
* .InterruptionListener) */
@Override
public void rmInterruptionListener(final InterruptionListener listener) {
listeners.remove(listener);
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
running = true;
try {
// TODO Auto-generated method stub
//
throw new RuntimeException("Not implemented yet");
} finally {
running = false;
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.process.Task#setRunning(boolean) */
@Override
public void setRunning(final boolean running) {
this.running = running;
}
}

View File

@@ -1,115 +0,0 @@
/*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2017 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
* gclc:fr.bigeon.gclc.proc.TaskPool.java
* Created on: May 10, 2017
*/
package fr.bigeon.gclc.process;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
/** A process pool.
*
* @author Emmanuel Bigeon */
public final class TaskPool {
/** The running processes. */
private final Map<String, Task> running = new HashMap<>();
/** The count for process id. */
private int count = 0;
/** The lock for pid attribution synchronization. */
private final Object lock = new Object();
/** Default constructor. */
public TaskPool() {
//
}
/** Add a process in the pool.
*
* @param cmd the process
* @return the pid */
public String add(final Task cmd) {
if (cmd == null) {
throw new IllegalArgumentException("Task cannot be null"); //$NON-NLS-1$
}
final String pid = getPID();
synchronized (lock) {
running.put(pid, cmd);
}
cmd.addInterruptionListener(new InterruptionListener() {
@SuppressWarnings("synthetic-access")
@Override
public void interrupted() {
synchronized (lock) {
running.remove(pid);
count = Math.min(count, Integer.parseInt(pid));
}
cmd.rmInterruptionListener(this);
}
});
return pid;
}
/** Get a process by it associated identifier.
*
* @param pid the task id
* @return the task, if any, associated to this id */
public Task get(final String pid) {
synchronized (lock) {
return running.get(pid);
}
}
/** Get the next process id.
*
* @return the process id */
private String getPID() {
synchronized (lock) {
String pid;
do {
pid = Integer.toString(count++);
} while (running.containsKey(pid));
return pid;
}
}
/** Get the running processes' identifiers.
*
* @return the pids */
public Collection<String> getPIDs() {
return new HashSet<>(running.keySet());
}
}

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

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

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

View File

@@ -1,134 +1,96 @@
<!-- 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</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.9</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.5</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.12</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 <groupId>com.github.sevntu-checkstyle</groupId>
of Emmanuel Bigeon. --> <artifactId>dsm-maven-plugin</artifactId>
<!-- --> <version>2.2.0</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, --> </plugins>
<!-- modify and/or redistribute the software under the terms of the CeCILL --> </reporting>
<!-- license as circulated by CEA, CNRS and INRIA at the following URL --> <developers>
<!-- "http://www.cecill.info". --> <developer>
<!-- --> <email>emmanuel@bigeon.fr</email>
<!-- As a counterpart to the access to the source code and rights to copy, --> <name>Emmanuel Bigeon</name>
<!-- modify and redistribute granted by the license, users are provided only --> <url>bigeon.net</url>
<!-- with a limited warranty and the software's author, the holder of the --> <roles>
<!-- economic rights, and the successive licensors have only limited --> <role>PM</role>
<!-- liability. --> </roles>
<!-- --> </developer>
<!-- In this respect, the user's attention is drawn to the risks associated --> </developers>
<!-- with loading, using, modifying and/or developing or reproducing the --> <name>GCLC Socket</name>
<!-- software by the user in light of its specific status of free software, --> <description>Socket implementation of GCLC</description>
<!-- that may mean that it is complicated to manipulate, and that also --> <scm>
<!-- therefore means that it is reserved for developers and experienced --> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<!-- professionals having in-depth computer knowledge. Users are therefore --> <tag>gclc-socket-1.1.11</tag>
<!-- encouraged to load and test the software's suitability as regards their --> </scm>
<!-- requirements in conditions enabling the security of their systems and/or --> <groupId>net.bigeon.gclc</groupId>
<!-- data to be ensured and, more generally, to use and operate it in the --> <inceptionYear>2016</inceptionYear>
<!-- same conditions as regards security. --> </project>
<!-- -->
<!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/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.fr/emmanuel</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.scm.id>git.bigeon.net</project.scm.id>
</properties>
<dependencies>
<dependency>
<groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.4-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>fr.bigeon</groupId>
<artifactId>smu</artifactId>
<version>0.0.7</version>
</dependency>
</dependencies>
<parent>
<groupId>fr.bigeon</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.7.1</version>
</parent>
<name>GCLC Socket</name>
<description>Socket implementation of GCLC</description>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag>
</scm>
</project>

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

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,158 +1,152 @@
/* package net.bigeon.gclc.socket;
* GCLC Socket, Socket implementation of GCLC
* Copyright (C) 2014-2017 E. Bigeon /*-
* mailto:emmanuel@bigeon.fr * #%L
* * GCLC Socket
* 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) 2016 - 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.
*/ *
package fr.bigeon.gclc.socket; * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
import java.io.IOException; * #L%
import java.net.Socket; */
import java.util.Collection; import java.io.IOException;
import java.net.Socket;
import fr.bigeon.gclc.ConsoleApplication; import java.util.Collection;
import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.command.ExitCommand; import net.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.command.HelpExecutor; import net.bigeon.gclc.command.Command;
import fr.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.command.base.ExitCommand;
import fr.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.command.base.HelpExecutor;
import fr.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput;
/** A test-purpose application import net.bigeon.gclc.manager.ConsoleOutput;
*
* @author Emmanuel Bigeon */ /** A test-purpose application
public class ConsoleTestApplication { *
* @author Emmanuel Bigeon */
/** Exit command */ public class ConsoleTestApplication {
public static final String EXIT = "exit"; //$NON-NLS-1$
/** Exit command */
/** Create the test application. public static final String EXIT = "exit"; //$NON-NLS-1$
*
* @param output the output /** Create the test application.
* @param input the input *
* @param manager the manager * @param output the output
* @return create the application */ * @param input the input
@SuppressWarnings("nls") * @param manager the manager
public static ConsoleApplication create(final ConsoleOutput output, * @return create the application */
final ConsoleInput input, @SuppressWarnings("nls")
final ConnexionManager<Socket> manager) { public static ConsoleApplication create(final ConsoleOutput output,
try { final ConsoleInput input, final ConnexionManager<Socket> manager) {
final ConsoleApplication application = new ConsoleApplication( try {
output, input, final ConsoleApplication application = new ConsoleApplication(output, input,
"Welcome to the test application. Type help or test.", "Welcome to the test application. Type help or test.", "See you");
"See you"); application.add(new ExitCommand(EXIT, application) {
application.add(new ExitCommand(EXIT, application) { /* (non-Javadoc)
/* (non-Javadoc) * @see fr.bigeon.gclc.command.ExitCommand#beforeExit() */
* @see fr.bigeon.gclc.command.ExitCommand#beforeExit() */ @Override
@Override protected void beforeExit() {
protected void beforeExit() { final Collection<String> coll = manager.getConnected();
final Collection<String> coll = manager.getConnected(); for (final String string : coll) {
for (final String string : coll) { manager.disconnect(string);
manager.disconnect(string); }
} }
} });
}); application.add(new HelpExecutor("help", application.root));
application application.add(new Command("test") {
.add(new HelpExecutor("help", application.root));
application.add(new Command("test") { /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
/* (non-Javadoc) * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc. * java.lang.String[]) */
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, @Override
* java.lang.String[]) */ public void execute(final ConsoleOutput out, final ConsoleInput in,
@Override final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, try {
final ConsoleInput in, output.println("Test command ran fine");
final String... args) throws CommandRunException { } catch (final IOException e) {
try { throw new CommandRunException("manager closed", e);
output.println("Test command ran fine"); }
} catch (final IOException e) { }
throw new CommandRunException("manager closed", e,
this); @Override
} public String tip() {
} return "A test command";
}
@Override
public String tip() { /* (non-Javadoc)
return "A test 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;
*/ throw new RuntimeException("Not implemented yet");
@Override }
protected String usageDetail() { });
// TODO Auto-generated method stub application.add(new Command("long") {
// return null;
throw new RuntimeException("Not implemented yet"); /* (non-Javadoc)
} * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
}); * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
application.add(new Command("long") { * java.lang.String[]) */
@Override
/* (non-Javadoc) public void execute(final ConsoleOutput out, final ConsoleInput in,
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc. final String... args) throws CommandRunException {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, try {
* java.lang.String[]) */ Object obj = new Object();
@Override synchronized (obj) {
public void execute(final ConsoleOutput out, obj.wait(2000);
final ConsoleInput in, }
final String... args) throws CommandRunException { output.println("Test command ran fine");
try { } catch (IOException | InterruptedException e) {
Thread.sleep(2000); throw new CommandRunException("manager closed", e);
output.println("Test command ran fine"); }
} catch (IOException | InterruptedException e) { }
throw new CommandRunException("manager closed", e,
this); @Override
} public String tip() {
} return "A long run test command";
}
@Override
public String tip() { /* (non-Javadoc)
return "A long run test 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;
*/ throw new RuntimeException("Not implemented yet");
@Override }
protected String usageDetail() { });
// TODO Auto-generated method stub application.add(new RemoteDisconnectCommand<>("out", manager, true));
// return null; return application;
throw new RuntimeException("Not implemented yet"); } catch (final InvalidCommandName e) {
} e.printStackTrace();
}); }
application.add( return null;
new RemoteDisconnectCommand<>("out", manager, true)); }
return application; }
} catch (final InvalidCommandName e) {
e.printStackTrace();
}
return null;
}
}

View File

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

View File

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

View File

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

View File

@@ -1,92 +1,91 @@
/* package net.bigeon.gclc.socket;
* GCLC Socket, Socket implementation of GCLC
* Copyright (C) 2014-2017 E. Bigeon /*-
* mailto:emmanuel@bigeon.fr * #%L
* * GCLC Socket
* 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) 2016 - 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.
*/ *
package fr.bigeon.gclc.socket; * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
import java.io.BufferedReader; * #L%
import java.io.IOException; */
import java.io.InputStreamReader; import java.io.BufferedReader;
import java.io.PrintWriter; import java.io.IOException;
import java.net.Socket; import java.io.InputStreamReader;
import java.util.ArrayList; import java.io.PrintWriter;
import java.util.Collection; import java.net.Socket;
import java.util.ArrayList;
import fr.bigeon.smu.StringEncoder; import java.util.Collection;
/** TODO Describe TestConsoleClient.java import net.bigeon.smu.StringEncoder;
* @author Emmanuel Bigeon
* /** TODO Describe TestConsoleClient.java
*/ *
@SuppressWarnings("nls") * @author Emmanuel Bigeon */
public class TestConsoleClient { @SuppressWarnings("nls")
@SuppressWarnings("javadoc") public class TestConsoleClient {
private static final Collection<String> TO_ENCODE = new ArrayList<>(); @SuppressWarnings("javadoc")
static { private static final Collection<String> TO_ENCODE = new ArrayList<>();
TO_ENCODE.add("\n"); static {
} TO_ENCODE.add("\n");
}
@SuppressWarnings("javadoc")
private static final StringEncoder ENCODER = new StringEncoder("%", @SuppressWarnings("javadoc")
TO_ENCODE); private static final StringEncoder ENCODER = new StringEncoder("%", TO_ENCODE);
@SuppressWarnings("javadoc") @SuppressWarnings("javadoc")
public static void main(String[] args) { public static void main(String[] args) {
final String hostName = "127.0.0.1"; final String hostName = "127.0.0.1";
final int portNumber = 3300; final int portNumber = 3300;
try (Socket kkSocket = new Socket(hostName, portNumber); try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
true); BufferedReader in = new BufferedReader(
BufferedReader in = new BufferedReader(new InputStreamReader( new InputStreamReader(kkSocket.getInputStream()));) {
kkSocket.getInputStream()));) {
String fromServer;
String fromServer; while ((fromServer = in.readLine()) != null) {
while ((fromServer = in.readLine()) != null) { System.out.println("Server: \n" + ENCODER.decode(fromServer));
System.out.println("Server: \n" + ENCODER.decode(fromServer)); if (fromServer.equals("Bye.")) {
if (fromServer.equals("Bye.")) { break;
break; }
}
final BufferedReader stdIn = new BufferedReader(
final BufferedReader stdIn = new BufferedReader( new InputStreamReader(System.in));
new InputStreamReader(System.in)); final String fromUser = stdIn.readLine();
final String fromUser = stdIn.readLine(); if (fromUser != null) {
if (fromUser != null) { System.out.println("Client: " + fromUser);
System.out.println("Client: " + fromUser); out.println(fromUser);
out.println(fromUser); }
} }
} } catch (final IOException e) {
} catch (final IOException e) { // TODO Auto-generated catch block
// TODO Auto-generated catch block e.printStackTrace();
e.printStackTrace(); }
}
}
} }
}

View File

@@ -1,105 +1,117 @@
/* package net.bigeon.gclc.socket;
* GCLC Socket, Socket implementation of GCLC
* Copyright (C) 2014-2017 E. Bigeon /*-
* mailto:emmanuel@bigeon.fr * #%L
* * GCLC Socket
* 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) 2016 - 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.
*/ *
package fr.bigeon.gclc.socket; * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
import java.io.IOException; * #L%
import java.net.InetAddress; */
import java.net.Socket; import java.io.IOException;
import java.net.UnknownHostException; import java.net.InetAddress;
import java.net.Socket;
import fr.bigeon.gclc.ConsoleApplication; import java.net.UnknownHostException;
/** A test server import net.bigeon.gclc.ConsoleApplication;
*
* @author Emmanuel Bigeon */ /** A test server
@SuppressWarnings({"javadoc", "nls"}) *
public class TestServer { * @author Emmanuel Bigeon */
@SuppressWarnings({ "javadoc", "nls" })
private static SocketConsoleApplicationShell SHELL; public class TestServer {
private static ConnexionManager<Socket> manager;
private static SocketConsoleApplicationShell SHELL;
private static Thread server; private static ConnexionManager<Socket> manager;
private static PluggableConsoleInput input;
private static PluggableConsoleOutput output; private static Thread server;
private static PluggableConsoleInput input;
public static synchronized void closeServer() { private static PluggableConsoleOutput output;
SHELL.stop();
input.close(); public static synchronized void closeServer() {
output.close(); SHELL.stop();
SHELL = null; input.close();
server = null; output.close();
} SHELL = null;
server = null;
public static synchronized Thread getServer() throws IOException { }
if (server == null) {
server = new Thread(getShell(), "gclcServer"); public static synchronized Thread getServer() throws IOException {
server.start(); if (server == null) {
} server = new Thread(getShell(), "gclcServer");
return server; server.start();
} }
return server;
private static SocketConsoleApplicationShell getShell() throws UnknownHostException { }
if (SHELL == null) {
input = new PluggableConsoleInput(); private static SocketConsoleApplicationShell getShell() throws UnknownHostException {
input.setPrompt("> \n"); if (SHELL == null) {
output = new PluggableConsoleOutput(); input = new PluggableConsoleInput();
manager = new DConnexionManager<>(); input.setPrompt("> \n");
SHELL = new SocketConsoleApplicationShell(3300, output = new PluggableConsoleOutput();
InetAddress.getByName("127.0.0.1")); manager = new DConnexionManager<>();
final ConsoleApplication app = ConsoleTestApplication SHELL = new SocketConsoleApplicationShell(3300,
.create(output, input, manager); InetAddress.getByName("127.0.0.1"));
SHELL.setInterface(new SocketConsoleInterface(input, output)); final ConsoleApplication app = ConsoleTestApplication.create(output, input,
SHELL.setConnexionManager(manager); manager);
SHELL.setApplication(app); SHELL.setInterface(new SocketConsoleInterface(input, output));
final Thread th = new Thread(new Runnable() { SHELL.setConnexionManager(manager);
SHELL.setApplication(app);
@Override final Thread th = new Thread(new Runnable() {
public void run() {
app.start(); @Override
} public void run() {
}); app.start();
th.start(); }
} });
return SHELL; th.start();
} try {
Object waiting = new Object();
/** @param args no argument synchronized (waiting) {
* @throws IOException if the server starting failed */ while (!input.isPrompting()) {
public static void main(final String... args) throws IOException { waiting.wait(50);
try { }
getServer().join(); }
} catch (final InterruptedException e) { } catch (InterruptedException e) {
e.printStackTrace(); Thread.currentThread().interrupt();
} }
} }
return SHELL;
} }
/** @param args no argument
* @throws IOException if the server starting failed */
public static void main(final String... args) throws IOException {
try {
getServer().join();
} catch (final InterruptedException e) {
e.printStackTrace();
}
}
}

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,132 +1,98 @@
<!-- 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.9</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.9</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</groupId> <groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>ebigeon-config</artifactId> <artifactId>dsm-maven-plugin</artifactId>
<version>1.7.1</version> <version>2.2.0</version>
</parent> </plugin>
<dependencies> </plugins>
<dependency> </reporting>
<groupId>fr.bigeon</groupId> <developers>
<artifactId>gclc</artifactId> <developer>
<version>2.0.4-SNAPSHOT</version> <email>emmanuel@bigeon.fr</email>
</dependency> <name>Emmanuel Bigeon</name>
<dependency> <url>bigeon.net</url>
<groupId>fr.bigeon</groupId> <roles>
<artifactId>collections</artifactId> <role>PM</role>
<version>1.1.0</version> </roles>
</dependency> </developer>
</dependencies> </developers>
<inceptionYear>2015</inceptionYear>
<name>GCLC swt</name> <scm>
<description>provide a swt window for console applications</description> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<scm> <tag>HEAD</tag>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> </scm>
<tag>HEAD</tag> </project>
</scm>
<profiles>
<profile>
<id>linux-deps</id>
<activation>
<os>
<family>Linux</family>
</os>
</activation>
<dependencies>
<dependency>
<groupId>org.eclipse.swt</groupId>
<artifactId>org.eclipse.swt.gtk.linux.x86_64</artifactId>
<version>4.3</version>
</dependency>
</dependencies>
</profile>
<profile>
<id>windows-deps</id>
<activation>
<os>
<family>Windows</family>
</os>
</activation>
<dependencies>
<dependency>
<groupId>org.eclipse.swt</groupId>
<artifactId>org.eclipse.swt.win32.win32.x86_64</artifactId>
<version>4.3</version>
</dependency>
</dependencies>
</profile>
</profiles>
</project>

View File

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

View File

@@ -1,112 +1,143 @@
/* /*
* 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,397 +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, SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | /** The number of columns of the layout. */
SWT.V_SCROLL | SWT.MULTI); private static final int LAYOUT_NB_COLUMNS = 2;
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, /** The cmd prefix in the output console. */
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( private final Text consoleOutput;
new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1)); /** The console input text field. */
consoleInput.addKeyListener(new HistoryTextKeyListener(this)); private final Text consoleInput;
/** The prompt label. */
} private final Label lblPromptlabel;
/** The prompt text. */
@Override private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
protected void checkSubclass() { /** The command entered by the user. */
// Disable the check that prevents subclassing of SWT components private String command = null;
} /** If the prompt should be active. */
private boolean prompting = false;
/* (non-Javadoc) /** The object for thread synchronization with the prompt. */
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */ private final Object promptLock = new Object();
@Override
public void close() { /** Create the composite.
synchronized (promptLock) { *
promptLock.notifyAll(); * @param parent the prent composite
} * @param style the composite style */
if (consoleInput.isDisposed()) { public SWTConsole(final Composite parent, final int style) {
return; super(parent, style);
}
consoleInput.setEnabled(false); setLayout(new GridLayout(LAYOUT_NB_COLUMNS, false));
consoleOutput.setEnabled(false);
} consoleOutput = new Text(this,
SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | SWT.V_SCROLL | SWT.MULTI);
/* (non-Javadoc) consoleOutput.setLayoutData(
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#getInput() */ new GridData(SWT.FILL, SWT.FILL, true, true, LAYOUT_NB_COLUMNS, 1));
@Override consoleOutput.setRedraw(true);
public String getInput() {
return consoleInput.getText(); lblPromptlabel = new Label(this, SWT.NONE);
} lblPromptlabel.setText(prompt.apply());
/* (non-Javadoc) consoleInput = new Text(this, SWT.BORDER);
* @see fr.bigeon.gclc.ConsoleManager#getPrompt() */ consoleInput.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
@Override consoleInput.addKeyListener(new HistoryTextKeyListener(this));
public StringProvider getPrompt() {
return prompt; }
}
@Override
/* (non-Javadoc) protected void checkSubclass() {
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */ // Disable the check that prevents subclassing of SWT components
@Override }
public void interruptPrompt() {
synchronized (promptLock) { /* (non-Javadoc)
promptLock.notifyAll(); * @see fr.bigeon.gclc.manager.ConsoleManager#close() */
} @Override
} public void close() {
synchronized (promptLock) {
/* (non-Javadoc) prompting = false;
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */ promptLock.notifyAll();
@Override }
public boolean isClosed() { if (consoleInput.isDisposed()) {
return isDisposed(); return;
} }
consoleInput.setEnabled(false);
/* (non-Javadoc) consoleOutput.setEnabled(false);
* @see fr.bigeon.gclc.ConsoleManager#print(java.lang.String) */ }
@Override
public void print(final String text) { /* (non-Javadoc)
Display.getDefault().syncExec(new Runnable() { * @see net.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
@SuppressWarnings("synthetic-access") @Override
@Override public String getInput() {
public void run() { return consoleInput.getText();
if (!consoleOutput.isDisposed()) { }
consoleOutput.append(text);
} /* (non-Javadoc)
} * @see fr.bigeon.gclc.ConsoleManager#getPrompt() */
}); @Override
} public StringProvider getPrompt() {
return prompt;
/* (non-Javadoc) }
* @see fr.bigeon.gclc.ConsoleManager#println() */
@Override /* (non-Javadoc)
public void println() { * @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
Display.getDefault().syncExec(new Runnable() { @Override
@SuppressWarnings("synthetic-access") public void interruptPrompt() {
@Override synchronized (promptLock) {
public void run() { promptLock.notifyAll();
if (!consoleOutput.isDisposed()) { }
consoleOutput.append(System.lineSeparator()); }
}
} /* (non-Javadoc)
}); * @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
} @Override
public boolean isClosed() {
/* (non-Javadoc) return isDisposed();
* @see fr.bigeon.gclc.ConsoleManager#println(java.lang.String) */ }
@Override
public void println(final String message) { /* (non-Javadoc)
Display.getDefault().syncExec(new Runnable() { * @see fr.bigeon.gclc.ConsoleManager#print(java.lang.String) */
@SuppressWarnings("synthetic-access") @Override
@Override public void print(final String text) throws IOException {
public void run() { if (isDisposed()) {
if (!consoleOutput.isDisposed()) { throw new IOException();
consoleOutput.append(message + System.lineSeparator()); }
} Display.getDefault().syncExec(new Runnable() {
} @SuppressWarnings("synthetic-access")
}); @Override
public void run() {
} if (!consoleOutput.isDisposed()) {
consoleOutput.append(text);
/* (non-Javadoc) }
* @see fr.bigeon.gclc.ConsoleManager#prompt() */ }
@Override });
public String prompt() throws IOException { }
synchronized (promptLock) {
if (isDisposed()) { /* (non-Javadoc)
throw new IOException(); * @see fr.bigeon.gclc.ConsoleManager#println() */
} @Override
try { public void println() throws IOException {
Display.getDefault().syncExec(new Runnable() { if (isDisposed()) {
@SuppressWarnings("synthetic-access") throw new IOException();
@Override }
public void run() { Display.getDefault().syncExec(new Runnable() {
if (!consoleInput.isDisposed()) { @SuppressWarnings("synthetic-access")
consoleInput.setEnabled(true); @Override
lblPromptlabel.setText(prompt.apply()); public void run() {
consoleInput.setFocus(); if (!consoleOutput.isDisposed()) {
} consoleOutput.append(System.lineSeparator());
} }
}); }
prompting = true; });
promptLock.notifyAll(); }
promptLock.wait();
} catch (final InterruptedException e) { /* (non-Javadoc)
LOGGER.log(Level.WARNING, * @see fr.bigeon.gclc.ConsoleManager#println(java.lang.String) */
"Error in synchronization of prompting", e); //$NON-NLS-1$ @Override
command = null; public void println(final String message) throws IOException {
Thread.currentThread().interrupt(); if (isDisposed()) {
} throw new IOException();
} }
if (isDisposed()) { Display.getDefault().syncExec(new Runnable() {
throw new IOException("Input closed"); //$NON-NLS-1$ @SuppressWarnings("synthetic-access")
} @Override
return command; public void run() {
} 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 { }
// TODO Auto-generated method stub
// return null; /* (non-Javadoc)
throw new RuntimeException("Not implemented yet"); * @see fr.bigeon.gclc.ConsoleManager#prompt() */
} @Override
public String prompt() throws IOException {
/* (non-Javadoc) synchronized (promptLock) {
* @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */ if (isDisposed()) {
@Override throw new IOException();
public String prompt(final String message) throws IOException { }
synchronized (promptLock) { try {
if (isDisposed()) { Display.getDefault().syncExec(new Runnable() {
throw new IOException(); @Override
} public void run() {
try { if (!consoleInput.isDisposed()) {
Display.getDefault().syncExec(new Runnable() { consoleInput.setEnabled(true);
@SuppressWarnings("synthetic-access") lblPromptlabel.setText(prompt.apply());
@Override // relayout
public void run() { SWTConsole.this.layout();
if (!consoleOutput.isDisposed()) { consoleInput.setFocus();
lblPromptlabel.setText(message); }
// relayout }
SWTConsole.this.layout(); });
consoleInput.setEnabled(true); prompting = true;
consoleInput.setFocus(); promptLock.notifyAll();
} while (prompting) {
} promptLock.wait();
}); }
prompting = true; } catch (final InterruptedException e) {
promptLock.wait(); LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$
if (isDisposed()) { command = null;
throw new IOException(); Thread.currentThread().interrupt();
} }
} catch (final InterruptedException e) { }
LOGGER.log(Level.WARNING, if (isDisposed()) {
"Error in synchronization of prompting", e); //$NON-NLS-1$ throw new IOException("Input closed"); //$NON-NLS-1$
command = null; }
Thread.currentThread().interrupt(); return command;
} finally { }
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access") /* (non-Javadoc)
@Override * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
public void run() { @Override
if (!consoleOutput.isDisposed()) { public String prompt(final long timeout) throws IOException {
lblPromptlabel.setText(prompt.apply()); synchronized (promptLock) {
// relayout if (isDisposed()) {
SWTConsole.this.layout(); throw new IOException();
} }
} try {
}); Display.getDefault().syncExec(new Runnable() {
} @Override
} public void run() {
return command; if (!consoleInput.isDisposed()) {
} consoleInput.setEnabled(true);
lblPromptlabel.setText(prompt.apply());
/* (non-Javadoc) // relayout
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) SWTConsole.this.layout();
*/ consoleInput.setFocus();
@Override }
public String prompt(final String message, final long timeout) throws IOException { }
// TODO Auto-generated method stub });
// return null; prompting = true;
throw new RuntimeException("Not implemented yet"); command = null;
} promptLock.notifyAll();
final long start = System.currentTimeMillis();
/* (non-Javadoc) long cur = start;
* @see org.eclipse.swt.widgets.Composite#setFocus() */ while (prompting && start + timeout > cur) {
@Override promptLock.wait((cur - start - timeout) / 2);
public boolean setFocus() { cur = System.currentTimeMillis();
return consoleInput.setFocus(); }
} } 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.swt.ConsoleDelayIO#setInput(java.lang.String) */ Thread.currentThread().interrupt();
@Override }
public void setInput(final String input) { }
consoleInput.setText(input); if (isDisposed()) {
consoleInput.setSelection(input.length()); throw new IOException("Input closed"); //$NON-NLS-1$
} }
return command;
/* (non-Javadoc) }
* @see fr.bigeon.gclc.ConsoleManager#setPrompt(java.lang.String) */
@Override /* (non-Javadoc)
public void setPrompt(final StringProvider prompt) { * @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
this.prompt = prompt; @Override
Display.getDefault().syncExec(new Runnable() { public String prompt(final String message) throws IOException {
@SuppressWarnings("synthetic-access") synchronized (promptLock) {
@Override if (isDisposed()) {
public void run() { throw new IOException();
if (!consoleOutput.isDisposed()) { }
lblPromptlabel.setText(prompt.apply()); try {
// relayout Display.getDefault().syncExec(new Runnable() {
SWTConsole.this.layout(); @SuppressWarnings("synthetic-access")
} @Override
} public void run() {
}); if (!consoleOutput.isDisposed()) {
} lblPromptlabel.setText(message);
// relayout
@Override SWTConsole.this.layout();
public void setPrompt(String prompt) { consoleInput.setEnabled(true);
setPrompt(new ConstantString(prompt)); consoleInput.setFocus();
} }
}
/** @param string the text */ });
public void setText(final String string) { prompting = true;
consoleInput.setText(string); promptLock.wait();
} if (isDisposed()) {
throw new IOException();
/** }
* } catch (final InterruptedException e) {
*/ LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$
public void validateCommand() { command = null;
validateInput(); Thread.currentThread().interrupt();
} } finally {
Display.getDefault().syncExec(new Runnable() {
/** @SuppressWarnings("synthetic-access")
* @Override
*/ public void run() {
@Override if (!consoleOutput.isDisposed()) {
public void validateInput() { lblPromptlabel.setText(prompt.apply());
Display.getDefault().syncExec(new Runnable() { // relayout
@SuppressWarnings("synthetic-access") SWTConsole.this.layout();
@Override }
public void run() { }
consoleInput.setEnabled(false); });
} }
}); }
synchronized (promptLock) { return command;
while (!prompting) { }
try {
promptLock.wait(); /* (non-Javadoc)
} catch (final InterruptedException e) { * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
LOGGER.log(Level.SEVERE, @Override
"Interruption while waiting prompt", e); //$NON-NLS-1$ public String prompt(final String message, final long timeout) throws IOException {
} // TODO Auto-generated method stub
} // return null;
Display.getDefault().syncExec(new Runnable() { throw new RuntimeException("Not implemented yet");
@SuppressWarnings("synthetic-access") }
@Override
public void run() { /* (non-Javadoc)
command = consoleInput.getText(); * @see org.eclipse.swt.widgets.Composite#setFocus() */
prompting = false; @Override
consoleInput.setText(EMPTY); public boolean setFocus() {
consoleOutput.append( return consoleInput.setFocus();
CMD_PREFIX + command + System.lineSeparator()); }
}
}); /* (non-Javadoc)
promptLock.notifyAll(); * @see net.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
} @Override
} public void setInput(final String input) {
consoleInput.setText(input);
} consoleInput.setSelection(input.length());
}
@Override
public void setPrompt(String prompt) {
setPrompt(new ConstantString(prompt));
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#setPrompt(java.lang.String) */
@Override
public void setPrompt(final StringProvider prompt) {
this.prompt = prompt;
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(prompt.apply());
// relayout
SWTConsole.this.layout();
}
}
});
}
/** @param string the text */
public void setText(final String string) {
consoleInput.setText(string);
}
/**
*
*/
public void validateCommand() {
validateInput();
}
/**
*
*/
@Override
public void validateInput() {
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleInput.setEnabled(false);
}
});
synchronized (promptLock) {
while (!prompting) {
try {
promptLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interruption while waiting prompt", e); //$NON-NLS-1$
}
}
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
command = consoleInput.getText();
prompting = false;
consoleInput.setText(EMPTY);
consoleOutput.append(CMD_PREFIX + command + System.lineSeparator());
}
});
promptLock.notifyAll();
}
}
}

View File

@@ -1,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,220 @@
/* /*
* 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 extends AOutputForwardRunnable {
private PipedConsoleInput input; /** The running status */
/** The forwarding runnable */ private boolean running = true;
private ToSWTConsoleForwardRunnable forward;
/** @param manager the manager */
/** Create the composite. public ToSWTConsoleForwardRunnable(final PipedConsoleOutput manager) {
* super(manager);
* @param parent the prent composite }
* @param style the composite style */
public SWTConsoleView(final Composite parent, final int style) { @Override
super(parent, style); protected void forwardLine(final String m) {
appendConsoleOutput(m);
setLayout(new GridLayout(1, false)); }
consoleOutput = new Text(this, SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | @Override
SWT.V_SCROLL | SWT.MULTI); protected boolean isRunning() {
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, return running && !isDisposed();
1, 1)); }
consoleOutput.setRedraw(true);
/** @param running the running to set */
consoleInput = new Text(this, SWT.BORDER); public void setRunning(final boolean running) {
consoleInput.setLayoutData( this.running = running;
new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1)); }
consoleInput.addKeyListener(new HistoryTextKeyListener(this)); }
}
/** The class logger */
/** @param next the next message */ private static final Logger LOGGER = Logger
protected void appendConsoleOutput(final String next) { .getLogger(SWTConsoleView.class.getName());
Display.getDefault().syncExec(new Runnable() { /** The console output text field */
@SuppressWarnings("synthetic-access") private final Text consoleOutput;
@Override /** The console input text field */
public void run() { private final Text consoleInput;
consoleOutput.append(System.lineSeparator() + next); /** The input. */
} private PipedConsoleInput input;
}); /** The forwarding runnable */
} private ToSWTConsoleForwardRunnable forward;
@Override /** Create the composite.
protected void checkSubclass() { *
// Disable the check that prevents subclassing of SWT components * @param parent the prent composite
} * @param style the composite style */
public SWTConsoleView(final Composite parent, final int style) {
/* (non-Javadoc) super(parent, style);
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
@Override setLayout(new GridLayout(1, false));
public String getInput() {
return consoleInput.getText(); consoleOutput = new Text(this,
} SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | SWT.V_SCROLL | SWT.MULTI);
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1));
/* (non-Javadoc) consoleOutput.setRedraw(true);
* @see org.eclipse.swt.widgets.Composite#setFocus() */
@Override consoleInput = new Text(this, SWT.BORDER);
public boolean setFocus() { consoleInput.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
return consoleInput.setFocus(); consoleInput.addKeyListener(new HistoryTextKeyListener(this));
} }
/* (non-Javadoc) /** @param next the next message */
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */ protected void appendConsoleOutput(final String next) {
@Override Display.getDefault().syncExec(new Runnable() {
public void setInput(final String input) { @SuppressWarnings("synthetic-access")
consoleInput.setText(input); @Override
consoleInput.setSelection(input.length()); public void run() {
} consoleOutput.append(System.lineSeparator() + next);
}
/** Set the input and output. });
* }
* @param manager the output to set
* @param input the input */ @Override
public void setManager(final PipedConsoleOutput manager, protected void checkSubclass() {
final PipedConsoleInput input) { // Disable the check that prevents subclassing of SWT components
this.input = input; }
if (forward != null) {
forward.setRunning(false); /* (non-Javadoc)
} * @see net.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
forward = new ToSWTConsoleForwardRunnable(manager); @Override
final Thread th = new Thread(forward, "gclcToSWT"); //$NON-NLS-1$ public String getInput() {
th.start(); return consoleInput.getText();
} }
/** @param string the text */ /* (non-Javadoc)
public void setText(final String string) { * @see org.eclipse.swt.widgets.Composite#setFocus() */
consoleInput.setText(string); @Override
} public boolean setFocus() {
return consoleInput.setFocus();
/** }
*
*/ /* (non-Javadoc)
@Override * @see net.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
public void validateInput() { @Override
try { public void setInput(final String input) {
input.type(getInput()); consoleInput.setText(input);
} catch (final IOException e) { consoleInput.setSelection(input.length());
LOGGER.log(Level.SEVERE, "Unable to input value to console", e); //$NON-NLS-1$ }
}
} /** 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

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

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,142 @@
/* /*
* 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()); /**
listener.pressedKeyCode(SWT.ARROW_DOWN); * <p>
assertEquals("", io.getInput()); * TODO
listener.pressedKeyCode('\r'); *
assertEquals("", io.getInput()); * @author Emmanuel Bigeon */
public class HistoryTextKeyListenerTest {
io.setInput("cmd arg");
listener.pressedKeyCode(SWT.ARROW_UP); /** Test method for
assertEquals("cmd arg", io.getInput()); * {@link net.bigeon.gclc.swt.HistoryTextKeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)}. */
listener.pressedKeyCode(SWT.ARROW_DOWN); @Test
assertEquals("cmd arg", io.getInput()); public final void testKeyPressedKeyEvent() {
listener.pressedKeyCode('\r'); ConsoleDelayIO io = new ConsoleDelayIO() {
assertEquals("", io.getInput()); private String input = "";
io.setInput("cmd arg2"); @Override
listener.pressedKeyCode(SWT.ARROW_UP); public String getInput() {
assertEquals("cmd arg", io.getInput()); return input;
listener.pressedKeyCode(SWT.ARROW_DOWN); }
assertEquals("", io.getInput());
io.setInput("cmd arg2"); @Override
listener.pressedKeyCode('\r'); public void setInput(String input) {
assertEquals("", io.getInput()); this.input = input;
listener.pressedKeyCode(SWT.ARROW_UP); }
assertEquals("cmd arg2", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP); @Override
assertEquals("cmd arg", io.getInput()); public void validateInput() {
listener.pressedKeyCode(SWT.ARROW_UP); input = "";
assertEquals("cmd arg", io.getInput()); }
listener.pressedKeyCode(SWT.ARROW_DOWN); };
assertEquals("cmd arg2", io.getInput()); HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
}
// no effects
} assertEquals("", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("", io.getInput());
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
io.setInput("cmd arg");
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
io.setInput("cmd arg2");
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("", io.getInput());
io.setInput("cmd arg2");
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg2", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("cmd arg2", io.getInput());
}
}

View File

@@ -1,333 +1,363 @@
/* /*
* 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 ConsoleInput in,
final Thread testThread = new Thread(new Runnable() { final String... args) throws CommandRunException {
try {
@Override Thread.sleep(TWO_SECONDS);
public void run() { } catch (final InterruptedException e) {
try { // TODO Auto-generated catch block
Thread.sleep(TWO_SECONDS); e.printStackTrace();
} catch (final InterruptedException e) { }
// TODO Auto-generated catch block }
e.printStackTrace();
} @Override
Display.getDefault().syncExec(new Runnable() { public String tip() {
@Override return "a long running command";
public void run() { }
swtConsole.setText("test"); //$NON-NLS-1$
swtConsole.validateCommand(); /* (non-Javadoc)
} * @see fr.bigeon.gclc.command.Command#usageDetail() */
}); @Override
try { protected String usageDetail() {
Thread.sleep(TWO_SECONDS); // TODO Auto-generated method stub
} catch (final InterruptedException e) { // return null;
// TODO Auto-generated catch block throw new RuntimeException("Not implemented yet");
e.printStackTrace(); }
} });
Display.getDefault().syncExec(new Runnable() { // shell.pack();
@Override shell.open();
public void run() { final Thread applThread = new Thread(new Runnable() {
shell.dispose();
} @Override
}); public void run() {
} appl.start();
}); }
applThread.start(); });
testThread.start(); final Thread testThread = new Thread(new Runnable() {
while (!shell.isDisposed()) {
if (!DISPLAY.readAndDispatch()) { @Override
DISPLAY.sleep(); public void run() {
} 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) { Display.getDefault().syncExec(new Runnable() {
// TODO Auto-generated catch block @Override
e.printStackTrace(); public void run() {
} catch (final InterruptedException e) { swtConsole.setText("test"); //$NON-NLS-1$
// TODO Auto-generated catch block swtConsole.validateCommand();
e.printStackTrace(); }
} });
} try {
Thread.sleep(TWO_SECONDS);
@Test } catch (final InterruptedException e) {
public void testConsoleClose() { // TODO Auto-generated catch block
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY); e.printStackTrace();
final SWTConsole swtConsole = shell.getManager(); }
swtConsole.close(); Display.getDefault().syncExec(new Runnable() {
swtConsole.setPrompt(":"); @Override
try { public void run() {
final ConsoleApplication appl = new ConsoleApplication(swtConsole, shell.dispose();
swtConsole, "Hello", "See you"); }
appl.add(new ExitCommand("exit", appl)); });
appl.add(new Command("long") { }
/* (non-Javadoc) });
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc. applThread.start();
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, testThread.start();
* java.lang.String[]) */ while (!shell.isDisposed()) {
@Override if (!DISPLAY.readAndDispatch()) {
public void execute(final ConsoleOutput out, DISPLAY.sleep();
final ConsoleInput in, }
final String... args) throws CommandRunException { }
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
} e.printStackTrace();
} catch (final InterruptedException e) {
@Override // TODO Auto-generated catch block
public String tip() { e.printStackTrace();
return "a long running command"; }
} }
/* (non-Javadoc) @Test
* @see fr.bigeon.gclc.command.Command#usageDetail() */ public void testConsoleClose() {
@Override final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
protected String usageDetail() { final SWTConsole swtConsole = shell.getManager();
// TODO Auto-generated method stub swtConsole.close();
// return null; swtConsole.setPrompt(":");
throw new RuntimeException("Not implemented yet"); try {
} final ConsoleApplication appl = new ConsoleApplication(swtConsole, swtConsole,
}); "Hello", "See you");
appl.add(new Command("test") { appl.add(new ExitCommand("exit", appl));
/* (non-Javadoc) appl.add(new Command("long") {
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc. /* (non-Javadoc)
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
* java.lang.String[]) */ * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
@Override * java.lang.String[]) */
public void execute(final ConsoleOutput out, @Override
final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
try { try {
swtConsole.prompt("Test"); Thread.sleep(TWO_SECONDS);
} catch (final IOException e) { } catch (final InterruptedException e) {
throw new CommandRunException("No input", e, this); // TODO Auto-generated catch block
} e.printStackTrace();
} }
}
@Override
public String tip() { @Override
return "a prompting running command"; public String tip() {
} return "a long running command";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */ /* (non-Javadoc)
@Override * @see fr.bigeon.gclc.command.Command#usageDetail() */
protected String usageDetail() { @Override
// TODO Auto-generated method stub protected String usageDetail() {
// return null; // TODO Auto-generated method stub
throw new RuntimeException("Not implemented yet"); // return null;
} throw new RuntimeException("Not implemented yet");
}); }
// shell.pack(); });
shell.open(); appl.add(new Command("test") {
final Thread applThread = new Thread(new Runnable() { /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
@Override * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
public void run() { * java.lang.String[]) */
appl.start(); @Override
} public void execute(final ConsoleOutput out, final ConsoleInput in,
}); final String... args) throws CommandRunException {
final Thread testThread = new Thread(new Runnable() { try {
swtConsole.prompt("Test");
@Override } catch (final IOException e) {
public void run() { throw new CommandRunException("No input", e);
try { }
Thread.sleep(TWO_SECONDS); }
} catch (final InterruptedException e) {
// TODO Auto-generated catch block @Override
e.printStackTrace(); public String tip() {
} return "a prompting running command";
Display.getDefault().syncExec(new Runnable() { }
@Override
public void run() { /* (non-Javadoc)
swtConsole.setText("test"); //$NON-NLS-1$ * @see fr.bigeon.gclc.command.Command#usageDetail() */
swtConsole.validateCommand(); @Override
} protected String usageDetail() {
}); // TODO Auto-generated method stub
Display.getDefault().syncExec(new Runnable() { // return null;
@Override throw new RuntimeException("Not implemented yet");
public void run() { }
swtConsole.setText("ok"); //$NON-NLS-1$ });
} // shell.pack();
}); shell.open();
swtConsole.validateCommand(); final Thread applThread = new Thread(new Runnable() {
Display.getDefault().syncExec(new Runnable() {
@Override @Override
public void run() { public void run() {
swtConsole.setText("long"); //$NON-NLS-1$ appl.start();
} }
}); });
swtConsole.validateCommand(); final Thread testThread = new Thread(new Runnable() {
Display.getDefault().syncExec(new Runnable() {
@Override @Override
public void run() { public void run() {
swtConsole.setText("test"); //$NON-NLS-1$ try {
} Thread.sleep(TWO_SECONDS);
}); } catch (final InterruptedException e) {
swtConsole.validateCommand(); // TODO Auto-generated catch block
Display.getDefault().syncExec(new Runnable() { e.printStackTrace();
@Override }
public void run() { Display.getDefault().syncExec(new Runnable() {
swtConsole.setText("test"); //$NON-NLS-1$ @Override
} public void run() {
}); swtConsole.setText("test"); //$NON-NLS-1$
swtConsole.validateCommand(); swtConsole.validateCommand();
try { }
Thread.sleep(TWO_SECONDS); });
} catch (final InterruptedException e) { Display.getDefault().syncExec(new Runnable() {
// TODO Auto-generated catch block @Override
e.printStackTrace(); public void run() {
} swtConsole.setText("ok"); //$NON-NLS-1$
Display.getDefault().syncExec(new Runnable() { }
@Override });
public void run() { swtConsole.validateCommand();
shell.dispose(); Display.getDefault().syncExec(new Runnable() {
} @Override
}); public void run() {
swtConsole.setText("long"); //$NON-NLS-1$
} }
}); });
applThread.start(); swtConsole.validateCommand();
testThread.start(); Display.getDefault().syncExec(new Runnable() {
while (!shell.isDisposed()) { @Override
if (!DISPLAY.readAndDispatch()) { public void run() {
DISPLAY.sleep(); swtConsole.setText("test"); //$NON-NLS-1$
} }
} });
swtConsole.setPrompt(">"); swtConsole.validateCommand();
try { Display.getDefault().syncExec(new Runnable() {
swtConsole.prompt(); @Override
fail("Prompting when closed should fail!"); public void run() {
} catch (final IOException e) { swtConsole.setText("test"); //$NON-NLS-1$
assertNotNull(e); }
} });
// DISPLAY.dispose(); swtConsole.validateCommand();
assertTrue(swtConsole.isClosed()); try {
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
assertFalse(appl.isRunning()); } catch (final InterruptedException e) {
} catch (final InvalidCommandName e) { // TODO Auto-generated catch block
// TODO Auto-generated catch block e.printStackTrace();
e.printStackTrace(); }
} catch (final InterruptedException e) { Display.getDefault().syncExec(new Runnable() {
// TODO Auto-generated catch block @Override
e.printStackTrace(); 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,203 @@
/* /*
* 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, /**
final String... args) throws CommandRunException { * <p>
try { * TODO
Thread.sleep(TWO_SECONDS); *
} catch (final InterruptedException e) { * @author Emmanuel Bigeon */
// TODO Auto-generated catch block @SuppressWarnings({ "javadoc", "static-method", "nls", "deprecation" })
e.printStackTrace(); public class SWTConsoleViewTest {
}
} protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = Display.getDefault();
@Override
public String tip() { @Test
return "a long running command"; public void test() {
} final Shell shell = new Shell(DISPLAY);
final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE);
/* (non-Javadoc) try (PipedConsoleOutput manager = new PipedConsoleOutput();
* @see fr.bigeon.gclc.command.Command#usageDetail() */ PipedConsoleInput input = new PipedConsoleInput(System.out)) {
@Override swtConsole.setManager(manager, input);
protected String usageDetail() { } catch (final IOException e2) {
// TODO Auto-generated method stub assertNull(e2);
// return null; }
throw new RuntimeException("Not implemented yet"); try (PipedConsoleOutput manager = new PipedConsoleOutput();
} PipedConsoleInput input = new PipedConsoleInput(System.out)) {
}); swtConsole.setManager(manager, input);
// shell.pack(); final ConsoleApplication appl = new ConsoleApplication(manager, 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[]) */
final Thread testThread = new Thread(new Runnable() { @Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
@Override final String... args) throws CommandRunException {
public void run() { try {
try { Thread.sleep(TWO_SECONDS);
Thread.sleep(TWO_SECONDS); } 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 @Override
public void run() { public String tip() {
swtConsole.setText("test"); //$NON-NLS-1$ return "a long running command";
swtConsole.validateInput(); }
}
}); /* (non-Javadoc)
try { * @see fr.bigeon.gclc.command.Command#usageDetail() */
Thread.sleep(TWO_SECONDS); @Override
} catch (final InterruptedException e) { protected String usageDetail() {
// TODO Auto-generated catch block // TODO Auto-generated method stub
e.printStackTrace(); // return null;
} throw new RuntimeException("Not implemented yet");
Display.getDefault().syncExec(new Runnable() { }
@Override });
public void run() { // shell.pack();
shell.dispose(); shell.open();
} final Thread applThread = new Thread(new Runnable() {
});
} @Override
}); public void run() {
applThread.start(); appl.start();
testThread.start(); }
while (!shell.isDisposed()) { });
if (!DISPLAY.readAndDispatch()) { final Thread testThread = new Thread(new Runnable() {
DISPLAY.sleep();
} @Override
} public void run() {
} catch (final InvalidCommandName e) { try {
// TODO Auto-generated catch block Thread.sleep(TWO_SECONDS);
e.printStackTrace(); } catch (final InterruptedException e) {
} catch (final IOException e1) { // TODO Auto-generated catch block
// TODO Auto-generated catch block e.printStackTrace();
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,64 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion>
<modelVersion>4.0.0</modelVersion> <groupId>net.bigeon.gclc</groupId>
<groupId>net.bigeon</groupId> <artifactId>system</artifactId>
<artifactId>gclc.system</artifactId> <version>0.0.2-SNAPSHOT</version>
<version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging>
<packaging>jar</packaging> <url>http://www.bigeon.net</url>
<url>http://www.bigeon.net</url> <properties>
<properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <copyright.email>emmanuel@bigeon.fr</copyright.email>
</properties> <license.licenseName>cecill_2.1</license.licenseName>
<build> </properties>
<plugins> <build>
</plugins> <plugins>
</build> </plugins>
<dependencies> </build>
<dependency> <dependencies>
<groupId>junit</groupId> <dependency>
<artifactId>junit</artifactId> <groupId>net.bigeon</groupId>
<version>4.11</version> <artifactId>gclc</artifactId>
<scope>test</scope> <version>2.0.9</version>
</dependency> </dependency>
<dependency> </dependencies>
<groupId>fr.bigeon</groupId> <name>GCLC system command</name>
<artifactId>gclc</artifactId> <description>Provide an exec command to execute system commands</description>
<version>2.0.0</version> <inceptionYear>2016</inceptionYear>
</dependency>
</dependencies> <licenses>
<name>GCLC system command</name> <license>
<description>Provide an exec command to execute system commands</description> <distribution>manual</distribution>
<inceptionYear>2016</inceptionYear> <name>CeCILL 2.1</name>
<scm> <url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> </license>
<tag>HEAD</tag> </licenses>
</scm> <reporting>
<parent> <plugins>
<groupId>fr.bigeon</groupId> <plugin>
<artifactId>ebigeon-config</artifactId> <groupId>com.github.sevntu-checkstyle</groupId>
<version>1.7.1</version> <artifactId>dsm-maven-plugin</artifactId>
</parent> <version>2.2.0</version>
</project> </plugin>
</plugins>
</reporting>
<developers>
<developer>
<email>emmanuel@bigeon.fr</email>
<name>Emmanuel Bigeon</name>
<url>bigeon.net</url>
<roles>
<role>PM</role>
</roles>
</developer>
</developers>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag>
</scm>
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.12</version>
</parent>
</project>

View File

@@ -1,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 {
}
/** Error message for the manager closed. */
final InputStream is = proc private static final String MANAGER_WAS_CLOSED = "manager was closed";
.getInputStream(); /** The command default name */
final Thread th = new Thread(new Runnable() { private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$
/** The end of line separator */
@SuppressWarnings("synthetic-access") private static final String EOL = System.lineSeparator();
@Override /** The class logger */
public void run() { private static final Logger LOGGER = Logger
try { .getLogger(ExecSystemCommand.class.getName());
readToEnd(out, is);
is.close(); /** Create the command with the name 'exec'. */
} catch (final CommandRunException e) { public ExecSystemCommand() {
LOGGER.log(Level.WARNING, super(COMMAND_DEFAULT_NAME);
"Manager was closed in the meantime...", e); //$NON-NLS-1$ }
} catch (final IOException e) {
LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$ /** Create the command with a custom name.
} *
} * @param name the name of the command (the input from the manager that should
}); * trigger this command) */
th.start(); public ExecSystemCommand(final String name) {
in.setPrompt(""); //$NON-NLS-1$ super(name);
final OutputStream os = proc.getOutputStream(); }
try (BufferedWriter writer = new BufferedWriter(
new OutputStreamWriter(os))) { /* (non-Javadoc)
while (th.isAlive()) { * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
String user; * ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
try { @Override
user = in.prompt(); public void execute(final ConsoleOutput out, final ConsoleInput in,
} catch (final IOException e) { final String... args) throws CommandRunException {
throw new CommandRunException( Process proc;
CommandRunExceptionType.INTERACTION, try {
"manager was closed", e, this); //$NON-NLS-1$ proc = Runtime.getRuntime().exec(args);
} } catch (final IOException e2) {
writer.write(user + EOL); LOGGER.log(Level.SEVERE, "Unable to run process", e2); //$NON-NLS-1$
} return;
} catch (final IOException e1) { }
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"manager was closed", e1, this); //$NON-NLS-1$ final InputStream is = proc.getInputStream();
} final Thread th = new Thread(new Runnable() {
}
@Override
/** @param is the input stream public void run() {
* @throws CommandRunException if the manager was closed while writing the try {
* stream */ readToEnd(out, is);
protected void readToEnd(final ConsoleOutput out, is.close();
final InputStream is) throws CommandRunException { } catch (final CommandRunException e) {
int c; LOGGER.log(Level.WARNING, "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))) {
} while (th.isAlive()) {
} catch (final IOException e) { String user = in.prompt();
LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$ writer.write(user + EOL);
} }
} } catch (final IOException e1) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
/* (non-Javadoc) MANAGER_WAS_CLOSED, e1); // $NON-NLS-1$
* @see fr.bigeon.gclc.command.ICommand#tip() */ }
@Override }
public String tip() {
return "Execute a system command"; //$NON-NLS-1$ /** @param is the input stream
} * @throws CommandRunException if the manager was closed while writing the
* stream */
/* (non-Javadoc) protected void readToEnd(final ConsoleOutput out, final InputStream is)
* @see fr.bigeon.gclc.command.Command#usageDetail() */ throws CommandRunException {
@Override int c;
protected String usageDetail() { try {
return " The system command is a system dependend command like sh on linux or" + //$NON-NLS-1$ while ((c = is.read()) != -1) {
System.lineSeparator() + "powershell on windows." + //$NON-NLS-1$ printCharacter(out, (char) c);
System.lineSeparator() + System.lineSeparator() + }
" As an example if you give \"cat /etc/hostname\" as argument, on a linux" + //$NON-NLS-1$ } catch (final IOException e) {
System.lineSeparator() + LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$
"system, you would get the computer name." + //$NON-NLS-1$ }
System.lineSeparator(); }
}
/** Print a character on the console.
/* (non-Javadoc) *
* @see fr.bigeon.gclc.command.Command#usagePattern() */ * @param out the console
@Override * @param c the character
protected String usagePattern() { * @throws CommandRunException if the console failed to print the character. */
return " CMD <system command>"; //$NON-NLS-1$ private void printCharacter(final ConsoleOutput out, char c)
} throws CommandRunException {
try {
} out.print(Character.toString(c));
} catch (final IOException e) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
MANAGER_WAS_CLOSED, e); // $NON-NLS-1$
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Execute a system command"; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return " The system command is a system dependend command like sh on linux or" + //$NON-NLS-1$
System.lineSeparator() + "powershell on windows." + //$NON-NLS-1$
System.lineSeparator() + System.lineSeparator()
+ " As an example if you give \"cat /etc/hostname\" as argument, on a linux" //$NON-NLS-1$
+ System.lineSeparator() + "system, you would get the computer name." + //$NON-NLS-1$
System.lineSeparator();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */
@Override
protected String usagePattern() {
return " CMD <system command>"; //$NON-NLS-1$
}
}

View File

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

View File

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

517
gclc/LICENSE.txt Normal file
View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

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

View File

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

View File

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

View File

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

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