MongoDB C++ Driver  mongocxx-3.0.0
array_context.hpp
1 // Copyright 2014 MongoDB Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include <bsoncxx/array/value.hpp>
18 #include <bsoncxx/builder/concatenate.hpp>
19 #include <bsoncxx/builder/core.hpp>
20 #include <bsoncxx/builder/stream/closed_context.hpp>
21 #include <bsoncxx/builder/stream/helpers.hpp>
22 #include <bsoncxx/util/functor.hpp>
23 
24 #include <bsoncxx/config/prelude.hpp>
25 
26 namespace bsoncxx {
27 BSONCXX_INLINE_NAMESPACE_BEGIN
28 namespace builder {
29 namespace stream {
30 
31 template <class T>
33 
34 class single_context;
35 
51 template <class base = closed_context>
53  public:
54 
61  BSONCXX_INLINE array_context(core* core) : _core(core) {
62  }
63 
71  template <class T>
72  BSONCXX_INLINE typename std::enable_if<
73  !(util::is_functor<T, void(array_context<>)>::value ||
74  util::is_functor<T, void(single_context)>::value ||
75  std::is_same<typename std::remove_reference<T>::type, const finalize_type>::value),
76  array_context>::type&
77  operator<<(T&& t) {
78  _core->append(std::forward<T>(t));
79  return *this;
80  }
81 
90  template <typename Func>
91  BSONCXX_INLINE typename std::enable_if<(util::is_functor<Func, void(array_context<>)>::value ||
92  util::is_functor<Func, void(single_context)>::value),
93  array_context>::type&
94  operator<<(Func func) {
95  func(*this);
96  return *this;
97  }
98 
110  template <typename T>
111  BSONCXX_INLINE typename std::enable_if<
112  std::is_same<base, closed_context>::value &&
113  std::is_same<typename std::remove_reference<T>::type, const finalize_type>::value,
114  // TODO(MSVC): This should just be 'array::value', but
115  // VS2015U1 can't resolve the name.
116  bsoncxx::array::value>::type
117  operator<<(T&&) {
118  return _core->extract_array();
119  }
120 
128  _core->open_document();
129  return wrap_document();
130  }
131 
142  _core->concatenate(array.view());
143  return *this;
144  }
145 
153  _core->open_array();
154  return wrap_array();
155  }
156 
163  BSONCXX_INLINE base operator<<(const close_array_type) {
164  _core->close_array();
165  return unwrap();
166  }
167 
172  BSONCXX_INLINE operator array_context<>() {
173  return array_context<>(_core);
174  }
175 
181  BSONCXX_INLINE operator single_context();
182 
183  private:
184  BSONCXX_INLINE base unwrap() {
185  return base(_core);
186  }
187 
188  BSONCXX_INLINE array_context<array_context> wrap_array() {
189  return array_context<array_context>(_core);
190  }
191 
192  BSONCXX_INLINE key_context<array_context> wrap_document() {
193  return key_context<array_context>(_core);
194  }
195 
196  core* _core;
197 };
198 
199 } // namespace stream
200 } // namespace builder
201 BSONCXX_INLINE_NAMESPACE_END
202 } // namespace bsoncxx
203 
204 #include <bsoncxx/config/postlude.hpp>
array::view view() const
Accessor that provides a view of the wrapped concatenate array.
Definition: concatenate.hpp:85
A low-level interface for constructing BSON documents and arrays.
Definition: core.hpp:42
A read-only BSON array that owns its underlying buffer.
Definition: value.hpp:34
A stream context which expects any number of values.
Definition: array_context.hpp:52
Definition: helpers.hpp:69
A streaming interface for constructing a BSON array.
Definition: array.hpp:36
std::enable_if< !(util::is_functor< T, void(array_context<>)>::value||util::is_functor< T, void(single_context)>::value||std::is_same< typename std::remove_reference< T >::type, const finalize_type >::value), array_context >::type & operator<<(T &&t)
<< operator for accepting a real value and appending it to the core builder.
Definition: array_context.hpp:77
A stream context which expects a key, which can later be followed by value, then more key/value pairs...
Definition: array_context.hpp:32
A stream context which appends a single value.
Definition: single_context.hpp:36
void open_array()
Opens a sub-array within this BSON datum.
array_context operator<<(concatenate_array array)
<< operator for concatenating another array.
Definition: array_context.hpp:141
array_context(core *core)
Create an array_context given a core builder.
Definition: array_context.hpp:61
void append(const types::b_double &value)
Append a BSON double.
void close_array()
Closes the current sub-array within this BSON datum.
Container to concatenate an array.
Definition: concatenate.hpp:62
array::value extract_array()
Transfer ownership of the underlying document to the caller.
base operator<<(const close_array_type)
<< operator for closing a subarray in the core builder.
Definition: array_context.hpp:163
void concatenate(const document::view &view)
Appends the keys from a BSON document into this BSON datum.
Definition: element.hpp:24
void open_document()
Opens a sub-document within this BSON datum.