TAO/TAO_IDL/include/ast_union_branch.h

   1 // This may look like C, but it's really -*- C++ -*-
   2 /*
   3
   4 COPYRIGHT
   5
   6 Copyright 1992, 1993, 1994 Sun Microsystems, Inc.  Printed in the United
   7 States of America.  All Rights Reserved.
   8
   9 This product is protected by copyright and distributed under the following
  10 license restricting its use.
  11
  12 The Interface Definition Language Compiler Front End (CFE) is made
  13 available for your use provided that you include this license and copyright
  14 notice on all media and documentation and the software program in which
  15 this product is incorporated in whole or part. You may copy and extend
  16 functionality (but may not remove functionality) of the Interface
  17 Definition Language CFE without charge, but you are not authorized to
  18 license or distribute it to anyone else except as part of a product or
  19 program developed by you or with the express written consent of Sun
  20 Microsystems, Inc. ("Sun").
  21
  22 The names of Sun Microsystems, Inc. and any of its subsidiaries or
  23 affiliates may not be used in advertising or publicity pertaining to
  24 distribution of Interface Definition Language CFE as permitted herein.
  25
  26 This license is effective until terminated by Sun for failure to comply
  27 with this license.  Upon termination, you shall destroy or return all code
  28 and documentation for the Interface Definition Language CFE.
  29
  30 INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED AS IS WITH NO WARRANTIES OF
  31 ANY KIND INCLUDING THE WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS
  32 FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR ARISING FROM A COURSE OF
  33 DEALING, USAGE OR TRADE PRACTICE.
  34
  35 INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED WITH NO SUPPORT AND WITHOUT
  36 ANY OBLIGATION ON THE PART OF Sun OR ANY OF ITS SUBSIDIARIES OR AFFILIATES
  37 TO ASSIST IN ITS USE, CORRECTION, MODIFICATION OR ENHANCEMENT.
  38
  39 SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES SHALL HAVE NO LIABILITY WITH
  40 RESPECT TO THE INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY
  41 INTERFACE DEFINITION LANGUAGE CFE OR ANY PART THEREOF.
  42
  43 IN NO EVENT WILL SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES BE LIABLE FOR
  44 ANY LOST REVENUE OR PROFITS OR OTHER SPECIAL, INDIRECT AND CONSEQUENTIAL
  45 DAMAGES, EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  46
  47 Use, duplication, or disclosure by the government is subject to
  48 restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in
  49 Technical Data and Computer Software clause at DFARS 252.227-7013 and FAR
  50 52.227-19.
  51
  52 Sun, Sun Microsystems and the Sun logo are trademarks or registered
  53 trademarks of Sun Microsystems, Inc.
  54
  55 SunSoft, Inc.
  56 2550 Garcia Avenue
  57 Mountain View, California  94043
  58
  59 NOTE:
  60
  61 SunOS, SunSoft, Sun, Solaris, Sun Microsystems or the Sun logo are
  62 trademarks or registered trademarks of Sun Microsystems, Inc.
  63
  64 */
  65
  66 #ifndef _AST_UNION_BRANCH_AST_UNION_BRAN_HH
  67 #define _AST_UNION_BRANCH_AST_UNION_BRAN_HH
  68
  69 #include "ast_field.h"
  70 #include "utl_scoped_name.h"
  71
  72 class UTL_LabelList;
  73 class AST_Type;
  74 class AST_UnionLabel;
  75 class AST_Union;
  76
  77 // Representation of union branch declaration.
  78 // A branch of a union is a field with a label.
  79
  80 class TAO_IDL_FE_Export AST_UnionBranch : public virtual AST_Field
  81 {
  82 public:
  83   AST_UnionBranch (UTL_LabelList *ll,
  84                    AST_Type *ft,
  85                    UTL_ScopedName *n);
  86
  87   virtual ~AST_UnionBranch (void);
  88
  89   UTL_LabelList *labels (void) const;
  90
  91   AST_UnionLabel *label (unsigned long index = 0);
  92
  93   unsigned long label_list_length (void);
  94
  95   // Called if our labels are enum values - adds them to the
  96   // enclosing scope's name_referenced list.
  97   void add_labels (AST_Union *u);
  98
  99   // Integer literals create a ulonglong AST_Expression. If
 100   // our union's discriminator type is some other kind of
 101   // integer, and we have more than one label, only the first
 102   // one gets coerced in the lookup for add of the branch. So
 103   // we call this at the end of fe_add_union_branch.
 104   void coerce_labels (AST_Union *u);
 105
 106   // Narrowing.
 107
 108   DEF_NARROW_FROM_DECL (AST_UnionBranch);
 109
 110   // AST Dumping.
 111   virtual void dump (ACE_OSTREAM_TYPE &o);
 112
 113   // Visiting.
 114   virtual int ast_accept (ast_visitor *visitor);
 115
 116   // Cleanup.
 117   virtual void destroy (void);
 118
 119   static AST_Decl::NodeType const NT;
 120
 121   virtual bool auto_dump_annotations () const { return false; }
 122
 123 private:
 124   // list of labels.
 125   UTL_LabelList *pd_ll;
 126 };
 127
 128 #endif           // _AST_UNION_BRANCH_AST_UNION_BRAN_HH