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