TAO/TAO_IDL/be/be_visitor_interface/interface_sh.cpp

   1
   2 //=============================================================================
   3 /**
   4  *  @file    interface_sh.cpp
   5  *
   6  *  Visitor generating code for Interfaces in the server header
   7  *
   8  *  @author Aniruddha Gokhale
   9  */
  10 //=============================================================================
  11
  12 #include "interface.h"
  13
  14 be_visitor_interface_sh::be_visitor_interface_sh (be_visitor_context *ctx)
  15   : be_visitor_interface (ctx)
  16 {
  17 }
  18
  19 be_visitor_interface_sh::~be_visitor_interface_sh ()
  20 {
  21 }
  22
  23 int
  24 be_visitor_interface_sh::visit_interface (be_interface *node)
  25 {
  26   if (node->srv_hdr_gen ()
  27       || node->imported ()
  28       || node->is_abstract ())
  29     {
  30       return 0;
  31     }
  32
  33   // If this node is a AMH-RH node, then generate code for it
  34   if (node->is_local ())
  35     {
  36       if (this->is_amh_rh_node (node))
  37         {
  38           // Create amh_rh_visitors.
  39           be_visitor_amh_rh_interface_sh amh_rh_intf (this->ctx_);
  40           amh_rh_intf.visit_interface (node);
  41         }
  42
  43       return 0;
  44     }
  45
  46   if (this->generate_amh_classes (node) == -1)
  47     {
  48       ACE_ERROR_RETURN ((LM_ERROR,
  49                           ACE_TEXT ("be_visitor_interface_sh::")
  50                           ACE_TEXT ("visit_interface - ")
  51                           ACE_TEXT ("codegen for AMH classes failed\n")),
  52                         -1);
  53     }
  54
  55   TAO_OutStream *os  = this->ctx_->stream ();
  56   ACE_CString class_name;
  57
  58   // We shall have a POA_ prefix only if we are at the topmost level.
  59   if (!node->is_nested ())
  60     {
  61       // We are outermost.
  62       class_name += "POA_";
  63       class_name += node->local_name ();
  64     }
  65   else
  66     {
  67       class_name +=  node->local_name ();
  68     }
  69
  70   *os << be_nl_2;
  71
  72   TAO_INSERT_COMMENT (os);
  73
  74   // Generate the skeleton class name.
  75   *os << be_nl_2
  76       << "class " << class_name.c_str () << ";" << be_nl;
  77
  78   // Generate the _ptr declaration.
  79   *os << "typedef " << class_name.c_str () << " *"
  80       << class_name.c_str () << "_ptr;";
  81
  82
  83   if (be_global->gen_direct_collocation ())
  84     {
  85       *os << be_nl_2
  86           << "class " << node->direct_proxy_impl_name ()
  87           << ";";
  88     }
  89
  90   // Now generate the class definition.
  91   *os << be_nl_2
  92       << "class " << be_global->skel_export_macro ()
  93       << " " << class_name.c_str () << be_idt_nl
  94       << ": " << be_idt;
  95
  96   node->gen_skel_inheritance (os);
  97
  98   *os << be_uidt << be_uidt_nl
  99       << "{" << be_nl
 100       << "protected:" << be_idt_nl;
 101
 102   // Default constructor.
 103   *os << class_name.c_str () << " ();"
 104       << be_uidt_nl << be_nl
 105       << "public:" << be_idt_nl;
 106
 107   // Some useful typedefs.
 108   *os << "/// Useful for template programming." << be_nl
 109       << "typedef ::" << node->name () << " _stub_type;"
 110       << be_nl
 111       << "typedef ::" << node->name () << "_ptr _stub_ptr_type;"
 112       << be_nl
 113       << "typedef ::" << node->name () << "_var _stub_var_type;"
 114       << be_nl_2;
 115
 116   // Copy constructor and destructor.
 117   *os << class_name.c_str () << " (const "
 118       << class_name.c_str () << "& rhs) = default;" << be_nl
 119       << "virtual ~" << class_name.c_str () << " () = default;" << be_nl_2;
 120
 121   // _is_a
 122   *os << "virtual ::CORBA::Boolean _is_a (const char* logical_type_id);" << be_nl_2;
 123
 124   // Add the dispatch method.
 125   *os << "virtual void _dispatch (" << be_idt << be_idt_nl
 126       << "TAO_ServerRequest & req," << be_nl
 127       << "TAO::Portable_Server::Servant_Upcall *servant_upcall);" << be_uidt
 128       << be_uidt_nl << be_nl;
 129
 130   this->this_method (node);
 131
 132   // The _interface_repository_id method.
 133   *os << be_nl
 134       << "virtual const char* _interface_repository_id "
 135       << "() const;";
 136
 137   // Generate code for elements in the scope (e.g., operations).
 138   if (this->visit_scope (node) ==  -1)
 139     {
 140       ACE_ERROR_RETURN ((LM_ERROR,
 141                          ACE_TEXT ("be_visitor_interface_sh::")
 142                          ACE_TEXT ("visit_interface - ")
 143                          ACE_TEXT ("codegen for scope failed\n")),
 144                         -1);
 145     }
 146
 147   *os << be_uidt_nl << "};";
 148
 149   be_visitor_context ctx (*this->ctx_);
 150
 151   // Generate the collocated class.
 152   ctx = *this->ctx_;
 153
 154   if (be_global->gen_direct_collocation ())
 155     {
 156       ctx.state (TAO_CodeGen::TAO_INTERFACE_DIRECT_PROXY_IMPL_SH);
 157       be_visitor_interface_direct_proxy_impl_sh idpi_visitor (&ctx);
 158
 159       if (node->accept (&idpi_visitor) == -1)
 160         {
 161           ACE_ERROR_RETURN ((LM_ERROR,
 162                              ACE_TEXT ("be_visitor_interface_sh::")
 163                              ACE_TEXT ("visit_interface - ")
 164                              ACE_TEXT ("codegen for direct ")
 165                              ACE_TEXT ("collocated class failed\n")),
 166                             -1);
 167         }
 168     }
 169
 170   return 0;
 171 }
 172
 173 int
 174 be_visitor_interface_sh::visit_component (be_component *node)
 175 {
 176   return this->visit_interface (node);
 177 }
 178
 179 int
 180 be_visitor_interface_sh::visit_connector (be_connector *node)
 181 {
 182   return this->visit_interface (node);
 183 }
 184
 185 int
 186 be_visitor_interface_sh::gen_abstract_ops_helper (
 187   be_interface *node,
 188   be_interface *base,
 189   TAO_OutStream *os)
 190 {
 191   if (!base->is_abstract ())
 192     {
 193       return 0;
 194     }
 195
 196   AST_Decl *d = nullptr;
 197   be_visitor_context ctx;
 198   ctx.stream (os);
 199   ctx.state (TAO_CodeGen::TAO_ROOT_SH);
 200
 201   for (UTL_ScopeActiveIterator si (base, UTL_Scope::IK_decls);
 202        !si.is_done ();
 203        si.next ())
 204     {
 205       d = si.item ();
 206
 207       if (d == nullptr)
 208         {
 209           ACE_ERROR_RETURN ((LM_ERROR,
 210                              ACE_TEXT ("be_visitor_interface_sh::")
 211                              ACE_TEXT ("gen_abstract_ops_helper - ")
 212                              ACE_TEXT ("bad node in this scope\n")),
 213                             -1);
 214         }
 215
 216       UTL_ScopedName item_new_name (d->local_name (),
 217                                     nullptr);
 218
 219       if (d->node_type () == AST_Decl::NT_op)
 220         {
 221           be_operation *op = dynamic_cast<be_operation*> (d);
 222           be_visitor_operation_sh op_visitor (&ctx);
 223           op_visitor.visit_operation (op);
 224         }
 225       else if (d->node_type () == AST_Decl::NT_attr)
 226         {
 227           AST_Attribute *attr = dynamic_cast<AST_Attribute*> (d);
 228           be_attribute new_attr (attr->readonly (),
 229                                  attr->field_type (),
 230                                  &item_new_name,
 231                                  attr->is_local (),
 232                                  attr->is_abstract ());
 233           new_attr.set_defined_in (node);
 234
 235           UTL_ExceptList *get_exceptions = attr->get_get_exceptions ();
 236
 237           if (nullptr != get_exceptions)
 238             {
 239               new_attr.be_add_get_exceptions (get_exceptions->copy ());
 240             }
 241
 242           UTL_ExceptList *set_exceptions = attr->get_set_exceptions ();
 243
 244           if (nullptr != set_exceptions)
 245             {
 246               new_attr.be_add_set_exceptions (set_exceptions->copy ());
 247             }
 248
 249           be_visitor_attribute attr_visitor (&ctx);
 250           attr_visitor.visit_attribute (&new_attr);
 251           ctx.attribute (nullptr);
 252           new_attr.destroy ();
 253         }
 254     }
 255
 256   return 0;
 257 }
 258
 259 void
 260 be_visitor_interface_sh::this_method (be_interface *node)
 261 {
 262   TAO_OutStream *os = this->ctx_->stream ();
 263
 264   // Print out the _this() method.
 265   *os << "::" << node->full_name () << " *_this ();"
 266       << be_nl;
 267 }
 268
 269 int
 270 be_visitor_interface_sh::generate_amh_classes (be_interface *node)
 271 {
 272   // We have to check for any abstract ancestor until AMH is integrated
 273   // with abstract interfaces. If the node itself is abstract, this
 274   // visitor would not be created.
 275   if (be_global->gen_amh_classes () && !node->has_mixed_parentage ())
 276   {
 277     be_visitor_amh_interface_sh amh_intf (this->ctx_);
 278     return amh_intf.visit_interface (node);
 279   }
 280
 281   return 0;
 282 }