msl 1.1.0
 
Loading...
Searching...
No Matches
Dictionary.h
Go to the documentation of this file.
1// Copyright 2024-2025 Julien Lamy, ICube, Université de Strasbourg-CNRS.
2// Part of msl, distributed under the terms of the MIT license.
3
4#ifndef _5724fb56_798a_4131_aeb5_cbcdcbe26c97
5#define _5724fb56_798a_4131_aeb5_cbcdcbe26c97
6
7#include <initializer_list>
8#include <memory>
9#include <string>
10#include <unordered_map>
11
12#include <boost/any.hpp>
13
14namespace msl
15{
16
17#define DECLARE_POINTERS(name) \
18 using Pointer = std::shared_ptr<name>; \
19 using ConstPointer = std::shared_ptr<name const>;
20
23{
24public:
26 using container = std::unordered_map<std::string, boost::any>;
27
28 using value_type = container::value_type;
29
31 using iterator = container::iterator;
33 using const_iterator = container::const_iterator;
34
36
37 static std::shared_ptr<Dictionary> New(
38 std::initializer_list<value_type> && data)
39 {
40 return std::make_shared<Dictionary>(data);
41 }
42
43 Dictionary() = default;
44 Dictionary(std::initializer_list<container::value_type> values);
45 Dictionary(Dictionary const &) = default;
46 Dictionary(Dictionary &&) = default;
47 Dictionary & operator=(Dictionary const &) = default;
49 ~Dictionary() = default;
50
56 container::mapped_type get(std::string const & key) const;
57
64 template<typename T>
65 T const & get(std::string const & key) const
66 {
67 try
68 {
69 return boost::any_cast<T const &>(this->_dictionary.at(key));
70 }
71 catch(std::out_of_range const &)
72 {
73 throw std::out_of_range("No such key: '"+key+"'");
74 }
75 catch(boost::bad_any_cast const &)
76 {
77 throw std::runtime_error("Wrong type for key: '"+key+"'");
78 }
79 }
80
87 template<typename T>
88 T & get(std::string const & key)
89 {
90 try
91 {
92 return boost::any_cast<T &>(this->_dictionary.at(key));
93 }
94 catch(std::out_of_range const &)
95 {
96 throw std::out_of_range("No such key: '"+key+"'");
97 }
98 catch(boost::bad_any_cast const &)
99 {
100 throw std::runtime_error("Wrong type for key: '"+key+"'");
101 }
102 }
103
105 bool has(std::string const & key) const;
106
112 boost::typeindex::type_info const & type(std::string const & key) const;
113
115 template<typename T>
116 Dictionary & set(std::string const & key, T && value)
117 {
118 this->_dictionary[key] = value;
119 return *this;
120 }
121
123 bool empty() const;
124
126 size_t size() const;
127
134
141
144
146 Dictionary & insert(std::initializer_list<value_type> && data);
147
148private:
149 container _dictionary;
150};
151
152}
153
154#endif // _5724fb56_798a_4131_aeb5_cbcdcbe26c97
Dictionary(std::initializer_list< container::value_type > values)
Dictionary & operator=(Dictionary const &)=default
size_t size() const
Return the number of items in the dictionary.
container::iterator iterator
Iterator on the elements.
Definition Dictionary.h:31
const_iterator cend() const
Return a read-only iterator past the last element.
boost::typeindex::type_info const & type(std::string const &key) const
Return the type of a key.
const_iterator cbegin() const
Return a read-only iterator to the first element.
Dictionary(Dictionary &&)=default
std::unordered_map< std::string, boost::any > container
Underlying container.
Definition Dictionary.h:26
Dictionary & clear()
Erases all elements.
T & get(std::string const &key)
Return a typed value.
Definition Dictionary.h:88
const_iterator begin() const
Return a read-only iterator to the first element.
Dictionary & insert(std::initializer_list< value_type > &&data)
Inserts elements.
Dictionary()=default
DECLARE_POINTERS(Dictionary)
~Dictionary()=default
bool has(std::string const &key) const
Check whether the key is in the dictionary.
const_iterator end() const
Return a read-only iterator past the last element.
T const & get(std::string const &key) const
Return a typed value (read-only)
Definition Dictionary.h:65
iterator end()
Return a read-write iterator past the last element.
container::mapped_type get(std::string const &key) const
Return a generic value.
Dictionary(Dictionary const &)=default
iterator begin()
Return a read-write iterator to the first element.
container::value_type value_type
Definition Dictionary.h:28
Dictionary & set(std::string const &key, T &&value)
Set the value at given key, create it if required.
Definition Dictionary.h:116
bool empty() const
Check whether the dictionary is empty.
container::const_iterator const_iterator
Read-only iterator on the elements.
Definition Dictionary.h:33
static std::shared_ptr< Dictionary > New(std::initializer_list< value_type > &&data)
Definition Dictionary.h:37
Dictionary & operator=(Dictionary &&)=default
Definition acceleration.h:17