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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
//! A _very_ basic parser
//!
//! # Supported queries
//!
//! ## By primary key
//!
//! Keys and values are typed.
//!
//! - `put int(100) str(1000)`
//! - `del int(100)`
//! - `get int(100)`
//!
//! The tuple type nests other data, including other tuples.
//!
//! - `put int(6000) tup( str(s6000) tup( int(60) str(s60) ) int(60) )`
//! - `get tup( str(a) int(10) )`
//!
//! ## By range over primary key
//!
//! Analogous sql:
//!
//! - `SELECT * FROM table WHERE pk BETWEEN ${pk_lo} AND ${pk_hi};`
//! - `SELECT * FROM table WHERE pk <= ${pk_hi};`
//!
//! Only inclusive boundaries are supported.
//!
//! - `get between int(50) str(foobar)`
//! - `get between int(50) _`
//! - `get between _ str(foobar)`
//! - `get between _ _`
//!
//! ## By sub-portion of value
//!
//! ### Index creation
//!
//! Analogous sql:
//!
//! `CREATE INDEX ON table (${column});`
//!
//! Whereas a RDBMS allows specifing an index based on
//! a selection of one or more columns, we support a selection of any of:
//!
//! - The whole value
//! - One contiguous sub-portion of value at a specific nested location and having a specific type
//!
//! Index all entries by value type.
//!
//! `create index svspec(int)`
//!
//! Index all entries by sub-value specification.
//!
//! `create index svspec(0 str)`
//!
//! Index all entries by nested sub-value specification.
//!
//! `create index svspec(1 0 int)`
//!
//! ### Index-based selection
//!
//! Analogous sql:
//!
//! - `SELECT * FROM table WHERE ${column} = ${col_val};`
//! - `SELECT * FROM table WHERE ${column} BETWEEN ${col_val_lo} AND ${col_val_hi};`
//! - `SELECT * FROM table WHERE ${column} <= ${col_val_hi};`
//!
//! In addition, because value schemas are dynamic, we also support selecting all values
//! that match a spec, regardless of the sub-portion of value pointed to by the spec.
//! It would be analogous to this hypothetical sql:
//!
//! - `SELECT * FROM table WHERE ${column} IS VALID COLUMN;`
//!
//! Get all entries by whole-value.
//!
//! - `get where svspec(int) int(1000)`
//! - `get where svspec(int) between int(500) int(1500)`
//! - `get where svspec(int) between _ int(1500)`
//! - `get where svspec(int) _`
//!
//! Get all entries by sub-value specification.
//!
//! - `get where svspec(0 str) str(s6000)`
//! - `get where svspec(0 str) between str(s1000) str(s9000)`
//! - `get where svspec(0 str) _`
//!
//! Get all entries by nested sub-value specification.
//!
//! - `get where svspec(1 0 int) int(60)`
//! - `get where svspec(1 0 int) between int(60) int(61)`
//! - `get where svspec(1 0 int) _`
//!
//! # Caveats
//!
//! The input string is split by unicode word boundary. This incurs some limitations:
//! - Literals such as `foo.bar` and `foo-bar` are separated into multiple tokens.
//!     - This means any data containing such characters as `.` and `-` are unworkable with this query engine.
//! - Literals such as `("` and `))` are not separated.
//!     - Hence, when in doubt, add spaces.
//!
//! This is a simplistic, recursion-based parser.
//! It's meant to be a stop-gap impl.
//! It ought to be replaced by one based on a lexer and a parser.

use crate::oper::api::{Operation, SearchRange, Statement};
use anyhow::{anyhow, Context, Result};
use pancake_types::serde::{Datum, DatumType};
use pancake_types::types::{PrimaryKey, SubValue, SubValueSpec, Value};
use regex::Regex;
use std::iter::Peekable;

pub fn parse(q_str: &str) -> Result<Operation> {
    let reg = Regex::new(r"\s+|\b")?;
    let iter = reg.split(q_str).filter(|w| w.len() > 0).peekable();
    root(iter)
}

