bpp-core3  3.0.0
KeyvalTools.h
Go to the documentation of this file.
1 //
2 // File: KeyvalTools.h
3 // Authors:
4 // Julien Dutheil
5 // Created: 2009-05-11 13:16:00+02:00
6 //
7 
8 /*
9  Copyright or © or Copr. Bio++ Development Tools, (2009)
10 
11  This software is a computer program whose purpose is to provide classes
12  for numerical calculus.
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_TEXT_KEYVALTOOLS_H
42 #define BPP_TEXT_KEYVALTOOLS_H
43 
44 
45 #include "../Exceptions.h"
46 #include "StringTokenizer.h"
47 #include "TextTools.h"
48 
49 // From the STL:
50 #include <map>
51 
52 namespace bpp
53 {
58  public Exception
59 {
60 public:
61  KeyvalException(const std::string& text) : Exception(text) {}
62 };
63 
76 {
77 public:
79  virtual ~KeyvalTools();
80 
81 public:
92  static void singleKeyval(const std::string& desc, std::string& key, std::string& val, const std::string& split = "=");
93 
104  static void multipleKeyvals(const std::string& desc, std::map<std::string, std::string>& keyvals, const std::string& split = ",", bool nested = true);
105 
123  static std::string changeKeyvals(const std::string& desc, const std::map<std::string, std::string>& newkeyvals, const std::string& split = ",", bool nested = true);
124 
133  static void parseProcedure(const std::string& desc, std::string& name, std::map<std::string, std::string>& args);
134 };
135 } // End of namespace bpp.
136 #endif // BPP_TEXT_KEYVALTOOLS_H
Exception base class. Overload exception constructor (to control the exceptions mechanism)....
Definition: Exceptions.h:59
Exception thrown by the Keyval parser.
Definition: KeyvalTools.h:59
KeyvalException(const std::string &text)
Definition: KeyvalTools.h:61
Tools to deal with the keyval syntax.
Definition: KeyvalTools.h:76
static void parseProcedure(const std::string &desc, std::string &name, std::map< std::string, std::string > &args)
Parse (not recursively) a procedure string.
static std::string changeKeyvals(const std::string &desc, const std::map< std::string, std::string > &newkeyvals, const std::string &split=",", bool nested=true)
Change several keys to new corresponding values (General purpose function).
virtual ~KeyvalTools()
static void multipleKeyvals(const std::string &desc, std::map< std::string, std::string > &keyvals, const std::string &split=",", bool nested=true)
Split a string into several keys and corresponding values (General purpose function).
Definition: KeyvalTools.cpp:60
static void singleKeyval(const std::string &desc, std::string &key, std::string &val, const std::string &split="=")
Split a string into a key and a value (General purpose function).
Definition: KeyvalTools.cpp:51
std::vector< std::string > split(const std::string &s, std::size_t n)
Definition: TextTools.cpp:301