ChangeLogTag:Sat Jan 31 01:08:19 1998 Carlos O'Ryan <coryan@cs.wustl.edu>

author: coryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795> 1998-01-31 07:12:35 +0000
committer: coryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795> 1998-01-31 07:12:35 +0000
commit: b548a8472ccaf47cf135ca4358c94847fe1b0d86 (patch)
tree: 4d48bc17e0ef818963d9723c0f3189fe75508ebd /TAO
parent: 61acb4ea6ddfeeb9feabaaa8e57523fd93024491 (diff)
download: ATCD-b548a8472ccaf47cf135ca4358c94847fe1b0d86.tar.gz
6 files changed, 156 insertions, 9 deletions
diff --git a/TAO/ChangeLog-98c b/TAO/ChangeLog-98c
index c37572ac54f..8f93495c951 100644
--- a/TAO/ChangeLog-98c
+++ b/TAO/ChangeLog-98c
@@ -1,3 +1,17 @@
+Sat Jan 31 01:08:19 1998  Carlos O'Ryan  <coryan@cs.wustl.edu>
+
+	* docs/releasenotes/index.html: 
+	  The IDL compiler has support for NT DLLs already, I moved the
+	  tiem from the "issues" to the "new features" list.
+
+	* docs/index.html: 
+	* docs/compiler.html: 
+	  Added documentation for TAO IDL compiler behavior and options.
+
+	* TAO_IDL/be/be_init.cpp: 
+	  Print a reasonable version for the compiler back-end, it is no
+	  longer the Sun example BE and the version is (around 0.1.0).
+
 Fri Jan 30 16:27:47 1998  Douglas C. Schmidt  <schmidt@cs.wustl.edu>
 
 	* TAO version 0.1.1, released Fri Jan 30 16:27:47 1998.
diff --git a/TAO/TAO_IDL/be/be_init.cpp b/TAO/TAO_IDL/be/be_init.cpp
index 47a72c9936d..b44336db57f 100644
--- a/TAO/TAO_IDL/be/be_init.cpp
+++ b/TAO/TAO_IDL/be/be_init.cpp
@@ -93,5 +93,5 @@ BE_init()
 void
 BE_version()
 {
-  cerr << GTDEVEL("Demonstration BE, version 1.0.0\n");
+  cerr << GTDEVEL("TAO C++ BE, version 0.1.0\n");
 }
diff --git a/TAO/docs/compiler.html b/TAO/docs/compiler.html
new file mode 100644
index 00000000000..313192f3ca5
--- /dev/null
+++ b/TAO/docs/compiler.html
@@ -0,0 +1,114 @@
+<html>
+  <!-- $Id$ -->
+  <head>
+    <title>TAO IDL compiler User's Guide</title>
+  </head>
+
+  <body>
+    <CENTER>
+      <h1>TAO IDL compiler User's Guide</h1>
+    </CENTER>
+
+    <H2>Scope</H2>
+
+    <P>
+      This document describes the options and features of TAO IDL
+      compiler,
+      it is not a reference manual or tutorial on IDL.
+    </P>
+
+    <H2>Generated Files</H2>
+
+    <P>
+      The IDL compiler generates 6 files from each <CODE>.idl</CODE>
+      file,
+      the file names are obtained by taking the IDL basename and
+      appending
+      <CODE>C.h</CODE>,
+      <CODE>C.i</CODE>,
+      <CODE>C.cpp</CODE>,
+      <CODE>S.h</CODE>,
+      <CODE>S.i</CODE>
+      and <CODE>S.cpp</CODE>;
+      the client stubs are declared in the <CODE>C.h</CODE> file,
+      the skeletons in the <CODE>S.h</CODE> file.
+    </P>
+
+    <P>
+      Both clients and servers should link against the object files
+      for the stubs and skeletons,
+      this is needed to transparently support collocated objects.
+    </P>
+
+    <H2>Options</H2>
+
+    <P>
+      The IDL compiler invokes your <CODE>C</CODE>
+      (or <CODE>C++</CODE>) preprocessor to resolve included IDL files,
+      it receives the common options for preprocessors
+      (such as <CODE>-D</CODE> or <CODE>-I</CODE>);
+      but also receives other options that are specific to it.
+    </P>
+
+    <P>
+    <TABLE BORDER="2"
+      CELLSPACING="2"
+      CELLPADDING= "0">
+      <TR>
+	<TH>Option</TH><TH>Description</TH></TR>
+      <TR NAME="V">
+	<TD><CODE>-V</CODE></TD>
+	<TD>The compiler printouts its version and exits</TD></TR>
+      <TR NAME="Wb">
+	<TD><CODE>-Wb,</CODE><EM>option_list</EM</TD>
+	<TD>Pass options to the backend.</TD></TR>
+      <TR NAME="export_macro">
+	<TD></TD>
+	<TD><CODE>export_macro=</CODE><EM>macro_name</EM></TD>
+	<TD>
+	  The compiler will emit 
+	  <EM>macro_name</EM>
+	  right after each <CODE>class</CODE> or <CODE>extern</CODE>
+	  keyword,
+	  this is needed for Windows/NT that requires special
+	  directives to export symbols from DLLs,
+	  usually the definition is just a space on unix platforms.
+	</TD>
+      </TR>
+      <TR NAME="export_include">
+	<TD></TD>
+	<TD><CODE>export_include=</CODE><EM>include_path</EM></TD>
+	<TD>
+	  The compiler will generate code to include
+	  <EM>include_path</EM> at the top of the client header,
+	  this is usually a good place to define the export macro.
+	</TD>
+      </TR>
+      <TR NAME="E">
+	<TD><CODE>-E</CODE></TD>
+	<TD>Only invoke the preprocessor</TD></TR>
+      <TR NAME="Wp">
+	<TD><CODE>-Wp,</CODE><EM>option_list</EM</TD>
+	<TD>Pass options to the preprocessor.</TD>
+      <TR NAME="D">
+	<TD><CODE>-D</CODE><EM>macro_definition</EM></TD>
+	<TD>It is passed to the preprocessor</TD></TR>
+      <TR NAME="U">
+	<TD><CODE>-U</CODE><EM>macro_name</EM></TD>
+	<TD>It is passed to the preprocessor</TD></TR>
+      <TR NAME="I">
+	<TD><CODE>-I</CODE><EM>include_path</EM></TD>
+	<TD>It is passed to the preprocessor</TD></TR>
+      <TR NAME="A">
+	<TD><CODE>-A</CODE><EM>assertion</EM></TD>
+	<TD>It is passed to the preprocessor</TD></TR>
+      <TR NAME="Y">
+	<TD><CODE>-Y</CODE></TD>
+	<TD>It is passed to the preprocessor</TD></TR>
+      </TABLE>
+    </P>
+
+    <hr>
+    <address><a href="mailto:coryan@cs.wustl.edu">Carlos O'Ryan</a></address>
+  </body>
+</html>
diff --git a/TAO/docs/index.html b/TAO/docs/index.html
index 8f009ae8634..daef84b3e60 100644
--- a/TAO/docs/index.html
+++ b/TAO/docs/index.html
@@ -21,6 +21,8 @@ bgcolor="#eeeeee">
       HREF="http://www.cs.wustl.edu/~schmidt/corba-research-realtime.html">Technical Overview</A> <P>
   <DT><A HREF="components.html" TARGET="_top">Component Configuration</A><P>
 
