src/libsyntax/ast_util.rs

   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.
   4 //
   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.
  10
  11 use ast::*;
  12 use ast;
  13 use ast_util;
  14 use codemap;
  15 use codemap::Span;
  16 use owned_slice::OwnedSlice;
  17 use parse::token;
  18 use print::pprust;
  19 use ptr::P;
  20 use visit::{FnKind, Visitor};
  21 use visit;
  22
  23 use std::cmp;
  24 use std::u32;
  25
  26 pub fn path_name_i(idents: &[Ident]) -> String {
  27     // FIXME: Bad copies (#2543 -- same for everything else that says "bad")
  28     idents.iter().map(|i| i.to_string()).collect::<Vec<String>>().join("::")
  29 }
  30
  31 pub fn stmt_id(s: &Stmt) -> Option<NodeId> {
  32     match s.node {
  33       StmtDecl(_, id) => Some(id),
  34       StmtExpr(_, id) => Some(id),
  35       StmtSemi(_, id) => Some(id),
  36       StmtMac(..) => None,
  37     }
  38 }
  39
  40 pub fn binop_to_string(op: BinOp_) -> &'static str {
  41     match op {
  42         BiAdd => "+",
  43         BiSub => "-",
  44         BiMul => "*",
  45         BiDiv => "/",
  46         BiRem => "%",
  47         BiAnd => "&&",
  48         BiOr => "||",
  49         BiBitXor => "^",
  50         BiBitAnd => "&",
  51         BiBitOr => "|",
  52         BiShl => "<<",
  53         BiShr => ">>",
  54         BiEq => "==",
  55         BiLt => "<",
  56         BiLe => "<=",
  57         BiNe => "!=",
  58         BiGe => ">=",
  59         BiGt => ">"
  60     }
  61 }
  62
  63 pub fn lazy_binop(b: BinOp_) -> bool {
  64     match b {
  65       BiAnd => true,
  66       BiOr => true,
  67       _ => false
  68     }
  69 }
  70
  71 pub fn is_shift_binop(b: BinOp_) -> bool {
  72     match b {
  73       BiShl => true,
  74       BiShr => true,
  75       _ => false
  76     }
  77 }
  78
  79 pub fn is_comparison_binop(b: BinOp_) -> bool {
  80     match b {
  81         BiEq | BiLt | BiLe | BiNe | BiGt | BiGe =>
  82             true,
  83         BiAnd | BiOr | BiAdd | BiSub | BiMul | BiDiv | BiRem |
  84         BiBitXor | BiBitAnd | BiBitOr | BiShl | BiShr =>
  85             false,
  86     }
  87 }
  88
  89 /// Returns `true` if the binary operator takes its arguments by value
  90 pub fn is_by_value_binop(b: BinOp_) -> bool {
  91     !is_comparison_binop(b)
  92 }
  93
  94 /// Returns `true` if the unary operator takes its argument by value
  95 pub fn is_by_value_unop(u: UnOp) -> bool {
  96     match u {
  97         UnNeg | UnNot => true,
  98         _ => false,
  99     }
 100 }
 101
 102 pub fn unop_to_string(op: UnOp) -> &'static str {
 103     match op {
 104         UnDeref => "*",
 105         UnNot => "!",
 106         UnNeg => "-",
 107     }
 108 }
 109
 110 pub fn is_path(e: P<Expr>) -> bool {
 111     match e.node { ExprPath(..) => true, _ => false }
 112 }
 113
 114 /// Get a string representation of a signed int type, with its value.
 115 /// We want to avoid "45int" and "-3int" in favor of "45" and "-3"
 116 pub fn int_ty_to_string(t: IntTy, val: Option<i64>) -> String {
 117     let s = match t {
 118         TyIs => "isize",
 119         TyI8 => "i8",
 120         TyI16 => "i16",
 121         TyI32 => "i32",
 122         TyI64 => "i64"
 123     };
 124
 125     match val {
 126         // cast to a u64 so we can correctly print INT64_MIN. All integral types
 127         // are parsed as u64, so we wouldn't want to print an extra negative
 128         // sign.
 129         Some(n) => format!("{}{}", n as u64, s),
 130         None => s.to_string()
 131     }
 132 }
 133
 134 pub fn int_ty_max(t: IntTy) -> u64 {
 135     match t {
 136         TyI8 => 0x80,
 137         TyI16 => 0x8000,
 138         TyIs | TyI32 => 0x80000000, // actually ni about TyIs
 139         TyI64 => 0x8000000000000000
 140     }
 141 }
 142
 143 /// Get a string representation of an unsigned int type, with its value.
 144 /// We want to avoid "42u" in favor of "42us". "42uint" is right out.
 145 pub fn uint_ty_to_string(t: UintTy, val: Option<u64>) -> String {
 146     let s = match t {
 147         TyUs => "usize",
 148         TyU8 => "u8",
 149         TyU16 => "u16",
 150         TyU32 => "u32",
 151         TyU64 => "u64"
 152     };
 153
 154     match val {
 155         Some(n) => format!("{}{}", n, s),
 156         None => s.to_string()
 157     }
 158 }
 159
 160 pub fn uint_ty_max(t: UintTy) -> u64 {
 161     match t {
 162         TyU8 => 0xff,
 163         TyU16 => 0xffff,
 164         TyUs | TyU32 => 0xffffffff, // actually ni about TyUs
 165         TyU64 => 0xffffffffffffffff
 166     }
 167 }
 168
 169 pub fn float_ty_to_string(t: FloatTy) -> String {
 170     match t {
 171         TyF32 => "f32".to_string(),
 172         TyF64 => "f64".to_string(),
 173     }
 174 }
 175
 176 // convert a span and an identifier to the corresponding
 177 // 1-segment path
 178 pub fn ident_to_path(s: Span, identifier: Ident) -> Path {
 179     ast::Path {
 180         span: s,
 181         global: false,
 182         segments: vec!(
 183             ast::PathSegment {
 184                 identifier: identifier,
 185                 parameters: ast::AngleBracketedParameters(ast::AngleBracketedParameterData {
 186                     lifetimes: Vec::new(),
 187                     types: OwnedSlice::empty(),
 188                     bindings: OwnedSlice::empty(),
 189                 })
 190             }
 191         ),
 192     }
 193 }
 194
 195 // If path is a single segment ident path, return that ident. Otherwise, return
 196 // None.
 197 pub fn path_to_ident(path: &Path) -> Option<Ident> {
 198     if path.segments.len() != 1 {
 199         return None;
 200     }
 201
 202     let segment = &path.segments[0];
 203     if !segment.parameters.is_empty() {
 204         return None;
 205     }
 206
 207     Some(segment.identifier)
 208 }
 209
 210 pub fn ident_to_pat(id: NodeId, s: Span, i: Ident) -> P<Pat> {
 211     P(Pat {
 212         id: id,
 213         node: PatIdent(BindByValue(MutImmutable), codemap::Spanned{span:s, node:i}, None),
 214         span: s
 215     })
 216 }
 217
 218 /// Generate a "pretty" name for an `impl` from its type and trait.
 219 /// This is designed so that symbols of `impl`'d methods give some
 220 /// hint of where they came from, (previously they would all just be
 221 /// listed as `__extensions__::method_name::hash`, with no indication
 222 /// of the type).
 223 pub fn impl_pretty_name(trait_ref: &Option<TraitRef>, ty: Option<&Ty>) -> Ident {
 224     let mut pretty = match ty {
 225         Some(t) => pprust::ty_to_string(t),
 226         None => String::from("..")
 227     };
 228
 229     match *trait_ref {
 230         Some(ref trait_ref) => {
 231             pretty.push('.');
 232             pretty.push_str(&pprust::path_to_string(&trait_ref.path));
 233         }
 234         None => {}
 235     }
 236     token::gensym_ident(&pretty[..])
 237 }
 238
 239 pub fn struct_field_visibility(field: ast::StructField) -> Visibility {
 240     match field.node.kind {
 241         ast::NamedField(_, v) | ast::UnnamedField(v) => v
 242     }
 243 }
 244
 245 /// Maps a binary operator to its precedence
 246 pub fn operator_prec(op: ast::BinOp_) -> usize {
 247   match op {
 248       // 'as' sits here with 12
 249       BiMul | BiDiv | BiRem     => 11,
 250       BiAdd | BiSub             => 10,
 251       BiShl | BiShr             =>  9,
 252       BiBitAnd                  =>  8,
 253       BiBitXor                  =>  7,
 254       BiBitOr                   =>  6,
 255       BiLt | BiLe | BiGe | BiGt | BiEq | BiNe => 3,
 256       BiAnd                     =>  2,
 257       BiOr                      =>  1
 258   }
 259 }
 260
 261 /// Precedence of the `as` operator, which is a binary operator
 262 /// not appearing in the prior table.
 263 pub const AS_PREC: usize = 12;
 264
 265 pub fn empty_generics() -> Generics {
 266     Generics {
 267         lifetimes: Vec::new(),
 268         ty_params: OwnedSlice::empty(),
 269         where_clause: WhereClause {
 270             id: DUMMY_NODE_ID,
 271             predicates: Vec::new(),
 272         }
 273     }
 274 }
 275
 276 // ______________________________________________________________________
 277 // Enumerating the IDs which appear in an AST
 278
 279 #[derive(Copy, Clone, RustcEncodable, RustcDecodable, Debug)]
 280 pub struct IdRange {
 281     pub min: NodeId,
 282     pub max: NodeId,
 283 }
 284
 285 impl IdRange {
 286     pub fn max() -> IdRange {
 287         IdRange {
 288             min: u32::MAX,
 289             max: u32::MIN,
 290         }
 291     }
 292
 293     pub fn empty(&self) -> bool {
 294         self.min >= self.max
 295     }
 296
 297     pub fn add(&mut self, id: NodeId) {
 298         self.min = cmp::min(self.min, id);
 299         self.max = cmp::max(self.max, id + 1);
 300     }
 301 }
 302
 303 pub trait IdVisitingOperation {
 304     fn visit_id(&mut self, node_id: NodeId);
 305 }
 306
 307 /// A visitor that applies its operation to all of the node IDs
 308 /// in a visitable thing.
 309
 310 pub struct IdVisitor<'a, O:'a> {
 311     pub operation: &'a mut O,
 312     pub pass_through_items: bool,
 313     pub visited_outermost: bool,
 314 }
 315
 316 impl<'a, O: IdVisitingOperation> IdVisitor<'a, O> {
 317     fn visit_generics_helper(&mut self, generics: &Generics) {
 318         for type_parameter in generics.ty_params.iter() {
 319             self.operation.visit_id(type_parameter.id)
 320         }
 321         for lifetime in &generics.lifetimes {
 322             self.operation.visit_id(lifetime.lifetime.id)
 323         }
 324     }
 325 }
 326
 327 impl<'a, 'v, O: IdVisitingOperation> Visitor<'v> for IdVisitor<'a, O> {
 328     fn visit_mod(&mut self,
 329                  module: &Mod,
 330                  _: Span,
 331                  node_id: NodeId) {
 332         self.operation.visit_id(node_id);
 333         visit::walk_mod(self, module)
 334     }
 335
 336     fn visit_foreign_item(&mut self, foreign_item: &ForeignItem) {
 337         self.operation.visit_id(foreign_item.id);
 338         visit::walk_foreign_item(self, foreign_item)
 339     }
 340
 341     fn visit_item(&mut self, item: &Item) {
 342         if !self.pass_through_items {
 343             if self.visited_outermost {
 344                 return
 345             } else {
 346                 self.visited_outermost = true
 347             }
 348         }
 349
 350         self.operation.visit_id(item.id);
 351         match item.node {
 352             ItemUse(ref view_path) => {
 353                 match view_path.node {
 354                     ViewPathSimple(_, _) |
 355                     ViewPathGlob(_) => {}
 356                     ViewPathList(_, ref paths) => {
 357                         for path in paths {
 358                             self.operation.visit_id(path.node.id())
 359                         }
 360                     }
 361                 }
 362             }
 363             ItemEnum(ref enum_definition, _) => {
 364                 for variant in &enum_definition.variants {
 365                     self.operation.visit_id(variant.node.id)
 366                 }
 367             }
 368             _ => {}
 369         }
 370
 371         visit::walk_item(self, item);
 372
 373         self.visited_outermost = false
 374     }
 375
 376     fn visit_local(&mut self, local: &Local) {
 377         self.operation.visit_id(local.id);
 378         visit::walk_local(self, local)
 379     }
 380
 381     fn visit_block(&mut self, block: &Block) {
 382         self.operation.visit_id(block.id);
 383         visit::walk_block(self, block)
 384     }
 385
 386     fn visit_stmt(&mut self, statement: &Stmt) {
 387         self.operation
 388             .visit_id(ast_util::stmt_id(statement).expect("attempted to visit unexpanded stmt"));
 389         visit::walk_stmt(self, statement)
 390     }
 391
 392     fn visit_pat(&mut self, pattern: &Pat) {
 393         self.operation.visit_id(pattern.id);
 394         visit::walk_pat(self, pattern)
 395     }
 396
 397     fn visit_expr(&mut self, expression: &Expr) {
 398         self.operation.visit_id(expression.id);
 399         visit::walk_expr(self, expression)
 400     }
 401
 402     fn visit_ty(&mut self, typ: &Ty) {
 403         self.operation.visit_id(typ.id);
 404         visit::walk_ty(self, typ)
 405     }
 406
 407     fn visit_generics(&mut self, generics: &Generics) {
 408         self.visit_generics_helper(generics);
 409         visit::walk_generics(self, generics)
 410     }
 411
 412     fn visit_fn(&mut self,
 413                 function_kind: visit::FnKind<'v>,
 414                 function_declaration: &'v FnDecl,
 415                 block: &'v Block,
 416                 span: Span,
 417                 node_id: NodeId) {
 418         if !self.pass_through_items {
 419             match function_kind {
 420                 FnKind::Method(..) if self.visited_outermost => return,
 421                 FnKind::Method(..) => self.visited_outermost = true,
 422                 _ => {}
 423             }
 424         }
 425
 426         self.operation.visit_id(node_id);
 427
 428         match function_kind {
 429             FnKind::ItemFn(_, generics, _, _, _, _) => {
 430                 self.visit_generics_helper(generics)
 431             }
 432             FnKind::Method(_, sig, _) => {
 433                 self.visit_generics_helper(&sig.generics)
 434             }
 435             FnKind::Closure => {}
 436         }
 437
 438         for argument in &function_declaration.inputs {
 439             self.operation.visit_id(argument.id)
 440         }
 441
 442         visit::walk_fn(self,
 443                        function_kind,
 444                        function_declaration,
 445                        block,
 446                        span);
 447
 448         if !self.pass_through_items {
 449             if let FnKind::Method(..) = function_kind {
 450                 self.visited_outermost = false;
 451             }
 452         }
 453     }
 454
 455     fn visit_struct_field(&mut self, struct_field: &StructField) {
 456         self.operation.visit_id(struct_field.node.id);
 457         visit::walk_struct_field(self, struct_field)
 458     }
 459
 460     fn visit_struct_def(&mut self,
 461                         struct_def: &StructDef,
 462                         _: ast::Ident,
 463                         _: &ast::Generics,
 464                         id: NodeId) {
 465         self.operation.visit_id(id);
 466         struct_def.ctor_id.map(|ctor_id| self.operation.visit_id(ctor_id));
 467         visit::walk_struct_def(self, struct_def);
 468     }
 469
 470     fn visit_trait_item(&mut self, ti: &ast::TraitItem) {
 471         self.operation.visit_id(ti.id);
 472         visit::walk_trait_item(self, ti);
 473     }
 474
 475     fn visit_impl_item(&mut self, ii: &ast::ImplItem) {
 476         self.operation.visit_id(ii.id);
 477         visit::walk_impl_item(self, ii);
 478     }
 479
 480     fn visit_lifetime(&mut self, lifetime: &Lifetime) {
 481         self.operation.visit_id(lifetime.id);
 482     }
 483
 484     fn visit_lifetime_def(&mut self, def: &LifetimeDef) {
 485         self.visit_lifetime(&def.lifetime);
 486     }
 487
 488     fn visit_trait_ref(&mut self, trait_ref: &TraitRef) {
 489         self.operation.visit_id(trait_ref.ref_id);
 490         visit::walk_trait_ref(self, trait_ref);
 491     }
 492 }
 493
 494 pub struct IdRangeComputingVisitor {
 495     pub result: IdRange,
 496 }
 497
 498 impl IdRangeComputingVisitor {
 499     pub fn new() -> IdRangeComputingVisitor {
 500         IdRangeComputingVisitor { result: IdRange::max() }
 501     }
 502
 503     pub fn result(&self) -> IdRange {
 504         self.result
 505     }
 506 }
 507
 508 impl IdVisitingOperation for IdRangeComputingVisitor {
 509     fn visit_id(&mut self, id: NodeId) {
 510         self.result.add(id);
 511     }
 512 }
 513
 514 /// Computes the id range for a single fn body, ignoring nested items.
 515 pub fn compute_id_range_for_fn_body(fk: FnKind,
 516                                     decl: &FnDecl,
 517                                     body: &Block,
 518                                     sp: Span,
 519                                     id: NodeId)
 520                                     -> IdRange
 521 {
 522     let mut visitor = IdRangeComputingVisitor::new();
 523     let mut id_visitor = IdVisitor {
 524         operation: &mut visitor,
 525         pass_through_items: false,
 526         visited_outermost: false,
 527     };
 528     id_visitor.visit_fn(fk, decl, body, sp, id);
 529     id_visitor.operation.result
 530 }
 531
 532 /// Returns true if the given struct def is tuple-like; i.e. that its fields
 533 /// are unnamed.
 534 pub fn struct_def_is_tuple_like(struct_def: &ast::StructDef) -> bool {
 535     struct_def.ctor_id.is_some()
 536 }
 537
 538 /// Returns true if the given pattern consists solely of an identifier
 539 /// and false otherwise.
 540 pub fn pat_is_ident(pat: P<ast::Pat>) -> bool {
 541     match pat.node {
 542         ast::PatIdent(..) => true,
 543         _ => false,
 544     }
 545 }
 546
 547 // are two paths equal when compared unhygienically?
 548 // since I'm using this to replace ==, it seems appropriate
 549 // to compare the span, global, etc. fields as well.
 550 pub fn path_name_eq(a : &ast::Path, b : &ast::Path) -> bool {
 551     (a.span == b.span)
 552     && (a.global == b.global)
 553     && (segments_name_eq(&a.segments[..], &b.segments[..]))
 554 }
 555
 556 // are two arrays of segments equal when compared unhygienically?
 557 pub fn segments_name_eq(a : &[ast::PathSegment], b : &[ast::PathSegment]) -> bool {
 558     a.len() == b.len() &&
 559     a.iter().zip(b).all(|(s, t)| {
 560         s.identifier.name == t.identifier.name &&
 561         // FIXME #7743: ident -> name problems in lifetime comparison?
 562         // can types contain idents?
 563         s.parameters == t.parameters
 564     })
 565 }
 566
 567 /// Returns true if this literal is a string and false otherwise.
 568 pub fn lit_is_str(lit: &Lit) -> bool {
 569     match lit.node {
 570         LitStr(..) => true,
 571         _ => false,
 572     }
 573 }
 574
 575 #[cfg(test)]
 576 mod tests {
 577     use ast::*;
 578     use super::*;
 579
 580     fn ident_to_segment(id: Ident) -> PathSegment {
 581         PathSegment {identifier: id,
 582                      parameters: PathParameters::none()}
 583     }
 584
 585     #[test] fn idents_name_eq_test() {
 586         assert!(segments_name_eq(
 587             &[Ident::new(Name(3),SyntaxContext(4)), Ident::new(Name(78),SyntaxContext(82))]
 588                 .iter().cloned().map(ident_to_segment).collect::<Vec<PathSegment>>(),
 589             &[Ident::new(Name(3),SyntaxContext(104)), Ident::new(Name(78),SyntaxContext(182))]
 590                 .iter().cloned().map(ident_to_segment).collect::<Vec<PathSegment>>()));
 591         assert!(!segments_name_eq(
 592             &[Ident::new(Name(3),SyntaxContext(4)), Ident::new(Name(78),SyntaxContext(82))]
 593                 .iter().cloned().map(ident_to_segment).collect::<Vec<PathSegment>>(),
 594             &[Ident::new(Name(3),SyntaxContext(104)), Ident::new(Name(77),SyntaxContext(182))]
 595                 .iter().cloned().map(ident_to_segment).collect::<Vec<PathSegment>>()));
 596     }
 597 }