src/librustc_builtin_macros/source_util.rs

   1 use rustc_ast::ast;
   2 use rustc_ast::ptr::P;
   3 use rustc_ast::token;
   4 use rustc_ast::tokenstream::TokenStream;
   5 use rustc_ast_pretty::pprust;
   6 use rustc_expand::base::{self, *};
   7 use rustc_expand::module::DirectoryOwnership;
   8 use rustc_parse::{self, new_parser_from_file, parser::Parser};
   9 use rustc_session::lint::builtin::INCOMPLETE_INCLUDE;
  10 use rustc_span::symbol::Symbol;
  11 use rustc_span::{self, Pos, Span};
  12
  13 use smallvec::SmallVec;
  14 use std::rc::Rc;
  15
  16 use rustc_data_structures::sync::Lrc;
  17
  18 // These macros all relate to the file system; they either return
  19 // the column/row/filename of the expression, or they include
  20 // a given file into the current one.
  21
  22 /// line!(): expands to the current line number
  23 pub fn expand_line(
  24     cx: &mut ExtCtxt<'_>,
  25     sp: Span,
  26     tts: TokenStream,
  27 ) -> Box<dyn base::MacResult + 'static> {
  28     let sp = cx.with_def_site_ctxt(sp);
  29     base::check_zero_tts(cx, sp, tts, "line!");
  30
  31     let topmost = cx.expansion_cause().unwrap_or(sp);
  32     let loc = cx.source_map().lookup_char_pos(topmost.lo());
  33
  34     base::MacEager::expr(cx.expr_u32(topmost, loc.line as u32))
  35 }
  36
  37 /* column!(): expands to the current column number */
  38 pub fn expand_column(
  39     cx: &mut ExtCtxt<'_>,
  40     sp: Span,
  41     tts: TokenStream,
  42 ) -> Box<dyn base::MacResult + 'static> {
  43     let sp = cx.with_def_site_ctxt(sp);
  44     base::check_zero_tts(cx, sp, tts, "column!");
  45
  46     let topmost = cx.expansion_cause().unwrap_or(sp);
  47     let loc = cx.source_map().lookup_char_pos(topmost.lo());
  48
  49     base::MacEager::expr(cx.expr_u32(topmost, loc.col.to_usize() as u32 + 1))
  50 }
  51
  52 /// file!(): expands to the current filename */
  53 /// The source_file (`loc.file`) contains a bunch more information we could spit
  54 /// out if we wanted.
  55 pub fn expand_file(
  56     cx: &mut ExtCtxt<'_>,
  57     sp: Span,
  58     tts: TokenStream,
  59 ) -> Box<dyn base::MacResult + 'static> {
  60     let sp = cx.with_def_site_ctxt(sp);
  61     base::check_zero_tts(cx, sp, tts, "file!");
  62
  63     let topmost = cx.expansion_cause().unwrap_or(sp);
  64     let loc = cx.source_map().lookup_char_pos(topmost.lo());
  65     base::MacEager::expr(cx.expr_str(topmost, Symbol::intern(&loc.file.name.to_string())))
  66 }
  67
  68 pub fn expand_stringify(
  69     cx: &mut ExtCtxt<'_>,
  70     sp: Span,
  71     tts: TokenStream,
  72 ) -> Box<dyn base::MacResult + 'static> {
  73     let sp = cx.with_def_site_ctxt(sp);
  74     let s = pprust::tts_to_string(tts);
  75     base::MacEager::expr(cx.expr_str(sp, Symbol::intern(&s)))
  76 }
  77
  78 pub fn expand_mod(
  79     cx: &mut ExtCtxt<'_>,
  80     sp: Span,
  81     tts: TokenStream,
  82 ) -> Box<dyn base::MacResult + 'static> {
  83     let sp = cx.with_def_site_ctxt(sp);
  84     base::check_zero_tts(cx, sp, tts, "module_path!");
  85     let mod_path = &cx.current_expansion.module.mod_path;
  86     let string = mod_path.iter().map(|x| x.to_string()).collect::<Vec<String>>().join("::");
  87
  88     base::MacEager::expr(cx.expr_str(sp, Symbol::intern(&string)))
  89 }
  90
  91 /// include! : parse the given file as an expr
  92 /// This is generally a bad idea because it's going to behave
  93 /// unhygienically.
  94 pub fn expand_include<'cx>(
  95     cx: &'cx mut ExtCtxt<'_>,
  96     sp: Span,
  97     tts: TokenStream,
  98 ) -> Box<dyn base::MacResult + 'cx> {
  99     let sp = cx.with_def_site_ctxt(sp);
 100     let file = match get_single_str_from_tts(cx, sp, tts, "include!") {
 101         Some(f) => f,
 102         None => return DummyResult::any(sp),
 103     };
 104     // The file will be added to the code map by the parser
 105     let mut file = match cx.resolve_path(file, sp) {
 106         Ok(f) => f,
 107         Err(mut err) => {
 108             err.emit();
 109             return DummyResult::any(sp);
 110         }
 111     };
 112     let p = new_parser_from_file(cx.parse_sess(), &file, Some(sp));
 113
 114     // If in the included file we have e.g., `mod bar;`,
 115     // then the path of `bar.rs` should be relative to the directory of `file`.
 116     // See https://github.com/rust-lang/rust/pull/69838/files#r395217057 for a discussion.
 117     // `MacroExpander::fully_expand_fragment` later restores, so "stack discipline" is maintained.
 118     file.pop();
 119     cx.current_expansion.directory_ownership = DirectoryOwnership::Owned { relative: None };
 120     let mod_path = cx.current_expansion.module.mod_path.clone();
 121     cx.current_expansion.module = Rc::new(ModuleData { mod_path, directory: file });
 122
 123     struct ExpandResult<'a> {
 124         p: Parser<'a>,
 125     }
 126     impl<'a> base::MacResult for ExpandResult<'a> {
 127         fn make_expr(mut self: Box<ExpandResult<'a>>) -> Option<P<ast::Expr>> {
 128             let r = base::parse_expr(&mut self.p)?;
 129             if self.p.token != token::Eof {
 130                 self.p.sess.buffer_lint(
 131                     &INCOMPLETE_INCLUDE,
 132                     self.p.token.span,
 133                     ast::CRATE_NODE_ID,
 134                     "include macro expected single expression in source",
 135                 );
 136             }
 137             Some(r)
 138         }
 139
 140         fn make_items(mut self: Box<ExpandResult<'a>>) -> Option<SmallVec<[P<ast::Item>; 1]>> {
 141             let mut ret = SmallVec::new();
 142             while self.p.token != token::Eof {
 143                 match self.p.parse_item() {
 144                     Err(mut err) => {
 145                         err.emit();
 146                         break;
 147                     }
 148                     Ok(Some(item)) => ret.push(item),
 149                     Ok(None) => {
 150                         let token = pprust::token_to_string(&self.p.token);
 151                         let msg = format!("expected item, found `{}`", token);
 152                         self.p.struct_span_err(self.p.token.span, &msg).emit();
 153                         break;
 154                     }
 155                 }
 156             }
 157             Some(ret)
 158         }
 159     }
 160
 161     Box::new(ExpandResult { p })
 162 }
 163
 164 // include_str! : read the given file, insert it as a literal string expr
 165 pub fn expand_include_str(
 166     cx: &mut ExtCtxt<'_>,
 167     sp: Span,
 168     tts: TokenStream,
 169 ) -> Box<dyn base::MacResult + 'static> {
 170     let sp = cx.with_def_site_ctxt(sp);
 171     let file = match get_single_str_from_tts(cx, sp, tts, "include_str!") {
 172         Some(f) => f,
 173         None => return DummyResult::any(sp),
 174     };
 175     let file = match cx.resolve_path(file, sp) {
 176         Ok(f) => f,
 177         Err(mut err) => {
 178             err.emit();
 179             return DummyResult::any(sp);
 180         }
 181     };
 182     match cx.source_map().load_binary_file(&file) {
 183         Ok(bytes) => match std::str::from_utf8(&bytes) {
 184             Ok(src) => {
 185                 let interned_src = Symbol::intern(&src);
 186                 base::MacEager::expr(cx.expr_str(sp, interned_src))
 187             }
 188             Err(_) => {
 189                 cx.span_err(sp, &format!("{} wasn't a utf-8 file", file.display()));
 190                 DummyResult::any(sp)
 191             }
 192         },
 193         Err(e) => {
 194             cx.span_err(sp, &format!("couldn't read {}: {}", file.display(), e));
 195             DummyResult::any(sp)
 196         }
 197     }
 198 }
 199
 200 pub fn expand_include_bytes(
 201     cx: &mut ExtCtxt<'_>,
 202     sp: Span,
 203     tts: TokenStream,
 204 ) -> Box<dyn base::MacResult + 'static> {
 205     let sp = cx.with_def_site_ctxt(sp);
 206     let file = match get_single_str_from_tts(cx, sp, tts, "include_bytes!") {
 207         Some(f) => f,
 208         None => return DummyResult::any(sp),
 209     };
 210     let file = match cx.resolve_path(file, sp) {
 211         Ok(f) => f,
 212         Err(mut err) => {
 213             err.emit();
 214             return DummyResult::any(sp);
 215         }
 216     };
 217     match cx.source_map().load_binary_file(&file) {
 218         Ok(bytes) => base::MacEager::expr(cx.expr_lit(sp, ast::LitKind::ByteStr(Lrc::new(bytes)))),
 219         Err(e) => {
 220             cx.span_err(sp, &format!("couldn't read {}: {}", file.display(), e));
 221             DummyResult::any(sp)
 222         }
 223     }
 224 }