TAO/TAO_IDL/include/utl_identifier.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_IDENTIFIER_UTL_IDENTIFIER_HH
  66 #define _UTL_IDENTIFIER_UTL_IDENTIFIER_HH
  67
  68 #include "TAO_IDL_FE_Export.h"
  69
  70 #include "ace/iosfwd.h"
  71
  72 class TAO_IDL_FE_Export Identifier
  73 {
  74 public:
  75   Identifier (void);
  76   // Default Constructor.
  77
  78   Identifier (const char *s);
  79   // Constructor.
  80
  81   Identifier (const Identifier &other);
  82
  83   virtual ~Identifier (void);
  84   // Destructor.
  85
  86   // Operations
  87
  88   /**
  89    * Get the underlying string.
  90    */
  91   ///{
  92   char *get_string (void);
  93   const char *get_string () const;
  94   ///}
  95
  96   void replace_string (const char *s);
  97   // Replace the underlying string and free the old one.
  98
  99   void preprocess_and_replace_string (const char *s);
 100
 101   bool compare (Identifier *other);
 102   // Compare with other Identifier.
 103
 104   bool case_compare (Identifier *other);
 105   // Also check for case-only difference.
 106
 107   bool case_compare_quiet (Identifier *other);
 108   // Like the above but suppressing error or warning I/O
 109
 110   Identifier *copy (void);
 111   // Create a deep copy.
 112
 113   bool escaped (void) const;
 114   // Accessor for the member.
 115
 116   virtual void dump (ACE_OSTREAM_TYPE &o);
 117   // Dump to an ostream.
 118
 119   virtual void destroy (void);
 120   // Cleanup function.
 121
 122   bool operator== (const Identifier &other) const;
 123
 124   Identifier &operator= (const Identifier &other);
 125
 126 private:
 127   // Storage for data.
 128   char *pv_string;
 129
 130   // Did the IDL string have a leading underscore?
 131   bool escaped_;
 132 };
 133
 134 #endif          // _UTL_IDENTIFIER_UTL_IDENTIFIER_HH