src/libsyntax/parse/obsolete.rs

   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.
   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 /*!
  12 Support for parsing unsupported, old syntaxes, for the
  13 purpose of reporting errors. Parsing of these syntaxes
  14 is tested by compile-test/obsolete-syntax.rs.
  15
  16 Obsolete syntax that becomes too hard to parse can be
  17 removed.
  18 */
  19
  20 use ast::{Expr, ExprLit, LitNil};
  21 use codemap::{Span, respan};
  22 use parse::parser::Parser;
  23 use parse::token;
  24
  25 use std::to_bytes;
  26
  27 /// The specific types of unsupported syntax
  28 #[deriving(Eq)]
  29 pub enum ObsoleteSyntax {
  30     ObsoleteSwap,
  31     ObsoleteUnsafeBlock,
  32     ObsoleteBareFnType,
  33     ObsoleteMultipleLocalDecl,
  34     ObsoleteUnsafeExternFn,
  35     ObsoleteTraitFuncVisibility,
  36     ObsoleteConstPointer,
  37     ObsoleteLoopAsContinue,
  38     ObsoleteEnumWildcard,
  39     ObsoleteStructWildcard,
  40     ObsoleteVecDotDotWildcard,
  41     ObsoleteBoxedClosure,
  42     ObsoleteClosureType,
  43     ObsoleteMultipleImport,
  44     ObsoleteManagedPattern,
  45     ObsoleteManagedString,
  46     ObsoleteManagedVec,
  47 }
  48
  49 impl to_bytes::IterBytes for ObsoleteSyntax {
  50     #[inline]
  51     fn iter_bytes(&self, lsb0: bool, f: to_bytes::Cb) -> bool {
  52         (*self as uint).iter_bytes(lsb0, f)
  53     }
  54 }
  55
  56 pub trait ParserObsoleteMethods {
  57     /// Reports an obsolete syntax non-fatal error.
  58     fn obsolete(&mut self, sp: Span, kind: ObsoleteSyntax);
  59     // Reports an obsolete syntax non-fatal error, and returns
  60     // a placeholder expression
  61     fn obsolete_expr(&mut self, sp: Span, kind: ObsoleteSyntax) -> @Expr;
  62     fn report(&mut self,
  63               sp: Span,
  64               kind: ObsoleteSyntax,
  65               kind_str: &str,
  66               desc: &str);
  67     fn is_obsolete_ident(&mut self, ident: &str) -> bool;
  68     fn eat_obsolete_ident(&mut self, ident: &str) -> bool;
  69 }
  70
  71 impl ParserObsoleteMethods for Parser {
  72     /// Reports an obsolete syntax non-fatal error.
  73     fn obsolete(&mut self, sp: Span, kind: ObsoleteSyntax) {
  74         let (kind_str, desc) = match kind {
  75             ObsoleteSwap => (
  76                 "swap",
  77                 "use std::mem::{swap, replace} instead"
  78             ),
  79             ObsoleteUnsafeBlock => (
  80                 "non-standalone unsafe block",
  81                 "use an inner `unsafe { ... }` block instead"
  82             ),
  83             ObsoleteBareFnType => (
  84                 "bare function type",
  85                 "use `|A| -> B` or `extern fn(A) -> B` instead"
  86             ),
  87             ObsoleteMultipleLocalDecl => (
  88                 "declaration of multiple locals at once",
  89                 "instead of e.g. `let a = 1, b = 2`, write \
  90                  `let (a, b) = (1, 2)`."
  91             ),
  92             ObsoleteUnsafeExternFn => (
  93                 "unsafe external function",
  94                 "external functions are always unsafe; remove the `unsafe` \
  95                  keyword"
  96             ),
  97             ObsoleteTraitFuncVisibility => (
  98                 "visibility not necessary",
  99                 "trait functions inherit the visibility of the trait itself"
 100             ),
 101             ObsoleteConstPointer => (
 102                 "const pointer",
 103                 "instead of `&const Foo` or `@const Foo`, write `&Foo` or \
 104                  `@Foo`"
 105             ),
 106             ObsoleteLoopAsContinue => (
 107                 "`loop` instead of `continue`",
 108                 "`loop` is now only used for loops and `continue` is used for \
 109                  skipping iterations"
 110             ),
 111             ObsoleteEnumWildcard => (
 112                 "enum wildcard",
 113                 "use `..` instead of `*` for matching all enum fields"
 114             ),
 115             ObsoleteStructWildcard => (
 116                 "struct wildcard",
 117                 "use `..` instead of `_` for matching trailing struct fields"
 118             ),
 119             ObsoleteVecDotDotWildcard => (
 120                 "vec slice wildcard",
 121                 "use `..` instead of `.._` for matching slices"
 122             ),
 123             ObsoleteBoxedClosure => (
 124                 "managed or owned closure",
 125                 "managed closures have been removed and owned closures are \
 126                  now written `proc()`"
 127             ),
 128             ObsoleteClosureType => (
 129                 "closure type",
 130                 "closures are now written `|A| -> B` rather than `&fn(A) -> \
 131                  B`."
 132             ),
 133             ObsoleteMultipleImport => (
 134                 "multiple imports",
 135                 "only one import is allowed per `use` statement"
 136             ),
 137             ObsoleteManagedPattern => (
 138                 "managed pointer pattern",
 139                 "use a nested `match` expression instead of a managed box \
 140                  pattern"
 141             ),
 142             ObsoleteManagedString => (
 143                 "managed string",
 144                 "use `Rc<~str>` instead of a managed string"
 145             ),
 146             ObsoleteManagedVec => (
 147                 "managed vector",
 148                 "use `Rc<~[T]>` instead of a managed vector"
 149             ),
 150         };
 151
 152         self.report(sp, kind, kind_str, desc);
 153     }
 154
 155     // Reports an obsolete syntax non-fatal error, and returns
 156     // a placeholder expression
 157     fn obsolete_expr(&mut self, sp: Span, kind: ObsoleteSyntax) -> @Expr {
 158         self.obsolete(sp, kind);
 159         self.mk_expr(sp.lo, sp.hi, ExprLit(@respan(sp, LitNil)))
 160     }
 161
 162     fn report(&mut self,
 163               sp: Span,
 164               kind: ObsoleteSyntax,
 165               kind_str: &str,
 166               desc: &str) {
 167         self.span_err(sp, format!("obsolete syntax: {}", kind_str));
 168
 169         if !self.obsolete_set.contains(&kind) {
 170             self.sess.span_diagnostic.handler().note(format!("{}", desc));
 171             self.obsolete_set.insert(kind);
 172         }
 173     }
 174
 175     fn is_obsolete_ident(&mut self, ident: &str) -> bool {
 176         match self.token {
 177             token::IDENT(sid, _) => {
 178                 token::get_ident(sid).equiv(&ident)
 179             }
 180             _ => false
 181         }
 182     }
 183
 184     fn eat_obsolete_ident(&mut self, ident: &str) -> bool {
 185         if self.is_obsolete_ident(ident) {
 186             self.bump();
 187             true
 188         } else {
 189             false
 190         }
 191     }
 192 }