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.
16 use owned_slice::OwnedSlice;
20 use visit::{FnKind, Visitor};
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("::")
31 pub fn stmt_id(s: &Stmt) -> NodeId {
33 StmtDecl(_, id) => id,
34 StmtExpr(_, id) => id,
35 StmtSemi(_, id) => id,
36 StmtMac(..) => panic!("attempted to analyze unexpanded stmt")
40 pub fn binop_to_string(op: BinOp_) -> &'static str {
63 pub fn lazy_binop(b: BinOp_) -> bool {
71 pub fn is_shift_binop(b: BinOp_) -> bool {
79 pub fn is_comparison_binop(b: BinOp_) -> bool {
81 BiEq | BiLt | BiLe | BiNe | BiGt | BiGe =>
83 BiAnd | BiOr | BiAdd | BiSub | BiMul | BiDiv | BiRem |
84 BiBitXor | BiBitAnd | BiBitOr | BiShl | BiShr =>
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)
94 /// Returns `true` if the unary operator takes its argument by value
95 pub fn is_by_value_unop(u: UnOp) -> bool {
97 UnNeg | UnNot => true,
102 pub fn unop_to_string(op: UnOp) -> &'static str {
111 pub fn is_path(e: P<Expr>) -> bool {
112 match e.node { ExprPath(..) => true, _ => false }
115 /// Get a string representation of a signed int type, with its value.
116 /// We want to avoid "45int" and "-3int" in favor of "45" and "-3"
117 pub fn int_ty_to_string(t: IntTy, val: Option<i64>) -> String {
127 // cast to a u64 so we can correctly print INT64_MIN. All integral types
128 // are parsed as u64, so we wouldn't want to print an extra negative
130 Some(n) => format!("{}{}", n as u64, s),
131 None => s.to_string()
135 pub fn int_ty_max(t: IntTy) -> u64 {
139 TyIs | TyI32 => 0x80000000, // actually ni about TyIs
140 TyI64 => 0x8000000000000000
144 /// Get a string representation of an unsigned int type, with its value.
145 /// We want to avoid "42u" in favor of "42us". "42uint" is right out.
146 pub fn uint_ty_to_string(t: UintTy, val: Option<u64>) -> String {
156 Some(n) => format!("{}{}", n, s),
157 None => s.to_string()
161 pub fn uint_ty_max(t: UintTy) -> u64 {
165 TyUs | TyU32 => 0xffffffff, // actually ni about TyUs
166 TyU64 => 0xffffffffffffffff
170 pub fn float_ty_to_string(t: FloatTy) -> String {
172 TyF32 => "f32".to_string(),
173 TyF64 => "f64".to_string(),
177 // convert a span and an identifier to the corresponding
179 pub fn ident_to_path(s: Span, identifier: Ident) -> Path {
185 identifier: identifier,
186 parameters: ast::AngleBracketedParameters(ast::AngleBracketedParameterData {
187 lifetimes: Vec::new(),
188 types: OwnedSlice::empty(),
189 bindings: OwnedSlice::empty(),
196 // If path is a single segment ident path, return that ident. Otherwise, return
198 pub fn path_to_ident(path: &Path) -> Option<Ident> {
199 if path.segments.len() != 1 {
203 let segment = &path.segments[0];
204 if !segment.parameters.is_empty() {
208 Some(segment.identifier)
211 pub fn ident_to_pat(id: NodeId, s: Span, i: Ident) -> P<Pat> {
214 node: PatIdent(BindByValue(MutImmutable), codemap::Spanned{span:s, node:i}, None),
219 /// Generate a "pretty" name for an `impl` from its type and trait.
220 /// This is designed so that symbols of `impl`'d methods give some
221 /// hint of where they came from, (previously they would all just be
222 /// listed as `__extensions__::method_name::hash`, with no indication
224 pub fn impl_pretty_name(trait_ref: &Option<TraitRef>, ty: Option<&Ty>) -> Ident {
225 let mut pretty = match ty {
226 Some(t) => pprust::ty_to_string(t),
227 None => String::from("..")
231 Some(ref trait_ref) => {
233 pretty.push_str(&pprust::path_to_string(&trait_ref.path));
237 token::gensym_ident(&pretty[..])
240 pub fn struct_field_visibility(field: ast::StructField) -> Visibility {
241 match field.node.kind {
242 ast::NamedField(_, v) | ast::UnnamedField(v) => v
246 /// Maps a binary operator to its precedence
247 pub fn operator_prec(op: ast::BinOp_) -> usize {
249 // 'as' sits here with 12
250 BiMul | BiDiv | BiRem => 11,
256 BiLt | BiLe | BiGe | BiGt | BiEq | BiNe => 3,
262 /// Precedence of the `as` operator, which is a binary operator
263 /// not appearing in the prior table.
264 pub const AS_PREC: usize = 12;
266 pub fn empty_generics() -> Generics {
268 lifetimes: Vec::new(),
269 ty_params: OwnedSlice::empty(),
270 where_clause: WhereClause {
272 predicates: Vec::new(),
277 // ______________________________________________________________________
278 // Enumerating the IDs which appear in an AST
280 #[derive(Copy, Clone, RustcEncodable, RustcDecodable, Debug)]
287 pub fn max() -> IdRange {
294 pub fn empty(&self) -> bool {
298 pub fn add(&mut self, id: NodeId) {
299 self.min = cmp::min(self.min, id);
300 self.max = cmp::max(self.max, id + 1);
304 pub trait IdVisitingOperation {
305 fn visit_id(&mut self, node_id: NodeId);
308 /// A visitor that applies its operation to all of the node IDs
309 /// in a visitable thing.
311 pub struct IdVisitor<'a, O:'a> {
312 pub operation: &'a mut O,
313 pub pass_through_items: bool,
314 pub visited_outermost: bool,
317 impl<'a, O: IdVisitingOperation> IdVisitor<'a, O> {
318 fn visit_generics_helper(&mut self, generics: &Generics) {
319 for type_parameter in generics.ty_params.iter() {
320 self.operation.visit_id(type_parameter.id)
322 for lifetime in &generics.lifetimes {
323 self.operation.visit_id(lifetime.lifetime.id)
328 impl<'a, 'v, O: IdVisitingOperation> Visitor<'v> for IdVisitor<'a, O> {
329 fn visit_mod(&mut self,
333 self.operation.visit_id(node_id);
334 visit::walk_mod(self, module)
337 fn visit_foreign_item(&mut self, foreign_item: &ForeignItem) {
338 self.operation.visit_id(foreign_item.id);
339 visit::walk_foreign_item(self, foreign_item)
342 fn visit_item(&mut self, item: &Item) {
343 if !self.pass_through_items {
344 if self.visited_outermost {
347 self.visited_outermost = true
351 self.operation.visit_id(item.id);
353 ItemUse(ref view_path) => {
354 match view_path.node {
355 ViewPathSimple(_, _) |
356 ViewPathGlob(_) => {}
357 ViewPathList(_, ref paths) => {
359 self.operation.visit_id(path.node.id())
364 ItemEnum(ref enum_definition, _) => {
365 for variant in &enum_definition.variants {
366 self.operation.visit_id(variant.node.id)
372 visit::walk_item(self, item);
374 self.visited_outermost = false
377 fn visit_local(&mut self, local: &Local) {
378 self.operation.visit_id(local.id);
379 visit::walk_local(self, local)
382 fn visit_block(&mut self, block: &Block) {
383 self.operation.visit_id(block.id);
384 visit::walk_block(self, block)
387 fn visit_stmt(&mut self, statement: &Stmt) {
388 self.operation.visit_id(ast_util::stmt_id(statement));
389 visit::walk_stmt(self, statement)
392 fn visit_pat(&mut self, pattern: &Pat) {
393 self.operation.visit_id(pattern.id);
394 visit::walk_pat(self, pattern)
397 fn visit_expr(&mut self, expression: &Expr) {
398 self.operation.visit_id(expression.id);
399 visit::walk_expr(self, expression)
402 fn visit_ty(&mut self, typ: &Ty) {
403 self.operation.visit_id(typ.id);
404 visit::walk_ty(self, typ)
407 fn visit_generics(&mut self, generics: &Generics) {
408 self.visit_generics_helper(generics);
409 visit::walk_generics(self, generics)
412 fn visit_fn(&mut self,
413 function_kind: visit::FnKind<'v>,
414 function_declaration: &'v FnDecl,
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,
426 self.operation.visit_id(node_id);
428 match function_kind {
429 FnKind::ItemFn(_, generics, _, _, _, _) => {
430 self.visit_generics_helper(generics)
432 FnKind::Method(_, sig, _) => {
433 self.visit_generics_helper(&sig.generics)
435 FnKind::Closure => {}
438 for argument in &function_declaration.inputs {
439 self.operation.visit_id(argument.id)
444 function_declaration,
448 if !self.pass_through_items {
449 if let FnKind::Method(..) = function_kind {
450 self.visited_outermost = false;
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)
460 fn visit_struct_def(&mut self,
461 struct_def: &StructDef,
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);
470 fn visit_trait_item(&mut self, ti: &ast::TraitItem) {
471 self.operation.visit_id(ti.id);
472 visit::walk_trait_item(self, ti);
475 fn visit_impl_item(&mut self, ii: &ast::ImplItem) {
476 self.operation.visit_id(ii.id);
477 visit::walk_impl_item(self, ii);
480 fn visit_lifetime_ref(&mut self, lifetime: &Lifetime) {
481 self.operation.visit_id(lifetime.id);
484 fn visit_lifetime_def(&mut self, def: &LifetimeDef) {
485 self.visit_lifetime_ref(&def.lifetime);
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);
494 pub struct IdRangeComputingVisitor {
498 impl IdRangeComputingVisitor {
499 pub fn new() -> IdRangeComputingVisitor {
500 IdRangeComputingVisitor { result: IdRange::max() }
503 pub fn result(&self) -> IdRange {
508 impl IdVisitingOperation for IdRangeComputingVisitor {
509 fn visit_id(&mut self, id: NodeId) {
514 /// Computes the id range for a single fn body, ignoring nested items.
515 pub fn compute_id_range_for_fn_body(fk: FnKind,
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,
528 id_visitor.visit_fn(fk, decl, body, sp, id);
529 id_visitor.operation.result
532 /// Returns true if the given struct def is tuple-like; i.e. that its fields
534 pub fn struct_def_is_tuple_like(struct_def: &ast::StructDef) -> bool {
535 struct_def.ctor_id.is_some()
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 {
542 ast::PatIdent(..) => true,
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 {
552 && (a.global == b.global)
553 && (segments_name_eq(&a.segments[..], &b.segments[..]))
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
567 /// Returns true if this literal is a string and false otherwise.
568 pub fn lit_is_str(lit: &Lit) -> bool {
580 fn ident_to_segment(id : &Ident) -> PathSegment {
581 PathSegment {identifier: id.clone(),
582 parameters: PathParameters::none()}
585 #[test] fn idents_name_eq_test() {
586 assert!(segments_name_eq(
587 &[Ident{name:Name(3),ctxt:4}, Ident{name:Name(78),ctxt:82}]
588 .iter().map(ident_to_segment).collect::<Vec<PathSegment>>(),
589 &[Ident{name:Name(3),ctxt:104}, Ident{name:Name(78),ctxt:182}]
590 .iter().map(ident_to_segment).collect::<Vec<PathSegment>>()));
591 assert!(!segments_name_eq(
592 &[Ident{name:Name(3),ctxt:4}, Ident{name:Name(78),ctxt:82}]
593 .iter().map(ident_to_segment).collect::<Vec<PathSegment>>(),
594 &[Ident{name:Name(3),ctxt:104}, Ident{name:Name(77),ctxt:182}]
595 .iter().map(ident_to_segment).collect::<Vec<PathSegment>>()));