ACE/ace/Functor_String.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    Functor_String.h
   6  *
   7  *   Class template specializations for ACE_*String types implementing
   8  *   function objects that are used in  various places in ATC. They
   9  *   could be placed in Functor.h. But we don't want to couple string
  10  *   types to the rest of ACE+TAO. Hence they are placed in a separate
  11  *   file.
  12  */
  13 //==========================================================================
  14 #ifndef ACE_FUNCTOR_STRING_H
  15 #define ACE_FUNCTOR_STRING_H
  16 #include /**/ "ace/pre.h"
  17
  18 #include /**/ "ace/config-all.h"
  19
  20 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  21 # pragma once
  22 #endif /* ACE_LACKS_PRAGMA_ONCE */
  23
  24 #include /**/ "ace/ACE_export.h"
  25 #include "ace/SStringfwd.h"
  26 #include <string>
  27
  28 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  29
  30 ////////////////////////////////////////////////////////////
  31 // STL-style Functor Classes and Template Specializations //
  32 ////////////////////////////////////////////////////////////
  33
  34 // Forward declaration since we are going to specialize that template
  35 // here. The template itself requires this file so every user of the
  36 // template should also see the specialization.
  37 template <class TYPE> class ACE_Hash;
  38 template <class TYPE> class ACE_Equal_To;
  39 template <class TYPE> class ACE_Less_Than;
  40
  41 /**
  42  * @brief Function object for determining whether two ACE_CStrings are
  43  * equal.
  44  */
  45 template<>
  46 class ACE_Export ACE_Equal_To<ACE_CString>
  47 {
  48 public:
  49   int operator () (const ACE_CString &lhs,
  50                    const ACE_CString &rhs) const;
  51 };
  52
  53
  54 /**
  55  * @brief Function object for hashing a ACE_CString
  56  */
  57 template<>
  58 class ACE_Export ACE_Hash<ACE_CString>
  59 {
  60 public:
  61   /// Calls ACE::hash_pjw
  62   unsigned long operator () (const ACE_CString &lhs) const;
  63 };
  64
  65
  66 /**
  67  * @brief Function object for determining whether the first const string
  68  * is less than the second const string.
  69  */
  70 template<>
  71 class ACE_Export ACE_Less_Than<ACE_CString>
  72 {
  73 public:
  74   /// Simply calls ACE_OS::strcmp
  75   int operator () (const ACE_CString &lhs,
  76                    const ACE_CString &rhs) const;
  77 };
  78
  79 /**
  80  * @brief Function object for determining whether two std::strings are
  81  * equal.
  82  */
  83 template<>
  84 class ACE_Export ACE_Equal_To<std::string>
  85 {
  86 public:
  87   int operator () (const std::string &lhs,
  88                    const std::string &rhs) const;
  89 };
  90
  91
  92 /**
  93  * @brief Function object for hashing a std::string
  94  */
  95 template<>
  96 class ACE_Export ACE_Hash<std::string>
  97 {
  98 public:
  99   /// Calls ACE::hash_pjw
 100   unsigned long operator () (const std::string &lhs) const;
 101 };
 102
 103
 104 /**
 105  * @brief Function object for determining whether the first const string
 106  * is less than the second const string.
 107  */
 108 template<>
 109 class ACE_Export ACE_Less_Than<std::string>
 110 {
 111 public:
 112   /// Simply calls std::string::compare
 113   int operator () (const std::string &lhs,
 114                    const std::string &rhs) const;
 115 };
 116
 117
 118 #if defined (ACE_USES_WCHAR)
 119
 120 /**
 121  * @brief Function object for determining whether two ACE_WStrings are
 122  * equal.
 123  */
 124 template<>
 125 class ACE_Export ACE_Equal_To<ACE_WString>
 126 {
 127 public:
 128   int operator () (const ACE_WString &lhs,
 129                    const ACE_WString &rhs) const;
 130 };
 131
 132
 133 /**
 134  * @brief Function object for hashing a ACE_WString
 135  */
 136 template<>
 137 class ACE_Export ACE_Hash<ACE_WString>
 138 {
 139 public:
 140   /// Calls ACE::hash_pjw
 141   unsigned long operator () (const ACE_WString &lhs) const;
 142 };
 143
 144 /**
 145  * @brief Function object for determining whether the first const wstring
 146  * is less than the second const wstring.
 147  */
 148 template<>
 149 class ACE_Export ACE_Less_Than<ACE_WString>
 150 {
 151 public:
 152   /// Simply calls ACE_OS::strcmp
 153   int operator () (const ACE_WString &lhs,
 154                    const ACE_WString &rhs) const;
 155 };
 156
 157 #endif /*ACE_USES_WCHAR*/
 158
 159 ACE_END_VERSIONED_NAMESPACE_DECL
 160
 161 #if defined (__ACE_INLINE__)
 162 #include "ace/Functor_String.inl"
 163 #endif /* __ACE_INLINE__ */
 164
 165 #include /**/ "ace/post.h"
 166 #endif /*ACE_FUNCTOR_STRING_H*/