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 (void)
  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           << be_idt << be_idt_nl
 130           << "::" << fname << "_ptr p);" << be_uidt << be_uidt_nl
 131           << "static void release (" << be_idt << be_idt_nl
 132           << "::" << fname << "_ptr p);" << be_uidt << be_uidt_nl
 133           << "static ::" << fname << "_ptr nil (void);" << be_nl
 134           << "static ::CORBA::Boolean marshal (" << be_idt << be_idt_nl
 135           << "const ::" << fname << "_ptr p," << be_nl
 136           << "TAO_OutputCDR & cdr);" << be_uidt  << be_uidt << be_uidt_nl
 137           << "};";
 138
 139       os->gen_endif ();
 140     }
 141
 142   if (this->visit_scope (node) != 0)
 143     {
 144       ACE_ERROR_RETURN ((LM_ERROR,
 145                          "(%N:%l) be_visitor_traits::"
 146                          "visit_interface - visit scope failed\n"),
 147                         -1);
 148     }
 149
 150   return 0;
 151 }
 152
 153 int
 154 be_visitor_traits::visit_interface_fwd (be_interface_fwd *node)
 155 {
 156   if (node->cli_traits_gen ())
 157     {
 158       return 0;
 159     }
 160
 161   be_interface *fd =
 162     dynamic_cast<be_interface*> (node->full_definition ());
 163
 164   // We want to generate just the declaration of the Arg_Traits<>
 165   // specialization if the interface is forward declared but not defined.
 166   if (!fd->is_defined () && this->visit_interface (fd) != 0)
 167     {
 168       ACE_ERROR_RETURN ((LM_ERROR,
 169                          "(%N:%l) be_visitor_traits::"
 170                          "visit_interface_fwd - code generation failed\n"),
 171                         -1);
 172     }
 173
 174   node->cli_traits_gen (true);
 175   return 0;
 176 }
 177
 178 int
 179 be_visitor_traits::visit_valuetype (be_valuetype *node)
 180 {
 181   if (node->cli_traits_gen ())
 182     {
 183       return 0;
 184     }
 185
 186   /// Some type of recursion can cause fprintf problems,
 187   /// easily avoided by setting the flag before visit_scope().
 188   node->cli_traits_gen (true);
 189
 190   TAO_OutStream *os = this->ctx_->stream ();
 191
 192   // I think we need to generate this only for non-defined forward
 193   // declarations.
 194   if (!node->imported ())
 195     {
 196       os->gen_ifdef_macro (node->flat_name (), "traits", false);
 197
 198       *os << be_nl_2
 199           << "template<>" << be_nl
 200           << "struct " << be_global->stub_export_macro () << " Value_Traits<"
 201           << node->name () << ">" << be_nl
 202           << "{" << be_idt_nl
 203           << "static void add_ref (" << node->name () << " *);" << be_nl
 204           << "static void remove_ref (" << node->name () << " *);"
 205           << be_nl
 206           << "static void release (" << node->name () << " *);"
 207           << be_uidt_nl
 208           << "};";
 209
 210       os->gen_endif ();
 211     }
 212
 213   int status = this->visit_scope (node);
 214
 215   if (status != 0)
 216     {
 217       ACE_ERROR_RETURN ((LM_ERROR,
 218                          "(%N:%l) be_visitor_traits::"
 219                          "visit_valuetype - visit scope failed\n"),
 220                         -1);
 221     }
 222
 223   return 0;
 224 }
 225
 226 int
 227 be_visitor_traits::visit_valuetype_fwd (be_valuetype_fwd *node)
 228 {
 229   if (node->cli_traits_gen ())
 230     {
 231       return 0;
 232     }
 233
 234   be_valuetype *fd =
 235     dynamic_cast<be_valuetype*> (node->full_definition ());
 236
 237   // The logic in visit_valuetype() should handle what gets generated
 238   // and what doesn't.
 239   int status = this->visit_valuetype (fd);
 240
 241   if (status != 0)
 242     {
 243       ACE_ERROR_RETURN ((LM_ERROR,
 244                          "(%N:%l) be_visitor_traits::"
 245                          "visit_valuetype_fwd - code generation failed\n"),
 246                         -1);
 247     }
 248
 249   node->cli_traits_gen (true);
 250   return 0;
 251 }
 252
 253 int
 254 be_visitor_traits::visit_valuebox (be_valuebox *node)
 255 {
 256   if (node->cli_traits_gen ())
 257     {
 258       return 0;
 259     }
 260
 261   TAO_OutStream *os = this->ctx_->stream ();
 262
 263   // I think we need to generate this only for non-defined forward
 264   // declarations.
 265   if (!node->imported ())
 266     {
 267       os->gen_ifdef_macro (node->flat_name (), "traits", false);
 268
 269       *os << be_nl_2
 270           << "template<>" << be_nl
 271           << "struct " << be_global->stub_export_macro () << " Value_Traits<"
 272           << node->name () << ">" << be_nl
 273           << "{" << be_idt_nl
 274           << "static void add_ref (" << node->name () << " *);" << be_nl
 275           << "static void remove_ref (" << node->name () << " *);"
 276           << be_nl
 277           << "static void release (" << node->name () << " *);"
 278           << be_uidt_nl
 279           << "};";
 280
 281       os->gen_endif ();
 282     }
 283
 284   node->cli_traits_gen (true);
 285   return 0;
 286 }
 287
 288 int
 289 be_visitor_traits::visit_component (be_component *node)
 290 {
 291   return this->visit_interface (node);
 292 }
 293
 294 int
 295 be_visitor_traits::visit_connector (be_connector *node)
 296 {
 297   return this->visit_component (node);
 298 }
 299
 300 int
 301 be_visitor_traits::visit_component_fwd (be_component_fwd *node)
 302 {
 303   return this->visit_interface_fwd (node);
 304 }
 305
 306 int
 307 be_visitor_traits::visit_eventtype (be_eventtype *node)
 308 {
 309   return this->visit_valuetype (node);
 310 }
 311
 312 int
 313 be_visitor_traits::visit_eventtype_fwd (be_eventtype_fwd *node)
 314 {
 315   return this->visit_valuetype_fwd (node);
 316 }
 317
 318 int
 319 be_visitor_traits::visit_field (be_field *node)
 320 {
 321   be_type *ft = dynamic_cast<be_type*> (node->field_type ());
 322
 323   if (ft->accept (this) == -1)
 324     {
 325       ACE_ERROR_RETURN ((LM_ERROR,
 326                          "(%N:%l) be_visitor_traits::"
 327                          "visit_field - visit field type failed\n"),
 328                         -1);
 329     }
 330
 331   return 0;
 332 }
 333
 334 int
 335 be_visitor_traits::visit_union_branch (be_union_branch *node)
 336 {
 337   be_type *ft = dynamic_cast<be_type*> (node->field_type ());
 338   AST_Decl::NodeType nt = ft->node_type ();
 339
 340   // All we are trying to catch in here are anonymous array members.
 341   if (nt != AST_Decl::NT_array)
 342     {
 343       return 0;
 344     }
 345
 346   if (ft->accept (this) == -1)
 347     {
 348       ACE_ERROR_RETURN ((LM_ERROR,
 349                          "(%N:%l) be_visitor_traits::"
 350                          "visit_union_branch - visit field type failed\n"),
 351                         -1);
 352     }
 353
 354   return 0;
 355 }
 356
 357 int
 358 be_visitor_traits::visit_exception (be_exception *node)
 359 {
 360   if (this->visit_scope (node) == -1)
 361     {
 362       ACE_ERROR_RETURN ((LM_ERROR,
 363                          "(%N:%l) be_visitor_traits::"
 364                          "visit_exception - visit scope failed\n"),
 365                         -1);
 366     }
 367
 368   return 0;
 369 }
 370
 371 int
 372 be_visitor_traits::visit_structure (be_structure *node)
 373 {
 374   if (this->visit_scope (node) == -1)
 375     {
 376       ACE_ERROR_RETURN ((LM_ERROR,
 377                          "(%N:%l) be_visitor_traits::"
 378                          "visit_struct - visit scope failed\n"),
 379                         -1);
 380     }
 381
 382   return 0;
 383 }
 384
 385 int
 386 be_visitor_traits::visit_union (be_union *node)
 387 {
 388   if (this->visit_scope (node) == -1)
 389     {
 390       ACE_ERROR_RETURN ((LM_ERROR,
 391                          "(%N:%l) be_visitor_traits::"
 392                          "visit_union - visit scope failed\n"),
 393                         -1);
 394     }
 395
 396   return 0;
 397 }
 398
 399 int
 400 be_visitor_traits::visit_array (be_array *node)
 401 {
 402   if (node->imported () || node->cli_traits_gen ())
 403     {
 404       return 0;
 405     }
 406
 407   ACE_CString name_holder;
 408
 409   if (node->is_nested ())
 410     {
 411       be_decl *parent =
 412         dynamic_cast<be_scope*> (node->defined_in ())->decl ();
 413       name_holder = parent->full_name ();
 414
 415       name_holder += "::";
 416
 417       if (!this->ctx_->alias ())
 418         {
 419           name_holder += "_";
 420         }
 421
 422       name_holder += node->local_name ()->get_string ();
 423     }
 424   else
 425     {
 426       name_holder = node->full_name ();
 427     }
 428
 429   const char *name = name_holder.fast_rep ();
 430
 431   TAO_OutStream *os = this->ctx_->stream ();
 432
 433   //FUZZ: disable check_for_lack_ACE_OS
 434   *os << be_nl
 435       << "template<>" << be_nl
 436       << "struct " << be_global->stub_export_macro () << " Array_Traits<"
 437       << be_idt << be_idt_nl
 438       << name << "_forany" << be_uidt_nl
 439       << ">" << be_uidt_nl
 440       << "{" << be_idt_nl
 441       << "static void free (" << be_idt << be_idt_nl
 442       << name << "_slice * _tao_slice);"
 443       << be_uidt
 444       << be_uidt_nl
 445       << "static " << name << "_slice * dup ("
 446       << be_idt << be_idt_nl
 447       << "const " << name << "_slice * _tao_slice);"
 448       << be_uidt
 449       << be_uidt_nl
 450       << "static void copy (" << be_idt << be_idt_nl
 451       << name << "_slice * _tao_to," << be_nl
 452       << "const " << name << "_slice * _tao_from);"
 453       << be_uidt
 454       << be_uidt_nl
 455       << "static " << name << "_slice * alloc (void);"
 456       << be_nl
 457       << "static void zero (" << be_idt << be_idt_nl
 458       << name << "_slice * _tao_slice);"
 459       << be_uidt
 460       << be_uidt
 461       << be_uidt_nl
 462       << "};";
 463   //FUZZ: enable check_for_lack_ACE_OS
 464
 465   node->cli_traits_gen (true);
 466   return 0;
 467 }
 468
 469 int
 470 be_visitor_traits::visit_typedef (be_typedef *node)
 471 {
 472   this->ctx_->alias (node);
 473
 474   // Make a decision based on the primitive base type.
 475   be_type *bt = node->primitive_base_type ();
 476
 477   if (!bt || (bt->accept (this) == -1))
 478     {
 479       ACE_ERROR_RETURN ((LM_ERROR,
 480                          "(%N:%l) be_visitor_traits::"
 481                          "visit_typedef - "
 482                          "Bad primitive type\n"),
 483                         -1);
 484     }
 485
 486   this->ctx_->alias (0);
 487   node->cli_traits_gen (true);
 488   return 0;
 489 }