dep/ACE_wrappers/ace/Functor_String.h

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