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
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// 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 in the LICENSE file at the
// root of this repository, or online at
//
//     http://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::fmt::{self, Debug};
use std::hash::Hash;

use crate::ast::display::{self, AstDisplay, AstFormatter};
use crate::ast::fold::{Fold, FoldNode};
use crate::ast::{
    Ident, Statement, UnresolvedDatabaseName, UnresolvedItemName, UnresolvedObjectName,
    UnresolvedSchemaName,
};

/// This represents the metadata that lives next to an AST, as we take it through
/// various stages in the planning process.
///
/// Conceptually, when we first receive an AST from the parsing process, it only
/// represents the syntax that the user input, and has no semantic information
/// embedded in it. Later in this process, we want to be able to walk the tree
/// and add additional information to it piecemeal, perhaps without going down
/// the full planning pipeline. AstInfo represents various bits of information
/// that get stored in the tree: for instance, at first, table names are only
/// represented by the names the user input (in the `Raw` implementor of this
/// trait), but later on, we replace them with both the name along with the ID
/// that it gets resolved to.
///
/// Currently this process brings an `Ast<Raw>` to `Ast<Aug>`, and lives in
/// sql/src/names.rs:resolve.
pub trait AstInfo: Clone {
    /// The type used for nested statements.
    type NestedStatement: AstDisplay + Clone + Hash + Debug + Eq;
    /// The type used for item references. Items are the subset of objects that are namespaced by a
    /// database and schema.
    type ItemName: AstDisplay + Clone + Hash + Debug + Eq + Ord;
    /// The type used for column references.
    type ColumnName: AstDisplay + Clone + Hash + Debug + Eq + Ord;
    /// The type used for schema names.
    type SchemaName: AstDisplay + Clone + Hash + Debug + Eq + Ord;
    /// The type used for database names.
    type DatabaseName: AstDisplay + Clone + Hash + Debug + Eq + Ord;
    /// The type used for cluster names.
    type ClusterName: AstDisplay + Clone + Hash + Debug + Eq + Ord;
    /// The type used for data types.
    type DataType: AstDisplay + Clone + Hash + Debug + Eq + Ord;
    /// The type stored next to CTEs for their assigned ID.
    type CteId: Clone + Hash + Debug + Eq + Ord;
    /// The type used for role references.
    type RoleName: AstDisplay + Clone + Hash + Debug + Eq + Ord;
    /// They type used for any object names. Objects are the superset of all objects in Materialize.
    type ObjectName: AstDisplay + Clone + Hash + Debug + Eq + Ord;
}

#[derive(Debug, PartialEq, Eq, Hash, Copy, Clone, Default)]
pub struct Raw;

impl AstInfo for Raw {
    type NestedStatement = Statement<Raw>;
    type ItemName = RawItemName;
    type ColumnName = RawColumnName;
    type SchemaName = UnresolvedSchemaName;
    type DatabaseName = UnresolvedDatabaseName;
    type ClusterName = RawClusterName;
    type DataType = RawDataType;
    type CteId = ();
    type RoleName = Ident;
    type ObjectName = UnresolvedObjectName;
}

#[derive(Debug, PartialEq, Eq, Hash, PartialOrd, Ord, Clone)]
pub enum RawItemName {
    Name(UnresolvedItemName),
    Id(String, UnresolvedItemName),
}

impl RawItemName {
    pub fn name(&self) -> &UnresolvedItemName {
        match self {
            RawItemName::Name(name) => name,
            RawItemName::Id(_, name) => name,
        }
    }

    pub fn name_mut(&mut self) -> &mut UnresolvedItemName {
        match self {
            RawItemName::Name(name) => name,
            RawItemName::Id(_, name) => name,
        }
    }
}

impl AstDisplay for RawItemName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            RawItemName::Name(o) => f.write_node(o),
            RawItemName::Id(id, o) => {
                f.write_str(format!("[{} AS ", id));
                f.write_node(o);
                f.write_str("]");
            }
        }
    }
}
impl_display!(RawItemName);

impl<T> FoldNode<Raw, T> for RawItemName
where
    T: AstInfo,
{
    type Folded = T::ItemName;

    fn fold<F>(self, f: &mut F) -> Self::Folded
    where
        F: Fold<Raw, T>,
    {
        f.fold_item_name(self)
    }
}

#[derive(Debug, PartialEq, Eq, Hash, PartialOrd, Ord, Clone)]
pub struct RawColumnName {
    pub relation: RawItemName,
    pub column: Ident,
}

impl AstDisplay for RawColumnName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_node(&self.relation);
        f.write_str(".");
        f.write_node(&self.column);
    }
}
impl_display!(RawColumnName);

#[derive(Debug, PartialEq, Eq, Hash, PartialOrd, Ord, Clone)]
pub enum RawClusterName {
    Unresolved(Ident),
    Resolved(String),
}

impl AstDisplay for RawClusterName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            RawClusterName::Unresolved(id) => f.write_node(id),
            RawClusterName::Resolved(id) => {
                f.write_str(format!("[{}]", id));
            }
        }
    }
}
impl_display!(RawClusterName);

impl<T> FoldNode<Raw, T> for RawClusterName
where
    T: AstInfo,
{
    type Folded = T::ClusterName;

    fn fold<F>(self, f: &mut F) -> Self::Folded
    where
        F: Fold<Raw, T>,
    {
        f.fold_cluster_name(self)
    }
}

/// SQL data types
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum RawDataType {
    /// Array
    Array(Box<RawDataType>),
    /// List
    List(Box<RawDataType>),
    /// Map
    Map {
        key_type: Box<RawDataType>,
        value_type: Box<RawDataType>,
    },
    /// Types who don't embed other types, e.g. INT
    Other {
        name: RawItemName,
        /// Typ modifiers appended to the type name, e.g. `numeric(38,0)`.
        typ_mod: Vec<i64>,
    },
}

impl AstDisplay for RawDataType {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            RawDataType::Array(ty) => {
                f.write_node(&ty);
                f.write_str("[]");
            }
            RawDataType::List(ty) => {
                f.write_node(&ty);
                f.write_str(" list");
            }
            RawDataType::Map {
                key_type,
                value_type,
            } => {
                f.write_str("map[");
                f.write_node(&key_type);
                f.write_str("=>");
                f.write_node(&value_type);
                f.write_str("]");
            }
            RawDataType::Other { name, typ_mod } => {
                f.write_node(name);
                if typ_mod.len() > 0 {
                    f.write_str("(");
                    f.write_node(&display::comma_separated(typ_mod));
                    f.write_str(")");
                }
            }
        }
    }
}
impl_display!(RawDataType);

impl<T> FoldNode<Raw, T> for RawDataType
where
    T: AstInfo,
{
    type Folded = T::DataType;

    fn fold<F>(self, f: &mut F) -> Self::Folded
    where
        F: Fold<Raw, T>,
    {
        f.fold_data_type(self)
    }
}