ACE/apps/JAWS3/jaws3/Config_File.h

   1 /* -*- c++ -*- */
   2 #ifndef JAWS_CONFIG_FILE_H
   3 #define JAWS_CONFIG_FILE_H
   4
   5 #include "jaws3/Export.h"
   6
   7 class JAWS_Config_File;
   8 class JAWS_Config_File_Impl;
   9
  10 class JAWS_Export JAWS_Config_File
  11 // = TITLE
  12 //     A simple configuration file manager.
  13 //
  14 // = DESCRIPTION
  15 //     Reads in a configuration file.  The syntax of the configuration
  16 //     file is:
  17 // = BEGIN<CODE>
  18 //     <configuration-file>   := <configuration-seq>
  19 //
  20 //     <configuration-seq>    := <configuration-line> [<configuration-seq>]
  21 //
  22 //     <configuration-line>   := <name-value-pair-line>
  23 //                             | <comment-line>
  24 //
  25 //     <name-value-pair-line> := <name> '=' <value-line>
  26 //
  27 //     <name>                 := <char-seq>
  28 //
  29 //     <value-line>           := [<char-seq>] <LF> [<continuation-seq>]
  30 //
  31 //     <continuation-seq>     := <continuation-line> [<continuation-seq>]
  32 //
  33 //     <continuation-line>    := <LWSP> [<char-seq>] <LF>
  34 //
  35 //     <comment-line>         := [<comment>] <LF>
  36 //
  37 //     <comment>              := '#' <char-seq>
  38 //
  39 //     <char-seq>             := <char> [<char-seq>]
  40 // = END<CODE>
  41 //     No <configuration-line> is to exceed 4094 characters.
  42 {
  43 public:
  44   // = Initialization
  45
  46   JAWS_Config_File (const ACE_TCHAR *config_file,
  47                     const ACE_TCHAR *config_dir = "./");
  48   // Parse the specified <config_file> in the <config_dir>.
  49
  50   // = Searching
  51
  52   int find (const ACE_TCHAR *key, const ACE_TCHAR *&value);
  53   // Find the <value> associated with <key>.
  54
  55 public:
  56   void reset ();
  57   // Re-read the configuration file.
  58
  59   void dump ();
  60   // Dump the values of all configuration variables.
  61
  62 private:
  63   JAWS_Config_File_Impl *impl_;
  64   // Opaque implementation.
  65 };
  66
  67 #endif /* JAWS_CONFIG_FILE_H */