blob: cbaf1292ba028414f70903aa1411cef877da8fc1 [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 Tolnay2a2b9ad2020-05-12 20:07:26 -0700244 Vec(Vec &&) noexcept;
245 ~Vec() noexcept;
David Tolnaycb800572020-04-24 20:30:43 -0700246
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700247 Vec &operator=(Vec &&) noexcept;
David Tolnayf97c2d52020-04-25 16:37:48 -0700248
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700249 size_t size() const noexcept;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700250 bool empty() const noexcept;
David Tolnay219c0792020-04-24 20:31:37 -0700251 const T *data() const noexcept;
David Tolnayfb6b73c2020-11-10 14:32:16 -0800252 T *data() noexcept;
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700253
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700254 const T &operator[](size_t n) const noexcept;
255 const T &at(size_t n) const;
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700256 const T &front() const;
257 const T &back() const;
258
David Tolnay908d5e52020-11-30 00:30:59 -0800259 T &operator[](size_t n) noexcept;
260 T &at(size_t n);
261 T &front();
262 T &back();
263
David Tolnayfb6b73c2020-11-10 14:32:16 -0800264 void reserve(size_t new_cap);
265 void push_back(const T &value);
266 void push_back(T &&value);
David Tolnay4e8c49a2020-11-11 10:00:18 -0800267 template <typename... Args>
David Tolnayfb6b73c2020-11-10 14:32:16 -0800268 void emplace_back(Args &&... args);
269
David Tolnay960b5112020-11-25 13:18:28 -0800270 class iterator;
271 iterator begin() noexcept;
272 iterator end() noexcept;
273
David Tolnaya5d72c62020-11-25 13:57:16 -0800274 using const_iterator = typename Vec<const T>::iterator;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700275 const_iterator begin() const noexcept;
276 const_iterator end() const noexcept;
David Tolnay960b5112020-11-25 13:18:28 -0800277 const_iterator cbegin() const noexcept;
278 const_iterator cend() const noexcept;
David Tolnayc87c2152020-04-24 17:07:41 -0700279
David Tolnay313b10e2020-04-25 16:30:51 -0700280 // Internal API only intended for the cxxbridge code generator.
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700281 Vec(unsafe_bitcopy_t, const Vec &) noexcept;
David Tolnay313b10e2020-04-25 16:30:51 -0700282
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700283private:
David Tolnay503d0192020-04-24 22:18:56 -0700284 static size_t stride() noexcept;
David Tolnayfb6b73c2020-11-10 14:32:16 -0800285 void reserve_total(size_t cap) noexcept;
286 void set_len(size_t len) noexcept;
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700287 void drop() noexcept;
288
289 // Size and alignment statically verified by rust_vec.rs.
290 std::array<uintptr_t, 3> repr;
291};
David Tolnay66f216c2020-11-25 13:21:00 -0800292
293template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800294class Vec<T>::iterator final {
295public:
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500296 using iterator_category = std::random_access_iterator_tag;
David Tolnay960b5112020-11-25 13:18:28 -0800297 using value_type = T;
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500298 using difference_type = ptrdiff_t;
David Tolnay960b5112020-11-25 13:18:28 -0800299 using pointer = typename std::add_pointer<T>::type;
300 using reference = typename std::add_lvalue_reference<T>::type;
David Tolnay960b5112020-11-25 13:18:28 -0800301
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500302 reference operator*() const noexcept;
303 pointer operator->() const noexcept;
304 reference operator[](difference_type) const noexcept;
305
David Tolnay960b5112020-11-25 13:18:28 -0800306 iterator &operator++() noexcept;
307 iterator operator++(int) noexcept;
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500308 iterator &operator--() noexcept;
309 iterator operator--(int) noexcept;
310
311 iterator &operator+=(difference_type) noexcept;
312 iterator &operator-=(difference_type) noexcept;
313 iterator operator+(difference_type) const noexcept;
314 iterator operator-(difference_type) const noexcept;
315 difference_type operator-(const iterator &) const noexcept;
316
David Tolnay960b5112020-11-25 13:18:28 -0800317 bool operator==(const iterator &) const noexcept;
318 bool operator!=(const iterator &) const noexcept;
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500319 bool operator<(const iterator &) const noexcept;
320 bool operator>(const iterator &) const noexcept;
321 bool operator<=(const iterator &) const noexcept;
322 bool operator>=(const iterator &) const noexcept;
David Tolnay960b5112020-11-25 13:18:28 -0800323
324private:
325 friend class Vec;
David Tolnaya5d72c62020-11-25 13:57:16 -0800326 friend class Vec<typename std::remove_const<T>::type>;
David Tolnay960b5112020-11-25 13:18:28 -0800327 void *pos;
328 size_t stride;
329};
David Tolnay0f0162f2020-11-16 23:43:37 -0800330#endif // CXXBRIDGE1_RUST_VEC
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700331
David Tolnay0f0162f2020-11-16 23:43:37 -0800332#ifndef CXXBRIDGE1_RUST_FN
David Tolnaye468f052020-11-29 19:39:35 -0800333// https://cxx.rs/binding/fn.html
David Tolnayf031c322020-11-29 19:41:33 -0800334template <typename Signature>
David Tolnayf262d382020-04-11 22:12:40 -0700335class Fn;
David Tolnay75dca2e2020-03-25 20:17:52 -0700336
David Tolnayf031c322020-11-29 19:41:33 -0800337template <typename Ret, typename... Args>
338class Fn<Ret(Args...)> final {
David Tolnay75dca2e2020-03-25 20:17:52 -0700339public:
David Tolnayf031c322020-11-29 19:41:33 -0800340 Ret operator()(Args... args) const noexcept;
David Tolnay533d4582020-04-08 20:29:14 -0700341 Fn operator*() const noexcept;
David Tolnay75dca2e2020-03-25 20:17:52 -0700342
343private:
David Tolnayf031c322020-11-29 19:41:33 -0800344 Ret (*trampoline)(Args..., void *fn) noexcept;
David Tolnay75dca2e2020-03-25 20:17:52 -0700345 void *fn;
346};
David Tolnay0f0162f2020-11-16 23:43:37 -0800347#endif // CXXBRIDGE1_RUST_FN
David Tolnay75dca2e2020-03-25 20:17:52 -0700348
David Tolnay0f0162f2020-11-16 23:43:37 -0800349#ifndef CXXBRIDGE1_RUST_ERROR
350#define CXXBRIDGE1_RUST_ERROR
David Tolnaye468f052020-11-29 19:39:35 -0800351// https://cxx.rs/binding/result.html
David Tolnaye4fa8732020-09-08 15:04:56 -0700352class Error final : public std::exception {
David Tolnay1e548172020-03-16 13:37:09 -0700353public:
354 Error(const Error &);
355 Error(Error &&) noexcept;
David Tolnay2714d2c2020-11-23 18:17:43 -0800356 ~Error() noexcept override;
David Tolnay7c6ac712020-10-31 17:22:28 -0700357
358 Error &operator=(const Error &);
David Tolnay15491062020-10-31 17:25:13 -0700359 Error &operator=(Error &&) noexcept;
David Tolnay7c6ac712020-10-31 17:22:28 -0700360
David Tolnay1e548172020-03-16 13:37:09 -0700361 const char *what() const noexcept override;
362
363private:
David Tolnaya0c9bc72020-10-31 14:37:14 -0700364 Error() noexcept = default;
David Tolnay84ddf9e2020-10-31 15:36:48 -0700365 friend impl<Error>;
David Tolnaya0c9bc72020-10-31 14:37:14 -0700366 const char *msg;
367 size_t len;
David Tolnay1e548172020-03-16 13:37:09 -0700368};
David Tolnay0f0162f2020-11-16 23:43:37 -0800369#endif // CXXBRIDGE1_RUST_ERROR
David Tolnay1e548172020-03-16 13:37:09 -0700370
David Tolnay0f0162f2020-11-16 23:43:37 -0800371#ifndef CXXBRIDGE1_RUST_ISIZE
372#define CXXBRIDGE1_RUST_ISIZE
David Tolnayb8a6fb22020-04-10 11:17:28 -0700373#if defined(_WIN32)
374using isize = SSIZE_T;
375#else
376using isize = ssize_t;
377#endif
David Tolnay0f0162f2020-11-16 23:43:37 -0800378#endif // CXXBRIDGE1_RUST_ISIZE
David Tolnayb8a6fb22020-04-10 11:17:28 -0700379
David Tolnay851677c2020-03-01 23:49:46 -0800380std::ostream &operator<<(std::ostream &, const String &);
381std::ostream &operator<<(std::ostream &, const Str &);
David Tolnay7db73692019-10-20 14:51:12 -0400382
David Tolnay365fc7c2020-11-25 16:08:13 -0800383#ifndef CXXBRIDGE1_RUST_OPAQUE
384#define CXXBRIDGE1_RUST_OPAQUE
385// Base class of generated opaque Rust types.
386class Opaque {
David Tolnaya857c322020-11-25 16:27:19 -0800387public:
David Tolnay365fc7c2020-11-25 16:08:13 -0800388 Opaque() = delete;
389 Opaque(const Opaque &) = delete;
390 ~Opaque() = delete;
391};
392#endif // CXXBRIDGE1_RUST_OPAQUE
393
David Tolnay174bd952020-11-02 09:23:12 -0800394// IsRelocatable<T> is used in assertions that a C++ type passed by value
395// between Rust and C++ is soundly relocatable by Rust.
396//
397// There may be legitimate reasons to opt out of the check for support of types
398// that the programmer knows are soundly Rust-movable despite not being
399// recognized as such by the C++ type system due to a move constructor or
400// destructor. To opt out of the relocatability check, do either of the
401// following things in any header used by `include!` in the bridge.
402//
403// --- if you define the type:
404// struct MyType {
405// ...
406// + using IsRelocatable = std::true_type;
407// };
408//
409// --- otherwise:
410// + template <>
411// + struct rust::IsRelocatable<MyType> : std::true_type {};
412template <typename T>
413struct IsRelocatable;
414
David Tolnay3b0c9882020-03-01 14:08:57 -0800415// Snake case aliases for use in code that uses this style for type names.
416using string = String;
417using str = Str;
David Tolnay4e8c49a2020-11-11 10:00:18 -0800418template <typename T>
David Tolnay38c87642020-09-06 22:18:08 -0700419using slice = Slice<T>;
David Tolnay4e8c49a2020-11-11 10:00:18 -0800420template <typename T>
David Tolnayf262d382020-04-11 22:12:40 -0700421using box = Box<T>;
David Tolnay4e8c49a2020-11-11 10:00:18 -0800422template <typename T>
David Tolnay38c87642020-09-06 22:18:08 -0700423using vec = Vec<T>;
David Tolnay1e548172020-03-16 13:37:09 -0700424using error = Error;
David Tolnayf262d382020-04-11 22:12:40 -0700425template <typename Signature>
David Tolnayf031c322020-11-29 19:41:33 -0800426using fn = Fn<Signature>;
David Tolnay174bd952020-11-02 09:23:12 -0800427template <typename T>
428using is_relocatable = IsRelocatable<T>;
David Tolnay3b0c9882020-03-01 14:08:57 -0800429
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700430
431
432////////////////////////////////////////////////////////////////////////////////
433/// end public API, begin implementation details
434
David Tolnay0f0162f2020-11-16 23:43:37 -0800435#ifndef CXXBRIDGE1_PANIC
436#define CXXBRIDGE1_PANIC
David Tolnay521d99d2020-08-26 20:45:40 -0700437template <typename Exception>
438void panic [[noreturn]] (const char *msg);
David Tolnay0f0162f2020-11-16 23:43:37 -0800439#endif // CXXBRIDGE1_PANIC
David Tolnay521d99d2020-08-26 20:45:40 -0700440
David Tolnay0f0162f2020-11-16 23:43:37 -0800441#ifndef CXXBRIDGE1_RUST_FN
442#define CXXBRIDGE1_RUST_FN
David Tolnayf031c322020-11-29 19:41:33 -0800443template <typename Ret, typename... Args>
444Ret Fn<Ret(Args...)>::operator()(Args... args) const noexcept {
David Tolnay75dca2e2020-03-25 20:17:52 -0700445 return (*this->trampoline)(std::move(args)..., this->fn);
446}
447
David Tolnayf031c322020-11-29 19:41:33 -0800448template <typename Ret, typename... Args>
449Fn<Ret(Args...)> Fn<Ret(Args...)>::operator*() const noexcept {
David Tolnaya23129c2020-04-08 20:08:21 -0700450 return *this;
451}
David Tolnay0f0162f2020-11-16 23:43:37 -0800452#endif // CXXBRIDGE1_RUST_FN
David Tolnaya23129c2020-04-08 20:08:21 -0700453
David Tolnay0f0162f2020-11-16 23:43:37 -0800454#ifndef CXXBRIDGE1_RUST_BITCOPY
455#define CXXBRIDGE1_RUST_BITCOPY
David Tolnay48521222020-10-31 14:59:42 -0700456struct unsafe_bitcopy_t final {
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700457 explicit unsafe_bitcopy_t() = default;
458};
459
460constexpr unsafe_bitcopy_t unsafe_bitcopy{};
David Tolnay0f0162f2020-11-16 23:43:37 -0800461#endif // CXXBRIDGE1_RUST_BITCOPY
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700462
David Tolnay0f0162f2020-11-16 23:43:37 -0800463#ifndef CXXBRIDGE1_RUST_STR
464#define CXXBRIDGE1_RUST_STR
David Tolnay5b1ee1f2020-10-31 18:21:39 -0700465inline const char *Str::data() const noexcept { return this->ptr; }
466
467inline size_t Str::size() const noexcept { return this->len; }
468
469inline size_t Str::length() const noexcept { return this->len; }
David Tolnay0f0162f2020-11-16 23:43:37 -0800470#endif // CXXBRIDGE1_RUST_STR
David Tolnay5b1ee1f2020-10-31 18:21:39 -0700471
David Tolnay0f0162f2020-11-16 23:43:37 -0800472#ifndef CXXBRIDGE1_RUST_SLICE
473#define CXXBRIDGE1_RUST_SLICE
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700474template <typename T>
David Tolnay7b16a392020-11-25 20:23:10 -0800475Slice<T>::Slice() noexcept : ptr(reinterpret_cast<T *>(alignof(T))), len(0) {}
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700476
477template <typename T>
David Tolnayce298232020-11-11 10:08:54 -0800478Slice<T>::Slice(T *s, size_t count) noexcept : ptr(s), len(count) {}
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700479
480template <typename T>
David Tolnayce298232020-11-11 10:08:54 -0800481T *Slice<T>::data() const noexcept {
David Tolnay36aa9e02020-10-31 23:08:21 -0700482 return this->ptr;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700483}
484
485template <typename T>
486size_t Slice<T>::size() const noexcept {
David Tolnay36aa9e02020-10-31 23:08:21 -0700487 return this->len;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700488}
489
490template <typename T>
491size_t Slice<T>::length() const noexcept {
David Tolnay36aa9e02020-10-31 23:08:21 -0700492 return this->len;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700493}
David Tolnayac6cb542020-11-25 20:18:55 -0800494
495template <typename T>
496T &Slice<T>::iterator::operator*() const noexcept {
497 return *this->pos;
498}
499
500template <typename T>
501T *Slice<T>::iterator::operator->() const noexcept {
502 return this->pos;
503}
504
505template <typename T>
506typename Slice<T>::iterator &Slice<T>::iterator::operator++() noexcept {
507 ++this->pos;
508 return *this;
509}
510
511template <typename T>
512typename Slice<T>::iterator Slice<T>::iterator::operator++(int) noexcept {
513 auto ret = iterator(*this);
514 ++this->pos;
515 return ret;
516}
517
518template <typename T>
519bool Slice<T>::iterator::operator==(const iterator &other) const noexcept {
520 return this->pos == other.pos;
521}
522
523template <typename T>
524bool Slice<T>::iterator::operator!=(const iterator &other) const noexcept {
525 return this->pos != other.pos;
526}
527
528template <typename T>
529typename Slice<T>::iterator Slice<T>::begin() const noexcept {
530 iterator it;
531 it.pos = this->ptr;
532 return it;
533}
534
535template <typename T>
536typename Slice<T>::iterator Slice<T>::end() const noexcept {
537 iterator it = this->begin();
538 it.pos += this->len;
539 return it;
540}
David Tolnay0f0162f2020-11-16 23:43:37 -0800541#endif // CXXBRIDGE1_RUST_SLICE
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700542
David Tolnay0f0162f2020-11-16 23:43:37 -0800543#ifndef CXXBRIDGE1_RUST_BOX
544#define CXXBRIDGE1_RUST_BOX
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700545template <typename T>
546Box<T>::Box(const Box &other) : Box(*other) {}
547
548template <typename T>
549Box<T>::Box(Box &&other) noexcept : ptr(other.ptr) {
550 other.ptr = nullptr;
551}
552
553template <typename T>
554Box<T>::Box(const T &val) {
555 this->uninit();
556 ::new (this->ptr) T(val);
557}
558
559template <typename T>
560Box<T>::Box(T &&val) {
561 this->uninit();
562 ::new (this->ptr) T(std::move(val));
563}
564
565template <typename T>
566Box<T>::~Box() noexcept {
567 if (this->ptr) {
568 this->drop();
569 }
570}
571
572template <typename T>
573Box<T> &Box<T>::operator=(const Box &other) {
574 if (this != &other) {
575 if (this->ptr) {
576 **this = *other;
577 } else {
578 this->uninit();
579 ::new (this->ptr) T(*other);
580 }
581 }
582 return *this;
583}
584
585template <typename T>
586Box<T> &Box<T>::operator=(Box &&other) noexcept {
587 if (this->ptr) {
588 this->drop();
589 }
590 this->ptr = other.ptr;
591 other.ptr = nullptr;
592 return *this;
593}
594
595template <typename T>
596const T *Box<T>::operator->() const noexcept {
597 return this->ptr;
598}
599
600template <typename T>
601const T &Box<T>::operator*() const noexcept {
602 return *this->ptr;
603}
604
605template <typename T>
606T *Box<T>::operator->() noexcept {
607 return this->ptr;
608}
609
610template <typename T>
611T &Box<T>::operator*() noexcept {
612 return *this->ptr;
613}
614
615template <typename T>
616template <typename... Fields>
617Box<T> Box<T>::in_place(Fields &&... fields) {
618 Box box;
619 box.uninit();
620 ::new (box.ptr) T{std::forward<Fields>(fields)...};
621 return box;
622}
623
624template <typename T>
625Box<T> Box<T>::from_raw(T *raw) noexcept {
626 Box box;
627 box.ptr = raw;
628 return box;
629}
630
631template <typename T>
632T *Box<T>::into_raw() noexcept {
633 T *raw = this->ptr;
634 this->ptr = nullptr;
635 return raw;
636}
637
638template <typename T>
David Tolnay79076c72020-11-23 18:16:55 -0800639Box<T>::Box() noexcept = default;
David Tolnay0f0162f2020-11-16 23:43:37 -0800640#endif // CXXBRIDGE1_RUST_BOX
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700641
David Tolnay0f0162f2020-11-16 23:43:37 -0800642#ifndef CXXBRIDGE1_RUST_VEC
643#define CXXBRIDGE1_RUST_VEC
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700644template <typename T>
David Tolnayf799b372020-11-29 23:57:42 -0800645Vec<T>::Vec(std::initializer_list<T> init) : Vec{} {
646 this->reserve_total(init.size());
647 std::move(init.begin(), init.end(), std::back_inserter(*this));
648}
649
650template <typename T>
David Tolnay15671862020-11-23 18:13:56 -0800651Vec<T>::Vec(Vec &&other) noexcept : repr(other.repr) {
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700652 new (&other) Vec();
653}
654
655template <typename T>
656Vec<T>::~Vec() noexcept {
657 this->drop();
658}
659
660template <typename T>
661Vec<T> &Vec<T>::operator=(Vec &&other) noexcept {
662 if (this != &other) {
663 this->drop();
664 this->repr = other.repr;
665 new (&other) Vec();
666 }
667 return *this;
668}
669
670template <typename T>
671bool Vec<T>::empty() const noexcept {
672 return size() == 0;
673}
674
675template <typename T>
David Tolnayfb6b73c2020-11-10 14:32:16 -0800676T *Vec<T>::data() noexcept {
677 return const_cast<T *>(const_cast<const Vec<T> *>(this)->data());
678}
679
680template <typename T>
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700681const T &Vec<T>::operator[](size_t n) const noexcept {
682 auto data = reinterpret_cast<const char *>(this->data());
683 return *reinterpret_cast<const T *>(data + n * this->stride());
684}
685
686template <typename T>
687const T &Vec<T>::at(size_t n) const {
David Tolnay8e1e6ac2020-08-26 20:51:43 -0700688 if (n >= this->size()) {
689 panic<std::out_of_range>("rust::Vec index out of range");
690 }
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700691 return (*this)[n];
692}
693
694template <typename T>
695const T &Vec<T>::front() const {
696 return (*this)[0];
697}
698
699template <typename T>
700const T &Vec<T>::back() const {
David Tolnayb10c4bc2020-08-26 21:55:29 -0700701 return (*this)[this->size() - 1];
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700702}
703
704template <typename T>
David Tolnay908d5e52020-11-30 00:30:59 -0800705T &Vec<T>::operator[](size_t n) noexcept {
706 auto data = reinterpret_cast<char *>(this->data());
707 return *reinterpret_cast<T *>(data + n * this->stride());
708}
709
710template <typename T>
711T &Vec<T>::at(size_t n) {
712 if (n >= this->size()) {
713 panic<std::out_of_range>("rust::Vec index out of range");
714 }
715 return (*this)[n];
716}
717
718template <typename T>
719T &Vec<T>::front() {
720 return (*this)[0];
721}
722
723template <typename T>
724T &Vec<T>::back() {
725 return (*this)[this->size() - 1];
726}
727
728template <typename T>
David Tolnayfb6b73c2020-11-10 14:32:16 -0800729void Vec<T>::reserve(size_t new_cap) {
730 this->reserve_total(new_cap);
731}
732
733template <typename T>
734void Vec<T>::push_back(const T &value) {
735 this->emplace_back(value);
736}
737
738template <typename T>
739void Vec<T>::push_back(T &&value) {
740 this->emplace_back(std::move(value));
741}
742
743template <typename T>
744template <typename... Args>
745void Vec<T>::emplace_back(Args &&... args) {
746 auto size = this->size();
747 this->reserve_total(size + 1);
748 ::new (reinterpret_cast<T *>(reinterpret_cast<char *>(this->data()) +
749 size * this->stride()))
750 T(std::forward<Args>(args)...);
751 this->set_len(size + 1);
752}
753
754template <typename T>
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500755typename Vec<T>::iterator::reference Vec<T>::iterator::operator*() const noexcept {
David Tolnay960b5112020-11-25 13:18:28 -0800756 return *static_cast<T *>(this->pos);
757}
758
759template <typename T>
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500760typename Vec<T>::iterator::pointer Vec<T>::iterator::operator->() const noexcept {
David Tolnay960b5112020-11-25 13:18:28 -0800761 return static_cast<T *>(this->pos);
762}
763
764template <typename T>
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500765typename Vec<T>::iterator::reference Vec<T>::iterator::operator[](
766 Vec<T>::iterator::difference_type n) const noexcept {
767 auto pos = static_cast<char *>(this->pos) + this->stride * n;
768 return *static_cast<T *>(pos);
769}
770
771template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800772typename Vec<T>::iterator &Vec<T>::iterator::operator++() noexcept {
David Tolnay248215e2020-11-25 19:38:26 -0800773 this->pos = static_cast<char *>(this->pos) + this->stride;
David Tolnay960b5112020-11-25 13:18:28 -0800774 return *this;
775}
776
777template <typename T>
778typename Vec<T>::iterator Vec<T>::iterator::operator++(int) noexcept {
779 auto ret = iterator(*this);
David Tolnay248215e2020-11-25 19:38:26 -0800780 this->pos = static_cast<char *>(this->pos) + this->stride;
David Tolnay960b5112020-11-25 13:18:28 -0800781 return ret;
782}
783
784template <typename T>
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500785typename Vec<T>::iterator &Vec<T>::iterator::operator--() noexcept {
786 this->pos = static_cast<char *>(this->pos) - this->stride;
787 return *this;
788}
789
790template <typename T>
791typename Vec<T>::iterator Vec<T>::iterator::operator--(int) noexcept {
792 auto ret = iterator(*this);
793 this->pos = static_cast<char *>(this->pos) - this->stride;
794 return ret;
795}
796
797template <typename T>
798typename Vec<T>::iterator &
799Vec<T>::iterator::operator+=(Vec<T>::iterator::difference_type n) noexcept {
800 this->pos = static_cast<char *>(this->pos) + this->stride * n;
801 return *this;
802}
803
804template <typename T>
805typename Vec<T>::iterator &
806Vec<T>::iterator::operator-=(Vec<T>::iterator::difference_type n) noexcept {
807 this->pos = static_cast<char *>(this->pos) - this->stride * n;
808 return *this;
809}
810
811template <typename T>
812typename Vec<T>::iterator Vec<T>::iterator::operator+(
813 Vec<T>::iterator::difference_type n) const noexcept {
814 auto temp = iterator(*this);
815 temp.pos = static_cast<char *>(this->pos) + this->stride * n;
816 return temp;
817}
818
819template <typename T>
820typename Vec<T>::iterator Vec<T>::iterator::operator-(
821 Vec<T>::iterator::difference_type n) const noexcept {
822 auto temp = iterator(*this);
823 temp.pos = static_cast<char *>(this->pos) - this->stride * n;
824 return temp;
825}
826
827template <typename T>
828typename Vec<T>::iterator::difference_type
829Vec<T>::iterator::operator-(const iterator &other) const noexcept {
830 auto diff = std::distance(static_cast<char *>(other.pos),
831 static_cast<char *>(this->pos));
832 return diff / stride;
833}
834
835template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800836bool Vec<T>::iterator::operator==(const iterator &other) const noexcept {
837 return this->pos == other.pos;
838}
839
840template <typename T>
841bool Vec<T>::iterator::operator!=(const iterator &other) const noexcept {
842 return this->pos != other.pos;
843}
844
845template <typename T>
Yan Zaretskiyefd5cd42020-12-03 09:22:22 -0500846bool 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>
856bool 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>
David Tolnay960b5112020-11-25 13:18:28 -0800866typename Vec<T>::iterator Vec<T>::begin() noexcept {
867 iterator it;
David Tolnaya5d72c62020-11-25 13:57:16 -0800868 it.pos = const_cast<typename std::remove_const<T>::type *>(this->data());
David Tolnay960b5112020-11-25 13:18:28 -0800869 it.stride = this->stride();
870 return it;
871}
872
873template <typename T>
874typename Vec<T>::iterator Vec<T>::end() noexcept {
875 iterator it = this->begin();
David Tolnay248215e2020-11-25 19:38:26 -0800876 it.pos = static_cast<char *>(it.pos) + it.stride * this->size();
David Tolnay960b5112020-11-25 13:18:28 -0800877 return it;
878}
879
880template <typename T>
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700881typename Vec<T>::const_iterator Vec<T>::begin() const noexcept {
David Tolnay960b5112020-11-25 13:18:28 -0800882 return this->cbegin();
883}
884
885template <typename T>
886typename Vec<T>::const_iterator Vec<T>::end() const noexcept {
887 return this->cend();
888}
889
890template <typename T>
891typename Vec<T>::const_iterator Vec<T>::cbegin() const noexcept {
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700892 const_iterator it;
David Tolnaya5d72c62020-11-25 13:57:16 -0800893 it.pos = const_cast<typename std::remove_const<T>::type *>(this->data());
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700894 it.stride = this->stride();
895 return it;
896}
897
898template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800899typename Vec<T>::const_iterator Vec<T>::cend() const noexcept {
900 const_iterator it = this->cbegin();
David Tolnay248215e2020-11-25 19:38:26 -0800901 it.pos = static_cast<char *>(it.pos) + it.stride * this->size();
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700902 return it;
903}
904
905// Internal API only intended for the cxxbridge code generator.
906template <typename T>
907Vec<T>::Vec(unsafe_bitcopy_t, const Vec &bits) noexcept : repr(bits.repr) {}
David Tolnay0f0162f2020-11-16 23:43:37 -0800908#endif // CXXBRIDGE1_RUST_VEC
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700909
David Tolnay0f0162f2020-11-16 23:43:37 -0800910#ifndef CXXBRIDGE1_RELOCATABLE
911#define CXXBRIDGE1_RELOCATABLE
David Tolnay174bd952020-11-02 09:23:12 -0800912namespace detail {
913template <typename... Ts>
914struct make_void {
915 using type = void;
916};
917
918template <typename... Ts>
919using void_t = typename make_void<Ts...>::type;
920
921template <typename Void, template <typename...> class, typename...>
922struct detect : std::false_type {};
923template <template <typename...> class T, typename... A>
924struct detect<void_t<T<A...>>, T, A...> : std::true_type {};
925
926template <template <typename...> class T, typename... A>
927using is_detected = detect<void, T, A...>;
928
929template <typename T>
930using detect_IsRelocatable = typename T::IsRelocatable;
931
932template <typename T>
933struct get_IsRelocatable
934 : std::is_same<typename T::IsRelocatable, std::true_type> {};
935} // namespace detail
936
937template <typename T>
938struct IsRelocatable
939 : std::conditional<
940 detail::is_detected<detail::detect_IsRelocatable, T>::value,
941 detail::get_IsRelocatable<T>,
942 std::integral_constant<
943 bool, std::is_trivially_move_constructible<T>::value &&
944 std::is_trivially_destructible<T>::value>>::type {};
David Tolnay0f0162f2020-11-16 23:43:37 -0800945#endif // CXXBRIDGE1_RELOCATABLE
David Tolnay174bd952020-11-02 09:23:12 -0800946
David Tolnay0f0162f2020-11-16 23:43:37 -0800947} // namespace cxxbridge1
David Tolnay750755e2020-03-01 13:04:08 -0800948} // namespace rust