gq-core 0.1.0

Core library for the GQ project. Currently is not intended for use outside of GQ frontends. Breaking changes may occur at any time.
Documentation 
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

use std::{
    fmt::{self, Display, Formatter},
    io,
};

use thiserror::Error;

use crate::format::Indentation;

use super::{ChildQuery, Query};

#[derive(Debug, Error)]
pub enum Error {
    #[error("IO error while formatting: {0}")]
    Io(#[from] io::Error),
}

pub type Result<T> = std::result::Result<T, Error>;

impl Query {
    // TODO: do a test for this function, so parsing a formatted query, outputs the
    // same original query...
    pub fn pretty_format(&self, indentation: Indentation) -> String {
        let mut result = String::new();

        let arguments = self.arguments();
        if !arguments.0.is_empty() {
            result.push_str(&format!("({arguments})"));
        }
        let key = self.key();
        if !key.keys().is_empty() {
            if self.children().is_empty() {
                result.push_str(&key.to_string());
                return result;
            }
            result.push_str(&format!("{key} "));
        } else if self.children().is_empty() {
            result.push_str("{ }");
            return result;
        }

        result.push_str(&format!("{{{}", indentation.level_separator()));
        for child in self.children() {
            child.do_pretty_format(&mut result, indentation, 1);
        }
        result.push('}');

        result
    }

    pub fn pretty_format_to_writer<W: io::Write>(
        &self,
        writer: &mut W,
        indentation: Indentation,
    ) -> Result<()> {
        let formatted = self.pretty_format(indentation);
        Ok(writer.write_all(formatted.as_bytes())?)
    }
}

impl ChildQuery {
    fn do_pretty_format(&self, result: &mut String, indentation: Indentation, level: usize) {
        let indent_string = indentation.at_level(level);
        let sep = indentation.level_separator();

        let query_key = self.key();

        result.push_str(&format!("{indent_string}{query_key}"));
        if let Some(alias) = self.alias() {
            result.push_str(&format!(": {alias}"));
        }

        if !self.children().is_empty() {
            result.push_str(&format!(" {{{sep}"));
            for child in self.children() {
                child.do_pretty_format(result, indentation, level + 1);
            }
            result.push_str(&format!("{indent_string}}}{sep}"));
        } else {
            result.push(sep);
        }
    }
}

impl Display for Query {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        let formatted = self.pretty_format(Default::default());
        formatted.fmt(f)
    }
}