quil-rs 0.36.0

Rust tooling for Quil (Quantum Instruction Language)
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

// Copyright 2022 Rigetti Computing
//
// 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 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 super::{LexErrorKind, LexInput, LexResult};

use crate::parser::lexer::{InternalLexError, InternalLexResult};
use nom::branch::{alt as nom_alt, Alt};
use nom::bytes::complete::{tag as nom_tag, tag_no_case as nom_tag_no_case};
use nom::error::ParseError;
use nom::Parser;
use std::fmt;

/// Returns a parser that runs the given one and converts its returned error using `mapper`.
pub(crate) fn map_err<'a, P, F, O, E1, E2>(
    mut parser: P,
    mapper: F,
) -> impl FnMut(LexInput<'a>) -> LexResult<'a, O, E2>
where
    P: Parser<LexInput<'a>, O, E1>,
    O: fmt::Debug,
    F: Fn(E1) -> E2,
{
    move |input| match parser.parse(input) {
        Ok(result) => Ok(result),
        Err(err) => match err {
            nom::Err::Incomplete(needed) => Err(nom::Err::Incomplete(needed)),
            nom::Err::Error(err) => Err(nom::Err::Error(mapper(err))),
            nom::Err::Failure(failure) => Err(nom::Err::Failure(mapper(failure))),
        },
    }
}

/// Returns a lexing parser that runs the given one and replaces its error with [`LexErrorKind::ExpectedContext`] with the given string.
pub(crate) fn expecting<'a, O, E, P>(
    context: &'static str,
    mut parser: P,
) -> impl FnMut(LexInput<'a>) -> InternalLexResult<'a, O>
where
    P: Parser<LexInput<'a>, O, E>,
    O: fmt::Debug,
{
    move |input| {
        parser.parse(input).map_err(|err| {
            let new_err =
                InternalLexError::from_kind(input, LexErrorKind::ExpectedContext(context));
            match err {
                nom::Err::Incomplete(needed) => nom::Err::Incomplete(needed),
                nom::Err::Error(_) => nom::Err::Error(new_err),
                nom::Err::Failure(_) => nom::Err::Failure(new_err),
            }
        })
    }
}

/// A wrapper for [`nom::branch::alt`] that returns [`LexErrorKind::ExpectedContext`] on error.
///
/// This works around the fact that [`nom::branch::alt`] does not return any errors from any of the
/// alternatives, and is more user-friendly than returning all of those errors anyways.
pub(crate) fn alt<'a, O, E, List>(
    context: &'static str,
    alts: List,
) -> impl FnMut(LexInput<'a>) -> InternalLexResult<'a, O>
where
    E: ParseError<LexInput<'a>>,
    List: Alt<LexInput<'a>, O, E>,
    O: fmt::Debug,
{
    let parser = nom_alt::<_, _, E, List>(alts);
    expecting(context, parser)
}

/// A wrapper for [`nom::bytes::complete::tag`] that replaces the error with one that indicates what
/// tag string was expected.
pub(crate) fn tag<'a>(
    lit: &'static str,
) -> impl FnMut(LexInput<'a>) -> InternalLexResult<'a, LexInput<'a>> {
    move |input| {
        map_err(nom_tag(lit), |err: nom::error::Error<LexInput<'a>>| {
            InternalLexError::from_kind(err.input, LexErrorKind::ExpectedString(lit))
        })(input)
    }
}

/// A wrapper for [`nom::bytes::complete::tag_no_case`] that replaces the error with one that
/// indicates what tag string was expected.
pub(crate) fn tag_no_case<'a>(
    lit: &'static str,
) -> impl FnMut(LexInput<'a>) -> InternalLexResult<'a, LexInput<'a>> {
    move |input| {
        map_err(
            nom_tag_no_case(lit),
            |err: nom::error::Error<LexInput<'a>>| {
                InternalLexError::from_kind(
                    err.input,
                    LexErrorKind::ExpectedCaseInsensitiveString(lit),
                )
            },
        )(input)
    }
}