/* COPYRIGHT Copyright 1992, 1993, 1994 Sun Microsystems, Inc. Printed in the United States of America. All Rights Reserved. This product is protected by copyright and distributed under the following license restricting its use. The Interface Definition Language Compiler Front End (CFE) is made available for your use provided that you include this license and copyright notice on all media and documentation and the software program in which this product is incorporated in whole or part. You may copy and extend functionality (but may not remove functionality) of the Interface Definition Language CFE without charge, but you are not authorized to license or distribute it to anyone else except as part of a product or program developed by you or with the express written consent of Sun Microsystems, Inc. ("Sun"). The names of Sun Microsystems, Inc. and any of its subsidiaries or affiliates may not be used in advertising or publicity pertaining to distribution of Interface Definition Language CFE as permitted herein. This license is effective until terminated by Sun for failure to comply with this license. Upon termination, you shall destroy or return all code and documentation for the Interface Definition Language CFE. INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE. INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED WITH NO SUPPORT AND WITHOUT ANY OBLIGATION ON THE PART OF Sun OR ANY OF ITS SUBSIDIARIES OR AFFILIATES TO ASSIST IN ITS USE, CORRECTION, MODIFICATION OR ENHANCEMENT. SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES SHALL HAVE NO LIABILITY WITH RESPECT TO THE INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY INTERFACE DEFINITION LANGUAGE CFE OR ANY PART THEREOF. IN NO EVENT WILL SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES BE LIABLE FOR ANY LOST REVENUE OR PROFITS OR OTHER SPECIAL, INDIRECT AND CONSEQUENTIAL DAMAGES, EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 and FAR 52.227-19. Sun, Sun Microsystems and the Sun logo are trademarks or registered trademarks of Sun Microsystems, Inc. SunSoft, Inc. 2550 Garcia Avenue Mountain View, California 94043 NOTE: SunOS, SunSoft, Sun, Solaris, Sun Microsystems or the Sun logo are trademarks or registered trademarks of Sun Microsystems, Inc. */ #ifndef _AST_STRUCTURE_AST_STRUCTURE_HH #define _AST_STRUCTURE_AST_STRUCTURE_HH // Representation of structure: // // NOTE: add (AST_ConcreteType *) is defined here because a structure // can contain locally defined types in addition to fields. // // NOTE: add (AST_EnumValue *) is defined here because enums can // be defined manifest locally; the constants defined in these // enums are inserted in the enclosing scope. It is unlikely that // a BE writer will need to overload this function in AST_Structure. #include "ast_concrete_type.h" #include "utl_scope.h" #include "ace/Unbounded_Queue.h" class TAO_IDL_FE_Export AST_Structure : public virtual AST_ConcreteType, public virtual UTL_Scope { public: AST_Structure (UTL_ScopedName *n, bool local, bool abstract); AST_Structure (AST_Decl::NodeType nt, UTL_ScopedName *n, bool local, bool abstract); virtual ~AST_Structure (); // This serves for both structs and unions. static void fwd_redefinition_helper (AST_Structure *&i, UTL_Scope *s); // Overridden for unions. virtual void redefine (AST_Structure *from); virtual int member_count (); // Return the count of members. virtual ACE_CDR::ULong nfields () const; // Return the count of actual fields. virtual int field (AST_Field **&result, ACE_CDR::ULong slot) const; // Get an individual field node. virtual bool is_local (); // Overwrite the is_local method. virtual bool in_recursion (ACE_Unbounded_Queue &list); // Are we or the node represented by node involved in recursion. virtual int contains_wstring (); // Do we contain a wstring at some nesting level? // Is this struct or union defined? This predicate returns FALSE when a // forward declaration is not defined yet, and TRUE in // all other cases. virtual bool is_defined (); // Recursively called on valuetype to check for legal use as // a primary key. Overridden for valuetype, struct, sequence, // union, array, typedef, and interface. virtual bool legal_for_primary_key () const; // Accessors for the member. AST_StructureFwd *fwd_decl () const; void fwd_decl (AST_StructureFwd *node); // AST Dumping. virtual void dump (ACE_OSTREAM_TYPE &o); // Cleanup function. virtual void destroy (); // Visiting. virtual int ast_accept (ast_visitor *visitor); // Accessor for the member. ACE_Unbounded_Queue &fields (); static AST_Decl::NodeType const NT; virtual bool annotatable () const; virtual AST_Field *fe_add_field (AST_Field *f); /// Easy Member Access ///{ virtual AST_Decl *operator[] (const size_t index); virtual AST_Decl *operator[] (const char* name); ///} protected: friend int tao_yyparse (); // Scope Management Protocol. virtual AST_Union *fe_add_union (AST_Union *u); virtual AST_Structure *fe_add_structure (AST_Structure *s); virtual AST_Enum *fe_add_enum (AST_Enum *e); virtual AST_EnumVal *fe_add_enum_val (AST_EnumVal *v); virtual int compute_size_type (); // Compute the size type if it is unknown. ACE_Unbounded_Queue fields_; // Container for this struct's field nodes. Excludes nodes included // in member_count, i.e., enum values of an enum declared inside // the struct. private: int compute_member_count (); // Count the number of members. int member_count_; // Number of members. int local_struct_; // We also need to determine whether we contain any local type. AST_StructureFwd *fwd_decl_; // The forward declaration we may have been created from. }; #endif // _AST_STRUCTURE_AST_STRUCTURE_HH