Refactor: LifetimeName is Name; use name, not ident, for such fields.

pnkfelix · pnkfelix · commit 318842a3d9cd · 2014-02-28T17:03:40.000+01:00
After PR rust-lang#12451 landed, lifetimes carry a `Name` instead of an `Ident`. But that PR did not change the field names in `ast.rs` to `name` instead of the prevous `ident`. This impedes hacking on the code, since you are using `foo.ident` in a content expecting a `Name` half the time. We may or may not revert PR rust-lang#12451 in the future (for unrelated reasons). But in the mean time, here are two changes to ease working with the existing code: * Adding the `ast::LifetimeName` alias eases swapping in a newtype struct when hacking, or changing the alias to `Ident` in the future. * Renaming the `ident` fields of type `LifetimeName` to be `name` instead makes the code look much saner.
diff --git a/src/librustc/metadata/decoder.rs b/src/librustc/metadata/decoder.rs
@@ -272,7 +272,7 @@ fn item_region_param_defs(item_doc: ebml::Doc, cdata: Cmd)
                                              tag_region_param_def_def_id);
             let def_id = reader::with_doc_data(def_id_doc, parse_def_id);
             let def_id = translate_def_id(cdata, def_id);
-            v.push(ty::RegionParameterDef { ident: ident.name,
+            v.push(ty::RegionParameterDef { name: ident.name,
                                             def_id: def_id });
             true
         });
