TAO/TAO_IDL/include/ast_field.h

   1 // -*- 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_FIELD_AST_FIELD_HH
  67 #define _AST_FIELD_AST_FIELD_HH
  68
  69 // Representation of a generic field.
  70
  71 // Used as member in structures, exceptions and unions, and as a base
  72 // type for attributes and arguments to operations
  73 //
  74 // NOTE: There are two constructors here, the first is used when field
  75 // is used directly inside a structure, the second when it is used as
  76 // the base type for attributes and operations.
  77
  78 #include "ast_decl.h"
  79 #include "utl_scoped_name.h"
  80
  81 class AST_Type;
  82
  83 class TAO_IDL_FE_Export AST_Field : public virtual AST_Decl
  84 {
  85 public:
  86   enum Visibility
  87     {
  88       vis_NA,
  89       vis_PUBLIC,
  90       vis_PRIVATE
  91     };
  92
  93   AST_Field (AST_Type *field_type,
  94              UTL_ScopedName *n,
  95              Visibility vis = vis_NA);
  96
  97   AST_Field (AST_Decl::NodeType nt,
  98              AST_Type *field_type,
  99              UTL_ScopedName *n,
 100              Visibility vis = vis_NA);
 101
 102   /**
 103    * A sort of copy constructor that creates a copy of the AST_Field for a new
 104    * scope.
 105    * The new name must be calculated beforehand.
 106    * This was created for Annotation Instances and Extended Structs.
 107    */
 108   AST_Field (
 109     UTL_ScopedName *name,
 110     AST_Field *other);
 111
 112   virtual ~AST_Field ();
 113
 114   // Data Accessors.
 115   AST_Type *field_type () const;
 116
 117   /// Get and Set Visibility
 118   ///{
 119   Visibility visibility () const;
 120   void visibility (Visibility val);
 121   ///}
 122
 123   // Are we or do we contain a wstring?
 124   virtual int contains_wstring ();
 125
 126   // Determine this bit of state after we have
 127   // be added to our aggregate type and before
 128   // we are destroyed.
 129   void set_recursive_flag ();
 130
 131   // AST Dumping.
 132   virtual void dump (ACE_OSTREAM_TYPE &o);
 133
 134   // Visiting.
 135   virtual int ast_accept (ast_visitor *visitor);
 136
 137   // Cleanup.
 138   virtual void destroy ();
 139
 140   static AST_Decl::NodeType const NT;
 141
 142   virtual bool annotatable () const;
 143
 144 protected:
 145   // Data.
 146
 147   AST_Type *ref_type_;
 148   // Base type for field.
 149
 150   Visibility visibility_;
 151   // Used with valuetype and eventtype fields.
 152
 153   bool owns_base_type_;
 154   // If our field type is anonymous array or sequence, we're
 155   // responsible for destroying it.
 156 };
 157
 158 #endif           // _AST_FIELD_AST_FIELD_HH