/*

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 _UTL_SCOPE_UTL_SCOPE_HH
#define _UTL_SCOPE_UTL_SCOPE_HH

// UTL_Scope - Provide scoping mechanism
//
// This is the base class for name scoping. Each entity which can
// be directly contained in a naming scope has an add() function
// defined for it. The functions defined on the base scoping class
// all return FALSE. Each subclass of UTL_Scope should
// define its own add() functions for those types which are legal
// in that context. Then, for those types for which no local functions
// have been defined the function on the base class will be called to
// return FALSE.
//
// The "AST_" classes may redefine add() functions to implement any
// name binding mechanisms needed for their own functionality. It is
// the responsibility of those functions then to call the add()
// function defined in the parent "AST_" class.

/*
** DEPENDENCIES: ast_decl.hh, utl_scoped_name.hh
**
** USE: Included from ast.hh
*/

#include	<idl_fwd.hh>
#include	<idl_narrow.hh>
#include	<ast_decl.hh>
#include	<ast_expression.hh>
#include	<utl_scoped_name.hh>

// Forward declaration of active iterator for UTL_Scope
class UTL_ScopeActiveIterator;

class	UTL_Scope : public virtual COMMON_Base
{
public:
  // Enum to denote the kind of iteration desired
  enum ScopeIterationKind {
      IK_both		// Iterate through both decls and local types
    , IK_decls		// Iterate only through decls
    , IK_localtypes	// Iterate only through local types
    , IK_parenttypes    // Iterate only through parenttypes
  };

  // Operations

  // Constructor(s)
  UTL_Scope();
  UTL_Scope(AST_Decl::NodeType nt);
  virtual ~UTL_Scope() {}

  // Scope Management Protocol
  virtual AST_PredefinedType	*add_predefined_type(AST_PredefinedType	*t);
  virtual AST_Module		*add_module(AST_Module			*m);
  virtual AST_Interface		*add_interface(AST_Interface		*i);
  virtual AST_InterfaceFwd	*add_interface_fwd(AST_InterfaceFwd	*i);
  virtual AST_Constant		*add_constant(AST_Constant		*c);
  virtual AST_Exception		*add_exception(AST_Exception		*e);
  virtual AST_Attribute		*add_attribute(AST_Attribute		*a);
  virtual AST_Operation		*add_operation(AST_Operation		*o);
  virtual AST_Argument		*add_argument(AST_Argument		*a);
  virtual AST_Union		*add_union(AST_Union			*u);
  virtual AST_UnionBranch	*add_union_branch(AST_UnionBranch	*b);
  virtual AST_Structure		*add_structure(AST_Structure		*s);
  virtual AST_Field		*add_field(AST_Field			*f);
  virtual AST_Enum		*add_enum(AST_Enum			*e);
  virtual AST_EnumVal		*add_enum_val(AST_EnumVal		*v);
  virtual AST_Typedef		*add_typedef(AST_Typedef		*t);
  virtual UTL_StrList		*add_context(UTL_StrList		*c);
  virtual UTL_NameList		*add_exceptions(UTL_NameList		*e);
  virtual AST_Sequence		*add_sequence(AST_Sequence		*s);
  virtual AST_String		*add_string(AST_String			*s);
  virtual AST_Array		*add_array(AST_Array			*a);

  // Call back end add_XXX functions for this scope
  virtual AST_Decl 		*call_add();

  // Data Accessors
  AST_Decl::NodeType scope_node_type() const
  {
    return pd_scope_node_type;
  }

  // Narrowing
  DEF_NARROW_METHODS0(UTL_Scope);
  DEF_NARROW_FROM_SCOPE(UTL_Scope);

  // AST Dumping
  virtual void			dump(std::ostream &o);

  // Other Operations

  // Name Lookup Mechanism
  virtual AST_Decl		*lookup_by_name(UTL_ScopedName *,
						idl_bool treat_as_ref,
						idl_bool internal_recursion=0);

  // Look up the Identifier * specified only in the local scope
  virtual AST_Decl		*lookup_by_name_local(Identifier *,
						      idl_bool treat_as_ref,
						      idl_bool ignore_case=0);

  // Look up a predefined type by its ExprType
  virtual AST_Decl
    *lookup_primitive_type(AST_Expression::ExprType);

  // How many entries are used?
  virtual unsigned long		nmembers();

  // Lookup based on the local name for the purpose of checking for
  // name clashes before addition. This function is intended to
  // be used only by the fe_add_* functions.
  virtual AST_Decl		*lookup_for_add(AST_Decl *d,
						idl_bool treat_as_ref,
						idl_bool ignore_case=0);


protected:
  // UTL_Scope protected addition protocol. This protocol is
  // used from sub-classes of UTL_Scope to insert nodes directly
  // into the specified node table (either decls or local_types)
  // Additionally, UTL_Scope also maintains a record of what nodes
  // defined elsewhere were referenced in this scope