diff --git a/src/librustc/metadata/encoder.rs b/src/librustc/metadata/encoder.rs
@@ -190,7 +190,7 @@ fn encode_region_param_defs(ebml_w: &mut writer::Encoder,
         ebml_w.start_tag(tag_region_param_def);
 
         ebml_w.start_tag(tag_region_param_def_ident);
-        encode_name(ebml_w, param.ident);
+        encode_name(ebml_w, param.name);
         ebml_w.end_tag();
 
         ebml_w.wr_tagged_str(tag_region_param_def_def_id,
diff --git a/src/librustc/metadata/tyencode.rs b/src/librustc/metadata/tyencode.rs
@@ -175,11 +175,11 @@ fn enc_region(w: &mut MemWriter, cx: @ctxt, r: ty::Region) {
             enc_bound_region(w, cx, br);
             mywrite!(w, "]");
         }
-        ty::ReEarlyBound(node_id, index, ident) => {
+        ty::ReEarlyBound(node_id, index, name) => {
             mywrite!(w, "B[{}|{}|{}]",
                      node_id,
                      index,
-                     token::get_name(ident));
+                     token::get_name(name));
         }
         ty::ReFree(ref fr) => {
             mywrite!(w, "f[{}|", fr.scope_id);
@@ -207,10 +207,10 @@ fn enc_bound_region(w: &mut MemWriter, cx: @ctxt, br: ty::BoundRegion) {
         ty::BrAnon(idx) => {
             mywrite!(w, "a{}|", idx);
         }
-        ty::BrNamed(d, s) => {
+        ty::BrNamed(d, name) => {
             mywrite!(w, "[{}|{}]",
                      (cx.ds)(d),
-                     token::get_name(s));
+                     token::get_name(name));
         }
         ty::BrFresh(id) => {
             mywrite!(w, "f{}|", id);
diff --git a/src/librustc/middle/resolve_lifetime.rs b/src/librustc/middle/resolve_lifetime.rs
@@ -147,7 +147,7 @@ impl<'a> Visitor<Scope<'a>> for LifetimeContext {
     fn visit_lifetime_ref(&mut self,
                           lifetime_ref: &ast::Lifetime,
                           scope: Scope<'a>) {
-        if lifetime_ref.ident == special_idents::statik.name {
+        if lifetime_ref.name == special_idents::statik.name {
             self.insert_lifetime(lifetime_ref, ast::DefStaticRegion);
             return;
         }
@@ -264,7 +264,7 @@ impl LifetimeContext {
         self.sess.span_err(
             lifetime_ref.span,
             format!("use of undeclared lifetime name `'{}`",
-                    token::get_name(lifetime_ref.ident)));
+                    token::get_name(lifetime_ref.name)));
     }
 
     fn check_lifetime_names(&self, lifetimes: &OptVec<ast::Lifetime>) {
@@ -273,23 +273,23 @@ impl LifetimeContext {
 
             let special_idents = [special_idents::statik];
             for lifetime in lifetimes.iter() {
-                if special_idents.iter().any(|&i| i.name == lifetime.ident) {
+                if special_idents.iter().any(|&i| i.name == lifetime.name) {
                     self.sess.span_err(
                         lifetime.span,
                         format!("illegal lifetime parameter name: `{}`",
-                                token::get_name(lifetime.ident)));
+                                token::get_name(lifetime.name)));
                 }
             }
 
             for j in range(i + 1, lifetimes.len()) {
                 let lifetime_j = lifetimes.get(j);
 
-                if lifetime_i.ident == lifetime_j.ident {
+                if lifetime_i.name == lifetime_j.name {
                     self.sess.span_err(
                         lifetime_j.span,
                         format!("lifetime name `'{}` declared twice in \
                                 the same scope",
-                                token::get_name(lifetime_j.ident)));
+                                token::get_name(lifetime_j.name)));
                 }
             }
         }
@@ -317,7 +317,7 @@ fn search_lifetimes(lifetimes: &OptVec<ast::Lifetime>,
                     lifetime_ref: &ast::Lifetime)
                     -> Option<(uint, ast::NodeId)> {
     for (i, lifetime_decl) in lifetimes.iter().enumerate() {
-        if lifetime_decl.ident == lifetime_ref.ident {
+        if lifetime_decl.name == lifetime_ref.name {
             return Some((i, lifetime_decl.id));
         }
     }
diff --git a/src/librustc/middle/ty.rs b/src/librustc/middle/ty.rs
@@ -466,7 +466,7 @@ pub enum Region {
     // Region bound in a type or fn declaration which will be
     // substituted 'early' -- that is, at the same time when type
     // parameters are substituted.
-    ReEarlyBound(/* param id */ ast::NodeId, /*index*/ uint, ast::Name),
+    ReEarlyBound(/* param id */ ast::NodeId, /*index*/ uint, ast::LifetimeName),
 
     // Region bound in a function scope, which will be substituted when the
     // function is called. The first argument must be the `binder_id` of
@@ -636,7 +636,7 @@ pub enum BoundRegion {
     ///
     /// The def-id is needed to distinguish free regions in
     /// the event of shadowing.
-    BrNamed(ast::DefId, ast::Name),
+    BrNamed(ast::DefId, ast::LifetimeName),
 
     /// Fresh bound identifiers created during GLB computations.
     BrFresh(uint),
@@ -985,7 +985,7 @@ pub struct TypeParameterDef {
 
 #[deriving(Encodable, Decodable, Clone)]
 pub struct RegionParameterDef {
-    ident: ast::Name,
+    name: ast::LifetimeName,
     def_id: ast::DefId,
 }
 
@@ -5114,7 +5114,7 @@ pub fn construct_parameter_environment(
     let region_params = item_region_params.iter().
         map(|r| ty::ReFree(ty::FreeRegion {
                 scope_id: free_id,
-                bound_region: ty::BrNamed(r.def_id, r.ident)})).
+                bound_region: ty::BrNamed(r.def_id, r.name)})).
         collect();
 
     let free_substs = substs {
diff --git a/src/librustc/middle/typeck/astconv.rs b/src/librustc/middle/typeck/astconv.rs
@@ -92,18 +92,18 @@ pub fn ast_region_to_region(tcx: ty::ctxt, lifetime: &ast::Lifetime)
 
         Some(&ast::DefLateBoundRegion(binder_id, _, id)) => {
             ty::ReLateBound(binder_id, ty::BrNamed(ast_util::local_def(id),
-                                                   lifetime.ident))
+                                                   lifetime.name))
         }
 
         Some(&ast::DefEarlyBoundRegion(index, id)) => {
-            ty::ReEarlyBound(id, index, lifetime.ident)
+            ty::ReEarlyBound(id, index, lifetime.name)
         }
 
         Some(&ast::DefFreeRegion(scope_id, id)) => {
             ty::ReFree(ty::FreeRegion {
                     scope_id: scope_id,
                     bound_region: ty::BrNamed(ast_util::local_def(id),
-                                              lifetime.ident)
+                                              lifetime.name)
                 })
         }
     };
diff --git a/src/librustc/middle/typeck/check/mod.rs b/src/librustc/middle/typeck/check/mod.rs
@@ -893,7 +893,7 @@ fn compare_impl_method(tcx: ty::ctxt,
         impl_generics.region_param_defs().iter().
         map(|l| ty::ReFree(ty::FreeRegion {
                 scope_id: impl_m_body_id,
-                bound_region: ty::BrNamed(l.def_id, l.ident)})).
+                bound_region: ty::BrNamed(l.def_id, l.name)})).
         collect();
     let dummy_substs = ty::substs {
         tps: vec::append(dummy_impl_tps, dummy_method_tps),
diff --git a/src/librustc/middle/typeck/collect.rs b/src/librustc/middle/typeck/collect.rs
@@ -310,7 +310,7 @@ pub fn ensure_trait_methods(ccx: &CrateCtxt, trait_id: ast::NodeId) {
         let rps_from_trait =
             trait_ty_generics.region_param_defs().iter().
             enumerate().
-            map(|(index,d)| ty::ReEarlyBound(d.def_id.node, index, d.ident)).
+            map(|(index,d)| ty::ReEarlyBound(d.def_id.node, index, d.name)).
             collect();
 
         // build up the substitution from
@@ -950,7 +950,7 @@ pub fn ty_generics(ccx: &CrateCtxt,
                    base_index: uint) -> ty::Generics {
     return ty::Generics {
         region_param_defs: Rc::new(generics.lifetimes.iter().map(|l| {
-                ty::RegionParameterDef { ident: l.ident,
+                ty::RegionParameterDef { name: l.name,
                                          def_id: local_def(l.id) }
             }).collect()),
         type_param_defs: Rc::new(generics.ty_params.mapi_to_vec(|offset, param| {
@@ -1065,7 +1065,7 @@ pub fn mk_item_substs(ccx: &CrateCtxt,
 
     let regions: OptVec<ty::Region> =
         ty_generics.region_param_defs().iter().enumerate().map(
-            |(i, l)| ty::ReEarlyBound(l.def_id.node, i, l.ident)).collect();
+            |(i, l)| ty::ReEarlyBound(l.def_id.node, i, l.name)).collect();
 
     substs {regions: ty::NonerasedRegions(regions),
             self_ty: self_ty,
diff --git a/src/librustc/middle/typeck/rscope.rs b/src/librustc/middle/typeck/rscope.rs
@@ -78,5 +78,5 @@ pub fn bound_type_regions(defs: &[ty::RegionParameterDef])
                           -> OptVec<ty::Region> {
     assert!(defs.iter().all(|def| def.def_id.krate == ast::LOCAL_CRATE));
     defs.iter().enumerate().map(
-        |(i, def)| ty::ReEarlyBound(def.def_id.node, i, def.ident)).collect()
+        |(i, def)| ty::ReEarlyBound(def.def_id.node, i, def.name)).collect()
 }
diff --git a/src/librustc/util/ppaux.rs b/src/librustc/util/ppaux.rs
@@ -162,8 +162,9 @@ pub fn bound_region_to_str(cx: ctxt,
     }
 
     match br {
-        BrNamed(_, ident)   => format!("{}'{}{}", prefix,
-                                       token::get_name(ident), space_str),
+        BrNamed(_, name)   => format!("{}'{}{}", prefix,
+                                      token::get_name(name),
+                                      space_str),
         BrAnon(_)           => prefix.to_str(),
         BrFresh(_)          => prefix.to_str(),
     }
@@ -225,7 +226,7 @@ pub fn region_to_str(cx: ctxt, prefix: &str, space: bool, region: Region) -> ~st
     // `explain_region()` or `note_and_explain_region()`.
     match region {
         ty::ReScope(_) => prefix.to_str(),
-        ty::ReEarlyBound(_, _, ident) => token::get_name(ident).get().to_str(),
+        ty::ReEarlyBound(_, _, name) => token::get_name(name).get().to_str(),
         ty::ReLateBound(_, br) => bound_region_to_str(cx, prefix, space, br),
         ty::ReFree(ref fr) => bound_region_to_str(cx, prefix, space, fr.bound_region),
         ty::ReInfer(ReSkolemized(_, br)) => {
@@ -630,7 +631,7 @@ impl Repr for ty::TypeParameterDef {
 impl Repr for ty::RegionParameterDef {
     fn repr(&self, _tcx: ctxt) -> ~str {
         format!("RegionParameterDef({}, {:?})",
-                token::get_name(self.ident),
+                token::get_name(self.name),
                 self.def_id)
     }
 }
@@ -716,9 +717,9 @@ impl Repr for ty::BoundRegion {
     fn repr(&self, tcx: ctxt) -> ~str {
         match *self {
             ty::BrAnon(id) => format!("BrAnon({})", id),
-            ty::BrNamed(id, ident) => format!("BrNamed({}, {})",
-                                               id.repr(tcx),
-                                               token::get_name(ident)),
+            ty::BrNamed(id, name) => format!("BrNamed({}, {})",
+                                             id.repr(tcx),
+                                             token::get_name(name)),
             ty::BrFresh(id) => format!("BrFresh({})", id),
         }
     }
@@ -727,9 +728,9 @@ impl Repr for ty::BoundRegion {
 impl Repr for ty::Region {
     fn repr(&self, tcx: ctxt) -> ~str {
         match *self {
-            ty::ReEarlyBound(id, index, ident) => {
+            ty::ReEarlyBound(id, index, name) => {
                 format!("ReEarlyBound({}, {}, {})",
-                        id, index, token::get_name(ident))
+                        id, index, token::get_name(name))
             }
 
             ty::ReLateBound(binder_id, ref bound_region) => {
diff --git a/src/librustdoc/clean.rs b/src/librustdoc/clean.rs
@@ -307,7 +307,7 @@ impl Lifetime {
 
 impl Clean<Lifetime> for ast::Lifetime {
     fn clean(&self) -> Lifetime {
-        Lifetime(token::get_name(self.ident).get().to_owned())
+        Lifetime(token::get_name(self.name).get().to_owned())
     }
 }
 
diff --git a/src/libsyntax/ast.rs b/src/libsyntax/ast.rs
@@ -146,11 +146,15 @@ impl<D:Decoder> Decodable<D> for Ident {
 /// Function name (not all functions have names)
 pub type FnIdent = Option<Ident>;
 
+// Factor out type used for lifetime name to ease switching to/from
+// hygiene-respecting ast::Ident.
+pub type LifetimeName = Name;
+
 #[deriving(Clone, Eq, Encodable, Decodable, Hash)]
 pub struct Lifetime {
     id: NodeId,
     span: Span,
-    ident: Name
+    name: LifetimeName
 }
 
 // a "Path" is essentially Rust's notion of a name;
diff --git a/src/libsyntax/ext/build.rs b/src/libsyntax/ext/build.rs
@@ -411,8 +411,8 @@ impl<'a> AstBuilder for ExtCtxt<'a> {
         ast::TraitTyParamBound(self.trait_ref(path))
     }
 
-    fn lifetime(&self, span: Span, ident: ast::Name) -> ast::Lifetime {
-        ast::Lifetime { id: ast::DUMMY_NODE_ID, span: span, ident: ident }
+    fn lifetime(&self, span: Span, name: ast::LifetimeName) -> ast::Lifetime {
+        ast::Lifetime { id: ast::DUMMY_NODE_ID, span: span, name: name }
     }
 
     fn stmt_expr(&self, expr: @ast::Expr) -> @ast::Stmt {
diff --git a/src/libsyntax/fold.rs b/src/libsyntax/fold.rs
@@ -433,7 +433,7 @@ pub fn fold_lifetime<T: Folder>(l: &Lifetime, fld: &mut T) -> Lifetime {
     Lifetime {
         id: fld.new_id(l.id),
         span: fld.new_span(l.span),
-        ident: l.ident
+        name: l.name
     }
 }
 
diff --git a/src/libsyntax/parse/parser.rs b/src/libsyntax/parse/parser.rs
@@ -1597,7 +1597,7 @@ impl Parser {
                 return ast::Lifetime {
                     id: ast::DUMMY_NODE_ID,
                     span: span,
-                    ident: i.name
+                    name: i.name
                 };
             }
             _ => {
diff --git a/src/libsyntax/print/pprust.rs b/src/libsyntax/print/pprust.rs
@@ -1951,7 +1951,7 @@ pub fn print_bounds(s: &mut State, bounds: &OptVec<ast::TyParamBound>,
 pub fn print_lifetime(s: &mut State,
                       lifetime: &ast::Lifetime) -> io::IoResult<()> {
     try!(word(&mut s.s, "'"));
-    print_name(s, lifetime.ident)
+    print_name(s, lifetime.name)
 }
 
 pub fn print_generics(s: &mut State,

Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ impl<'a> Visitor<Scope<'a>> for LifetimeContext {`
`147`	`147`	`fn visit_lifetime_ref(&mut self,`
`148`	`148`	`lifetime_ref: &ast::Lifetime,`
`149`	`149`	`scope: Scope<'a>) {`
`150`		`- if lifetime_ref.ident == special_idents::statik.name {`
	`150`	`+ if lifetime_ref.name == special_idents::statik.name {`
`151`	`151`	`self.insert_lifetime(lifetime_ref, ast::DefStaticRegion);`
`152`	`152`	`return;`
`153`	`153`	`}`
`@@ -264,7 +264,7 @@ impl LifetimeContext {`
`264`	`264`	`self.sess.span_err(`
`265`	`265`	`lifetime_ref.span,`
`266`	`266`	format!("use of undeclared lifetime name `'{}`",
`267`		`- token::get_name(lifetime_ref.ident)));`
	`267`	`+ token::get_name(lifetime_ref.name)));`
`268`	`268`	`}`
`269`	`269`
`270`	`270`	`fn check_lifetime_names(&self, lifetimes: &OptVec<ast::Lifetime>) {`
`@@ -273,23 +273,23 @@ impl LifetimeContext {`
`273`	`273`
`274`	`274`	`let special_idents = [special_idents::statik];`
`275`	`275`	`for lifetime in lifetimes.iter() {`
`276`		`- if special_idents.iter().any(\|&i\| i.name == lifetime.ident) {`
	`276`	`+ if special_idents.iter().any(\|&i\| i.name == lifetime.name) {`
`277`	`277`	`self.sess.span_err(`
`278`	`278`	`lifetime.span,`
`279`	`279`	format!("illegal lifetime parameter name: `{}`",
`280`		`- token::get_name(lifetime.ident)));`
	`280`	`+ token::get_name(lifetime.name)));`
`281`	`281`	`}`
`282`	`282`	`}`
`283`	`283`
`284`	`284`	`for j in range(i + 1, lifetimes.len()) {`
`285`	`285`	`let lifetime_j = lifetimes.get(j);`
`286`	`286`
`287`		`- if lifetime_i.ident == lifetime_j.ident {`
	`287`	`+ if lifetime_i.name == lifetime_j.name {`
`288`	`288`	`self.sess.span_err(`
`289`	`289`	`lifetime_j.span,`
`290`	`290`	format!("lifetime name `'{}` declared twice in \
`291`	`291`	`the same scope",`
`292`		`- token::get_name(lifetime_j.ident)));`
	`292`	`+ token::get_name(lifetime_j.name)));`
`293`	`293`	`}`
`294`	`294`	`}`
`295`	`295`	`}`
`@@ -317,7 +317,7 @@ fn search_lifetimes(lifetimes: &OptVec<ast::Lifetime>,`
`317`	`317`	`lifetime_ref: &ast::Lifetime)`
`318`	`318`	`-> Option<(uint, ast::NodeId)> {`
`319`	`319`	`for (i, lifetime_decl) in lifetimes.iter().enumerate() {`
`320`		`- if lifetime_decl.ident == lifetime_ref.ident {`
	`320`	`+ if lifetime_decl.name == lifetime_ref.name {`
`321`	`321`	`return Some((i, lifetime_decl.id));`
`322`	`322`	`}`
`323`	`323`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,18 +92,18 @@ pub fn ast_region_to_region(tcx: ty::ctxt, lifetime: &ast::Lifetime)`
`92`	`92`
`93`	`93`	`Some(&ast::DefLateBoundRegion(binder_id, _, id)) => {`
`94`	`94`	`ty::ReLateBound(binder_id, ty::BrNamed(ast_util::local_def(id),`
`95`		`- lifetime.ident))`
	`95`	`+ lifetime.name))`
`96`	`96`	`}`
`97`	`97`
`98`	`98`	`Some(&ast::DefEarlyBoundRegion(index, id)) => {`
`99`		`- ty::ReEarlyBound(id, index, lifetime.ident)`
	`99`	`+ ty::ReEarlyBound(id, index, lifetime.name)`
`100`	`100`	`}`
`101`	`101`
`102`	`102`	`Some(&ast::DefFreeRegion(scope_id, id)) => {`
`103`	`103`	`ty::ReFree(ty::FreeRegion {`
`104`	`104`	`scope_id: scope_id,`
`105`	`105`	`bound_region: ty::BrNamed(ast_util::local_def(id),`
`106`		`- lifetime.ident)`
	`106`	`+ lifetime.name)`
`107`	`107`	`})`
`108`	`108`	`}`
`109`	`109`	`};`
Original file line number	Diff line number	Diff line change
`@@ -78,5 +78,5 @@ pub fn bound_type_regions(defs: &[ty::RegionParameterDef])`
`78`	`78`	`-> OptVec<ty::Region> {`
`79`	`79`	`assert!(defs.iter().all(\|def\| def.def_id.krate == ast::LOCAL_CRATE));`
`80`	`80`	`defs.iter().enumerate().map(`
`81`		`- \|(i, def)\| ty::ReEarlyBound(def.def_id.node, i, def.ident)).collect()`
	`81`	`+ \|(i, def)\| ty::ReEarlyBound(def.def_id.node, i, def.name)).collect()`
`82`	`82`	`}`