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;
23 use iterator::Iterator;
25 use option::{Some, None};
28 use reflect::{MovePtr, align};
32 use unstable::intrinsics::{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 do ::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 do ::$ty::to_str_bytes(*self, 10u) |bits| {
66 writer.write(bytes!($suffix));
82 fn write_repr(&self, writer: &mut io::Writer) {
83 let s = self.to_str();
84 writer.write(s.as_bytes());
88 macro_rules! num_repr(($ty:ident, $suffix:expr) => (impl Repr for $ty {
89 fn write_repr(&self, writer: &mut io::Writer) {
90 let s = self.to_str();
91 writer.write(s.as_bytes());
92 writer.write(bytes!($suffix));
99 // New implementation using reflect::MovePtr
107 pub struct ReprVisitor<'self> {
110 var_stk: ~[VariantState],
111 writer: &'self mut io::Writer
114 pub fn ReprVisitor<'a>(ptr: *c_void,
115 writer: &'a mut io::Writer) -> ReprVisitor<'a> {
124 impl<'self> MovePtr for ReprVisitor<'self> {
126 fn move_ptr(&mut self, adjustment: &fn(*c_void) -> *c_void) {
127 self.ptr = adjustment(self.ptr);
129 fn push_ptr(&mut self) {
130 self.ptr_stk.push(self.ptr);
132 fn pop_ptr(&mut self) {
133 self.ptr = self.ptr_stk.pop();
137 impl<'self> ReprVisitor<'self> {
138 // Various helpers for the TyVisitor impl
141 pub fn get<T>(&mut self, f: &fn(&mut ReprVisitor, &T)) -> bool {
143 f(self, transmute::<*c_void,&T>(self.ptr));
149 pub fn visit_inner(&mut self, inner: *TyDesc) -> bool {
150 self.visit_ptr_inner(self.ptr, inner)
154 pub fn visit_ptr_inner(&mut self, ptr: *c_void, inner: *TyDesc) -> bool {
156 // This should call the constructor up above, but due to limiting
157 // issues we have to recreate it here.
158 let u = ReprVisitor {
162 writer: ::cast::transmute_copy(&self.writer),
164 let mut v = reflect::MovePtrAdaptor(u);
165 // Obviously this should not be a thing, but blame #8401 for now
166 visit_tydesc(inner, &mut v as &mut TyVisitor);
172 pub fn write<T:Repr>(&mut self) -> bool {
173 do self.get |this, v:&T| {
174 v.write_repr(unsafe { ::cast::transmute_copy(&this.writer) });
178 pub fn write_escaped_slice(&mut self, slice: &str) {
179 self.writer.write(['"' as u8]);
180 for ch in slice.iter() {
181 self.write_escaped_char(ch);
183 self.writer.write(['"' as u8]);
186 pub fn write_mut_qualifier(&mut self, mtbl: uint) {
188 self.writer.write("mut ".as_bytes());
189 } else if mtbl == 1 {
190 // skip, this is ast::m_imm
193 self.writer.write("const ".as_bytes());
197 pub fn write_vec_range(&mut self,
203 let mut p = ptr as *u8;
204 let (sz, al) = unsafe { ((*inner).size, (*inner).align) };
205 self.writer.write(['[' as u8]);
206 let mut first = true;
208 // unit structs have 0 size, and don't loop forever.
209 let dec = if sz == 0 {1} else {sz};
214 self.writer.write(", ".as_bytes());
216 self.visit_ptr_inner(p as *c_void, inner);
217 p = align(unsafe { ptr::offset(p, sz as int) as uint }, al) as *u8;
220 self.writer.write([']' as u8]);
224 pub fn write_unboxed_vec_repr(&mut self,
229 self.write_vec_range(mtbl, ptr::to_unsafe_ptr(&v.data),
233 fn write_escaped_char(&mut self, ch: char) {
235 '\t' => self.writer.write("\\t".as_bytes()),
236 '\r' => self.writer.write("\\r".as_bytes()),
237 '\n' => self.writer.write("\\n".as_bytes()),
238 '\\' => self.writer.write("\\\\".as_bytes()),
239 '\'' => self.writer.write("\\'".as_bytes()),
240 '"' => self.writer.write("\\\"".as_bytes()),
241 '\x20'..'\x7e' => self.writer.write([ch as u8]),
243 do char::escape_unicode(ch) |c| {
244 self.writer.write([c as u8]);
251 impl<'self> TyVisitor for ReprVisitor<'self> {
252 fn visit_bot(&mut self) -> bool {
253 self.writer.write("!".as_bytes());
256 fn visit_nil(&mut self) -> bool { self.write::<()>() }
257 fn visit_bool(&mut self) -> bool { self.write::<bool>() }
258 fn visit_int(&mut self) -> bool { self.write::<int>() }
259 fn visit_i8(&mut self) -> bool { self.write::<i8>() }
260 fn visit_i16(&mut self) -> bool { self.write::<i16>() }
261 fn visit_i32(&mut self) -> bool { self.write::<i32>() }
262 fn visit_i64(&mut self) -> bool { self.write::<i64>() }
264 fn visit_uint(&mut self) -> bool { self.write::<uint>() }
265 fn visit_u8(&mut self) -> bool { self.write::<u8>() }
266 fn visit_u16(&mut self) -> bool { self.write::<u16>() }
267 fn visit_u32(&mut self) -> bool { self.write::<u32>() }
268 fn visit_u64(&mut self) -> bool { self.write::<u64>() }
270 fn visit_float(&mut self) -> bool { self.write::<float>() }
271 fn visit_f32(&mut self) -> bool { self.write::<f32>() }
272 fn visit_f64(&mut self) -> bool { self.write::<f64>() }
274 fn visit_char(&mut self) -> bool {
275 do self.get::<char> |this, &ch| {
276 this.writer.write(['\'' as u8]);
277 this.write_escaped_char(ch);
278 this.writer.write(['\'' as u8]);
282 fn visit_estr_box(&mut self) -> bool {
283 do self.get::<@str> |this, s| {
284 this.writer.write(['@' as u8]);
285 this.write_escaped_slice(*s);
289 fn visit_estr_uniq(&mut self) -> bool {
290 do self.get::<~str> |this, s| {
291 this.writer.write(['~' as u8]);
292 this.write_escaped_slice(*s);
296 fn visit_estr_slice(&mut self) -> bool {
297 do self.get::<&str> |this, s| {
298 this.write_escaped_slice(*s);
302 // Type no longer exists, vestigial function.
303 fn visit_estr_fixed(&mut self, _n: uint, _sz: uint,
304 _align: uint) -> bool { fail!(); }
306 fn visit_box(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
307 self.writer.write(['@' as u8]);
308 self.write_mut_qualifier(mtbl);
309 do self.get::<&raw::Box<()>> |this, b| {
310 let p = ptr::to_unsafe_ptr(&b.data) as *c_void;
311 this.visit_ptr_inner(p, inner);
315 fn visit_uniq(&mut self, _mtbl: uint, inner: *TyDesc) -> bool {
316 self.writer.write(['~' as u8]);
317 do self.get::<*c_void> |this, b| {
318 this.visit_ptr_inner(*b, inner);
322 fn visit_uniq_managed(&mut self, _mtbl: uint, inner: *TyDesc) -> bool {
323 self.writer.write(['~' as u8]);
324 do self.get::<&raw::Box<()>> |this, b| {
325 let p = ptr::to_unsafe_ptr(&b.data) as *c_void;
326 this.visit_ptr_inner(p, inner);
330 fn visit_ptr(&mut self, mtbl: uint, _inner: *TyDesc) -> bool {
331 do self.get::<*c_void> |this, p| {
332 write!(this.writer, "({} as *", *p);
333 this.write_mut_qualifier(mtbl);
334 this.writer.write("())".as_bytes());
338 fn visit_rptr(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
339 self.writer.write(['&' as u8]);
340 self.write_mut_qualifier(mtbl);
341 do self.get::<*c_void> |this, p| {
342 this.visit_ptr_inner(*p, inner);
346 // Type no longer exists, vestigial function.
347 fn visit_vec(&mut self, _mtbl: uint, _inner: *TyDesc) -> bool { fail!(); }
350 fn visit_unboxed_vec(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
351 do self.get::<raw::Vec<()>> |this, b| {
352 this.write_unboxed_vec_repr(mtbl, b, inner);
356 fn visit_evec_box(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
357 do self.get::<&raw::Box<raw::Vec<()>>> |this, b| {
358 this.writer.write(['@' as u8]);
359 this.write_mut_qualifier(mtbl);
360 this.write_unboxed_vec_repr(mtbl, &b.data, inner);
364 fn visit_evec_uniq(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
365 do self.get::<&raw::Vec<()>> |this, b| {
366 this.writer.write(['~' as u8]);
367 this.write_unboxed_vec_repr(mtbl, *b, inner);
371 fn visit_evec_uniq_managed(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
372 do self.get::<&raw::Box<raw::Vec<()>>> |this, b| {
373 this.writer.write(['~' as u8]);
374 this.write_unboxed_vec_repr(mtbl, &b.data, inner);
378 fn visit_evec_slice(&mut self, mtbl: uint, inner: *TyDesc) -> bool {
379 do self.get::<raw::Slice<()>> |this, s| {
380 this.writer.write(['&' as u8]);
381 this.write_vec_range(mtbl, s.data, s.len, inner);
385 fn visit_evec_fixed(&mut self, _n: uint, sz: uint, _align: uint,
386 mtbl: uint, inner: *TyDesc) -> bool {
387 do self.get::<()> |this, b| {
388 this.write_vec_range(mtbl, ptr::to_unsafe_ptr(b), sz, inner);
392 fn visit_enter_rec(&mut self, _n_fields: uint,
393 _sz: uint, _align: uint) -> bool {
394 self.writer.write(['{' as u8]);
398 fn visit_rec_field(&mut self, i: uint, name: &str,
399 mtbl: uint, inner: *TyDesc) -> bool {
401 self.writer.write(", ".as_bytes());
403 self.write_mut_qualifier(mtbl);
404 self.writer.write(name.as_bytes());
405 self.writer.write(": ".as_bytes());
406 self.visit_inner(inner);
410 fn visit_leave_rec(&mut self, _n_fields: uint,
411 _sz: uint, _align: uint) -> bool {
412 self.writer.write(['}' as u8]);
416 fn visit_enter_class(&mut self, _n_fields: uint,
417 _sz: uint, _align: uint) -> bool {
418 self.writer.write(['{' as u8]);
421 fn visit_class_field(&mut self, i: uint, name: &str,
422 mtbl: uint, inner: *TyDesc) -> bool {
424 self.writer.write(", ".as_bytes());
426 self.write_mut_qualifier(mtbl);
427 self.writer.write(name.as_bytes());
428 self.writer.write(": ".as_bytes());
429 self.visit_inner(inner);
432 fn visit_leave_class(&mut self, _n_fields: uint,
433 _sz: uint, _align: uint) -> bool {
434 self.writer.write(['}' as u8]);
438 fn visit_enter_tup(&mut self, _n_fields: uint,
439 _sz: uint, _align: uint) -> bool {
440 self.writer.write(['(' as u8]);
443 fn visit_tup_field(&mut self, i: uint, inner: *TyDesc) -> bool {
445 self.writer.write(", ".as_bytes());
447 self.visit_inner(inner);
450 fn visit_leave_tup(&mut self, _n_fields: uint,
451 _sz: uint, _align: uint) -> bool {
453 self.writer.write([',' as u8]);
455 self.writer.write([')' as u8]);
459 fn visit_enter_enum(&mut self,
461 get_disr: extern unsafe fn(ptr: *Opaque) -> int,
463 _align: uint) -> bool {
465 get_disr(transmute(self.ptr))
467 self.var_stk.push(SearchingFor(disr));
471 fn visit_enter_enum_variant(&mut self, _variant: uint,
474 name: &str) -> bool {
475 let mut write = false;
476 match self.var_stk.pop() {
477 SearchingFor(sought) => {
478 if disr_val == sought {
479 self.var_stk.push(Matched);
482 self.var_stk.push(SearchingFor(sought));
485 Matched | AlreadyFound => {
486 self.var_stk.push(AlreadyFound);
491 self.writer.write(name.as_bytes());
493 self.writer.write(['(' as u8]);
499 fn visit_enum_variant_field(&mut self,
504 match self.var_stk[self.var_stk.len() - 1] {
507 self.writer.write(", ".as_bytes());
509 if ! self.visit_inner(inner) {
518 fn visit_leave_enum_variant(&mut self, _variant: uint,
521 _name: &str) -> bool {
522 match self.var_stk[self.var_stk.len() - 1] {
525 self.writer.write([')' as u8]);
533 fn visit_leave_enum(&mut self,
535 _get_disr: extern unsafe fn(ptr: *Opaque) -> int,
539 match self.var_stk.pop() {
540 SearchingFor(*) => fail!("enum value matched no variant"),
545 fn visit_enter_fn(&mut self, _purity: uint, _proto: uint,
546 _n_inputs: uint, _retstyle: uint) -> bool { true }
547 fn visit_fn_input(&mut self, _i: uint, _mode: uint, _inner: *TyDesc) -> bool {
550 fn visit_fn_output(&mut self, _retstyle: uint, _inner: *TyDesc) -> bool {
553 fn visit_leave_fn(&mut self, _purity: uint, _proto: uint,
554 _n_inputs: uint, _retstyle: uint) -> bool { true }
557 fn visit_trait(&mut self) -> bool { true }
558 fn visit_param(&mut self, _i: uint) -> bool { true }
559 fn visit_self(&mut self) -> bool { true }
560 fn visit_type(&mut self) -> bool { true }
562 fn visit_opaque_box(&mut self) -> bool {
563 self.writer.write(['@' as u8]);
564 do self.get::<&raw::Box<()>> |this, b| {
565 let p = ptr::to_unsafe_ptr(&b.data) as *c_void;
566 this.visit_ptr_inner(p, b.type_desc);
570 fn visit_closure_ptr(&mut self, _ck: uint) -> bool { true }
573 pub fn write_repr<T>(writer: &mut io::Writer, object: &T) {
575 let ptr = ptr::to_unsafe_ptr(object) as *c_void;
576 let tydesc = get_tydesc::<T>();
577 let u = ReprVisitor(ptr, writer);
578 let mut v = reflect::MovePtrAdaptor(u);
579 visit_tydesc(tydesc, &mut v as &mut TyVisitor);
584 struct P {a: int, b: float}
590 use rt::io::Decorator;
592 fn exact_test<T>(t: &T, e:&str) {
593 let mut m = io::mem::MemWriter::new();
594 write_repr(&mut m as &mut io::Writer, t);
595 let s = str::from_bytes_owned(m.inner());
596 assert_eq!(s.as_slice(), e);
599 exact_test(&10, "10");
600 exact_test(&true, "true");
601 exact_test(&false, "false");
602 exact_test(&1.234, "1.234");
603 exact_test(&(&"hello"), "\"hello\"");
604 exact_test(&(@"hello"), "@\"hello\"");
605 exact_test(&(~"he\u10f3llo"), "~\"he\\u10f3llo\"");
607 exact_test(&(@10), "@10");
608 exact_test(&(@mut 10), "@mut 10");
609 exact_test(&((@mut 10, 2)), "(@mut 10, 2)");
610 exact_test(&(~10), "~10");
611 exact_test(&(&10), "&10");
613 exact_test(&(&mut x), "&mut 10");
614 exact_test(&(@mut [1, 2]), "@mut [1, 2]");
616 exact_test(&(0 as *()), "(0x0 as *())");
617 exact_test(&(0 as *mut ()), "(0x0 as *mut ())");
619 exact_test(&(1,), "(1,)");
620 exact_test(&(@[1,2,3,4,5,6,7,8]),
621 "@[1, 2, 3, 4, 5, 6, 7, 8]");
622 exact_test(&(@[1u8,2u8,3u8,4u8]),
623 "@[1u8, 2u8, 3u8, 4u8]");
624 exact_test(&(@["hi", "there"]),
625 "@[\"hi\", \"there\"]");
626 exact_test(&(~["hi", "there"]),
627 "~[\"hi\", \"there\"]");
628 exact_test(&(&["hi", "there"]),
629 "&[\"hi\", \"there\"]");
630 exact_test(&(P{a:10, b:1.234}),
631 "{a: 10, b: 1.234}");
632 exact_test(&(@P{a:10, b:1.234}),
633 "@{a: 10, b: 1.234}");
634 exact_test(&(~P{a:10, b:1.234}),
635 "~{a: 10, b: 1.234}");
636 exact_test(&(10u8, ~"hello"),
637 "(10u8, ~\"hello\")");
638 exact_test(&(10u16, ~"hello"),
639 "(10u16, ~\"hello\")");
640 exact_test(&(10u32, ~"hello"),
641 "(10u32, ~\"hello\")");
642 exact_test(&(10u64, ~"hello"),
643 "(10u64, ~\"hello\")");
646 exact_test(&(~[Foo, Foo, Foo]), "~[{}, {}, {}]");