User Manual
Contents
1. A COM2CORBA Option Description Remark Gt Generate optimized TypeCodes GX Generate empty A h file Used by TAO developers for generating an empty A h file when the GA option can t be used Overrides Sa and St Guc Generate uninlined constant if defined in a Inlined assigned a value in the module C header file by default but this causes a problem with some compilers when using pre compiled headers Constants declared at global scope are always generated inline while those declared in an interface or a valuetype never are neither case is affected by this option Gse Generate explicit export of sequence s Occasionally needed as a template base class workaround for a bug in Visual Studio NET 2002 NET 2003 and Express 2005 where the template instantiation used for the base class isn t automatically exported GI Generate boiler plate files that contain empty servant implementations Glh arg Servant implementation header file name ending Gls arg Servant implementation skeleton file name ending Glb arg Prefix to the implementation class names Gle arg Suffix to the implementation class names Version 1 0 0 revision 424 13 2009 05 08 COM2CORBA Option Description Remark GIc Generate copy constructors in the servant implementation template files Gla Generate assignment operators in the servant implementation template files2. Gld Generate IDL compiler source file line debug info in implementation files GT Enable generation of the TIE classes and the S T files that contain them GA Generate type codes and Any operators in A h and A cpp Decouples client and server decisions to compile and link TypeCode and Any related code which is generated in C h and C cpp by default If Sa or St also appear then an empty A h file is generated Gos Generate std ostream insertion operators for IDL declarations ORB IDL declarations including the basic type sequences don t have these operators generated by default to avoid the increased footprint To turn on this generation for ORB IDL files set gen ostream 1 in your default features MPC file If this option is used on application IDL that references any of the predefined basic sequence IDL types TAO must be compiled with the gen ostream feature turned on Sa Suppress generation of the Any operators Sal Suppress generation of the Any operators for local interfaces only Suppress generation of collocated stubs that use Thru_ POA collocation strategy Version 1 0 0 revision 424 14 2009 05 08 directories i e STAO ROOT TAO_ROOT tao STAO ROOT orbsves STAO ROOT CIAO TAO_ROOT CIAO ciao TAO_ROOT CIAO ccm A COM2CORBA Option Description Remark Sorb Suppress generation of the OR
3. ending Default is C inl SS Server skeleton file name ending Default is S cpp sT Server template skeleton file name ending Default is S_T cpp si Server inline skeleton file name ending Default is S inl t Temporary directory to be used by the IDL Unix use environment variable compiler TEMPDIR if defined else use tmp Windows NT 2000 XP use environment variable TMP or TEMP if defined else use the Windows directory Cw Output a warning if two identifiers in the This option has been added as a same scope differ in spelling only by case nicety for dealing with legacy default is output of error message IDL files written when the CORBA rules for name resolution were not as stringent Ce Output an error if two indentifiers in the same scope differ in spelling only by case default GC Generate AMI stubs sendc_ methods reply handler stubs etc GC Generate AMI stubs sendc_ methods reply handler stubs etc GH Generate AMH stubs skeletons exception holders etc Gp Generated collocated stubs that use Thru_POA collocation strategy default Gd Generated collocated stubs that use Direct collocation strategy Gce Generated code for CORBA e This reduces the size of the generated code Gmc Generated code for Minimum CORBA This reduces the size of the generated code Gsp Generate client smart proxies Version 1 0 0 revision 424 12 2009 05 08
4. B h include This option is useful when regenerating pidl files in the core TAO libs to prevent cyclic includes Se Disable custom header file name endings for include directories i e files that are found in TAO specific include TAO_ ROOT TAO_ROOT tao TAO_ROOT orbsvcs TAO_ROOT CIAO TAO_ROOT CIAO ciao STAO ROOT CIAO cem This option is useful when used together with hs or he I e when user needs custom file name endings for his her own files but still wants to use TAO specific files with their original endings Version 1 0 0 revision 424 15 2009 05 08 BIBLIOGRAPHY COM2CORBA Bibliography 1 http www dre vanderbilt edu schmidt DOC BOOT AO docs compiler html www dre vanderbilt edu schmidt DOC_ROOT TAO docs compiler html 2 http www omg org technology documents corba spec catalog htmhttp www omg 3 http www triodia com staff michi henning htmlhttp www triodia com staff michi henning html 4 http www cs wustl edu schmidt PDF amil pdfhttp www cs wustl edu schmidt DF amil pdf 5 http www theaceorb com product index htmlhttp www theaceorb com product 1 NI o D 09 ct D Q 5 B o m o 0g el Q o Q E 3 D B ct a Q H o D u ke D a Q D ct D o 09 Es ct B I H B E D Gei Er ct 5 6 http www dre vanderbilt edu schmidt DOC_ROOT TAO docs compiler htmloptionthttp www d
5. User Manual COM2CORBA Date 2009 05 08 Version 1 0 0 revision 424 COM2CORBA This document Summary This document presents the user manual for the COM2CORBA project Author Marcus Ericsson Date 2009 05 08 Version 1 0 0 revision 424 Document history Version Date Changes 0 1 0 2009 05 07 Document created 1 0 0 2009 05 08 First version Version 1 0 0 revision 424 1 2009 05 08 CONTENTS COM2CORBA Contents E 1 User Manual Tao Options 11 Document overview SE EE EES EE EE BEER EE EE w CO CC On CV BK Version 1 0 0 revision 424 2 2009 05 08 1 User Manual Tao Options COM2CORBA Chapter 1 User Manual Tao Options 1 1 Document overview The document is a copy of TAO IDL Compiler User s Guide 1 Version 1 0 0 revision 424 3 2009 05 08 A COM2CORBA Appendix A A 1 Scope This document describes the options and features of TAO IDL compiler It is not a reference manual or tutorial on OMG IDL For more information on OMG IDL see the online CORBA specification 2 and the Advanced CORBA Programming with C 3 book More informa tion on the design of TAO s IDL compiler is also available online 4 Finally comprehensive documentation on TAO s IDL compiler is available in the OCI TAO Developer s Guide 5 A 2 Generated Files The IDL compiler generates 9 files from each idl file The file names are obtained by taking th
6. ator or extern typecode declaration in the generated stub code this is needed for directives to export symbols from DLLs usually the definition is just a space on unix platforms This option works only in conjuction with the GA option which generates Any operators and typecodes into a separate set of files Version 1 0 0 revision 424 2009 05 08 COM2CORBA Option Description Remark anyop export include include path The compiler will generate code to include include_path at the top of the anyop file header this is usually a good place to define the export macro This option works in conjuction with the GA option which generates Any operators and typecodes into a separate set of files export macro macro name This option has the same effect as issuing Wb skel export macro macro name Wb stub export macro macro name Wb anyop export macro macro name This option is useful when building a DLL containing both stubs and skeletons export include include path This option has the same effect as specifying Wb stub export include include path Wb skel export include include path Wb anyop export include include path This option goes with the previous option to build DLL containing both stubs and skeletons Version 1 0 0 revision 424 2009 05 08 COM2CORBA Option Description R
7. cient H bi nary search H lin ear_ search in To generate include statements with lt gt s for the standard include files e g tao corba h indicating them as non changing files ic To generate include statements with s for changing standard include files e g tao corba h g To specify the path for the perfect hasing program GPERF Default is ACE ROOT bin gperf o path To specify the output directory to IDL If the specified directory does compiler as to where all the not exist it will be created if IDL compiler generated files are to be put any path that may precede the By default all the files are put in the current directory name already exists If directory from where is called the directory itself already exists no action is taken oS path Same as o option but applies only to Default is value of o option or generated S files current directory oA path Same as o option but applies only to Default is value of o option or generated A files current directory Version 1 0 0 revision 424 11 2009 05 08 A COM2CORBA Option Description Remark he Client s header file name ending Default is Chi hs Server s header file name ending Default is Oh hT Server s template header file name ending Default is S_T h CS Client stub s file name ending Default is C cpp ci Client inline file name
8. e IDL basename and appending the following suffixes see the list of TAO s IDL compiler options 6 on how to get different suffixes for these files e Client stubs i e C h C inl and C cpp Pure client applications only need to in clude and link with these files e Server skeletons i e S h S inl and S cpp Servers need to include and link with these files e Server skeleton templates i e S_T h S_T inl and S_T cpp Some C compilers do not like template and non template code in the same files so TAO s IDL compiler generates these files separately TAO s IDL compiler creates separate inl and S_T files to improve the performance of the generated code For example the inl files enable you to compile with inlining enabled or not which is useful for trading off compile time and run time performance Fortunately you only need to include the client stubs declared in the C h file and the skeletons in the S h file in your code Version 1 0 0 revision 424 4 2009 05 08 A COM2CORBA A 3 Environment Variables Variable Usage T O DL PREPROCESSOR Used to override the program name of the preprocessor that T O IDL uses T O IDL Used to override the flags passed to the preprocessor that PREPROCESSOR ARGS T O IDL uses This can be used to alter the default options for the preprocessor and specify things like include directories and how the preprocessor is invoked Two flags that wi
9. e the g option for the T O IDL compiler or set your search path accordingly to install gperf in a directory other than ACE ROOT bin Note that if you can t use perfect hashing for some reason the next best operation demuxing strategy is binary search which can be configured using TAO s IDL compiler options 9 A 5 AMI support The TAO_IDL compiler generates AMI stubs and skeletons as described in the CORBA 3 0 3 specification A 6 Collocation Strategies TAO_IDL can generate collocated stubs using two different collocation strategies It also allows you to supress enable the generation of the stubs of a particular strategy To gain great flexibility at run time you can gereate stubs for both collocation strategies using both Gp 10 and Gd 11 flags at the same time and defer the determination of collocation strategy until run time On the other hand if you want to minimize the footprint of your program you might want to pre determine the collocation strategy you want and only generate the right collocated stubs or not generating any at all using both Sp 12 and Sd 13 flags at the same time if it s a pure client See our collocation paper 14 for a detail discussion on the collocation support in TAO A 7 TAO s IDL Compiler Options TAO s IDL compiler invokes your C or C preprocessor to resolve included IDL files It receives the common options for preprocessors such as D or I It also receive
10. emark pch include include path The compiler will generate code to include include_path at the top of all T O IDL compiler generated files This can be used with a precompiled header mechanism such as those provided by Borland C Builder or MSVC obv opt accessor The IDL compiler will generate code to optimize access to base class data for valuetypes pre include include path The compiler will generate code to include include_path at the top of the each header file before any other include statements For example ace pre h which pushes compiler options for the Borland C Builder and MSVC compilers is included in this manner in all IDL generated files in the T O libraries and CORBA services post include include path The compiler will generate code to include include_path at the bottom of the each header file For example ace post h which pops compiler options for the Borland C Builder and MSVC compilers is included in this manner in all IDL generated files in the T O libraries and CORBA services include guard define The compiler will generate code the define in the C h file to prevent users from including the generated C h file Useful for regenerating the pidl files in the archive safe include file File that the user should include instead of this generated C h file Useful for regenerating the pidl files in the archive unique include file F
11. ile that the user should include instead of the normal includes in the C h file Useful for regenerating the include pidl files in the archive Version 1 0 0 revision 424 2009 05 08 COM2CORBA Option Description Remark E Invoke only the preprocessor Wp Pass options to the preprocessor option list d Causes output of a dump of the AST Dmacro It is passed to the preprocessor _ definition It is passed to the preprocessor Umacro_ name It is passed to the preprocessor Tinclude_ path Aassertion It is passed to the preprocessor Yp path Specifies the path for the C preprocessor H To specify the IDL compiler to generate perfect hash skeleton code that uses perfect hashed operation demuxing strategy which is the default strategy Perfect hashing uses gperf program to generate demuxing methods Version 1 0 0 revision 424 10 2009 05 08 COM2CORBA Option Description Remark H dy To specify the IDL compiler to generate namic_hash skeleton code that uses dynamic hashed operation demuxing strategy To specify the IDL compiler to generate skeleton code that uses binary search based operation demuxing strategy To specify the IDL compiler to generate skeleton code that uses linear search based operation demuxing strategy Note that this option is for testing purposes only and should not be used for production code since it s ineffi
12. ll always be passed to the preprocessor are DIDL and T T O ROOT Used to determine where orb idl is located ACE ROOT Used to determine where orb idl is located Because T O IDL doesn t have any code to implement a preprocessor it has to use an external one For convenience it uses a built in name for an external preprocessor to call During compilation this is how that default is set 1 If the macro T O DL PREPROCESSOR is defined then it will use that 2 Else if the macro ACE CC PREPROCESSOR is defined then it will use that 3 Otherwise it will use cc And the same behavior occurs for the T O IDL PREPROCESSOR ARGS and ACE CC PREPROCESSOR ARGS macros Case 1 is used by the Makefile on most machines to specify the preprocessor Case 2 is used on Windows and platforms that need special arguments passed to the preprocessor MVS HPUX etc And case 3 isn t used at all but is included as a default case Since the default preprocessor may not always work when T O IDL is moved to another machine or used in cross compilation it can be overriden at runtime by setting the environment variables T O IDL PREPROCESSOR and T O IDL PREPROCESSOR ARGS In previous versions the environment variables CPP_ LOCATION and T O DL DEFAULT CPP FLAGS were used for this purpose Both will still work but TAO_IDL will display a deprecation warning if it detects one of these It is possible that support for these old variable
13. re vanderbilt edu schmidt DOC_ROOT TA0 docs compiler html options 7 http www cs wustl edu schmidt PDF COOTS 99 pd schmidt PDF COOTS 99 pdf http www cs wustl edu schmidt PDF gperf pdfhttp www cs wustl edu schmidt 8 PDF gperf pdf 9 http www cs wustl edu schmidt ACE versions i htmlhttp www cs wustl edu schmidt ACE versions i html 10 http www dre vanderbilt edu schmidt DOC_ROOT TAO docs compiler html Gpht tp www dre vanderbilt edu schmidt DOC_ROOT TAO docs compiler html Gp N 11 http www dre vanderbilt edu schmidt DOC_ROOT TAO docs compiler html Gdhttp www dre vanderbilt edu schmidt DOC_ROOT TA0 docs compiler html Gd NI 12 http www dre vanderbilt edu schmidt DOC_ROOT TAO docs compiler html Sphttp www dre vanderbilt edu schmidt DOC_ROOT TAO docs compiler html Sp NI 13 http www dre vanderbilt edu schmidt DOC_ROOT TAO docs compiler html Sdhttp www dre vanderbilt edu schmidt DOC ROOT TAO docs compiler html amp Sd 14 http www cs wustl edu schmidt PDF C report coll8 pd f NJI 8 E un Q Er Ei H Q ct NJ Hg E Es w EX H D go o H ct n o Ha o go Q Version 1 0 0 revision 424 16 2009 05 08
14. s other options that are specific to it Version 1 0 0 revision 424 6 2009 05 08 COM2CORBA Option Description Remark u The compiler prints out the options that are given below and exits clean V The compiler printouts its version and exits Wb Pass options to the TAO IDL compiler option list backend skel export macro macro name The compiler will emit macro name right after each class or extern keyword in the generated skeleton code S files this is needed for Windows which requires special directives to export symbols from DLLs usually the definition is just a space on unix platforms skel export include include path The compiler will generate code to include include_path at the top of the generated server header this is usually a good place to define the server side export macro stub export macro macro name The compiler will emit macro name right after each class or extern keyword in the generated stub code this is needed for Windows which requires special directives to export symbols from DLLs usually the definition is just a space on unix platforms stub export include include path The compiler will generate code to include include_path at the top of the client header this is usually a good place to define the export macro anyop export macro macro name Windows which requires special The compiler will emit macro name before each Any oper
15. s will be removed in a future version of TAO If ACE ROOT or T O ROOT are defined then TAO_IDL will use them to include the ACE_ROOT TAO tao or TAO_ ROOT tao directories This is to allow TAO_IDL to automatically find lt orb idl gt when it is included in an IDL file TAO IDL will display a warning message when neither is defined A 4 Operation Demuxing Strategies The server skeleton can use different demuxing strategies to match the incoming operation with the correct operation at the servant TAO s IDL compiler supports perfect hashing binary search and dynamic hashing demuxing strategies By default TAO s IDL compiler tries to generate perfect hash functions which is generally the most efficient and predictable operation demuxing technique 7 To generate perfect hash functions TAO s IDL compiler uses gperf 8 which is a general purpose perfect hash function generator To configure TAO s IDL compiler to support perfect hashing please do the following e Enable ACE HAS GPERF when building ACE and TAO This macro has been defined for the platforms where gperf has been tested which includes most platforms that ACE runs on Version 1 0 0 revision 424 5 2009 05 08 A COM2CORBA e Build the gperf in ACE ROOT apps gperf This build also leaves a copy link of the gperf program at the ACE_ROOT bin directory e Set the environment variable SACE ROOT appropriately or add ACE_ROOT bin to your search path e Us
Download Pdf Manuals
Related Search