TAO/TAO_IDL/be/be_visitor_array/array_cs.cpp

   1
   2 //=============================================================================
   3 /**
   4  *  @file    array_cs.cpp
   5  *
   6  *  Visitor for code generation of Arrays in the client stubs
   7  *
   8  *  @author Aniruddha Gokhale
   9  */
  10 //=============================================================================
  11
  12 #include "array.h"
  13
  14 be_visitor_array_cs::be_visitor_array_cs (be_visitor_context *ctx)
  15   : be_visitor_array (ctx)
  16 {
  17 }
  18
  19 int be_visitor_array_cs::visit_array (be_array *node)
  20 {
  21   // Nothing to do if we are imported or code is already generated.
  22   if (node->imported () || (node->cli_stub_gen ()))
  23     {
  24       return 0;
  25     }
  26
  27   TAO_OutStream *os = this->ctx_->stream ();
  28   ACE_CDR::ULong i;
  29   this->ctx_->node (node);
  30
  31   // Retrieve the type.
  32   be_type *bt = dynamic_cast<be_type*> (node->base_type ());
  33
  34   if (!bt)
  35     {
  36       ACE_ERROR_RETURN ((LM_ERROR,
  37                          "be_visitor_array_cs::"
  38                          "visit_array - "
  39                          "Bad base type\n"),
  40                         -1);
  41     }
  42
  43   // To hold the full and local.
  44   char fname [NAMEBUFSIZE];
  45   char lname [NAMEBUFSIZE];
  46   ACE_OS::memset (fname,
  47                   '\0',
  48                   NAMEBUFSIZE);
  49   ACE_OS::memset (lname,
  50                   '\0',
  51                   NAMEBUFSIZE);
  52
  53   if (this->ctx_->tdef ())
  54     {
  55       // Typedefed node.
  56       ACE_OS::sprintf (fname, "%s",
  57                        node->full_name ());
  58       ACE_OS::sprintf (lname, "%s",
  59                        node->local_name ()->get_string ());
  60     }
  61   else
  62     {
  63       // For anonymous arrays ...
  64       // we have to generate a name for us that has an underscope prepended to
  65       // our local name. This needs to be inserted after the parents's name.
  66       if (node->is_nested ())
  67         {
  68           be_decl *parent =
  69             dynamic_cast<be_scope*> (node->defined_in ())->decl ();
  70           ACE_OS::sprintf (fname,
  71                            "%s::_%s",
  72                            parent->full_name (),
  73                            node->local_name ()->get_string ());
  74           ACE_OS::sprintf (lname,
  75                            "_%s",
  76                            node->local_name ()->get_string ());
  77         }
  78       else
  79         {
  80           ACE_OS::sprintf (fname,
  81                            "_%s",
  82                            node->full_name ());
  83           ACE_OS::sprintf (lname,
  84                            "_%s",
  85                            node->local_name ()->get_string ());
  86         }
  87     }
  88
  89   TAO_INSERT_COMMENT (os);
  90
  91   // dup method.
  92   *os << fname << "_slice *" << be_nl
  93       << fname << "_dup (const " << fname
  94       << "_slice *_tao_src_array)" << be_nl;
  95   *os << "{" << be_idt_nl;
  96   *os << fname << "_slice *_tao_dup_array = "
  97       << fname << "_alloc ();" << be_nl << be_nl;
  98   *os << "if (_tao_dup_array)" << be_idt_nl
  99       << "{" << be_idt_nl;
 100   *os << fname << "_copy (_tao_dup_array, _tao_src_array);" << be_uidt_nl
 101       << "}" << be_uidt_nl << be_nl;
 102   *os << "return _tao_dup_array;" << be_uidt_nl;
 103   *os << "}" << be_nl_2;
 104
 105   // alloc method.
 106   *os << fname << "_slice *" << be_nl;
 107   *os << fname << "_alloc ()" << be_nl;
 108   *os << "{" << be_idt_nl;
 109   *os << fname << "_slice *retval {};" << be_nl;
 110   *os << "ACE_NEW_RETURN (retval, ";
 111
 112   if (bt->accept (this) == -1)
 113     {
 114       ACE_ERROR_RETURN ((LM_ERROR,
 115                          "be_visitor_array_cs::"
 116                          "visit_array - "
 117                          "base type decl failed\n"),
 118                         -1);
 119     }
 120
 121   if (node->gen_dimensions (os) == -1)
 122     {
 123       ACE_ERROR_RETURN ((LM_ERROR,
 124                          "(%N:%l) be_visitor_array_cs::"
 125                          "visit_array - "
 126                          "dimensions codegen failed\n"),
 127                         -1);
 128     }
 129
 130   *os << ", nullptr);" << be_nl;
 131   *os << "return retval;" << be_uidt_nl;
 132   *os << "}" << be_nl_2;
 133
 134   // free method.
 135   *os << "void" << be_nl
 136       << fname << "_free (" << fname << "_slice *_tao_slice)"
 137       << be_nl;
 138   *os << "{" << be_idt_nl;
 139   *os << "delete [] _tao_slice;" << be_uidt_nl;
 140   *os << "}" << be_nl_2;
 141
 142   // copy method.
 143   *os << "void" << be_nl;
 144   *os << fname << "_copy (" << be_idt << be_idt_nl
 145       << fname << "_slice * _tao_to," << be_nl
 146       << "const " << fname << "_slice *_tao_from)" << be_uidt
 147       << be_uidt_nl;
 148   *os << "{" << be_idt_nl;
 149   *os << "// Copy each individual element." << be_nl;
 150
 151   ACE_CDR::ULong ndims = node->n_dims ();
 152
 153   // Generate nested loops for as many dimensions as there are.
 154   for (i = 0; i < ndims; ++i)
 155     {
 156       // Retrieve the ith dimension value.
 157       AST_Expression *expr = node->dims ()[i];
 158
 159       if ((expr == nullptr) || ((expr != nullptr) && (expr->ev () == nullptr)))
 160         {
 161           ACE_ERROR_RETURN ((LM_ERROR,
 162                              "(%N:%l) be_visitor_array_cs::"
 163                              "visit_array - "
 164                              "bad array dimension\n"),
 165                             -1);
 166         }
 167
 168       if (expr->ev ()->et == AST_Expression::EV_ulong)
 169         {
 170           // Generate a loop for each dimension.
 171           *os << "for (::CORBA::ULong i" << i << " = 0; i" << i << " < "
 172               << expr->ev ()->u.ulval << "; ++i" << i << ")" << be_idt_nl
 173               << "{" << be_idt_nl;
 174         }
 175       else
 176         {
 177           ACE_ERROR_RETURN ((LM_ERROR,
 178                              "(%N:%l) be_visitor_array_cs::"
 179                              "visit_array - "
 180                              "bad array dimension value\n"),
 181                             -1);
 182         }
 183     }
 184
 185   // Now generate code such that every element of the array gets assigned
 186   // inside the innermost level of the  nested loops generated above.
 187   be_array *primitive_type = nullptr;
 188
 189   if (bt->node_type () == AST_Decl::NT_typedef)
 190     {
 191       // Base type of the array node is a typedef. We need to make sure that
 192       // this typedef is not to another array type. If it is, then we cannot
 193       // assign an array to another. We will have to invoke the underlying
 194       // array type's copy method for every array dimension.
 195
 196       // There may be more than one level of typedef.
 197       be_type *tmp = bt;
 198
 199       while (tmp->node_type () == AST_Decl::NT_typedef)
 200         {
 201           be_typedef *tdef = dynamic_cast<be_typedef*> (tmp);
 202           tmp = dynamic_cast<be_type*> (tdef->base_type ());
 203         }
 204
 205       primitive_type = dynamic_cast<be_array*> (tmp);
 206     }
 207
 208   if (primitive_type != nullptr)
 209     {
 210       // The base type is a typedef to another array type, so
 211       // we use the base type's copy method.
 212       *os << "// call the underlying _copy" << be_nl;
 213
 214       if (bt->accept (this) == -1)
 215         {
 216           ACE_ERROR_RETURN ((LM_ERROR,
 217                              "be_visitor_array_cs::"
 218                              "visit_array - "
 219                              "base type decl failed\n"),
 220                             -1);
 221         }
 222
 223       *os << "_copy (_tao_to";
 224
 225       for (i = 0; i < ndims; ++i)
 226         {
 227           *os << "[i" << i << "]";
 228         }
 229
 230       *os << ", ";
 231       *os << "_tao_from";
 232
 233       for (i = 0; i < ndims; ++i)
 234         {
 235           *os << "[i" << i << "]";
 236         }
 237
 238       *os << ");";
 239     }
 240   else
 241     {
 242       // The base type is not a typedef to possibly another array type. In
 243       // such a case, assign each element.
 244
 245       *os << "_tao_to";
 246
 247       for (i = 0; i < ndims; ++i)
 248         {
 249           *os << "[i" << i << "]";
 250         }
 251
 252       *os << " = ";
 253       *os << "_tao_from";
 254
 255       for (i = 0; i < ndims; ++i)
 256         {
 257           *os << "[i" << i << "]";
 258         }
 259
 260       *os << ";";
 261     }
 262
 263   for (i = 0; i < ndims; ++i)
 264     {
 265       // Add closing braces as many times as the number of dimensions.
 266       *os << be_uidt_nl << "}" << be_uidt;
 267     }
 268
 269   *os << be_uidt_nl << "}";
 270
 271   AST_Decl::NodeType nt = bt->node_type ();
 272
 273   // If we contain an anonymous sequence,
 274   // generate code for the sequence here.
 275   if (nt == AST_Decl::NT_sequence)
 276     {
 277       if (this->gen_anonymous_base_type (bt,
 278                                          TAO_CodeGen::TAO_ROOT_CS)
 279           == -1)
 280         {
 281           ACE_ERROR_RETURN ((LM_ERROR,
 282                              "(%N:%l) be_visitor_array_cs::"
 283                              "visit_array - "
 284                              "gen_anonymous_base_type failed\n"),
 285                             -1);
 286         }
 287     }
 288
 289   // If the member's element type
 290   // is a declaration (not a reference), we must generate code for
 291   // the declaration.
 292   if (this->ctx_->alias () == nullptr // Not a typedef.
 293       && bt->is_child (this->ctx_->scope ()->decl ()))
 294     {
 295       int status = 0;
 296       be_visitor_context ctx (*this->ctx_);
 297
 298       switch (nt)
 299       {
 300         case AST_Decl::NT_enum:
 301           {
 302             be_visitor_enum_cs ec_visitor (&ctx);
 303             status = bt->accept (&ec_visitor);
 304             break;
 305           }
 306         case AST_Decl::NT_struct:
 307           {
 308             be_visitor_structure_cs sc_visitor (&ctx);
 309             status = bt->accept (&sc_visitor);
 310             break;
 311           }
 312         case AST_Decl::NT_union:
 313           {
 314             be_visitor_union_cs uc_visitor (&ctx);
 315             status = bt->accept (&uc_visitor);
 316             break;
 317           }
 318         default:
 319           break;
 320       }
 321
 322       if (status == -1)
 323         {
 324           ACE_ERROR_RETURN ((LM_ERROR,
 325                              "(%N:%l) be_visitor_array_ch::"
 326                              "visit_array - "
 327                              "array base type codegen failed\n"),
 328                             -1);
 329         }
 330     }
 331
 332   node->cli_stub_gen (true);
 333   return 0;
 334 }
 335