risingwave_sqlparser/parser_v2/
mod.rs

1// Licensed under the Apache License, Version 2.0 (the "License");
2// you may not use this file except in compliance with the License.
3// You may obtain a copy of the License at
4//
5//     http://www.apache.org/licenses/LICENSE-2.0
6//
7// Unless required by applicable law or agreed to in writing, software
8// distributed under the License is distributed on an "AS IS" BASIS,
9// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10// See the License for the specific language governing permissions and
11// limitations under the License.
12
13use winnow::combinator::impls::Context;
14use winnow::combinator::{separated, trace};
15use winnow::error::{AddContext, ContextError, ErrMode, ParserError, StrContext};
16use winnow::stream::{Stream, StreamIsPartial};
17use winnow::token::any;
18use winnow::{ModalResult, Parser, Stateful};
19
20use crate::ast::{Ident, ObjectName};
21use crate::keywords::{self, Keyword};
22use crate::tokenizer::{Token, TokenWithLocation};
23
24mod compact;
25mod data_type;
26mod expr;
27mod impl_;
28mod number;
29
30pub(crate) use data_type::*;
31pub(crate) use expr::*;
32pub(crate) use number::*;
33
34/// Bundle trait requirements from winnow, so that we don't need to write them everywhere.
35///
36/// All combinators should accept a generic `S` that implements `TokenStream`.
37pub trait TokenStream:
38    Stream<Token = TokenWithLocation> + StreamIsPartial + Default + compact::ParseV1
39{
40}
41
42impl<S> TokenStream for S where
43    S: Stream<Token = TokenWithLocation> + StreamIsPartial + Default + compact::ParseV1
44{
45}
46
47/// Consume any token.
48///
49/// If you need to consume a specific token, use [`Token::?`][Token] directly, which already implements [`Parser`].
50fn token<S>(input: &mut S) -> ModalResult<TokenWithLocation>
51where
52    S: TokenStream,
53{
54    any(input)
55}
56
57/// Consume a keyword.
58///
59/// If you need to consume a specific keyword, use [`Keyword::?`][Keyword] directly, which already implements [`Parser`].
60pub fn keyword<S>(input: &mut S) -> ModalResult<Keyword>
61where
62    S: TokenStream,
63{
64    trace(
65        "keyword",
66        token.verify_map(|t| match &t.token {
67            Token::Word(w) if w.keyword != Keyword::NoKeyword => Some(w.keyword),
68            _ => None,
69        }),
70    )
71    .context(StrContext::Label("keyword"))
72    .parse_next(input)
73}
74
75impl<I> Parser<I, TokenWithLocation, ErrMode<ContextError>> for Token
76where
77    I: TokenStream,
78{
79    fn parse_next(&mut self, input: &mut I) -> ModalResult<TokenWithLocation, ContextError> {
80        trace(
81            format_args!("token {}", self.clone()),
82            token.verify(move |t: &TokenWithLocation| t.token == *self),
83        )
84        .parse_next(input)
85    }
86}
87
88impl<I> Parser<I, Keyword, ErrMode<ContextError>> for Keyword
89where
90    I: TokenStream,
91{
92    fn parse_next(&mut self, input: &mut I) -> ModalResult<Keyword, ContextError> {
93        trace(
94            format_args!("keyword {}", self.clone()),
95            token.verify_map(move |t| match &t.token {
96                Token::Word(w) if *self == w.keyword => Some(w.keyword),
97                _ => None,
98            }),
99        )
100        .parse_next(input)
101    }
102}
103
104/// Consume an identifier that is not a reserved keyword.
105fn identifier_non_reserved<S>(input: &mut S) -> ModalResult<Ident>
106where
107    S: TokenStream,
108{
109    // FIXME: Reporting error correctly.
110    token
111        .verify_map(|t| match &t.token {
112            Token::Word(w) if !keywords::RESERVED_FOR_COLUMN_OR_TABLE_NAME.contains(&w.keyword) => {
113                w.to_ident().ok()
114            }
115            _ => None,
116        })
117        .parse_next(input)
118}
119
120/// Consume an 'single-quoted string'.
121pub fn single_quoted_string<S>(input: &mut S) -> ModalResult<String>
122where
123    S: TokenStream,
124{
125    token
126        .verify_map(|t| match &t.token {
127            Token::SingleQuotedString(s) => Some(s.clone()),
128            _ => None,
129        })
130        .parse_next(input)
131}
132
133/// Consume an $$ dollar-quoted string $$.
134pub fn dollar_quoted_string<S>(input: &mut S) -> ModalResult<String>
135where
136    S: TokenStream,
137{
138    token
139        .verify_map(|t| match &t.token {
140            Token::DollarQuotedString(s) => Some(s.value.clone()),
141            _ => None,
142        })
143        .parse_next(input)
144}
145
146/// Consume an object name.
147///
148/// FIXME: Object name is extremely complex, we only handle a subset here.
149fn object_name<S>(input: &mut S) -> ModalResult<ObjectName>
150where
151    S: TokenStream,
152{
153    separated(1.., identifier_non_reserved, Token::Period)
154        .map(ObjectName)
155        .parse_next(input)
156}
157
158/// Accept a subparser contains a given state.
159///
160/// The state will be constructed using [`Default::default()`].
161fn with_state<S, State, O, ParseNext, E>(mut parse_next: ParseNext) -> impl Parser<S, O, E>
162where
163    S: TokenStream,
164    State: Default,
165    ParseNext: Parser<Stateful<S, State>, O, E>,
166    E: ParserError<S>,
167{
168    move |input: &mut S| -> winnow::Result<O, E> {
169        let state = State::default();
170        let input2 = std::mem::take(input);
171        let mut stateful = Stateful {
172            input: input2,
173            state,
174        };
175        let output = parse_next.parse_next(&mut stateful);
176        *input = stateful.input;
177        output
178    }
179}
180
181pub trait ParserExt<I, O, E>: Parser<I, O, E> {
182    /// Add a context to the error message.
183    ///
184    /// This is a shorthand for `context(StrContext::Expected(StrContextValue::Description(expected)))`.
185    fn expect(self, expected: &'static str) -> Context<Self, I, O, E, StrContext>
186    where
187        Self: Sized,
188        I: Stream,
189        E: AddContext<I, StrContext>,
190        E: ParserError<I>,
191    {
192        self.context(StrContext::Expected(
193            winnow::error::StrContextValue::Description(expected),
194        ))
195    }
196}
197
198impl<I, O, E, T> ParserExt<I, O, E> for T where T: Parser<I, O, E> {}
risingwave_sqlparser/parser_v2/mod.rs

risingwave_sqlparser/parser_v2/
mod.rs
