blob: 8c3f241373aacb5e27181cd2db110d4ec61710d3 [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:
296 using difference_type = ptrdiff_t;
297 using value_type = T;
298 using pointer = typename std::add_pointer<T>::type;
299 using reference = typename std::add_lvalue_reference<T>::type;
300 using iterator_category = std::forward_iterator_tag;
301
302 T &operator*() const noexcept;
303 T *operator->() const noexcept;
304 iterator &operator++() noexcept;
305 iterator operator++(int) noexcept;
306 bool operator==(const iterator &) const noexcept;
307 bool operator!=(const iterator &) const noexcept;
308
309private:
310 friend class Vec;
David Tolnaya5d72c62020-11-25 13:57:16 -0800311 friend class Vec<typename std::remove_const<T>::type>;
David Tolnay960b5112020-11-25 13:18:28 -0800312 void *pos;
313 size_t stride;
314};
David Tolnay0f0162f2020-11-16 23:43:37 -0800315#endif // CXXBRIDGE1_RUST_VEC
David Tolnay7f2dc3b2020-04-24 16:46:39 -0700316
David Tolnay0f0162f2020-11-16 23:43:37 -0800317#ifndef CXXBRIDGE1_RUST_FN
David Tolnaye468f052020-11-29 19:39:35 -0800318// https://cxx.rs/binding/fn.html
David Tolnayf031c322020-11-29 19:41:33 -0800319template <typename Signature>
David Tolnayf262d382020-04-11 22:12:40 -0700320class Fn;
David Tolnay75dca2e2020-03-25 20:17:52 -0700321
David Tolnayf031c322020-11-29 19:41:33 -0800322template <typename Ret, typename... Args>
323class Fn<Ret(Args...)> final {
David Tolnay75dca2e2020-03-25 20:17:52 -0700324public:
David Tolnayf031c322020-11-29 19:41:33 -0800325 Ret operator()(Args... args) const noexcept;
David Tolnay533d4582020-04-08 20:29:14 -0700326 Fn operator*() const noexcept;
David Tolnay75dca2e2020-03-25 20:17:52 -0700327
328private:
David Tolnayf031c322020-11-29 19:41:33 -0800329 Ret (*trampoline)(Args..., void *fn) noexcept;
David Tolnay75dca2e2020-03-25 20:17:52 -0700330 void *fn;
331};
David Tolnay0f0162f2020-11-16 23:43:37 -0800332#endif // CXXBRIDGE1_RUST_FN
David Tolnay75dca2e2020-03-25 20:17:52 -0700333
David Tolnay0f0162f2020-11-16 23:43:37 -0800334#ifndef CXXBRIDGE1_RUST_ERROR
335#define CXXBRIDGE1_RUST_ERROR
David Tolnaye468f052020-11-29 19:39:35 -0800336// https://cxx.rs/binding/result.html
David Tolnaye4fa8732020-09-08 15:04:56 -0700337class Error final : public std::exception {
David Tolnay1e548172020-03-16 13:37:09 -0700338public:
339 Error(const Error &);
340 Error(Error &&) noexcept;
David Tolnay2714d2c2020-11-23 18:17:43 -0800341 ~Error() noexcept override;
David Tolnay7c6ac712020-10-31 17:22:28 -0700342
343 Error &operator=(const Error &);
David Tolnay15491062020-10-31 17:25:13 -0700344 Error &operator=(Error &&) noexcept;
David Tolnay7c6ac712020-10-31 17:22:28 -0700345
David Tolnay1e548172020-03-16 13:37:09 -0700346 const char *what() const noexcept override;
347
348private:
David Tolnaya0c9bc72020-10-31 14:37:14 -0700349 Error() noexcept = default;
David Tolnay84ddf9e2020-10-31 15:36:48 -0700350 friend impl<Error>;
David Tolnaya0c9bc72020-10-31 14:37:14 -0700351 const char *msg;
352 size_t len;
David Tolnay1e548172020-03-16 13:37:09 -0700353};
David Tolnay0f0162f2020-11-16 23:43:37 -0800354#endif // CXXBRIDGE1_RUST_ERROR
David Tolnay1e548172020-03-16 13:37:09 -0700355
David Tolnay0f0162f2020-11-16 23:43:37 -0800356#ifndef CXXBRIDGE1_RUST_ISIZE
357#define CXXBRIDGE1_RUST_ISIZE
David Tolnayb8a6fb22020-04-10 11:17:28 -0700358#if defined(_WIN32)
359using isize = SSIZE_T;
360#else
361using isize = ssize_t;
362#endif
David Tolnay0f0162f2020-11-16 23:43:37 -0800363#endif // CXXBRIDGE1_RUST_ISIZE
David Tolnayb8a6fb22020-04-10 11:17:28 -0700364
David Tolnay851677c2020-03-01 23:49:46 -0800365std::ostream &operator<<(std::ostream &, const String &);
366std::ostream &operator<<(std::ostream &, const Str &);
David Tolnay7db73692019-10-20 14:51:12 -0400367
David Tolnay365fc7c2020-11-25 16:08:13 -0800368#ifndef CXXBRIDGE1_RUST_OPAQUE
369#define CXXBRIDGE1_RUST_OPAQUE
370// Base class of generated opaque Rust types.
371class Opaque {
David Tolnaya857c322020-11-25 16:27:19 -0800372public:
David Tolnay365fc7c2020-11-25 16:08:13 -0800373 Opaque() = delete;
374 Opaque(const Opaque &) = delete;
375 ~Opaque() = delete;
376};
377#endif // CXXBRIDGE1_RUST_OPAQUE
378
David Tolnay174bd952020-11-02 09:23:12 -0800379// IsRelocatable<T> is used in assertions that a C++ type passed by value
380// between Rust and C++ is soundly relocatable by Rust.
381//
382// There may be legitimate reasons to opt out of the check for support of types
383// that the programmer knows are soundly Rust-movable despite not being
384// recognized as such by the C++ type system due to a move constructor or
385// destructor. To opt out of the relocatability check, do either of the
386// following things in any header used by `include!` in the bridge.
387//
388// --- if you define the type:
389// struct MyType {
390// ...
391// + using IsRelocatable = std::true_type;
392// };
393//
394// --- otherwise:
395// + template <>
396// + struct rust::IsRelocatable<MyType> : std::true_type {};
397template <typename T>
398struct IsRelocatable;
399
David Tolnay3b0c9882020-03-01 14:08:57 -0800400// Snake case aliases for use in code that uses this style for type names.
401using string = String;
402using str = Str;
David Tolnay4e8c49a2020-11-11 10:00:18 -0800403template <typename T>
David Tolnay38c87642020-09-06 22:18:08 -0700404using slice = Slice<T>;
David Tolnay4e8c49a2020-11-11 10:00:18 -0800405template <typename T>
David Tolnayf262d382020-04-11 22:12:40 -0700406using box = Box<T>;
David Tolnay4e8c49a2020-11-11 10:00:18 -0800407template <typename T>
David Tolnay38c87642020-09-06 22:18:08 -0700408using vec = Vec<T>;
David Tolnay1e548172020-03-16 13:37:09 -0700409using error = Error;
David Tolnayf262d382020-04-11 22:12:40 -0700410template <typename Signature>
David Tolnayf031c322020-11-29 19:41:33 -0800411using fn = Fn<Signature>;
David Tolnay174bd952020-11-02 09:23:12 -0800412template <typename T>
413using is_relocatable = IsRelocatable<T>;
David Tolnay3b0c9882020-03-01 14:08:57 -0800414
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700415
416
417////////////////////////////////////////////////////////////////////////////////
418/// end public API, begin implementation details
419
David Tolnay0f0162f2020-11-16 23:43:37 -0800420#ifndef CXXBRIDGE1_PANIC
421#define CXXBRIDGE1_PANIC
David Tolnay521d99d2020-08-26 20:45:40 -0700422template <typename Exception>
423void panic [[noreturn]] (const char *msg);
David Tolnay0f0162f2020-11-16 23:43:37 -0800424#endif // CXXBRIDGE1_PANIC
David Tolnay521d99d2020-08-26 20:45:40 -0700425
David Tolnay0f0162f2020-11-16 23:43:37 -0800426#ifndef CXXBRIDGE1_RUST_FN
427#define CXXBRIDGE1_RUST_FN
David Tolnayf031c322020-11-29 19:41:33 -0800428template <typename Ret, typename... Args>
429Ret Fn<Ret(Args...)>::operator()(Args... args) const noexcept {
David Tolnay75dca2e2020-03-25 20:17:52 -0700430 return (*this->trampoline)(std::move(args)..., this->fn);
431}
432
David Tolnayf031c322020-11-29 19:41:33 -0800433template <typename Ret, typename... Args>
434Fn<Ret(Args...)> Fn<Ret(Args...)>::operator*() const noexcept {
David Tolnaya23129c2020-04-08 20:08:21 -0700435 return *this;
436}
David Tolnay0f0162f2020-11-16 23:43:37 -0800437#endif // CXXBRIDGE1_RUST_FN
David Tolnaya23129c2020-04-08 20:08:21 -0700438
David Tolnay0f0162f2020-11-16 23:43:37 -0800439#ifndef CXXBRIDGE1_RUST_BITCOPY
440#define CXXBRIDGE1_RUST_BITCOPY
David Tolnay48521222020-10-31 14:59:42 -0700441struct unsafe_bitcopy_t final {
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700442 explicit unsafe_bitcopy_t() = default;
443};
444
445constexpr unsafe_bitcopy_t unsafe_bitcopy{};
David Tolnay0f0162f2020-11-16 23:43:37 -0800446#endif // CXXBRIDGE1_RUST_BITCOPY
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700447
David Tolnay0f0162f2020-11-16 23:43:37 -0800448#ifndef CXXBRIDGE1_RUST_STR
449#define CXXBRIDGE1_RUST_STR
David Tolnay5b1ee1f2020-10-31 18:21:39 -0700450inline const char *Str::data() const noexcept { return this->ptr; }
451
452inline size_t Str::size() const noexcept { return this->len; }
453
454inline size_t Str::length() const noexcept { return this->len; }
David Tolnay0f0162f2020-11-16 23:43:37 -0800455#endif // CXXBRIDGE1_RUST_STR
David Tolnay5b1ee1f2020-10-31 18:21:39 -0700456
David Tolnay0f0162f2020-11-16 23:43:37 -0800457#ifndef CXXBRIDGE1_RUST_SLICE
458#define CXXBRIDGE1_RUST_SLICE
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700459template <typename T>
David Tolnay7b16a392020-11-25 20:23:10 -0800460Slice<T>::Slice() noexcept : ptr(reinterpret_cast<T *>(alignof(T))), len(0) {}
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700461
462template <typename T>
David Tolnayce298232020-11-11 10:08:54 -0800463Slice<T>::Slice(T *s, size_t count) noexcept : ptr(s), len(count) {}
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700464
465template <typename T>
David Tolnayce298232020-11-11 10:08:54 -0800466T *Slice<T>::data() const noexcept {
David Tolnay36aa9e02020-10-31 23:08:21 -0700467 return this->ptr;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700468}
469
470template <typename T>
471size_t Slice<T>::size() const noexcept {
David Tolnay36aa9e02020-10-31 23:08:21 -0700472 return this->len;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700473}
474
475template <typename T>
476size_t Slice<T>::length() const noexcept {
David Tolnay36aa9e02020-10-31 23:08:21 -0700477 return this->len;
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700478}
David Tolnayac6cb542020-11-25 20:18:55 -0800479
480template <typename T>
481T &Slice<T>::iterator::operator*() const noexcept {
482 return *this->pos;
483}
484
485template <typename T>
486T *Slice<T>::iterator::operator->() const noexcept {
487 return this->pos;
488}
489
490template <typename T>
491typename Slice<T>::iterator &Slice<T>::iterator::operator++() noexcept {
492 ++this->pos;
493 return *this;
494}
495
496template <typename T>
497typename Slice<T>::iterator Slice<T>::iterator::operator++(int) noexcept {
498 auto ret = iterator(*this);
499 ++this->pos;
500 return ret;
501}
502
503template <typename T>
504bool Slice<T>::iterator::operator==(const iterator &other) const noexcept {
505 return this->pos == other.pos;
506}
507
508template <typename T>
509bool Slice<T>::iterator::operator!=(const iterator &other) const noexcept {
510 return this->pos != other.pos;
511}
512
513template <typename T>
514typename Slice<T>::iterator Slice<T>::begin() const noexcept {
515 iterator it;
516 it.pos = this->ptr;
517 return it;
518}
519
520template <typename T>
521typename Slice<T>::iterator Slice<T>::end() const noexcept {
522 iterator it = this->begin();
523 it.pos += this->len;
524 return it;
525}
David Tolnay0f0162f2020-11-16 23:43:37 -0800526#endif // CXXBRIDGE1_RUST_SLICE
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700527
David Tolnay0f0162f2020-11-16 23:43:37 -0800528#ifndef CXXBRIDGE1_RUST_BOX
529#define CXXBRIDGE1_RUST_BOX
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700530template <typename T>
531Box<T>::Box(const Box &other) : Box(*other) {}
532
533template <typename T>
534Box<T>::Box(Box &&other) noexcept : ptr(other.ptr) {
535 other.ptr = nullptr;
536}
537
538template <typename T>
539Box<T>::Box(const T &val) {
540 this->uninit();
541 ::new (this->ptr) T(val);
542}
543
544template <typename T>
545Box<T>::Box(T &&val) {
546 this->uninit();
547 ::new (this->ptr) T(std::move(val));
548}
549
550template <typename T>
551Box<T>::~Box() noexcept {
552 if (this->ptr) {
553 this->drop();
554 }
555}
556
557template <typename T>
558Box<T> &Box<T>::operator=(const Box &other) {
559 if (this != &other) {
560 if (this->ptr) {
561 **this = *other;
562 } else {
563 this->uninit();
564 ::new (this->ptr) T(*other);
565 }
566 }
567 return *this;
568}
569
570template <typename T>
571Box<T> &Box<T>::operator=(Box &&other) noexcept {
572 if (this->ptr) {
573 this->drop();
574 }
575 this->ptr = other.ptr;
576 other.ptr = nullptr;
577 return *this;
578}
579
580template <typename T>
581const T *Box<T>::operator->() const noexcept {
582 return this->ptr;
583}
584
585template <typename T>
586const T &Box<T>::operator*() const noexcept {
587 return *this->ptr;
588}
589
590template <typename T>
591T *Box<T>::operator->() noexcept {
592 return this->ptr;
593}
594
595template <typename T>
596T &Box<T>::operator*() noexcept {
597 return *this->ptr;
598}
599
600template <typename T>
601template <typename... Fields>
602Box<T> Box<T>::in_place(Fields &&... fields) {
603 Box box;
604 box.uninit();
605 ::new (box.ptr) T{std::forward<Fields>(fields)...};
606 return box;
607}
608
609template <typename T>
610Box<T> Box<T>::from_raw(T *raw) noexcept {
611 Box box;
612 box.ptr = raw;
613 return box;
614}
615
616template <typename T>
617T *Box<T>::into_raw() noexcept {
618 T *raw = this->ptr;
619 this->ptr = nullptr;
620 return raw;
621}
622
623template <typename T>
David Tolnay79076c72020-11-23 18:16:55 -0800624Box<T>::Box() noexcept = default;
David Tolnay0f0162f2020-11-16 23:43:37 -0800625#endif // CXXBRIDGE1_RUST_BOX
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700626
David Tolnay0f0162f2020-11-16 23:43:37 -0800627#ifndef CXXBRIDGE1_RUST_VEC
628#define CXXBRIDGE1_RUST_VEC
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700629template <typename T>
David Tolnayf799b372020-11-29 23:57:42 -0800630Vec<T>::Vec(std::initializer_list<T> init) : Vec{} {
631 this->reserve_total(init.size());
632 std::move(init.begin(), init.end(), std::back_inserter(*this));
633}
634
635template <typename T>
David Tolnay15671862020-11-23 18:13:56 -0800636Vec<T>::Vec(Vec &&other) noexcept : repr(other.repr) {
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700637 new (&other) Vec();
638}
639
640template <typename T>
641Vec<T>::~Vec() noexcept {
642 this->drop();
643}
644
645template <typename T>
646Vec<T> &Vec<T>::operator=(Vec &&other) noexcept {
647 if (this != &other) {
648 this->drop();
649 this->repr = other.repr;
650 new (&other) Vec();
651 }
652 return *this;
653}
654
655template <typename T>
656bool Vec<T>::empty() const noexcept {
657 return size() == 0;
658}
659
660template <typename T>
David Tolnayfb6b73c2020-11-10 14:32:16 -0800661T *Vec<T>::data() noexcept {
662 return const_cast<T *>(const_cast<const Vec<T> *>(this)->data());
663}
664
665template <typename T>
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700666const T &Vec<T>::operator[](size_t n) const noexcept {
667 auto data = reinterpret_cast<const char *>(this->data());
668 return *reinterpret_cast<const T *>(data + n * this->stride());
669}
670
671template <typename T>
672const T &Vec<T>::at(size_t n) const {
David Tolnay8e1e6ac2020-08-26 20:51:43 -0700673 if (n >= this->size()) {
674 panic<std::out_of_range>("rust::Vec index out of range");
675 }
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700676 return (*this)[n];
677}
678
679template <typename T>
680const T &Vec<T>::front() const {
681 return (*this)[0];
682}
683
684template <typename T>
685const T &Vec<T>::back() const {
David Tolnayb10c4bc2020-08-26 21:55:29 -0700686 return (*this)[this->size() - 1];
Stephen Crane9e48d5b2020-08-21 12:17:02 -0700687}
688
689template <typename T>
David Tolnay908d5e52020-11-30 00:30:59 -0800690T &Vec<T>::operator[](size_t n) noexcept {
691 auto data = reinterpret_cast<char *>(this->data());
692 return *reinterpret_cast<T *>(data + n * this->stride());
693}
694
695template <typename T>
696T &Vec<T>::at(size_t n) {
697 if (n >= this->size()) {
698 panic<std::out_of_range>("rust::Vec index out of range");
699 }
700 return (*this)[n];
701}
702
703template <typename T>
704T &Vec<T>::front() {
705 return (*this)[0];
706}
707
708template <typename T>
709T &Vec<T>::back() {
710 return (*this)[this->size() - 1];
711}
712
713template <typename T>
David Tolnayfb6b73c2020-11-10 14:32:16 -0800714void Vec<T>::reserve(size_t new_cap) {
715 this->reserve_total(new_cap);
716}
717
718template <typename T>
719void Vec<T>::push_back(const T &value) {
720 this->emplace_back(value);
721}
722
723template <typename T>
724void Vec<T>::push_back(T &&value) {
725 this->emplace_back(std::move(value));
726}
727
728template <typename T>
729template <typename... Args>
730void Vec<T>::emplace_back(Args &&... args) {
731 auto size = this->size();
732 this->reserve_total(size + 1);
733 ::new (reinterpret_cast<T *>(reinterpret_cast<char *>(this->data()) +
734 size * this->stride()))
735 T(std::forward<Args>(args)...);
736 this->set_len(size + 1);
737}
738
739template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800740T &Vec<T>::iterator::operator*() const noexcept {
741 return *static_cast<T *>(this->pos);
742}
743
744template <typename T>
745T *Vec<T>::iterator::operator->() const noexcept {
746 return static_cast<T *>(this->pos);
747}
748
749template <typename T>
750typename Vec<T>::iterator &Vec<T>::iterator::operator++() noexcept {
David Tolnay248215e2020-11-25 19:38:26 -0800751 this->pos = static_cast<char *>(this->pos) + this->stride;
David Tolnay960b5112020-11-25 13:18:28 -0800752 return *this;
753}
754
755template <typename T>
756typename Vec<T>::iterator Vec<T>::iterator::operator++(int) noexcept {
757 auto ret = iterator(*this);
David Tolnay248215e2020-11-25 19:38:26 -0800758 this->pos = static_cast<char *>(this->pos) + this->stride;
David Tolnay960b5112020-11-25 13:18:28 -0800759 return ret;
760}
761
762template <typename T>
763bool Vec<T>::iterator::operator==(const iterator &other) const noexcept {
764 return this->pos == other.pos;
765}
766
767template <typename T>
768bool Vec<T>::iterator::operator!=(const iterator &other) const noexcept {
769 return this->pos != other.pos;
770}
771
772template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800773typename Vec<T>::iterator Vec<T>::begin() noexcept {
774 iterator it;
David Tolnaya5d72c62020-11-25 13:57:16 -0800775 it.pos = const_cast<typename std::remove_const<T>::type *>(this->data());
David Tolnay960b5112020-11-25 13:18:28 -0800776 it.stride = this->stride();
777 return it;
778}
779
780template <typename T>
781typename Vec<T>::iterator Vec<T>::end() noexcept {
782 iterator it = this->begin();
David Tolnay248215e2020-11-25 19:38:26 -0800783 it.pos = static_cast<char *>(it.pos) + it.stride * this->size();
David Tolnay960b5112020-11-25 13:18:28 -0800784 return it;
785}
786
787template <typename T>
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700788typename Vec<T>::const_iterator Vec<T>::begin() const noexcept {
David Tolnay960b5112020-11-25 13:18:28 -0800789 return this->cbegin();
790}
791
792template <typename T>
793typename Vec<T>::const_iterator Vec<T>::end() const noexcept {
794 return this->cend();
795}
796
797template <typename T>
798typename Vec<T>::const_iterator Vec<T>::cbegin() const noexcept {
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700799 const_iterator it;
David Tolnaya5d72c62020-11-25 13:57:16 -0800800 it.pos = const_cast<typename std::remove_const<T>::type *>(this->data());
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700801 it.stride = this->stride();
802 return it;
803}
804
805template <typename T>
David Tolnay960b5112020-11-25 13:18:28 -0800806typename Vec<T>::const_iterator Vec<T>::cend() const noexcept {
807 const_iterator it = this->cbegin();
David Tolnay248215e2020-11-25 19:38:26 -0800808 it.pos = static_cast<char *>(it.pos) + it.stride * this->size();
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700809 return it;
810}
811
812// Internal API only intended for the cxxbridge code generator.
813template <typename T>
814Vec<T>::Vec(unsafe_bitcopy_t, const Vec &bits) noexcept : repr(bits.repr) {}
David Tolnay0f0162f2020-11-16 23:43:37 -0800815#endif // CXXBRIDGE1_RUST_VEC
David Tolnay2a2b9ad2020-05-12 20:07:26 -0700816
David Tolnay0f0162f2020-11-16 23:43:37 -0800817#ifndef CXXBRIDGE1_RELOCATABLE
818#define CXXBRIDGE1_RELOCATABLE
David Tolnay174bd952020-11-02 09:23:12 -0800819namespace detail {
820template <typename... Ts>
821struct make_void {
822 using type = void;
823};
824
825template <typename... Ts>
826using void_t = typename make_void<Ts...>::type;
827
828template <typename Void, template <typename...> class, typename...>
829struct detect : std::false_type {};
830template <template <typename...> class T, typename... A>
831struct detect<void_t<T<A...>>, T, A...> : std::true_type {};
832
833template <template <typename...> class T, typename... A>
834using is_detected = detect<void, T, A...>;
835
836template <typename T>
837using detect_IsRelocatable = typename T::IsRelocatable;
838
839template <typename T>
840struct get_IsRelocatable
841 : std::is_same<typename T::IsRelocatable, std::true_type> {};
842} // namespace detail
843
844template <typename T>
845struct IsRelocatable
846 : std::conditional<
847 detail::is_detected<detail::detect_IsRelocatable, T>::value,
848 detail::get_IsRelocatable<T>,
849 std::integral_constant<
850 bool, std::is_trivially_move_constructible<T>::value &&
851 std::is_trivially_destructible<T>::value>>::type {};
David Tolnay0f0162f2020-11-16 23:43:37 -0800852#endif // CXXBRIDGE1_RELOCATABLE
David Tolnay174bd952020-11-02 09:23:12 -0800853
David Tolnay0f0162f2020-11-16 23:43:37 -0800854} // namespace cxxbridge1
David Tolnay750755e2020-03-01 13:04:08 -0800855} // namespace rust