TAO/TAO_IDL/be/be_visitor_home/home_svh.cpp

   1
   2 //=============================================================================
   3 /**
   4  *  @file    home_svh.cpp
   5  *
   6  *  Visitor generating code for Homes in the servant header.
   7  *
   8  *  @author Jeff Parsons
   9  */
  10 //=============================================================================
  11
  12 #include "home.h"
  13
  14 be_visitor_home_svh::be_visitor_home_svh (be_visitor_context *ctx)
  15   : be_visitor_scope (ctx),
  16     node_ (0),
  17     comp_ (0),
  18     os_ (*ctx->stream ()),
  19     export_macro_ (be_global->svnt_export_macro ())
  20 {
  21   /// All existing CIAO examples set the servant export values in the CIDL
  22   /// compiler to equal the IDL compiler's skel export values. Below is a
  23   /// partial effort to decouple them, should be completely decoupled
  24   /// sometime. See comment in codegen.cpp, line 1173.
  25   if (export_macro_ == "")
  26     {
  27       export_macro_ = be_global->skel_export_macro ();
  28     }
  29 }
  30
  31 be_visitor_home_svh::~be_visitor_home_svh (void)
  32 {
  33 }
  34
  35 int
  36 be_visitor_home_svh::visit_home (be_home *node)
  37 {
  38   if (node->imported ())
  39     {
  40       return 0;
  41     }
  42
  43   node->scan (node);
  44   node_ = node;
  45   comp_ = node_->managed_component ();
  46
  47   /// Use 'CIAO_' + component's flat name.
  48   os_ << be_nl_2
  49       << "namespace CIAO_" << comp_->flat_name () << "_Impl" << be_nl
  50       << "{" << be_idt;
  51
  52   if (this->gen_servant_class () == -1)
  53     {
  54       ACE_ERROR_RETURN ((LM_ERROR,
  55                          ACE_TEXT ("be_visitor_home_svh::")
  56                          ACE_TEXT ("visit_home - ")
  57                          ACE_TEXT ("gen_servant_class() failed\n")),
  58                         -1);
  59     }
  60
  61   this->gen_entrypoint ();
  62
  63   os_ << be_uidt_nl
  64       << "}";
  65
  66   return 0;
  67 }
  68
  69 int
  70 be_visitor_home_svh::visit_operation (be_operation *node)
  71 {
  72   be_visitor_operation_ch v (this->ctx_);
  73   return v.visit_operation (node);
  74 }
  75
  76 int
  77 be_visitor_home_svh::visit_attribute (be_attribute *node)
  78 {
  79   be_visitor_attribute v (this->ctx_);
  80   return v.visit_attribute (node);
  81 }
  82
  83 int
  84 be_visitor_home_svh::visit_factory (be_factory *node)
  85 {
  86   // An inherited factory/finder needs to return the managed
  87   // component of the home where it is defined.
  88   be_home *h =
  89     dynamic_cast<be_home*> (node->defined_in ());
  90
  91   AST_Component *c = h->managed_component ();
  92
  93   os_ << be_nl_2
  94       << "virtual ::" << c->name () << "_ptr" << be_nl
  95       << node->local_name ();
  96
  97   // We can reuse this visitor.
  98   be_visitor_valuetype_init_arglist_ch v (this->ctx_);
  99
 100   if (v.visit_factory (node) != 0)
 101     {
 102       ACE_ERROR_RETURN ((LM_ERROR,
 103                          ACE_TEXT ("be_visitor_home_svh::")
 104                          ACE_TEXT ("visit_factory - ")
 105                          ACE_TEXT ("codegen for argument ")
 106                          ACE_TEXT ("list failed\n")),
 107                         -1);
 108     }
 109
 110   os_ << ";";
 111
 112   return 0;
 113 }
 114
 115 int
 116 be_visitor_home_svh::visit_finder (be_finder *node)
 117 {
 118   return this->visit_factory (node);
 119 }
 120
 121 int
 122 be_visitor_home_svh::gen_servant_class (void)
 123 {
 124   AST_Decl *scope = ScopeAsDecl (node_->defined_in ());
 125   ACE_CString sname_str (scope->full_name ());
 126   const char *sname = sname_str.c_str ();
 127
 128   // No '_cxx_' prefix.
 129   const char *lname =
 130     node_->original_local_name ()->get_string ();
 131
 132   const char *clname = comp_->local_name ()->get_string ();
 133   const char *global = (sname_str == "" ? "" : "::");
 134
 135   os_ << be_nl
 136       << "class " << export_macro_.c_str () << " " << lname
 137       << "_Servant" << be_idt_nl
 138       << ": public virtual" << be_idt << be_idt_nl
 139       << "::CIAO::"
 140       << "Home_Servant_Impl<" << be_idt_nl
 141       << "::" << node_->full_skel_name () << "," << be_nl
 142       << global << sname << "::CCM_" << lname << "," << be_nl
 143       << clname << "_Servant," << be_nl
 144       << "::CIAO::" << be_global->ciao_container_type () << "_Container>"
 145       << be_uidt << be_uidt << be_uidt << be_uidt_nl
 146       << "{" << be_nl
 147       << "public:" << be_idt_nl;
 148
 149   os_ << lname << "_Servant (" << be_idt_nl
 150       << global << sname << "::CCM_" << lname << "_ptr exe," << be_nl
 151       << "const char * ins_name," << be_nl
 152       << "::CIAO::" << be_global->ciao_container_type ()
 153       << "_Container_ptr c);" << be_uidt;
 154
 155   os_ << be_nl_2
 156       << "virtual ~" << lname << "_Servant (void);";
 157
 158   if (this->node_->has_rw_attributes ())
 159     {
 160       os_ << be_nl_2
 161           << "virtual void" << be_nl
 162           << "set_attributes (const "
 163           << "::Components::ConfigValues & descr);";
 164     }
 165
 166 AST_Type *pk = node_->primary_key ();
 167
 168   if (pk != 0)
 169     {
 170       os_ << be_nl_2
 171           << "// Implicit home primary key operations - not supported.";
 172
 173       os_ << be_nl_2
 174           << "virtual ::" << comp_->name () << "_ptr" << be_nl
 175           << "create (" << be_idt_nl
 176           << "::" << pk->name () << " * key);" << be_uidt;
 177
 178       if (!be_global->gen_lwccm ())
 179         {
 180           os_ << be_nl_2
 181               << "virtual ::" << comp_->name () << "_ptr" << be_nl
 182               << "find_by_primary_key (" << be_idt_nl
 183               << "::" << pk->name () << " * key);" << be_uidt;
 184         }
 185
 186       os_ << be_nl_2
 187           << "virtual void" << be_nl
 188           << "remove (" << be_idt_nl
 189           << "::" << pk->name () << " * key);" << be_uidt;
 190
 191       if (!be_global->gen_lwccm ())
 192         {
 193           os_ << be_nl_2
 194               << "virtual ::" << pk->name () << " *" << be_nl
 195               << "get_primary_key (" << be_idt_nl
 196               << "::" << comp_->name () << "_ptr comp);" << be_uidt;
 197         }
 198     }
 199
 200   be_home *h = node_;
 201
 202   while (h != 0)
 203     {
 204       if (this->visit_scope (h) != 0)
 205         {
 206           ACE_ERROR_RETURN ((LM_ERROR,
 207                              ACE_TEXT ("be_visitor_home_svh::")
 208                              ACE_TEXT ("gen_servant_class - ")
 209                              ACE_TEXT ("visit_scope() failed\n")),
 210                             -1);
 211         }
 212
 213       for (long i = 0; i < h->n_inherits (); ++i)
 214         {
 215           // A closure of all the supported interfaces is stored
 216           // in the base class 'pd_inherits_flat' member.
 217           be_interface *bi =
 218             dynamic_cast<be_interface*> (h->inherits ()[i]);
 219
 220           int status =
 221             bi->traverse_inheritance_graph (
 222               be_visitor_home_svh::op_attr_decl_helper,
 223               &os_);
 224
 225           if (status == -1)
 226             {
 227               ACE_ERROR_RETURN ((LM_ERROR,
 228                                  ACE_TEXT ("be_visitor_home_svh::")
 229                                  ACE_TEXT ("gen_servant_class - ")
 230                                  ACE_TEXT ("traverse_inheritance_graph() ")
 231                                  ACE_TEXT ("failed for %s\n"),
 232                                  bi->full_name ()),
 233                                 -1);
 234             }
 235         }
 236
 237       h = dynamic_cast<be_home*> (h->base_home ());
 238     }
 239
 240   os_ << be_uidt_nl
 241       << "};";
 242
 243   return 0;
 244 }
 245
 246 void
 247 be_visitor_home_svh::gen_entrypoint (void)
 248 {
 249   os_ << be_nl_2
 250       << "extern \"C\" " << export_macro_.c_str ()
 251       << " ::PortableServer::Servant" << be_nl
 252       << "create_" << node_->flat_name ()
 253       << "_Servant (" << be_idt_nl
 254       << "::Components::HomeExecutorBase_ptr p," << be_nl
 255       << "::CIAO::" << be_global->ciao_container_type ()
 256       << "_Container_ptr c," << be_nl
 257       << "const char * ins_name);" << be_uidt;
 258 }
 259
 260 int
 261 be_visitor_home_svh::op_attr_decl_helper (be_interface * /* derived */,
 262                                           be_interface *ancestor,
 263                                           TAO_OutStream *os)
 264 {
 265   /// We're in a static method, so we have to instantiate a temporary
 266   /// visitor and context.
 267   be_visitor_context ctx;
 268   ctx.state (TAO_CodeGen::TAO_ROOT_SVH);
 269   ctx.stream (os);
 270   be_visitor_home_svh visitor (&ctx);
 271
 272   /// Since this visitor overriddes only visit_operation() and
 273   /// visit_attribute(), we can get away with this for the declarations.
 274   return visitor.visit_scope (ancestor);
 275 }
 276
 277