TAO/TAO_IDL/be/be_visitor_traits.cpp

   1 //=============================================================================
   2 /**
   3 *  @file   be_visitor_traits.cpp
   4 *
   5 *  This visitor generates template specializations for traits of various
   6 *  kinds for IDL declarations. These specialized template classes are then
   7 *  used in other template classes in the ORB.
   8 *
   9 *  @author Jeff Parsons <j.parsons@vanderbilt.edu>
  10 */
  11 //=============================================================================
  12
  13 #include "be_visitor_traits.h"
  14 #include "be_visitor_context.h"
  15 #include "be_root.h"
  16 #include "be_module.h"
  17 #include "be_interface.h"
  18 #include "be_valuebox.h"
  19 #include "be_valuetype.h"
  20 #include "be_valuebox.h"
  21 #include "be_interface_fwd.h"
  22 #include "be_valuetype_fwd.h"
  23 #include "be_eventtype.h"
  24 #include "be_eventtype_fwd.h"
  25 #include "be_connector.h"
  26 #include "be_component_fwd.h"
  27 #include "be_field.h"
  28 #include "be_union_branch.h"
  29 #include "be_exception.h"
  30 #include "be_structure.h"
  31 #include "be_union.h"
  32 #include "be_array.h"
  33 #include "be_typedef.h"
  34 #include "be_helper.h"
  35 #include "be_extern.h"
  36
  37 #include "utl_identifier.h"
  38 #include "idl_defines.h"
  39
  40 #include "ace/Log_Msg.h"
  41
  42 be_visitor_traits::be_visitor_traits (be_visitor_context *ctx)
  43   : be_visitor_scope (ctx)
  44 {
  45 }
  46
  47 be_visitor_traits::~be_visitor_traits ()
  48 {
  49 }
  50
  51 int
  52 be_visitor_traits::visit_root (be_root *node)
  53 {
  54   if (be_global->gen_arg_traits ())
  55     {
  56       TAO_OutStream *os = this->ctx_->stream ();
  57
  58       TAO_INSERT_COMMENT (os);
  59
  60       *os << be_nl
  61           << be_global->core_versioning_begin ();
  62
  63       *os << be_nl
  64           << "// Traits specializations." << be_nl
  65           << "namespace TAO" << be_nl
  66           << "{" << be_idt;
  67
  68       if (this->visit_scope (node) == -1)
  69         {
  70           ACE_ERROR_RETURN ((LM_ERROR,
  71                             "(%N:%l) be_visitor_traits::"
  72                             "visit_root - visit scope failed\n"),
  73                             -1);
  74         }
  75
  76       *os << be_uidt_nl
  77           << "}";
  78
  79       *os << be_global->core_versioning_end () << be_nl;
  80     }
  81
  82   return 0;
  83 }
  84
  85 int
  86 be_visitor_traits::visit_module (be_module *node)
  87 {
  88   if (this->visit_scope (node) == -1)
  89     {
  90       ACE_ERROR_RETURN ((LM_ERROR,
  91                          "(%N:%l) be_visitor_traits::"
  92                          "visit_module - visit scope failed\n"),
  93                         -1);
  94     }
  95
  96   return 0;
  97 }
  98
  99 int
 100 be_visitor_traits::visit_interface (be_interface *node)
 101 {
 102   if (node->cli_traits_gen ())
 103     {
 104       return 0;
 105     }
 106
 107   /// Some type of recursion can cause fprintf problems,
 108   /// easily avoided by setting the flag before visit_scope().
 109   node->cli_traits_gen (true);
 110
 111   TAO_OutStream *os = this->ctx_->stream ();
 112
 113   // Since the three blocks below generate specialized (i.e., non-template)
 114   // classes, we don't want to generate them unless it's necessary - thus
 115   // the ifdef logic surrounding each one.
 116
 117   if (!node->imported ())
 118     {
 119       os->gen_ifdef_macro (node->flat_name (), "traits", false);
 120
 121       const char *fname = node->full_name ();
 122
 123       *os << be_nl_2
 124           << "template<>" << be_nl
 125           << "struct " << be_global->stub_export_macro () << " Objref_Traits<"
 126           << " ::" << fname << ">" << be_nl
 127           << "{" << be_idt_nl
 128           << "static ::" << fname << "_ptr duplicate ("
 129           << "::" << fname << "_ptr p);" << be_nl
 130           << "static void release ("
 131           << "::" << fname << "_ptr p);" << be_nl
 132           << "static ::" << fname << "_ptr nil ();" << be_nl
 133           << "static ::CORBA::Boolean marshal ("
 134           << "const ::" << fname << "_ptr p,"
 135           << "TAO_OutputCDR & cdr);" << be_uidt_nl
 136           << "};";
 137
 138       os->gen_endif ();
 139     }
 140
 141   if (this->visit_scope (node) != 0)
 142     {
 143       ACE_ERROR_RETURN ((LM_ERROR,
 144                          "(%N:%l) be_visitor_traits::"
 145                          "visit_interface - visit scope failed\n"),
 146                         -1);
 147     }
 148
 149   return 0;
 150 }
 151
 152 int
 153 be_visitor_traits::visit_interface_fwd (be_interface_fwd *node)
 154 {
 155   if (node->cli_traits_gen ())
 156     {
 157       return 0;
 158     }
 159
 160   be_interface *fd =
 161     dynamic_cast<be_interface*> (node->full_definition ());
 162
 163   // We want to generate just the declaration of the Arg_Traits<>
 164   // specialization if the interface is forward declared but not defined.
 165   if (!fd->is_defined () && this->visit_interface (fd) != 0)
 166     {
 167       ACE_ERROR_RETURN ((LM_ERROR,
 168                          "(%N:%l) be_visitor_traits::"
 169                          "visit_interface_fwd - code generation failed\n"),
 170                         -1);
 171     }
 172
 173   node->cli_traits_gen (true);
 174   return 0;
 175 }
 176
 177 int
 178 be_visitor_traits::visit_valuetype (be_valuetype *node)
 179 {
 180   if (node->cli_traits_gen ())
 181     {
 182       return 0;
 183     }
 184
 185   /// Some type of recursion can cause fprintf problems,
 186   /// easily avoided by setting the flag before visit_scope().
 187   node->cli_traits_gen (true);
 188
 189   TAO_OutStream *os = this->ctx_->stream ();
 190
 191   // I think we need to generate this only for non-defined forward
 192   // declarations.
 193   if (!node->imported ())
 194     {
 195       os->gen_ifdef_macro (node->flat_name (), "traits", false);
 196
 197       *os << be_nl_2
 198           << "template<>" << be_nl
 199           << "struct " << be_global->stub_export_macro () << " Value_Traits<"
 200           << node->name () << ">" << be_nl
 201           << "{" << be_idt_nl
 202           << "static void add_ref (" << node->name () << " *);" << be_nl
 203           << "static void remove_ref (" << node->name () << " *);"
 204           << be_nl
 205           << "static void release (" << node->name () << " *);"
 206           << be_uidt_nl
 207           << "};";
 208
 209       os->gen_endif ();
 210     }
 211
 212   int status = this->visit_scope (node);
 213
 214   if (status != 0)
 215     {
 216       ACE_ERROR_RETURN ((LM_ERROR,
 217                          "(%N:%l) be_visitor_traits::"
 218                          "visit_valuetype - visit scope failed\n"),
 219                         -1);
 220     }
 221
 222   return 0;
 223 }
 224
 225 int
 226 be_visitor_traits::visit_valuetype_fwd (be_valuetype_fwd *node)
 227 {
 228   if (node->cli_traits_gen ())
 229     {
 230       return 0;
 231     }
 232
 233   be_valuetype *fd =
 234     dynamic_cast<be_valuetype*> (node->full_definition ());
 235
 236   // The logic in visit_valuetype() should handle what gets generated
 237   // and what doesn't.
 238   int status = this->visit_valuetype (fd);
 239
 240   if (status != 0)
 241     {
 242       ACE_ERROR_RETURN ((LM_ERROR,
 243                          "(%N:%l) be_visitor_traits::"
 244                          "visit_valuetype_fwd - code generation failed\n"),
 245                         -1);
 246     }
 247
 248   node->cli_traits_gen (true);
 249   return 0;
 250 }
 251
 252 int
 253 be_visitor_traits::visit_valuebox (be_valuebox *node)
 254 {
 255   if (node->cli_traits_gen ())
 256     {
 257       return 0;
 258     }
 259
 260   TAO_OutStream *os = this->ctx_->stream ();
 261
 262   // I think we need to generate this only for non-defined forward
 263   // declarations.
 264   if (!node->imported ())
 265     {
 266       os->gen_ifdef_macro (node->flat_name (), "traits", false);
 267
 268       *os << be_nl_2
 269           << "template<>" << be_nl
 270           << "struct " << be_global->stub_export_macro () << " Value_Traits<"
 271           << node->name () << ">" << be_nl
 272           << "{" << be_idt_nl
 273           << "static void add_ref (" << node->name () << " *);" << be_nl
 274           << "static void remove_ref (" << node->name () << " *);"
 275           << be_nl
 276           << "static void release (" << node->name () << " *);"
 277           << be_uidt_nl
 278           << "};";
 279
 280       os->gen_endif ();
 281     }
 282
 283   node->cli_traits_gen (true);
 284   return 0;
 285 }
 286
 287 int
 288 be_visitor_traits::visit_component (be_component *node)
 289 {
 290   return this->visit_interface (node);
 291 }
 292
 293 int
 294 be_visitor_traits::visit_connector (be_connector *node)
 295 {
 296   return this->visit_component (node);
 297 }
 298
 299 int
 300 be_visitor_traits::visit_component_fwd (be_component_fwd *node)
 301 {
 302   return this->visit_interface_fwd (node);
 303 }
 304
 305 int
 306 be_visitor_traits::visit_eventtype (be_eventtype *node)
 307 {
 308   return this->visit_valuetype (node);
 309 }
 310
 311 int
 312 be_visitor_traits::visit_eventtype_fwd (be_eventtype_fwd *node)
 313 {
 314   return this->visit_valuetype_fwd (node);
 315 }
 316
 317 int
 318 be_visitor_traits::visit_field (be_field *node)
 319 {
 320   be_type *ft = dynamic_cast<be_type*> (node->field_type ());
 321
 322   if (ft->accept (this) == -1)
 323     {
 324       ACE_ERROR_RETURN ((LM_ERROR,
 325                          "(%N:%l) be_visitor_traits::"
 326                          "visit_field - visit field type failed\n"),
 327                         -1);
 328     }
 329
 330   return 0;
 331 }
 332
 333 int
 334 be_visitor_traits::visit_union_branch (be_union_branch *node)
 335 {
 336   be_type *ft = dynamic_cast<be_type*> (node->field_type ());
 337   AST_Decl::NodeType nt = ft->node_type ();
 338
 339   // All we are trying to catch in here are anonymous array members.
 340   if (nt != AST_Decl::NT_array)
 341     {
 342       return 0;
 343     }
 344
 345   if (ft->accept (this) == -1)
 346     {
 347       ACE_ERROR_RETURN ((LM_ERROR,
 348                          "(%N:%l) be_visitor_traits::"
 349                          "visit_union_branch - visit field type failed\n"),
 350                         -1);
 351     }
 352
 353   return 0;
 354 }
 355
 356 int
 357 be_visitor_traits::visit_exception (be_exception *node)
 358 {
 359   if (this->visit_scope (node) == -1)
 360     {
 361       ACE_ERROR_RETURN ((LM_ERROR,
 362                          "(%N:%l) be_visitor_traits::"
 363                          "visit_exception - visit scope failed\n"),
 364                         -1);
 365     }
 366
 367   return 0;
 368 }
 369
 370 int
 371 be_visitor_traits::visit_structure (be_structure *node)
 372 {
 373   if (this->visit_scope (node) == -1)
 374     {
 375       ACE_ERROR_RETURN ((LM_ERROR,
 376                          "(%N:%l) be_visitor_traits::"
 377                          "visit_struct - visit scope failed\n"),
 378                         -1);
 379     }
 380
 381   return 0;
 382 }
 383
 384 int
 385 be_visitor_traits::visit_union (be_union *node)
 386 {
 387   if (this->visit_scope (node) == -1)
 388     {
 389       ACE_ERROR_RETURN ((LM_ERROR,
 390                          "(%N:%l) be_visitor_traits::"
 391                          "visit_union - visit scope failed\n"),
 392                         -1);
 393     }
 394
 395   return 0;
 396 }
 397
 398 int
 399 be_visitor_traits::visit_array (be_array *node)
 400 {
 401   if (node->imported () || node->cli_traits_gen ())
 402     {
 403       return 0;
 404     }
 405
 406   ACE_CString name_holder;
 407
 408   if (node->is_nested ())
 409     {
 410       be_decl *parent =
 411         dynamic_cast<be_scope*> (node->defined_in ())->decl ();
 412       name_holder = parent->full_name ();
 413
 414       name_holder += "::";
 415
 416       if (!this->ctx_->alias ())
 417         {
 418           name_holder += "_";
 419         }
 420
 421       name_holder += node->local_name ()->get_string ();
 422     }
 423   else
 424     {
 425       name_holder = node->full_name ();
 426     }
 427
 428   const char *name = name_holder.fast_rep ();
 429
 430   TAO_OutStream *os = this->ctx_->stream ();
 431
 432   //FUZZ: disable check_for_lack_ACE_OS
 433   *os << be_nl
 434       << "template<>" << be_nl
 435       << "struct " << be_global->stub_export_macro () << " Array_Traits<"
 436       << be_idt << be_idt_nl
 437       << name << "_forany" << be_uidt_nl
 438       << ">" << be_uidt_nl
 439       << "{" << be_idt_nl
 440       << "static void free (" << be_idt << be_idt_nl
 441       << name << "_slice * _tao_slice);"
 442       << be_uidt
 443       << be_uidt_nl
 444       << "static " << name << "_slice * dup ("
 445       << be_idt << be_idt_nl
 446       << "const " << name << "_slice * _tao_slice);"
 447       << be_uidt
 448       << be_uidt_nl
 449       << "static void copy (" << be_idt << be_idt_nl
 450       << name << "_slice * _tao_to," << be_nl
 451       << "const " << name << "_slice * _tao_from);"
 452       << be_uidt
 453       << be_uidt_nl
 454       << "static " << name << "_slice * alloc ();"
 455       << be_nl
 456       << "static void zero (" << be_idt << be_idt_nl
 457       << name << "_slice * _tao_slice);"
 458       << be_uidt
 459       << be_uidt
 460       << be_uidt_nl
 461       << "};";
 462   //FUZZ: enable check_for_lack_ACE_OS
 463
 464   node->cli_traits_gen (true);
 465   return 0;
 466 }
 467
 468 int
 469 be_visitor_traits::visit_typedef (be_typedef *node)
 470 {
 471   this->ctx_->alias (node);
 472
 473   // Make a decision based on the primitive base type.
 474   be_type *bt = node->primitive_base_type ();
 475
 476   if (!bt || (bt->accept (this) == -1))
 477     {
 478       ACE_ERROR_RETURN ((LM_ERROR,
 479                          "(%N:%l) be_visitor_traits::"
 480                          "visit_typedef - "
 481                          "Bad primitive type\n"),
 482                         -1);
 483     }
 484
 485   this->ctx_->alias (nullptr);
 486   node->cli_traits_gen (true);
 487   return 0;
 488 }