TAO/TAO_IDL/ast/ast_sequence.cpp

   1 /*
   2
   3 COPYRIGHT
   4
   5 Copyright 1992, 1993, 1994 Sun Microsystems, Inc.  Printed in the United
   6 States of America.  All Rights Reserved.
   7
   8 This product is protected by copyright and distributed under the following
   9 license restricting its use.
  10
  11 The Interface Definition Language Compiler Front End (CFE) is made
  12 available for your use provided that you include this license and copyright
  13 notice on all media and documentation and the software program in which
  14 this product is incorporated in whole or part. You may copy and extend
  15 functionality (but may not remove functionality) of the Interface
  16 Definition Language CFE without charge, but you are not authorized to
  17 license or distribute it to anyone else except as part of a product or
  18 program developed by you or with the express written consent of Sun
  19 Microsystems, Inc. ("Sun").
  20
  21 The names of Sun Microsystems, Inc. and any of its subsidiaries or
  22 affiliates may not be used in advertising or publicity pertaining to
  23 distribution of Interface Definition Language CFE as permitted herein.
  24
  25 This license is effective until terminated by Sun for failure to comply
  26 with this license.  Upon termination, you shall destroy or return all code
  27 and documentation for the Interface Definition Language CFE.
  28
  29 INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED AS IS WITH NO WARRANTIES OF
  30 ANY KIND INCLUDING THE WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS
  31 FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR ARISING FROM A COURSE OF
  32 DEALING, USAGE OR TRADE PRACTICE.
  33
  34 INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED WITH NO SUPPORT AND WITHOUT
  35 ANY OBLIGATION ON THE PART OF Sun OR ANY OF ITS SUBSIDIARIES OR AFFILIATES
  36 TO ASSIST IN ITS USE, CORRECTION, MODIFICATION OR ENHANCEMENT.
  37
  38 SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES SHALL HAVE NO LIABILITY WITH
  39 RESPECT TO THE INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY
  40 INTERFACE DEFINITION LANGUAGE CFE OR ANY PART THEREOF.
  41
  42 IN NO EVENT WILL SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES BE LIABLE FOR
  43 ANY LOST REVENUE OR PROFITS OR OTHER SPECIAL, INDIRECT AND CONSEQUENTIAL
  44 DAMAGES, EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  45
  46 Use, duplication, or disclosure by the government is subject to
  47 restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in
  48 Technical Data and Computer Software clause at DFARS 252.227-7013 and FAR
  49 52.227-19.
  50
  51 Sun, Sun Microsystems and the Sun logo are trademarks or registered
  52 trademarks of Sun Microsystems, Inc.
  53
  54 SunSoft, Inc.
  55 2550 Garcia Avenue
  56 Mountain View, California  94043
  57
  58 NOTE:
  59
  60 SunOS, SunSoft, Sun, Solaris, Sun Microsystems or the Sun logo are
  61 trademarks or registered trademarks of Sun Microsystems, Inc.
  62
  63 */
  64
  65 // AST_Sequence nodes represent IDL sequence declarations.
  66 // AST_Sequence is a subclass of AST_ConcreteType.
  67 // AST_Sequence nodes have a maximum size (an AST_Expression which
  68 // must evaluate to a positive integer) and a base type (a subclass
  69 // of AST_Type).
  70
  71 #include "ast_sequence.h"
  72 #include "ast_typedef.h"
  73 #include "ast_expression.h"
  74 #include "ast_param_holder.h"
  75 #include "ast_visitor.h"
  76 #include "ast_annotation_appl.h"
  77
  78 #include "utl_identifier.h"
  79 #include "utl_err.h"
  80
  81 #include "global_extern.h"
  82 #include "fe_extern.h"
  83
  84 #include "ace/Log_Msg.h"
  85 #include "ace/OS_Memory.h"
  86 #include "ace/OS_NS_string.h"
  87
  88 AST_Decl::NodeType const
  89 AST_Sequence::NT = AST_Decl::NT_sequence;
  90
  91 AST_Sequence::AST_Sequence (AST_Expression *ms,
  92                             AST_Type *bt,
  93                             UTL_ScopedName *n,
  94                             bool local,
  95                             bool abstract)
  96   : COMMON_Base (bt->is_local () || local,
  97                  abstract),
  98     AST_Decl (AST_Decl::NT_sequence,
  99               n,
 100               true),
 101     AST_Type (AST_Decl::NT_sequence,
 102               n),
 103     AST_ConcreteType (AST_Decl::NT_sequence,
 104                       n),
 105     pd_max_size (ms),
 106     pd_base_type (bt),
 107     unbounded_ (true),
 108     owns_base_type_ (false)
 109 {
 110   FE_Utils::tmpl_mod_ref_check (this, bt);
 111
 112   AST_Decl::NodeType bnt = bt->node_type ();
 113
 114   if (bnt == AST_Decl::NT_param_holder)
 115     {
 116       AST_Param_Holder *ph = dynamic_cast<AST_Param_Holder*> (bt);
 117
 118       if (ph->info ()->type_ == AST_Decl::NT_const)
 119         {
 120           idl_global->err ()->not_a_type (bt);
 121           bt->destroy ();
 122           delete bt;
 123           bt = 0;
 124           throw Bailout ();
 125         }
 126     }
 127
 128   // Check if we are bounded or unbounded. An expression value of 0 means
 129   // unbounded. If our bound is a template parameter, skip the
 130   // check altogether, this node will trigger no code generation.
 131   if (ms->param_holder () == 0)
 132     {
 133       this->unbounded_ = (ms->ev ()->u.ulval == 0);
 134     }
 135
 136   // A sequence data type is always VARIABLE.
 137   this->size_type (AST_Type::VARIABLE);
 138
 139   AST_Decl::NodeType nt = bt->node_type ();
 140
 141   this->owns_base_type_ =
 142     nt == AST_Decl::NT_array
 143     || nt == AST_Decl::NT_sequence
 144     || nt == AST_Decl::NT_param_holder;
 145 }
 146
 147 AST_Sequence::~AST_Sequence (void)
 148 {
 149 }
 150
 151 // Public operations.
 152
 153 bool
 154 AST_Sequence::in_recursion (ACE_Unbounded_Queue<AST_Type *> &list)
 155 {
 156   if (list.size () == 0) // only structs, unions and valuetypes can be recursive
 157     return false;
 158
 159   list.enqueue_tail(this);
 160
 161   AST_Type *type = dynamic_cast<AST_Type*> (this->base_type ());
 162
 163   if (type == 0)
 164     {
 165       ACE_ERROR_RETURN ((LM_ERROR,
 166                          ACE_TEXT ("AST_Sequence::in_recursion - ")
 167                          ACE_TEXT ("bad base type\n")),
 168                         false);
 169     }
 170
 171   AST_Decl::NodeType nt = type->node_type ();
 172
 173   if (nt == AST_Decl::NT_typedef)
 174     {
 175       AST_Typedef *td = dynamic_cast<AST_Typedef*> (type);
 176       type = td->primitive_base_type ();
 177       nt = type->node_type ();
 178     }
 179
 180   if (nt != AST_Decl::NT_struct
 181       && nt != AST_Decl::NT_union
 182       && nt != AST_Decl::NT_valuetype
 183       && nt != AST_Decl::NT_sequence)
 184     {
 185       return false;
 186     }
 187
 188   bool recursion_found = false;
 189   AST_Type** recursable_type = 0;
 190   list.get (recursable_type, 0);
 191   if (!ACE_OS::strcmp (type->full_name (),
 192                            (*recursable_type)->full_name ()))
 193     {
 194       // They match.
 195       recursion_found = true;
 196       idl_global->recursive_type_seen_ = true;
 197     }
 198   else
 199     {
 200       // Check the element type.
 201       recursion_found = type->in_recursion (list);
 202     }
 203
 204   return recursion_found;
 205 }
 206
 207 // Redefinition of inherited virtual operations.
 208
 209 // Dump this AST_Sequence node to the ostream o.
 210 void
 211 AST_Sequence::dump (ACE_OSTREAM_TYPE &o)
 212 {
 213   this->dump_i (o, "sequence <");
 214   AST_Annotation_Appls::iterator i,
 215     finished = base_type_annotations ().end ();
 216   for (i = base_type_annotations ().begin (); i != finished; ++i)
 217     {
 218       AST_Annotation_Appl *a = i->get ();
 219       a->dump (o);
 220       dump_i (o, " ");
 221     }
 222   this->pd_base_type->dump (o);
 223   this->dump_i (o, ", ");
 224   this->pd_max_size->dump (o);
 225   this->dump_i (o, ">");
 226 }
 227
 228 int
 229 AST_Sequence::ast_accept (ast_visitor *visitor)
 230 {
 231   return visitor->visit_sequence (this);
 232 }
 233
 234 // Data accessors.
 235
 236 AST_Expression *
 237 AST_Sequence::max_size (void)
 238 {
 239   return this->pd_max_size;
 240 }
 241
 242 AST_Type *
 243 AST_Sequence::base_type (void) const
 244 {
 245   return this->pd_base_type;
 246 }
 247
 248 AST_Type *
 249 AST_Sequence::primitive_base_type () const
 250 {
 251   AST_Type *type_node = base_type ();
 252   if (type_node && type_node->node_type () == AST_Decl::NT_typedef)
 253     {
 254       AST_Typedef *const typedef_node = dynamic_cast<AST_Typedef *> (type_node);
 255       if (!typedef_node) return 0;
 256       type_node = typedef_node->primitive_base_type ();
 257     }
 258   return type_node;
 259 }
 260
 261 bool
 262 AST_Sequence::unbounded (void) const
 263 {
 264   return this->unbounded_;
 265 }
 266
 267 bool
 268 AST_Sequence::legal_for_primary_key (void) const
 269 {
 270   return this->base_type ()->legal_for_primary_key ();
 271 }
 272
 273 bool
 274 AST_Sequence::is_defined (void)
 275 {
 276   return this->pd_base_type->is_defined ();
 277 }
 278
 279 void
 280 AST_Sequence::destroy (void)
 281 {
 282   if (this->owns_base_type_)
 283     {
 284       this->pd_base_type->destroy ();
 285       delete this->pd_base_type;
 286       this->pd_base_type = 0;
 287     }
 288
 289   this->pd_max_size->destroy ();
 290   delete this->pd_max_size;
 291   this->pd_max_size = 0;
 292
 293   this->AST_ConcreteType::destroy ();
 294 }
 295
 296 IMPL_NARROW_FROM_DECL(AST_Sequence)
 297
 298 AST_Annotation_Appls &
 299 AST_Sequence::base_type_annotations ()
 300 {
 301   return base_type_annotations_;
 302 }
 303
 304 void
 305 AST_Sequence::base_type_annotations (const AST_Annotation_Appls &annotations)
 306 {
 307   base_type_annotations_ = annotations;
 308 }