+  <DT><A HREF="compiler.html" TARGET="_top">TAO IDL Compiler Options</A><P>
+
   <DT><A HREF="releasenotes/index.html">Release Notes</A><P>
 
   <DT><A
diff --git a/TAO/docs/releasenotes/index.html b/TAO/docs/releasenotes/index.html
index f6766480c51..7b8de1cce1c 100644
--- a/TAO/docs/releasenotes/index.html
+++ b/TAO/docs/releasenotes/index.html
@@ -95,7 +95,8 @@ HREF="http://www.cs.wustl.edu/~schmidt/ACE_wrappers/TAO/VERSION">current release
 
       <LI>
           Problems when interfaces use single
-          or multiple inheritance solved. The problem was with the demultiplexing
+          or multiple inheritance solved. The problem was with the
+	  demultiplexing
           code, the generated operation tables, and the dispatching
           mechanism. We are currently testing this with the Event
           Channel code. </LI>
@@ -132,12 +133,18 @@ HREF="http://www.cs.wustl.edu/~schmidt/ACE_wrappers/TAO/VERSION">current release
       <LI> Generated code closely follows the C++ Mapping specified in
           the POA Specification (ORBOS/97-05-15). </LI>
 
+      <LI>Support dynamic libraries on NT, i.e., marking classes for
+	DLL export was added.
+	Two backend options control the name of the export macro,
+	and the name of an extra include file were the macro is
+	defined;
+	the options are <CODE>-Wp,export_macro=MACRO_NAME</CODE>
+	<CODE>-Wp,export_include=INCLUDE_NAME</CODE>.
+      </LI>
     </UL>
 
   <P> Known bugs/unimplemented constructs:
   <UL>
-      <li>Support dynamic libraries on NT, i.e., marking classes for
-      DLL export.</li>
 
       <LI> Generation of Managed types must somehow be moved
 	to the ORB Core </LI>
@@ -366,25 +373,34 @@ carry updates as available.
       <dd>If an object which should be collocated is created via
       <code>string_to_object</code>, it is created as a remote object
       rather than collocated.</dd>
+      
+      <dt><em>The stubs and skeletons are not needed.</em></dt>
+      <dd>The library includes stubs and skeletons for the Portable
+	Server interfaces,
+	since all this interfaces have locality constraints the stubs
+	and skeletons are effectively dead code and should be removed.
+      </dd>
+	
     </dl>
 
-Critical work:
+    Critical work:
     <UL>
       <LI>None.</li>
-    </ul>
+    </UL>
 
     Future work:
     <UL>
       <LI>Determine the degree to which we will support the full
-      semantics of remote objects on a colocated object.  The spec
+      semantics of remote objects on a collocated object.  The spec
       mandates that collocated object should behave <em>exactly</em>
       like remote objects, but that means that request will have to be
       queued rather than calling a method directly, and this could be
       hazardous to our quest for real-time ORB status.</li>
 
       <LI>
-	Provide extensions of the specification to ensure real-time delivery of
-	messages.</LI>
+	Provide extensions of the specification to ensure real-time
+	delivery of messages.
+      </LI>
     </UL>
 
 <HR>
diff --git a/TAO/rules.tao.GNU b/TAO/rules.tao.GNU
index 9a97fc82e51..dcfba2858c7 100644
--- a/TAO/rules.tao.GNU
+++ b/TAO/rules.tao.GNU
@@ -1,4 +1,5 @@
 #----------------------------------------------------------------------------
+#
 #	$Id$
 #
 #	Common rules for all of TAO
author	coryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>	1998-01-31 07:12:35 +0000
committer	coryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>	1998-01-31 07:12:35 +0000
commit	b548a8472ccaf47cf135ca4358c94847fe1b0d86 (patch)
tree	4d48bc17e0ef818963d9723c0f3189fe75508ebd /TAO
parent	61acb4ea6ddfeeb9feabaaa8e57523fd93024491 (diff)
download	ATCD-b548a8472ccaf47cf135ca4358c94847fe1b0d86.tar.gz