//
// $Id$
//

// ============================================================================
//
// = LIBRARY
//    TAO IDL
//
// = FILENAME
//    operation.h
//
// = DESCRIPTION
//    Visitor for generating code for IDL operations in client stubs
//
// = AUTHOR
//    Aniruddha Gokhale
//
// ============================================================================

#ifndef _BE_VISITOR_OPERATION_OPERATION_H_
#define _BE_VISITOR_OPERATION_OPERATION_H_

// ************************************************************
// Generic Operation visitor with some helper methods
// ************************************************************

class be_visitor_operation : public be_visitor_scope
{
  //
  // = TITLE
  //   be_visitor_operation
  //
  // = DESCRIPTION
  //   This is a base helper visitor for operation node
  //
  //
public:
  be_visitor_operation (be_visitor_context *ctx);
  // constructor

  ~be_visitor_operation (void);
  // destructor

  // =helper

  virtual int void_return_type (be_type *);
  // is my return type void?

  virtual int has_param_type (be_operation *, 
                              AST_Argument::Direction);
  // does any of the argument node have the specified direction

  /// Count the number of "in" and "inout" parameters.
  virtual size_t count_non_out_parameters (be_operation *node);

  /// Special generation of throw_spec if it is an AMH ExceptionHolder
  /// 0:false, 1:true
  virtual int is_amh_exception_holder (be_interface *node);

  virtual int gen_throw_spec (be_operation *node);
  // generate the throw specification

  virtual int gen_environment_decl (int argument_emitted,
                                    be_operation *node);
  // generate the ACE_ENV_ARG declaration, needs to know if there was
  // at least one argument emitted to deal with all the commas.

  virtual const char *gen_environment_var (void);
  // generate the environment variable declaration

  virtual int gen_raise_exception (be_type *return_type,
                                   const char *exception_name,
                                   const char *exception_arguments);
  // helper that generates code for raising an exception

  virtual int gen_check_exception (be_type *return_type);
  // helper that generates code for checking for an exception

  virtual int gen_check_interceptor_exception (be_type *);
  // helper that generates code for checking for an exception within
  // an interceptor try block.

  virtual int gen_stub_operation_body (be_operation *node,
                                      be_type *return_type);
  // Generates the code from opening brace to closing brace for
  // stub operations. Also called (for now)
  // from be_visitor_operation_cs, to generate operation stub
  // bodies for abstract interfaces (unless and until abstract
  // interfaces are made to interoperate with collocatino).

  virtual int gen_pre_stub_info (be_operation *node);
  // generate any info before the actual code for the stub is generated

  virtual int gen_marshal_and_invoke (be_operation *node,
                                      be_type *bt);
  // generate code that marshals the arguments and transmits them

  virtual int gen_raise_interceptor_exception (
      be_type *return_type,
      const char *exception_name,
      const char *exception_arguments
    );
  // helper that generates code for raising an exception within
  // interceptor's try block

  virtual const char *compute_operation_name (be_operation *node);
  // compute the operation_remote_proxy_impl name.  
  // Notice that this operation_remote_proxy_impl
  // _does_ include the double quote.

private:
  char *operation_name_;
};

#endif /* _BE_VISITOR_OPERATION_OPERATION_H_ */