squawk_syntax/ast/
node_ext.rs

1// via https://github.com/rust-lang/rust-analyzer/blob/d8887c0758bbd2d5f752d5bd405d4491e90e7ed6/crates/syntax/src/ast/node_ext.rs
2//
3// Permission is hereby granted, free of charge, to any
4// person obtaining a copy of this software and associated
5// documentation files (the "Software"), to deal in the
6// Software without restriction, including without
7// limitation the rights to use, copy, modify, merge,
8// publish, distribute, sublicense, and/or sell copies of
9// the Software, and to permit persons to whom the Software
10// is furnished to do so, subject to the following
11// conditions:
12//
13// The above copyright notice and this permission notice
14// shall be included in all copies or substantial portions
15// of the Software.
16//
17// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
18// ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
19// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
20// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
21// SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
24// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25// DEALINGS IN THE SOFTWARE.
26
27use std::borrow::Cow;
28
29#[cfg(test)]
30use insta::assert_snapshot;
31use rowan::{GreenNodeData, GreenTokenData, NodeOrToken};
32
33#[cfg(test)]
34use crate::SourceFile;
35use rowan::Direction;
36
37use crate::ast;
38use crate::ast::AstNode;
39use crate::unescape::{escape_unicode_esc_str, uescape_char};
40use crate::{SyntaxKind, SyntaxNode, SyntaxToken, TokenText};
41
42use super::support;
43
44#[derive(Debug, Clone, PartialEq, Eq)]
45pub enum LitKind {
46    BitString(SyntaxToken),
47    ByteString(SyntaxToken),
48    Default(SyntaxToken),
49    DollarQuotedString(SyntaxToken),
50    EscString(SyntaxToken),
51    False(SyntaxToken),
52    IntNumber(SyntaxToken),
53    Null(SyntaxToken),
54    NumericNumber(SyntaxToken),
55    PositionalParam(SyntaxToken),
56    String(SyntaxToken),
57    True(SyntaxToken),
58    UnicodeEscString(SyntaxToken),
59}
60
61impl ast::Literal {
62    pub fn kind(&self) -> Option<LitKind> {
63        let token = self.syntax().first_child_or_token()?.into_token()?;
64        let kind = match token.kind() {
65            SyntaxKind::BIT_STRING => LitKind::BitString(token),
66            SyntaxKind::BYTE_STRING => LitKind::ByteString(token),
67            SyntaxKind::DEFAULT_KW => LitKind::Default(token),
68            SyntaxKind::DOLLAR_QUOTED_STRING => LitKind::DollarQuotedString(token),
69            SyntaxKind::ESC_STRING => LitKind::EscString(token),
70            SyntaxKind::FALSE_KW => LitKind::False(token),
71            SyntaxKind::INT_NUMBER => LitKind::IntNumber(token),
72            SyntaxKind::NULL_KW => LitKind::Null(token),
73            SyntaxKind::NUMERIC_NUMBER => LitKind::NumericNumber(token),
74            SyntaxKind::POSITIONAL_PARAM => LitKind::PositionalParam(token),
75            SyntaxKind::STRING => LitKind::String(token),
76            SyntaxKind::TRUE_KW => LitKind::True(token),
77            SyntaxKind::UNICODE_ESC_STRING => LitKind::UnicodeEscString(token),
78            _ => return None,
79        };
80        Some(kind)
81    }
82}
83
84impl ast::Constraint {
85    #[inline]
86    pub fn constraint_name(&self) -> Option<ast::ConstraintName> {
87        support::child(self.syntax())
88    }
89}
90
91#[derive(Debug, Clone, PartialEq, Eq)]
92pub enum BinOp {
93    And(SyntaxToken),
94    AtTimeZone(ast::AtTimeZone),
95    Caret(SyntaxToken),
96    Collate(SyntaxToken),
97    ColonColon(ast::ColonColon),
98    ColonEq(SyntaxToken),
99    CustomOp(ast::CustomOp),
100    Eq(SyntaxToken),
101    FatArrow(SyntaxToken),
102    Gteq(SyntaxToken),
103    Ilike(SyntaxToken),
104    In(SyntaxToken),
105    Is(SyntaxToken),
106    IsDistinctFrom(ast::IsDistinctFrom),
107    IsNot(ast::IsNot),
108    IsNotDistinctFrom(ast::IsNotDistinctFrom),
109    LAngle(SyntaxToken),
110    Like(SyntaxToken),
111    Lteq(SyntaxToken),
112    Minus(SyntaxToken),
113    Neq(SyntaxToken),
114    Neqb(SyntaxToken),
115    NotIlike(ast::NotIlike),
116    NotIn(ast::NotIn),
117    NotLike(ast::NotLike),
118    NotSimilarTo(ast::NotSimilarTo),
119    OperatorCall(ast::OperatorCall),
120    Or(SyntaxToken),
121    Overlaps(SyntaxToken),
122    Percent(SyntaxToken),
123    Plus(SyntaxToken),
124    RAngle(SyntaxToken),
125    SimilarTo(ast::SimilarTo),
126    Slash(SyntaxToken),
127    Star(SyntaxToken),
128}
129
130#[derive(Debug, Clone, PartialEq, Eq)]
131pub enum PostfixOp {
132    AtLocal(SyntaxToken),
133    IsJson(ast::IsJson),
134    IsJsonArray(ast::IsJsonArray),
135    IsJsonObject(ast::IsJsonObject),
136    IsJsonScalar(ast::IsJsonScalar),
137    IsJsonValue(ast::IsJsonValue),
138    IsNormalized(ast::IsNormalized),
139    IsNotJson(ast::IsNotJson),
140    IsNotJsonArray(ast::IsNotJsonArray),
141    IsNotJsonObject(ast::IsNotJsonObject),
142    IsNotJsonScalar(ast::IsNotJsonScalar),
143    IsNotJsonValue(ast::IsNotJsonValue),
144    IsNotNormalized(ast::IsNotNormalized),
145    IsNull(SyntaxToken),
146    NotNull(SyntaxToken),
147}
148
149impl ast::BinExpr {
150    #[inline]
151    pub fn lhs(&self) -> Option<ast::Expr> {
152        support::children(self.syntax()).next()
153    }
154
155    #[inline]
156    pub fn rhs(&self) -> Option<ast::Expr> {
157        support::children(self.syntax()).nth(1)
158    }
159
160    pub fn op(&self) -> Option<BinOp> {
161        let lhs = self.lhs()?;
162        for child in lhs.syntax().siblings_with_tokens(Direction::Next).skip(1) {
163            match child {
164                NodeOrToken::Token(token) => {
165                    let op = match token.kind() {
166                        SyntaxKind::AND_KW => BinOp::And(token),
167                        SyntaxKind::CARET => BinOp::Caret(token),
168                        SyntaxKind::COLLATE_KW => BinOp::Collate(token),
169                        SyntaxKind::COLON_EQ => BinOp::ColonEq(token),
170                        SyntaxKind::EQ => BinOp::Eq(token),
171                        SyntaxKind::FAT_ARROW => BinOp::FatArrow(token),
172                        SyntaxKind::GTEQ => BinOp::Gteq(token),
173                        SyntaxKind::ILIKE_KW => BinOp::Ilike(token),
174                        SyntaxKind::IN_KW => BinOp::In(token),
175                        SyntaxKind::IS_KW => BinOp::Is(token),
176                        SyntaxKind::L_ANGLE => BinOp::LAngle(token),
177                        SyntaxKind::LIKE_KW => BinOp::Like(token),
178                        SyntaxKind::LTEQ => BinOp::Lteq(token),
179                        SyntaxKind::MINUS => BinOp::Minus(token),
180                        SyntaxKind::NEQ => BinOp::Neq(token),
181                        SyntaxKind::NEQB => BinOp::Neqb(token),
182                        SyntaxKind::OR_KW => BinOp::Or(token),
183                        SyntaxKind::OVERLAPS_KW => BinOp::Overlaps(token),
184                        SyntaxKind::PERCENT => BinOp::Percent(token),
185                        SyntaxKind::PLUS => BinOp::Plus(token),
186                        SyntaxKind::R_ANGLE => BinOp::RAngle(token),
187                        SyntaxKind::SLASH => BinOp::Slash(token),
188                        SyntaxKind::STAR => BinOp::Star(token),
189                        _ => continue,
190                    };
191                    return Some(op);
192                }
193                NodeOrToken::Node(node) => {
194                    let op = match node.kind() {
195                        SyntaxKind::AT_TIME_ZONE => {
196                            BinOp::AtTimeZone(ast::AtTimeZone { syntax: node })
197                        }
198                        SyntaxKind::COLON_COLON => {
199                            BinOp::ColonColon(ast::ColonColon { syntax: node })
200                        }
201                        SyntaxKind::CUSTOM_OP => BinOp::CustomOp(ast::CustomOp { syntax: node }),
202                        SyntaxKind::IS_DISTINCT_FROM => {
203                            BinOp::IsDistinctFrom(ast::IsDistinctFrom { syntax: node })
204                        }
205                        SyntaxKind::IS_NOT => BinOp::IsNot(ast::IsNot { syntax: node }),
206                        SyntaxKind::IS_NOT_DISTINCT_FROM => {
207                            BinOp::IsNotDistinctFrom(ast::IsNotDistinctFrom { syntax: node })
208                        }
209                        SyntaxKind::NOT_ILIKE => BinOp::NotIlike(ast::NotIlike { syntax: node }),
210                        SyntaxKind::NOT_IN => BinOp::NotIn(ast::NotIn { syntax: node }),
211                        SyntaxKind::NOT_LIKE => BinOp::NotLike(ast::NotLike { syntax: node }),
212                        SyntaxKind::NOT_SIMILAR_TO => {
213                            BinOp::NotSimilarTo(ast::NotSimilarTo { syntax: node })
214                        }
215                        SyntaxKind::OPERATOR_CALL => {
216                            BinOp::OperatorCall(ast::OperatorCall { syntax: node })
217                        }
218                        SyntaxKind::SIMILAR_TO => BinOp::SimilarTo(ast::SimilarTo { syntax: node }),
219                        _ => continue,
220                    };
221                    return Some(op);
222                }
223            }
224        }
225        None
226    }
227}
228
229impl ast::PostfixExpr {
230    pub fn op(&self) -> Option<PostfixOp> {
231        let lhs = self.expr()?;
232
233        let siblings = lhs.syntax().siblings_with_tokens(Direction::Next).skip(1);
234        for child in siblings {
235            match child {
236                NodeOrToken::Token(token) => {
237                    let op = match token.kind() {
238                        SyntaxKind::AT_KW => PostfixOp::AtLocal(token),
239                        SyntaxKind::ISNULL_KW => PostfixOp::IsNull(token),
240                        SyntaxKind::NOTNULL_KW => PostfixOp::NotNull(token),
241                        _ => continue,
242                    };
243                    return Some(op);
244                }
245                NodeOrToken::Node(node) => {
246                    let op = match node.kind() {
247                        SyntaxKind::IS_JSON => PostfixOp::IsJson(ast::IsJson { syntax: node }),
248                        SyntaxKind::IS_JSON_ARRAY => {
249                            PostfixOp::IsJsonArray(ast::IsJsonArray { syntax: node })
250                        }
251                        SyntaxKind::IS_JSON_OBJECT => {
252                            PostfixOp::IsJsonObject(ast::IsJsonObject { syntax: node })
253                        }
254                        SyntaxKind::IS_JSON_SCALAR => {
255                            PostfixOp::IsJsonScalar(ast::IsJsonScalar { syntax: node })
256                        }
257                        SyntaxKind::IS_JSON_VALUE => {
258                            PostfixOp::IsJsonValue(ast::IsJsonValue { syntax: node })
259                        }
260                        SyntaxKind::IS_NORMALIZED => {
261                            PostfixOp::IsNormalized(ast::IsNormalized { syntax: node })
262                        }
263                        SyntaxKind::IS_NOT_JSON => {
264                            PostfixOp::IsNotJson(ast::IsNotJson { syntax: node })
265                        }
266                        SyntaxKind::IS_NOT_JSON_ARRAY => {
267                            PostfixOp::IsNotJsonArray(ast::IsNotJsonArray { syntax: node })
268                        }
269                        SyntaxKind::IS_NOT_JSON_OBJECT => {
270                            PostfixOp::IsNotJsonObject(ast::IsNotJsonObject { syntax: node })
271                        }
272                        SyntaxKind::IS_NOT_JSON_SCALAR => {
273                            PostfixOp::IsNotJsonScalar(ast::IsNotJsonScalar { syntax: node })
274                        }
275                        SyntaxKind::IS_NOT_JSON_VALUE => {
276                            PostfixOp::IsNotJsonValue(ast::IsNotJsonValue { syntax: node })
277                        }
278                        SyntaxKind::IS_NOT_NORMALIZED => {
279                            PostfixOp::IsNotNormalized(ast::IsNotNormalized { syntax: node })
280                        }
281                        _ => continue,
282                    };
283                    return Some(op);
284                }
285            }
286        }
287
288        None
289    }
290}
291
292impl ast::FieldExpr {
293    // We have NameRef as a variant of Expr which complicates things (and it
294    // might not be worth it).
295    // Rust analyzer doesn't do this so it doesn't have to special case this.
296    #[inline]
297    pub fn base(&self) -> Option<ast::Expr> {
298        support::children(self.syntax()).next()
299    }
300    #[inline]
301    pub fn field(&self) -> Option<ast::NameRef> {
302        support::children(self.syntax()).last()
303    }
304}
305
306impl ast::IndexExpr {
307    #[inline]
308    pub fn base(&self) -> Option<ast::Expr> {
309        support::children(&self.syntax).next()
310    }
311    #[inline]
312    pub fn index(&self) -> Option<ast::Expr> {
313        support::children(&self.syntax).nth(1)
314    }
315}
316
317impl ast::SliceExpr {
318    #[inline]
319    pub fn base(&self) -> Option<ast::Expr> {
320        support::children(&self.syntax).next()
321    }
322
323    #[inline]
324    pub fn start(&self) -> Option<ast::Expr> {
325        // With `select x[1:]`, we have two exprs, `x` and `1`.
326        // We skip over the first one, and then we want the second one, but we
327        // want to make sure we don't choose the end expr if instead we had:
328        // `select x[:1]`
329        let colon = self.colon_token()?;
330        support::children(&self.syntax)
331            .skip(1)
332            .find(|expr: &ast::Expr| expr.syntax().text_range().end() <= colon.text_range().start())
333    }
334
335    #[inline]
336    pub fn end(&self) -> Option<ast::Expr> {
337        // We want to make sure we get the last expr after the `:` which is the
338        // end of the slice, i.e., `2` in: `select x[:2]`
339        let colon = self.colon_token()?;
340        support::children(&self.syntax)
341            .find(|expr: &ast::Expr| expr.syntax().text_range().start() >= colon.text_range().end())
342    }
343}
344
345impl ast::RenameColumn {
346    #[inline]
347    pub fn from(&self) -> Option<ast::NameRef> {
348        support::children(&self.syntax).nth(0)
349    }
350    #[inline]
351    pub fn to(&self) -> Option<ast::NameRef> {
352        support::children(&self.syntax).nth(1)
353    }
354}
355
356impl ast::ForeignKeyConstraint {
357    #[inline]
358    pub fn from_columns(&self) -> Option<ast::ColumnList> {
359        support::children(&self.syntax).nth(0)
360    }
361    #[inline]
362    pub fn to_columns(&self) -> Option<ast::ColumnList> {
363        support::children(&self.syntax).nth(1)
364    }
365}
366
367impl ast::BetweenExpr {
368    #[inline]
369    pub fn target(&self) -> Option<ast::Expr> {
370        support::children(&self.syntax).nth(0)
371    }
372    #[inline]
373    pub fn start(&self) -> Option<ast::Expr> {
374        support::children(&self.syntax).nth(1)
375    }
376    #[inline]
377    pub fn end(&self) -> Option<ast::Expr> {
378        support::children(&self.syntax).nth(2)
379    }
380}
381
382impl ast::WhenClause {
383    #[inline]
384    pub fn condition(&self) -> Option<ast::Expr> {
385        support::children(&self.syntax).next()
386    }
387    #[inline]
388    pub fn then(&self) -> Option<ast::Expr> {
389        support::children(&self.syntax).nth(1)
390    }
391}
392
393impl ast::CompoundSelect {
394    #[inline]
395    pub fn lhs(&self) -> Option<ast::SelectVariant> {
396        support::children(&self.syntax).next()
397    }
398    #[inline]
399    pub fn rhs(&self) -> Option<ast::SelectVariant> {
400        support::children(&self.syntax).nth(1)
401    }
402}
403
404impl ast::NameRef {
405    #[inline]
406    pub fn text(&self) -> String {
407        normalize_name_node(self.syntax())
408    }
409
410    #[inline]
411    pub fn is_quoted(&self) -> bool {
412        is_quoted(self.syntax())
413    }
414}
415
416impl ast::Name {
417    #[inline]
418    pub fn text(&self) -> String {
419        normalize_name_node(self.syntax())
420    }
421
422    #[inline]
423    pub fn is_quoted(&self) -> bool {
424        is_quoted(self.syntax())
425    }
426}
427
428fn is_quoted(node: &SyntaxNode) -> bool {
429    let text = node.text();
430    let first = text.char_at(0.into());
431    let second = text.char_at(1.into());
432    matches!(
433        (first, second),
434        (Some('u' | 'U'), Some('"')) | (Some('"'), Some(_))
435    )
436}
437
438// TODO: return a NewType wrapper around String?
439fn normalize_name_node(node: &SyntaxNode) -> String {
440    let mut tokens = node
441        .children_with_tokens()
442        .filter_map(|el| el.into_token())
443        .filter(|t| !t.kind().is_trivia());
444
445    let Some(ident_token) = tokens.next() else {
446        return String::new();
447    };
448    let raw = ident_token.text();
449
450    let unicode_inner = raw
451        .strip_prefix(['u', 'U'])
452        .and_then(|s| s.strip_prefix("&\""))
453        .and_then(|s| s.strip_suffix('"'));
454
455    if let Some(inner) = unicode_inner {
456        let mut escape_char = '\\';
457        if let Some(uesc) = tokens.next()
458            && uesc.kind() == SyntaxKind::UESCAPE_KW
459            && let Some(token) = tokens.next()
460            && let Some(ch) = uescape_char(token.text())
461        {
462            escape_char = ch;
463        }
464
465        let inner = inner.replace(r#""""#, "\"");
466        let mut result = String::with_capacity(inner.len());
467        escape_unicode_esc_str(&inner, escape_char, |_range, r| {
468            if let Ok(ch) = r {
469                result.push(ch);
470            }
471        });
472        return result;
473    }
474
475    raw.strip_prefix('"')
476        .and_then(|t| t.strip_suffix('"'))
477        .map(|x| x.replace(r#""""#, "\""))
478        .unwrap_or_else(|| raw.to_ascii_lowercase())
479}
480
481impl ast::CharType {
482    #[inline]
483    pub fn text(&self) -> TokenText<'_> {
484        text_of_first_token(self.syntax())
485    }
486}
487
488fn is_falsey_option(text: &str) -> bool {
489    text == "0" || text.eq_ignore_ascii_case("false") || text.eq_ignore_ascii_case("off")
490}
491
492impl ast::Vacuum {
493    pub fn is_full(&self) -> bool {
494        self.full_token().is_some()
495            // TODO: we need a better way of handling option lists
496            || self.vacuum_option_list().is_some_and(|opt_list| {
497                opt_list.vacuum_options().any(|opt| {
498                    let mut tokens = opt
499                        .syntax()
500                        .descendants_with_tokens()
501                        .filter_map(|child| child.into_token())
502                        .filter(|token| !token.kind().is_trivia());
503
504                    tokens
505                        .next()
506                        .is_some_and(|token| token.text().eq_ignore_ascii_case("full"))
507                        && tokens
508                            .next()
509                            .is_none_or(|token| !is_falsey_option(token.text()))
510                })
511            })
512    }
513}
514
515impl ast::OpSig {
516    #[inline]
517    pub fn lhs(&self) -> Option<ast::Type> {
518        support::children(self.syntax()).next()
519    }
520
521    #[inline]
522    pub fn rhs(&self) -> Option<ast::Type> {
523        support::children(self.syntax()).nth(1)
524    }
525}
526
527impl ast::CastSig {
528    #[inline]
529    pub fn lhs(&self) -> Option<ast::Type> {
530        support::children(self.syntax()).next()
531    }
532
533    #[inline]
534    pub fn rhs(&self) -> Option<ast::Type> {
535        support::children(self.syntax()).nth(1)
536    }
537}
538
539pub(crate) fn text_of_first_token(node: &SyntaxNode) -> TokenText<'_> {
540    fn first_token(green_ref: &GreenNodeData) -> &GreenTokenData {
541        green_ref
542            .children()
543            .next()
544            .and_then(NodeOrToken::into_token)
545            .unwrap()
546    }
547
548    match node.green() {
549        Cow::Borrowed(green_ref) => TokenText::borrowed(first_token(green_ref).text()),
550        Cow::Owned(green) => TokenText::owned(first_token(&green).to_owned()),
551    }
552}
553
554impl ast::WithQuery {
555    #[inline]
556    pub fn with_clause(&self) -> Option<ast::WithClause> {
557        support::child(self.syntax())
558    }
559}
560
561impl ast::SelectVariant {
562    #[inline]
563    pub fn target_list(&self) -> Option<ast::TargetList> {
564        match self {
565            ast::SelectVariant::Select(select) => {
566                return select.select_clause()?.target_list();
567            }
568            ast::SelectVariant::SelectInto(select_into) => {
569                return select_into.select_clause()?.target_list();
570            }
571            ast::SelectVariant::ParenSelect(paren_select) => {
572                return paren_select.select()?.target_list();
573            }
574            _ => return None,
575        }
576    }
577}
578
579impl ast::HasParamList for ast::FunctionSig {}
580impl ast::HasParamList for ast::Aggregate {}
581
582impl ast::NameLike for ast::Name {
583    #[inline]
584    fn text(&self) -> String {
585        self.text()
586    }
587}
588impl ast::NameLike for ast::NameRef {
589    #[inline]
590    fn text(&self) -> String {
591        self.text()
592    }
593}
594
595impl ast::HasWithClause for ast::Select {}
596impl ast::HasWithClause for ast::SelectInto {}
597impl ast::HasWithClause for ast::Insert {}
598impl ast::HasWithClause for ast::Update {}
599impl ast::HasWithClause for ast::Delete {}
600
601impl ast::HasCreateTable for ast::CreateTable {}
602impl ast::HasCreateTable for ast::CreateForeignTable {}
603impl ast::HasCreateTable for ast::CreateTableLike {}
604
605#[test]
606fn name() {
607    assert_snapshot!(extract_name("select 1 foo"), @"foo");
608    assert_snapshot!(extract_name("select 1 FOO"), @"foo");
609    assert_snapshot!(extract_name(r#"select 1 "foo""#), @"foo");
610    assert_snapshot!(extract_name(r#"select 1 "Foo""#), @"Foo");
611    assert_snapshot!(extract_name(r#"select 1 "FOO""#), @"FOO");
612    assert_snapshot!(extract_name(r#"select 1 U&"\0066\006f\006f""#), @"foo");
613    assert_snapshot!(extract_name(r#"select 1 U&"@0066@006f@006f" uescape '@'"#), @"foo");
614
615    fn extract_name(source_code: &str) -> String {
616        let parse = SourceFile::parse(source_code);
617        assert!(parse.errors().is_empty());
618        let stmt = parse.tree().stmts().next().unwrap();
619        let ast::Stmt::Select(select) = stmt else {
620            unreachable!()
621        };
622        let name = select
623            .select_clause()
624            .unwrap()
625            .target_list()
626            .unwrap()
627            .targets()
628            .next()
629            .unwrap()
630            .as_name()
631            .unwrap()
632            .name()
633            .unwrap();
634        name.text().to_string()
635    }
636}
637
638#[test]
639fn name_ref() {
640    assert_snapshot!(extract_name_ref("select foo"), @"foo");
641    assert_snapshot!(extract_name_ref("select FOO"), @"foo");
642    assert_snapshot!(extract_name_ref(r#"select "foo""#), @"foo");
643    assert_snapshot!(extract_name_ref(r#"select "Foo""#), @"Foo");
644    assert_snapshot!(extract_name_ref(r#"select "FOO""#), @"FOO");
645    assert_snapshot!(extract_name_ref(r#"select U&"\0066\006f\006f""#), @"foo");
646    assert_snapshot!(extract_name_ref(r#"select U&"@0066@006f@006f" uescape '@'"#), @"foo");
647
648    fn extract_name_ref(source_code: &str) -> String {
649        let parse = SourceFile::parse(source_code);
650        assert!(parse.errors().is_empty());
651        let stmt = parse.tree().stmts().next().unwrap();
652        let ast::Stmt::Select(select) = stmt else {
653            unreachable!()
654        };
655        let select_clause = select.select_clause().unwrap();
656        let target = select_clause
657            .target_list()
658            .unwrap()
659            .targets()
660            .next()
661            .unwrap();
662        let ast::Expr::NameRef(name_ref) = target.expr().unwrap() else {
663            unreachable!()
664        };
665        name_ref.text().to_string()
666    }
667}
668
669#[test]
670fn unicode_quoted_name_keeps_doubled_single_quotes() {
671    let parse = SourceFile::parse(r#"select 1 U&"a''b""#);
672    assert!(parse.errors().is_empty());
673    let stmt = parse.tree().stmts().next().unwrap();
674    let ast::Stmt::Select(select) = stmt else {
675        unreachable!()
676    };
677    let name = select
678        .select_clause()
679        .unwrap()
680        .target_list()
681        .unwrap()
682        .targets()
683        .next()
684        .unwrap()
685        .as_name()
686        .unwrap()
687        .name()
688        .unwrap();
689
690    assert_snapshot!(name.text().to_string(), @"a''b");
691}
692
693#[test]
694fn index_expr() {
695    let source_code = "
696        select foo[bar];
697    ";
698    let parse = SourceFile::parse(source_code);
699    assert!(parse.errors().is_empty());
700    let stmt = parse.tree().stmts().next().unwrap();
701    let ast::Stmt::Select(select) = stmt else {
702        unreachable!()
703    };
704    let select_clause = select.select_clause().unwrap();
705    let target = select_clause
706        .target_list()
707        .unwrap()
708        .targets()
709        .next()
710        .unwrap();
711    let ast::Expr::IndexExpr(index_expr) = target.expr().unwrap() else {
712        unreachable!()
713    };
714    let base = index_expr.base().unwrap();
715    let index = index_expr.index().unwrap();
716    assert_eq!(base.syntax().text(), "foo");
717    assert_eq!(index.syntax().text(), "bar");
718}
719
720#[test]
721fn slice_expr() {
722    use insta::assert_snapshot;
723    let source_code = "
724        select x[1:2], x[2:], x[:3], x[:];
725    ";
726    let parse = SourceFile::parse(source_code);
727    assert!(parse.errors().is_empty());
728    let stmt = parse.tree().stmts().next().unwrap();
729    let ast::Stmt::Select(select) = stmt else {
730        unreachable!()
731    };
732    let select_clause = select.select_clause().unwrap();
733    let mut targets = select_clause.target_list().unwrap().targets();
734
735    let ast::Expr::SliceExpr(slice) = targets.next().unwrap().expr().unwrap() else {
736        unreachable!()
737    };
738    assert_snapshot!(slice.syntax(), @"x[1:2]");
739    assert_eq!(slice.base().unwrap().syntax().text(), "x");
740    assert_eq!(slice.start().unwrap().syntax().text(), "1");
741    assert_eq!(slice.end().unwrap().syntax().text(), "2");
742
743    let ast::Expr::SliceExpr(slice) = targets.next().unwrap().expr().unwrap() else {
744        unreachable!()
745    };
746    assert_snapshot!(slice.syntax(), @"x[2:]");
747    assert_eq!(slice.base().unwrap().syntax().text(), "x");
748    assert_eq!(slice.start().unwrap().syntax().text(), "2");
749    assert!(slice.end().is_none());
750
751    let ast::Expr::SliceExpr(slice) = targets.next().unwrap().expr().unwrap() else {
752        unreachable!()
753    };
754    assert_snapshot!(slice.syntax(), @"x[:3]");
755    assert_eq!(slice.base().unwrap().syntax().text(), "x");
756    assert!(slice.start().is_none());
757    assert_eq!(slice.end().unwrap().syntax().text(), "3");
758
759    let ast::Expr::SliceExpr(slice) = targets.next().unwrap().expr().unwrap() else {
760        unreachable!()
761    };
762    assert_snapshot!(slice.syntax(), @"x[:]");
763    assert_eq!(slice.base().unwrap().syntax().text(), "x");
764    assert!(slice.start().is_none());
765    assert!(slice.end().is_none());
766}
767
768#[test]
769fn field_expr() {
770    let source_code = "
771        select foo.bar;
772    ";
773    let parse = SourceFile::parse(source_code);
774    assert!(parse.errors().is_empty());
775    let stmt = parse.tree().stmts().next().unwrap();
776    let ast::Stmt::Select(select) = stmt else {
777        unreachable!()
778    };
779    let select_clause = select.select_clause().unwrap();
780    let target = select_clause
781        .target_list()
782        .unwrap()
783        .targets()
784        .next()
785        .unwrap();
786    let ast::Expr::FieldExpr(field_expr) = target.expr().unwrap() else {
787        unreachable!()
788    };
789    let base = field_expr.base().unwrap();
790    let field = field_expr.field().unwrap();
791    assert_eq!(base.syntax().text(), "foo");
792    assert_eq!(field.syntax().text(), "bar");
793}
794
795#[test]
796fn between_expr() {
797    let source_code = "
798        select 2 between 1 and 3;
799    ";
800    let parse = SourceFile::parse(source_code);
801    assert!(parse.errors().is_empty());
802    let stmt = parse.tree().stmts().next().unwrap();
803    let ast::Stmt::Select(select) = stmt else {
804        unreachable!()
805    };
806    let select_clause = select.select_clause().unwrap();
807    let target = select_clause
808        .target_list()
809        .unwrap()
810        .targets()
811        .next()
812        .unwrap();
813    let ast::Expr::BetweenExpr(between_expr) = target.expr().unwrap() else {
814        unreachable!()
815    };
816    let target = between_expr.target().unwrap();
817    let start = between_expr.start().unwrap();
818    let end = between_expr.end().unwrap();
819    assert_eq!(target.syntax().text(), "2");
820    assert_eq!(start.syntax().text(), "1");
821    assert_eq!(end.syntax().text(), "3");
822}
823
824#[test]
825fn cast_expr() {
826    use insta::assert_snapshot;
827
828    let cast = extract_expr("select cast('123' as int)");
829    assert!(cast.expr().is_some());
830    assert_snapshot!(cast.expr().unwrap().syntax(), @"'123'");
831    assert!(cast.ty().is_some());
832    assert_snapshot!(cast.ty().unwrap().syntax(), @"int");
833
834    let cast = extract_expr("select cast('123' as pg_catalog.int4)");
835    assert!(cast.expr().is_some());
836    assert_snapshot!(cast.expr().unwrap().syntax(), @"'123'");
837    assert!(cast.ty().is_some());
838    assert_snapshot!(cast.ty().unwrap().syntax(), @"pg_catalog.int4");
839
840    let cast = extract_expr("select int '123'");
841    assert!(cast.expr().is_some());
842    assert_snapshot!(cast.expr().unwrap().syntax(), @"'123'");
843    assert!(cast.ty().is_some());
844    assert_snapshot!(cast.ty().unwrap().syntax(), @"int");
845
846    let cast = extract_expr("select pg_catalog.int4 '123'");
847    assert!(cast.expr().is_some());
848    assert_snapshot!(cast.expr().unwrap().syntax(), @"'123'");
849    assert!(cast.ty().is_some());
850    assert_snapshot!(cast.ty().unwrap().syntax(), @"pg_catalog.int4");
851
852    let cast = extract_expr("select '123'::int");
853    assert!(cast.expr().is_some());
854    assert_snapshot!(cast.expr().unwrap().syntax(), @"'123'");
855    assert!(cast.ty().is_some());
856    assert_snapshot!(cast.ty().unwrap().syntax(), @"int");
857
858    let cast = extract_expr("select '123'::int4");
859    assert!(cast.expr().is_some());
860    assert_snapshot!(cast.expr().unwrap().syntax(), @"'123'");
861    assert!(cast.ty().is_some());
862    assert_snapshot!(cast.ty().unwrap().syntax(), @"int4");
863
864    let cast = extract_expr("select '123'::pg_catalog.int4");
865    assert!(cast.expr().is_some());
866    assert_snapshot!(cast.expr().unwrap().syntax(), @"'123'");
867    assert!(cast.ty().is_some());
868    assert_snapshot!(cast.ty().unwrap().syntax(), @"pg_catalog.int4");
869
870    let cast = extract_expr("select '{123}'::pg_catalog.varchar(10)[]");
871    assert!(cast.expr().is_some());
872    assert_snapshot!(cast.expr().unwrap().syntax(), @"'{123}'");
873    assert!(cast.ty().is_some());
874    assert_snapshot!(cast.ty().unwrap().syntax(), @"pg_catalog.varchar(10)[]");
875
876    let cast = extract_expr("select cast('{123}' as pg_catalog.varchar(10)[])");
877    assert!(cast.expr().is_some());
878    assert_snapshot!(cast.expr().unwrap().syntax(), @"'{123}'");
879    assert!(cast.ty().is_some());
880    assert_snapshot!(cast.ty().unwrap().syntax(), @"pg_catalog.varchar(10)[]");
881
882    let cast = extract_expr("select pg_catalog.varchar(10) '{123}'");
883    assert!(cast.expr().is_some());
884    assert_snapshot!(cast.expr().unwrap().syntax(), @"'{123}'");
885    assert!(cast.ty().is_some());
886    assert_snapshot!(cast.ty().unwrap().syntax(), @"pg_catalog.varchar(10)");
887
888    let cast = extract_expr("select interval '1' month");
889    assert!(cast.expr().is_some());
890    assert_snapshot!(cast.expr().unwrap().syntax(), @"'1'");
891    assert!(cast.ty().is_some());
892    assert_snapshot!(cast.ty().unwrap().syntax(), @"interval");
893
894    fn extract_expr(sql: &str) -> ast::CastExpr {
895        let parse = SourceFile::parse(sql);
896        assert!(parse.errors().is_empty());
897        let node = parse
898            .tree()
899            .stmts()
900            .map(|x| match x {
901                ast::Stmt::Select(select) => select
902                    .select_clause()
903                    .unwrap()
904                    .target_list()
905                    .unwrap()
906                    .targets()
907                    .next()
908                    .unwrap()
909                    .expr()
910                    .unwrap()
911                    .clone(),
912                _ => unreachable!(),
913            })
914            .next()
915            .unwrap();
916        match node {
917            ast::Expr::CastExpr(cast) => cast,
918            _ => unreachable!(),
919        }
920    }
921}
922
923#[test]
924fn op_sig() {
925    let source_code = "
926      alter operator p.+ (int4, int8) 
927        owner to u;
928    ";
929    let parse = SourceFile::parse(source_code);
930    assert!(parse.errors().is_empty());
931    let stmt = parse.tree().stmts().next().unwrap();
932    let ast::Stmt::AlterOperator(alter_op) = stmt else {
933        unreachable!()
934    };
935    let op_sig = alter_op.op_sig().unwrap();
936    let lhs = op_sig.lhs().unwrap();
937    let rhs = op_sig.rhs().unwrap();
938    assert_snapshot!(lhs.syntax().text(), @"int4");
939    assert_snapshot!(rhs.syntax().text(), @"int8");
940}
941
942#[test]
943fn cast_sig() {
944    let source_code = "
945      drop cast (text as int);
946    ";
947    let parse = SourceFile::parse(source_code);
948    assert!(parse.errors().is_empty());
949    let stmt = parse.tree().stmts().next().unwrap();
950    let ast::Stmt::DropCast(alter_op) = stmt else {
951        unreachable!()
952    };
953    let cast_sig = alter_op.cast_sig().unwrap();
954    let lhs = cast_sig.lhs().unwrap();
955    let rhs = cast_sig.rhs().unwrap();
956    assert_snapshot!(lhs.syntax().text(), @"text");
957    assert_snapshot!(rhs.syntax().text(), @"int");
958}
959
960#[cfg(test)]
961fn extract_vacuum(sql: &str) -> ast::Vacuum {
962    let parse = SourceFile::parse(sql);
963    assert!(parse.errors().is_empty());
964    let stmt = parse.tree().stmts().next().unwrap();
965    let ast::Stmt::Vacuum(vacuum) = stmt else {
966        unreachable!()
967    };
968    vacuum
969}
970
971#[test]
972fn vacuum_full_is_full() {
973    assert!(extract_vacuum("VACUUM FULL foo;").is_full());
974}
975
976#[test]
977fn vacuum_option_list_full_is_full() {
978    assert!(extract_vacuum("VACUUM (FULL) foo;").is_full());
979}
980
981#[test]
982fn vacuum_full_true_is_full() {
983    assert!(extract_vacuum("VACUUM (FULL TRUE) foo;").is_full());
984}
985
986#[test]
987fn vacuum_full_on_is_full() {
988    assert!(extract_vacuum("VACUUM (FULL ON) foo;").is_full());
989}
990
991#[test]
992fn vacuum_full_1_is_full() {
993    assert!(extract_vacuum("VACUUM (FULL 1) foo;").is_full());
994}
995
996#[test]
997fn vacuum_no_full_is_not_full() {
998    assert!(!extract_vacuum("VACUUM foo;").is_full());
999}
1000
1001#[test]
1002fn vacuum_other_option_is_not_full() {
1003    assert!(!extract_vacuum("VACUUM (FREEZE) foo;").is_full());
1004}
1005
1006#[test]
1007fn vacuum_full_false_is_not_full() {
1008    assert!(!extract_vacuum("VACUUM (FULL FALSE) foo;").is_full());
1009}
1010
1011#[test]
1012fn vacuum_full_off_is_not_full() {
1013    assert!(!extract_vacuum("VACUUM (FULL OFF) foo;").is_full());
1014}
1015
1016#[test]
1017fn vacuum_full_0_is_not_full() {
1018    assert!(!extract_vacuum("VACUUM (FULL 0) foo;").is_full());
1019}
squawk_syntax/ast/node_ext.rs

squawk_syntax/ast/
node_ext.rs
