Skip to content

Commit 76ff155

Browse files
floscherfloscher
committed
Added markdown, switched license to LGPLv3 and added Gradle wrapper
Fixes arenn#8.
1 parent fd55a73 commit 76ff155

11 files changed

+516
-560
lines changed

‎COPYING.LIB

Lines changed: 0 additions & 482 deletions
This file was deleted.

‎LANGUAGES

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎LANGUAGES.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Getopt supports error messages in the following languages:
2+
3+
* [English (default)](./src/main/resources/MessagesBundle_en.properties)
4+
* Chinese ([simplified](./src/main/resources/MessagesBundle_chs.properties) and [traditional](./src/main/resources/MessagesBundle_cht.properties))
5+
* [Czech](./src/main/resources/MessagesBundle_cs.properties)
6+
* [Dutch](./src/main/resources/MessagesBundle_nl.properties)
7+
* [French](./src/main/resources/MessagesBundle_fr.properties)
8+
* [German](./src/main/resources/MessagesBundle_de.properties)
9+
* [Hungarian](./src/main/resources/MessagesBundle_hu.properties)
10+
* [Italian](./src/main/resources/MessagesBundle_it.properties)
11+
* [Japanese](./src/main/resources/MessagesBundle_ja.properties)
12+
* [Norwegian](./src/main/resources/MessagesBundle_no.properties)
13+
* [Polish](./src/main/resources/MessagesBundle_pl.properties)
14+
* [Romanian](./src/main/resources/MessagesBundle_ro.properties)
15+
* [Spanish](./src/main/resources/MessagesBundle_es.properties)
16+
17+
Anyone can create a translation without knowing how to program Java.
18+
Simply supply me with a MessagesBundle file for your locale and I'm happy
19+
to include it. See [MessagesBundle.properties](./src/main/resources/MessagesBundle.properties) as an example with reference
20+
English messages.
21+
22+
Aaron ([email protected])

‎LICENSE

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README

Lines changed: 0 additions & 56 deletions
This file was deleted.

‎README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
This is a Java port of the GNU getopt functions based on the versions
2+
contained in glibc 2.0.6. I have attempted to keep the functionality
3+
and programmer's interface as faithful to the original as possible.
4+
However, due to differences between Java and C, some minor changes
5+
has to me made. (Given the obtuse interface in the clib version,
6+
perhaps some major changes should have been made). This should not
7+
affect the way options appear to be parsed to the end user of program
8+
that uses this Java getopt. The use of these classes are completely
9+
documented in the javadoc comments, so I will not repeat that info here.
10+
11+
I am not aware of any bugs. If you find one though, please send email
12+
to me at [email protected]. The more detailed a bug report the better.
13+
Bug fixes are also welcome at the same address. Please reference
14+
release number "1.0.14". If you use this code, it would be helpful
15+
if you let me know so that I can let you know if anything changes or
16+
if any major bugs have been found/fixed.
17+
18+
I have included a Gradle wrapper for compiling the source and generating the Javadoc. That means, there is no need to install Gradle in order to use it!
19+
20+
Just run
21+
```shell
22+
./gradlew build
23+
```
24+
to generate the .class files in `./build/classes` and a jar in `./build/libs` or run
25+
```shell
26+
./gradlew javadoc
27+
```
28+
to generate the Javadoc in `./build/docs`.
29+
30+
If you want to open the project in Eclipse, run
31+
```shell
32+
./gradlew cleanEclipse eclipse
33+
```
34+
Then you can simply import the project in Eclipse as an "existing Eclipse project".
35+
36+
There is sample code showing how to use getopt available in the
37+
GetoptDemo.java file.
38+
39+
The source code is released under the [GNU Lesser General Public License version 3](./LICENSE) and translated to [various languages](./LANGUAGES.md). A [changelog](./CHANGELOG.md) is also available.
40+
41+
Happy hacking!
42+
43+
---
44+
45+
Original README by:
46+
47+
Aaron.<br>
48+
[email protected]<br>
49+
http://www.urbanophile.com/arenn/
50+
51+
README modified by Florian

‎build.gradle

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
apply plugin: 'java'
2+
apply plugin: 'eclipse'
3+
4+
5+
version = '1.1.0'
6+
sourceCompatibility = '1.7'
7+
8+
sourceSets {
9+
main {
10+
java {
11+
exclude 'GetoptDemo.java'
12+
}
13+
}
14+
}
15+
16+
task wrapper(type: Wrapper) {
17+
gradleVersion = '2.4'
18+
}

‎gradle/wrapper/gradle-wrapper.jar

46.5 KB
Binary file not shown.

‎gradle/wrapper/gradle-wrapper.properties

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#Fri May 22 15:53:16 CEST 2015
2+
distributionBase=GRADLE_USER_HOME
3+
distributionPath=wrapper/dists
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists
6+
distributionUrl=http\://services.gradle.org/distributions/gradle-2.4-bin.zip

0 commit comments

Comments
 (0)