/*

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.

*/

#ifndef _AST_GENERATOR_AST_GENERATOR_HH
#define _AST_GENERATOR_AST_GENERATOR_HH


// ast_generator.h
//
// Defines base class for generators

/*
** DEPENDENCIES: ast_predefined_type.hh utl_scoped_name.hh utl_strlist.hh
**   ast_module.hh ast_root.hh ast_interface.hh
**   ast_interface_fwd.hh ast_exception.hh ast_structure.hh
**   ast_enum.hh ast_operation.hh ast_type.hh ast_field.hh
**   ast_argument.hh ast_attribute.hh ast_union.hh
**   ast_concrete_type.hh ast_union_branch.hh ast_union_label.hh
**   ast_expression.hh ast_enum_val.hh ast_array.hh
**   ast_sequence.hh ast_string.hh ast_typedef.hh
**
** USE: Included from ast.hh
*/

class AST_Generator
{

public:
   // Operations
   virtual ~AST_Generator()
   {}

   // Create a node representing a predefined type
   virtual AST_PredefinedType
   *create_predefined_type(AST_PredefinedType::PredefinedType t,
                           UTL_ScopedName *n,
                           const UTL_Pragmas &p);

   // Create a node representing a module
   virtual AST_Module *create_module(UTL_ScopedName *n,
                                     const UTL_Pragmas &p);

   // Create a node representing a module which is the root of an AST
   virtual AST_Root *create_root(UTL_ScopedName *n,
                                 const UTL_Pragmas &p);

   // Create a node representing an interface

   virtual AST_Interface *create_interface
   (
      bool local,
      bool abstract,
      UTL_ScopedName *n,
      AST_Interface **ih,
      long nih,
      const UTL_Pragmas &p
   );

   // Create a node representing a forward declaration of an interface

   AST_InterfaceFwd * create_interface_fwd
   (
      bool local,
      bool abstract,
      UTL_ScopedName *n,
      const UTL_Pragmas &p
   );

   // Create a node representing a value type

   virtual AST_Value *create_valuetype
   (
      bool abstract,
      bool custom,
      bool truncatable,
      UTL_ScopedName *n,
      AST_Value **ih,
      long nih,
      AST_Interface **supports,
      long nsupports,
      const UTL_Pragmas &p
   );

   // Create a node representing a forward declaration of a value type
   virtual AST_ValueFwd *create_valuetype_fwd
   (
      bool abstract,
      UTL_ScopedName *n,
      const UTL_Pragmas &p
   );

   // Create a node representing a state member
   virtual AST_StateMember *create_state_member
   (
      bool public_access,
      AST_Type *ft,
      UTL_ScopedName *n,
      const UTL_Pragmas &p
   );

   // Create a node representing an intilializer
   virtual AST_Initializer *create_initializer
   (
      UTL_ScopedName *n,
      const UTL_Pragmas &p
   );

   // Create a node representing a boxed value type
   virtual AST_BoxedValue *create_boxed_valuetype
   (
      UTL_ScopedName *n,
      AST_Type *t,
      const UTL_Pragmas &p
   );

   // Create a node representing an exception
   virtual AST_Exception *create_exception(UTL_ScopedName *n,
                                           const UTL_Pragmas &p);

   // Create a node representing a structure
   virtual AST_Structure *create_structure(UTL_ScopedName *n,
                                           const UTL_Pragmas &p);

   // Create a node representing an enum
   virtual AST_Enum *create_enum(UTL_ScopedName *n,
                                 const UTL_Pragmas &p);

   // Create a node representing an operation on an interface
   virtual AST_Operation *create_operation(AST_Type *rt,
                                           AST_Operation::Flags fl,
                                           UTL_ScopedName *n,
                                           const UTL_Pragmas &p);

   // Create a node representing a field in a structure, exception or
   // union
   virtual AST_Field *create_field(AST_Type *ft,
                                   UTL_ScopedName *n,
                                   const UTL_Pragmas &p);

   // Create a node representing an argument to an operation
   virtual AST_Argument *create_argument(AST_Argument::Direction d,
                                         AST_Type *ft,
                                         UTL_ScopedName *n,
                                         const UTL_Pragmas &p);

   // Create a node representing an attribute
   virtual AST_Attribute *create_attribute(bool ro,
                                           AST_Type *ft,
                                           UTL_ScopedName *n,
                                           const UTL_Pragmas &p);

   // Create a node representing a union

   virtual AST_Union * create_union
   (
      UTL_ScopedName * n,
      const UTL_Pragmas & p
   );

   // Create a node representing one branch in a union
   virtual AST_UnionBranch *create_union_branch(AST_UnionLabel *lab,
         AST_Type *ft,
         UTL_ScopedName *n,
         const UTL_Pragmas &p);

   // Create a node representing a label on a union branch
   virtual AST_UnionLabel *create_union_label(AST_UnionLabel::UnionLabel ul,
         AST_Expression *lv);

   // Create a node representing a constant
   virtual AST_Constant *create_constant(AST_Expression::ExprType et,
                                         AST_Expression *ev,
                                         UTL_ScopedName *n,
                                         const UTL_Pragmas &p);

   // Create various kinds of nodes representing expressions

   virtual AST_Expression *create_expr (UTL_ScopedName *n);
   virtual AST_Expression *create_expr (AST_Expression *v,
                                        AST_Expression::ExprType t);
   virtual AST_Expression *create_expr (AST_Expression::ExprComb c,
                                        AST_Expression *v1,
                                        AST_Expression *v2);
   virtual AST_Expression *create_expr (long v);
   virtual AST_Expression *create_expr (long v,
                                        AST_Expression::ExprType t);
   virtual AST_Expression *create_expr (unsigned long v);
   virtual AST_Expression *create_expr (UTL_String *s);
   virtual AST_Expression *create_expr (char c);
   virtual AST_Expression *create_expr (double d, const char * str);

   // Create a node representing an enumerator
   virtual AST_EnumVal *create_enum_val(unsigned long v,
                                        UTL_ScopedName *n,
                                        const UTL_Pragmas &p);

   // Create a node representing an array type
   virtual AST_Array *create_array(UTL_ScopedName *n,
                                   unsigned long ndims,
                                   UTL_ExprList *dims);

   // Create a node representing a sequence type
   virtual AST_Sequence *create_sequence(AST_Expression *v,
                                         AST_Type *bt);

   // Create a node representing a string type
   virtual AST_String *create_string(AST_Expression *v);

   // Create a node representing a wide string type
   virtual AST_String *create_wstring(AST_Expression *v);

   // Create a node representing a type renaming (typedef)
   virtual AST_Typedef *create_typedef(AST_Type *bt,
                                       UTL_ScopedName *n,
                                       const UTL_Pragmas &p);

   // Create a node representing an opaque type
   virtual AST_Opaque *create_opaque(UTL_ScopedName *n,
                                     const UTL_Pragmas &p);
};

#endif
