1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
/*
* Copyright 2018 The Starlark in Rust Authors.
* Copyright (c) Facebook, Inc. and its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use std::collections::HashMap;
use std::fmt::Write;
use std::fs;
use std::mem;
use std::path::Path;
use derivative::Derivative;
use dupe::Dupe;
use lalrpop_util as lu;
use crate::codemap::CodeMap;
use crate::codemap::FileSpan;
use crate::codemap::Pos;
use crate::codemap::Span;
use crate::codemap::Spanned;
use crate::eval_exception::EvalException;
use crate::lexer::Lexer;
use crate::lexer::Token;
use crate::syntax::ast::ArgumentP;
use crate::syntax::ast::AstExpr;
use crate::syntax::ast::AstStmt;
use crate::syntax::ast::ExprP;
use crate::syntax::ast::IdentP;
use crate::syntax::ast::LoadArgP;
use crate::syntax::ast::Stmt;
use crate::syntax::grammar::StarlarkParser;
use crate::syntax::state::ParserState;
use crate::syntax::AstLoad;
use crate::syntax::Dialect;
fn one_of(expected: &[String]) -> String {
let mut result = String::new();
for (i, e) in expected.iter().enumerate() {
let sep = match i {
0 => "one of",
_ if i < expected.len() - 1 => ",",
// Last expected message to be written
_ => " or",
};
write!(result, "{} {}", sep, e).unwrap();
}
result
}
/// Convert the error to a codemap diagnostic.
///
/// To build this diagnostic, the method needs the file span corresponding
/// to the parsed file.
fn parse_error_add_span(
err: lu::ParseError<usize, Token, EvalException>,
pos: usize,
codemap: &CodeMap,
) -> crate::Error {
let (message, span) = match err {
lu::ParseError::InvalidToken { location } => (
"Parse error: invalid token".to_owned(),
Span::new(Pos::new(location as u32), Pos::new(location as u32)),
),
lu::ParseError::UnrecognizedToken {
token: (x, t, y),
expected,
} => (
format!(
"Parse error: unexpected {} here, expected {}",
t,
one_of(&expected)
),
Span::new(Pos::new(x as u32), Pos::new(y as u32)),
),
lu::ParseError::UnrecognizedEOF { .. } => (
"Parse error: unexpected end of file".to_owned(),
Span::new(Pos::new(pos as u32), Pos::new(pos as u32)),
),
lu::ParseError::ExtraToken { token: (x, t, y) } => (
format!("Parse error: extraneous token {}", t),
Span::new(Pos::new(x as u32), Pos::new(y as u32)),
),
lu::ParseError::User { error } => return error.into_error(),
};
crate::Error::new_spanned(
crate::ErrorKind::Other(anyhow::anyhow!(message)),
span,
codemap,
)
}
/// A representation of a Starlark module abstract syntax tree.
///
/// Created with either [`parse`](AstModule::parse) or [`parse_file`](AstModule::parse_file),
/// and evaluated with `Evaluator::eval_module`.
///
/// The internal details (statements/expressions) are deliberately omitted, as they change
/// more regularly. A few methods to obtain information about the AST are provided.
#[derive(Derivative)]
#[derivative(Debug)]
pub struct AstModule {
#[derivative(Debug = "ignore")]
pub(crate) codemap: CodeMap,
pub(crate) statement: AstStmt,
pub(crate) dialect: Dialect,
/// Opt-in typecheck.
/// Specified with `@starlark-rust: typecheck`.
pub(crate) typecheck: bool,
}
/// This trait is not exported as public API of starlark.
pub trait AstModuleFields: Sized {
fn codemap(&self) -> &CodeMap;
fn statement(&self) -> &AstStmt;
fn dialect(&self) -> &Dialect;
fn into_parts(self) -> (CodeMap, AstStmt, Dialect, bool);
}
impl AstModuleFields for AstModule {
fn codemap(&self) -> &CodeMap {
&self.codemap
}
fn statement(&self) -> &AstStmt {
&self.statement
}
fn dialect(&self) -> &Dialect {
&self.dialect
}
fn into_parts(self) -> (CodeMap, AstStmt, Dialect, bool) {
(self.codemap, self.statement, self.dialect, self.typecheck)
}
}
impl AstModule {
fn create(
codemap: CodeMap,
statement: AstStmt,
dialect: &Dialect,
typecheck: bool,
) -> crate::Result<AstModule> {
Stmt::validate(&codemap, &statement, dialect).map_err(EvalException::into_error)?;
Ok(AstModule {
codemap,
statement,
dialect: dialect.clone(),
typecheck,
})
}
/// Parse a file stored on disk. For details see [`parse`](AstModule::parse).
pub fn parse_file(path: &Path, dialect: &Dialect) -> crate::Result<Self> {
let content = fs::read_to_string(path).map_err(anyhow::Error::new)?;
Self::parse(&path.to_string_lossy(), content, dialect)
}
/// Parse a Starlark module to produce an [`AstModule`], or an error if there are syntax errors.
/// The `filename` is for error messages only, and does not have to be a valid file.
/// The [`Dialect`] selects which Starlark constructs are valid.
///
/// The returned error may contain diagnostic information. For example:
///
/// ```
/// use starlark_syntax::codemap::FileSpan;
/// use starlark_syntax::syntax::AstModule;
/// use starlark_syntax::syntax::Dialect;
///
/// let err: starlark_syntax::Error =
/// AstModule::parse("filename", "\n(unmatched".to_owned(), &Dialect::Standard).unwrap_err();
/// let span: &FileSpan = err.span().unwrap();
/// assert_eq!(span.to_string(), "filename:2:11");
/// ```
pub fn parse(filename: &str, content: String, dialect: &Dialect) -> crate::Result<Self> {
let typecheck = content.contains("@starlark-rust: typecheck");
let codemap = CodeMap::new(filename.to_owned(), content);
let lexer = Lexer::new(codemap.source(), dialect, codemap.dupe());
let mut errors = Vec::new();
match StarlarkParser::new().parse(
&mut ParserState {
codemap: &codemap,
dialect,
errors: &mut errors,
},
lexer.filter(|t| !matches!(t, Ok((_, Token::Comment(_), _)))),
) {
Ok(v) => {
if let Some(err) = errors.into_iter().next() {
return Err(err.into_error());
}
Ok(AstModule::create(codemap, v, dialect, typecheck)?)
}
Err(p) => Err(parse_error_add_span(p, codemap.source().len(), &codemap)),
}
}
/// Return the file names of all the `load` statements in the module.
/// If the [`Dialect`] had [`enable_load`](Dialect::enable_load) set to [`false`] this will be an empty list.
pub fn loads(&self) -> Vec<AstLoad> {
// We know that `load` statements must be at the top-level, so no need to descend inside `if`, `for`, `def` etc.
// There is a suggestion that `load` statements should be at the top of a file, but we tolerate that not being true.
fn f<'a>(ast: &'a AstStmt, codemap: &CodeMap, vec: &mut Vec<AstLoad<'a>>) {
match &ast.node {
Stmt::Load(load) => vec.push(AstLoad {
span: FileSpan {
file: codemap.dupe(),
span: load.module.span,
},
module_id: &load.module.node,
symbols: load
.args
.iter()
.map(|LoadArgP { local, their, .. }| {
(local.node.ident.as_str(), their.node.as_str())
})
.collect(),
}),
Stmt::Statements(stmts) => {
for s in stmts {
f(s, codemap, vec);
}
}
_ => {}
}
}
let mut loads = Vec::new();
f(&self.statement, &self.codemap, &mut loads);
loads
}
/// Look up a [`Span`] contained in this module to a [`FileSpan`].
pub fn file_span(&self, x: Span) -> FileSpan {
self.codemap.file_span(x)
}
/// Locations where statements occur.
pub fn stmt_locations(&self) -> Vec<FileSpan> {
fn go(x: &AstStmt, codemap: &CodeMap, res: &mut Vec<FileSpan>) {
match &**x {
Stmt::Statements(_) => {} // These are not interesting statements that come up
_ => res.push(FileSpan {
span: x.span,
file: codemap.dupe(),
}),
}
x.visit_stmt(|x| go(x, codemap, res))
}
let mut res = Vec::new();
go(&self.statement, &self.codemap, &mut res);
res
}
/// Function to help people who want to write deeper AST transformations in Starlark.
/// Likely to break type checking and LSP support to some extent.
///
/// Replacement must be a map from operator name (e.g. `+` or `==`) to a function name
/// (e.g. `my_plus` or `my_equals`).
pub fn replace_binary_operators(&mut self, replace: &HashMap<String, String>) {
fn f(x: &mut AstExpr, replace: &HashMap<String, String>) {
let mut temp = ExprP::Tuple(vec![]);
mem::swap(&mut x.node, &mut temp);
let mut res = match temp {
ExprP::Op(lhs, op, rhs) => match replace.get(op.to_string().trim()) {
Some(func) => ExprP::Call(
Box::new(Spanned {
span: x.span,
node: ExprP::Identifier(Spanned {
span: x.span,
node: IdentP {
ident: func.clone(),
payload: (),
},
}),
}),
vec![
Spanned {
span: lhs.span,
node: ArgumentP::Positional(*lhs),
},
Spanned {
span: rhs.span,
node: ArgumentP::Positional(*rhs),
},
],
),
None => ExprP::Op(lhs, op, rhs),
},
_ => temp,
};
mem::swap(&mut x.node, &mut res);
x.visit_expr_mut(|x| f(x, replace));
}
self.statement.visit_expr_mut(|x| f(x, replace));
}
}
#[cfg(test)]
mod tests {
use crate::slice_vec_ext::SliceExt;
use crate::syntax::grammar_tests;
#[test]
fn test_locations() {
fn get(code: &str) -> String {
grammar_tests::parse_ast(code)
.stmt_locations()
.map(|x| x.resolve_span().to_string())
.join(" ")
}
assert_eq!(&get("foo"), "1:1-4");
assert_eq!(&get("foo\ndef x():\n pass"), "1:1-4 2:1-3:8 3:4-8");
}
}