File: map.hpp

package info (click to toggle)
qpid-proton 0.37.0-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 18,384 kB
  • sloc: ansic: 37,828; cpp: 37,140; python: 15,302; ruby: 6,018; xml: 477; sh: 320; pascal: 52; makefile: 18
file content (161 lines) | stat: -rw-r--r-- 4,688 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
#ifndef PROTON_MAP_HPP
#define PROTON_MAP_HPP

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */

#include "./value.hpp"

#include <cstddef>
#include <initializer_list>
#include <map>
#include <memory>

/// @file
/// @copybrief proton::map

namespace proton {

namespace codec {
class decoder;
class encoder;
}

template <class K, class T>
class map_type_impl;

template <class K, class T>
class map;

/// Decode from a proton::map
template <class K, class T>
PN_CPP_EXTERN proton::codec::decoder& operator>>(proton::codec::decoder& d, map<K,T>& m);
/// Encode to a proton::map
template <class K, class T>
PN_CPP_EXTERN proton::codec::encoder& operator<<(proton::codec::encoder& e, const map<K,T>& m);
/// Swap proton::map instances
template <class K, class T>
PN_CPP_EXTERN void swap(map<K,T>&, map<K,T>&);

/// A collection of key-value pairs.
///
/// Used to access standard AMQP property, annotation, and filter maps
/// attached to proton::message and proton::source.
///
/// This class provides only basic get() and put() operations for
/// convenience.  For more complicated uses (iteration, preserving
/// order, and so on), convert the value to a standard C++ map type
/// such as `std::map`. See @ref message_properties.cpp and @ref
/// types_page.
template <class K, class T>
class PN_CPP_CLASS_EXTERN map {
    template <class M, class U=void>
        struct assignable_map :
            public std::enable_if<codec::is_encodable_map<M,K,T>::value, U> {};

 public:
    /// Construct an empty map.
    PN_CPP_EXTERN map();

    /// Copy a map.
    PN_CPP_EXTERN map(const map&);

    /// Copy a map.
    PN_CPP_EXTERN map& operator=(const map&);

    /// Copy a std::map.
    PN_CPP_EXTERN map(const std::map<K, T>&);

    /// Copy a std::map.
    PN_CPP_EXTERN map& operator=(const std::map<K, T>&);

    /// Initializer_list constructor.
    PN_CPP_EXTERN map(const std::initializer_list<std::pair<const K, T>>&);

    /// Move a map.
    PN_CPP_EXTERN map(map&&);

    /// Move a map.
    PN_CPP_EXTERN map& operator=(map&&);
    PN_CPP_EXTERN ~map();

    /// Type-safe assign from a compatible map, for instance
    /// `std::map<K,T>`. See @ref types_page.
    template <class M>
    typename assignable_map<M, map&>::type operator=(const M& x) { value(x); return *this; }

    /// Copy from a proton::value.
    ///
    /// @throw proton::conversion_error if `x` does not contain a
    /// compatible map.
    PN_CPP_EXTERN void value(const value& x);

    /// Access as a proton::value containing an AMQP map.
    PN_CPP_EXTERN proton::value& value();

    /// Access as a proton::value containing an AMQP map.
    PN_CPP_EXTERN const proton::value& value() const;

    /// Get the map entry for key `k`.  Return `T()` if there is no
    /// such entry.
    PN_CPP_EXTERN T get(const K& k) const;

    /// Put a map entry for key `k`.
    PN_CPP_EXTERN void put(const K& k, const T& v);

    /// Erase the map entry at `k`.
    PN_CPP_EXTERN size_t erase(const K& k);

    /// True if the map has an entry for `k`.
    PN_CPP_EXTERN bool exists(const K& k) const;

    /// Get the number of map entries.
    PN_CPP_EXTERN size_t size() const;

    /// Remove all map entries.
    PN_CPP_EXTERN void clear();

    /// True if the map has no entries.
    PN_CPP_EXTERN bool empty() const;

    /// @cond INTERNAL
    explicit map(pn_data_t*);
    void reset(pn_data_t*);
    /// @endcond

  private:
    typedef map_type_impl<K,T> map_type;
    mutable std::unique_ptr<map_type> map_;
    mutable proton::value value_;

    map_type& cache() const;
    proton::value& flush() const;

    /// @cond INTERNAL
  friend PN_CPP_EXTERN proton::codec::decoder& operator>> <>(proton::codec::decoder&, map&);
  friend PN_CPP_EXTERN proton::codec::encoder& operator<< <>(proton::codec::encoder&, const map&);
  friend PN_CPP_EXTERN void swap<>(map&, map&);
    /// @endcond
};

} // proton

#endif // PROTON_MAP_HPP