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
use crate::source::CustomDecoder;
use crate::token_rewriter::TokenRewriter;
/// Configuration of the parser
pub struct ParserOptions {
/// Name of the buffer. Used in all diagnostic messages
pub buffer_name: String,
/// Controls whether the parser should run in debug mode
///
/// Debug mode forces parser/lexer to print additional information
/// while running (like bison actions)
pub debug: bool,
/// Custom decoder that can be used if the source is encoded
/// in unknown encoding. Only UTF-8 and ASCII-8BIT/BINARY are
/// supported out of the box.
///
/// # Example
/// ```rust
/// use lib_ruby_parser::source::{InputError, CustomDecoder, RustFnBasedCustomDecoder};
/// use lib_ruby_parser::{Parser, ParserOptions, ParserResult};
///
/// fn decode(encoding: &str, input: &[u8]) -> Result<Vec<u8>, InputError> {
/// if "US-ASCII" == encoding.to_uppercase() {
/// // reencode and return Ok(result)
/// return Ok(b"# encoding: us-ascii\ndecoded".to_vec());
/// }
/// Err(InputError::DecodingError(
/// "only us-ascii is supported".to_owned(),
/// ))
/// }
///
/// // Or
/// let decode_closure = |encoding: &str, input: &[u8]| -> Result<Vec<u8>, InputError> {
/// if "US-ASCII" == encoding.to_uppercase() {
/// // reencode and return Ok(result)
/// return Ok(b"# encoding: us-ascii\ndecoded".to_vec());
/// }
/// Err(InputError::DecodingError(
/// "only us-ascii is supported".to_owned(),
/// ))
/// };
///
/// let decoder = RustFnBasedCustomDecoder::new(Box::new(decode_closure));
/// let options = ParserOptions { decoder: Some(Box::new(decoder)), debug: true, ..Default::default() };
/// let mut parser = Parser::new(b"# encoding: us-ascii\n3 + 3", options);
/// let ParserResult { ast, input, .. } = parser.do_parse();
///
/// assert_eq!(ast.unwrap().expression().source(&input).unwrap(), "decoded".to_owned())
/// ```
pub decoder: Option<Box<dyn CustomDecoder>>,
/// Optional token rewriter, see TokenRewriter API
pub token_rewriter: Option<Box<dyn TokenRewriter>>,
/// When set to true Parser records tokens.
/// When set to false `ParserResult.tokens` is guaranteed to be empty
/// If you don't need tokens better set it to false to speed up parsing.
pub record_tokens: bool,
}
const DEFAULT_BUFFER_NAME: &str = "(eval)";
impl Default for ParserOptions {
fn default() -> Self {
Self {
buffer_name: DEFAULT_BUFFER_NAME.to_owned(),
debug: false,
decoder: None,
token_rewriter: None,
record_tokens: true,
}
}
}