TAO/TAO_IDL/ast/ast_enum.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 #include "ast_enum.h"
  66 #include "ast_enum_val.h"
  67 #include "ast_generator.h"
  68 #include "ast_visitor.h"
  69 #include "utl_identifier.h"
  70 #include "utl_err.h"
  71 #include "utl_indenter.h"
  72
  73 AST_Decl::NodeType const
  74 AST_Enum::NT = AST_Decl::NT_enum;
  75
  76 AST_Enum::AST_Enum (UTL_ScopedName *n,
  77                     bool local,
  78                     bool abstract)
  79   : COMMON_Base (local,
  80                  abstract),
  81     AST_Decl (AST_Decl::NT_enum,
  82               n),
  83     AST_Type (AST_Decl::NT_enum,
  84               n),
  85     AST_ConcreteType (AST_Decl::NT_enum,
  86                       n),
  87     UTL_Scope (AST_Decl::NT_enum),
  88     pd_enum_counter (0),
  89     member_count_ (-1)
  90 {
  91   this->size_type (AST_Type::FIXED);
  92 }
  93
  94 AST_Enum::~AST_Enum (void)
  95 {
  96 }
  97
  98 // Return the member count.
  99 int
 100 AST_Enum::member_count (void)
 101 {
 102   if (this->member_count_ == -1)
 103     {
 104       this->compute_member_count ();
 105     }
 106
 107   return this->member_count_;
 108 }
 109
 110 // Convert a numeric value to the string name
 111 UTL_ScopedName *
 112 AST_Enum::value_to_name (const unsigned long v)
 113 {
 114   AST_EnumVal *item = 0;
 115   AST_Decl *d = 0;
 116
 117   for (UTL_ScopeActiveIterator i (this, IK_decls); !i.is_done (); i.next ())
 118     {
 119       d = i.item  ();
 120       item = dynamic_cast<AST_EnumVal*> (d);
 121
 122       if (item->constant_value ()->ev ()->u.ulval == v)
 123         {
 124           return item->name ();
 125         }
 126     }
 127
 128   return 0;
 129 }
 130
 131 // Look up an enumerator by the value of the supplied expression.
 132 AST_EnumVal *
 133 AST_Enum::lookup_by_value (const AST_Expression *v)
 134 {
 135   AST_EnumVal *item = 0;
 136   AST_Decl *d = 0;
 137
 138   for (UTL_ScopeActiveIterator i (this, IK_decls);
 139        !i.is_done ();
 140        i.next ())
 141     {
 142       d = i.item ();
 143       item = dynamic_cast<AST_EnumVal*> (d);
 144       AST_Expression *cv = item->constant_value ();
 145
 146       if (cv == v)
 147         {
 148           return item;
 149         }
 150
 151       // Enum union label expressions don't get evaluated upon
 152       // creation, to evaluate them later, we have only the
 153       // string name to look up the enum value with.
 154       UTL_ScopedName *v_n = const_cast<AST_Expression *> (v)->n ();
 155
 156       if (v_n != 0)
 157         {
 158           Identifier *cv_i = item->local_name ();
 159           Identifier *v_i = v_n->last_component ();
 160
 161           if (cv_i->compare (v_i))
 162             {
 163               return item;
 164             }
 165         }
 166     }
 167
 168   return 0;
 169 }
 170
 171 // Compute the value to be assigned to the next enumerator. Bump the
 172 // counter.
 173 unsigned long
 174 AST_Enum::next_enum_val (void)
 175 {
 176   unsigned long i = pd_enum_counter++;
 177
 178   return i;
 179 }
 180
 181 // Static helper functions
 182
 183 // Modify scoped name of an enumval so that it is scoped inside the scope
 184 // in which the enum is defined and not inside the enum itself
 185 static UTL_ScopedName *
 186 munge_name_for_enumval (UTL_ScopedName *n,
 187                         Identifier *last_component)
 188 {
 189   long len = n->length ();
 190   UTL_ScopedName *hold = n;
 191
 192   // Last three components are:
 193   // - scope in which enum is defined
 194   // - scope for enum
 195   // - name of enumval
 196
 197   // We want to stop cdr'ing down the list when the head of the
 198   // list is at the name for the scope in which the enum is defined.
 199   while (len > 3)
 200     {
 201       len--;
 202       n = (UTL_ScopedName *) n->tail ();
 203     }
 204
 205   UTL_IdList *id = 0;
 206   ACE_NEW_RETURN (id,
 207                   UTL_IdList (last_component->copy (),
 208                               0),
 209                   0);
 210
 211   n->set_tail (id);
 212
 213   return hold;
 214 }
 215
 216 // Compute total number of members.
 217 int
 218 AST_Enum::compute_member_count (void)
 219 {
 220   this->member_count_ = 0;
 221
 222   // If there are elements in this scope
 223   if (this->nmembers () > 0)
 224     {
 225       for (UTL_ScopeActiveIterator i (this, IK_decls);
 226            !i.is_done ();
 227            i.next ())
 228         {
 229           // Get the next AST decl node.
 230           ++this->member_count_;
 231         }
 232     }
 233
 234   return 0;
 235 }
 236
 237 AST_EnumVal *
 238 AST_Enum::fe_add_enum_val (AST_EnumVal *t)
 239 {
 240   AST_Decl *d = 0;
 241   AST_EnumVal *t1 = 0;
 242
 243   AST_Expression::AST_ExprValue *ev =
 244     t->constant_value ()->coerce (AST_Expression::EV_ulong);
 245
 246   t1 = idl_global->gen ()->create_enum_val (ev->u.ulval,
 247                                             t->name ());
 248
 249   delete ev;
 250   ev = 0;
 251
 252   UTL_ScopedName *sn =
 253     munge_name_for_enumval ((UTL_IdList *) t->name ()->copy (),
 254                             t->local_name ());
 255
 256   t->set_name (sn);
 257
 258   sn = munge_name_for_enumval ((UTL_IdList *) t1->name ()->copy (),
 259                                 t1->local_name ());
 260
 261   t1->set_name (sn);
 262
 263   // Already defined and cannot be redefined? Or already used?
 264   if ((d = this->lookup_for_add (t)) != 0)
 265     {
 266       if (!FE_Utils::can_be_redefined (d, t))
 267         {
 268           idl_global->err ()->error3 (UTL_Error::EIDL_REDEF,
 269                                       t,
 270                                       this,
 271                                       d);
 272           return 0;
 273         }
 274
 275       if (this->referenced (d, t->local_name ()))
 276         {
 277           idl_global->err ()->error3 (UTL_Error::EIDL_DEF_USE,
 278                                       t,
 279                                       this,
 280                                       d);
 281           return 0;
 282         }
 283
 284       if (t->has_ancestor (d))
 285         {
 286           idl_global->err ()->redefinition_in_scope (t,
 287                                                      d);
 288           return 0;
 289         }
 290     }
 291
 292   // Add it to scope.
 293   this->add_to_scope (t);
 294
 295   // Add it to set of locally referenced symbols.
 296   this->add_to_referenced (t,
 297                            false,
 298                            t->local_name ());
 299
 300   if (t1 == 0)
 301     {
 302       // Prevent dereferencing null pointer in nested calls.
 303       return 0;
 304     }
 305
 306   // Add it to enclosing scope.
 307   idl_global->scopes ().next_to_top ()->fe_add_enum_val (t1);
 308
 309   return t;
 310 }
 311
 312 // Redefinition of inherited virtual operations.
 313
 314 // Dump this AST_Enum to the ostream o
 315 void
 316 AST_Enum::dump (ACE_OSTREAM_TYPE &o)
 317 {
 318   AST_Decl *d = 0;
 319
 320   if (this->is_local ())
 321     {
 322       this->dump_i (o, "(local) ");
 323     }
 324   else if (this->is_abstract ())
 325     {
 326       this->dump_i (o, "(abstract) ");
 327     }
 328
 329   this->dump_i (o, "enum ");
 330
 331   this->local_name ()->dump (o);
 332
 333   this->dump_i (o, " {\n");
 334   idl_global->indent ()->increase ();
 335   idl_global->indent ()->skip_to (o);
 336
 337   // Must increment the iterator explicitly inside the loop.
 338   for (UTL_ScopeActiveIterator i (this, IK_decls);!i.is_done ();)
 339     {
 340       d = i.item ();
 341       d->dump_annotations (o, true /* print inline */);
 342       d->local_name ()->dump (o);
 343       i.next ();
 344
 345       if (i.is_done ())
 346         {
 347           this->dump_i (o, "\n");
 348         }
 349       else
 350         {
 351           this->dump_i (o, ",\n");
 352           idl_global->indent ()->skip_to (o);
 353         }
 354     }
 355
 356   idl_global->indent ()->decrease ();
 357   idl_global->indent ()->skip_to (o);
 358
 359   this->dump_i (o, "}");
 360 }
 361
 362 int
 363 AST_Enum::ast_accept (ast_visitor *visitor)
 364 {
 365   return visitor->visit_enum (this);
 366 }
 367
 368 void
 369 AST_Enum::destroy (void)
 370 {
 371   this->UTL_Scope::destroy ();
 372   this->AST_ConcreteType::destroy ();
 373 }
 374
 375
 376
 377
 378 IMPL_NARROW_FROM_DECL(AST_Enum)
 379 IMPL_NARROW_FROM_SCOPE(AST_Enum)