fn root<'a, I: Iterator<Item = &'a str>>(mut iter: Peekable<I>) -> Result<Operation> {
    match iter.next() {
        Some("put") => {
            let dat = datum(&mut iter)?;
            let key = PrimaryKey(dat);
            let dat = datum(&mut iter)?;
            let val = Value(dat);
            eos(&mut iter)?;

            let q = Operation::from(Statement::Put(key, Some(val)));
            return Ok(q);
        }
        Some("del") => {
            let dat = datum(&mut iter)?;
            eos(&mut iter)?;

            let key = PrimaryKey(dat);
            let q = Operation::from(Statement::Put(key, None));
            return Ok(q);
        }
        Some("get") => match iter.peek() {
            Some(&"between") => {
                iter.next();

                let optdat = opt_datum(&mut iter)?;
                let pk_lo = optdat.map(PrimaryKey);
                let optdat = opt_datum(&mut iter)?;
                let pk_hi = optdat.map(PrimaryKey);
                eos(&mut iter)?;

                let q = Operation::from(Statement::GetPK(SearchRange::Range {
                    lo: pk_lo,
                    hi: pk_hi,
                }));
                return Ok(q);
            }
            Some(&"where") => {
                iter.next();

                let spec = svspec(&mut iter)?;

                match iter.peek() {
                    Some(&"between") => {
                        iter.next();

                        let optdat = opt_datum(&mut iter)?;
                        let sv_lo = optdat.map(SubValue);
                        let optdat = opt_datum(&mut iter)?;
                        let sv_hi = optdat.map(SubValue);
                        eos(&mut iter)?;

                        let q = Operation::from(Statement::GetSV(
                            spec,
                            SearchRange::Range {
                                lo: sv_lo,
                                hi: sv_hi,
                            },
                        ));
                        return Ok(q);
                    }
                    _ => {
                        let optdat = opt_datum(&mut iter)?;
                        eos(&mut iter)?;

                        match optdat {
                            None => {
                                let q = Operation::from(Statement::GetSV(spec, SearchRange::all()));
                                return Ok(q);
                            }
                            Some(dat) => {
                                let sv = SubValue(dat);
                                let q =
                                    Operation::from(Statement::GetSV(spec, SearchRange::One(sv)));
                                return Ok(q);
                            }
                        }
                    }
                }
            }
            _ => {
                let dat = datum(&mut iter)?;
                let key = PrimaryKey(dat);
                eos(&mut iter)?;

                let q = Operation::from(Statement::GetPK(SearchRange::One(key)));
                return Ok(q);
            }
        },
        Some("create") => match iter.next() {
            Some("index") => {
                let spec = svspec(&mut iter)?;
                eos(&mut iter)?;
                return Ok(Operation::CreateScndIdx(spec));
            }
            x => return Err(anyhow!("Expected creatable but found {x:?}")),
        },
        Some("delete") => match iter.next() {
            Some("index") => {
                let spec = svspec(&mut iter)?;
                eos(&mut iter)?;
                return Ok(Operation::DelScndIdx(spec));
            }
            x => return Err(anyhow!("Expected deletable but found {x:?}")),
        },
        x => return Err(anyhow!("Expected operation but found {x:?}")),
    }
}

fn datum<'a, I: Iterator<Item = &'a str>>(iter: &mut Peekable<I>) -> Result<Datum> {
    match iter.next() {
        Some("str") => match iter.next() {
            Some("(") => match iter.next() {
                Some(str_literal) => match iter.next() {
                    Some(")") => return Ok(Datum::Str(String::from(str_literal))),
                    x => {
                        return Err(anyhow!(
                            "Expected closing of string literal but found {x:?}",
                        ))
                    }
                },
                None => return Err(anyhow!("Expected string literal but found EOS")),
            },
            x => {
                return Err(anyhow!(
                    "Expected opening of string literal but found {x:?}",
                ))
            }
        },
        Some("int") => match iter.next() {
            Some("(") => match iter.next() {
                Some(int_literal) => {
                    let int_val = int_literal
                        .parse::<i64>()
                        .context(format!("Expected i64 literal but found {int_literal}"))?;
                    match iter.next() {
                        Some(")") => return Ok(Datum::I64(int_val)),
                        x => {
                            return Err(anyhow!("Expected closing of int literal but found {x:?}"))
                        }
                    }
                }
                None => return Err(anyhow!("Expected int literal but found EOS")),
            },
            x => return Err(anyhow!("Expected opening of int literal but found {x:?}")),
        },
        Some("tup") => match iter.next() {
            Some("(") => {
                let mut members = Vec::<Datum>::new();
                loop {
                    match iter.peek() {
                        Some(&")") => {
                            iter.next();
                            return Ok(Datum::Tuple(members));
                        }
                        _ => {
                            let member = datum(iter)?;
                            members.push(member);
                        }
                    }
                }
            }
            x => return Err(anyhow!("Expected opening of tuple but found {x:?}")),
        },
        x => Err(anyhow!("Expected datum type but found {x:?}")),
    }
}

