TAO/TAO_IDL/include/utl_idlist.h

   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 #ifndef _UTL_IDLIST_UTL_IDLIST_HH
  66 #define _UTL_IDLIST_UTL_IDLIST_HH
  67
  68 // List of Identifiers
  69
  70 // NOTE: This list class only works correctly because we use single public
  71 //       inheritance, as opposed to multiple inheritance or public virtual.
  72 //       It relies on a type-unsafe cast from UTL_List to subclasses, which
  73 //       will cease to operate correctly if you use either multiple or
  74 //       public virtual inheritance.
  75
  76 #include "utl_list.h"
  77 #include "ace/iosfwd.h"
  78
  79 class Identifier;
  80
  81 class TAO_IDL_FE_Export UTL_IdList : public UTL_List
  82 {
  83   // =TITLE
  84   //  UTL_IdList
  85   // =DESCRIPTION
  86   //  Used to maintain a list of identifiers. The primary usage of this class
  87   //  is to maintain a scoped name.
  88 public:
  89   UTL_IdList (Identifier *car,
  90               UTL_IdList *cdr);
  91   // Constructor(s)
  92
  93   virtual ~UTL_IdList (void) {}
  94   // destructor
  95
  96   virtual void dump (ACE_OSTREAM_TYPE &o);
  97   // Dump to ostream.
  98
  99   virtual void destroy (void);
 100   // Cleanup function.
 101
 102   virtual UTL_IdList *copy (void);
 103   // Copy the list.
 104
 105   Identifier *head (void);
 106   // Get element.
 107
 108   Identifier *last_component (void);
 109   // Get last element in this list.
 110
 111   Identifier *first_component (void);
 112   // Get first element in this list holding a non-empty string.
 113
 114   int compare (UTL_IdList *other);
 115   // Compares each component for equality.
 116
 117   /**
 118    * Return a copy of the contents as a string
 119    */
 120   char *get_string_copy ();
 121
 122   /**
 123    * Return true if the list begins with "::"
 124    */
 125   bool is_absolute ();
 126
 127 private:
 128   Identifier *pd_car_data;
 129 };
 130
 131 // Active iterator for UTL_IdList.
 132
 133 class TAO_IDL_FE_Export UTL_IdListActiveIterator
 134   : public UTL_ListActiveIterator
 135 {
 136   // =TITLE
 137   //  UTL_IdListActiveIterator
 138   // =DESCRIPTION
 139   //  Iterator for the IDList
 140 public:
 141   UTL_IdListActiveIterator (UTL_IdList *s);
 142
 143   /// Retrieves the next item.
 144   Identifier *item (void);
 145 };
 146
 147 #endif          // _UTL_IDLIST_UTL_IDLIST_HH