Libosmium: include/osmium/util/options.hpp Source File

Libosmium Fast and flexible C++ library for working with OpenStreetMap data

Loading...
Searching...
No Matches
options.hpp
Go to the documentation of this file.
1#ifndef OSMIUM_UTIL_OPTIONS_HPP
2#define OSMIUM_UTIL_OPTIONS_HPP
3
4/*
5
6This file is part of Osmium (https://osmcode.org/libosmium).
7
8Copyright 2013-2026 Jochen Topf <jochen@topf.org> and others (see README).
9
10Boost Software License - Version 1.0 - August 17th, 2003
11
12Permission is hereby granted, free of charge, to any person or organization
13obtaining a copy of the software and accompanying documentation covered by
14this license (the "Software") to use, reproduce, display, distribute,
15execute, and transmit the Software, and to prepare derivative works of the
16Software, and to permit third-parties to whom the Software is furnished to
17do so, all subject to the following:
18
19The copyright notices in the Software and this entire statement, including
20the above license grant, this restriction and the following disclaimer,
21must be included in all copies of the Software, in whole or in part, and
22all derivative works of the Software, unless such copies or derivative
23works are solely in the form of machine-executable object code generated by
24a source language processor.
25
26THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
29SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
30FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
31ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
32DEALINGS IN THE SOFTWARE.
33
34*/
35
36#include <cstddef>
37#include <initializer_list>
38#include <map>
39#include <string>
40#include <utility>
41
42namespace osmium {
43
44 inline namespace util {
45
58 class Options {
59
60 using option_map = std::map<std::string, std::string>;
61 option_map m_options;
62
63 public:
64
65 using iterator = option_map::iterator;
66 using const_iterator = option_map::const_iterator;
67 using value_type = option_map::value_type;
68
72 Options() = default;
73
80 Options(const std::initializer_list<value_type>& values) :
81 m_options(values) {
82 }
83
87 void set(const std::string& key, const std::string& value) {
88 m_options[key] = value;
89 }
90
94 void set(const std::string& key, const char* value) {
95 m_options[key] = value;
96 }
97
101 void set(const std::string& key, bool value) {
102 m_options[key] = value ? "true" : "false";
103 }
104
110 void set(const std::string& data) {
111 const std::size_t pos = data.find_first_of('=');
112 if (pos == std::string::npos) {
113 m_options[data] = "true";
114 } else {
115 const std::string value{data.substr(pos + 1)};
116 set(data.substr(0, pos), value);
117 }
118 }
119
124 std::string get(const std::string& key, const std::string& default_value = "") const noexcept {
125 const auto it = m_options.find(key);
126 if (it == m_options.end()) {
127 return default_value;
128 }
129 return it->second;
130 }
131
136 bool is_true(const std::string& key) const noexcept {
137 const std::string value{get(key)};
138 return (value == "true" || value == "yes");
139 }
140
145 bool is_false(const std::string& key) const noexcept {
146 const std::string value{get(key)};
147 return (value == "false" || value == "no");
148 }
149
154 bool is_not_false(const std::string& key) const noexcept {
155 const std::string value{get(key)};
156 return !(value == "false" || value == "no");
157 }
158
162 bool empty() const noexcept {
163 return m_options.empty();
164 }
165
169 std::size_t size() const noexcept {
170 return m_options.size();
171 }
172
176 iterator begin() noexcept {
177 return m_options.begin();
178 }
179
183 iterator end() noexcept {
184 return m_options.end();
185 }
186
190 const_iterator begin() const noexcept {
191 return m_options.cbegin();
192 }
193
197 const_iterator end() const noexcept {
198 return m_options.cend();
199 }
200
204 const_iterator cbegin() const noexcept {
205 return m_options.cbegin();
206 }
207
211 const_iterator cend() const noexcept {
212 return m_options.cend();
213 }
214
215 }; // class Options
216
217 } // namespace util
218
219} // namespace osmium
220
221#endif // OSMIUM_UTIL_OPTIONS_HPP
osmium::Options
Definition options.hpp:58
osmium::util::Options::cend
const_iterator cend() const noexcept
Definition options.hpp:211
osmium::util::Options::set
void set(const std::string &data)
Definition options.hpp:110
osmium::util::Options::end
iterator end() noexcept
Definition options.hpp:183
osmium::util::Options::set
void set(const std::string &key, bool value)
Definition options.hpp:101
osmium::util::Options::m_options
option_map m_options
Definition options.hpp:61
osmium::util::Options::Options
Options()=default
osmium::util::Options::empty
bool empty() const noexcept
Definition options.hpp:162
osmium::util::Options::begin
const_iterator begin() const noexcept
Definition options.hpp:190
osmium::util::Options::iterator
option_map::iterator iterator
Definition options.hpp:65
osmium::util::Options::const_iterator
option_map::const_iterator const_iterator
Definition options.hpp:66
osmium::util::Options::cbegin
const_iterator cbegin() const noexcept
Definition options.hpp:204
osmium::util::Options::is_true
bool is_true(const std::string &key) const noexcept
Definition options.hpp:136
osmium::util::Options::set
void set(const std::string &key, const char *value)
Definition options.hpp:94
osmium::util::Options::size
std::size_t size() const noexcept
Definition options.hpp:169
osmium::util::Options::end
const_iterator end() const noexcept
Definition options.hpp:197
osmium::util::Options::is_false
bool is_false(const std::string &key) const noexcept
Definition options.hpp:145
osmium::util::Options::value_type
option_map::value_type value_type
Definition options.hpp:67
osmium::util::Options::get
std::string get(const std::string &key, const std::string &default_value="") const noexcept
Definition options.hpp:124
osmium::util::Options::set
void set(const std::string &key, const std::string &value)
Definition options.hpp:87
osmium::util::Options::is_not_false
bool is_not_false(const std::string &key) const noexcept
Definition options.hpp:154
osmium::util::Options::option_map
std::map< std::string, std::string > option_map
Definition options.hpp:60
osmium::util::Options::Options
Options(const std::initializer_list< value_type > &values)
Definition options.hpp:80
osmium::util::Options::begin
iterator begin() noexcept
Definition options.hpp:176
osmium::util
Helpful utility classes and functions not strictly OSM related.
Definition crc.hpp:55
osmium
Namespace for everything in the Osmium library.
Definition assembler.hpp:53