1 ." Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved. |
1 '\" t |
2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
2 .\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. |
3 ." |
3 .\" |
4 ." This code is free software; you can redistribute it and/or modify it |
4 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
5 ." under the terms of the GNU General Public License version 2 only, as |
5 .\" |
6 ." published by the Free Software Foundation. |
6 .\" This code is free software; you can redistribute it and/or modify it |
7 ." |
7 .\" under the terms of the GNU General Public License version 2 only, as |
8 ." This code is distributed in the hope that it will be useful, but WITHOUT |
8 .\" published by the Free Software Foundation. |
9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
9 .\" |
10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
10 .\" This code is distributed in the hope that it will be useful, but WITHOUT |
11 ." version 2 for more details (a copy is included in the LICENSE file that |
11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
12 ." accompanied this code). |
12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
13 ." |
13 .\" version 2 for more details (a copy is included in the LICENSE file that |
14 ." You should have received a copy of the GNU General Public License version |
14 .\" accompanied this code). |
15 ." 2 along with this work; if not, write to the Free Software Foundation, |
15 .\" |
16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
16 .\" You should have received a copy of the GNU General Public License version |
17 ." |
17 .\" 2 along with this work; if not, write to the Free Software Foundation, |
18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
18 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
19 ." or visit www.oracle.com if you need additional information or have any |
19 .\" |
20 ." questions. |
20 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
21 ." |
21 .\" or visit www.oracle.com if you need additional information or have any |
22 .TH idlj 1 "10 May 2011" |
22 .\" questions. |
23 |
23 .\" |
24 .LP |
24 .\" Arch: generic |
25 .SH "Name" |
25 .\" Software: JDK 8 |
26 idlj \- The IDL\-to\-Java Compiler |
26 .\" Date: 21 November 2013 |
27 .LP |
27 .\" SectDesc: Java IDL and RMI-IIOP Tools |
28 \f3idlj\fP generates Java bindings from a given IDL file. |
28 .\" Title: idlj.1 |
29 .SH "Synopsis" |
29 .\" |
30 .LP |
30 .if n .pl 99999 |
31 .nf |
31 .TH idlj 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" |
32 \f3 |
32 .\" ----------------------------------------------------------------- |
33 .fl |
33 .\" * Define some portability stuff |
34 idlj [ \fP\f3options\fP\f3 ] \fP\f4idl\-file\fP\f3 |
34 .\" ----------------------------------------------------------------- |
35 .fl |
35 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
36 \fP |
36 .\" http://bugs.debian.org/507673 |
37 .fi |
37 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
38 |
38 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
39 .LP |
39 .ie \n(.g .ds Aq \(aq |
40 .LP |
40 .el .ds Aq ' |
41 where \f2idl\-file\fP is the name of a file containing Interface Definition Language (IDL) definitions. \f2Options\fP may appear in any order, but must precede the \f2idl\-file\fP. |
41 .\" ----------------------------------------------------------------- |
42 .LP |
42 .\" * set default formatting |
43 .SH "Description" |
43 .\" ----------------------------------------------------------------- |
44 .LP |
44 .\" disable hyphenation |
45 .LP |
45 .nh |
46 The IDL\-to\-Java Compiler generates the Java bindings for a given IDL file.\ For binding details, see the |
46 .\" disable justification (adjust text to left margin only) |
47 .na |
47 .ad l |
48 \f2OMG IDL to Java Language Language Mapping Specification\fP @ |
48 .\" ----------------------------------------------------------------- |
49 .fi |
49 .\" * MAIN CONTENT STARTS HERE * |
50 http://download.oracle.com/javase/7/docs/technotes/guides/idl/mapping/jidlMapping.html. Some previous releases of the IDL\-to\-Java compiler were named \f2idltojava\fP. |
50 .\" ----------------------------------------------------------------- |
51 .LP |
51 |
52 .SS |
52 .SH NAME |
53 Emitting Client and Server Bindings |
53 idlj \- Generates Java bindings for a specified Interface Definition Language (IDL) file\&. |
54 .LP |
54 .SH SYNOPSIS |
55 .LP |
55 .sp |
56 To generate Java bindings for an IDL file named My.idl: |
56 .nf |
57 .LP |
57 |
58 .nf |
58 \fBidlj\fR [ \fIoptions\fR ] \fIidlfile\fR |
59 \f3 |
59 .fi |
60 .fl |
60 .sp |
61 idlj My.idl |
61 .TP |
62 .fl |
62 \fIoptions\fR |
63 \fP |
63 The command-line options\&. See Options\&. Options can appear in any order, but must precede the \f3idlfile\fR\&. |
64 .fi |
64 .TP |
65 |
65 \fIidlfile\fR |
66 .LP |
66 The name of a file that contains Interface Definition Language (IDL) definitions\&. |
67 .LP |
67 .SH DESCRIPTION |
68 This generates the client\-side bindings and is equivalent to: |
68 The IDL-to-Java Compiler generates the Java bindings for a specified IDL file\&. For binding details, see Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html |
69 .LP |
69 .PP |
70 .nf |
70 Some earlier releases of the IDL-to-Java compiler were named \f3idltojava\fR\&. |
71 \f3 |
71 .SS EMIT\ CLIENT\ AND\ SERVER\ BINDINGS |
72 .fl |
72 The following \f3idlj\fR command generates an IDL file named \f3My\&.idl\fR with client-side bindings\&. |
73 idlj \fP\f3\-fclient\fP My.idl |
73 .sp |
74 .fl |
74 .nf |
75 .fi |
75 \f3idlj My\&.idl\fP |
76 |
76 .fi |
77 .LP |
77 .nf |
78 .LP |
78 \f3\fR |
79 The client\-side bindings do not include the server\-side skeleton. If you want to generate the server\-side bindings for the interfaces: |
79 .fi |
80 .LP |
80 .sp |
81 .nf |
81 The previous syntax is equivalent to the following: |
82 \f3 |
82 .sp |
83 .fl |
83 .nf |
84 idlj \fP\f3\-fserver\fP My.idl |
84 \f3idlj \-fclient My\&.idl\fP |
85 .fl |
85 .fi |
86 .fi |
86 .nf |
87 |
87 \f3\fR |
88 .LP |
88 .fi |
89 .LP |
89 .sp |
90 Server\-side bindings include the client\-side bindings plus the skeleton, all of which are \f2POA\fP (that is, Inheritance Model) classes. If you want to generate both client and server\-side bindings, use one of the following (equivalent) commands: |
90 The next example generates the server-side bindings, and includes the client-side bindings plus the skeleton, all of which are POA (Inheritance Model)\&. |
91 .LP |
91 .sp |
92 .nf |
92 .nf |
93 \f3 |
93 \f3idlg \-fserver My\&.idl\fP |
94 .fl |
94 .fi |
95 idlj \fP\f3\-fclient \-fserver\fP My.idl |
95 .nf |
96 .fl |
96 \f3\fR |
97 idlj \f3\-fall\fP My.idl |
97 .fi |
98 .fl |
98 .sp |
99 .fi |
99 If you want to generate both client and server-side bindings, then use one of the following (equivalent) commands: |
100 |
100 .sp |
101 .LP |
101 .nf |
102 .LP |
102 \f3idlj \-fclient \-fserver My\&.idl\fP |
103 There are two possible server\-side models: the Inheritance Model and the Tie Delegation Model. |
103 .fi |
104 .LP |
104 .nf |
105 .LP |
105 \f3idlj \-fall My\&.idl\fP |
106 The default server\-side model is the \f2Portable Servant Inheritance Model\fP. Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2MyPOA.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2MyPOA\fP. |
106 .fi |
107 .LP |
107 .nf |
108 .LP |
108 \f3\fR |
109 \f2MyPOA.java\fP is a stream\-based skeleton that extends |
109 .fi |
110 .na |
110 .sp |
111 \f2org.omg.PortableServer.Servant\fP @ |
111 There are two possible server-side models: the Portal Servant Inheritance Model and the Tie Model\&. See Tie Delegation Model\&. |
112 .fi |
112 .PP |
113 http://download.oracle.com/javase/7/docs/api/org/omg/PortableServer/Servant.html and implements the \f2InvokeHandler\fP interface and the operations interface associated with the IDL interface the skeleton implements. |
113 \f3Portable Servant Inheritance Model\fR\&. The default server-side model is the Portable Servant Inheritance Model\&. Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3MyPOA\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3MyPOA\fR class\&. \f3MyPOA\&.java\fR is a stream-based skeleton that extends the \f3org\&.omg\&.PortableServer\&.Servant\fR class at http://docs\&.oracle\&.com/javase/8/docs/api/org/omg/PortableServer/Servant\&.html The \f3My\fR interface implements the \f3callHandler\fR interface and the operations interface associated with the IDL interface the skeleton implements\&.The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. See Portable Object Adapter (POA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/POA\&.html In the Java programming language, the \f3Servant\fR type is mapped to the Java \f3org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&.Another option for the Inheritance Model is to use the \f3-oldImplBase\fR flag to generate server-side bindings that are compatible with releases of the Java programming language before Java SE 1\&.4\&. The -\f3oldImplBase\fR flag is nonstandard, and these APIs are deprecated\&. You would use this flag only for compatibility with existing servers written in Java SE 1\&.3\&. In that case, you would need to modify an existing make file to add the \f3-oldImplBase\fR flag to the \f3idlj\fR compiler\&. Otherwise POA-based server-side mappings are generated\&. To generate server-side bindings that are backward compatible, do the following: |
114 .LP |
114 .sp |
115 .LP |
115 .nf |
116 The \f2PortableServer\fP module for the |
116 \f3idlj \-fclient \-fserver \-oldImplBase My\&.idl\fP |
117 .na |
117 .fi |
118 \f2Portable Object Adapter (POA)\fP @ |
118 .nf |
119 .fi |
119 \f3idlj \-fall \-oldImplBase My\&.idl\fP |
120 http://download.oracle.com/javase/7/docs/technotes/guides/idl/POA.html defines the native \f2Servant\fP type. In the Java programming language, the \f2Servant\fP type is mapped to the Java \f2org.omg.PortableServer.Servant\fP class. It serves as the base class for all POA servant implementations and provides a number of methods that may be invoked by the application programmer, as well as methods which are invoked by the POA itself and may be overridden by the user to control aspects of servant behavior. |
120 .fi |
121 .LP |
121 .nf |
122 .LP |
122 \f3\fR |
123 Another option for the Inheritance Model is to use the \f2\-oldImplBase\fP flag in order to generate server\-side bindings that are compatible with versions of the Java programming language prior to J2SE 1.4. Note that using the \f2\-oldImplBase\fP flag is non\-standard: these APIs are being deprecated. You would use this flag ONLY for compatibility with existing servers written in J2SE 1.3. In that case, you would need to modify an existing MAKEFILE to add the \f2\-oldImplBase\fP flag to the \f2idlj\fP compiler, otherwise POA\-based server\-side mappings will be generated. To generate server\-side bindings that are backwards compatible: |
123 .fi |
124 .LP |
124 .sp |
125 .nf |
125 Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3_MyImplBase\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3_MyImplBase\fR class\&. |
126 \f3 |
126 .PP |
127 .fl |
127 \f3Tie Delegation Model\fR\&. The other server-side model is called the Tie Model\&. This is a delegation model\&. Because it is not possible to generate ties and skeletons at the same time, they must be generated separately\&. The following commands generate the bindings for the Tie Model: |
128 idlj \fP\f3\-fclient \-fserver\fP \f3\-oldImplBase\fP My.idl |
128 .sp |
129 .fl |
129 .nf |
130 idlj \f3\-fall\fP \f3\-oldImplBase\fP My.idl |
130 \f3idlj \-fall My\&.idl\fP |
131 .fl |
131 .fi |
132 .fi |
132 .nf |
133 |
133 \f3idlj \-fallTIE My\&.idl\fP |
134 .LP |
134 .fi |
135 .LP |
135 .nf |
136 Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2_MyImplBase.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2_MyImplBase\fP. |
136 \f3\fR |
137 .LP |
137 .fi |
138 .LP |
138 .sp |
139 The other server\-side model is called the Tie Model. This is a delegation model. Because it is not possible to generate ties and skeletons at the same time, they must be generated separately. The following commands generate the bindings for the Tie Model: |
139 For the \f3My\fR interface, the second command generates \f3MyPOATie\&.java\fR\&. The constructor to the \f3MyPOATie\fR class takes a delegate\&. In this example, using the default POA model, the constructor also needs a POA\&. You must provide the implementation for the delegate, but it does not have to inherit from any other class, only the interface \f3MyOperations\fR\&. To use it with the ORB, you must wrap your implementation within the \f3MyPOATie\fR class, for example: |
140 .LP |
140 .sp |
141 .nf |
141 .nf |
142 \f3 |
142 \f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP |
143 .fl |
143 .fi |
144 idlj \fP\f3\-fall\fP My.idl |
144 .nf |
145 .fl |
145 \f3\fR |
146 idlj \f3\-fallTIE\fP My.idl |
146 .fi |
147 .fl |
147 .nf |
148 .fi |
148 \f3// Get reference to rootpoa & activate the POAManager\fP |
149 |
149 .fi |
150 .LP |
150 .nf |
151 .LP |
151 \f3POA rootpoa = (POA)orb\&.resolve_initial_references("RootPOA");\fP |
152 For the interface \f2My\fP, the second command generates \f2MyPOATie.java\fP. The constructor to \f2MyPOATie\fP takes a \f2delegate\fP. In this example, using the default POA model, the constructor also needs a \f2poa\fP. You must provide the implementation for \f2delegate\fP, but it does not have to inherit from any other class, only the interface \f2MyOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2MyPOATie\fP. For instance: |
152 .fi |
153 .LP |
153 .nf |
154 .nf |
154 \f3rootpoa\&.the_POAManager()\&.activate();\fP |
155 \f3 |
155 .fi |
156 .fl |
156 .nf |
157 ORB orb = ORB.init(args, System.getProperties()); |
157 \f3\fR |
158 .fl |
158 .fi |
159 |
159 .nf |
160 .fl |
160 \f3// create servant and register it with the ORB\fP |
161 // Get reference to rootpoa & activate the POAManager |
161 .fi |
162 .fl |
162 .nf |
163 POA rootpoa = (POA)orb.resolve_initial_references("RootPOA"); |
163 \f3MyServant myDelegate = new MyServant();\fP |
164 .fl |
164 .fi |
165 rootpoa.the_POAManager().activate(); |
165 .nf |
166 .fl |
166 \f3myDelegate\&.setORB(orb); \fP |
167 |
167 .fi |
168 .fl |
168 .nf |
169 // create servant and register it with the ORB |
169 \f3\fR |
170 .fl |
170 .fi |
171 MyServant myDelegate = new MyServant(); |
171 .nf |
172 .fl |
172 \f3// create a tie, with servant being the delegate\&.\fP |
173 myDelegate.setORB(orb); |
173 .fi |
174 .fl |
174 .nf |
175 |
175 \f3MyPOATie tie = new MyPOATie(myDelegate, rootpoa);\fP |
176 .fl |
176 .fi |
177 // create a tie, with servant being the delegate. |
177 .nf |
178 .fl |
178 \f3\fR |
179 MyPOATie tie = new MyPOATie(myDelegate, rootpoa); |
179 .fi |
180 .fl |
180 .nf |
181 |
181 \f3// obtain the objectRef for the tie\fP |
182 .fl |
182 .fi |
183 // obtain the objectRef for the tie |
183 .nf |
184 .fl |
184 \f3My ref = tie\&._this(orb);\fP |
185 My ref = tie._this(orb); |
185 .fi |
186 .fl |
186 .nf |
187 \fP |
187 \f3\fR |
188 .fi |
188 .fi |
189 |
189 .sp |
190 .LP |
190 You might want to use the Tie model instead of the typical Inheritance model when your implementation must inherit from some other implementation\&. Java allows any number of interface inheritance, but there is only one slot for class inheritance\&. If you use the inheritance model, then that slot is used up\&. With the Tie Model, that slot is freed up for your own use\&. The drawback is that it introduces a level of indirection: one extra method call occurs when a method is called\&. |
191 .LP |
191 .PP |
192 You might want to use the Tie model instead of the typical Inheritance model if your implementation must inherit from some other implementation. Java allows any number of interface inheritance, but there is only one slot for class inheritance. If you use the inheritance model, that slot is used up . By using the Tie Model, that slot is freed up for your own use. The drawback is that it introduces a level of indirection: one extra method call occurs when invoking a method. |
192 For server-side generation, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions earlier than Java SE 1\&.4\&. |
193 .LP |
193 .sp |
194 .LP |
194 .nf |
195 To generate server\-side, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions prior to J2SE 1.4. |
195 \f3idlj \-oldImplBase \-fall My\&.idl\fP |
196 .LP |
196 .fi |
197 .nf |
197 .nf |
198 \f3 |
198 \f3idlj \-oldImplBase \-fallTIE My\&.idl\fP |
199 .fl |
199 .fi |
200 idlj \fP\f3\-oldImplBase\fP \f3\-fall\fP My.idl |
200 .nf |
201 .fl |
201 \f3\fR |
202 idlj \f3\-oldImplBase\fP \f3\-fallTIE\fP My.idl |
202 .fi |
203 .fl |
203 .sp |
204 .fi |
204 For the \f3My\fR interface, the this generates \f3My_Tie\&.java\fR\&. The constructor to the \f3My_Tie\fR class takes an \f3impl\fR object\&. You must provide the implementation for \f3impl\fR, but it does not have to inherit from any other class, only the interface \f3HelloOperations\fR\&. But to use it with the ORB, you must wrap your implementation within \f3My_Tie\fR, for example: |
205 |
205 .sp |
206 .LP |
206 .nf |
207 .LP |
207 \f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP |
208 For the interface \f2My\fP, this will generate \f2My_Tie.java\fP. The constructor to \f2My_Tie\fP takes a \f2impl\fP. You must provide the implementation for \f2impl\fP, but it does not have to inherit from any other class, only the interface \f2HelloOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2My_Tie\fP. For instance: |
208 .fi |
209 .LP |
209 .nf |
210 .nf |
210 \f3\fR |
211 \f3 |
211 .fi |
212 .fl |
212 .nf |
213 ORB orb = ORB.init(args, System.getProperties()); |
213 \f3// create servant and register it with the ORB\fP |
214 .fl |
214 .fi |
215 |
215 .nf |
216 .fl |
216 \f3MyServant myDelegate = new MyServant();\fP |
217 // create servant and register it with the ORB |
217 .fi |
218 .fl |
218 .nf |
219 MyServant myDelegate = new MyServant(); |
219 \f3myDelegate\&.setORB(orb); \fP |
220 .fl |
220 .fi |
221 myDelegate.setORB(orb); |
221 .nf |
222 .fl |
222 \f3\fR |
223 |
223 .fi |
224 .fl |
224 .nf |
225 // create a tie, with servant being the delegate. |
225 \f3// create a tie, with servant being the delegate\&.\fP |
226 .fl |
226 .fi |
227 MyPOATie tie = new MyPOATie(myDelegate); |
227 .nf |
228 .fl |
228 \f3MyPOATie tie = new MyPOATie(myDelegate);\fP |
229 |
229 .fi |
230 .fl |
230 .nf |
231 // obtain the objectRef for the tie |
231 \f3\fR |
232 .fl |
232 .fi |
233 My ref = tie._this(orb); |
233 .nf |
234 .fl |
234 \f3// obtain the objectRef for the tie\fP |
235 \fP |
235 .fi |
236 .fi |
236 .nf |
237 |
237 \f3My ref = tie\&._this(orb);\fP |
238 .LP |
238 .fi |
239 .SS |
239 .nf |
240 Specifying Alternate Locations for Emitted Files |
240 \f3\fR |
241 .LP |
241 .fi |
242 .LP |
242 .sp |
243 If you want to direct the emitted files to a directory other than the current directory, invoke the compiler as: |
243 .SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ EMITTED\ FILES |
244 .LP |
244 If you want to direct the emitted files to a directory other than the current directory, then call the compiler this way: \f3i\fR\f3dlj -td /altdir My\&.idl\fR\&. |
245 .nf |
245 .PP |
246 \f3 |
246 For the \f3My\fR interface, the bindings are emitted to \f3/altdir/My\&.java\fR, etc\&., instead of \f3\&./My\&.java\fR\&. |
247 .fl |
247 .SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ INCLUDE\ FILES |
248 idlj \fP\f3\-td /altdir\fP My.idl |
248 If the \f3My\&.idl\fR file includes another \f3idl\fR file, \f3MyOther\&.idl\fR, then the compiler assumes that the \f3MyOther\&.idl\fR file resides in the local directory\&. If it resides in \f3/includes\fR, for example, then you call the compiler with the following command: |
249 .fl |
249 .sp |
250 .fi |
250 .nf |
251 |
251 \f3idlj \-i /includes My\&.idl\fP |
252 .LP |
252 .fi |
253 .LP |
253 .nf |
254 For the interface \f2My\fP, the bindings will be emitted to \f2/altdir/My.java\fP, etc., instead of \f2./My.java\fP. |
254 \f3\fR |
255 .LP |
255 .fi |
256 .SS |
256 .sp |
257 Specifying Alternate Locations for Include Files |
257 If \f3My\&.idl\fR also included \f3Another\&.idl\fR that resided in \f3/moreIncludes\fR, for example, then you call the compiler with the following command: |
258 .LP |
258 .sp |
259 .LP |
259 .nf |
260 If \f2My.idl\fP included another idl file, \f2MyOther.idl\fP, the compiler assumes that \f2MyOther.idl\fP resides in the local directory. If it resides in \f2/includes\fP, for example, then you would invoke the compiler with the following command: |
260 \f3idlj \-i /includes \-i /moreIncludes My\&.idl\fP |
261 .LP |
261 .fi |
262 .nf |
262 .nf |
263 \f3 |
263 \f3\fR |
264 .fl |
264 .fi |
265 idlj \fP\f3\-i /includes\fP My.idl |
265 .sp |
266 .fl |
266 Because this form of \f3include\fR can become long, another way to indicate to the compiler where to search for included files is provided\&. This technique is similar to the idea of an environment variable\&. Create a file named idl\&.config in a directory that is listed in your \f3CLASSPATH\fR variable\&. Inside of \f3idl\&.config\fR, provide a line with the following form: |
267 .fi |
267 .sp |
268 |
268 .nf |
269 .LP |
269 \f3includes=/includes;/moreIncludes\fP |
270 .LP |
270 .fi |
271 If \f2My.idl\fP also included \f2Another.idl\fP that resided in \f2/moreIncludes\fP, for example, then you would invoke the compiler with the following command: |
271 .nf |
272 .LP |
272 \f3\fR |
273 .nf |
273 .fi |
274 \f3 |
274 .sp |
275 .fl |
275 The compiler will find this file and read in the includes list\&. Note that in this example the separator character between the two directories is a semicolon (;)\&. This separator character is platform dependent\&. On the Windows platform, use a semicolon, on the Unix platform, use a colon, and so on\&. |
276 idlj \fP\f3\-i /includes \-i /moreIncludes\fP My.idl |
276 .SS EMIT\ BINDINGS\ FOR\ INCLUDE\ FILES |
277 .fl |
277 By default, only those interfaces, structures, and so on, that are defined in the \f3idl\fR file on the command line have Java bindings generated for them\&. The types defined in included files are not generated\&. For example, assume the following two \f3idl\fR files: |
278 .fi |
278 .sp |
279 |
279 .nf |
280 .LP |
280 \f3My\&.idl file:\fP |
281 .LP |
281 .fi |
282 Since this form of include can become irritatingly long, another means of indicating to the compiler where to search for included files is provided. This technique is similar to the idea of an environment variable. Create a file named \f2idl.config\fP in a directory that is listed in your CLASSPATH. Inside of \f2idl.config\fP, provide a line with the following form: |
282 .nf |
283 .LP |
283 \f3\fR |
284 .nf |
284 .fi |
285 \f3 |
285 .nf |
286 .fl |
286 \f3#include <MyOther\&.idl>\fP |
287 includes=/includes;/moreIncludes |
287 .fi |
288 .fl |
288 .nf |
289 \fP |
289 \f3interface My\fP |
290 .fi |
290 .fi |
291 |
291 .nf |
292 .LP |
292 \f3{\fP |
293 .LP |
293 .fi |
294 The compiler will find this file and read in the includes list. Note that in this example the separator character between the two directories is a semicolon (;). This separator character is platform dependent. On the Windows platform, use a semicolon, on the Unix platform, use a colon, etc. For more information on \f2includes\fP, see the |
294 .nf |
295 .na |
295 \f3};\fP |
296 \f2Setting the Classpath\fP @ |
296 .fi |
297 .fi |
297 .nf |
298 http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general. |
298 \f3\fR |
299 .LP |
299 .fi |
300 .SS |
300 .nf |
301 Emitting Bindings for Include Files |
301 \f3MyOther\&.idl file:\fP |
302 .LP |
302 .fi |
303 .LP |
303 .nf |
304 By default, only those interfaces, structs, etc, that are defined in the idl file on the command line have Java bindings generated for them. The types defined in included files are not generated. For example, assume the following two idl files: |
304 \f3\fR |
305 .LP |
305 .fi |
306 |
306 .nf |
307 .LP |
307 \f3interface MyOther\fP |
308 .LP |
308 .fi |
309 \f4My.idl\fP |
309 .nf |
310 .LP |
310 \f3{\fP |
311 .nf |
311 .fi |
312 \f3 |
312 .nf |
313 .fl |
313 \f3};\fP |
314 #include <MyOther.idl> |
314 .fi |
315 .fl |
315 .nf |
316 interface My |
316 \f3\fR |
317 .fl |
317 .fi |
318 { |
318 .sp |
319 .fl |
319 There is a caveat to the default rule\&. Any \f3#include\fR statements that appear at the global scope are treated as described\&. These \f3#include\fR statements can be thought of as import statements\&. The \f3#include\fR statements that appear within an enclosed scope are treated as true \f3#include\fR statements, which means that the code within the included file is treated as though it appeared in the original file and, therefore, Java bindings are emitted for it\&. Here is an example: |
320 }; |
320 .sp |
321 .fl |
321 .nf |
322 \fP |
322 \f3My\&.idl file:\fP |
323 .fi |
323 .fi |
324 |
324 .nf |
325 .LP |
325 \f3\fR |
326 |
326 .fi |
327 .LP |
327 .nf |
328 .LP |
328 \f3#include <MyOther\&.idl>\fP |
329 \f4MyOther.idl\fP |
329 .fi |
330 .LP |
330 .nf |
331 .nf |
331 \f3interface My\fP |
332 \f3 |
332 .fi |
333 .fl |
333 .nf |
334 interface MyOther |
334 \f3{\fP |
335 .fl |
335 .fi |
336 { |
336 .nf |
337 .fl |
337 \f3 #include <Embedded\&.idl>\fP |
338 }; |
338 .fi |
339 .fl |
339 .nf |
340 \fP |
340 \f3};\fP |
341 .fi |
341 .fi |
342 |
342 .nf |
343 .LP |
343 \f3\fR |
344 |
344 .fi |
345 .LP |
345 .nf |
346 .LP |
346 \f3MyOther\&.idl file:\fP |
347 The following command will only generate the java bindings for \f2My\fP: |
347 .fi |
348 .LP |
348 .nf |
349 .nf |
349 \f3\fR |
350 \f3 |
350 .fi |
351 .fl |
351 .nf |
352 idlj My.idl |
352 \f3interface MyOther\fP |
353 .fl |
353 .fi |
354 \fP |
354 .nf |
355 .fi |
355 \f3{\fP |
356 |
356 .fi |
357 .LP |
357 .nf |
358 .LP |
358 \f3};\fP |
359 To generate all of the types in \f2My.idl\fP and all of the types in the files that \f2My.idl\fP includes (in this example, \f2MyOther.idl\fP), use the following command: |
359 .fi |
360 .LP |
360 .nf |
361 .nf |
361 \f3\fR |
362 \f3 |
362 .fi |
363 .fl |
363 .nf |
364 idlj \fP\f3\-emitAll\fP My.idl |
364 \f3Embedded\&.idl\fP |
365 .fl |
365 .fi |
366 .fi |
366 .nf |
367 |
367 \f3\fR |
368 .LP |
368 .fi |
369 .LP |
369 .nf |
370 There is a caveat to the default rule. \f2#include\fP statements which appear at global scope are treated as described. These \f2#include\fP statements can be thought of as import statements. \f2#include\fP statements which appear within some enclosing scope are treated as true \f2#include\fP statements, meaning that the code within the included file is treated as if it appeared in the original file and, therefore, Java bindings are emitted for it. Here is an example: |
370 \f3enum E {one, two, three};\fP |
371 .LP |
371 .fi |
372 |
372 .nf |
373 .LP |
373 \f3\fR |
374 .LP |
374 .fi |
375 \f4My.idl\fP |
375 .sp |
376 .LP |
376 Run\f3idlj My\&.idl\fRto generate the following list of Java files\&. Notice that \f3MyOther\&.java\fR is not generated because it is defined in an import-like \f3#include\fR\&. But \f3E\&.java\fR was generated because it was defined in a true \f3#include\fR\&. Notice that because the \f3Embedded\&.idl\fR file is included within the scope of the interface \f3My\fR, it appears within the scope of \f3My\fR (in \f3MyPackage\fR)\&. If the \f3-emitAll\fR flag had been used, then all types in all included files would have been emitted\&. |
377 .nf |
377 .sp |
378 \f3 |
378 .nf |
379 .fl |
379 \f3\&./MyHolder\&.java\fP |
380 #include <MyOther.idl> |
380 .fi |
381 .fl |
381 .nf |
382 interface My |
382 \f3\&./MyHelper\&.java\fP |
383 .fl |
383 .fi |
384 { |
384 .nf |
385 .fl |
385 \f3\&./_MyStub\&.java\fP |
386 #include <Embedded.idl> |
386 .fi |
387 .fl |
387 .nf |
388 }; |
388 \f3\&./MyPackage\fP |
389 .fl |
389 .fi |
390 \fP |
390 .nf |
391 .fi |
391 \f3\&./MyPackage/EHolder\&.java\fP |
392 |
392 .fi |
393 .LP |
393 .nf |
394 |
394 \f3\&./MyPackage/EHelper\&.java\fP |
395 .LP |
395 .fi |
396 .LP |
396 .nf |
397 \f4MyOther.idl\fP |
397 \f3\&./MyPackage/E\&.java\fP |
398 .LP |
398 .fi |
399 .nf |
399 .nf |
400 \f3 |
400 \f3\&./My\&.java\fP |
401 .fl |
401 .fi |
402 interface MyOther |
402 .nf |
403 .fl |
403 \f3\fR |
404 { |
404 .fi |
405 .fl |
405 .sp |
406 }; |
406 .SS INSERT\ PACKAGE\ PREFIXES |
407 .fl |
|
408 \fP |
|
409 .fi |
|
410 |
|
411 .LP |
|
412 |
|
413 .LP |
|
414 .LP |
|
415 \f4Embedded.idl\fP |
|
416 .LP |
|
417 .nf |
|
418 \f3 |
|
419 .fl |
|
420 enum E {one, two, three}; |
|
421 .fl |
|
422 \fP |
|
423 .fi |
|
424 |
|
425 .LP |
|
426 |
|
427 .LP |
|
428 .LP |
|
429 Running the following command: |
|
430 .LP |
|
431 .nf |
|
432 \f3 |
|
433 .fl |
|
434 idlj My.idl |
|
435 .fl |
|
436 \fP |
|
437 .fi |
|
438 |
|
439 .LP |
|
440 .LP |
|
441 will generate the following list of Java files: |
|
442 .LP |
|
443 .nf |
|
444 \f3 |
|
445 .fl |
|
446 ./MyHolder.java |
|
447 .fl |
|
448 ./MyHelper.java |
|
449 .fl |
|
450 ./_MyStub.java |
|
451 .fl |
|
452 ./MyPackage |
|
453 .fl |
|
454 ./MyPackage/EHolder.java |
|
455 .fl |
|
456 ./MyPackage/EHelper.java |
|
457 .fl |
|
458 ./MyPackage/E.java |
|
459 .fl |
|
460 ./My.java |
|
461 .fl |
|
462 \fP |
|
463 .fi |
|
464 |
|
465 .LP |
|
466 .LP |
|
467 Notice that \f2MyOther.java\fP was not generated because it is defined in an import\-like \f2#include\fP. But \f2E.java\fP \f2was\fP generated because it was defined in a true \f2#include\fP. Also notice that since \f2Embedded.idl\fP was included within the scope of the interface \f2My\fP, it appears within the scope of \f2My\fP (that is,in \f2MyPackage\fP). |
|
468 .LP |
|
469 .LP |
|
470 If the \f2\-emitAll\fP flag had been used in the previous example, then all types in all included files would be emitted. |
|
471 .LP |
|
472 .SS |
|
473 Inserting Package Prefixes |
|
474 .LP |
|
475 .LP |
|
476 Suppose that you work for a company named ABC that has constructed the following IDL file: |
407 Suppose that you work for a company named ABC that has constructed the following IDL file: |
477 .LP |
408 .sp |
478 |
409 .nf |
479 .LP |
410 \f3Widgets\&.idl file:\fP |
480 .LP |
411 .fi |
481 \f4Widgets.idl\fP |
412 .nf |
482 .LP |
413 \f3\fR |
483 .nf |
414 .fi |
484 \f3 |
415 .nf |
485 .fl |
416 \f3module Widgets\fP |
486 module Widgets |
417 .fi |
487 .fl |
418 .nf |
488 { |
419 \f3{\fP |
489 .fl |
420 .fi |
490 interface W1 {...}; |
421 .nf |
491 .fl |
422 \f3 interface W1 {\&.\&.\&.};\fP |
492 interface W2 {...}; |
423 .fi |
493 .fl |
424 .nf |
494 }; |
425 \f3 interface W2 {\&.\&.\&.};\fP |
495 .fl |
426 .fi |
496 \fP |
427 .nf |
497 .fi |
428 \f3};\fP |
498 |
429 .fi |
499 .LP |
430 .nf |
500 |
431 \f3\fR |
501 .LP |
432 .fi |
502 .LP |
433 .sp |
503 Running this file through the IDL\-to\-Java compiler will place the Java bindings for \f2W1\fP and \f2W2\fP within the package \f2Widgets\fP. But there is an industry convention that states that a company's packages should reside within a package named \f2com.<company name>\fP. The \f2Widgets\fP package is not good enough. To follow convention, it should be \f2com.abc.Widgets\fP. To place this package prefix onto the \f2Widgets\fP module, execute the following: |
434 If you run this file through the IDL-to-Java compiler, then the Java bindings for W1 and W2 are placed within the \f3Widgets\fR package\&. There is an industry convention that states that a company\&'s packages should reside within a package named \f3com\&.<company name>\fR\&. To follow this convention, the package name should be \f3com\&.abc\&.Widgets\fR\&. To place this package prefix onto the Widgets module, execute the following: |
504 .LP |
435 .sp |
505 .nf |
436 .nf |
506 \f3 |
437 \f3idlj \-pkgPrefix Widgets com\&.abc Widgets\&.idl\fP |
507 .fl |
438 .fi |
508 idlj \fP\f3\-pkgPrefix Widgets com.abc\fP Widgets.idl |
439 .nf |
509 .fl |
440 \f3\fR |
510 .fi |
441 .fi |
511 |
442 .sp |
512 .LP |
443 If you have an IDL file that includes Widgets\&.idl, then the \f3-pkgPrefix\fR flag must appear in that command also\&. If it does not, then your IDL file will be looking for a \f3Widgets\fR package rather than a \f3com\&.abc\&.Widgets\fR package\&. |
513 .LP |
444 .PP |
514 If you have an IDL file which includes \f2Widgets.idl\fP, the \f2\-pkgPrefix\fP flag must appear in that command also. If it does not, then your IDL file will be looking for a \f2Widgets\fP package rather than a \f2com.abc.Widgets\fP package. |
445 If you have a number of these packages that require prefixes, then it might be easier to place them into the idl\&.config file described previously\&. Each package prefix line should be of the form: \f3PkgPrefix\&.<type>=<prefix>\fR\&. The line for the previous example would be \f3PkgPrefix\&.Widgets=com\&.abc\fR\&. This option does not affect the Repository ID\&. |
515 .LP |
446 .SS DEFINE\ SYMBOLS\ BEFORE\ COMPILATION |
516 .LP |
447 You might need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings\&. The command \f3idlj -d MYDEF My\&.idl\fRis equivalent to putting the line \f3#define MYDEF\fR inside My\&.idl\&. |
517 If you have a number of these packages that require prefixes, it might be easier to place them into the \f2idl.config\fP file described above. Each package prefix line should be of the form: |
448 .SS PRESERVE\ PREEXISTING\ BINDINGS |
518 .LP |
449 If the Java binding files already exist, then the \f3-keep\fR flag keeps the compiler from overwriting them\&. The default is to generate all files without considering that they already exist\&. If you have customized those files (which you should not do unless you are very comfortable with their contents), then the \f3-keep\fR option is very useful\&. The command \f3idlj -keep My\&.idl\fR emits all client-side bindings that do not already exist\&. |
519 .nf |
450 .SS VIEW\ COMPILATION\ PROGRESS |
520 \f3 |
451 The IDL-to-Java compiler generates status messages as it progresses through its phases of execution\&. Use the \f3-v\fR option to activate the verbose mode: \f3idlj -v My\&.idl\fR\&. |
521 .fl |
452 .PP |
522 PkgPrefix.<type>=<prefix> |
453 By default the compiler does not operate in verbose mode |
523 .fl |
454 .SS DISPLAY\ VERSION\ INFORMATION |
524 \fP |
455 To display the build version of the IDL-to-Java compiler, specify the \f3-version\fR option on the command-line: \f3idlj -version\fR\&. |
525 .fi |
456 .PP |
526 |
457 Version information also appears within the bindings generated by the compiler\&. Any additional options appearing on the command-line are ignored\&. |
527 .LP |
458 .SH OPTIONS |
528 So the line for the above example would be: |
459 .TP |
529 .nf |
460 -d \fIsymbol\fR |
530 \f3 |
461 .br |
531 .fl |
|
532 PkgPrefix.Widgets=com.abc |
|
533 .fl |
|
534 \fP |
|
535 .fi |
|
536 |
|
537 .LP |
|
538 .LP |
|
539 The use of this option does not affect the Repository ID. |
|
540 .LP |
|
541 .SS |
|
542 Defining Symbols Before Compilation |
|
543 .LP |
|
544 .LP |
|
545 You may need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings. The command |
|
546 .LP |
|
547 .nf |
|
548 \f3 |
|
549 .fl |
|
550 idlj \fP\f3\-d\fP MYDEF My.idl |
|
551 .fl |
|
552 .fi |
|
553 |
|
554 .LP |
|
555 .LP |
|
556 is the equivalent of putting the line \f2#define MYDEF\fP inside \f2My.idl\fP. |
|
557 .LP |
|
558 .SS |
|
559 Preserving Pre\-Existing Bindings |
|
560 .LP |
|
561 .LP |
|
562 If the Java binding files already exist, the \f2\-keep\fP flag will keep the compiler from overwriting them. The default is to generate all files without considering if they already exist. If you've customized those files (which you should not do unless you are very comfortable with their contents), then the \f2\-keep\fP option is very useful. The command |
|
563 .LP |
|
564 .nf |
|
565 \f3 |
|
566 .fl |
|
567 idlj \fP\f3\-keep\fP My.idl |
|
568 .fl |
|
569 .fi |
|
570 |
|
571 .LP |
|
572 .LP |
|
573 emits all client\-side bindings that do not already exist. |
|
574 .LP |
|
575 .SS |
|
576 Viewing Progress of Compilation |
|
577 .LP |
|
578 .LP |
|
579 The IDL\-to\-Java compiler will generate status messages as it progresses through its phases of execution. Use the \f2\-v\fP option to activate this "verbose" mode: |
|
580 .LP |
|
581 .nf |
|
582 \f3 |
|
583 .fl |
|
584 idlj \fP\f3\-v\fP My.idl |
|
585 .fl |
|
586 .fi |
|
587 |
|
588 .LP |
|
589 .LP |
|
590 By default the compiler does not operate in verbose mode. |
|
591 .LP |
|
592 .SS |
|
593 Displaying Version Information |
|
594 .LP |
|
595 .LP |
|
596 To display the build version of the IDL\-to\-Java compiler, specify the \f2\-version\fP option on the command\-line: |
|
597 .LP |
|
598 .nf |
|
599 \f3 |
|
600 .fl |
|
601 idlj \-version |
|
602 .fl |
|
603 \fP |
|
604 .fi |
|
605 |
|
606 .LP |
|
607 .LP |
|
608 Version information also appears within the bindings generated by the compiler. Any additional options appearing on the command\-line are ignored. |
|
609 .LP |
|
610 .SH "Options" |
|
611 .LP |
|
612 .RS 3 |
|
613 .TP 3 |
|
614 \-d symbol |
|
615 This is equivalent to the following line in an IDL file: |
462 This is equivalent to the following line in an IDL file: |
616 .nf |
463 .sp |
617 \f3 |
464 .nf |
618 .fl |
465 \f3#define \fIsymbol\fR\fP |
619 #define \fP\f4symbol\fP\f3 |
466 .fi |
620 .fl |
467 .nf |
621 \fP |
468 \f3\fR |
622 .fi |
469 .fi |
623 .TP 3 |
470 .sp |
624 \-emitAll |
471 |
625 Emit all types, including those found in \f2#include\fP files. |
472 .TP |
626 .TP 3 |
473 -demitAll |
627 \-fside |
474 .br |
628 Defines what bindings to emit. \f2side\fP is one of \f2client\fP, \f2server\fP, \f2serverTIE\fP, \f2all\fP, or \f2allTIE\fP. The \f2\-fserverTIE\fP and \f2\-fallTIE\fP options cause delegate model skeletons to be emitted. Assumes \f2\-fclient\fP if the flag is not specified. |
475 Emit all types, including those found in \f3#include\fR files\&. |
629 .TP 3 |
476 .TP |
630 \-i include\-path |
477 -fside |
631 By default, the current directory is scanned for included files. This option adds another directory. |
478 .br |
632 .TP 3 |
479 Defines what bindings to emit\&. The \f3side\fR parameter can be \f3client\fR, \f3server\fR, \f3serverTIE\fR, \f3all\fR, or \f3allTIE\fR\&. The \f3-fserverTIE\fR and \f3-fallTIE\fR options cause delegate model skeletons to be emitted\&. Defaults to \f3-fclient\fR when the flag is not specified\&. |
633 \-keep |
480 .TP |
634 If a file to be generated already exists, do not overwrite it. By default it is overwritten. |
481 -i \fIinclude-path\fR |
635 .TP 3 |
482 .br |
636 \-noWarn |
483 By default, the current directory is scanned for included files\&. This option adds another directory\&. |
637 Suppresses warning messages. |
484 .TP |
638 .TP 3 |
485 -i \fIkeep\fR |
639 \-oldImplBase |
486 .br |
640 Generates skeletons compatible with pre\-1.4 JDK ORBs. By default, the POA Inheritance Model server\-side bindings are generated. This option provides backward\-compatibility with older versions of the Java programming language by generating server\-side bindings that are \f2ImplBase\fP Inheritance Model classes. |
487 If a file to be generated already exists, then do not overwrite it\&. By default it is overwritten\&. |
641 .TP 3 |
488 .TP |
642 \-pkgPrefix type prefix |
489 -noWarn |
643 Wherever \f2type\fP is encountered at file scope, prefix the generated Java package name with \f2prefix\fP for all files generated for that type. The \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module. |
490 .br |
644 .TP 3 |
491 Suppress warning messages\&. |
645 \-pkgTranslate type package |
492 .TP |
646 Whenever the module name \f2type\fP is encountered in an identifier, replace it in the identifier with \f2package\fP for all files in the generated Java package. Note that \f2pkgPrefix\fP changes are made first. \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module, and must match the full package name exactly. |
493 -oldImplBase |
647 .br |
494 .br |
648 .br |
495 Generates skeletons compatible with pre-1\&.4 JDK ORBs\&. By default, the POA Inheritance Model server-side bindings are generated\&. This option provides backward-compatibility with earlier releases of the Java programming language by generating server-side bindings that are \f3ImplBase\fR Inheritance Model classes\&. |
649 If more than one translation matches an identifier, the longest match is chosen. For example, if the arguments include: |
496 .TP |
650 .nf |
497 -pkgPrefix \fItype\fR\fIprefix\fR |
651 \f3 |
498 .br |
652 .fl |
499 Wherever \f3type\fR is encountered at file scope, prefix the generated Java package name with \f3prefix\fR for all files generated for that type\&. The type is the simple name of either a top-level module, or an IDL type defined outside of any module\&. |
653 \-pkgTranslate foo bar \-pkgTranslate foo.baz buzz.fizz |
500 .TP |
654 .fl |
501 -pkgTranslate \fItype\fR\fIpackage\fR |
655 \fP |
502 .br |
656 .fi |
503 Whenever the module name type is encountered in an identifier, replace it in the identifier with package for all files in the generated Java package\&. Note that \f3pkgPrefix\fR changes are made first\&. The type value is the simple name of either a top-level module, or an IDL type defined outside of any module and must match the full package name exactly\&. |
657 The following translations would occur: |
504 |
658 .nf |
505 If more than one translation matches an identifier, then the longest match is chosen as shown in the following example: |
659 \f3 |
506 |
660 .fl |
507 \fICommand\fR: |
661 foo => bar |
508 .sp |
662 .fl |
509 .nf |
663 foo.boo => bar.boo |
510 \f3pkgTranslate type pkg \-pkgTranslate type2\&.baz pkg2\&.fizz\fP |
664 .fl |
511 .fi |
665 foo.baz => buzz.fizz |
512 .nf |
666 .fl |
513 \f3\fR |
667 foo.baz.bar => buzz.fizz.bar |
514 .fi |
668 .fl |
515 .sp |
669 \fP |
516 |
670 .fi |
517 |
671 The following package names cannot be translated: |
518 \fIResulting Translation\fR: |
672 .RS 3 |
519 .sp |
673 .TP 2 |
520 .nf |
674 o |
521 \f3type => pkg\fP |
675 \f2org\fP |
522 .fi |
676 .TP 2 |
523 .nf |
677 o |
524 \f3type\&.ext => pkg\&.ext\fP |
678 \f2org.omg\fP or any subpackages of \f2org.omg\fP |
525 .fi |
|
526 .nf |
|
527 \f3type\&.baz => pkg2\&.fizz\fP |
|
528 .fi |
|
529 .nf |
|
530 \f3type2\&.baz\&.pkg => pkg2\&.fizz\&.pkg\fP |
|
531 .fi |
|
532 .nf |
|
533 \f3\fR |
|
534 .fi |
|
535 .sp |
|
536 |
|
537 |
|
538 The following package names \f3org\fR, \f3org\fR\&.o\f3mg\fR, or any subpackages of \f3org\&.omg\fR cannot be translated\&. Any attempt to translate these packages results in uncompilable code, and the use of these packages as the first argument after \f3-pkgTranslate\fR is treated as an error\&. |
|
539 .TP |
|
540 -skeletonName \fIxxx%yyy\fR |
|
541 .br |
|
542 Use \f3xxx%yyy\fR as the pattern for naming the skeleton\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserver\fR or \f3-fall\fR), and \f3_%ImplBase\fR for the \f3oldImplBase\fR class (-\f3oldImplBase\fR) and (\f3-fserver\fR or \f3-fall\fR))\&. |
|
543 .TP |
|
544 -td \fIdir\fR |
|
545 .br |
|
546 Use \fIdir\fR for the output directory instead of the current directory\&. |
|
547 .TP |
|
548 -tieName \fIxxx%yyy\fR |
|
549 .br |
|
550 Use \f3xxx%yyy\fR according to the pattern\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserverTie or -fallTie\fR), and \f3_%Tie\fR for the \f3oldImplBase\fR tie class (-\f3oldImplBase\fR) and (\f3-fserverTie\fR or \f3-fallTie\fR)) |
|
551 .TP |
|
552 -nowarn, -verbose |
|
553 .br |
|
554 Displays release information and terminates\&. |
|
555 .TP |
|
556 -version |
|
557 .br |
|
558 Displays release information and terminates\&. |
|
559 .SH RESTRICTIONS |
|
560 Escaped identifiers in the global scope cannot have the same spelling as IDL primitive types, \f3Object\fR, or \f3ValueBase\fR\&. This is because the symbol table is preloaded with these identifiers\&. Allowing them to be redefined would overwrite their original definitions\&. Possible permanent restriction\&. |
|
561 .PP |
|
562 The \f3fixed\fR IDL type is not supported\&. |
|
563 .SH KNOWN\ PROBLEMS |
|
564 No import is generated for global identifiers\&. If you call an unexported local \f3impl\fR object, then you do get an exception, but it seems to be due to a \f3NullPointerException\fR in the \f3ServerDelegate\fR DSI code\&. |
679 .RE |
565 .RE |
680 Any attempt to translate these packages will result in uncompilable code, and the use of these packages as the first argument after \f2\-pkgTranslate\fP will be treated as an error. |
566 .br |
681 .TP 3 |
567 'pl 8.5i |
682 \-skeletonName xxx%yyy |
568 'bp |
683 Use \f2xxx%yyy\fP as the pattern for naming the skeleton. The defaults are: |
|
684 .RS 3 |
|
685 .TP 2 |
|
686 o |
|
687 %POA for the \f2POA\fP base class (\f2\-fserver\fP or \f2\-fall\fP) |
|
688 .TP 2 |
|
689 o |
|
690 _%ImplBase for the \f2oldImplBase\fP class (\f2\-oldImplBase\fP and (\f2\-fserver\fP or \f2\-fall\fP)) |
|
691 .RE |
|
692 .TP 3 |
|
693 \-td dir |
|
694 Use \f2dir\fP for the output directory instead of the current directory. |
|
695 .TP 3 |
|
696 \-tieName xxx%yyy |
|
697 Name the tie according to the pattern. The defaults are: |
|
698 .RS 3 |
|
699 .TP 2 |
|
700 o |
|
701 %POATie for the \f2POA\fP tie base class (\f2\-fserverTie\fP or \f2\-fallTie\fP) |
|
702 .TP 2 |
|
703 o |
|
704 %_Tie for the \f2oldImplBase\fP tie class (\f2\-oldImplBase\fP and (\f2\-fserverTie\fP or \f2\-fallTie\fP)) |
|
705 .RE |
|
706 .TP 3 |
|
707 \-nowarn, \-verbose |
|
708 Verbose mode. |
|
709 .TP 3 |
|
710 \-version |
|
711 Display version information and terminate. |
|
712 .RE |
|
713 |
|
714 .LP |
|
715 .LP |
|
716 See the Description section for more option information. |
|
717 .LP |
|
718 .SH "Restrictions:" |
|
719 .LP |
|
720 .RS 3 |
|
721 .TP 2 |
|
722 o |
|
723 Escaped identifiers in the global scope may not have the same spelling as IDL primitive types, \f2Object\fP, or \f2ValueBase\fP. This is because the symbol table is pre\-loaded with these identifiers; allowing them to be redefined would overwrite their original definitions. (Possible permanent restriction). |
|
724 .TP 2 |
|
725 o |
|
726 The \f2fixed\fP IDL type is not supported. |
|
727 .RE |
|
728 |
|
729 .LP |
|
730 .SH "Known Problems:" |
|
731 .LP |
|
732 .RS 3 |
|
733 .TP 2 |
|
734 o |
|
735 No import generated for global identifiers. If you invoke on an unexported local impl, you do get an exception, but it seems to be due to a \f2NullPointerException\fP in the \f2ServerDelegate\fP DSI code. |
|
736 .RE |
|
737 |
|
738 .LP |
|
739 |
|