1 // Copyright 2012-2014 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.
17 use owned_slice::OwnedSlice;
27 pub fn path_name_i(idents: &[Ident]) -> String {
28 // FIXME: Bad copies (#2543 -- same for everything else that says "bad")
29 idents.iter().map(|i| {
30 token::get_ident(*i).get().to_string()
31 }).collect::<Vec<String>>().connect("::")
34 pub fn local_def(id: NodeId) -> DefId {
35 ast::DefId { krate: LOCAL_CRATE, node: id }
38 pub fn is_local(did: ast::DefId) -> bool { did.krate == LOCAL_CRATE }
40 pub fn stmt_id(s: &Stmt) -> NodeId {
42 StmtDecl(_, id) => id,
43 StmtExpr(_, id) => id,
44 StmtSemi(_, id) => id,
45 StmtMac(..) => panic!("attempted to analyze unexpanded stmt")
49 pub fn binop_to_string(op: BinOp) -> &'static str {
72 pub fn lazy_binop(b: BinOp) -> bool {
80 pub fn is_shift_binop(b: BinOp) -> bool {
88 pub fn unop_to_string(op: UnOp) -> &'static str {
97 pub fn is_path(e: P<Expr>) -> bool {
98 return match e.node { ExprPath(_) => true, _ => false };
101 /// Get a string representation of a signed int type, with its value.
102 /// We want to avoid "45int" and "-3int" in favor of "45" and "-3"
103 pub fn int_ty_to_string(t: IntTy, val: Option<i64>) -> String {
105 TyI if val.is_some() => "i",
114 // cast to a u64 so we can correctly print INT64_MIN. All integral types
115 // are parsed as u64, so we wouldn't want to print an extra negative
117 Some(n) => format!("{}{}", n as u64, s),
118 None => s.to_string()
122 pub fn int_ty_max(t: IntTy) -> u64 {
126 TyI | TyI32 => 0x80000000u64, // actually ni about TyI
127 TyI64 => 0x8000000000000000u64
131 /// Get a string representation of an unsigned int type, with its value.
132 /// We want to avoid "42uint" in favor of "42u"
133 pub fn uint_ty_to_string(t: UintTy, val: Option<u64>) -> String {
135 TyU if val.is_some() => "u",
144 Some(n) => format!("{}{}", n, s),
145 None => s.to_string()
149 pub fn uint_ty_max(t: UintTy) -> u64 {
153 TyU | TyU32 => 0xffffffffu64, // actually ni about TyU
154 TyU64 => 0xffffffffffffffffu64
158 pub fn float_ty_to_string(t: FloatTy) -> String {
160 TyF32 => "f32".to_string(),
161 TyF64 => "f64".to_string(),
165 // convert a span and an identifier to the corresponding
167 pub fn ident_to_path(s: Span, identifier: Ident) -> Path {
173 identifier: identifier,
174 parameters: ast::AngleBracketedParameters(ast::AngleBracketedParameterData {
175 lifetimes: Vec::new(),
176 types: OwnedSlice::empty(),
183 pub fn ident_to_pat(id: NodeId, s: Span, i: Ident) -> P<Pat> {
186 node: PatIdent(BindByValue(MutImmutable), codemap::Spanned{span:s, node:i}, None),
191 pub fn name_to_dummy_lifetime(name: Name) -> Lifetime {
192 Lifetime { id: DUMMY_NODE_ID,
193 span: codemap::DUMMY_SP,
197 /// Generate a "pretty" name for an `impl` from its type and trait.
198 /// This is designed so that symbols of `impl`'d methods give some
199 /// hint of where they came from, (previously they would all just be
200 /// listed as `__extensions__::method_name::hash`, with no indication
202 pub fn impl_pretty_name(trait_ref: &Option<TraitRef>, ty: &Ty) -> Ident {
203 let mut pretty = pprust::ty_to_string(ty);
205 Some(ref trait_ref) => {
207 pretty.push_str(pprust::path_to_string(&trait_ref.path).as_slice());
211 token::gensym_ident(pretty.as_slice())
214 pub fn trait_method_to_ty_method(method: &Method) -> TypeMethod {
226 attrs: method.attrs.clone(),
228 decl: (*decl).clone(),
229 generics: generics.clone(),
230 explicit_self: (*explicit_self).clone(),
237 MethMac(_) => panic!("expected non-macro method declaration")
241 /// extract a TypeMethod from a TraitItem. if the TraitItem is
242 /// a default, pull out the useful fields to make a TypeMethod
244 // NB: to be used only after expansion is complete, and macros are gone.
245 pub fn trait_item_to_ty_method(method: &TraitItem) -> TypeMethod {
247 RequiredMethod(ref m) => (*m).clone(),
248 ProvidedMethod(ref m) => trait_method_to_ty_method(&**m),
249 TypeTraitItem(_) => {
250 panic!("trait_method_to_ty_method(): expected method but found \
256 pub fn split_trait_methods(trait_methods: &[TraitItem])
257 -> (Vec<TypeMethod>, Vec<P<Method>> ) {
258 let mut reqd = Vec::new();
259 let mut provd = Vec::new();
260 for trt_method in trait_methods.iter() {
262 RequiredMethod(ref tm) => reqd.push((*tm).clone()),
263 ProvidedMethod(ref m) => provd.push((*m).clone()),
264 TypeTraitItem(_) => {}
270 pub fn struct_field_visibility(field: ast::StructField) -> Visibility {
271 match field.node.kind {
272 ast::NamedField(_, v) | ast::UnnamedField(v) => v
276 /// Maps a binary operator to its precedence
277 pub fn operator_prec(op: ast::BinOp) -> uint {
279 // 'as' sits here with 12
280 BiMul | BiDiv | BiRem => 11u,
281 BiAdd | BiSub => 10u,
286 BiLt | BiLe | BiGe | BiGt => 4u,
293 /// Precedence of the `as` operator, which is a binary operator
294 /// not appearing in the prior table.
295 #[allow(non_upper_case_globals)]
296 pub static as_prec: uint = 12u;
298 pub fn empty_generics() -> Generics {
300 lifetimes: Vec::new(),
301 ty_params: OwnedSlice::empty(),
302 where_clause: WhereClause {
304 predicates: Vec::new(),
309 // ______________________________________________________________________
310 // Enumerating the IDs which appear in an AST
312 #[deriving(Encodable, Decodable, Show)]
319 pub fn max() -> IdRange {
326 pub fn empty(&self) -> bool {
330 pub fn add(&mut self, id: NodeId) {
331 self.min = cmp::min(self.min, id);
332 self.max = cmp::max(self.max, id + 1);
336 pub trait IdVisitingOperation {
337 fn visit_id(&mut self, node_id: NodeId);
340 /// A visitor that applies its operation to all of the node IDs
341 /// in a visitable thing.
343 pub struct IdVisitor<'a, O:'a> {
344 pub operation: &'a mut O,
345 pub pass_through_items: bool,
346 pub visited_outermost: bool,
349 impl<'a, O: IdVisitingOperation> IdVisitor<'a, O> {
350 fn visit_generics_helper(&mut self, generics: &Generics) {
351 for type_parameter in generics.ty_params.iter() {
352 self.operation.visit_id(type_parameter.id)
354 for lifetime in generics.lifetimes.iter() {
355 self.operation.visit_id(lifetime.lifetime.id)
360 impl<'a, 'v, O: IdVisitingOperation> Visitor<'v> for IdVisitor<'a, O> {
361 fn visit_mod(&mut self,
365 self.operation.visit_id(node_id);
366 visit::walk_mod(self, module)
369 fn visit_view_item(&mut self, view_item: &ViewItem) {
370 if !self.pass_through_items {
371 if self.visited_outermost {
374 self.visited_outermost = true;
377 match view_item.node {
378 ViewItemExternCrate(_, _, node_id) => {
379 self.operation.visit_id(node_id)
381 ViewItemUse(ref view_path) => {
382 match view_path.node {
383 ViewPathSimple(_, _, node_id) |
384 ViewPathGlob(_, node_id) => {
385 self.operation.visit_id(node_id)
387 ViewPathList(_, ref paths, node_id) => {
388 self.operation.visit_id(node_id);
389 for path in paths.iter() {
390 self.operation.visit_id(path.node.id())
396 visit::walk_view_item(self, view_item);
397 self.visited_outermost = false;
400 fn visit_foreign_item(&mut self, foreign_item: &ForeignItem) {
401 self.operation.visit_id(foreign_item.id);
402 visit::walk_foreign_item(self, foreign_item)
405 fn visit_item(&mut self, item: &Item) {
406 if !self.pass_through_items {
407 if self.visited_outermost {
410 self.visited_outermost = true
414 self.operation.visit_id(item.id);
416 ItemEnum(ref enum_definition, _) => {
417 for variant in enum_definition.variants.iter() {
418 self.operation.visit_id(variant.node.id)
424 visit::walk_item(self, item);
426 self.visited_outermost = false
429 fn visit_local(&mut self, local: &Local) {
430 self.operation.visit_id(local.id);
431 visit::walk_local(self, local)
434 fn visit_block(&mut self, block: &Block) {
435 self.operation.visit_id(block.id);
436 visit::walk_block(self, block)
439 fn visit_stmt(&mut self, statement: &Stmt) {
440 self.operation.visit_id(ast_util::stmt_id(statement));
441 visit::walk_stmt(self, statement)
444 fn visit_pat(&mut self, pattern: &Pat) {
445 self.operation.visit_id(pattern.id);
446 visit::walk_pat(self, pattern)
449 fn visit_expr(&mut self, expression: &Expr) {
450 self.operation.visit_id(expression.id);
451 visit::walk_expr(self, expression)
454 fn visit_ty(&mut self, typ: &Ty) {
455 self.operation.visit_id(typ.id);
457 TyPath(_, _, id) => self.operation.visit_id(id),
460 visit::walk_ty(self, typ)
463 fn visit_generics(&mut self, generics: &Generics) {
464 self.visit_generics_helper(generics);
465 visit::walk_generics(self, generics)
468 fn visit_fn(&mut self,
469 function_kind: visit::FnKind<'v>,
470 function_declaration: &'v FnDecl,
474 if !self.pass_through_items {
475 match function_kind {
476 visit::FkMethod(..) if self.visited_outermost => return,
477 visit::FkMethod(..) => self.visited_outermost = true,
482 self.operation.visit_id(node_id);
484 match function_kind {
485 visit::FkItemFn(_, generics, _, _) |
486 visit::FkMethod(_, generics, _) => {
487 self.visit_generics_helper(generics)
489 visit::FkFnBlock => {}
492 for argument in function_declaration.inputs.iter() {
493 self.operation.visit_id(argument.id)
498 function_declaration,
502 if !self.pass_through_items {
503 match function_kind {
504 visit::FkMethod(..) => self.visited_outermost = false,
510 fn visit_struct_field(&mut self, struct_field: &StructField) {
511 self.operation.visit_id(struct_field.node.id);
512 visit::walk_struct_field(self, struct_field)
515 fn visit_struct_def(&mut self,
516 struct_def: &StructDef,
520 self.operation.visit_id(id);
521 struct_def.ctor_id.map(|ctor_id| self.operation.visit_id(ctor_id));
522 visit::walk_struct_def(self, struct_def);
525 fn visit_trait_item(&mut self, tm: &ast::TraitItem) {
527 ast::RequiredMethod(ref m) => self.operation.visit_id(m.id),
528 ast::ProvidedMethod(ref m) => self.operation.visit_id(m.id),
529 ast::TypeTraitItem(ref typ) => self.operation.visit_id(typ.ty_param.id),
531 visit::walk_trait_item(self, tm);
534 fn visit_lifetime_ref(&mut self, lifetime: &'v Lifetime) {
535 self.operation.visit_id(lifetime.id);
538 fn visit_lifetime_def(&mut self, def: &'v LifetimeDef) {
539 self.visit_lifetime_ref(&def.lifetime);
543 pub fn visit_ids_for_inlined_item<O: IdVisitingOperation>(item: &InlinedItem,
545 let mut id_visitor = IdVisitor {
546 operation: operation,
547 pass_through_items: true,
548 visited_outermost: false,
551 visit::walk_inlined_item(&mut id_visitor, item);
554 struct IdRangeComputingVisitor {
558 impl IdVisitingOperation for IdRangeComputingVisitor {
559 fn visit_id(&mut self, id: NodeId) {
564 pub fn compute_id_range_for_inlined_item(item: &InlinedItem) -> IdRange {
565 let mut visitor = IdRangeComputingVisitor {
566 result: IdRange::max()
568 visit_ids_for_inlined_item(item, &mut visitor);
572 /// Computes the id range for a single fn body, ignoring nested items.
573 pub fn compute_id_range_for_fn_body(fk: visit::FnKind,
580 let mut visitor = IdRangeComputingVisitor {
581 result: IdRange::max()
583 let mut id_visitor = IdVisitor {
584 operation: &mut visitor,
585 pass_through_items: false,
586 visited_outermost: false,
588 id_visitor.visit_fn(fk, decl, body, sp, id);
589 id_visitor.operation.result
592 pub fn walk_pat(pat: &Pat, it: |&Pat| -> bool) -> bool {
598 PatIdent(_, _, Some(ref p)) => walk_pat(&**p, it),
599 PatStruct(_, ref fields, _) => {
600 fields.iter().all(|field| walk_pat(&*field.node.pat, |p| it(p)))
602 PatEnum(_, Some(ref s)) | PatTup(ref s) => {
603 s.iter().all(|p| walk_pat(&**p, |p| it(p)))
605 PatBox(ref s) | PatRegion(ref s) => {
608 PatVec(ref before, ref slice, ref after) => {
609 before.iter().all(|p| walk_pat(&**p, |p| it(p))) &&
610 slice.iter().all(|p| walk_pat(&**p, |p| it(p))) &&
611 after.iter().all(|p| walk_pat(&**p, |p| it(p)))
613 PatMac(_) => panic!("attempted to analyze unexpanded pattern"),
614 PatWild(_) | PatLit(_) | PatRange(_, _) | PatIdent(_, _, _) |
621 pub trait EachViewItem {
622 fn each_view_item(&self, f: |&ast::ViewItem| -> bool) -> bool;
625 struct EachViewItemData<'a> {
626 callback: |&ast::ViewItem|: 'a -> bool,
629 impl<'a, 'v> Visitor<'v> for EachViewItemData<'a> {
630 fn visit_view_item(&mut self, view_item: &ast::ViewItem) {
631 let _ = (self.callback)(view_item);
635 impl EachViewItem for ast::Crate {
636 fn each_view_item(&self, f: |&ast::ViewItem| -> bool) -> bool {
637 let mut visit = EachViewItemData {
640 visit::walk_crate(&mut visit, self);
645 pub fn view_path_id(p: &ViewPath) -> NodeId {
647 ViewPathSimple(_, _, id) | ViewPathGlob(_, id)
648 | ViewPathList(_, _, id) => id
652 /// Returns true if the given struct def is tuple-like; i.e. that its fields
654 pub fn struct_def_is_tuple_like(struct_def: &ast::StructDef) -> bool {
655 struct_def.ctor_id.is_some()
658 /// Returns true if the given pattern consists solely of an identifier
659 /// and false otherwise.
660 pub fn pat_is_ident(pat: P<ast::Pat>) -> bool {
662 ast::PatIdent(..) => true,
667 // are two paths equal when compared unhygienically?
668 // since I'm using this to replace ==, it seems appropriate
669 // to compare the span, global, etc. fields as well.
670 pub fn path_name_eq(a : &ast::Path, b : &ast::Path) -> bool {
672 && (a.global == b.global)
673 && (segments_name_eq(a.segments.as_slice(), b.segments.as_slice()))
676 // are two arrays of segments equal when compared unhygienically?
677 pub fn segments_name_eq(a : &[ast::PathSegment], b : &[ast::PathSegment]) -> bool {
678 if a.len() != b.len() {
681 for (idx,seg) in a.iter().enumerate() {
682 if seg.identifier.name != b[idx].identifier.name
683 // FIXME #7743: ident -> name problems in lifetime comparison?
684 // can types contain idents?
685 || seg.parameters != b[idx].parameters
694 /// Returns true if this literal is a string and false otherwise.
695 pub fn lit_is_str(lit: &Lit) -> bool {
702 /// Macro invocations are guaranteed not to occur after expansion is complete.
703 /// Extracting fields of a method requires a dynamic check to make sure that it's
704 /// not a macro invocation. This check is guaranteed to succeed, assuming
705 /// that the invocations are indeed gone.
706 pub trait PostExpansionMethod {
707 fn pe_ident(&self) -> ast::Ident;
708 fn pe_generics<'a>(&'a self) -> &'a ast::Generics;
709 fn pe_abi(&self) -> Abi;
710 fn pe_explicit_self<'a>(&'a self) -> &'a ast::ExplicitSelf;
711 fn pe_fn_style(&self) -> ast::FnStyle;
712 fn pe_fn_decl<'a>(&'a self) -> &'a ast::FnDecl;
713 fn pe_body<'a>(&'a self) -> &'a ast::Block;
714 fn pe_vis(&self) -> ast::Visibility;
717 macro_rules! mf_method{
718 ($meth_name:ident, $field_ty:ty, $field_pat:pat, $result:expr) => {
719 fn $meth_name<'a>(&'a self) -> $field_ty {
721 $field_pat => $result,
723 panic!("expected an AST without macro invocations");
731 impl PostExpansionMethod for Method {
732 mf_method!(pe_ident,ast::Ident,MethDecl(ident,_,_,_,_,_,_,_),ident)
733 mf_method!(pe_generics,&'a ast::Generics,
734 MethDecl(_,ref generics,_,_,_,_,_,_),generics)
735 mf_method!(pe_abi,Abi,MethDecl(_,_,abi,_,_,_,_,_),abi)
736 mf_method!(pe_explicit_self,&'a ast::ExplicitSelf,
737 MethDecl(_,_,_,ref explicit_self,_,_,_,_),explicit_self)
738 mf_method!(pe_fn_style,ast::FnStyle,MethDecl(_,_,_,_,fn_style,_,_,_),fn_style)
739 mf_method!(pe_fn_decl,&'a ast::FnDecl,MethDecl(_,_,_,_,_,ref decl,_,_),&**decl)
740 mf_method!(pe_body,&'a ast::Block,MethDecl(_,_,_,_,_,_,ref body,_),&**body)
741 mf_method!(pe_vis,ast::Visibility,MethDecl(_,_,_,_,_,_,_,vis),vis)
749 fn ident_to_segment(id : &Ident) -> PathSegment {
750 PathSegment {identifier: id.clone(),
751 parameters: PathParameters::none()}
754 #[test] fn idents_name_eq_test() {
755 assert!(segments_name_eq(
756 [Ident{name:Name(3),ctxt:4}, Ident{name:Name(78),ctxt:82}]
757 .iter().map(ident_to_segment).collect::<Vec<PathSegment>>().as_slice(),
758 [Ident{name:Name(3),ctxt:104}, Ident{name:Name(78),ctxt:182}]
759 .iter().map(ident_to_segment).collect::<Vec<PathSegment>>().as_slice()));
760 assert!(!segments_name_eq(
761 [Ident{name:Name(3),ctxt:4}, Ident{name:Name(78),ctxt:82}]
762 .iter().map(ident_to_segment).collect::<Vec<PathSegment>>().as_slice(),
763 [Ident{name:Name(3),ctxt:104}, Ident{name:Name(77),ctxt:182}]
764 .iter().map(ident_to_segment).collect::<Vec<PathSegment>>().as_slice()));