GCC Fastjar
GCC Fastjar
Tom Tromey
For the GCC-4.1.2 Version*
Copyright
c 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under the terms of
the GNU Free Documentation License, Version 1.2 or any later version published by the
Free Software Foundation; with the Invariant Sections being “GNU General Public License”,
the Front-Cover texts being (a) (see below), and with the Back-Cover Texts being (b) (see
below). A copy of the license is included in the section entitled “GNU Free Documentation
License”.
(a) The FSF’s Front-Cover Text is:
A GNU Manual
(b) The FSF’s Back-Cover Text is:
You have freedom to copy and modify this GNU Manual, like GNU software. Copies
published by the Free Software Foundation raise funds for GNU development.
i
Table of Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1 Invoking gcj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.1 Input and output files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.2 Input Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.3 Encodings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.4 Warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.5 Linking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.6 Code Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
1.7 Configure-time Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3 Invoking gcjh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4 Invoking gjnih . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5 Invoking jv-scan . . . . . . . . . . . . . . . . . . . . . . . . . . 27
6 Invoking jcf-dump . . . . . . . . . . . . . . . . . . . . . . . . 28
7 Invoking gij . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
8 Invoking gcj-dbtool. . . . . . . . . . . . . . . . . . . . . . . . 31
9 Invoking jv-convert . . . . . . . . . . . . . . . . . . . . . . . 32
ii
10 Invoking grmic . . . . . . . . . . . . . . . . . . . . . . . . . . 33
11 Invoking grmiregistry . . . . . . . . . . . . . . . . . . . . 34
12 About CNI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
12.1 Basic concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
12.1.1 Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
12.2 Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
12.2.1 Leaving out package names . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
12.3 Primitive types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
12.3.1 Reference types associated with primitive types . . . . . . . . . 37
12.4 Reference types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
12.5 Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
12.6 Objects and Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
12.6.1 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
12.6.2 Object fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
12.6.3 Access specifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
12.7 Class Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
12.8 Object allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
12.9 Memory allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
12.10 Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
12.10.1 Creating arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
12.11 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
12.11.1 Overloading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
12.11.2 Static methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
12.11.3 Object Constructors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
12.11.4 Instance methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
12.11.5 Interface methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
12.12 Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
12.13 Interoperating with C/C++ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
12.13.1 RawData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
12.13.2 RawDataManaged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
12.13.3 Native memory allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
12.13.4 Posix signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
12.14 Exception Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
12.15 Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
12.16 Invocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
12.16.1 Handling uncaught exceptions . . . . . . . . . . . . . . . . . . . . . . . . 48
12.16.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
12.17 Reflection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
13 System properties . . . . . . . . . . . . . . . . . . . . . . . 50
13.1 Standard Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
13.2 GNU Classpath Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
13.3 libgcj Runtime Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
14 Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
iii
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Introduction 1
Introduction
This manual describes how to use gcj, the GNU compiler for the Java programming lan-
guage. gcj can generate both ‘.class’ files and object files, and it can read both Java
source code and ‘.class’ files.
GNU GENERAL PUBLIC LICENSE 2
Preamble
The licenses for most software are designed to take away your freedom to share and change
it. By contrast, the GNU General Public License is intended to guarantee your freedom
to share and change free software—to make sure the software is free for all its users. This
General Public License applies to most of the Free Software Foundation’s software and to
any other program whose authors commit to using it. (Some other Free Software Foundation
software is covered by the GNU Library General Public License instead.) You can apply it
to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General
Public Licenses are designed to make sure that you have the freedom to distribute copies
of free software (and charge for this service if you wish), that you receive source code or
can get it if you want it, that you can change the software or use pieces of it in new free
programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to deny you
these rights or to ask you to surrender the rights. These restrictions translate to certain
responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you
must give the recipients all the rights that you have. You must make sure that they, too,
receive or can get the source code. And you must show them these terms so they know
their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this
license which gives you legal permission to copy, distribute and/or modify the software.
Also, for each author’s protection and ours, we want to make certain that everyone
understands that there is no warranty for this free software. If the software is modified by
someone else and passed on, we want its recipients to know that what they have is not the
original, so that any problems introduced by others will not reflect on the original authors’
reputations.
Finally, any free program is threatened constantly by software patents. We wish to avoid
the danger that redistributors of a free program will individually obtain patent licenses, in
effect making the program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone’s free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification follow.
GNU GENERAL PUBLIC LICENSE 3
Thus, it is not the intent of this section to claim rights or contest your rights to
work written entirely by you; rather, the intent is to exercise the right to control the
distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the
Program (or with a work based on the Program) on a volume of a storage or distribution
medium does not bring the other work under the scope of this License.
3. You may copy and distribute the Program (or a work based on it, under Section 2)
in object code or executable form under the terms of Sections 1 and 2 above provided
that you also do one of the following:
a. Accompany it with the complete corresponding machine-readable source code,
which must be distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
b. Accompany it with a written offer, valid for at least three years, to give any third
party, for a charge no more than your cost of physically performing source distri-
bution, a complete machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium customarily
used for software interchange; or,
c. Accompany it with the information you received as to the offer to distribute cor-
responding source code. (This alternative is allowed only for noncommercial dis-
tribution and only if you received the program in object code or executable form
with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making modifi-
cations to it. For an executable work, complete source code means all the source code
for all modules it contains, plus any associated interface definition files, plus the scripts
used to control compilation and installation of the executable. However, as a spe-
cial exception, the source code distributed need not include anything that is normally
distributed (in either source or binary form) with the major components (compiler,
kernel, and so on) of the operating system on which the executable runs, unless that
component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from
a designated place, then offering equivalent access to copy the source code from the
same place counts as distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program except as expressly
provided under this License. Any attempt otherwise to copy, modify, sublicense or
distribute the Program is void, and will automatically terminate your rights under this
License. However, parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such parties remain in full
compliance.
5. You are not required to accept this License, since you have not signed it. However,
nothing else grants you permission to modify or distribute the Program or its derivative
works. These actions are prohibited by law if you do not accept this License. Therefore,
by modifying or distributing the Program (or any work based on the Program), you
indicate your acceptance of this License to do so, and all its terms and conditions for
copying, distributing or modifying the Program or works based on it.
GNU GENERAL PUBLIC LICENSE 5
6. Each time you redistribute the Program (or any work based on the Program), the
recipient automatically receives a license from the original licensor to copy, distribute
or modify the Program subject to these terms and conditions. You may not impose
any further restrictions on the recipients’ exercise of the rights granted herein. You are
not responsible for enforcing compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent infringement or for any
other reason (not limited to patent issues), conditions are imposed on you (whether by
court order, agreement or otherwise) that contradict the conditions of this License, they
do not excuse you from the conditions of this License. If you cannot distribute so as
to satisfy simultaneously your obligations under this License and any other pertinent
obligations, then as a consequence you may not distribute the Program at all. For
example, if a patent license would not permit royalty-free redistribution of the Program
by all those who receive copies directly or indirectly through you, then the only way
you could satisfy both it and this License would be to refrain entirely from distribution
of the Program.
If any portion of this section is held invalid or unenforceable under any particular
circumstance, the balance of the section is intended to apply and the section as a
whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other
property right claims or to contest validity of any such claims; this section has the
sole purpose of protecting the integrity of the free software distribution system, which
is implemented by public license practices. Many people have made generous contri-
butions to the wide range of software distributed through that system in reliance on
consistent application of that system; it is up to the author/donor to decide if he or
she is willing to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence
of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain countries either
by patents or by copyrighted interfaces, the original copyright holder who places the
Program under this License may add an explicit geographical distribution limitation
excluding those countries, so that distribution is permitted only in or among countries
not thus excluded. In such case, this License incorporates the limitation as if written
in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions of the General
Public License from time to time. Such new versions will be similar in spirit to the
present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a
version number of this License which applies to it and “any later version”, you have
the option of following the terms and conditions either of that version or of any later
version published by the Free Software Foundation. If the Program does not specify a
version number of this License, you may choose any version ever published by the Free
Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs whose distri-
bution conditions are different, write to the author to ask for permission. For software
GNU GENERAL PUBLIC LICENSE 6
which is copyrighted by the Free Software Foundation, write to the Free Software Foun-
dation; we sometimes make exceptions for this. Our decision will be guided by the two
goals of preserving the free status of all derivatives of our free software and of promoting
the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLI-
CABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPY-
RIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS
IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE
RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH
YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST
OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO
MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED
ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF
THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT
LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this when it starts in an
interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
type ‘show w’.
This is free software, and you are welcome to redistribute it
under certain conditions; type ‘show c’ for details.
The hypothetical commands ‘show w’ and ‘show c’ should show the appropriate parts of
the General Public License. Of course, the commands you use may be called something
other than ‘show w’ and ‘show c’; they could even be mouse-clicks or menu items—whatever
suits your program.
You should also get your employer (if you work as a programmer) or your school, if any,
to sign a “copyright disclaimer” for the program, if necessary. Here is a sample; alter the
names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
‘Gnomovision’ (which makes passes at compilers) written by James Hacker.
under this License. If a section does not fit the above definition of Secondary then it is
not allowed to be designated as Invariant. The Document may contain zero Invariant
Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover
Texts or Back-Cover Texts, in the notice that says that the Document is released under
this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may
be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented
in a format whose specification is available to the general public, that is suitable for
revising the document straightforwardly with generic text editors or (for images com-
posed of pixels) generic paint programs or (for drawings) some widely available drawing
editor, and that is suitable for input to text formatters or for automatic translation to
a variety of formats suitable for input to text formatters. A copy made in an otherwise
Transparent file format whose markup, or absence of markup, has been arranged to
thwart or discourage subsequent modification by readers is not Transparent. An image
format is not Transparent if used for any substantial amount of text. A copy that is
not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ascii without
markup, Texinfo input format, LaTEX input format, SGML or XML using a publicly
available DTD, and standard-conforming simple HTML, PostScript or PDF designed
for human modification. Examples of transparent image formats include PNG, XCF
and JPG. Opaque formats include proprietary formats that can be read and edited
only by proprietary word processors, SGML or XML for which the DTD and/or
processing tools are not generally available, and the machine-generated HTML,
PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following
pages as are needed to hold, legibly, the material this License requires to appear in the
title page. For works in formats which do not have any title page as such, “Title Page”
means the text near the most prominent appearance of the work’s title, preceding the
beginning of the body of the text.
A section “Entitled XYZ” means a named subunit of the Document whose title either
is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in
another language. (Here XYZ stands for a specific section name mentioned below, such
as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve
the Title” of such a section when you modify the Document means that it remains a
section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that
this License applies to the Document. These Warranty Disclaimers are considered to
be included by reference in this License, but only as regards disclaiming warranties:
any other implication that these Warranty Disclaimers may have is void and has no
effect on the meaning of this License.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or
noncommercially, provided that this License, the copyright notices, and the license
notice saying this License applies to the Document are reproduced in all copies, and
GNU Free Documentation License 10
that you add no other conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further copying of the copies
you make or distribute. However, you may accept compensation in exchange for copies.
If you distribute a large enough number of copies you must also follow the conditions
in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly
display copies.
3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of
the Document, numbering more than 100, and the Document’s license notice requires
Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all
these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify you as the publisher
of these copies. The front cover must present the full title with all words of the title
equally prominent and visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve the title of the
Document and satisfy these conditions, can be treated as verbatim copying in other
respects.
If the required texts for either cover are too voluminous to fit legibly, you should put
the first ones listed (as many as fit reasonably) on the actual cover, and continue the
rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100,
you must either include a machine-readable Transparent copy along with each Opaque
copy, or state in or with each Opaque copy a computer-network location from which
the general network-using public has access to download using public-standard network
protocols a complete Transparent copy of the Document, free of added material. If
you use the latter option, you must take reasonably prudent steps, when you begin
distribution of Opaque copies in quantity, to ensure that this Transparent copy will
remain thus accessible at the stated location until at least one year after the last time
you distribute an Opaque copy (directly or through your agents or retailers) of that
edition to the public.
It is requested, but not required, that you contact the authors of the Document well
before redistributing any large number of copies, to give them a chance to provide you
with an updated version of the Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions
of sections 2 and 3 above, provided that you release the Modified Version under precisely
this License, with the Modified Version filling the role of the Document, thus licensing
distribution and modification of the Modified Version to whoever possesses a copy of
it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct from that of the
Document, and from those of previous versions (which should, if there were any,
be listed in the History section of the Document). You may use the same title as
a previous version if the original publisher of that version gives permission.
GNU Free Documentation License 11
B. List on the Title Page, as authors, one or more persons or entities responsible for
authorship of the modifications in the Modified Version, together with at least five
of the principal authors of the Document (all of its principal authors, if it has fewer
than five), unless they release you from this requirement.
C. State on the Title page the name of the publisher of the Modified Version, as the
publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications adjacent to the other
copyright notices.
F. Include, immediately after the copyright notices, a license notice giving the public
permission to use the Modified Version under the terms of this License, in the form
shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections and required Cover
Texts given in the Document’s license notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled “History”, Preserve its Title, and add to it an item
stating at least the title, year, new authors, and publisher of the Modified Version
as given on the Title Page. If there is no section Entitled “History” in the Docu-
ment, create one stating the title, year, authors, and publisher of the Document
as given on its Title Page, then add an item describing the Modified Version as
stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for public access to
a Transparent copy of the Document, and likewise the network locations given in
the Document for previous versions it was based on. These may be placed in the
“History” section. You may omit a network location for a work that was published
at least four years before the Document itself, or if the original publisher of the
version it refers to gives permission.
K. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title
of the section, and preserve in the section all the substance and tone of each of the
contributor acknowledgements and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document, unaltered in their text and
in their titles. Section numbers or the equivalent are not considered part of the
section titles.
M. Delete any section Entitled “Endorsements”. Such a section may not be included
in the Modified Version.
N. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in
title with any Invariant Section.
O. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify
as Secondary Sections and contain no material copied from the Document, you may at
your option designate some or all of these sections as invariant. To do this, add their
titles to the list of Invariant Sections in the Modified Version’s license notice. These
titles must be distinct from any other section titles.
GNU Free Documentation License 12
You may add a section Entitled “Endorsements”, provided it contains nothing but
endorsements of your Modified Version by various parties—for example, statements of
peer review or that the text has been approved by an organization as the authoritative
definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up
to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified
Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be
added by (or through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or by arrangement
made by the same entity you are acting on behalf of, you may not add another; but
you may replace the old one, on explicit permission from the previous publisher that
added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission
to use their names for publicity for or to assert or imply endorsement of any Modified
Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License,
under the terms defined in section 4 above for modified versions, provided that you
include in the combination all of the Invariant Sections of all of the original documents,
unmodified, and list them all as Invariant Sections of your combined work in its license
notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical
Invariant Sections may be replaced with a single copy. If there are multiple Invariant
Sections with the same name but different contents, make the title of each such section
unique by adding at the end of it, in parentheses, the name of the original author or
publisher of that section if known, or else a unique number. Make the same adjustment
to the section titles in the list of Invariant Sections in the license notice of the combined
work.
In the combination, you must combine any sections Entitled “History” in the vari-
ous original documents, forming one section Entitled “History”; likewise combine any
sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You
must delete all sections Entitled “Endorsements.”
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released
under this License, and replace the individual copies of this License in the various
documents with a single copy that is included in the collection, provided that you
follow the rules of this License for verbatim copying of each of the documents in all
other respects.
You may extract a single document from such a collection, and distribute it individu-
ally under this License, provided you insert a copy of this License into the extracted
document, and follow this License in all other respects regarding verbatim copying of
that document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate and independent
documents or works, in or on a volume of a storage or distribution medium, is called
GNU Free Documentation License 13
an “aggregate” if the copyright resulting from the compilation is not used to limit the
legal rights of the compilation’s users beyond what the individual works permit. When
the Document is included in an aggregate, this License does not apply to the other
works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document,
then if the Document is less than one half of the entire aggregate, the Document’s Cover
Texts may be placed on covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form. Otherwise they
must appear on printed covers that bracket the whole aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you may distribute translations
of the Document under the terms of section 4. Replacing Invariant Sections with
translations requires special permission from their copyright holders, but you may
include translations of some or all Invariant Sections in addition to the original versions
of these Invariant Sections. You may include a translation of this License, and all the
license notices in the Document, and any Warranty Disclaimers, provided that you
also include the original English version of this License and the original versions of
those notices and disclaimers. In case of a disagreement between the translation and
the original version of this License or a notice or disclaimer, the original version will
prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “His-
tory”, the requirement (section 4) to Preserve its Title (section 1) will typically require
changing the actual title.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly
provided for under this License. Any other attempt to copy, modify, sublicense or
distribute the Document is void, and will automatically terminate your rights under
this License. However, parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such parties remain in full
compliance.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of the GNU Free
Documentation License from time to time. Such new versions will be similar in spirit
to the present version, but may differ in detail to address new problems or concerns.
See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document
specifies that a particular numbered version of this License “or any later version”
applies to it, you have the option of following the terms and conditions either of that
specified version or of any later version that has been published (not as a draft) by
the Free Software Foundation. If the Document does not specify a version number of
this License, you may choose any version ever published (not as a draft) by the Free
Software Foundation.
GNU Free Documentation License 14
1 Invoking gcj
As gcj is just another front end to gcc, it supports many of the same options as gcc. See
section “Option Summary” in Using the GNU Compiler Collection (GCC). This manual
only documents the options specific to gcj.
-Idir All directories specified by -I are kept in order and prepended to the class
path constructed from all the other options. Unless compatibility with tools
like javac is important, we recommend always using -I instead of the other
options for manipulating the class path.
--classpath=path
This sets the class path to path, a colon-separated list of paths (on Windows-
based systems, a semicolon-separate list of paths). This does not override the
builtin (“boot”) search path.
--CLASSPATH=path
Deprecated synonym for --classpath.
--bootclasspath=path
Where to find the standard builtin classes, such as java.lang.String.
--extdirs=path
For each directory in the path, place the contents of that directory at the end
of the class path.
CLASSPATH
This is an environment variable which holds a list of paths.
The final class path is constructed like so:
• First come all directories specified via -I.
• If ‘--classpath’ is specified, its value is appended. Otherwise, if the CLASSPATH en-
vironment variable is specified, then its value is appended. Otherwise, the current
directory (".") is appended.
• If --bootclasspath was specified, append its value. Otherwise, append the built-in
system directory, ‘libgcj.jar’.
• Finally, if --extdirs was specified, append the contents of the specified directories at
the end of the class path. Otherwise, append the contents of the built-in extdirs at
$(prefix)/share/java/ext.
The classfile built by gcj for the class java.lang.Object (and placed in libgcj.jar)
contains a special zero length attribute gnu.gcj.gcj-compiled. The compiler looks for
this attribute when loading java.lang.Object and will report an error if it isn’t found,
unless it compiles to bytecode (the option -fforce-classes-archive-check can be used
to override this behavior in this particular case.)
-fforce-classes-archive-check
This forces the compiler to always check for the special zero length attribute
gnu.gcj.gcj-compiled in java.lang.Object and issue an error if it isn’t
found.
1.3 Encodings
The Java programming language uses Unicode throughout. In an effort to integrate well
with other locales, gcj allows ‘.java’ files to be written using almost any encoding. gcj
knows how to convert these encodings into its internal encoding at compile time.
Chapter 1: Invoking gcj 17
You can use the --encoding=NAME option to specify an encoding (of a particular char-
acter set) to use for source files. If this is not specified, the default encoding comes from
your current locale. If your host system has insufficient locale support, then gcj assumes
the default encoding to be the ‘UTF-8’ encoding of Unicode.
To implement --encoding, gcj simply uses the host platform’s iconv conversion routine.
This means that in practice gcj is limited by the capabilities of the host platform.
The names allowed for the argument --encoding vary from platform to platform (since
they are not standardized anywhere). However, gcj implements the encoding named ‘UTF-8’
internally, so if you choose to use this for your source files you can be assured that it will
work on every host.
1.4 Warnings
gcj implements several warnings. As with other generic gcc warnings, if an option of
the form -Wfoo enables a warning, then -Wno-foo will disable it. Here we’ve chosen to
document the form of the warning which will have an effect – the default being the opposite
of what is listed.
-Wredundant-modifiers
With this flag, gcj will warn about redundant modifiers. For instance, it will
warn if an interface method is declared public.
-Wextraneous-semicolon
This causes gcj to warn about empty statements. Empty statements have been
deprecated.
-Wno-out-of-date
This option will cause gcj not to warn when a source file is newer than its
matching class file. By default gcj will warn about this.
-Wno-deprecated
Warn if a deprecated class, method, or field is referred to.
-Wunused This is the same as gcc’s -Wunused.
-Wall This is the same as -Wredundant-modifiers -Wextraneous-semicolon
-Wunused.
1.5 Linking
To turn a Java application into an executable program, you need to link it with the needed
libraries, just as for C or C++. The linker by default looks for a global function named main.
Since Java does not have global functions, and a collection of Java classes may have more
than one class with a main method, you need to let the linker know which of those main
methods it should invoke when starting the application. You can do that in any of these
ways:
• Specify the class containing the desired main method when you link the application,
using the --main flag, described below.
• Link the Java package(s) into a shared library (dll) rather than an executable. Then
invoke the application using the gij program, making sure that gij can find the
libraries it needs.
Chapter 1: Invoking gcj 18
• Link the Java packages(s) with the flag -lgij, which links in the main routine from
the gij command. This allows you to select the class whose main method you want to
run when you run the application. You can also use other gij flags, such as -D flags to
set properties. Using the -lgij library (rather than the gij program of the previous
mechanism) has some advantages: it is compatible with static linking, and does not
require configuring or installing libraries.
These gij options relate to linking an executable:
--main=CLASSNAME
This option is used when linking to specify the name of the class whose main
method should be invoked when the resulting executable is run.
-Dname [=value ]
This option can only be used with --main. It defines a system property named
name with value value. If value is not specified then it defaults to the empty
string. These system properties are initialized at the program’s startup and can
be retrieved at runtime using the java.lang.System.getProperty method.
-lgij Create an application whose command-line processing is that of the gij com-
mand.
This option is an alternative to using --main; you cannot use both.
-fno-store-check
Don’t generate array store checks. When storing objects into arrays, a runtime
check is normally generated in order to ensure that the object is assignment
compatible with the component type of the array (which may not be known at
compile-time). With this option, these checks are omitted. This can improve
performance for code which stores objects into arrays frequently. It is safe to use
this option if you are sure your code will never throw an ArrayStoreException.
-fjni With gcj there are two options for writing native methods: CNI and JNI. By
default gcj assumes you are using CNI. If you are compiling a class with native
methods, and these methods are implemented using JNI, then you must use -
fjni. This option causes gcj to generate stubs which will invoke the underlying
JNI methods.
-fno-assert
Don’t recognize the assert keyword. This is for compatibility with older ver-
sions of the language specification.
-fno-optimize-static-class-initialization
When the optimization level is greater or equal to -O2, gcj will try to optimize
the way calls into the runtime are made to initialize static classes upon their first
use (this optimization isn’t carried out if -C was specified.) When compiling
to native code, -fno-optimize-static-class-initialization will turn this
optimization off, regardless of the optimization level in use.
--disable-assertions[=class-or-package ]
Don’t include code for checking assertions in the compiled code. If =class-
or-package is missing disables assertion code generation for all classes, unless
overridden by a more specific --enable-assertions flag. If class-or-package is
a class name, only disables generating assertion checks within the named class
or its inner classes. If class-or-package is a package name, disables generating
assertion checks within the named package or a subpackage.
By default, assertions are enabled when generating class files or when not op-
timizing, and disabled when generating optimized binaries.
--enable-assertions[=class-or-package ]
Generates code to check assertions. The option is perhaps misnamed, as you
still need to turn on assertion checking at run-time, and we don’t support any
easy way to do that. So this flag isn’t very useful yet, except to partially
override --disable-assertions.
-findirect-dispatch
gcj has a special binary compatibility ABI, which is enabled by the
-findirect-dispatch option. In this mode, the code generated by gcj
honors the binary compatibility guarantees in the Java Language Specification,
and the resulting object files do not need to be directly linked against their
dependencies. Instead, all dependencies are looked up at runtime. This allows
free mixing of interpreted and compiled code.
Note that, at present, -findirect-dispatch can only be used when compiling
‘.class’ files. It will not work when compiling from source. CNI also does not
Chapter 1: Invoking gcj 20
yet work with the binary compatibility ABI. These restrictions will be lifted in
some future release.
However, if you compile CNI code with the standard ABI, you can call it from
code built with the binary compatibility ABI.
-fbootstrap-classes
This option can be use to tell libgcj that the compiled classes should be loaded
by the bootstrap loader, not the system class loader. By default, if you compile
a class and link it into an executable, it will be treated as if it was loaded
using the system class loader. This is convenient, as it means that things like
Class.forName() will search ‘CLASSPATH’ to find the desired class.
• libgcj includes a special ‘gcjlib’ URL type. A URL of this form is like a jar URL, and
looks like ‘gcjlib:/path/to/shared/library.so!/path/to/resource’. An access to
one of these URLs causes the shared library to be dlopen()d, and then the resource is
looked for in that library. These URLs are most useful when used in conjunction with
java.net.URLClassLoader. Note that, due to implementation limitations, currently
any such URL can be accessed by only one class loader, and libraries are never unloaded.
This means some care must be exercised to make sure that a gcjlib URL is not accessed
by more than one class loader at once. In a future release this limitation will be lifted,
and such libraries will be mapped privately.
• A program compiled by gcj will examine the GCJ_PROPERTIES environment variable
and change its behavior in some ways. In particular GCJ_PROPERTIES holds a list of
assignments to global properties, such as would be set with the ‘-D’ option to java.
For instance, ‘java.compiler=gcj’ is a valid (but currently meaningless) setting.
Chapter 3: Invoking gcjh 23
3 Invoking gcjh
The gcjh program is used to generate header files from class files. It can generate both
CNI and JNI header files, as well as stub implementation files which can be used as a basis
for implementing the required native methods.
-stubs This causes gcjh to generate stub files instead of header files. By default the
stub file will be named after the class, with a suffix of ‘.cc’. In JNI mode, the
default output file will have the suffix ‘.c’.
-jni This tells gcjh to generate a JNI header or stub. By default, CNI headers are
generated.
-force This option forces gcjh to write the output file.
-old This option is accepted but ignored for compatibility.
-trace This option is accepted but ignored for compatibility.
-J option
This option is accepted but ignored for compatibility.
-add text
Inserts text into the class body. This is ignored in JNI mode.
-append text
Inserts text into the header file after the class declaration. This is ignored in
JNI mode.
-friend text
Inserts text into the class as a friend declaration. This is ignored in JNI mode.
-prepend text
Inserts text into the header file before the class declaration. This is ignored in
JNI mode.
--classpath=path
--CLASSPATH=path
--bootclasspath=path
-Idirectory
-d directory
-o file These options are all identical to the corresponding gcj options.
-o file Sets the output file name. This cannot be used if there is more than one class
on the command line.
-td directory
Sets the name of the directory to use for temporary files.
-M Print all dependencies to stdout; suppress ordinary output.
-MM Print non-system dependencies to stdout; suppress ordinary output.
-MD Print all dependencies to stdout.
-MMD Print non-system dependencies to stdout.
Chapter 3: Invoking gcjh 24
--help Print help about gcjh and exit. No further processing is done.
--version
Print version information for gcjh and exit. No further processing is done.
-v, --verbose
Print extra information while running.
All remaining options are considered to be names of classes.
Chapter 4: Invoking gjnih 25
4 Invoking gjnih
The gjnih program is used to generate JNI header files from class files. Running it is
equivalent to running gcjh -jni.
-stubs This causes gjnih to generate stub files instead of header files. By default the
stub file will be named after the class, with a suffix of ‘.c’.
-jni This option specifies the default behavior which is to generate a JNI header or
stub.
-force This option forces gjnih to write the output file.
-old This option is accepted but ignored for compatibility.
-trace This option is accepted but ignored for compatibility.
-J option
This option is accepted but ignored for compatibility.
-add text
Inserts text into the class body. This is ignored in by gjnih.
-append text
Inserts text into the header file after the class declaration. This is ignored in
by gjnih.
-friend text
Inserts text into the class as a friend declaration. This is ignored by gjnih.
-prepend text
Inserts text into the header file before the class declaration. This is ignored in
by gjnih.
--classpath=path
--CLASSPATH=path
--bootclasspath=path
-Idirectory
-d directory
-o file These options are all identical to the corresponding gcj options.
-o file Sets the output file name. This cannot be used if there is more than one class
on the command line.
-td directory
Sets the name of the directory to use for temporary files.
-M Print all dependencies to stdout; suppress ordinary output.
-MM Print non-system dependencies to stdout; suppress ordinary output.
-MD Print all dependencies to stdout.
-MMD Print non-system dependencies to stdout.
--help Print help about gjnih and exit. No further processing is done.
Chapter 4: Invoking gjnih 26
--version
Print version information for gjnih and exit. No further processing is done.
-v, --verbose
Print extra information while running.
All remaining options are considered to be names of classes.
Chapter 5: Invoking jv-scan 27
5 Invoking jv-scan
The jv-scan program can be used to print information about a Java source file (‘.java’
file).
--no-assert
Don’t recognize the assert keyword, for backwards compatibility with older
versions of the language specification.
--complexity
This prints a complexity measure, related to cyclomatic complexity, for each
input file.
--encoding=name
This works like the corresponding gcj option.
--print-main
This prints the name of the class in this file containing a main method.
--list-class
This lists the names of all classes defined in the input files.
--list-filename
If --list-class is given, this option causes jv-scan to also print the name of
the file in which each class was found.
-o file Print output to the named file.
--help Print help, then exit.
--version
Print version number, then exit.
Chapter 6: Invoking jcf-dump 28
6 Invoking jcf-dump
This is a class file examiner, similar to javap. It will print information about a number of
classes, which are specified by class name or file name.
-c Disassemble method bodies. By default method bodies are not printed.
--print-constants
Print the constant pool. When printing a reference to a constant also print its
index in the constant pool.
--javap Generate output in javap format. The implementation of this feature is very
incomplete.
--classpath=path
--CLASSPATH=path
-Idirectory
-o file These options as the same as the corresponding gcj options.
--help Print help, then exit.
--version
Print version number, then exit.
-v, --verbose
Print extra information while running. Implies --print-constants.
Chapter 7: Invoking gij 29
7 Invoking gij
gij is a Java bytecode interpreter included with libgcj. gij is not available on every
platform; porting it requires a small amount of assembly programming which has not been
done for all the targets supported by gcj.
The primary argument to gij is the name of a class or, with -jar, a jar file. Options
before this argument are interpreted by gij; remaining options are passed to the interpreted
program.
If a class name is specified and this class does not have a main method with the appro-
priate signature (a static void method with a String[] as its sole argument), then gij
will print an error and exit.
If a jar file is specified then gij will use information in it to determine which class’ main
method will be invoked.
gij will invoke the main method with all the remaining command-line options.
Note that gij is not limited to interpreting code. Because libgcj includes a class loader
which can dynamically load shared objects, it is possible to give gij the name of a class
which has been compiled and put into a shared library on the class path.
-cp path
-classpath path
Set the initial class path. The class path is used for finding class and resource
files. If specified, this option overrides the CLASSPATH environment variable.
Note that this option is ignored if -jar is used.
-Dname [=value ]
This defines a system property named name with value value. If value is not
specified then it defaults to the empty string. These system properties are
initialized at the program’s startup and can be retrieved at runtime using the
java.lang.System.getProperty method.
-ms=number
Equivalent to -Xms.
-mx=number
Equivalent to -Xmx.
-noverify
Do not verify compliance of bytecode with the VM specification. In addition,
this option disables type verification which is otherwise performed on BC-ABI
compiled code.
-X
-Xargument
Supplying -X by itself will cause gij to list all the supported -X options. Cur-
rently these options are supported:
-Xmssize Set the initial heap size.
-Xmxsize Set the maximum heap size.
-Xsssize Set the thread stack size.
Chapter 7: Invoking gij 30
8 Invoking gcj-dbtool.
gcj-dbtool is a tool for creating and manipulating class file mapping databases. libgcj can
use these databases to find a shared library corresponding to the bytecode representation
of a class. This functionality is useful for ahead-of-time compilation of a program that has
no knowledge of gcj.
gcj-dbtool works best if all the jar files added to it are compiled using -findirect-
dispatch.
Note that gcj-dbtool is currently available as “preview technology”. We believe it is a
reasonable way to allow application-transparent ahead-of-time compilation, but this is an
unexplored area. We welcome your comments.
-n DBFILE [SIZE ]
This creates a new database. Currently, databases cannot be resized; you can
choose a larger initial size if desired. The default size is 32,749.
-a DBFILE JARFILE LIB
-f DBFILE JARFILE LIB
This adds a jar file to the database. For each class file in the jar, a cryptographic
signature of the bytecode representation of the class is recorded in the database.
At runtime, a class is looked up by its signature and the compiled form of the
class is looked for in the corresponding shared library. The ‘-a’ option will
verify that LIB exists before adding it to the database; ‘-f’ skips this check.
[‘-’][‘-0’] -m DBFILE DBFILE,[DBFILE ]
Merge a number of databases. The output database overwrites any existing
database. To add databases into an existing database, include the destination
in the list of sources.
If ‘-’ or ‘-0’ are used, the list of files to read is taken from standard input
instead of the command line. For ‘-0’, Input filenames are terminated by a null
character instead of by whitespace. Useful when arguments might contain white
space. The GNU find -print0 option produces input suitable for this mode.
-t DBFILE
Test a database.
-l DBFILE
List the contents of a database.
-p Print the name of the default database. If there is no default database, this
prints a blank line. If LIBDIR is specified, use it instead of the default library
directory component of the database name.
--help Print a help message, then exit.
--version
-v Print version information, then exit.
Chapter 9: Invoking jv-convert 32
9 Invoking jv-convert
jv-convert [‘OPTION’] . . . [INPUTFILE [OUTPUTFILE]]
jv-convert is a utility included with libgcj which converts a file from one encoding to
another. It is similar to the Unix iconv utility.
The encodings supported by jv-convert are platform-dependent. Currently there is no
way to get a list of all supported encodings.
--encoding name
--from name
Use name as the input encoding. The default is the current locale’s encoding.
--to name
Use name as the output encoding. The default is the JavaSrc encoding; this is
ASCII with ‘\u’ escapes for non-ASCII characters.
-i file Read from file. The default is to read from standard input.
-o file Write to file. The default is to write to standard output.
--reverse
Swap the input and output encodings.
--help Print a help message, then exit.
--version
Print version information, then exit.
Chapter 10: Invoking grmic 33
10 Invoking grmic
grmic [‘OPTION’] . . . class . . .
grmic is a utility included with libgcj which generates stubs for remote objects.
Note that this program isn’t yet fully compatible with the JDK grmic. Some options,
such as ‘-classpath’, are recognized but currently ignored. We have left these options
undocumented for now.
Long options can also be given with a GNU-style leading ‘--’. For instance, ‘--help’ is
accepted.
-keep
-keepgenerated
By default, grmic deletes intermediate files. Either of these options causes it
not to delete such files.
-v1.1 Cause grmic to create stubs and skeletons for the 1.1 protocol version.
-vcompat Cause grmic to create stubs and skeletons compatible with both the 1.1 and
1.2 protocol versions. This is the default.
-v1.2 Cause grmic to create stubs and skeletons for the 1.2 protocol version.
-nocompile
Don’t compile the generated files.
-verbose Print information about what grmic is doing.
-d directory
Put output files in directory. By default the files are put in the current working
directory.
-help Print a help message, then exit.
-version Print version information, then exit.
Chapter 11: Invoking grmiregistry 34
11 Invoking grmiregistry
grmic [‘OPTION’] . . . [port]
grmiregistry starts a remote object registry on the current host. If no port number is
specified, then port 1099 is used.
--help Print a help message, then exit.
--version
Print version information, then exit.
Chapter 12: About CNI 35
12 About CNI
This documents CNI, the Compiled Native Interface, which is is a convenient way to write
Java native methods using C++. This is a more efficient, more convenient, but less portable
alternative to the standard JNI (Java Native Interface).
12.1.1 Limitations
Whilst a Java class is just a C++ class that doesn’t mean that you are freed from the shackles
of Java, a CNI C++ class must adhere to the rules of the Java programming language.
For example: it is not possible to declare a method in a CNI class that will take a C
string (char*) as an argument, or to declare a member variable of some non-Java datatype.
Chapter 12: About CNI 36
12.2 Packages
The only global names in Java are class names, and packages. A package can contain zero or
more classes, and also zero or more sub-packages. Every class belongs to either an unnamed
package or a package that has a hierarchical and globally unique name.
A Java package is mapped to a C++ namespace. The Java class java.lang.String is
in the package java.lang, which is a sub-package of java. The C++ equivalent is the class
java::lang::String, which is in the namespace java::lang which is in the namespace
java.
Here is how you could express this:
(// Declare the class(es), possibly in a header file:
namespace java {
namespace lang {
class Object;
class String;
...
}
}
12.5 Interfaces
A Java class can implement zero or more interfaces, in addition to inheriting from a single
base class.
CNI allows CNI code to implement methods of interfaces. You can also call methods
through interface references, with some limitations.
CNI doesn’t understand interface inheritance at all yet. So, you can only call an interface
method when the declared type of the field being called matches the interface which declares
that method. The workaround is to cast the interface reference to the right superinterface.
For example if you have:
interface A
{
void a();
}
interface B extends A
{
void b();
}
and declare a variable of type B in C++, you can’t call a() unless you cast it to an A first.
public int i;
public Int (int i) { this.i = i; }
public static Int zero = new Int(0);
}
you can write:
#include <gcj/cni.h>;
#include <Int>;
Int*
mult (Int *p, jint k)
{
if (k == 0)
return Int::zero; // Static member access.
return new Int(p->i * k);
}
Accessing a static field also requires the class of the field to be initialized. The Java
compiler will generate code to call JvInitClass before getting or setting the field. However,
the C++ compiler will not generate this extra code, so it is your responsibility to make sure
the class is initialized before you access a static field from C++.
12.10 Arrays
While in many ways Java is similar to C and C++, it is quite different in its treatment of
arrays. C arrays are based on the idea of pointer arithmetic, which would be incompatible
with Java’s security requirements. Java arrays are true objects (array types inherit from
java.lang.Object). An array-valued variable is one that contains a reference (pointer) to
an array object.
Referencing a Java array in C++ code is done using the JArray template, which as defined
as follows:
class __JArray : public java::lang::Object
{
public:
int length;
};
template<class T>
class JArray : public __JArray
Chapter 12: About CNI 41
{
T data[0];
public:
T& operator[](jint i) { return data[i]; }
};
There are a number of typedefs which correspond to typedefs from the JNI. Each is
the type of an array holding objects of the relevant type:
typedef __JArray *jarray;
typedef JArray<jobject> *jobjectArray;
typedef JArray<jboolean> *jbooleanArray;
typedef JArray<jbyte> *jbyteArray;
typedef JArray<jchar> *jcharArray;
typedef JArray<jshort> *jshortArray;
typedef JArray<jint> *jintArray;
typedef JArray<jlong> *jlongArray;
typedef JArray<jfloat> *jfloatArray;
typedef JArray<jdouble> *jdoubleArray;
T* elements (JArray<T> array ) [Method on template<class T>]
This template function can be used to get a pointer to the elements of the array. For
instance, you can fetch a pointer to the integers that make up an int[] like so:
extern jintArray foo;
jint *intp = elements (foo);
The name of this function may change in the future.
jobjectArray JvNewObjectArray (jsize length, jclass klass, jobject [Function]
init )
This creates a new array whose elements have reference type. klass is the type of
elements of the array and init is the initial value put into every slot in the array.
using namespace java::lang;
JArray<String *> *array
= (JArray<String *> *) JvNewObjectArray(length, &String::class$, NULL);
12.11 Methods
Java methods are mapped directly into C++ methods. The header files generated by gcjh
include the appropriate method definitions. Basically, the generated methods have the same
names and corresponding types as the Java methods, and are called in the natural manner.
12.11.1 Overloading
Both Java and C++ provide method overloading, where multiple methods in a class have
the same name, and the correct one is chosen (at compile time) depending on the argument
types. The rules for choosing the correct method are (as expected) more complicated in C++
than in Java, but given a set of overloaded methods generated by gcjh the C++ compiler
will choose the expected one.
Common assemblers and linkers are not aware of C++ overloading, so the standard
implementation strategy is to encode the parameter types of a method into its assembly-
level name. This encoding is called mangling, and the encoded name is the mangled name.
The same mechanism is used to implement Java overloading. For C++/Java interoperability,
it is important that both the Java and C++ compilers use the same encoding scheme.
if (x->longValue == 0)
...
Defining a Java native instance method is also done the natural way:
#include <java/lang/Integer.h>
jdouble
java::lang:Integer::doubleValue()
{
return (jdouble) value;
}
12.12 Strings
CNI provides a number of utility functions for working with Java Java String objects. The
names and interfaces are analogous to those of JNI.
uint
::SomeClass::someMethod (char *arg)
{
.
.
.
} // uint is not a valid Java type, neither is char*
Of course, it is ok to use C/C++ types within the scope of a method:
jint
::SomeClass::otherMethod (jstring str)
{
char *arg = ...
.
.
.
}
12.13.1 RawData
The above restriction can be problematic, so CNI includes the gnu.gcj.RawData class. The
RawData class is a non-scanned reference type. In other words variables declared of type
RawData can contain any data and are not checked by the compiler or memory manager in
any way.
This means that you can put C/C++ data structures (including classes) in your CNI
classes, as long as you use the appropriate cast.
Here are some examples:
MyClass ();
gnu.gcj.RawData getText ();
void printText ();
}
::MyClass::MyClass ()
{
char* text = ...
string = text;
}
gnu.gcj.RawData
::MyClass::getText ()
{
return string;
}
void
::MyClass::printText ()
{
printf("%s\n", (char*) string);
}
12.13.2 RawDataManaged
gnu.gcj.RawDataManaged is another type used to indicate special data used by native
code. Unlike the RawData type, fields declared as RawDataManaged will be "marked" by the
memory manager and considered for garbage collection.
Native data which is allocated using CNI’s JvAllocBytes() function and stored in a
RawDataManaged will be automatically freed when the Java object it is associated with
becomes unreachable.
void foo()
{
S s;
bar();
}
The usual effect of an incorrect guess is a link failure, complaining of a missing routine
called __gxx_personality_v0.
You can inform the compiler that Java exceptions are to be used in a translation unit,
irrespective of what it might think, by writing #pragma GCC java_exceptions at the head
of the file. This #pragma must appear before any functions that throw or catch exceptions,
or run destructors when exceptions are thrown through them.
12.15 Synchronization
Each Java object has an implicit monitor. The Java VM uses the instruction monitorenter
to acquire and lock a monitor, and monitorexit to release it.
The corresponding CNI macros are JvMonitorEnter and JvMonitorExit (JNI has sim-
ilar methods MonitorEnter and MonitorExit).
The Java source language does not provide direct access to these primitives. Instead,
there is a synchronized statement that does an implicit monitorenter before entry to the
block, and does a monitorexit on exit from the block. Note that the lock has to be released
even when the block is abnormally terminated by an exception, which means there is an
implicit try finally surrounding synchronization locks.
Chapter 12: About CNI 47
From C++, it makes sense to use a destructor to release a lock. CNI defines the following
utility class:
class JvSynchronize() {
jobject obj;
JvSynchronize(jobject o) { obj = o; JvMonitorEnter(o); }
~JvSynchronize() { JvMonitorExit(obj); }
};
So this Java code:
synchronized (OBJ)
{
CODE
}
might become this C++ code:
{
JvSynchronize dummy (OBJ);
CODE;
}
Java also has methods with the synchronized attribute. This is equivalent to wrapping
the entire method body in a synchronized statement. (Alternatively, an implementation
could require the caller to do the synchronization. This is not practical for a compiler, be-
cause each virtual method call would have to test at run-time if synchronization is needed.)
Since in gcj the synchronized attribute is handled by the method implementation, it
is up to the programmer of a synchronized native method to handle the synchronization
(in the C++ implementation of the method). In other words, you need to manually add
JvSynchronize in a native synchronized method.
12.16 Invocation
CNI permits C++ applications to make calls into Java classes, in addition to allowing Java
code to call into C++. Several functions, known as the invocation API, are provided to
support this.
12.16.2 Example
The following code demonstrates the use of the invocation API. In this example, the C++
application initializes the Java runtime and attaches itself. The java.lang.System class is
initialized in order to access its out field, and a Java string is printed. Finally, the thread
is detached from the runtime once it has finished making Java calls. Everything is wrapped
with a try/catch block to provide a default handler for any uncaught exceptions.
The example can be compiled with c++ test.cc -lgcj.
// test.cc
#include <gcj/cni.h>
#include <java/lang/System.h>
#include <java/io/PrintStream.h>
#include <java/lang/Throwable.h>
try
{
JvCreateJavaVM(NULL);
JvAttachCurrentThread(NULL, NULL);
JvDetachCurrentThread();
}
catch (Throwable *t)
{
System::err->println(JvNewStringLatin1("Unhandled Java exception:"));
t->printStackTrace();
}
}
12.17 Reflection
Reflection is possible with CNI code, it functions similarly to how it functions with JNI.
The types jfieldID and jmethodID are as in JNI.
The functions:
• JvFromReflectedField,
• JvFromReflectedMethod,
• JvToReflectedField
• JvToFromReflectedMethod
will be added shortly, as will other functions corresponding to JNI.
Chapter 13: System properties 50
13 System properties
The runtime behavior of the libgcj library can be modified by setting certain
system properties. These properties can be compiled into the program using the
-Dname [=value ] option to gcj or by setting them explicitly in the program by calling
the java.lang.System.setProperty() method. Some system properties are only used
for informational purposes (like giving a version number or a user name). A program can
inspect the current value of a property by calling the java.lang.System.getProperty()
method.
java.specification.vendor
The Runtime Environment specification designer.
java.specification.name
The name of the Runtime Environment specification (Set to ‘Java Platform
API Specification’).
java.class.path
The paths (jar files, zip files and directories) used for finding class files.
java.library.path
Directory path used for finding native libraries.
java.io.tmpdir
The directory used to put temporary files in.
java.compiler
Name of the Just In Time compiler to use by the byte code interpreter. Cur-
rently not used in libgcj.
java.ext.dirs
Directories containing jar files with extra libraries. Will be used when resolving
classes.
java.protocol.handler.pkgs
A ‘|’ separated list of package names that is used to find classes that implement
handlers for java.net.URL.
java.rmi.server.codebase
A list of URLs that is used by the java.rmi.server.RMIClassLoader to load
classes from.
jdbc.drivers
A list of class names that will be loaded by the java.sql.DriverManager when
it starts up.
file.separator
The separator used in when directories are included in a filename (normally ‘/’
or ‘\’ ).
file.encoding
The default character encoding used when converting platform native files to
Unicode (usually set to ‘8859_1’).
path.separator
The standard separator used when a string contains multiple paths (normally
‘:’ or ‘;’), the string is usually not a valid character to use in normal directory
names.)
line.separator
The default line separator used on the platform (normally ‘\n’, ‘\r’ or a com-
bination of those two characters).
policy.provider
The class name used for the default policy provider returned by
java.security.Policy.getPolicy.
Chapter 13: System properties 52
user.name
The name of the user running the program. Can be the full name, the login
name or empty if unknown.
user.home
The default directory to put user specific files in.
user.dir The current working directory from which the program was started.
user.language
The default language as used by the java.util.Locale class.
user.region
The default region as used by the java.util.Local class.
user.variant
The default variant of the language and region local used.
user.timezone
The default timezone as used by the java.util.TimeZone class.
os.name The operating system/kernel name that the program runs on.
os.arch The hardware that we are running on.
os.version
The version number of the operating system/kernel.
awt.appletWarning
The string to display when an untrusted applet is displayed. Returned by
java.awt.Window.getWarningString() when the window is “insecure”.
awt.toolkit
The class name used for initializing the default java.awt.Toolkit. Defaults
to gnu.awt.gtk.GtkToolkit.
http.proxyHost
Name of proxy host for http connections.
http.proxyPort
Port number to use when a proxy host is in use.
gnu.classpath.home.url
A base URL used for finding system property files (e.g., ‘classpath.security’).
By default this is a ‘file:’ URL pointing to the ‘lib’ directory under
‘java.home’.
gnu.gcj.jit.options
This is a space-separated string of options which should be passed to gcj when
in JIT mode. If not set, a sensible default is chosen.
gnu.gcj.jit.cachedir
This is the directory where cached shared library files are stored. If not set, JIT
compilation is disabled. This should never be set to a directory that is writable
by any other user.
gnu.gcj.precompiled.db.path
This is a sequence of file names, each referring to a file created by gcj-dbtool.
These files will be used by libgcj to find shared libraries corresponding to
classes that are loaded from bytecode. libgcj often has a built-in default
database; it can be queried using gcj-dbtool -p.
Chapter 14: Resources 55
14 Resources
While writing gcj and libgcj we have, of course, relied heavily on documentation from
Sun Microsystems. In particular we have used The Java Language Specification (both
first and second editions), the Java Class Libraries (volumes one and two), and the
Java Virtual Machine Specification. In addition we’ve used the online documentation at
http://java.sun.com/.
The current gcj home page is http://gcc.gnu.org/java/.
For more information on gcc, see http://gcc.gnu.org/.
Some libgcj testing is done using the Mauve test suite. This is a free software
Java class library test suite which is being written because the JCK is not free. See
http://sources.redhat.com/mauve/ for more information.
Index 56
Index
C jobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
class path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 jstring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
class$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 JvAllocBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
JvAttachCurrentThread . . . . . . . . . . . . . . . . . . . . . 48
JvCreateJavaVM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
E JvDetachCurrentThread . . . . . . . . . . . . . . . . . . . . . 48
elements on template<class T> . . . . . . . . . . . . . . 41 JvFree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
JvGetArrayLength . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
JvGetStringChars . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
F JvGetStringUTFLength . . . . . . . . . . . . . . . . . . . . . . . 43
FDL, GNU Free Documentation License . . . . . . . . 8 JvGetStringUTFRegion . . . . . . . . . . . . . . . . . . . . . . . 43
JvMalloc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
JvNewBooleanArray . . . . . . . . . . . . . . . . . . . . . . . . . . 41
G JvNewObjectArray . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
GCJ_PROPERTIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 JvNewString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
JvNewStringLatin1 . . . . . . . . . . . . . . . . . . . . . . . . . . 43
JvNewStringUTF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
J JvPrimClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
jclass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 JvRealloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40