diff options
Diffstat (limited to 'TAO/TAO_IDL/docs/ROADMAP')
| -rw-r--r-- | TAO/TAO_IDL/docs/ROADMAP | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/TAO/TAO_IDL/docs/ROADMAP b/TAO/TAO_IDL/docs/ROADMAP new file mode 100644 index 00000000000..5da0d83823c --- /dev/null +++ b/TAO/TAO_IDL/docs/ROADMAP @@ -0,0 +1,126 @@ +INTERFACE DEFINITION LANGUAGE SOURCE TREE ROADMAP +-===============================================- + +INTRODUCTION + +This file provides an overview of the directory structure of the sources +for the compiler front end for OMG Interface Definition Language. This will +be of use in understanding the source structure and will aid developers of +BEs. + +DIRECTORIES + +The following directories are present: + +- idl_specs: Contains many examples of IDL specifications, including the + IDL specifications of several Object Services, and several + files that somewhat exhaustively test features of the IDL + language +- include: Contains all include (".hh") files +- ast: Contains implementations for all classes comprising + the AST internal representation of the input parsed +- fe: Contains the Yacc grammar and Lex specification for + the OMG Interface Definition Language, and some utilities +- driver: Contains the main program which drives the compilation + process +- util: Contains utility classes used throughout the CFE. These + classes may also be of use in writing a BE +- narrow: Contains an implementation of a narrowing mechanism used + in the CFE. Since C++ does not provide compiler support + for narrowing, this is provided as an explicit service +- demo_be: Contains a demonstration back end which subclasses all + the AST classes but adds no functionality + +NAMING CONVENTIONS + +The file names start with two or three characters identifying the component +to which they belong: + +- idl_: This is the prefix for all files which contain global + elements of the CFE +- ast_: This is the prefix for all files containing implementations + or definitions of the AST +- fe_: This is the prefix for all files belonging to the parser +- drv_: This is the prefix for all files belonging to the compiler + driver +- utl_: This prefix is used to identify files belonging to the set of + utlities provided with the CFE +- nr_: This prefix identifies files belonging to the narrowing mechanim +- be_: This is the prefix for all files belonging to the back end + +All C++ files use the ".cc" extension, and all include files have the ".hh" +extension. All make files are named Makefile. Each directory contains a +make file. Lex input files have the ".ll" extension, and Yacc input files +use the ".yy" extension. All files containing IDL specifications have a +name ending with the ".idl" suffix. + +INCLUDE FILE HIERARCHY + +There are two main include files which must be included in all source +files. These are idl.hh and idl_extern.hh. The idl.hh file includes the +definitions for all the facilities provided by the CFE. The idl_extern.hh +file declares globally accessible data and exported application programmer +interface entry points. + +Each component has an include file for its own. Back end writers will want +to modify be.hh and possibly be_extern.hh. + +COPYRIGHT + +Copyright 1992, 1993, 1994 Sun Microsystems, Inc. Printed in the United +States of America. All Rights Reserved. + +This product is protected by copyright and distributed under the following +license restricting its use. + +The Interface Definition Language Compiler Front End (CFE) is made +available for your use provided that you include this license and copyright +notice on all media and documentation and the software program in which +this product is incorporated in whole or part. You may copy and extend +functionality (but may not remove functionality) of the Interface +Definition Language CFE without charge, but you are not authorized to +license or distribute it to anyone else except as part of a product or +program developed by you or with the express written consent of Sun +Microsystems, Inc. ("Sun"). + +The names of Sun Microsystems, Inc. and any of its subsidiaries or +affiliates may not be used in advertising or publicity pertaining to +distribution of Interface Definition Language CFE as permitted herein. + +This license is effective until terminated by Sun for failure to comply +with this license. Upon termination, you shall destroy or return all code +and documentation for the Interface Definition Language CFE. + +INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED AS IS WITH NO WARRANTIES OF +ANY KIND INCLUDING THE WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS +FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR ARISING FROM A COURSE OF +DEALING, USAGE OR TRADE PRACTICE. + +INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED WITH NO SUPPORT AND WITHOUT +ANY OBLIGATION ON THE PART OF Sun OR ANY OF ITS SUBSIDIARIES OR AFFILIATES +TO ASSIST IN ITS USE, CORRECTION, MODIFICATION OR ENHANCEMENT. + +SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES SHALL HAVE NO LIABILITY WITH +RESPECT TO THE INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY +INTERFACE DEFINITION LANGUAGE CFE OR ANY PART THEREOF. + +IN NO EVENT WILL SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES BE LIABLE FOR +ANY LOST REVENUE OR PROFITS OR OTHER SPECIAL, INDIRECT AND CONSEQUENTIAL +DAMAGES, EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +Use, duplication, or disclosure by the government is subject to +restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in +Technical Data and Computer Software clause at DFARS 252.227-7013 and FAR +52.227-19. + +Sun, Sun Microsystems and the Sun logo are trademarks or registered +trademarks of Sun Microsystems, Inc. + +SunSoft, Inc. +2550 Garcia Avenue +Mountain View, California 94043 + +NOTE: + +SunOS, SunSoft, Sun, Solaris, Sun Microsystems or the Sun logo are +trademarks or registered trademarks of Sun Microsystems, Inc. |