dep/ACE_wrappers/ace/Svc_Conf_Param.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Svc_Conf_Param.h
   6  *
   7  *  $Id: Svc_Conf_Param.h 81312 2008-04-09 21:01:34Z iliyan $
   8  *
   9  *  @author Iliyan Jeliazkov <iliyan@ociweb.com>
  10  *  @author Based on code originally found in Svc_Conf.h by Doug
  11             Schmidt and Ossama Othman.
  12  */
  13 //=============================================================================
  14
  15
  16 #ifndef ACE_SVC_CONF_PARAM_H
  17 #define ACE_SVC_CONF_PARAM_H
  18
  19 #include /**/ "ace/pre.h"
  20
  21 // Globally visible macros, type decls, and extern var decls for
  22 // Service Configurator utility.
  23
  24 #include "ace/Obstack.h"
  25
  26 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  27 # pragma once
  28 #endif /* ACE_LACKS_PRAGMA_ONCE */
  29
  30 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  31
  32 // Forward declarations.
  33 struct ace_yy_buffer_state;
  34 class ACE_Service_Gestalt;
  35
  36 extern void ace_yy_delete_buffer (ace_yy_buffer_state *buffer);
  37
  38 /**
  39  * @class ACE_Svc_Conf_Param
  40  *
  41  * @brief An instance of this object will be passed down to the
  42  *        yyparse() and yylex() functions.
  43  *
  44  * This is intended for internal use within ACE service configuration
  45  * framework only.
  46  *
  47  * This class retains the state for a given parse/scan.  It primarily
  48  * makes it possible to hold the static object lock in the scanner
  49  * for as short a period of time as possible.  The resulting finer
  50  * grained locking prevents deadlocks from occuring when scanning a
  51  * `svc.conf' file and activating an ACE_Task, for example, as a
  52  * result of processing the directives in that file.
  53  */
  54 class ACE_Svc_Conf_Param
  55 {
  56 public:
  57
  58   enum SVC_CONF_PARAM_TYPE
  59     {
  60       /// The lexer will scan a file containing one or more directives.
  61       SVC_CONF_FILE,
  62
  63       /// The lexer will scan a string containing a directive.
  64       SVC_CONF_DIRECTIVE
  65     };
  66
  67   /// Constructor
  68   ACE_Svc_Conf_Param (ACE_Service_Gestalt* config, FILE *file)
  69     : type (SVC_CONF_FILE),
  70       yyerrno (0),
  71       yylineno (1),
  72       buffer (0),
  73       obstack (),
  74       config (config)
  75   {
  76     source.file = file;
  77   }
  78
  79   /// Constructor
  80   ACE_Svc_Conf_Param (ACE_Service_Gestalt* config, const ACE_TCHAR *directive)
  81     : type (SVC_CONF_DIRECTIVE),
  82       yyerrno (0),
  83       yylineno (1),
  84       buffer (0),
  85       obstack (),
  86       config (config)
  87   {
  88     source.directive = directive;
  89   }
  90
  91   ~ACE_Svc_Conf_Param (void)
  92   {
  93     ace_yy_delete_buffer (this->buffer);
  94   }
  95
  96 public:
  97
  98   union
  99   {
 100     /// FILE stream from which directives will be scanned and parsed.
 101     FILE *file;
 102
 103     /// String containing directive that will be scanned and parsed.
 104     const ACE_TCHAR *directive;
 105
 106   } source;
 107
 108   /// Discriminant use to determine which union member to use.
 109   SVC_CONF_PARAM_TYPE type;
 110
 111   /// Keeps track of the number of errors encountered so far.
 112   int yyerrno;
 113
 114   /// Keeps track of the current line number for error-handling routine.
 115   int yylineno;
 116
 117   /// Lexer buffer that corresponds to the current Service
 118   /// Configurator file/direct scan.
 119   ace_yy_buffer_state *buffer;
 120
 121   /// Obstack used for efficient memory allocation when
 122   /// parsing/scanning a service configurator directive.
 123   ACE_Obstack_T<ACE_TCHAR> obstack;
 124
 125   /// A reference to the configuration
 126   ACE_Service_Gestalt *config;
 127 };
 128
 129
 130 // Parameter that is passed down to the yyparse() function, and
 131 // eventually to yylex().
 132 #define YYPARSE_PARAM ace_svc_conf_parameter
 133
 134 #define YYLEX_PARAM YYPARSE_PARAM
 135
 136 #define ACE_SVC_CONF_PARAM (static_cast<ACE_Svc_Conf_Param *> (YYLEX_PARAM))
 137
 138 ACE_END_VERSIONED_NAMESPACE_DECL
 139
 140 #include /**/ "ace/post.h"
 141
 142 #endif /* ACE_SVC_CONF_PARAM_H */