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
|
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2022 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
/**
* @file ostream_containers.hpp
* @brief Coercion safe method to insert a container into an ostream
*
* The contained type T must be ostream'able
*/
#pragma once
#include <ostream>
namespace openvpn {
namespace C2os {
/**
* @brief New typename for holding the underlying container type
*
* Note also that C2os::Container could be extended by passing in optional arguments to
* the Container ctor that could adjust the formatting (e.g., different delimiter,
* curlies vs square brackets, etc.)
*
* @tparam C underlying container type
*/
template <typename C>
struct Container
{
explicit Container(const C &container)
: ref(container)
{
}
const C &ref;
};
/**
* @brief Provide an instance of C2os::Container<C> from the underlying container
*
* This is the only interface the consumer sees (but see cast_deref, below)
*
* @tparam C underlying container type (deduced from the container param)
* @param container instance of the underlying container
* @return const C2os::Container<C> instance
*/
template <typename C>
inline const auto cast(const C &container)
{
return Container<C>(container);
}
/**
* @brief overload ostream operator<< for the C2os::Container<C> type
*
* @tparam C underlying container type
* @param os ostream instance
* @param container instance of the underlying container
* @return std::ostream& param os
*/
template <typename C>
inline std::ostream &operator<<(std::ostream &os, const Container<C> &container)
{
constexpr char separator[] = ", ";
const char *delimiter = "";
os << "[";
for (const auto &e : container.ref)
{
os << delimiter << e;
delimiter = separator;
}
os << "]";
return os;
}
/**
* @brief same idea as C2os::Container<C>, above; importantly, with a different typename
*
* @tparam C underlying container type
*/
template <typename C>
struct PtrContainer : Container<C>
{
using Container<C>::Container;
};
/**
* @brief Provide an instance of C2os::PtrContainer<C> from the underlying container
*
* This is the only interface the consumer sees if he wants to dereference the contained
* type T \a before ostream'ing it
*
* @tparam C underlying container type (deduced from the container param)
* @param container instance of the underlying container
* @return const C2os::PtrContainer<C> instance
*/
template <typename C>
inline const auto cast_deref(const C &container)
{
return PtrContainer<C>(container);
}
/**
* @brief overload ostream operator<< for the C2os::PtrContainer<C> type
*
* @tparam C underlying container type
* @param os ostream instance
* @param container instance of the underlying container
* @return std::ostream& param os
*/
template <typename C>
inline std::ostream &operator<<(std::ostream &os, const PtrContainer<C> &container)
{
constexpr char separator[] = ", ";
const char *delimiter = "";
os << "[";
for (const auto &e : container.ref)
{
os << delimiter << *e;
delimiter = separator;
}
os << "]";
return os;
}
} // namespace C2os
} // namespace openvpn
|
