TAO/TAO_IDL/include/ast_sequence.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_SEQUENCE_AST_SEQUENCE_HH
  67 #define _AST_SEQUENCE_AST_SEQUENCE_HH
  68
  69 #include "ast_concrete_type.h"
  70
  71
  72 class AST_Expression;
  73 class AST_Type;
  74
  75 class TAO_IDL_FE_Export AST_Sequence : public virtual AST_ConcreteType
  76 {
  77 public:
  78   AST_Sequence (AST_Expression *max_size,
  79                 AST_Type *bt,
  80                 UTL_ScopedName *n,
  81                 bool local,
  82                 bool abstract);
  83
  84   virtual ~AST_Sequence (void);
  85
  86   virtual bool in_recursion (ACE_Unbounded_Queue<AST_Type *> &list);
  87   // Are we or the node represented by node involved in recursion.
  88
  89   // Data Accessors.
  90   AST_Expression *max_size (void);
  91
  92   AST_Type *base_type (void) const;
  93
  94   /**
  95    * Returns the fully dealiased base type if it's a typedef. If it's not a
  96    * typedef, the it returns the same value as as base_type().
  97    */
  98   AST_Type *primitive_base_type () const;
  99
 100   virtual bool unbounded (void) const;
 101   // Is this sequence bounded or not.
 102
 103   // Recursively called on valuetype to check for legal use as
 104   // a primary key. Overridden for valuetype, struct, sequence,
 105   // union, array, typedef, and interface.
 106   virtual bool legal_for_primary_key (void) const;
 107
 108   // Is the element type a forward declared struct or union
 109   // that hasn't yet been fully defined?
 110   virtual bool is_defined (void);
 111
 112   // Cleanup method.
 113   virtual void destroy (void);
 114
 115   // Narrowing.
 116
 117   DEF_NARROW_FROM_DECL(AST_Sequence);
 118
 119   // AST Dumping.
 120   virtual void dump (ACE_OSTREAM_TYPE &o);
 121
 122   // Visiting.
 123   virtual int ast_accept (ast_visitor *visitor);
 124
 125   static AST_Decl::NodeType const NT;
 126
 127   /**
 128    * Get and Set Annotations on the base type
 129    */
 130   ///{
 131   AST_Annotation_Appls &base_type_annotations ();
 132   void base_type_annotations (const AST_Annotation_Appls &annotations);
 133   ///}
 134
 135 private:
 136   // Data.
 137   AST_Expression *pd_max_size;
 138   // Maximum sequence size.
 139
 140   AST_Type *pd_base_type;
 141   // Sequence base type.
 142
 143   bool unbounded_;
 144   // Whether we are bounded or unbounded.
 145
 146   bool owns_base_type_;
 147   // If our base type is anonymous array or sequence, we're
 148   // responsible for destroying it.
 149
 150   /**
 151    * Annotations on the base type
 152    */
 153   AST_Annotation_Appls base_type_annotations_;
 154 };
 155
 156 #endif           // _AST_SEQUENCE_AST_SEQUENCE_HH