blob: 22636fdfc5d1ae3f9241ac7e6c11e57b9f643649 [file] [log] [blame]
David Tolnay7db73692019-10-20 14:51:12 -04001#pragma once
David Tolnayf799b372020-11-29 23:57:42 -08002#include <algorithm>
David Tolnay7db73692019-10-20 14:51:12 -04003#include <array>
David Tolnay30430f12020-03-19 20:49:00 -07004#include <cstddef>
David Tolnay7db73692019-10-20 14:51:12 -04005#include <cstdint>
David Tolnayb7a7cb62020-03-17 21:18:40 -07006#include <exception>
David Tolnayf799b372020-11-29 23:57:42 -08007#include <initializer_list>
David Tolnay001102a2020-03-01 20:05:04 -08008#include <iosfwd>
David Tolnayd1df4c72020-11-25 20:38:05 -08009#include <iterator>
David Tolnay0ecd05a2020-07-29 16:32:03 -070010#include <new>
Stephen Crane9e48d5b2020-08-21 12:17:02 -070011#include <stdexcept>
David Tolnay7db73692019-10-20 14:51:12 -040012#include <string>
David Tolnayf6292372020-03-01 21:09:11 -080013#include <type_traits>
David Tolnay4791f1c2020-03-17 21:53:16 -070014#include <utility>
David Tolnay37dd7e12020-04-25 12:51:59 -070015#include <vector>
David Tolnay59b5ba12020-04-10 11:32:19 -070016#if defined(_WIN32)
David Tolnayda38b7c2020-09-16 11:50:04 -040017#include <basetsd.h>
David Tolnay59b5ba12020-04-10 11:32:19 -070018#endif
David Tolnay7db73692019-10-20 14:51:12 -040019
David Tolnay750755e2020-03-01 13:04:08 -080020namespace rust {
David Tolnay0f0162f2020-11-16 23:43:37 -080021inline namespace cxxbridge1 {
David Tolnay7db73692019-10-20 14:51:12 -040022
David Tolnay2a2b9ad2020-05-12 20:07:26 -070023struct unsafe_bitcopy_t;
David Tolnayd1e2efc2020-03-03 22:25:43 -080024
David Tolnay84ddf9e2020-10-31 15:36:48 -070025namespace {
26template <typename T>
27class impl;
28}
29
David Tolnay0f0162f2020-11-16 23:43:37 -080030#ifndef CXXBRIDGE1_RUST_STRING
31#define CXXBRIDGE1_RUST_STRING
David Tolnaye468f052020-11-29 19:39:35 -080032// https://cxx.rs/binding/string.html
David Tolnay56082162020-03-01 12:57:33 -080033class String final {
David Tolnay7db73692019-10-20 14:51:12 -040034public:
David Tolnay56082162020-03-01 12:57:33 -080035 String() noexcept;
David Tolnayd9c4ac92020-03-01 20:33:58 -080036 String(const String &) noexcept;
37 String(String &&) noexcept;
David Tolnay56082162020-03-01 12:57:33 -080038 ~String() noexcept;
David Tolnayd9c4ac92020-03-01 20:33:58 -080039
40 String(const std::string &);
41 String(const char *);
David Tolnayc2bbd952020-07-29 18:15:26 -070042 String(const char *, size_t);
David Tolnayd9c4ac92020-03-01 20:33:58 -080043
44 String &operator=(const String &) noexcept;
45 String &operator=(String &&) noexcept;
46
David Tolnay404d6892020-03-01 20:19:41 -080047 explicit operator std::string() const;
David Tolnay7db73692019-10-20 14:51:12 -040048
49 // Note: no null terminator.
50 const char *data() const noexcept;
51 size_t size() const noexcept;
52 size_t length() const noexcept;
53
David Tolnayff7f5fb2020-11-25 20:50:32 -080054 using iterator = char *;
55 iterator begin() noexcept;
56 iterator end() noexcept;
57
58 using const_iterator = const char *;
59 const_iterator begin() const noexcept;
60 const_iterator end() const noexcept;
61 const_iterator cbegin() const noexcept;
62 const_iterator cend() const noexcept;
63
David Tolnayff86dce2020-11-29 19:45:13 -080064 bool operator==(const String &) const noexcept;
65 bool operator!=(const String &) const noexcept;
66 bool operator<(const String &) const noexcept;
67 bool operator<=(const String &) const noexcept;
68 bool operator>(const String &) const noexcept;
69 bool operator>=(const String &) const noexcept;
70
David Tolnayd1e2efc2020-03-03 22:25:43 -080071 // Internal API only intended for the cxxbridge code generator.
72 String(unsafe_bitcopy_t, const String &) noexcept;
73
David Tolnay7db73692019-10-20 14:51:12 -040074private:
75 // Size and alignment statically verified by rust_string.rs.
76 std::array<uintptr_t, 3> repr;
77};
David Tolnay0f0162f2020-11-16 23:43:37 -080078#endif // CXXBRIDGE1_RUST_STRING
David Tolnay7db73692019-10-20 14:51:12 -040079
David Tolnay0f0162f2020-11-16 23:43:37 -080080#ifndef CXXBRIDGE1_RUST_STR
David Tolnaye468f052020-11-29 19:39:35 -080081// https://cxx.rs/binding/str.html
David Tolnay09dbe752020-03-01 13:00:40 -080082class Str final {
David Tolnay7db73692019-10-20 14:51:12 -040083public:
David Tolnay09dbe752020-03-01 13:00:40 -080084 Str() noexcept;
David Tolnay828e5132020-11-29 20:40:40 -080085 Str(const String &) noexcept;
David Tolnay851677c2020-03-01 23:49:46 -080086 Str(const std::string &);
87 Str(const char *);
David Tolnay894c5e42020-07-29 18:20:00 -070088 Str(const char *, size_t);
David Tolnayd9c4ac92020-03-01 20:33:58 -080089
David Tolnay2d7f1172020-10-31 17:58:31 -070090 Str &operator=(const Str &) noexcept = default;
David Tolnayd9c4ac92020-03-01 20:33:58 -080091
David Tolnay404d6892020-03-01 20:19:41 -080092 explicit operator std::string() const;
David Tolnay7db73692019-10-20 14:51:12 -040093
94 // Note: no null terminator.
95 const char *data() const noexcept;
96 size_t size() const noexcept;
97 size_t length() const noexcept;
98
David Tolnayde9a5b12020-10-31 12:15:43 -070099 // Important in order for System V ABI to pass in registers.
100 Str(const Str &) noexcept = default;
101 ~Str() noexcept = default;
102
David Tolnayff7f5fb2020-11-25 20:50:32 -0800103 using iterator = const char *;
104 using const_iterator = const char *;
105 const_iterator begin() const noexcept;
106 const_iterator end() const noexcept;
107 const_iterator cbegin() const noexcept;
108 const_iterator cend() const noexcept;
109
David Tolnayff86dce2020-11-29 19:45:13 -0800110 bool operator==(const Str &) const noexcept;
111 bool operator!=(const Str &) const noexcept;
112 bool operator<(const Str &) const noexcept;
113 bool operator<=(const Str &) const noexcept;
114 bool operator>(const Str &) const noexcept;
115 bool operator>=(const Str &) const noexcept;
116
David Tolnay5df1f062020-10-31 12:31:10 -0700117private:
David Tolnay0356d332020-10-31 19:46:41 -0700118 friend impl<Str>;
David Tolnay7db73692019-10-20 14:51:12 -0400119 // Not necessarily ABI compatible with &str. Codegen will translate to
120 // cxx::rust_str::RustStr which matches this layout.
David Tolnay5df1f062020-10-31 12:31:10 -0700121 const char *ptr;
122 size_t len;
David Tolnay7db73692019-10-20 14:51:12 -0400123};
David Tolnay0f0162f2020-11-16 23:43:37 -0800124#endif // CXXBRIDGE1_RUST_STR
David Tolnay7db73692019-10-20 14:51:12 -0400125
David Tolnay0f0162f2020-11-16 23:43:37 -0800126#ifndef CXXBRIDGE1_RUST_SLICE
David Tolnayc5629f02020-11-23 18:32:46 -0800127namespace detail {
David Tolnayee9b9ee2020-11-25 08:28:50 -0800128template <bool>
David Tolnayc5629f02020-11-23 18:32:46 -0800129struct copy_assignable_if {};
David Tolnayce298232020-11-11 10:08:54 -0800130
David Tolnayc5629f02020-11-23 18:32:46 -0800131template <>
132struct copy_assignable_if<false> {
133 copy_assignable_if() noexcept = default;
134 copy_assignable_if(const copy_assignable_if &) noexcept = default;
135 copy_assignable_if &operator=(const copy_assignable_if &) noexcept = delete;
136 copy_assignable_if &operator=(copy_assignable_if &&) noexcept = default;
137};
138} // namespace detail
139
David Tolnaye468f052020-11-29 19:39:35 -0800140// https://cxx.rs/binding/slice.html
David Tolnayc5629f02020-11-23 18:32:46 -0800141template <typename T>
142class Slice final
143 : private detail::copy_assignable_if<std::is_const<T>::value> {
David Tolnayefe81052020-04-14 16:28:24 -0700144public:
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700145 Slice() noexcept;
David Tolnayce298232020-11-11 10:08:54 -0800146 Slice(T *, size_t count) noexcept;
David Tolnayefe81052020-04-14 16:28:24 -0700147
David Tolnay2d7f1172020-10-31 17:58:31 -0700148 Slice &operator=(const Slice<T> &) noexcept = default;
David Tolnayc5629f02020-11-23 18:32:46 -0800149 Slice &operator=(Slice<T> &&) noexcept = default;
David Tolnayefe81052020-04-14 16:28:24 -0700150
David Tolnayce298232020-11-11 10:08:54 -0800151 T *data() const noexcept;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700152 size_t size() const noexcept;
153 size_t length() const noexcept;
David Tolnayefe81052020-04-14 16:28:24 -0700154
David Tolnayde9a5b12020-10-31 12:15:43 -0700155 // Important in order for System V ABI to pass in registers.
156 Slice(const Slice<T> &) noexcept = default;
157 ~Slice() noexcept = default;
158
David Tolnayac6cb542020-11-25 20:18:55 -0800159 class iterator;
160 iterator begin() const noexcept;
161 iterator end() const noexcept;
162
David Tolnayefe81052020-04-14 16:28:24 -0700163private:
David Tolnay36aa9e02020-10-31 23:08:21 -0700164 friend impl<Slice>;
165 // Not necessarily ABI compatible with &[T]. Codegen will translate to
David Tolnay5515a9e2020-11-25 19:07:54 -0800166 // cxx::rust_slice::RustSlice which matches this layout.
David Tolnayce298232020-11-11 10:08:54 -0800167 T *ptr;
David Tolnay36aa9e02020-10-31 23:08:21 -0700168 size_t len;
David Tolnayefe81052020-04-14 16:28:24 -0700169};
David Tolnayac6cb542020-11-25 20:18:55 -0800170
171template <typename T>
172class Slice<T>::iterator final {
173public:
174 using difference_type = ptrdiff_t;
175 using value_type = T;
176 using pointer = typename std::add_pointer<T>::type;
177 using reference = typename std::add_lvalue_reference<T>::type;
178 using iterator_category = std::forward_iterator_tag;
179
180 T &operator*() const noexcept;
181 T *operator->() const noexcept;
182 iterator &operator++() noexcept;
183 iterator operator++(int) noexcept;
184 bool operator==(const iterator &) const noexcept;
185 bool operator!=(const iterator &) const noexcept;
186
187private:
188 friend class Slice;
189 T *pos;
190};
David Tolnay0f0162f2020-11-16 23:43:37 -0800191#endif // CXXBRIDGE1_RUST_SLICE
David Tolnayefe81052020-04-14 16:28:24 -0700192
David Tolnay0f0162f2020-11-16 23:43:37 -0800193#ifndef CXXBRIDGE1_RUST_BOX
David Tolnaye468f052020-11-29 19:39:35 -0800194// https://cxx.rs/binding/box.html
David Tolnayf262d382020-04-11 22:12:40 -0700195template <typename T>
196class Box final {
David Tolnay7db73692019-10-20 14:51:12 -0400197public:
David Tolnayf6292372020-03-01 21:09:11 -0800198 using value_type = T;
David Tolnay9706a512020-04-24 17:09:01 -0700199 using const_pointer =
200 typename std::add_pointer<typename std::add_const<T>::type>::type;
201 using pointer = typename std::add_pointer<T>::type;
David Tolnayf6292372020-03-01 21:09:11 -0800202
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700203 Box(const Box &);
204 Box(Box &&) noexcept;
205 ~Box() noexcept;
David Tolnay7db73692019-10-20 14:51:12 -0400206
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700207 explicit Box(const T &);
208 explicit Box(T &&);
209
210 Box &operator=(const Box &);
211 Box &operator=(Box &&) noexcept;
212
213 const T *operator->() const noexcept;
214 const T &operator*() const noexcept;
215 T *operator->() noexcept;
216 T &operator*() noexcept;
David Tolnay7db73692019-10-20 14:51:12 -0400217
David Tolnayf262d382020-04-11 22:12:40 -0700218 template <typename... Fields>
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700219 static Box in_place(Fields &&...);
David Tolnay7ce59fc2020-04-11 11:46:33 -0700220
David Tolnay7db73692019-10-20 14:51:12 -0400221 // Important: requires that `raw` came from an into_raw call. Do not pass a
222 // pointer from `new` or any other source.
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700223 static Box from_raw(T *) noexcept;
David Tolnay7db73692019-10-20 14:51:12 -0400224
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700225 T *into_raw() noexcept;
David Tolnay7db73692019-10-20 14:51:12 -0400226
227private:
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700228 Box() noexcept;
David Tolnay7db73692019-10-20 14:51:12 -0400229 void uninit() noexcept;
David Tolnay7db73692019-10-20 14:51:12 -0400230 void drop() noexcept;
David Tolnay33169bd2020-03-06 13:02:08 -0800231 T *ptr;
David Tolnay7db73692019-10-20 14:51:12 -0400232};
David Tolnay0f0162f2020-11-16 23:43:37 -0800233#endif // CXXBRIDGE1_RUST_BOX
David Tolnay7db73692019-10-20 14:51:12 -0400234
David Tolnay0f0162f2020-11-16 23:43:37 -0800235#ifndef CXXBRIDGE1_RUST_VEC
David Tolnaye468f052020-11-29 19:39:35 -0800236// https://cxx.rs/binding/vec.html
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700237template <typename T>
238class Vec final {
239public:
David Tolnayc87c2152020-04-24 17:07:41 -0700240 using value_type = T;
241
David Tolnayf97c2d52020-04-25 16:37:48 -0700242 Vec() noexcept;
David Tolnayf799b372020-11-29 23:57:42 -0800243 Vec(std::initializer_list<T>);
David Tolnay9007e462020-12-11 13:59:08 -0800244 Vec(const Vec &);
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700245 Vec(Vec &&) noexcept;
246 ~Vec() noexcept;
David Tolnaycb800572020-04-24 20:30:43 -0700247
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700248 Vec &operator=(Vec &&) noexcept;
David Tolnayf97c2d52020-04-25 16:37:48 -0700249
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700250 size_t size() const noexcept;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700251 bool empty() const noexcept;
David Tolnay219c0792020-04-24 20:31:37 -0700252 const T *data() const noexcept;
David Tolnayfb6b73c2020-11-10 14:32:16 -0800253 T *data() noexcept;
David Tolnaydc62d712020-12-11 13:51:53 -0800254 size_t capacity() const noexcept;
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700255
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700256 const T &operator[](size_t n) const noexcept;
257 const T &at(size_t n) const;
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700258 const T &front() const;
259 const T &back() const;
260
David Tolnay908d5e52020-11-30 00:30:59 -0800261 T &operator[](size_t n) noexcept;
262 T &at(size_t n);
263 T &front();
264 T &back();
265
David Tolnayfb6b73c2020-11-10 14:32:16 -0800266 void reserve(size_t new_cap);
267 void push_back(const T &value);
268 void push_back(T &&value);
David Tolnay4e8c49a2020-11-11 10:00:18 -0800269 template <typename... Args>
David Tolnayfb6b73c2020-11-10 14:32:16 -0800270 void emplace_back(Args &&... args);
271
David Tolnay960b5112020-11-25 13:18:28 -0800272 class iterator;
273 iterator begin() noexcept;
274 iterator end() noexcept;
275
David Tolnaya5d72c62020-11-25 13:57:16 -0800276 using const_iterator = typename Vec<const T>::iterator;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700277 const_iterator begin() const noexcept;
278 const_iterator end() const noexcept;
David Tolnay960b5112020-11-25 13:18:28 -0800279 const_iterator cbegin() const noexcept;
280 const_iterator cend() const noexcept;
David Tolnayc87c2152020-04-24 17:07:41 -0700281
David Tolnay313b10e2020-04-25 16:30:51 -0700282 // Internal API only intended for the cxxbridge code generator.
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700283 Vec(unsafe_bitcopy_t, const Vec &) noexcept;
David Tolnay313b10e2020-04-25 16:30:51 -0700284
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700285private:
David Tolnay503d0192020-04-24 22:18:56 -0700286 static size_t stride() noexcept;
David Tolnayfb6b73c2020-11-10 14:32:16 -0800287 void reserve_total(size_t cap) noexcept;
288 void set_len(size_t len) noexcept;
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700289 void drop() noexcept;
290
291 // Size and alignment statically verified by rust_vec.rs.
292 std::array<uintptr_t, 3> repr;
293};
David Tolnay66f216c2020-11-25 13:21:00 -0800294
295template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800296class Vec<T>::iterator final {
297public:
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500298 using iterator_category = std::random_access_iterator_tag;
David Tolnay960b5112020-11-25 13:18:28 -0800299 using value_type = T;
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500300 using difference_type = ptrdiff_t;
David Tolnay960b5112020-11-25 13:18:28 -0800301 using pointer = typename std::add_pointer<T>::type;
302 using reference = typename std::add_lvalue_reference<T>::type;
David Tolnay960b5112020-11-25 13:18:28 -0800303
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500304 reference operator*() const noexcept;
305 pointer operator->() const noexcept;
306 reference operator[](difference_type) const noexcept;
307
David Tolnay960b5112020-11-25 13:18:28 -0800308 iterator &operator++() noexcept;
309 iterator operator++(int) noexcept;
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500310 iterator &operator--() noexcept;
311 iterator operator--(int) noexcept;
312
313 iterator &operator+=(difference_type) noexcept;
314 iterator &operator-=(difference_type) noexcept;
315 iterator operator+(difference_type) const noexcept;
316 iterator operator-(difference_type) const noexcept;
317 difference_type operator-(const iterator &) const noexcept;
318
David Tolnay960b5112020-11-25 13:18:28 -0800319 bool operator==(const iterator &) const noexcept;
320 bool operator!=(const iterator &) const noexcept;
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500321 bool operator<(const iterator &) const noexcept;
322 bool operator>(const iterator &) const noexcept;
323 bool operator<=(const iterator &) const noexcept;
324 bool operator>=(const iterator &) const noexcept;
David Tolnay960b5112020-11-25 13:18:28 -0800325
326private:
327 friend class Vec;
David Tolnaya5d72c62020-11-25 13:57:16 -0800328 friend class Vec<typename std::remove_const<T>::type>;
David Tolnay960b5112020-11-25 13:18:28 -0800329 void *pos;
330 size_t stride;
331};
David Tolnay0f0162f2020-11-16 23:43:37 -0800332#endif // CXXBRIDGE1_RUST_VEC
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700333
David Tolnay0f0162f2020-11-16 23:43:37 -0800334#ifndef CXXBRIDGE1_RUST_FN
David Tolnaye468f052020-11-29 19:39:35 -0800335// https://cxx.rs/binding/fn.html
David Tolnayf031c322020-11-29 19:41:33 -0800336template <typename Signature>
David Tolnayf262d382020-04-11 22:12:40 -0700337class Fn;
David Tolnay75dca2e2020-03-25 20:17:52 -0700338
David Tolnayf031c322020-11-29 19:41:33 -0800339template <typename Ret, typename... Args>
340class Fn<Ret(Args...)> final {
David Tolnay75dca2e2020-03-25 20:17:52 -0700341public:
David Tolnayf031c322020-11-29 19:41:33 -0800342 Ret operator()(Args... args) const noexcept;
David Tolnay533d4582020-04-08 20:29:14 -0700343 Fn operator*() const noexcept;
David Tolnay75dca2e2020-03-25 20:17:52 -0700344
345private:
David Tolnayf031c322020-11-29 19:41:33 -0800346 Ret (*trampoline)(Args..., void *fn) noexcept;
David Tolnay75dca2e2020-03-25 20:17:52 -0700347 void *fn;
348};
David Tolnay0f0162f2020-11-16 23:43:37 -0800349#endif // CXXBRIDGE1_RUST_FN
David Tolnay75dca2e2020-03-25 20:17:52 -0700350
David Tolnay0f0162f2020-11-16 23:43:37 -0800351#ifndef CXXBRIDGE1_RUST_ERROR
352#define CXXBRIDGE1_RUST_ERROR
David Tolnaye468f052020-11-29 19:39:35 -0800353// https://cxx.rs/binding/result.html
David Tolnaye4fa8732020-09-08 15:04:56 -0700354class Error final : public std::exception {
David Tolnay1e548172020-03-16 13:37:09 -0700355public:
356 Error(const Error &);
357 Error(Error &&) noexcept;
David Tolnay2714d2c2020-11-23 18:17:43 -0800358 ~Error() noexcept override;
David Tolnay7c6ac712020-10-31 17:22:28 -0700359
360 Error &operator=(const Error &);
David Tolnay15491062020-10-31 17:25:13 -0700361 Error &operator=(Error &&) noexcept;
David Tolnay7c6ac712020-10-31 17:22:28 -0700362
David Tolnay1e548172020-03-16 13:37:09 -0700363 const char *what() const noexcept override;
364
365private:
David Tolnaya0c9bc72020-10-31 14:37:14 -0700366 Error() noexcept = default;
David Tolnay84ddf9e2020-10-31 15:36:48 -0700367 friend impl<Error>;
David Tolnaya0c9bc72020-10-31 14:37:14 -0700368 const char *msg;
369 size_t len;
David Tolnay1e548172020-03-16 13:37:09 -0700370};
David Tolnay0f0162f2020-11-16 23:43:37 -0800371#endif // CXXBRIDGE1_RUST_ERROR
David Tolnay1e548172020-03-16 13:37:09 -0700372
David Tolnay0f0162f2020-11-16 23:43:37 -0800373#ifndef CXXBRIDGE1_RUST_ISIZE
374#define CXXBRIDGE1_RUST_ISIZE
David Tolnayb8a6fb22020-04-10 11:17:28 -0700375#if defined(_WIN32)
376using isize = SSIZE_T;
377#else
378using isize = ssize_t;
379#endif
David Tolnay0f0162f2020-11-16 23:43:37 -0800380#endif // CXXBRIDGE1_RUST_ISIZE
David Tolnayb8a6fb22020-04-10 11:17:28 -0700381
David Tolnay851677c2020-03-01 23:49:46 -0800382std::ostream &operator<<(std::ostream &, const String &);
383std::ostream &operator<<(std::ostream &, const Str &);
David Tolnay7db73692019-10-20 14:51:12 -0400384
David Tolnay365fc7c2020-11-25 16:08:13 -0800385#ifndef CXXBRIDGE1_RUST_OPAQUE
386#define CXXBRIDGE1_RUST_OPAQUE
387// Base class of generated opaque Rust types.
388class Opaque {
David Tolnaya857c322020-11-25 16:27:19 -0800389public:
David Tolnay365fc7c2020-11-25 16:08:13 -0800390 Opaque() = delete;
391 Opaque(const Opaque &) = delete;
392 ~Opaque() = delete;
393};
394#endif // CXXBRIDGE1_RUST_OPAQUE
395
David Tolnay174bd952020-11-02 09:23:12 -0800396// IsRelocatable<T> is used in assertions that a C++ type passed by value
397// between Rust and C++ is soundly relocatable by Rust.
398//
399// There may be legitimate reasons to opt out of the check for support of types
400// that the programmer knows are soundly Rust-movable despite not being
401// recognized as such by the C++ type system due to a move constructor or
402// destructor. To opt out of the relocatability check, do either of the
403// following things in any header used by `include!` in the bridge.
404//
405// --- if you define the type:
406// struct MyType {
407// ...
408// + using IsRelocatable = std::true_type;
409// };
410//
411// --- otherwise:
412// + template <>
413// + struct rust::IsRelocatable<MyType> : std::true_type {};
414template <typename T>
415struct IsRelocatable;
416
David Tolnay3b0c9882020-03-01 14:08:57 -0800417// Snake case aliases for use in code that uses this style for type names.
418using string = String;
419using str = Str;
David Tolnay4e8c49a2020-11-11 10:00:18 -0800420template <typename T>
David Tolnay38c87642020-09-06 22:18:08 -0700421using slice = Slice<T>;
David Tolnay4e8c49a2020-11-11 10:00:18 -0800422template <typename T>
David Tolnayf262d382020-04-11 22:12:40 -0700423using box = Box<T>;
David Tolnay4e8c49a2020-11-11 10:00:18 -0800424template <typename T>
David Tolnay38c87642020-09-06 22:18:08 -0700425using vec = Vec<T>;
David Tolnay1e548172020-03-16 13:37:09 -0700426using error = Error;
David Tolnayf262d382020-04-11 22:12:40 -0700427template <typename Signature>
David Tolnayf031c322020-11-29 19:41:33 -0800428using fn = Fn<Signature>;
David Tolnay174bd952020-11-02 09:23:12 -0800429template <typename T>
430using is_relocatable = IsRelocatable<T>;
David Tolnay3b0c9882020-03-01 14:08:57 -0800431
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700432
433
434////////////////////////////////////////////////////////////////////////////////
435/// end public API, begin implementation details
436
David Tolnay0f0162f2020-11-16 23:43:37 -0800437#ifndef CXXBRIDGE1_PANIC
438#define CXXBRIDGE1_PANIC
David Tolnay521d99d2020-08-26 20:45:40 -0700439template <typename Exception>
440void panic [[noreturn]] (const char *msg);
David Tolnay0f0162f2020-11-16 23:43:37 -0800441#endif // CXXBRIDGE1_PANIC
David Tolnay521d99d2020-08-26 20:45:40 -0700442
David Tolnay0f0162f2020-11-16 23:43:37 -0800443#ifndef CXXBRIDGE1_RUST_FN
444#define CXXBRIDGE1_RUST_FN
David Tolnayf031c322020-11-29 19:41:33 -0800445template <typename Ret, typename... Args>
446Ret Fn<Ret(Args...)>::operator()(Args... args) const noexcept {
David Tolnay75dca2e2020-03-25 20:17:52 -0700447 return (*this->trampoline)(std::move(args)..., this->fn);
448}
449
David Tolnayf031c322020-11-29 19:41:33 -0800450template <typename Ret, typename... Args>
451Fn<Ret(Args...)> Fn<Ret(Args...)>::operator*() const noexcept {
David Tolnaya23129c2020-04-08 20:08:21 -0700452 return *this;
453}
David Tolnay0f0162f2020-11-16 23:43:37 -0800454#endif // CXXBRIDGE1_RUST_FN
David Tolnaya23129c2020-04-08 20:08:21 -0700455
David Tolnay0f0162f2020-11-16 23:43:37 -0800456#ifndef CXXBRIDGE1_RUST_BITCOPY
457#define CXXBRIDGE1_RUST_BITCOPY
David Tolnay48521222020-10-31 14:59:42 -0700458struct unsafe_bitcopy_t final {
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700459 explicit unsafe_bitcopy_t() = default;
460};
461
462constexpr unsafe_bitcopy_t unsafe_bitcopy{};
David Tolnay0f0162f2020-11-16 23:43:37 -0800463#endif // CXXBRIDGE1_RUST_BITCOPY
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700464
David Tolnay0f0162f2020-11-16 23:43:37 -0800465#ifndef CXXBRIDGE1_RUST_STR
466#define CXXBRIDGE1_RUST_STR
David Tolnay5b1ee1f2020-10-31 18:21:39 -0700467inline const char *Str::data() const noexcept { return this->ptr; }
468
469inline size_t Str::size() const noexcept { return this->len; }
470
471inline size_t Str::length() const noexcept { return this->len; }
David Tolnay0f0162f2020-11-16 23:43:37 -0800472#endif // CXXBRIDGE1_RUST_STR
David Tolnay5b1ee1f2020-10-31 18:21:39 -0700473
David Tolnay0f0162f2020-11-16 23:43:37 -0800474#ifndef CXXBRIDGE1_RUST_SLICE
475#define CXXBRIDGE1_RUST_SLICE
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700476template <typename T>
David Tolnay7b16a392020-11-25 20:23:10 -0800477Slice<T>::Slice() noexcept : ptr(reinterpret_cast<T *>(alignof(T))), len(0) {}
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700478
479template <typename T>
David Tolnayce298232020-11-11 10:08:54 -0800480Slice<T>::Slice(T *s, size_t count) noexcept : ptr(s), len(count) {}
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700481
482template <typename T>
David Tolnayce298232020-11-11 10:08:54 -0800483T *Slice<T>::data() const noexcept {
David Tolnay36aa9e02020-10-31 23:08:21 -0700484 return this->ptr;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700485}
486
487template <typename T>
488size_t Slice<T>::size() const noexcept {
David Tolnay36aa9e02020-10-31 23:08:21 -0700489 return this->len;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700490}
491
492template <typename T>
493size_t Slice<T>::length() const noexcept {
David Tolnay36aa9e02020-10-31 23:08:21 -0700494 return this->len;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700495}
David Tolnayac6cb542020-11-25 20:18:55 -0800496
497template <typename T>
498T &Slice<T>::iterator::operator*() const noexcept {
499 return *this->pos;
500}
501
502template <typename T>
503T *Slice<T>::iterator::operator->() const noexcept {
504 return this->pos;
505}
506
507template <typename T>
508typename Slice<T>::iterator &Slice<T>::iterator::operator++() noexcept {
509 ++this->pos;
510 return *this;
511}
512
513template <typename T>
514typename Slice<T>::iterator Slice<T>::iterator::operator++(int) noexcept {
515 auto ret = iterator(*this);
516 ++this->pos;
517 return ret;
518}
519
520template <typename T>
521bool Slice<T>::iterator::operator==(const iterator &other) const noexcept {
522 return this->pos == other.pos;
523}
524
525template <typename T>
526bool Slice<T>::iterator::operator!=(const iterator &other) const noexcept {
527 return this->pos != other.pos;
528}
529
530template <typename T>
531typename Slice<T>::iterator Slice<T>::begin() const noexcept {
532 iterator it;
533 it.pos = this->ptr;
534 return it;
535}
536
537template <typename T>
538typename Slice<T>::iterator Slice<T>::end() const noexcept {
539 iterator it = this->begin();
540 it.pos += this->len;
541 return it;
542}
David Tolnay0f0162f2020-11-16 23:43:37 -0800543#endif // CXXBRIDGE1_RUST_SLICE
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700544
David Tolnay0f0162f2020-11-16 23:43:37 -0800545#ifndef CXXBRIDGE1_RUST_BOX
546#define CXXBRIDGE1_RUST_BOX
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700547template <typename T>
548Box<T>::Box(const Box &other) : Box(*other) {}
549
550template <typename T>
551Box<T>::Box(Box &&other) noexcept : ptr(other.ptr) {
552 other.ptr = nullptr;
553}
554
555template <typename T>
556Box<T>::Box(const T &val) {
557 this->uninit();
558 ::new (this->ptr) T(val);
559}
560
561template <typename T>
562Box<T>::Box(T &&val) {
563 this->uninit();
564 ::new (this->ptr) T(std::move(val));
565}
566
567template <typename T>
568Box<T>::~Box() noexcept {
569 if (this->ptr) {
570 this->drop();
571 }
572}
573
574template <typename T>
575Box<T> &Box<T>::operator=(const Box &other) {
576 if (this != &other) {
577 if (this->ptr) {
578 **this = *other;
579 } else {
580 this->uninit();
581 ::new (this->ptr) T(*other);
582 }
583 }
584 return *this;
585}
586
587template <typename T>
588Box<T> &Box<T>::operator=(Box &&other) noexcept {
589 if (this->ptr) {
590 this->drop();
591 }
592 this->ptr = other.ptr;
593 other.ptr = nullptr;
594 return *this;
595}
596
597template <typename T>
598const T *Box<T>::operator->() const noexcept {
599 return this->ptr;
600}
601
602template <typename T>
603const T &Box<T>::operator*() const noexcept {
604 return *this->ptr;
605}
606
607template <typename T>
608T *Box<T>::operator->() noexcept {
609 return this->ptr;
610}
611
612template <typename T>
613T &Box<T>::operator*() noexcept {
614 return *this->ptr;
615}
616
617template <typename T>
618template <typename... Fields>
619Box<T> Box<T>::in_place(Fields &&... fields) {
620 Box box;
621 box.uninit();
622 ::new (box.ptr) T{std::forward<Fields>(fields)...};
623 return box;
624}
625
626template <typename T>
627Box<T> Box<T>::from_raw(T *raw) noexcept {
628 Box box;
629 box.ptr = raw;
630 return box;
631}
632
633template <typename T>
634T *Box<T>::into_raw() noexcept {
635 T *raw = this->ptr;
636 this->ptr = nullptr;
637 return raw;
638}
639
640template <typename T>
David Tolnay79076c72020-11-23 18:16:55 -0800641Box<T>::Box() noexcept = default;
David Tolnay0f0162f2020-11-16 23:43:37 -0800642#endif // CXXBRIDGE1_RUST_BOX
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700643
David Tolnay0f0162f2020-11-16 23:43:37 -0800644#ifndef CXXBRIDGE1_RUST_VEC
645#define CXXBRIDGE1_RUST_VEC
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700646template <typename T>
David Tolnayf799b372020-11-29 23:57:42 -0800647Vec<T>::Vec(std::initializer_list<T> init) : Vec{} {
648 this->reserve_total(init.size());
649 std::move(init.begin(), init.end(), std::back_inserter(*this));
650}
651
652template <typename T>
David Tolnay9007e462020-12-11 13:59:08 -0800653Vec<T>::Vec(const Vec &other) : Vec() {
654 this->reserve_total(other.size());
655 std::copy(other.begin(), other.end(), std::back_inserter(*this));
656}
657
658template <typename T>
David Tolnay15671862020-11-23 18:13:56 -0800659Vec<T>::Vec(Vec &&other) noexcept : repr(other.repr) {
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700660 new (&other) Vec();
661}
662
663template <typename T>
664Vec<T>::~Vec() noexcept {
665 this->drop();
666}
667
668template <typename T>
669Vec<T> &Vec<T>::operator=(Vec &&other) noexcept {
670 if (this != &other) {
671 this->drop();
672 this->repr = other.repr;
673 new (&other) Vec();
674 }
675 return *this;
676}
677
678template <typename T>
679bool Vec<T>::empty() const noexcept {
680 return size() == 0;
681}
682
683template <typename T>
David Tolnayfb6b73c2020-11-10 14:32:16 -0800684T *Vec<T>::data() noexcept {
685 return const_cast<T *>(const_cast<const Vec<T> *>(this)->data());
686}
687
688template <typename T>
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700689const T &Vec<T>::operator[](size_t n) const noexcept {
690 auto data = reinterpret_cast<const char *>(this->data());
691 return *reinterpret_cast<const T *>(data + n * this->stride());
692}
693
694template <typename T>
695const T &Vec<T>::at(size_t n) const {
David Tolnay8e1e6ac2020-08-26 20:51:43 -0700696 if (n >= this->size()) {
697 panic<std::out_of_range>("rust::Vec index out of range");
698 }
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700699 return (*this)[n];
700}
701
702template <typename T>
703const T &Vec<T>::front() const {
704 return (*this)[0];
705}
706
707template <typename T>
708const T &Vec<T>::back() const {
David Tolnayb10c4bc2020-08-26 21:55:29 -0700709 return (*this)[this->size() - 1];
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700710}
711
712template <typename T>
David Tolnay908d5e52020-11-30 00:30:59 -0800713T &Vec<T>::operator[](size_t n) noexcept {
714 auto data = reinterpret_cast<char *>(this->data());
715 return *reinterpret_cast<T *>(data + n * this->stride());
716}
717
718template <typename T>
719T &Vec<T>::at(size_t n) {
720 if (n >= this->size()) {
721 panic<std::out_of_range>("rust::Vec index out of range");
722 }
723 return (*this)[n];
724}
725
726template <typename T>
727T &Vec<T>::front() {
728 return (*this)[0];
729}
730
731template <typename T>
732T &Vec<T>::back() {
733 return (*this)[this->size() - 1];
734}
735
736template <typename T>
David Tolnayfb6b73c2020-11-10 14:32:16 -0800737void Vec<T>::reserve(size_t new_cap) {
738 this->reserve_total(new_cap);
739}
740
741template <typename T>
742void Vec<T>::push_back(const T &value) {
743 this->emplace_back(value);
744}
745
746template <typename T>
747void Vec<T>::push_back(T &&value) {
748 this->emplace_back(std::move(value));
749}
750
751template <typename T>
752template <typename... Args>
753void Vec<T>::emplace_back(Args &&... args) {
754 auto size = this->size();
755 this->reserve_total(size + 1);
756 ::new (reinterpret_cast<T *>(reinterpret_cast<char *>(this->data()) +
757 size * this->stride()))
758 T(std::forward<Args>(args)...);
759 this->set_len(size + 1);
760}
761
762template <typename T>
David Tolnay300072b2020-12-03 12:12:24 -0800763typename Vec<T>::iterator::reference
764Vec<T>::iterator::operator*() const noexcept {
David Tolnay960b5112020-11-25 13:18:28 -0800765 return *static_cast<T *>(this->pos);
766}
767
768template <typename T>
David Tolnay300072b2020-12-03 12:12:24 -0800769typename Vec<T>::iterator::pointer
770Vec<T>::iterator::operator->() const noexcept {
David Tolnay960b5112020-11-25 13:18:28 -0800771 return static_cast<T *>(this->pos);
772}
773
774template <typename T>
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500775typename Vec<T>::iterator::reference Vec<T>::iterator::operator[](
776 Vec<T>::iterator::difference_type n) const noexcept {
777 auto pos = static_cast<char *>(this->pos) + this->stride * n;
778 return *static_cast<T *>(pos);
779}
780
781template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800782typename Vec<T>::iterator &Vec<T>::iterator::operator++() noexcept {
David Tolnay248215e2020-11-25 19:38:26 -0800783 this->pos = static_cast<char *>(this->pos) + this->stride;
David Tolnay960b5112020-11-25 13:18:28 -0800784 return *this;
785}
786
787template <typename T>
788typename Vec<T>::iterator Vec<T>::iterator::operator++(int) noexcept {
789 auto ret = iterator(*this);
David Tolnay248215e2020-11-25 19:38:26 -0800790 this->pos = static_cast<char *>(this->pos) + this->stride;
David Tolnay960b5112020-11-25 13:18:28 -0800791 return ret;
792}
793
794template <typename T>
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500795typename Vec<T>::iterator &Vec<T>::iterator::operator--() noexcept {
796 this->pos = static_cast<char *>(this->pos) - this->stride;
797 return *this;
798}
799
800template <typename T>
801typename Vec<T>::iterator Vec<T>::iterator::operator--(int) noexcept {
802 auto ret = iterator(*this);
803 this->pos = static_cast<char *>(this->pos) - this->stride;
804 return ret;
805}
806
807template <typename T>
808typename Vec<T>::iterator &
809Vec<T>::iterator::operator+=(Vec<T>::iterator::difference_type n) noexcept {
810 this->pos = static_cast<char *>(this->pos) + this->stride * n;
811 return *this;
812}
813
814template <typename T>
815typename Vec<T>::iterator &
816Vec<T>::iterator::operator-=(Vec<T>::iterator::difference_type n) noexcept {
817 this->pos = static_cast<char *>(this->pos) - this->stride * n;
818 return *this;
819}
820
821template <typename T>
822typename Vec<T>::iterator Vec<T>::iterator::operator+(
823 Vec<T>::iterator::difference_type n) const noexcept {
David Tolnay300072b2020-12-03 12:12:24 -0800824 auto ret = iterator(*this);
825 ret.pos = static_cast<char *>(this->pos) + this->stride * n;
826 return ret;
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500827}
828
829template <typename T>
830typename Vec<T>::iterator Vec<T>::iterator::operator-(
831 Vec<T>::iterator::difference_type n) const noexcept {
David Tolnay300072b2020-12-03 12:12:24 -0800832 auto ret = iterator(*this);
833 ret.pos = static_cast<char *>(this->pos) - this->stride * n;
834 return ret;
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500835}
836
837template <typename T>
838typename Vec<T>::iterator::difference_type
839Vec<T>::iterator::operator-(const iterator &other) const noexcept {
840 auto diff = std::distance(static_cast<char *>(other.pos),
841 static_cast<char *>(this->pos));
David Tolnay300072b2020-12-03 12:12:24 -0800842 return diff / this->stride;
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500843}
844
845template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800846bool Vec<T>::iterator::operator==(const iterator &other) const noexcept {
847 return this->pos == other.pos;
848}
849
850template <typename T>
851bool Vec<T>::iterator::operator!=(const iterator &other) const noexcept {
852 return this->pos != other.pos;
853}
854
855template <typename T>
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500856bool Vec<T>::iterator::operator>(const iterator &other) const noexcept {
857 return this->pos > other.pos;
858}
859
860template <typename T>
861bool Vec<T>::iterator::operator<(const iterator &other) const noexcept {
862 return this->pos < other.pos;
863}
864
865template <typename T>
866bool Vec<T>::iterator::operator>=(const iterator &other) const noexcept {
867 return this->pos >= other.pos;
868}
869
870template <typename T>
871bool Vec<T>::iterator::operator<=(const iterator &other) const noexcept {
872 return this->pos <= other.pos;
873}
874
875template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800876typename Vec<T>::iterator Vec<T>::begin() noexcept {
877 iterator it;
David Tolnaya5d72c62020-11-25 13:57:16 -0800878 it.pos = const_cast<typename std::remove_const<T>::type *>(this->data());
David Tolnay960b5112020-11-25 13:18:28 -0800879 it.stride = this->stride();
880 return it;
881}
882
883template <typename T>
884typename Vec<T>::iterator Vec<T>::end() noexcept {
885 iterator it = this->begin();
David Tolnay248215e2020-11-25 19:38:26 -0800886 it.pos = static_cast<char *>(it.pos) + it.stride * this->size();
David Tolnay960b5112020-11-25 13:18:28 -0800887 return it;
888}
889
890template <typename T>
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700891typename Vec<T>::const_iterator Vec<T>::begin() const noexcept {
David Tolnay960b5112020-11-25 13:18:28 -0800892 return this->cbegin();
893}
894
895template <typename T>
896typename Vec<T>::const_iterator Vec<T>::end() const noexcept {
897 return this->cend();
898}
899
900template <typename T>
901typename Vec<T>::const_iterator Vec<T>::cbegin() const noexcept {
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700902 const_iterator it;
David Tolnaya5d72c62020-11-25 13:57:16 -0800903 it.pos = const_cast<typename std::remove_const<T>::type *>(this->data());
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700904 it.stride = this->stride();
905 return it;
906}
907
908template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800909typename Vec<T>::const_iterator Vec<T>::cend() const noexcept {
910 const_iterator it = this->cbegin();
David Tolnay248215e2020-11-25 19:38:26 -0800911 it.pos = static_cast<char *>(it.pos) + it.stride * this->size();
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700912 return it;
913}
914
915// Internal API only intended for the cxxbridge code generator.
916template <typename T>
917Vec<T>::Vec(unsafe_bitcopy_t, const Vec &bits) noexcept : repr(bits.repr) {}
David Tolnay0f0162f2020-11-16 23:43:37 -0800918#endif // CXXBRIDGE1_RUST_VEC
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700919
David Tolnay0f0162f2020-11-16 23:43:37 -0800920#ifndef CXXBRIDGE1_RELOCATABLE
921#define CXXBRIDGE1_RELOCATABLE
David Tolnay174bd952020-11-02 09:23:12 -0800922namespace detail {
923template <typename... Ts>
924struct make_void {
925 using type = void;
926};
927
928template <typename... Ts>
929using void_t = typename make_void<Ts...>::type;
930
931template <typename Void, template <typename...> class, typename...>
932struct detect : std::false_type {};
933template <template <typename...> class T, typename... A>
934struct detect<void_t<T<A...>>, T, A...> : std::true_type {};
935
936template <template <typename...> class T, typename... A>
937using is_detected = detect<void, T, A...>;
938
939template <typename T>
940using detect_IsRelocatable = typename T::IsRelocatable;
941
942template <typename T>
943struct get_IsRelocatable
944 : std::is_same<typename T::IsRelocatable, std::true_type> {};
945} // namespace detail
946
947template <typename T>
948struct IsRelocatable
949 : std::conditional<
950 detail::is_detected<detail::detect_IsRelocatable, T>::value,
951 detail::get_IsRelocatable<T>,
952 std::integral_constant<
953 bool, std::is_trivially_move_constructible<T>::value &&
954 std::is_trivially_destructible<T>::value>>::type {};
David Tolnay0f0162f2020-11-16 23:43:37 -0800955#endif // CXXBRIDGE1_RELOCATABLE
David Tolnay174bd952020-11-02 09:23:12 -0800956
David Tolnay0f0162f2020-11-16 23:43:37 -0800957} // namespace cxxbridge1
David Tolnay750755e2020-03-01 13:04:08 -0800958} // namespace rust