dep/ACE_wrappers/ace/Capabilities.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Capabilities.h
   6  *
   7  *  $Id: Capabilities.h 80826 2008-03-04 14:51:23Z wotte $
   8  *
   9  *  @author Arturo Montes <mitosys@colomsat.net.co>
  10  */
  11 //=============================================================================
  12
  13
  14 #ifndef ACE_CAPABILITIES_H
  15 #define ACE_CAPABILITIES_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/Null_Mutex.h"
  25 #include "ace/Hash_Map_Manager_T.h"
  26 #include "ace/Containers.h"
  27 #include "ace/SString.h"
  28 #include "ace/Functor_String.h"
  29
  30 #if defined (ACE_IS_SPLITTING)
  31 # include "ace/OS_NS_ctype.h"
  32 #endif  /* ACE_IS_SPLITTING */
  33
  34
  35 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  36
  37 /**
  38  * @class ACE_CapEntry
  39  *
  40  * @brief This class is the base class for all ACE Capabilities entry
  41  * subclasses.
  42  *
  43  * This class is not instantiable and does not provide accessors
  44  * or methods.  If you want to add a new kind of attribute subclass
  45  * this class and dynamic_cast to proper subclass.
  46  */
  47 class ACE_Export ACE_CapEntry
  48 {
  49 public:
  50
  51    virtual ~ACE_CapEntry (void);
  52
  53 protected:
  54
  55   enum
  56   {
  57     ACE_INTCAP = 0,
  58     ACE_STRINGCAP = 1,
  59     ACE_BOOLCAP = 2
  60   };
  61
  62   ACE_CapEntry (int captype);
  63
  64 protected:
  65
  66   int captype_;
  67
  68 };
  69
  70 /**
  71  * @class ACE_IntCapEntry
  72  *
  73  * @brief This class implement the ACE Integer Capability subclass.
  74  *
  75  * This is a container class for ACE Capabilities integer container
  76  * values.
  77  */
  78 class ACE_Export ACE_IntCapEntry : public ACE_CapEntry
  79 {
  80 public:
  81   ACE_IntCapEntry (int val);
  82   int getval (void) const;
  83
  84 protected:
  85   int val_;
  86 };
  87
  88 /**
  89  * @class ACE_StringCapEntry
  90  *
  91  * @brief This class implement the ACE String Capability subclass.
  92  *
  93  * This is a container class for ACE Capabilities String container
  94  * values.
  95  */
  96 class ACE_Export ACE_StringCapEntry : public ACE_CapEntry
  97 {
  98 public:
  99   ACE_StringCapEntry (const ACE_TString &val);
 100   ACE_TString getval (void) const;
 101
 102 protected:
 103   ACE_TString val_;
 104 };
 105
 106 /**
 107  * @class ACE_BoolCapEntry
 108  *
 109  * @brief This class implement the ACE Bool Capability subclass.
 110  *
 111  * This is a container class for ACE Capabilities bool container
 112  * values.
 113  */
 114 class ACE_Export ACE_BoolCapEntry : public ACE_CapEntry
 115 {
 116 public:
 117   ACE_BoolCapEntry (int val);
 118   int getval (void) const;
 119
 120 protected:
 121   int val_;
 122 };
 123
 124 /**
 125  * @class ACE_Capabilities
 126  *
 127  * @brief This class implement the ACE Capabilities.
 128  *
 129  * This is a container class for ACE Capabilities
 130  * values. Currently exist three different capability values:
 131  * <ACE_IntCapEntry> (integer), <ACE_BoolCapEntry> (bool) and
 132  * <ACE_StringCapEntry> (String).  An ACE_Capabilities is a
 133  * unordered set of pair = (<String>, <ACE_CapEntry> *).  Where
 134  * the first component is the name of capability and the second
 135  * component is a pointer to the capability value container.  A
 136  * <FILE> is a container for ACE_Capabilities, the
 137  * ACE_Capabilities has a name in the file, as a termcap file.
 138  */
 139 class ACE_Export ACE_Capabilities
 140 {
 141 public:
 142
 143   typedef  ACE_Hash_Map_Manager_Ex<ACE_TString, ACE_CapEntry *, ACE_Hash<ACE_TString>, ACE_Equal_To<ACE_TString>, ACE_Null_Mutex> CAPABILITIES_MAP;
 144
 145   /// The Constructor
 146   ACE_Capabilities (void);
 147
 148   /// The Destructor
 149   ~ACE_Capabilities(void);
 150
 151 public:
 152
 153   /// Get a string entry.
 154   int getval (const ACE_TCHAR *ent, ACE_TString &val);
 155
 156   /// Get an integer entry.
 157   int getval (const ACE_TCHAR *ent, int &val);
 158
 159   /// Get the ACE_Capabilities name from FILE fname and load the
 160   /// associated capabitily entries in map.
 161   int getent (const ACE_TCHAR *fname, const ACE_TCHAR *name);
 162
 163 protected:
 164
 165   /// Parse an integer property
 166   const ACE_TCHAR *parse (const ACE_TCHAR *buf, int &cap);
 167
 168   /// Parse a string property
 169   const ACE_TCHAR *parse (const ACE_TCHAR *buf, ACE_TString &cap);
 170
 171   /// Fill the ACE_Capabilities with description in ent.
 172   int fillent(const ACE_TCHAR *ent);
 173
 174   /// Parse a cap entry
 175   int parseent (const ACE_TCHAR *name, ACE_TCHAR *line);
 176
 177   /// Get a line from FILE input stream
 178   int getline (FILE* fp,
 179                ACE_TString &line);
 180
 181   /// Is a valid entry
 182   int is_entry (const ACE_TCHAR *name, const ACE_TCHAR *line);
 183
 184   /// Reset the set of capabilities
 185   void resetcaps (void);
 186
 187 private:
 188
 189   /// This is the set of ACE_CapEntry.
 190   CAPABILITIES_MAP caps_;
 191
 192 };
 193
 194 #if defined (ACE_IS_SPLITTING)
 195 int
 196 is_empty (const ACE_TCHAR *line)
 197 {
 198   while (*line && ACE_OS::ace_isspace (*line))
 199     ++line;
 200
 201   return *line == ACE_TEXT ('\0') || *line == ACE_TEXT ('#');
 202 }
 203
 204 int
 205 is_line (const ACE_TCHAR *line)
 206 {
 207   while (*line && ACE_OS::ace_isspace (*line))
 208     ++line;
 209
 210   return *line != ACE_TEXT ('\0');
 211 }
 212 #endif /* ACE_IS_SPLITTING */
 213
 214 ACE_END_VERSIONED_NAMESPACE_DECL
 215
 216 #if defined (__ACE_INLINE__)
 217 #include "ace/Capabilities.inl"
 218 #endif /* __ACE_INLINE__ */
 219
 220 #include /**/ "ace/post.h"
 221 #endif /* __ACE_CAPABILITIES_H__ */