blob: 36e51d58bbd70cce51b4d2650333290629da15c1 [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,
David Tolnaya9449372021-03-26 16:40:53 -040018 pub unsafe_bitcopy_t: bool,
David Tolnay3be0e1f2020-10-31 20:53:00 -070019 pub rust_error: bool,
20 pub manually_drop: bool,
21 pub maybe_uninit: bool,
22 pub trycatch: bool,
David Tolnay919085c2020-10-31 22:32:22 -070023 pub ptr_len: bool,
David Tolnayfe77f332021-01-02 17:39:51 -080024 pub repr_fat: bool,
David Tolnaye5cd1482021-01-02 21:04:32 -080025 pub rust_str_new_unchecked: bool,
26 pub rust_str_repr: bool,
27 pub rust_slice_new: bool,
28 pub rust_slice_repr: bool,
David Tolnay1f010c62020-11-01 20:27:46 -080029 pub exception: bool,
David Tolnay174bd952020-11-02 09:23:12 -080030 pub relocatable: bool,
David Tolnay22664ae2020-11-04 16:30:45 -080031 pub friend_impl: bool,
David Tolnay53462762020-11-25 07:08:10 -080032 pub is_complete: bool,
33 pub deleter_if: bool,
David Tolnay97c5b862020-11-01 14:59:01 -080034 pub content: Content<'a>,
David Tolnay3be0e1f2020-10-31 20:53:00 -070035}
36
David Tolnay97c5b862020-11-01 14:59:01 -080037impl<'a> Builtins<'a> {
David Tolnay3be0e1f2020-10-31 20:53:00 -070038 pub fn new() -> Self {
39 Builtins::default()
40 }
41}
David Tolnay3374d8d2020-10-31 22:18:45 -070042
43pub(super) fn write(out: &mut OutFile) {
44 if out.builtin == Default::default() {
45 return;
46 }
47
48 let include = &mut out.include;
49 let builtin = &mut out.builtin;
50 let out = &mut builtin.content;
51
David Tolnaydcfa8e92020-11-02 09:50:06 -080052 if builtin.rust_string {
53 include.array = true;
54 include.cstdint = true;
55 include.string = true;
56 }
57
58 if builtin.rust_str {
David Tolnay851d2f72021-01-04 12:20:50 -080059 include.array = true;
David Tolnaydcfa8e92020-11-02 09:50:06 -080060 include.cstdint = true;
61 include.string = true;
David Tolnay22664ae2020-11-04 16:30:45 -080062 builtin.friend_impl = true;
63 }
64
David Tolnay725bf502020-12-27 02:47:40 -080065 if builtin.rust_vec {
66 include.algorithm = true;
67 include.array = true;
David Tolnayecb4dbf2021-01-14 11:22:34 -080068 include.cassert = true;
David Tolnay725bf502020-12-27 02:47:40 -080069 include.cstddef = true;
David Tolnay851d2f72021-01-04 12:20:50 -080070 include.cstdint = true;
David Tolnay725bf502020-12-27 02:47:40 -080071 include.initializer_list = true;
72 include.iterator = true;
73 include.new = true;
74 include.type_traits = true;
75 include.utility = true;
76 builtin.panic = true;
77 builtin.rust_slice = true;
David Tolnaya9449372021-03-26 16:40:53 -040078 builtin.unsafe_bitcopy_t = true;
David Tolnay725bf502020-12-27 02:47:40 -080079 }
80
David Tolnay22664ae2020-11-04 16:30:45 -080081 if builtin.rust_slice {
David Tolnay851d2f72021-01-04 12:20:50 -080082 include.array = true;
David Tolnayecb4dbf2021-01-14 11:22:34 -080083 include.cassert = true;
David Tolnay08679ae2020-12-12 22:10:01 -080084 include.cstddef = true;
David Tolnay851d2f72021-01-04 12:20:50 -080085 include.cstdint = true;
David Tolnayd1df4c72020-11-25 20:38:05 -080086 include.iterator = true;
David Tolnay450d8cd2020-11-25 20:36:06 -080087 include.type_traits = true;
David Tolnay22664ae2020-11-04 16:30:45 -080088 builtin.friend_impl = true;
David Tolnay6f92baa2020-12-27 01:09:26 -080089 builtin.layout = true;
David Tolnay78dd5352020-12-26 23:44:20 -080090 builtin.panic = true;
David Tolnaydcfa8e92020-11-02 09:50:06 -080091 }
92
93 if builtin.rust_box {
94 include.new = true;
95 include.type_traits = true;
David Tolnayea6f86c2020-11-10 15:08:57 -080096 include.utility = true;
David Tolnaydcfa8e92020-11-02 09:50:06 -080097 }
98
David Tolnaya5a13012020-11-10 15:03:09 -080099 if builtin.rust_fn {
100 include.utility = true;
101 }
102
David Tolnaydcfa8e92020-11-02 09:50:06 -0800103 if builtin.rust_error {
104 include.exception = true;
David Tolnay22664ae2020-11-04 16:30:45 -0800105 builtin.friend_impl = true;
David Tolnaydcfa8e92020-11-02 09:50:06 -0800106 }
107
108 if builtin.rust_isize {
109 include.basetsd = true;
David Tolnay74dd66f2020-12-12 22:03:47 -0800110 include.sys_types = true;
David Tolnaydcfa8e92020-11-02 09:50:06 -0800111 }
112
David Tolnay174bd952020-11-02 09:23:12 -0800113 if builtin.relocatable {
114 include.type_traits = true;
115 }
116
David Tolnayee6ecfc2020-12-26 21:54:37 -0800117 if builtin.layout {
118 include.type_traits = true;
119 include.cstddef = true;
120 builtin.is_complete = true;
121 }
122
David Tolnay75068632020-12-26 22:15:17 -0800123 if builtin.is_complete {
124 include.cstddef = true;
125 include.type_traits = true;
126 }
127
David Tolnaya9449372021-03-26 16:40:53 -0400128 if builtin.unsafe_bitcopy {
129 builtin.unsafe_bitcopy_t = true;
130 }
131
David Tolnay0c033e32020-11-01 15:15:48 -0800132 out.begin_block(Block::Namespace("rust"));
David Tolnay0f0162f2020-11-16 23:43:37 -0800133 out.begin_block(Block::InlineNamespace("cxxbridge1"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700134
David Tolnay5e14b102021-03-26 00:17:07 -0400135 let cxx_header = include.has_cxx_header();
David Tolnayccd269d2021-03-25 23:53:38 -0400136 if !cxx_header {
137 writeln!(out, "// #include \"rust/cxx.h\"");
David Tolnay3374d8d2020-10-31 22:18:45 -0700138
David Tolnayccd269d2021-03-25 23:53:38 -0400139 ifndef::write(out, builtin.panic, "CXXBRIDGE1_PANIC");
140
141 if builtin.rust_string {
142 out.next_section();
143 writeln!(out, "struct unsafe_bitcopy_t;");
144 }
145
146 if builtin.friend_impl {
147 out.begin_block(Block::AnonymousNamespace);
148 writeln!(out, "template <typename T>");
149 writeln!(out, "class impl;");
150 out.end_block(Block::AnonymousNamespace);
151 }
152
David Tolnay3374d8d2020-10-31 22:18:45 -0700153 out.next_section();
David Tolnayccd269d2021-03-25 23:53:38 -0400154 if builtin.rust_str && !builtin.rust_string {
155 writeln!(out, "class String;");
156 }
157 if builtin.layout && !builtin.opaque {
158 writeln!(out, "class Opaque;");
159 }
David Tolnay3374d8d2020-10-31 22:18:45 -0700160
David Tolnayccd269d2021-03-25 23:53:38 -0400161 if builtin.rust_slice {
162 out.next_section();
163 writeln!(out, "template <typename T>");
164 writeln!(out, "::std::size_t size_of();");
165 writeln!(out, "template <typename T>");
166 writeln!(out, "::std::size_t align_of();");
167 }
David Tolnay3374d8d2020-10-31 22:18:45 -0700168
David Tolnayccd269d2021-03-25 23:53:38 -0400169 ifndef::write(out, builtin.rust_string, "CXXBRIDGE1_RUST_STRING");
170 ifndef::write(out, builtin.rust_str, "CXXBRIDGE1_RUST_STR");
171 ifndef::write(out, builtin.rust_slice, "CXXBRIDGE1_RUST_SLICE");
172 ifndef::write(out, builtin.rust_box, "CXXBRIDGE1_RUST_BOX");
David Tolnaya9449372021-03-26 16:40:53 -0400173 ifndef::write(out, builtin.unsafe_bitcopy_t, "CXXBRIDGE1_RUST_BITCOPY_T");
David Tolnayccd269d2021-03-25 23:53:38 -0400174 ifndef::write(out, builtin.unsafe_bitcopy, "CXXBRIDGE1_RUST_BITCOPY");
175 ifndef::write(out, builtin.rust_vec, "CXXBRIDGE1_RUST_VEC");
176 ifndef::write(out, builtin.rust_fn, "CXXBRIDGE1_RUST_FN");
177 ifndef::write(out, builtin.rust_error, "CXXBRIDGE1_RUST_ERROR");
178 ifndef::write(out, builtin.rust_isize, "CXXBRIDGE1_RUST_ISIZE");
179 ifndef::write(out, builtin.opaque, "CXXBRIDGE1_RUST_OPAQUE");
180 ifndef::write(out, builtin.is_complete, "CXXBRIDGE1_IS_COMPLETE");
181 ifndef::write(out, builtin.layout, "CXXBRIDGE1_LAYOUT");
182 ifndef::write(out, builtin.relocatable, "CXXBRIDGE1_RELOCATABLE");
David Tolnay828e5132020-11-29 20:40:40 -0800183 }
David Tolnay3374d8d2020-10-31 22:18:45 -0700184
David Tolnaye5cd1482021-01-02 21:04:32 -0800185 if builtin.rust_str_new_unchecked {
186 out.next_section();
187 writeln!(out, "class Str::uninit {{}};");
188 writeln!(out, "inline Str::Str(uninit) noexcept {{}}");
189 }
190
191 if builtin.rust_slice_new {
192 out.next_section();
193 writeln!(out, "template <typename T>");
194 writeln!(out, "class Slice<T>::uninit {{}};");
195 writeln!(out, "template <typename T>");
196 writeln!(out, "inline Slice<T>::Slice(uninit) noexcept {{}}");
197 }
198
David Tolnay718ca0f2020-12-09 23:01:11 -0800199 out.begin_block(Block::Namespace("detail"));
200
201 if builtin.maybe_uninit {
202 include.cstddef = true;
203 include.new = true;
204 out.next_section();
205 writeln!(out, "template <typename T, typename = void *>");
206 writeln!(out, "struct operator_new {{");
207 writeln!(
208 out,
David Tolnaybe3cbf72020-12-12 22:12:07 -0800209 " void *operator()(::std::size_t sz) {{ return ::operator new(sz); }}",
David Tolnay718ca0f2020-12-09 23:01:11 -0800210 );
211 writeln!(out, "}};");
212 out.next_section();
213 writeln!(out, "template <typename T>");
214 writeln!(
215 out,
216 "struct operator_new<T, decltype(T::operator new(sizeof(T)))> {{",
217 );
218 writeln!(
219 out,
David Tolnaybe3cbf72020-12-12 22:12:07 -0800220 " void *operator()(::std::size_t sz) {{ return T::operator new(sz); }}",
David Tolnay718ca0f2020-12-09 23:01:11 -0800221 );
222 writeln!(out, "}};");
223 }
224
225 out.end_block(Block::Namespace("detail"));
226
David Tolnay3374d8d2020-10-31 22:18:45 -0700227 if builtin.manually_drop {
228 out.next_section();
229 include.utility = true;
230 writeln!(out, "template <typename T>");
231 writeln!(out, "union ManuallyDrop {{");
232 writeln!(out, " T value;");
233 writeln!(
234 out,
235 " ManuallyDrop(T &&value) : value(::std::move(value)) {{}}",
236 );
237 writeln!(out, " ~ManuallyDrop() {{}}");
238 writeln!(out, "}};");
239 }
240
241 if builtin.maybe_uninit {
David Tolnay718ca0f2020-12-09 23:01:11 -0800242 include.cstddef = true;
David Tolnay3374d8d2020-10-31 22:18:45 -0700243 out.next_section();
244 writeln!(out, "template <typename T>");
245 writeln!(out, "union MaybeUninit {{");
246 writeln!(out, " T value;");
David Tolnay718ca0f2020-12-09 23:01:11 -0800247 writeln!(
248 out,
David Tolnaybe3cbf72020-12-12 22:12:07 -0800249 " void *operator new(::std::size_t sz) {{ return detail::operator_new<T>{{}}(sz); }}",
David Tolnay718ca0f2020-12-09 23:01:11 -0800250 );
David Tolnay3374d8d2020-10-31 22:18:45 -0700251 writeln!(out, " MaybeUninit() {{}}");
252 writeln!(out, " ~MaybeUninit() {{}}");
253 writeln!(out, "}};");
254 }
255
David Tolnay0c033e32020-11-01 15:15:48 -0800256 out.begin_block(Block::AnonymousNamespace);
David Tolnay3374d8d2020-10-31 22:18:45 -0700257
David Tolnaye5cd1482021-01-02 21:04:32 -0800258 if builtin.repr_fat {
259 include.array = true;
260 include.cstdint = true;
261 out.next_section();
262 out.begin_block(Block::Namespace("repr"));
263 writeln!(out, "using Fat = ::std::array<::std::uintptr_t, 2>;");
264 out.end_block(Block::Namespace("repr"));
265 }
266
David Tolnay919085c2020-10-31 22:32:22 -0700267 if builtin.ptr_len {
David Tolnay12320e12020-12-09 23:09:36 -0800268 include.cstddef = true;
David Tolnaye5cd1482021-01-02 21:04:32 -0800269 out.next_section();
David Tolnay0c033e32020-11-01 15:15:48 -0800270 out.begin_block(Block::Namespace("repr"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700271 writeln!(out, "struct PtrLen final {{");
David Tolnayc5629f02020-11-23 18:32:46 -0800272 writeln!(out, " void *ptr;");
David Tolnaybe3cbf72020-12-12 22:12:07 -0800273 writeln!(out, " ::std::size_t len;");
David Tolnay3374d8d2020-10-31 22:18:45 -0700274 writeln!(out, "}};");
David Tolnay0c033e32020-11-01 15:15:48 -0800275 out.end_block(Block::Namespace("repr"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700276 }
277
David Tolnaye5cd1482021-01-02 21:04:32 -0800278 if builtin.rust_str_new_unchecked || builtin.rust_str_repr {
279 out.next_section();
280 writeln!(out, "template <>");
281 writeln!(out, "class impl<Str> final {{");
282 writeln!(out, "public:");
283 if builtin.rust_str_new_unchecked {
284 writeln!(
285 out,
286 " static Str new_unchecked(repr::Fat repr) noexcept {{",
287 );
288 writeln!(out, " Str str = Str::uninit{{}};");
289 writeln!(out, " str.repr = repr;");
290 writeln!(out, " return str;");
291 writeln!(out, " }}");
292 }
293 if builtin.rust_str_repr {
294 writeln!(out, " static repr::Fat repr(Str str) noexcept {{");
295 writeln!(out, " return str.repr;");
296 writeln!(out, " }}");
297 }
David Tolnayfe77f332021-01-02 17:39:51 -0800298 writeln!(out, "}};");
David Tolnaye5cd1482021-01-02 21:04:32 -0800299 }
300
301 if builtin.rust_slice_new || builtin.rust_slice_repr {
302 out.next_section();
303 writeln!(out, "template <typename T>");
304 writeln!(out, "class impl<Slice<T>> final {{");
305 writeln!(out, "public:");
306 if builtin.rust_slice_new {
307 writeln!(out, " static Slice<T> slice(repr::Fat repr) noexcept {{");
308 writeln!(out, " Slice<T> slice = typename Slice<T>::uninit{{}};");
309 writeln!(out, " slice.repr = repr;");
310 writeln!(out, " return slice;");
311 writeln!(out, " }}");
312 }
313 if builtin.rust_slice_repr {
314 writeln!(out, " static repr::Fat repr(Slice<T> slice) noexcept {{");
315 writeln!(out, " return slice.repr;");
316 writeln!(out, " }}");
317 }
318 writeln!(out, "}};");
David Tolnayfe77f332021-01-02 17:39:51 -0800319 }
320
David Tolnay3374d8d2020-10-31 22:18:45 -0700321 if builtin.rust_error {
322 out.next_section();
323 writeln!(out, "template <>");
324 writeln!(out, "class impl<Error> final {{");
325 writeln!(out, "public:");
326 writeln!(out, " static Error error(repr::PtrLen repr) noexcept {{");
327 writeln!(out, " Error error;");
328 writeln!(out, " error.msg = static_cast<const char *>(repr.ptr);");
329 writeln!(out, " error.len = repr.len;");
330 writeln!(out, " return error;");
331 writeln!(out, " }}");
332 writeln!(out, "}};");
333 }
334
David Tolnay53462762020-11-25 07:08:10 -0800335 if builtin.deleter_if {
336 out.next_section();
337 writeln!(out, "template <bool> struct deleter_if {{");
338 writeln!(out, " template <typename T> void operator()(T *) {{}}");
339 writeln!(out, "}};");
340 out.next_section();
341 writeln!(out, "template <> struct deleter_if<true> {{");
342 writeln!(
343 out,
344 " template <typename T> void operator()(T *ptr) {{ ptr->~T(); }}",
345 );
346 writeln!(out, "}};");
347 }
348
David Tolnay0c033e32020-11-01 15:15:48 -0800349 out.end_block(Block::AnonymousNamespace);
David Tolnay0f0162f2020-11-16 23:43:37 -0800350 out.end_block(Block::InlineNamespace("cxxbridge1"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700351
352 if builtin.trycatch {
David Tolnay0c033e32020-11-01 15:15:48 -0800353 out.begin_block(Block::Namespace("behavior"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700354 include.exception = true;
355 include.type_traits = true;
356 include.utility = true;
357 writeln!(out, "class missing {{}};");
358 writeln!(out, "missing trycatch(...);");
359 writeln!(out);
360 writeln!(out, "template <typename Try, typename Fail>");
361 writeln!(out, "static typename ::std::enable_if<");
362 writeln!(
363 out,
364 " ::std::is_same<decltype(trycatch(::std::declval<Try>(), ::std::declval<Fail>())),",
365 );
366 writeln!(out, " missing>::value>::type");
367 writeln!(out, "trycatch(Try &&func, Fail &&fail) noexcept try {{");
368 writeln!(out, " func();");
369 writeln!(out, "}} catch (const ::std::exception &e) {{");
370 writeln!(out, " fail(e.what());");
371 writeln!(out, "}}");
David Tolnay0c033e32020-11-01 15:15:48 -0800372 out.end_block(Block::Namespace("behavior"));
David Tolnay3374d8d2020-10-31 22:18:45 -0700373 }
374
David Tolnay0c033e32020-11-01 15:15:48 -0800375 out.end_block(Block::Namespace("rust"));
David Tolnay1f010c62020-11-01 20:27:46 -0800376
377 if builtin.exception {
David Tolnay12320e12020-12-09 23:09:36 -0800378 include.cstddef = true;
David Tolnay1f010c62020-11-01 20:27:46 -0800379 out.begin_block(Block::ExternC);
380 writeln!(
381 out,
David Tolnaybe3cbf72020-12-12 22:12:07 -0800382 "const char *cxxbridge1$exception(const char *, ::std::size_t);",
David Tolnay1f010c62020-11-01 20:27:46 -0800383 );
384 out.end_block(Block::ExternC);
385 }
David Tolnay3374d8d2020-10-31 22:18:45 -0700386}