fn svspec<'a, I: Iterator<Item = &'a str>>(iter: &mut I) -> Result<SubValueSpec> {
    match iter.next() {
        Some("svspec") => match iter.next() {
            Some("(") => {
                let mut member_idxs = vec![];
                let mut datum_type = None;
                loop {
                    match iter.next() {
                        Some(")") => break,
                        Some(token) => {
                            if datum_type.is_some() {
                                return Err(anyhow!(
                                    "svspec() contains an extra token {token} following datum_type.",
                                ));
                            } else if token == "str" {
                                datum_type = Some(DatumType::Str);
                            } else if token == "int" {
                                datum_type = Some(DatumType::I64);
                            } else {
                                let member_idx = token.parse::<u32>().context(format!(
                                    "Expected svspec() member_idx but found {token}.",
                                ))?;
                                member_idxs.push(member_idx);
                            }
                        }
                        None => {
                            return Err(anyhow!("Expected svspec() defn to close but found EOS."))
                        }
                    }
                }
                match datum_type {
                    None => return Err(anyhow!("svspec() did not contain datum_type.")),
                    Some(datum_type) => {
                        return Ok(SubValueSpec {
                            member_idxs,
                            datum_type,
                        })
                    }
                }
            }
            x => return Err(anyhow!("Expected opening of svspec() but found {x:?}.")),
        },
        x => return Err(anyhow!("Expected opening of svspec() but found {x:?}.")),
    }
}

fn opt_datum<'a, I: Iterator<Item = &'a str>>(iter: &mut Peekable<I>) -> Result<Option<Datum>> {
    match iter.peek() {
        Some(&"_") => {
            iter.next();
            return Ok(None);
        }
        _ => {
            let dat = datum(iter)?;
            return Ok(Some(dat));
        }
    }
}

