bes  Updated for version 3.19.1
TheBESKeys.h
1 // TheBESKeys.h
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the OPeNDAP Data Access Protocol.
5 
6 // Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 //
23 // You can contact University Corporation for Atmospheric Research at
24 // 3080 Center Green Drive, Boulder, CO 80301
25 
26 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
28 //
29 // Authors:
30 // pwest Patrick West <pwest@ucar.edu>
31 // jgarcia Jose Garcia <jgarcia@ucar.edu>
32 
33 #ifndef TheBESKeys_h_
34 #define TheBESKeys_h_ 1
35 
36 #include <fstream>
37 #include <map>
38 #include <vector>
39 #include <string>
40 
41 using std::string;
42 using std::map;
43 using std::vector;
44 using std::ifstream;
45 
46 #include "BESObj.h"
47 
84 class TheBESKeys: public BESObj {
85 private:
86 
87  ifstream * _keys_file;
88  std::string _keys_file_name;
89  std::map<std::string, std::vector<string> > *_the_keys;
90  bool _own_keys;
91 
92  static std::vector<std::string> KeyList;
93  static bool LoadedKeys(const std::string &key_file);
94 
95  void clean();
96  void initialize_keys();
97  void load_keys();
98  bool break_pair(const char* b, string& key, string &value, bool &addto);
99  bool only_blanks(const char *line);
100  void load_include_files(const string &files);
101  void load_include_file(const string &file);
102 
103  TheBESKeys() :
104  _keys_file(0), _keys_file_name(""), _the_keys(0), _own_keys(false)
105  {
106  }
107 
108  TheBESKeys(const string &keys_file_name, map<string, vector<string> > *keys);
109 
110 protected:
111  TheBESKeys(const string &keys_file_name);
112 
113 public:
114  static TheBESKeys *_instance;
115  virtual ~TheBESKeys();
116 
117  std::string keys_file_name() const
118  {
119  return _keys_file_name;
120  }
121 
122  void set_key(const string &key, const string &val, bool addto = false);
123  void set_key(const string &pair);
124  void get_value(const string& s, string &val, bool &found);
125  void get_values(const string& s, vector<string> &vals, bool &found);
126 
127  typedef map<string, vector<string> >::const_iterator Keys_citer;
128 
129  Keys_citer keys_begin()
130  {
131  return _the_keys->begin();
132  }
133 
134  Keys_citer keys_end()
135  {
136  return _the_keys->end();
137  }
138 
139  virtual void dump(ostream &strm) const;
140 
145  static string ConfigFile;
146 
150  static TheBESKeys *TheKeys();
151 };
152 
153 #endif // TheBESKeys_h_
154 
mapping of key/value pairs defining different behaviors of an application.
Definition: TheBESKeys.h:84
void get_value(const string &s, string &val, bool &found)
Retrieve the value of a given key, if set.
Definition: TheBESKeys.cc:422
void set_key(const string &key, const string &val, bool addto=false)
allows the user to set key/value pairs from within the application.
Definition: TheBESKeys.cc:374
Base object for bes objects.
Definition: BESObj.h:52
static TheBESKeys * TheKeys()
Definition: TheBESKeys.cc:62
virtual ~TheBESKeys()
cleans up the key/value pair mapping
Definition: TheBESKeys.cc:129
void get_values(const string &s, vector< string > &vals, bool &found)
Retrieve the values of a given key, if set.
Definition: TheBESKeys.cc:453
static string ConfigFile
Definition: TheBESKeys.h:145
virtual void dump(ostream &strm) const
dumps information about this object
Definition: TheBESKeys.cc:470