xref: /freebsd/contrib/kyua/utils/config/keys.cpp (revision 911f0260390e18cf85f3dbf2c719b593efdc1e3c)
1 // Copyright 2012 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 #include "utils/config/tree.ipp"
30 
31 #include "utils/config/exceptions.hpp"
32 #include "utils/format/macros.hpp"
33 #include "utils/text/operations.hpp"
34 
35 namespace config = utils::config;
36 namespace text = utils::text;
37 
38 
39 /// Converts a key to its textual representation.
40 ///
41 /// \param key The key to convert.
42 ///
43 /// \return a flattened representation of \p key, "."-joined.
44 std::string
45 utils::config::detail::flatten_key(const tree_key& key)
46 {
47     PRE(!key.empty());
48     return text::join(key, ".");
49 }
50 
51 
52 /// Parses and validates a textual key.
53 ///
54 /// \param str The key to process in dotted notation.
55 ///
56 /// \return The tokenized key if valid.
57 ///
58 /// \throw invalid_key_error If the input key is empty or invalid for any other
59 ///     reason.  Invalid does NOT mean unknown though.
60 utils::config::detail::tree_key
61 utils::config::detail::parse_key(const std::string& str)
62 {
63     const tree_key key = text::split(str, '.');
64     if (key.empty())
65         throw invalid_key_error("Empty key");
66     for (tree_key::const_iterator iter = key.begin(); iter != key.end(); iter++)
67         if ((*iter).empty())
68             throw invalid_key_error(F("Empty component in key '%s'") % str);
69     return key;
70 }
71