1 // Copyright 2012 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
13 More runtime type reflection
17 #[allow(missing_doc)];
21 use container::Container;
25 use option::{Some, None};
28 use reflect::{MovePtr, align};
32 use unstable::intrinsics::{Disr, Opaque, TyDesc, TyVisitor, get_tydesc, visit_tydesc};
38 fn write_repr(&self, writer: &mut io::Writer);
42 fn write_repr(&self, writer: &mut io::Writer) {
43 writer.write("()".as_bytes());
48 fn write_repr(&self, writer: &mut io::Writer) {
49 let s = if *self { "true" } else { "false" };
50 writer.write(s.as_bytes())
55 fn write_repr(&self, writer: &mut io::Writer) {
56 ::int::to_str_bytes(*self, 10u, |bits| {
62 macro_rules! int_repr(($ty:ident, $suffix:expr) => (impl Repr for $ty {
63 fn write_repr(&self, writer: &mut io::Writer) {
64 ::$ty::to_str_bytes(*self, 10u, |bits| {
66 writer.write(bytes!($suffix));
81 macro_rules! num_repr(($ty:ident, $suffix:expr) => (impl Repr for $ty {
82 fn write_repr(&self, writer: &mut io::Writer) {
83 let s = self.to_str();
84 writer.write(s.as_bytes());
85 writer.write(bytes!($suffix));
92 // New implementation using reflect::MovePtr
100 pub struct ReprVisitor<'a> {
102 priv ptr_stk: ~[*c_void],
103 priv var_stk: ~[VariantState],
104 priv writer: &'a mut io::Writer
107 pub fn ReprVisitor<'a>(ptr: *c_void,
108 writer: &'a mut io::Writer) -> ReprVisitor<'a> {
117 impl<'a> MovePtr for ReprVisitor<'a> {
119 fn move_ptr(&mut self, adjustment: |*c_void| -> *c_void) {
120 self.ptr = adjustment(self.ptr);
122 fn push_ptr(&mut self) {
123 self.ptr_stk.push(self.ptr);
125 fn pop_ptr(&mut self) {
126 self.ptr = self.ptr_stk.pop();
130 impl<'a> ReprVisitor<'a> {
131 // Various helpers for the TyVisitor impl
134 pub fn get<T>(&mut self, f: |&mut ReprVisitor, &T|) -> bool {
136 f(self, transmute::<*c_void,&T>(self.ptr));
142 pub fn visit_inner(&mut self, inner: *TyDesc) -> bool {
143 self.visit_ptr_inner(self.ptr, inner)
147 pub fn visit_ptr_inner(&mut self, ptr: *c_void, inner: *TyDesc) -> bool {
149 // This should call the constructor up above, but due to limiting
150 // issues we have to recreate it here.
151 let u = ReprVisitor {
155 writer: ::cast::transmute_copy(&self.writer),
157 let mut v = reflect::MovePtrAdaptor(u);
158 // Obviously this should not be a thing, but blame #8401 for now
159 visit_tydesc(inner, &mut v as &mut TyVisitor);
165 pub fn write<T:Repr>(&mut self) -> bool {
166 self.get(|this, v:&T| {
167 v.write_repr(unsafe { ::cast::transmute_copy(&this.writer) });
171 pub fn write_escaped_slice(&mut self, slice: &str) {
172 self.writer.write(['"' as u8]);
173 for ch in slice.chars() {
174 self.write_escaped_char(ch, true);
176 self.writer.write(['"' as u8]);
179 pub fn write_mut_qualifier(&mut self, mtbl: uint) {
181 self.writer.write("mut ".as_bytes());
182 } else if mtbl == 1 {
183 // skip, this is ast::m_imm
185 fail!("invalid mutability value");
189 pub fn write_vec_range(&mut self, ptr: *(), len: uint, inner: *TyDesc) -> bool {
190 let mut p = ptr as *u8;
191 let (sz, al) = unsafe { ((*inner).size, (*inner).align) };
192 self.writer.write(['[' as u8]);
193 let mut first = true;
195 // unit structs have 0 size, and don't loop forever.
196 let dec = if sz == 0 {1} else {sz};
201 self.writer.write(", ".as_bytes());
203 self.visit_ptr_inner(p as *c_void, inner);
204 p = align(unsafe { ptr::offset(p, sz as int) as uint }, al) as *u8;
207 self.writer.write([']' as u8]);
211 pub fn write_unboxed_vec_repr(&mut self, _: uint, v: &raw::Vec<()>, inner: *TyDesc) -> bool {
212 self.write_vec_range(ptr::to_unsafe_ptr(&v.data), v.fill, inner)
215 fn write_escaped_char(&mut self, ch: char, is_str: bool) {
217 '\t' => self.writer.write("\\t".as_bytes()),
218 '\r' => self.writer.write("\\r".as_bytes()),
219 '\n' => self.writer.write("\\n".as_bytes()),
220 '\\' => self.writer.write("\\\\".as_bytes()),
223 self.writer.write("'".as_bytes())
225 self.writer.write("\\'".as_bytes())
230 self.writer.write("\\\"".as_bytes())
232 self.writer.write("\"".as_bytes())
235 '\x20'..'\x7e' => self.writer.write([ch as u8]),
237 char::escape_unicode(ch, |c| {
238 self.writer.write([c as u8]);
245 impl<'a> TyVisitor for ReprVisitor<'a> {
246 fn visit_bot(&mut self) -> bool {
247 self.writer.write("!".as_bytes());
250 fn visit_nil(&mut self) -> bool { self.write::<()>() }
251 fn visit_bool(&mut self) -> bool { self.write::<bool>() }
252 fn visit_int(&mut self) -> bool { self.write::<int>() }
253 fn visit_i8(&mut self) -> bool { self.write::<i8>() }
254 fn visit_i16(&mut self) -> bool { self.write::<i16>() }
255 fn visit_i32(&mut self) -> bool { self.write::<i32>() }
256 fn visit_i64(&mut self) -> bool { self.write::<i64>() }
258 fn visit_uint(&mut self) -> bool { self.write::<uint>() }
259 fn visit_u8(&mut self) -> bool { self.write::<u8>() }
260 fn visit_u16(&mut self) -> bool { self.write::<u16>() }
261 fn visit_u32(&mut self) -> bool { self.write::<u32>() }
262 fn visit_u64(&mut self) -> bool { self.write::<u64>() }
264 fn visit_f32(&mut self) -> bool { self.write::<f32>() }
265 fn visit_f64(&mut self) -> bool { self.write::<f64>() }
267 fn visit_char(&mut self) -> bool {
268 self.get::<char>(|this, &ch| {
269 this.writer.write(['\'' as u8]);
270 this.write_escaped_char(ch, false);
271 this.writer.write(['\'' as u8]);
275 fn visit_estr_box(&mut self) -> bool {
276 self.get::<@str>(|this, s| {
277 this.writer.write(['@' as u8]);
278 this.write_escaped_slice(*s);
282 fn visit_estr_uniq(&mut self) -> bool {
283 self.get::<~str>(|this, s| {
284 this.writer.write(['~' as u8]);
285 this.write_escaped_slice(*s);
289 fn visit_estr_slice(&mut self) -> bool {
290 self.get::<&str>(|this, s| this.write_escaped_slice(*s))
293 // Type no longer exists, vestigial function.
294 fn visit_estr_fixed(&mut self, _n: uint, _sz: uint,
295 _align: uint) -> bool { fail!(); }
297 fn visit_box(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
298 self.writer.write(['@' as u8]);
299 self.write_mut_qualifier(mtbl);
300 self.get::<&raw::Box<()>>(|this, b| {
301 let p = ptr::to_unsafe_ptr(&b.data) as *c_void;
302 this.visit_ptr_inner(p, inner);
306 fn visit_uniq(&mut self, _mtbl: uint, inner: *TyDesc) -> bool {
307 self.writer.write(['~' as u8]);
308 self.get::<*c_void>(|this, b| {
309 this.visit_ptr_inner(*b, inner);
313 fn visit_uniq_managed(&mut self, _mtbl: uint, inner: *TyDesc) -> bool {
314 self.writer.write(['~' as u8]);
315 self.get::<&raw::Box<()>>(|this, b| {
316 let p = ptr::to_unsafe_ptr(&b.data) as *c_void;
317 this.visit_ptr_inner(p, inner);
321 fn visit_ptr(&mut self, mtbl: uint, _inner: *TyDesc) -> bool {
322 self.get::<*c_void>(|this, p| {
323 write!(this.writer, "({} as *", *p);
324 this.write_mut_qualifier(mtbl);
325 this.writer.write("())".as_bytes());
329 fn visit_rptr(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
330 self.writer.write(['&' as u8]);
331 self.write_mut_qualifier(mtbl);
332 self.get::<*c_void>(|this, p| {
333 this.visit_ptr_inner(*p, inner);
337 // Type no longer exists, vestigial function.
338 fn visit_vec(&mut self, _mtbl: uint, _inner: *TyDesc) -> bool { fail!(); }
340 fn visit_unboxed_vec(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
341 self.get::<raw::Vec<()>>(|this, b| {
342 this.write_unboxed_vec_repr(mtbl, b, inner);
346 fn visit_evec_box(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
347 self.get::<&raw::Box<raw::Vec<()>>>(|this, b| {
348 this.writer.write(['@' as u8]);
349 this.write_mut_qualifier(mtbl);
350 this.write_unboxed_vec_repr(mtbl, &b.data, inner);
354 fn visit_evec_uniq(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
355 self.get::<&raw::Vec<()>>(|this, b| {
356 this.writer.write(['~' as u8]);
357 this.write_unboxed_vec_repr(mtbl, *b, inner);
361 fn visit_evec_uniq_managed(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
362 self.get::<&raw::Box<raw::Vec<()>>>(|this, b| {
363 this.writer.write(['~' as u8]);
364 this.write_unboxed_vec_repr(mtbl, &b.data, inner);
368 fn visit_evec_slice(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
369 self.get::<raw::Slice<()>>(|this, s| {
370 this.writer.write(['&' as u8]);
371 this.write_mut_qualifier(mtbl);
373 if (*inner).size == 0 { 1 } else { (*inner).size }
375 this.write_vec_range(s.data, s.len * size, inner);
379 fn visit_evec_fixed(&mut self, n: uint, sz: uint, _align: uint,
380 _: uint, inner: *TyDesc) -> bool {
381 let assumed_size = if sz == 0 { n } else { sz };
382 self.get::<()>(|this, b| {
383 this.write_vec_range(ptr::to_unsafe_ptr(b), assumed_size, inner);
387 fn visit_enter_rec(&mut self, _n_fields: uint,
388 _sz: uint, _align: uint) -> bool {
389 self.writer.write(['{' as u8]);
393 fn visit_rec_field(&mut self, i: uint, name: &str,
394 mtbl: uint, inner: *TyDesc) -> bool {
396 self.writer.write(", ".as_bytes());
398 self.write_mut_qualifier(mtbl);
399 self.writer.write(name.as_bytes());
400 self.writer.write(": ".as_bytes());
401 self.visit_inner(inner);
405 fn visit_leave_rec(&mut self, _n_fields: uint,
406 _sz: uint, _align: uint) -> bool {
407 self.writer.write(['}' as u8]);
411 fn visit_enter_class(&mut self, name: &str, named_fields: bool, n_fields: uint,
412 _sz: uint, _align: uint) -> bool {
413 self.writer.write(name.as_bytes());
416 self.writer.write(['{' as u8]);
418 self.writer.write(['(' as u8]);
424 fn visit_class_field(&mut self, i: uint, name: &str, named: bool,
425 _mtbl: uint, inner: *TyDesc) -> bool {
427 self.writer.write(", ".as_bytes());
430 self.writer.write(name.as_bytes());
431 self.writer.write(": ".as_bytes());
433 self.visit_inner(inner);
437 fn visit_leave_class(&mut self, _name: &str, named_fields: bool, n_fields: uint,
438 _sz: uint, _align: uint) -> bool {
441 self.writer.write(['}' as u8]);
443 self.writer.write([')' as u8]);
449 fn visit_enter_tup(&mut self, _n_fields: uint,
450 _sz: uint, _align: uint) -> bool {
451 self.writer.write(['(' as u8]);
455 fn visit_tup_field(&mut self, i: uint, inner: *TyDesc) -> bool {
457 self.writer.write(", ".as_bytes());
459 self.visit_inner(inner);
463 fn visit_leave_tup(&mut self, _n_fields: uint,
464 _sz: uint, _align: uint) -> bool {
466 self.writer.write([',' as u8]);
468 self.writer.write([')' as u8]);
472 fn visit_enter_enum(&mut self,
474 get_disr: extern unsafe fn(ptr: *Opaque) -> Disr,
476 _align: uint) -> bool {
478 get_disr(transmute(self.ptr))
480 self.var_stk.push(SearchingFor(disr));
484 fn visit_enter_enum_variant(&mut self, _variant: uint,
487 name: &str) -> bool {
488 let mut write = false;
489 match self.var_stk.pop() {
490 SearchingFor(sought) => {
491 if disr_val == sought {
492 self.var_stk.push(Matched);
495 self.var_stk.push(SearchingFor(sought));
498 Matched | AlreadyFound => {
499 self.var_stk.push(AlreadyFound);
504 self.writer.write(name.as_bytes());
506 self.writer.write(['(' as u8]);
512 fn visit_enum_variant_field(&mut self,
517 match self.var_stk[self.var_stk.len() - 1] {
520 self.writer.write(", ".as_bytes());
522 if ! self.visit_inner(inner) {
531 fn visit_leave_enum_variant(&mut self, _variant: uint,
534 _name: &str) -> bool {
535 match self.var_stk[self.var_stk.len() - 1] {
538 self.writer.write([')' as u8]);
546 fn visit_leave_enum(&mut self,
548 _get_disr: extern unsafe fn(ptr: *Opaque) -> Disr,
552 match self.var_stk.pop() {
553 SearchingFor(..) => fail!("enum value matched no variant"),
558 fn visit_enter_fn(&mut self, _purity: uint, _proto: uint,
559 _n_inputs: uint, _retstyle: uint) -> bool {
560 self.writer.write("fn(".as_bytes());
564 fn visit_fn_input(&mut self, i: uint, _mode: uint, inner: *TyDesc) -> bool {
566 self.writer.write(", ".as_bytes());
568 let name = unsafe { (*inner).name };
569 self.writer.write(name.as_bytes());
573 fn visit_fn_output(&mut self, _retstyle: uint, variadic: bool, inner: *TyDesc) -> bool {
575 self.writer.write(", ...".as_bytes());
577 self.writer.write(")".as_bytes());
578 let name = unsafe { (*inner).name };
580 self.writer.write(" -> ".as_bytes());
581 self.writer.write(name.as_bytes());
586 fn visit_leave_fn(&mut self, _purity: uint, _proto: uint,
587 _n_inputs: uint, _retstyle: uint) -> bool { true }
590 fn visit_trait(&mut self, name: &str) -> bool {
591 self.writer.write(name.as_bytes());
595 fn visit_param(&mut self, _i: uint) -> bool { true }
596 fn visit_self(&mut self) -> bool { true }
597 fn visit_type(&mut self) -> bool { true }
599 fn visit_opaque_box(&mut self) -> bool {
600 self.writer.write(['@' as u8]);
601 self.get::<&raw::Box<()>>(|this, b| {
602 let p = ptr::to_unsafe_ptr(&b.data) as *c_void;
603 this.visit_ptr_inner(p, b.type_desc);
607 fn visit_closure_ptr(&mut self, _ck: uint) -> bool { true }
610 pub fn write_repr<T>(writer: &mut io::Writer, object: &T) {
612 let ptr = ptr::to_unsafe_ptr(object) as *c_void;
613 let tydesc = get_tydesc::<T>();
614 let u = ReprVisitor(ptr, writer);
615 let mut v = reflect::MovePtrAdaptor(u);
616 visit_tydesc(tydesc, &mut v as &mut TyVisitor);
620 pub fn repr_to_str<T>(t: &T) -> ~str {
625 let mut result = io::mem::MemWriter::new();
626 write_repr(&mut result as &mut io::Writer, t);
627 str::from_utf8_owned(result.inner())
631 struct P {a: int, b: f64}
640 use char::is_alphabetic;
642 fn exact_test<T>(t: &T, e:&str) {
643 let mut m = io::mem::MemWriter::new();
644 write_repr(&mut m as &mut io::Writer, t);
645 let s = str::from_utf8_owned(m.inner());
646 assert_eq!(s.as_slice(), e);
649 exact_test(&10, "10");
650 exact_test(&true, "true");
651 exact_test(&false, "false");
652 exact_test(&1.234, "1.234f64");
653 exact_test(&(&"hello"), "\"hello\"");
654 exact_test(&(@"hello"), "@\"hello\"");
655 exact_test(&(~"he\u10f3llo"), "~\"he\\u10f3llo\"");
657 exact_test(&(@10), "@10");
658 exact_test(&(@mut 10), "@mut 10");
659 exact_test(&((@mut 10, 2)), "(@mut 10, 2)");
660 exact_test(&(~10), "~10");
661 exact_test(&(&10), "&10");
663 exact_test(&(&mut x), "&mut 10");
664 exact_test(&(@mut [1, 2]), "@mut [1, 2]");
666 exact_test(&(0 as *()), "(0x0 as *())");
667 exact_test(&(0 as *mut ()), "(0x0 as *mut ())");
669 exact_test(&(1,), "(1,)");
670 exact_test(&(@[1,2,3,4,5,6,7,8]),
671 "@[1, 2, 3, 4, 5, 6, 7, 8]");
672 exact_test(&(@[1u8,2u8,3u8,4u8]),
673 "@[1u8, 2u8, 3u8, 4u8]");
674 exact_test(&(@["hi", "there"]),
675 "@[\"hi\", \"there\"]");
676 exact_test(&(~["hi", "there"]),
677 "~[\"hi\", \"there\"]");
678 exact_test(&(&["hi", "there"]),
679 "&[\"hi\", \"there\"]");
680 exact_test(&(P{a:10, b:1.234}),
681 "repr::P{a: 10, b: 1.234f64}");
682 exact_test(&(@P{a:10, b:1.234}),
683 "@repr::P{a: 10, b: 1.234f64}");
684 exact_test(&(~P{a:10, b:1.234}),
685 "~repr::P{a: 10, b: 1.234f64}");
686 exact_test(&(10u8, ~"hello"),
687 "(10u8, ~\"hello\")");
688 exact_test(&(10u16, ~"hello"),
689 "(10u16, ~\"hello\")");
690 exact_test(&(10u32, ~"hello"),
691 "(10u32, ~\"hello\")");
692 exact_test(&(10u64, ~"hello"),
693 "(10u64, ~\"hello\")");
695 exact_test(&(&[1, 2]), "&[1, 2]");
696 exact_test(&(&mut [1, 2]), "&mut [1, 2]");
698 exact_test(&'\'', "'\\''");
699 exact_test(&'"', "'\"'");
700 exact_test(&("'"), "\"'\"");
701 exact_test(&("\""), "\"\\\"\"");
703 exact_test(&println, "fn(&str)");
704 exact_test(&swap::<int>, "fn(&mut int, &mut int)");
705 exact_test(&is_alphabetic, "fn(char) -> bool");
706 exact_test(&(~5 as ~ToStr), "~to_str::ToStr:Send");
709 exact_test(&(~[Foo, Foo]), "~[repr::test_repr::Foo, repr::test_repr::Foo]");
711 struct Bar(int, int);
712 exact_test(&(Bar(2, 2)), "repr::test_repr::Bar(2, 2)");