TAO/docs/interfacerepo/tao_ifr.html

   1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   5 <meta name="GENERATOR" content="Mozilla/4.5 [en] (X11; I; SunOS 5.5.1 sun4u) [Netscape]">
   6 <title>tao_ifr User's Guide</title>
   7 <!--  -->
   8 </head>
   9 <body text="#000000" bgcolor="#FFFFFF" link="#0000FF" vlink="#CC0000">
  10
  11 <hr>
  12 <h3>
  13 tao_ifr User's Guide</h3>
  14
  15 <h3> Overview</h3> tao_ifr is TAO's interface repository loader. When executed, it will first resolve the interface repository, either by finding the interface repository's IOR in a file whose name is passed to it through the -ORBInitRef command line option, or by IP multicast (the default). Note - if the -ORBInitRef option is used, it should come first on the command line, since it will be consumed when the ORB is initialized. Then it will create entries in (or remove entries from) the repository corresponding to the declarations found in the IDL file(s) passed to it. If an entry to be removed is not found the repository, nothing happens. As stated elsewhere in the documentation, if an entry to be added is found to already exist in the repository (that is, if the interface repository id is found by lookup), the old entry will be replaced by the new one. It is the user's responsibility to make sure that no entries are unexpectedly replaced in the repository. This is also the method by which interfaces forward declared but not defined in one IDL file are fully defined in another. If the old and new entries are both interfaces, there is no way for tao_ifr to know if this is the intention, or if there is a genuine name clash. The behavior shown by tao_ifr in this case was chosen to conform to the behavior of the interface repository loaders from other ORB vendors.
  16
  17 <P>
  18
  19 <HR><P>
  20
  21 <h3><A NAME="options">tao_ifr Command Line Options</A></h3>
  22
  23 tao_ifr uses the front end of the TAO IDL compiler, which invokes your <tt>C</tt> (or <tt>C++</tt>)
  24 preprocessor to resolve included IDL files.  It receives the common
  25 options for preprocessors (such as <tt>-D</tt> or <tt>-I</tt>).  It
  26 also receives other options that are specific to it<P>
  27
  28 <table BORDER=2 CELLSPACING=2 CELLPADDING=0 >
  29   <tr>
  30     <th>Option</th>
  31     <th>Description</th>
  32     <th>Remark</th>
  33   </tr>
  34   <tr><a NAME="ORBInitRef">
  35     <td><tt>-ORBInitRef InterfaceRepository=
  36             corbaloc:iiop:[hostname]:[port]/InterfaceRepository</tt></td>
  37
  38     <td>Locate the Interface Repository using the <a href="../INS.html">Interoperable Naming Service</a></td>
  39     <td>Without this option, the Interface Repository will be located by multicast.</td>
  40
  41    </tr>
  42    <tr>
  43     <td><tt>-ORBInitRef InterfaceRepository=file://[filename]</tt></td>
  44     <td>Locate the Interface Repository using the IOR from a file.</td>
  45
  46     <td>Without this option, the Interface Repository will be located by multicast.</td>
  47   </tr>
  48   <tr><a NAME="u">
  49     <td><tt>-u</tt></td>
  50
  51     <td>Prints the options given below and exits.</td>
  52     <td>Outputs to stdout by default.</td>
  53   </tr>
  54
  55   <tr> <a NAME="v">
  56     <td><tt>-v</tt></td>
  57
  58     <td>Traces tao_ifr processing stages.</td>
  59     <td>&nbsp;</td>
  60   </tr>
  61
  62   <tr> <a NAME="V">
  63     <td><tt>-V</tt></td>
  64
  65     <td>Prints version information and exits.</td>
  66     <td>&nbsp;</td>
  67   </tr>
  68
  69   <tr><a name="E">
  70     <td><tt>-E</tt></td>
  71
  72     <td>Invokes the preprocessor and exits.</td>
  73     <td>Outputs to stdout by default.</td>
  74   </tr>
  75
  76   <tr><a name="d">
  77     <td><tt>-d</tt></td>
  78
  79     <td>Outputs a dump of the AST.</td>
  80     <td>Outputs to stdout by default.</td>
  81   </tr>
  82
  83  <tr><a name="D">
  84     <td><tt>-D</tt><i>macro_definition</i></td>
  85
  86     <td><i>macro_definition</i> is passed to the preprocessor.</td>
  87     <td>&nbsp;</td>
  88   </tr>
  89
  90   <tr><a name="U">
  91     <td><tt>-U</tt><i>macro_name</i></td>
  92
  93     <td><i>macro_name</i> is passed to the preprocessor.</td>
  94     <td>Undefines <i>macro_name</i>.</td>
  95   </tr>
  96
  97   <tr><a name="I">
  98     <td><tt>-I</tt><i>include_path</i></td>
  99
 100     <td><i>include_path</i> is passed to the preprocessor.</td>
 101     <td>&nbsp;</td>
 102   </tr>
 103
 104   <tr><a name="A">
 105     <td><tt>-A</tt><i>assertion</i></td>
 106
 107     <td><i>assertion</i> is passed to the preprocessor.</td>
 108     <td>Local implementation-specific escape.</td>
 109   </tr>
 110
 111   <tr><a name="Y">
 112     <td><tt>-Yp,<i>path</i></tt></td>
 113
 114     <td>Specifies the path for the preprocessor.</td>
 115     <td>&nbsp;</td>
 116   </tr>
 117
 118   <tr><a name="t">
 119     <td><tt>-t</tt>&nbsp;<i>directory_name</i></td>
 120
 121     <td>Temporary directory to be used by the IDL compiler.</td>
 122     <td> Default:
 123         Resolve ACE_DEFAULT_TEMP_DIR_ENV. If it is not defined,
 124         /tmp/ is used.
 125    </td>
 126   </tr>
 127
 128   <tr><a name="Cw">
 129     <td><tt>-Cw</tt></td>
 130
 131     <td>Output a warning if two identifiers in the same scope differ in
 132         spelling only by case.</td>
 133
 134     <td>Default is to output error message. This option has been added as a nicety
 135         for dealing with legacy IDL files, written when the CORBA rules for name
 136         resolution were not as stringent.</td>
 137   </tr>
 138
 139   <tr><a name="Ce">
 140     <td><tt>-Ce</tt></td>
 141
 142     <td>Output an error if two indentifiers in the same scope differ in
 143         spelling only by case.</td>
 144
 145     <td>This will also happen by default.</td>
 146   </tr>
 147
 148   <tr><a name="w">
 149     <td><tt>-w</tt></td>
 150
 151     <td>Suppress IDL compiler warning messages.</td>
 152
 153     <td>&nbsp;</td>
 154   </tr>
 155
 156   <tr><a name="Si">
 157     <td><tt>-Si</tt></td>
 158
 159     <td>Suppress processing of included IDL files.</td>
 160     <td>Default is to process included IDL files.</td>
 161   </tr>
 162
 163   <tr><a name="L">
 164     <td><tt>-L</tt></td>
 165
 166     <td>Enables locking at the IDL file level.</td>
 167     <td>Guards against the same IDL file being processed concurrently by multiple
 168         threads running tao_ifr.</td>
 169   </tr>
 170
 171   <tr><a name="r">
 172     <td><tt>-r</tt></td>
 173
 174     <td>Remove contents of IDL file(s) from the repository.</td>
 175     <td>Default is to add contents.</td>
 176   </tr>
 177
 178 </table> <P>
 179
 180  <P><HR><P>
 181 Back to the Interface Repository <A HREF="index.html">documentation</A>.
 182
 183 <!--#include virtual="/~schmidt/cgi-sig.html" -->
 184
 185 </body>
 186 </html>