  // Add to decls. Node represents a local declaration
  void				add_to_scope(AST_Decl *e);

  // Add to local types. Node represents a local manifest type
  void				add_to_local_types(AST_Decl *e);

  // Add to referenced nodes set.
  void				add_to_referenced(AST_Decl *e,
						  idl_bool recursive);

  // Has this node been referenced here already?
  idl_bool			referenced(AST_Decl *e);

  // Add to parent types: nodes defined in the outer scope but are referenced 
  // in this scope using their unqualified name.
  void				add_to_parent_types(AST_Decl *e);

public:
  // Look up a scoped name in the inherited interfaces of an
  // interface
  virtual AST_Decl		*look_in_inherited(UTL_ScopedName *,
						   idl_bool treat_as_ref);
private:
  // Data

  // What type is this node? This is a cache of the information
  // in AST_Decl
  const	AST_Decl::NodeType	pd_scope_node_type;

  // Storage for declarations in this scope:
  AST_Decl			**pd_decls;		// Store declarations
  long				pd_decls_allocated;	// How many allocated?
  long				pd_decls_used;		// How many used?

  // Storage for local manifest types in this scope:
  AST_Decl			**pd_local_types;	// Store types
  long				pd_locals_allocated;	// How many allocated?
  long				pd_locals_used;		// How many used?

  // Storage for referenced nodes in this scope:
  AST_Decl			**pd_referenced;	// Store references
  long				pd_referenced_allocated;// How many allocated?
  long				pd_referenced_used;	// How many used?

  // Storage for nodes defined in the outer scope but are referenced in this 
  // scope using their unqualified name:
  AST_Decl			**pd_parent_types;	// Store references
  long				pd_parents_allocated;   // How many allocated?
  long				pd_parents_used;	// How many used?


  // Friend class UTL_ScopeActiveIterator defines active iterator for
  // UTL_Scope. Definition follows below.
  friend class			UTL_ScopeActiveIterator;

private:
  friend int yyparse();
  friend class AST_Enum;

  // Scope Management Protocol
  virtual AST_PredefinedType	*fe_add_predefined_type(AST_PredefinedType *t);
  virtual AST_Module		*fe_add_module(AST_Module		*m);
  virtual AST_Interface		*fe_add_interface(AST_Interface		*i);
  virtual AST_InterfaceFwd	*fe_add_interface_fwd(AST_InterfaceFwd	*i);
  virtual AST_Constant		*fe_add_constant(AST_Constant		*c);
  virtual AST_Exception		*fe_add_exception(AST_Exception		*e);
  virtual AST_Attribute		*fe_add_attribute(AST_Attribute		*a);
  virtual AST_Operation		*fe_add_operation(AST_Operation		*o);
  virtual AST_Argument		*fe_add_argument(AST_Argument		*a);
  virtual AST_Union		*fe_add_union(AST_Union			*u);
  virtual AST_UnionBranch	*fe_add_union_branch(AST_UnionBranch	*b);
  virtual AST_Structure		*fe_add_structure(AST_Structure		*s);
  virtual AST_Field		*fe_add_field(AST_Field			*f);
  virtual AST_Enum		*fe_add_enum(AST_Enum			*e);
  virtual AST_EnumVal		*fe_add_enum_val(AST_EnumVal		*v);
  virtual AST_Typedef		*fe_add_typedef(AST_Typedef		*t);
  virtual UTL_StrList		*fe_add_context(UTL_StrList		*c);
  virtual UTL_NameList		*fe_add_exceptions(UTL_NameList		*e);
  virtual AST_Sequence		*fe_add_sequence(AST_Sequence		*s);
  virtual AST_String		*fe_add_string(AST_String		*s);
  virtual AST_Array		*fe_add_array(AST_Array			*a);
};

// Active iterator for a UTL_Scope node
class UTL_ScopeActiveIterator {
public:
  // Operations

  // Constructor(s)
  UTL_ScopeActiveIterator(UTL_Scope *s, UTL_Scope::ScopeIterationKind ik);

  // Advance to next item
  virtual void			next();

  // Get current item
  virtual AST_Decl		*item();

  // Have we iterated over entire scope?
  virtual idl_bool		is_done();

  // What kind of iterator is this?
  virtual UTL_Scope::ScopeIterationKind	iteration_kind();

  // What stage are we in with this iterator?
  virtual UTL_Scope::ScopeIterationKind	iteration_stage();

private:
  // Data
  UTL_Scope			*iter_source;	// Scope to iterate over
  UTL_Scope::ScopeIterationKind	ik;		// What kind of iteration
  UTL_Scope::ScopeIterationKind	stage;		// What stage
  long				il;		// What location in stage
};

#endif           // _UTL_SCOPE_UTL_SCOPE_HH
