TAO/TAO_IDL/be/be_visitor_valuebox/field_ci.cpp

   1
   2 //=============================================================================
   3 /**
   4  *  @file    field_ci.cpp
   5  *
   6  *   Visitor for the Valuebox class.
   7  *   This one generates code for accessor and modifier functions of
   8  *  for valuebox struct members.
   9  *
  10  *  @author Gary Maxey
  11  */
  12 //=============================================================================
  13
  14 #include "valuebox.h"
  15
  16 be_visitor_valuebox_field_ci::be_visitor_valuebox_field_ci (
  17     be_visitor_context *ctx
  18   )
  19   : be_visitor_decl (ctx),
  20     vb_node_ (nullptr)
  21 {
  22 }
  23
  24 be_visitor_valuebox_field_ci::~be_visitor_valuebox_field_ci ()
  25 {
  26 }
  27
  28 int
  29 be_visitor_valuebox_field_ci::visit_field (be_field *node)
  30 {
  31   be_type *bt = dynamic_cast<be_type*> (node->field_type ());
  32
  33   if (!bt)
  34     {
  35       ACE_ERROR_RETURN ((LM_ERROR,
  36                          "(%N:%l) be_visitor_valuebox_field_ci::"
  37                          "visit_field - "
  38                          "Bad field type\n"),
  39                         -1);
  40     }
  41
  42   // Store the valuebox in the visitor member, then replace the
  43   // context value with the field node.
  44   this->vb_node_ =
  45     dynamic_cast<be_valuebox*> (this->ctx_->node ());
  46   this->ctx_->node (node);
  47
  48   if (bt->accept (this) == -1)
  49     {
  50       ACE_ERROR_RETURN ((LM_ERROR,
  51                          "(%N:%l) be_visitor_valuebox_field_ci::"
  52                          "visit_field - "
  53                          "codegen for field type failed\n"),
  54                         -1);
  55     }
  56
  57   return 0;
  58 }
  59
  60 // Visit operations on all possible data types that a field can be
  61
  62 int
  63 be_visitor_valuebox_field_ci::visit_array (be_array *node)
  64 {
  65   be_decl *field = this->ctx_->node ();
  66   be_type *bt = nullptr;
  67
  68   // Check if we are visiting this node via a visit to a typedef node.
  69   if (this->ctx_->alias ())
  70     {
  71       bt = this->ctx_->alias ();
  72     }
  73   else
  74     {
  75       bt = node;
  76     }
  77
  78   if (!field || !vb_node_)
  79     {
  80       ACE_ERROR_RETURN ((LM_ERROR,
  81                          "(%N:%l) be_visitor_valuebox_field_ci::"
  82                          "visit_array - "
  83                          "bad context information\n"),
  84                         -1);
  85     }
  86
  87   TAO_OutStream *os = this->ctx_->stream ();
  88
  89   char fname [NAMEBUFSIZE];
  90   ACE_OS::memset (fname,
  91                   '\0',
  92                   NAMEBUFSIZE);
  93
  94   if (bt->node_type () != AST_Decl::NT_typedef)
  95     {
  96       // For anonymous arrays ...
  97       // We have to generate a name for us that has an underscope prepended to
  98       // our local name. This needs to be inserted after the parent's name.
  99       if (bt->is_nested ())
 100         {
 101           be_decl *parent =
 102                  dynamic_cast<be_scope*> (bt->defined_in ())->decl ();
 103           ACE_OS::sprintf (fname,
 104                            "%s::_%s",
 105                            parent->full_name (),
 106                            bt->local_name ()->get_string ());
 107         }
 108       else
 109         {
 110           ACE_OS::sprintf (fname,
 111                            "_%s",
 112                            bt->full_name ());
 113         }
 114     }
 115   else
 116     {
 117       // Typedefed node.
 118       ACE_OS::sprintf (fname,
 119                        "%s",
 120                        bt->full_name ());
 121     }
 122
 123   TAO_INSERT_COMMENT (os);
 124
 125   *os << "/// Modifier to set the member." << be_nl;
 126
 127   *os << "ACE_INLINE void" << be_nl
 128       << vb_node_->name () << "::" << field->local_name ()
 129       << " (" << fname << " val)" << be_nl
 130       << "{" << be_idt_nl
 131       << fname << "_copy ("
 132       << "this->_pd_value->" << field->local_name ()
 133       << ", val);" << be_uidt_nl
 134       << "}" << be_nl_2;
 135
 136   *os << "/// Accessor to retrieve the member." << be_nl;
 137
 138   *os << "ACE_INLINE const " << fname << "_slice *" << be_nl
 139       << vb_node_->name () << "::" << field->local_name ()
 140       << " () const" << be_nl
 141       << "{" << be_idt_nl
 142       << "return this->_pd_value->" << field->local_name ()
 143       << ";" << be_uidt_nl
 144       << "}" << be_nl_2;
 145
 146   return 0;
 147 }
 148
 149 int
 150 be_visitor_valuebox_field_ci::visit_enum (be_enum *node)
 151 {
 152   be_decl *field = this->ctx_->node ();
 153   be_type *bt = nullptr;
 154
 155   // Check if we are visiting this node via a visit to a typedef node.
 156   if (this->ctx_->alias ())
 157     {
 158       bt = this->ctx_->alias ();
 159     }
 160   else
 161     {
 162       bt = node;
 163     }
 164
 165   if (!field || !vb_node_)
 166     {
 167       ACE_ERROR_RETURN ((LM_ERROR,
 168                          "(%N:%l) be_visitor_valuebox_field_ci::"
 169                          "visit_enum - "
 170                          "bad context information\n"),
 171                         -1);
 172     }
 173
 174   TAO_OutStream *os = this->ctx_->stream ();
 175
 176   TAO_INSERT_COMMENT (os);
 177
 178   this->emit_member_set (field, bt, "", "");
 179   this->emit_member_get (field, bt, "", "", "const", "");
 180
 181   return 0;
 182 }
 183
 184 int
 185 be_visitor_valuebox_field_ci::visit_interface (be_interface *node)
 186 {
 187   be_decl *field = this->ctx_->node ();
 188   be_type *bt = nullptr;
 189
 190   // Check if we are visiting this node via a visit to a typedef node.
 191   if (this->ctx_->alias ())
 192     {
 193       bt = this->ctx_->alias ();
 194     }
 195   else
 196     {
 197       bt = node;
 198     }
 199
 200   if (!field || !vb_node_)
 201     {
 202       ACE_ERROR_RETURN ((LM_ERROR,
 203                          "(%N:%l) be_visitor_valuebox_field_ci::"
 204                          "visit_interface - "
 205                          "bad context information\n"),
 206                         -1);
 207     }
 208
 209   TAO_OutStream *os = this->ctx_->stream ();
 210
 211   TAO_INSERT_COMMENT (os);
 212
 213   *os << "// Modifier to set the member." << be_nl;
 214
 215   *os << "ACE_INLINE void" << be_nl
 216       << vb_node_->name () << "::" << field->local_name ()
 217       << " (" << bt->name () << "_ptr val)"
 218       << be_nl << "{" << be_idt_nl
 219       << "this->_pd_value->" << field->local_name ()
 220       << " = " << "TAO::Objref_Traits< ::" << bt->name ()
 221       << ">::duplicate (val);" << be_uidt << be_uidt_nl
 222       << "}" << be_nl_2;
 223
 224   this->emit_member_get (field, bt, "", "_ptr", "const", ".in ()");
 225
 226   return 0;
 227 }
 228
 229 int
 230 be_visitor_valuebox_field_ci::visit_interface_fwd (be_interface_fwd *node)
 231 {
 232   be_decl *field = this->ctx_->node ();
 233   be_type *bt = nullptr;
 234
 235   // Check if we are visiting this node via a visit to a typedef node.
 236   if (this->ctx_->alias ())
 237     {
 238       bt = this->ctx_->alias ();
 239     }
 240   else
 241     {
 242       bt = node;
 243     }
 244
 245   if (!field || !vb_node_)
 246     {
 247       ACE_ERROR_RETURN ((LM_ERROR,
 248                          "(%N:%l) be_visitor_valuebox_field_ci::"
 249                          "visit_interface_fwd - "
 250                          "bad context information\n"),
 251                         -1);
 252     }
 253
 254   TAO_OutStream *os = this->ctx_->stream ();
 255
 256   TAO_INSERT_COMMENT (os);
 257
 258   *os << "// Modifier to set the member." << be_nl;
 259
 260   *os << "ACE_INLINE void" << be_nl
 261       << vb_node_->name () << "::" << field->local_name ()
 262       << " (" << bt->name () << "_ptr val)"
 263       << be_nl << "{" << be_idt_nl
 264       << "this->_pd_value->" << field->local_name ()
 265       << " = " << "TAO::Objref_Traits< ::" << bt->name ()
 266       << ">::duplicate (val);" << be_uidt << be_uidt_nl
 267       << "}" << be_nl_2;
 268
 269   this->emit_member_get (field, bt, "", "_ptr", "const", ".in ()");
 270
 271   return 0;
 272 }
 273
 274 int
 275 be_visitor_valuebox_field_ci::visit_valuetype (be_valuetype *)
 276 {
 277   // Valuetype is not a valid component of a valuebox
 278   return 0;
 279 }
 280
 281 int
 282 be_visitor_valuebox_field_ci::visit_eventtype (be_eventtype *)
 283 {
 284   // Valuetype is not a valid component of a valuebox
 285   return 0;
 286 }
 287
 288 int
 289 be_visitor_valuebox_field_ci::visit_valuetype_fwd (be_valuetype_fwd *)
 290 {
 291   // Valuetype is not a valid component of a valuebox
 292   return 0;
 293 }
 294
 295 int
 296 be_visitor_valuebox_field_ci::visit_eventtype_fwd (be_eventtype_fwd *)
 297 {
 298   // Valuetype is not a valid component of a valuebox
 299   return 0;
 300 }
 301
 302 int
 303 be_visitor_valuebox_field_ci::visit_predefined_type (be_predefined_type *node)
 304 {
 305   be_decl *field = this->ctx_->node ();
 306   be_type *bt = nullptr;
 307
 308   // Check if we are visiting this node via a visit to a typedef node.
 309   if (this->ctx_->alias ())
 310     {
 311       bt = this->ctx_->alias ();
 312     }
 313   else
 314     {
 315       bt = node;
 316     }
 317
 318   if (!field || !vb_node_)
 319     {
 320       ACE_ERROR_RETURN ((LM_ERROR,
 321                          "(%N:%l) be_visitor_valuebox_field_ci::"
 322                          "visit_predefined_type - "
 323                          "bad context information\n"),
 324                         -1);
 325     }
 326
 327   TAO_OutStream *os = this->ctx_->stream ();
 328
 329   TAO_INSERT_COMMENT (os);
 330
 331   switch (node->pt ())
 332   {
 333     case AST_PredefinedType::PT_pseudo:
 334     case AST_PredefinedType::PT_object:
 335       *os << "// Modifier to set the member." << be_nl;
 336
 337       *os << "ACE_INLINE void" << be_nl
 338           << vb_node_->name () << "::" << field->local_name ()
 339           << " (::" << bt->name () << "_ptr val)"
 340           << be_nl << "{" << be_idt_nl
 341           << "this->_pd_value->" << field->local_name ()
 342           << " = ::" << bt->name() << "::_duplicate (val);" << be_uidt_nl
 343           << "}" << be_nl_2;
 344
 345       this->emit_member_get (field, bt, " ::", "_ptr", "const", ".in ()");
 346       break;
 347     case AST_PredefinedType::PT_any:
 348       this->emit_member_set (field, bt, "const ::", " &");
 349       this->emit_member_get (field, bt, "const ::", " &", "const", "");
 350       this->emit_member_get (field, bt, " ::", " &", "", "");
 351       break;
 352     case AST_PredefinedType::PT_void:
 353       break;
 354     default:
 355       this->emit_member_set (field, bt, " ::", "");
 356       this->emit_member_get (field, bt, " ::", "", "const", "");
 357       break;
 358   }
 359
 360   return 0;
 361 }
 362
 363 int
 364 be_visitor_valuebox_field_ci::visit_sequence (be_sequence *node)
 365 {
 366   be_decl *field = this->ctx_->node ();
 367   be_type *bt = nullptr;
 368
 369   // Check if we are visiting this node via a visit to a typedef node.
 370   if (this->ctx_->alias ())
 371     {
 372       bt = this->ctx_->alias ();
 373     }
 374   else
 375     {
 376       bt = node;
 377     }
 378
 379   if (!field || !vb_node_)
 380     {
 381       ACE_ERROR_RETURN ((LM_ERROR,
 382                          "(%N:%l) be_visitor_valuebox_field_ci::"
 383                          "visit_sequence - "
 384                          "bad context information\n"),
 385                         -1);
 386     }
 387
 388   TAO_OutStream *os = this->ctx_->stream ();
 389
 390   TAO_INSERT_COMMENT (os);
 391
 392   this->emit_member_set (field, bt, "const ", " &");
 393   this->emit_member_get (field, bt, "const ", " &", "const", "");
 394   this->emit_member_get (field, bt, "", " &", "", "");
 395
 396   return 0;
 397 }
 398
 399 int
 400 be_visitor_valuebox_field_ci::visit_string (be_string *node)
 401 {
 402   be_decl *field = this->ctx_->node ();
 403   be_type *bt = nullptr;
 404
 405   // Check if we are visiting this node via a visit to a typedef node.
 406   if (this->ctx_->alias ())
 407     {
 408       bt = this->ctx_->alias ();
 409     }
 410   else
 411     {
 412       bt = node;
 413     }
 414
 415   if (!field || !vb_node_)
 416     {
 417       ACE_ERROR_RETURN ((LM_ERROR,
 418                          "(%N:%l) be_visitor_valuebox_field_ci::"
 419                          "visit_predefined_type - "
 420                          "bad context information\n"),
 421                         -1);
 422     }
 423
 424   TAO_OutStream *os = this->ctx_->stream ();
 425
 426   TAO_INSERT_COMMENT (os);
 427
 428   this->emit_member_set (field, bt, "", "");
 429   this->emit_member_set (field, bt, "const ", "");
 430
 431   *os << "// Modifier to set the member." << be_nl;
 432
 433   const char *string_type = "";
 434   if (node->node_type () == AST_Decl::NT_string)
 435     {
 436       string_type = "String";
 437     }
 438   else if (node->node_type () == AST_Decl::NT_wstring)
 439     {
 440       string_type = "WString";
 441     }
 442
 443   *os << "ACE_INLINE void" << be_nl
 444       << vb_node_->name () << "::" << field->local_name ()
 445       << " (const ::CORBA::" << string_type << "_var & val)"
 446       << be_nl << "{" << be_idt_nl
 447       << "this->_pd_value->" << field->local_name ()
 448       << " = val;" << be_uidt_nl
 449       << "}" << be_nl_2;
 450
 451   this->emit_member_get (field, bt, "const ", "", "const", "");
 452
 453   return 0;
 454 }
 455
 456 int
 457 be_visitor_valuebox_field_ci::visit_structure (be_structure *node)
 458 {
 459   be_decl *field = this->ctx_->node ();
 460   be_type *bt = nullptr;
 461
 462   // Check if we are visiting this node via a visit to a typedef node.
 463   if (this->ctx_->alias ())
 464     {
 465       bt = this->ctx_->alias ();
 466     }
 467   else
 468     {
 469       bt = node;
 470     }
 471
 472   if (!field || !vb_node_)
 473     {
 474       ACE_ERROR_RETURN ((LM_ERROR,
 475                          "(%N:%l) be_visitor_valuebox_field_ci::"
 476                          "visit_structure - "
 477                          "bad context information\n"),
 478                         -1);
 479     }
 480
 481   TAO_OutStream *os = this->ctx_->stream ();
 482
 483   TAO_INSERT_COMMENT (os);
 484
 485   this->emit_member_set (field, bt, "const ", " &");
 486   this->emit_member_get (field, bt, "const ", " &", "const", "");
 487   this->emit_member_get (field, bt, "", " &", "", "");
 488
 489   return 0;
 490 }
 491
 492 int
 493 be_visitor_valuebox_field_ci::visit_typedef (be_typedef *node)
 494 {
 495   this->ctx_->alias (node);
 496   be_type *bt = node->primitive_base_type ();
 497
 498   if (!bt || (bt->accept (this) == -1))
 499     {
 500       ACE_ERROR_RETURN ((LM_ERROR,
 501                          "(%N:%l) be_visitor_valuebox_field_ci::"
 502                          "visit_typedef - "
 503                          "Bad primitive type\n"),
 504                         -1);
 505     }
 506
 507   this->ctx_->alias (nullptr);
 508   return 0;
 509 }
 510
 511 int
 512 be_visitor_valuebox_field_ci::visit_union (be_union *node)
 513 {
 514   be_decl *field = this->ctx_->node ();
 515   be_type *bt = nullptr;
 516
 517   // Check if we are visiting this node via a visit to a typedef node.
 518   if (this->ctx_->alias ())
 519     {
 520       bt = this->ctx_->alias ();
 521     }
 522   else
 523     {
 524       bt = node;
 525     }
 526
 527   if (!field || !vb_node_)
 528     {
 529       ACE_ERROR_RETURN ((LM_ERROR,
 530                          "(%N:%l) be_visitor_valuebox_field_ci::"
 531                          "visit_union - "
 532                          "bad context information\n"),
 533                         -1);
 534     }
 535
 536   TAO_OutStream *os = this->ctx_->stream ();
 537
 538   TAO_INSERT_COMMENT (os);
 539
 540   this->emit_member_set (field, bt, "const ", " &");
 541   this->emit_member_get (field, bt, "const ", " &", "const", "");
 542   this->emit_member_get (field, bt, "", " &", "", "");
 543
 544   return 0;
 545 }
 546
 547 void
 548 be_visitor_valuebox_field_ci::emit_member_set (be_decl *field,
 549                                                be_type *field_type,
 550                                                const char *const_arg,
 551                                                const char *arg_modifier)
 552 {
 553   TAO_OutStream *os = this->ctx_->stream ();
 554
 555   *os << "// Modifier to set the member." << be_nl;
 556
 557   *os << "ACE_INLINE void" << be_nl
 558       << vb_node_->name () << "::" << field->local_name ()
 559       << " (" << const_arg << field_type->name () << arg_modifier << " val)"
 560       << be_nl << "{" << be_idt_nl
 561       << "this->_pd_value->" << field->local_name ()
 562       << " = val;" << be_uidt_nl
 563       << "}" << be_nl_2;
 564 }
 565
 566 void
 567 be_visitor_valuebox_field_ci::emit_member_get (be_decl *field,
 568                                                be_type *field_type,
 569                                                const char *const_prefix,
 570                                                const char *type_suffix,
 571                                                const char *const_method,
 572                                                const char *access_modifier)
 573 {
 574   TAO_OutStream *os = this->ctx_->stream ();
 575
 576   *os << "/// Accessor to retrieve the member." << be_nl;
 577
 578   *os << "ACE_INLINE " << const_prefix << field_type->name () << type_suffix
 579       << be_nl
 580       << vb_node_->name () << "::" << field->local_name ()
 581       << " () " << const_method << be_nl
 582       << "{" << be_idt_nl
 583       << "return this->_pd_value->" << field->local_name () << access_modifier
 584       << ";" << be_uidt_nl
 585       << "}" << be_nl_2;
 586 }