// This may look like C, but it's really -*- C++ -*-
// ast_operation.h,v 1.19 2006/02/09 16:44:15 parsons Exp
/*

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_OPERATION_AST_OPERATION_HH
#define _AST_OPERATION_AST_OPERATION_HH

#include "ast_decl.h"
#include "utl_scope.h"

class UTL_ExceptList;

class TAO_IDL_FE_Export AST_Operation : public virtual AST_Decl,
                                        public virtual UTL_Scope
{
public:
  // Define enum with flags for operation attributes.
  enum Flags
  {
       OP_noflags               // No flags present.
     , OP_oneway                // Operation is oneway.
     , OP_idempotent            // Operation is idempotent.
  };

  // Constructor(s).
  AST_Operation (void);

  AST_Operation (AST_Type *return_type,
                 Flags flags,
                 UTL_ScopedName *n,
                 bool local,
                 bool abstract);

  // Destructor.
  virtual ~AST_Operation (void);

  // Data Accessors.

  AST_Type *return_type (void);

  Flags flags (void);

  UTL_StrList *context (void);

  UTL_ExceptList *exceptions (void);

  // Public operations.

  int void_return_type (void);
  /// Returns 1 if the operation has a void return type.

  /// Return the number of arguments
  virtual int argument_count (void);

  /// Count the number of arguments of a certain type.
  /**
   * @param direction_mask limit the direction (IN, OUT or INOUT) of
   * the arguments considered.  Typically used as follows:
   *
   * int count =
   *    ast_operation->count_arguments_with_direction
   *    (AST_Argument::dir_IN
   *     | AST_Argument::dir_OUT);
   */
  int count_arguments_with_direction (int direction_mask);

  virtual int has_native (void);
  // Any of the arguments or the return value is a <native> type.
  // This is important because in that case no code should be
  // generated for the stubs.

  // Narrowing.
  DEF_NARROW_METHODS2(AST_Operation, AST_Decl, UTL_Scope);
  DEF_NARROW_FROM_DECL(AST_Operation);
  DEF_NARROW_FROM_SCOPE(AST_Operation);

  // AST Dumping.
  virtual void dump (ACE_OSTREAM_TYPE &o);

  // Method to add exceptions
  UTL_ExceptList *be_add_exceptions (UTL_ExceptList *t);

  // Add an argument to the scope.
  AST_Argument *be_add_argument (AST_Argument *arg);

  // Insert an exception at the head of the list.
  int be_insert_exception (AST_Exception *ex);

  // Cleanup function.
  virtual void destroy (void);

  // Visiting.
  virtual int ast_accept (ast_visitor *visitor);

private:
  // Data.

  AST_Type *pd_return_type;
  // Return type

  Flags pd_flags;
  // Operation flags

  UTL_StrList *pd_context;
  // Context

  UTL_ExceptList *pd_exceptions;
  // Exceptions raised

  int argument_count_;
  // Number of arguments.

  int has_native_;
  // Is any argument of type native.

  // Operations.

  int compute_argument_attr (void);
  // Count the number of arguments.

  // Scope Management Protocol.

  friend int tao_yyparse (void);
  virtual AST_Argument *fe_add_argument (AST_Argument *a);
  virtual UTL_StrList *fe_add_context (UTL_StrList *c);
  virtual UTL_NameList *fe_add_exceptions (UTL_NameList *e);
};

#endif           // _AST_OPERATION_AST_OPERATION_HH
