bpp-core3  3.0.0
AttributesTools.h
Go to the documentation of this file.
1 //
2 // File: AttributesTools.h
3 // Authors:
4 // Julien Dutheil
5 // Created: 2003-10-07 00:00:00
6 //
7 
8 /*
9  Copyright or © or Copr. Bio++ Development Tools, (November 17, 2004)
10 
11  This software is a computer program whose purpose is to provide basal and
12  utilitary classes. This file belongs to the Bio++ Project.
13 
14  This software is governed by the CeCILL license under French law and
15  abiding by the rules of distribution of free software. You can use,
16  modify and/ or redistribute the software under the terms of the CeCILL
17  license as circulated by CEA, CNRS and INRIA at the following URL
18  "http://www.cecill.info".
19 
20  As a counterpart to the access to the source code and rights to copy,
21  modify and redistribute granted by the license, users are provided only
22  with a limited warranty and the software's author, the holder of the
23  economic rights, and the successive licensors have only limited
24  liability.
25 
26  In this respect, the user's attention is drawn to the risks associated
27  with loading, using, modifying and/or developing or reproducing the
28  software by the user in light of its specific status of free software,
29  that may mean that it is complicated to manipulate, and that also
30  therefore means that it is reserved for developers and experienced
31  professionals having in-depth computer knowledge. Users are therefore
32  encouraged to load and test the software's suitability as regards their
33  requirements in conditions enabling the security of their systems and/or
34  data to be ensured and, more generally, to use and operate it in the
35  same conditions as regards security.
36 
37  The fact that you are presently reading this means that you have had
38  knowledge of the CeCILL license and that you accept its terms.
39 */
40 
41 #ifndef BPP_UTILS_ATTRIBUTESTOOLS_H
42 #define BPP_UTILS_ATTRIBUTESTOOLS_H
43 
44 
45 #include "../Exceptions.h"
46 
47 // From the STL:
48 #include <cstdlib>
49 #include <map>
50 #include <string>
51 #include <vector>
52 
53 namespace bpp
54 {
130 {
131 private:
132  /*
133  * vector of param names already seen, to avoid infinite recursion
134  *
135  */
136 
137  static std::vector<std::string> vParam_;
138 
139 public:
141  virtual ~AttributesTools() {}
142 
150  static std::vector<std::string> getVector(int argc, char* argv[]);
151 
161  static std::map<std::string, std::string> getAttributesMap(
162  const std::vector<std::string>& argv,
163  const std::string& delimiter = "=");
164 
174  static void getAttributesMap(
175  const std::vector<std::string>& argv,
176  std::map<std::string, std::string>& am,
177  const std::string& delimiter = "=");
178 
186  static std::map<std::string, std::string> getAttributesMapFromFile(
187  const std::string& file,
188  const std::string& delimiter);
189 
197  static void getAttributesMapFromFile(
198  const std::string& file,
199  std::map<std::string, std::string>& params,
200  const std::string& delimiter);
201 
211  static void actualizeAttributesMap(
212  std::map<std::string, std::string>& attMap,
213  const std::map<std::string, std::string>& atts);
214 
227  static void resolveVariables(std::map<std::string, std::string>& am,
228  char varCode = '$',
229  char varBeg = '(',
230  char varEnd = ')');
231 
241  static std::map<std::string, std::string> parseOptions(int args, char** argv);
242 
243 private:
251  static std::string removeComments(const std::string& s, const std::string& begin, const std::string& end);
252 };
253 } // end of namespace bpp.
254 #endif // BPP_UTILS_ATTRIBUTESTOOLS_H
Some functions to deal with attributes, i.e. parameters passed to a program/method.
static std::map< std::string, std::string > getAttributesMapFromFile(const std::string &file, const std::string &delimiter)
Get an attribute map from a file.
static std::map< std::string, std::string > getAttributesMap(const std::vector< std::string > &argv, const std::string &delimiter="=")
Get an attribute map from a vector of arguments.
static std::string removeComments(const std::string &s, const std::string &begin, const std::string &end)
Remove comments from a string.
static void actualizeAttributesMap(std::map< std::string, std::string > &attMap, const std::map< std::string, std::string > &atts)
Actualizes an attribute map with another.
static std::vector< std::string > getVector(int argc, char *argv[])
Get attributes a vector of strings from command line arguments.
static void resolveVariables(std::map< std::string, std::string > &am, char varCode='$', char varBeg='(', char varEnd=')')
Resolve the variables.
static std::map< std::string, std::string > parseOptions(int args, char **argv)
Global function that reads all parameters from command line and files, and set the values in a map.
static std::vector< std::string > vParam_