blob: adcd048871183294622be25e6b83bce7b7bcd16e [file] [log] [blame]
David Tolnay0c033e32020-11-01 15:15:48 -08001use crate::gen::block::Block;
David Tolnay3374d8d2020-10-31 22:18:45 -07002use crate::gen::ifndef;
3use crate::gen::out::{Content, OutFile};
David Tolnay8c14d9a2020-10-31 21:52:38 -07004
David Tolnay3be0e1f2020-10-31 20:53:00 -07005#[derive(Default, PartialEq)]
David Tolnay97c5b862020-11-01 14:59:01 -08006pub struct Builtins<'a> {
David Tolnay3be0e1f2020-10-31 20:53:00 -07007 pub panic: bool,
8 pub rust_string: bool,
9 pub rust_str: bool,
10 pub rust_slice: bool,
11 pub rust_box: bool,
12 pub rust_vec: bool,
13 pub rust_fn: bool,
14 pub rust_isize: bool,
David Tolnay365fc7c2020-11-25 16:08:13 -080015 pub opaque: bool,
David Tolnayee6ecfc2020-12-26 21:54:37 -080016 pub layout: bool,
David Tolnay3be0e1f2020-10-31 20:53:00 -070017 pub unsafe_bitcopy: bool,
18 pub rust_error: bool,
19 pub manually_drop: bool,
20 pub maybe_uninit: bool,
21 pub trycatch: bool,
David Tolnay919085c2020-10-31 22:32:22 -070022 pub ptr_len: bool,
David Tolnayfe77f332021-01-02 17:39:51 -080023 pub repr_fat: bool,
David Tolnaye5cd1482021-01-02 21:04:32 -080024 pub rust_str_new_unchecked: bool,
25 pub rust_str_repr: bool,
26 pub rust_slice_new: bool,
27 pub rust_slice_repr: bool,
David Tolnay1f010c62020-11-01 20:27:46 -080028 pub exception: bool,
David Tolnay174bd952020-11-02 09:23:12 -080029 pub relocatable: bool,
David Tolnay22664ae2020-11-04 16:30:45 -080030 pub friend_impl: bool,
David Tolnay53462762020-11-25 07:08:10 -080031 pub is_complete: bool,
32 pub deleter_if: bool,
David Tolnay97c5b862020-11-01 14:59:01 -080033 pub content: Content<'a>,
David Tolnay3be0e1f2020-10-31 20:53:00 -070034}
35
David Tolnay97c5b862020-11-01 14:59:01 -080036impl<'a> Builtins<'a> {
David Tolnay3be0e1f2020-10-31 20:53:00 -070037 pub fn new() -> Self {
38 Builtins::default()
39 }
40}
David Tolnay3374d8d2020-10-31 22:18:45 -070041
42pub(super) fn write(out: &mut OutFile) {
43 if out.builtin == Default::default() {
44 return;
45 }
46
47 let include = &mut out.include;
48 let builtin = &mut out.builtin;
49 let out = &mut builtin.content;
50
David Tolnaydcfa8e92020-11-02 09:50:06 -080051 if builtin.rust_string {
52 include.array = true;
53 include.cstdint = true;
54 include.string = true;
55 }
56
57 if builtin.rust_str {
David Tolnay851d2f72021-01-04 12:20:50 -080058 include.array = true;
David Tolnaydcfa8e92020-11-02 09:50:06 -080059 include.cstdint = true;
60 include.string = true;
David Tolnay22664ae2020-11-04 16:30:45 -080061 builtin.friend_impl = true;
62 }
63
David Tolnay725bf502020-12-27 02:47:40 -080064 if builtin.rust_vec {
65 include.algorithm = true;
66 include.array = true;
David Tolnayecb4dbf2021-01-14 11:22:34 -080067 include.cassert = true;
David Tolnay725bf502020-12-27 02:47:40 -080068 include.cstddef = true;
David Tolnay851d2f72021-01-04 12:20:50 -080069 include.cstdint = true;
David Tolnay725bf502020-12-27 02:47:40 -080070 include.initializer_list = true;
71 include.iterator = true;
72 include.new = true;
73 include.type_traits = true;
74 include.utility = true;
75 builtin.panic = true;
76 builtin.rust_slice = true;
77 builtin.unsafe_bitcopy = true;
78 }
79
David Tolnay22664ae2020-11-04 16:30:45 -080080 if builtin.rust_slice {
David Tolnay851d2f72021-01-04 12:20:50 -080081 include.array = true;
David Tolnayecb4dbf2021-01-14 11:22:34 -080082 include.cassert = true;
David Tolnay08679ae2020-12-12 22:10:01 -080083 include.cstddef = true;
David Tolnay851d2f72021-01-04 12:20:50 -080084 include.cstdint = true;
David Tolnayd1df4c72020-11-25 20:38:05 -080085 include.iterator = true;
David Tolnay450d8cd2020-11-25 20:36:06 -080086 include.type_traits = true;
David Tolnay22664ae2020-11-04 16:30:45 -080087 builtin.friend_impl = true;
David Tolnay6f92baa2020-12-27 01:09:26 -080088 builtin.layout = true;
David Tolnay78dd5352020-12-26 23:44:20 -080089 builtin.panic = true;
David Tolnaydcfa8e92020-11-02 09:50:06 -080090 }
91
92 if builtin.rust_box {
93 include.new = true;
94 include.type_traits = true;
David Tolnayea6f86c2020-11-10 15:08:57 -080095 include.utility = true;
David Tolnaydcfa8e92020-11-02 09:50:06 -080096 }
97
David Tolnaya5a13012020-11-10 15:03:09 -080098 if builtin.rust_fn {
99 include.utility = true;
100 }
101
David Tolnaydcfa8e92020-11-02 09:50:06 -0800102 if builtin.rust_error {
103 include.exception = true;
David Tolnay22664ae2020-11-04 16:30:45 -0800104 builtin.friend_impl = true;
David Tolnaydcfa8e92020-11-02 09:50:06 -0800105 }
106
107 if builtin.rust_isize {
108 include.basetsd = true;
David Tolnay74dd66f2020-12-12 22:03:47 -0800109 include.sys_types = true;
David Tolnaydcfa8e92020-11-02 09:50:06 -0800110 }
111
David Tolnay174bd952020-11-02 09:23:12 -0800112 if builtin.relocatable {
113 include.type_traits = true;
114 }
115
David Tolnayee6ecfc2020-12-26 21:54:37 -0800116 if builtin.layout {
117 include.type_traits = true;
118 include.cstddef = true;
119 builtin.is_complete = true;
120 }
121
David Tolnay75068632020-12-26 22:15:17 -0800122 if builtin.is_complete {
123 include.cstddef = true;
124 include.type_traits = true;
125 }
126
David Tolnay0c033e32020-11-01 15:15:48 -0800127 out.begin_block(Block::Namespace("rust"));
David Tolnay0f0162f2020-11-16 23:43:37 -0800128 out.begin_block(Block::InlineNamespace("cxxbridge1"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700129
David Tolnay5e14b102021-03-26 00:17:07 -0400130 let cxx_header = include.has_cxx_header();
David Tolnayccd269d2021-03-25 23:53:38 -0400131 if !cxx_header {
132 writeln!(out, "// #include \"rust/cxx.h\"");
David Tolnay3374d8d2020-10-31 22:18:45 -0700133
David Tolnayccd269d2021-03-25 23:53:38 -0400134 ifndef::write(out, builtin.panic, "CXXBRIDGE1_PANIC");
135
136 if builtin.rust_string {
137 out.next_section();
138 writeln!(out, "struct unsafe_bitcopy_t;");
139 }
140
141 if builtin.friend_impl {
142 out.begin_block(Block::AnonymousNamespace);
143 writeln!(out, "template <typename T>");
144 writeln!(out, "class impl;");
145 out.end_block(Block::AnonymousNamespace);
146 }
147
David Tolnay3374d8d2020-10-31 22:18:45 -0700148 out.next_section();
David Tolnayccd269d2021-03-25 23:53:38 -0400149 if builtin.rust_str && !builtin.rust_string {
150 writeln!(out, "class String;");
151 }
152 if builtin.layout && !builtin.opaque {
153 writeln!(out, "class Opaque;");
154 }
David Tolnay3374d8d2020-10-31 22:18:45 -0700155
David Tolnayccd269d2021-03-25 23:53:38 -0400156 if builtin.rust_slice {
157 out.next_section();
158 writeln!(out, "template <typename T>");
159 writeln!(out, "::std::size_t size_of();");
160 writeln!(out, "template <typename T>");
161 writeln!(out, "::std::size_t align_of();");
162 }
David Tolnay3374d8d2020-10-31 22:18:45 -0700163
David Tolnayccd269d2021-03-25 23:53:38 -0400164 ifndef::write(out, builtin.rust_string, "CXXBRIDGE1_RUST_STRING");
165 ifndef::write(out, builtin.rust_str, "CXXBRIDGE1_RUST_STR");
166 ifndef::write(out, builtin.rust_slice, "CXXBRIDGE1_RUST_SLICE");
167 ifndef::write(out, builtin.rust_box, "CXXBRIDGE1_RUST_BOX");
168 ifndef::write(out, builtin.unsafe_bitcopy, "CXXBRIDGE1_RUST_BITCOPY");
169 ifndef::write(out, builtin.rust_vec, "CXXBRIDGE1_RUST_VEC");
170 ifndef::write(out, builtin.rust_fn, "CXXBRIDGE1_RUST_FN");
171 ifndef::write(out, builtin.rust_error, "CXXBRIDGE1_RUST_ERROR");
172 ifndef::write(out, builtin.rust_isize, "CXXBRIDGE1_RUST_ISIZE");
173 ifndef::write(out, builtin.opaque, "CXXBRIDGE1_RUST_OPAQUE");
174 ifndef::write(out, builtin.is_complete, "CXXBRIDGE1_IS_COMPLETE");
175 ifndef::write(out, builtin.layout, "CXXBRIDGE1_LAYOUT");
176 ifndef::write(out, builtin.relocatable, "CXXBRIDGE1_RELOCATABLE");
David Tolnay828e5132020-11-29 20:40:40 -0800177 }
David Tolnay3374d8d2020-10-31 22:18:45 -0700178
David Tolnaye5cd1482021-01-02 21:04:32 -0800179 if builtin.rust_str_new_unchecked {
180 out.next_section();
181 writeln!(out, "class Str::uninit {{}};");
182 writeln!(out, "inline Str::Str(uninit) noexcept {{}}");
183 }
184
185 if builtin.rust_slice_new {
186 out.next_section();
187 writeln!(out, "template <typename T>");
188 writeln!(out, "class Slice<T>::uninit {{}};");
189 writeln!(out, "template <typename T>");
190 writeln!(out, "inline Slice<T>::Slice(uninit) noexcept {{}}");
191 }
192
David Tolnay718ca0f2020-12-09 23:01:11 -0800193 out.begin_block(Block::Namespace("detail"));
194
195 if builtin.maybe_uninit {
196 include.cstddef = true;
197 include.new = true;
198 out.next_section();
199 writeln!(out, "template <typename T, typename = void *>");
200 writeln!(out, "struct operator_new {{");
201 writeln!(
202 out,
David Tolnaybe3cbf72020-12-12 22:12:07 -0800203 " void *operator()(::std::size_t sz) {{ return ::operator new(sz); }}",
David Tolnay718ca0f2020-12-09 23:01:11 -0800204 );
205 writeln!(out, "}};");
206 out.next_section();
207 writeln!(out, "template <typename T>");
208 writeln!(
209 out,
210 "struct operator_new<T, decltype(T::operator new(sizeof(T)))> {{",
211 );
212 writeln!(
213 out,
David Tolnaybe3cbf72020-12-12 22:12:07 -0800214 " void *operator()(::std::size_t sz) {{ return T::operator new(sz); }}",
David Tolnay718ca0f2020-12-09 23:01:11 -0800215 );
216 writeln!(out, "}};");
217 }
218
219 out.end_block(Block::Namespace("detail"));
220
David Tolnay3374d8d2020-10-31 22:18:45 -0700221 if builtin.manually_drop {
222 out.next_section();
223 include.utility = true;
224 writeln!(out, "template <typename T>");
225 writeln!(out, "union ManuallyDrop {{");
226 writeln!(out, " T value;");
227 writeln!(
228 out,
229 " ManuallyDrop(T &&value) : value(::std::move(value)) {{}}",
230 );
231 writeln!(out, " ~ManuallyDrop() {{}}");
232 writeln!(out, "}};");
233 }
234
235 if builtin.maybe_uninit {
David Tolnay718ca0f2020-12-09 23:01:11 -0800236 include.cstddef = true;
David Tolnay3374d8d2020-10-31 22:18:45 -0700237 out.next_section();
238 writeln!(out, "template <typename T>");
239 writeln!(out, "union MaybeUninit {{");
240 writeln!(out, " T value;");
David Tolnay718ca0f2020-12-09 23:01:11 -0800241 writeln!(
242 out,
David Tolnaybe3cbf72020-12-12 22:12:07 -0800243 " void *operator new(::std::size_t sz) {{ return detail::operator_new<T>{{}}(sz); }}",
David Tolnay718ca0f2020-12-09 23:01:11 -0800244 );
David Tolnay3374d8d2020-10-31 22:18:45 -0700245 writeln!(out, " MaybeUninit() {{}}");
246 writeln!(out, " ~MaybeUninit() {{}}");
247 writeln!(out, "}};");
248 }
249
David Tolnay0c033e32020-11-01 15:15:48 -0800250 out.begin_block(Block::AnonymousNamespace);
David Tolnay3374d8d2020-10-31 22:18:45 -0700251
David Tolnaye5cd1482021-01-02 21:04:32 -0800252 if builtin.repr_fat {
253 include.array = true;
254 include.cstdint = true;
255 out.next_section();
256 out.begin_block(Block::Namespace("repr"));
257 writeln!(out, "using Fat = ::std::array<::std::uintptr_t, 2>;");
258 out.end_block(Block::Namespace("repr"));
259 }
260
David Tolnay919085c2020-10-31 22:32:22 -0700261 if builtin.ptr_len {
David Tolnay12320e12020-12-09 23:09:36 -0800262 include.cstddef = true;
David Tolnaye5cd1482021-01-02 21:04:32 -0800263 out.next_section();
David Tolnay0c033e32020-11-01 15:15:48 -0800264 out.begin_block(Block::Namespace("repr"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700265 writeln!(out, "struct PtrLen final {{");
David Tolnayc5629f02020-11-23 18:32:46 -0800266 writeln!(out, " void *ptr;");
David Tolnaybe3cbf72020-12-12 22:12:07 -0800267 writeln!(out, " ::std::size_t len;");
David Tolnay3374d8d2020-10-31 22:18:45 -0700268 writeln!(out, "}};");
David Tolnay0c033e32020-11-01 15:15:48 -0800269 out.end_block(Block::Namespace("repr"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700270 }
271
David Tolnaye5cd1482021-01-02 21:04:32 -0800272 if builtin.rust_str_new_unchecked || builtin.rust_str_repr {
273 out.next_section();
274 writeln!(out, "template <>");
275 writeln!(out, "class impl<Str> final {{");
276 writeln!(out, "public:");
277 if builtin.rust_str_new_unchecked {
278 writeln!(
279 out,
280 " static Str new_unchecked(repr::Fat repr) noexcept {{",
281 );
282 writeln!(out, " Str str = Str::uninit{{}};");
283 writeln!(out, " str.repr = repr;");
284 writeln!(out, " return str;");
285 writeln!(out, " }}");
286 }
287 if builtin.rust_str_repr {
288 writeln!(out, " static repr::Fat repr(Str str) noexcept {{");
289 writeln!(out, " return str.repr;");
290 writeln!(out, " }}");
291 }
David Tolnayfe77f332021-01-02 17:39:51 -0800292 writeln!(out, "}};");
David Tolnaye5cd1482021-01-02 21:04:32 -0800293 }
294
295 if builtin.rust_slice_new || builtin.rust_slice_repr {
296 out.next_section();
297 writeln!(out, "template <typename T>");
298 writeln!(out, "class impl<Slice<T>> final {{");
299 writeln!(out, "public:");
300 if builtin.rust_slice_new {
301 writeln!(out, " static Slice<T> slice(repr::Fat repr) noexcept {{");
302 writeln!(out, " Slice<T> slice = typename Slice<T>::uninit{{}};");
303 writeln!(out, " slice.repr = repr;");
304 writeln!(out, " return slice;");
305 writeln!(out, " }}");
306 }
307 if builtin.rust_slice_repr {
308 writeln!(out, " static repr::Fat repr(Slice<T> slice) noexcept {{");
309 writeln!(out, " return slice.repr;");
310 writeln!(out, " }}");
311 }
312 writeln!(out, "}};");
David Tolnayfe77f332021-01-02 17:39:51 -0800313 }
314
David Tolnay3374d8d2020-10-31 22:18:45 -0700315 if builtin.rust_error {
316 out.next_section();
317 writeln!(out, "template <>");
318 writeln!(out, "class impl<Error> final {{");
319 writeln!(out, "public:");
320 writeln!(out, " static Error error(repr::PtrLen repr) noexcept {{");
321 writeln!(out, " Error error;");
322 writeln!(out, " error.msg = static_cast<const char *>(repr.ptr);");
323 writeln!(out, " error.len = repr.len;");
324 writeln!(out, " return error;");
325 writeln!(out, " }}");
326 writeln!(out, "}};");
327 }
328
David Tolnay53462762020-11-25 07:08:10 -0800329 if builtin.deleter_if {
330 out.next_section();
331 writeln!(out, "template <bool> struct deleter_if {{");
332 writeln!(out, " template <typename T> void operator()(T *) {{}}");
333 writeln!(out, "}};");
334 out.next_section();
335 writeln!(out, "template <> struct deleter_if<true> {{");
336 writeln!(
337 out,
338 " template <typename T> void operator()(T *ptr) {{ ptr->~T(); }}",
339 );
340 writeln!(out, "}};");
341 }
342
David Tolnay0c033e32020-11-01 15:15:48 -0800343 out.end_block(Block::AnonymousNamespace);
David Tolnay0f0162f2020-11-16 23:43:37 -0800344 out.end_block(Block::InlineNamespace("cxxbridge1"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700345
346 if builtin.trycatch {
David Tolnay0c033e32020-11-01 15:15:48 -0800347 out.begin_block(Block::Namespace("behavior"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700348 include.exception = true;
349 include.type_traits = true;
350 include.utility = true;
351 writeln!(out, "class missing {{}};");
352 writeln!(out, "missing trycatch(...);");
353 writeln!(out);
354 writeln!(out, "template <typename Try, typename Fail>");
355 writeln!(out, "static typename ::std::enable_if<");
356 writeln!(
357 out,
358 " ::std::is_same<decltype(trycatch(::std::declval<Try>(), ::std::declval<Fail>())),",
359 );
360 writeln!(out, " missing>::value>::type");
361 writeln!(out, "trycatch(Try &&func, Fail &&fail) noexcept try {{");
362 writeln!(out, " func();");
363 writeln!(out, "}} catch (const ::std::exception &e) {{");
364 writeln!(out, " fail(e.what());");
365 writeln!(out, "}}");
David Tolnay0c033e32020-11-01 15:15:48 -0800366 out.end_block(Block::Namespace("behavior"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700367 }
368
David Tolnay0c033e32020-11-01 15:15:48 -0800369 out.end_block(Block::Namespace("rust"));
David Tolnay1f010c62020-11-01 20:27:46 -0800370
371 if builtin.exception {
David Tolnay12320e12020-12-09 23:09:36 -0800372 include.cstddef = true;
David Tolnay1f010c62020-11-01 20:27:46 -0800373 out.begin_block(Block::ExternC);
374 writeln!(
375 out,
David Tolnaybe3cbf72020-12-12 22:12:07 -0800376 "const char *cxxbridge1$exception(const char *, ::std::size_t);",
David Tolnay1f010c62020-11-01 20:27:46 -0800377 );
378 out.end_block(Block::ExternC);
379 }
David Tolnay3374d8d2020-10-31 22:18:45 -0700380}