fn eos<'a, I: Iterator<Item = &'a str>>(iter: &mut I) -> Result<()> {
    match iter.next() {
        None => Ok(()),
        x => Err(anyhow!("Expected EOS but found {x:?}")),
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn put() -> Result<()> {
        let q_str = "put int(123) str(val1)";
        let exp_q_obj = Operation::from(Statement::Put(
            PrimaryKey(Datum::I64(123)),
            Some(Value(Datum::Str(String::from("val1")))),
        ));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "put tup( str(a) int(123) ) int(321)";
        let exp_q_obj = Operation::from(Statement::Put(
            PrimaryKey(Datum::Tuple(vec![
                Datum::Str(String::from("a")),
                Datum::I64(123),
            ])),
            Some(Value(Datum::I64(321))),
        ));
        assert_eq!(parse(q_str)?, exp_q_obj);

        Ok(())
    }

    #[test]
    fn del() -> Result<()> {
        let q_str = "del int(123)";
        let exp_q_obj = Operation::from(Statement::Put(PrimaryKey(Datum::I64(123)), None));
        assert_eq!(parse(q_str)?, exp_q_obj);

        Ok(())
    }

    #[test]
    fn get() -> Result<()> {
        let q_str = "get int(123)";
        let exp_q_obj = Operation::from(Statement::GetPK(SearchRange::One(PrimaryKey(
            Datum::I64(123),
        ))));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "get str(key1)";
        let exp_q_obj = Operation::from(Statement::GetPK(SearchRange::One(PrimaryKey(
            Datum::Str(String::from("key1")),
        ))));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "get tup( str(a) int(123) )";
        let exp_q_obj = Operation::from(Statement::GetPK(SearchRange::One(PrimaryKey(
            Datum::Tuple(vec![Datum::Str(String::from("a")), Datum::I64(123)]),
        ))));
        assert_eq!(parse(q_str)?, exp_q_obj);

        Ok(())
    }

    #[test]
    fn get_between() -> Result<()> {
        let q_str = "get between int(123) int(234)";
        let exp_q_obj = Operation::from(Statement::GetPK(SearchRange::Range {
            lo: Some(PrimaryKey(Datum::I64(123))),
            hi: Some(PrimaryKey(Datum::I64(234))),
        }));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "get between int(123) _";
        let exp_q_obj = Operation::from(Statement::GetPK(SearchRange::Range {
            lo: Some(PrimaryKey(Datum::I64(123))),
            hi: None,
        }));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "get between _ int(234)";
        let exp_q_obj = Operation::from(Statement::GetPK(SearchRange::Range {
            lo: None,
            hi: Some(PrimaryKey(Datum::I64(234))),
        }));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "get between _ _";
        let exp_q_obj =
            Operation::from(Statement::GetPK(SearchRange::Range { lo: None, hi: None }));
        assert_eq!(parse(q_str)?, exp_q_obj);

        Ok(())
    }

    #[test]
    fn get_where() -> Result<()> {
        let q_str = "get where svspec(int) _";
        let exp_q_obj = Operation::from(Statement::GetSV(
            SubValueSpec::whole(DatumType::I64),
            SearchRange::all(),
        ));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "get where svspec(int) int(123)";
        let exp_q_obj = Operation::from(Statement::GetSV(
            SubValueSpec::whole(DatumType::I64),
            SearchRange::One(SubValue(Datum::I64(123))),
        ));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "get where svspec(1 0 str) str(subval_a)";
        let exp_q_obj = Operation::from(Statement::GetSV(
            SubValueSpec {
                member_idxs: vec![1, 0],
                datum_type: DatumType::Str,
            },
            SearchRange::One(SubValue(Datum::Str(String::from("subval_a")))),
        ));
        assert_eq!(parse(q_str)?, exp_q_obj);

        Ok(())
    }

    #[test]
    fn get_where_between() -> Result<()> {
        let q_str = "get where svspec(int) between int(123) int(234)";
        let exp_q_obj = Operation::from(Statement::GetSV(
            SubValueSpec::whole(DatumType::I64),
            SearchRange::Range {
                lo: Some(SubValue(Datum::I64(123))),
                hi: Some(SubValue(Datum::I64(234))),
            },
        ));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "get where svspec(int) between int(123) _";
        let exp_q_obj = Operation::from(Statement::GetSV(
            SubValueSpec::whole(DatumType::I64),
            SearchRange::Range {
                lo: Some(SubValue(Datum::I64(123))),
                hi: None,
            },
        ));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "get where svspec(int) between _ int(234)";
        let exp_q_obj = Operation::from(Statement::GetSV(
            SubValueSpec::whole(DatumType::I64),
            SearchRange::Range {
                lo: None,
                hi: Some(SubValue(Datum::I64(234))),
            },
        ));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "get where svspec(int) between _ _";
        let exp_q_obj = Operation::from(Statement::GetSV(
            SubValueSpec::whole(DatumType::I64),
            SearchRange::all(),
        ));
        assert_eq!(parse(q_str)?, exp_q_obj);

        Ok(())
    }

    #[test]
    fn create_scnd_idx() -> Result<()> {
        let q_str = "create index svspec(int)";
        let exp_q_obj = Operation::CreateScndIdx(SubValueSpec::whole(DatumType::I64));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "create index svspec(2 int)";
        let exp_q_obj = Operation::CreateScndIdx(SubValueSpec {
            member_idxs: vec![2],
            datum_type: DatumType::I64,
        });
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "create index svspec(1 0 str)";
        let exp_q_obj = Operation::CreateScndIdx(SubValueSpec {
            member_idxs: vec![1, 0],
            datum_type: DatumType::Str,
        });
        assert_eq!(parse(q_str)?, exp_q_obj);

        Ok(())
    }

    #[test]
    fn delete_scnd_idx() -> Result<()> {
        let q_str = "delete index svspec(int)";
        let exp_q_obj = Operation::DelScndIdx(SubValueSpec::whole(DatumType::I64));
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "delete index svspec(2 int)";
        let exp_q_obj = Operation::DelScndIdx(SubValueSpec {
            member_idxs: vec![2],
            datum_type: DatumType::I64,
        });
        assert_eq!(parse(q_str)?, exp_q_obj);

        let q_str = "delete index svspec(1 0 str)";
        let exp_q_obj = Operation::DelScndIdx(SubValueSpec {
            member_idxs: vec![1, 0],
            datum_type: DatumType::Str,
        });
        assert_eq!(parse(q_str)?, exp_q_obj);

        Ok(())
    }
}