ngc 0.2.6

Library to parse G-code (LinuxCNC dialect)
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
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

// Copyright (c) 2019-2021 Georg Brandl.  Licensed under the Apache License,
// Version 2.0 <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0>
// or the MIT license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at
// your option. This file may not be copied, modified, or distributed except
// according to those terms.

//! Parser for G-code.

use std::str::FromStr;
use itertools::Itertools;
use pest::{Parser, Span, error::{Error, ErrorVariant}, iterators::{Pair, Pairs}};

use crate::ast::*;
use crate::util::num_to_int;

// Since pest makes Rule "pub", we do this in order to not show it to crate users.
mod parser {
    use pest_derive::Parser;

    #[derive(Parser)]
    #[grammar = "gcode.pest"]
    pub struct GcodeParser;
}

use self::parser::{GcodeParser, Rule};

/// Result of a parsing operation.
pub type ParseResult<T> = Result<T, Error<Rule>>;

fn err(span: Span, msg: impl Into<String>) -> Error<Rule> {
    Error::new_from_span(ErrorVariant::CustomError { message: msg.into() }, span)
}

fn parse_filtered<T: FromStr>(pair: Pair<Rule>) -> T
    where T::Err: std::fmt::Debug
{
    pair.as_str().chars()
                 .filter(|&ch| ch != ' ' && ch != '\t')
                 .collect::<String>()
                 .parse().expect("valid parse")
}

fn make_par_ref(pair: Pair<Rule>) -> ParseResult<ParId> {
    let (pair,) = pair.into_inner().collect_tuple().expect("one child");
    if pair.as_rule() == Rule::par_name {
        Ok(ParId::Named(parse_filtered(pair)))
    } else {
        let expr_span = pair.as_span();
        let expr = make_expr(pair)?;
        if let Expr::Num(f) = expr {
            let n = num_to_int(f, u16::max_value(),
                               |f| err(expr_span, format!("Invalid parameter number {}", f)))?;
            Ok(ParId::Numeric(n as u16))
        } else {
            Ok(ParId::Indirect(Box::new(expr)))
        }
    }
}

fn make_signed(sign: f64, expr: Expr) -> Expr {
    if sign < 0. {
        Expr::UnOp(UnOp::Minus, Box::new(expr))
    } else {
        expr
    }
}

fn make_expr(expr_pair: Pair<Rule>) -> ParseResult<Expr> {
    let mut lhs = None;
    let mut op = None;
    let mut sign = 1.;
    for pair in expr_pair.into_inner() {
        match pair.as_rule() {
            // prefix unary op
            Rule::op_un => if pair.as_str() == "-" { sign = -sign; },
            // singleton inside "expr_atom" or "value"
            Rule::expr => return Ok(make_signed(sign, make_expr(pair)?)),
            Rule::num => return Ok(Expr::Num(sign * parse_filtered::<f64>(pair))),
            Rule::expr_call => {
                let (func, arg) = pair.into_inner().collect_tuple().expect("children");
                let arg = Box::new(make_expr(arg)?);
                let func = match func.as_str() {
                    x if x.eq_ignore_ascii_case("ABS")    => Call::Abs(arg),
                    x if x.eq_ignore_ascii_case("ACOS")   => Call::Acos(arg),
                    x if x.eq_ignore_ascii_case("ASIN")   => Call::Asin(arg),
                    x if x.eq_ignore_ascii_case("COS")    => Call::Cos(arg),
                    x if x.eq_ignore_ascii_case("EXP")    => Call::Exp(arg),
                    x if x.eq_ignore_ascii_case("FIX")    => Call::Fix(arg),
                    x if x.eq_ignore_ascii_case("FUP")    => Call::Fup(arg),
                    x if x.eq_ignore_ascii_case("ROUND")  => Call::Round(arg),
                    x if x.eq_ignore_ascii_case("LN")     => Call::Ln(arg),
                    x if x.eq_ignore_ascii_case("SIN")    => Call::Sin(arg),
                    x if x.eq_ignore_ascii_case("SQRT")   => Call::Sqrt(arg),
                    _                                     => Call::Tan(arg),
                };
                return Ok(make_signed(sign, Expr::Call(func)));
            }
            Rule::expr_exist => {
                let (par_ref,) = pair.into_inner().collect_tuple().expect("one child");
                return Ok(make_signed(sign, Expr::Call(Call::Exists(
                    make_par_ref(par_ref)?
                ))));
            }
            Rule::expr_atan => {
                let (argy, argx) = pair.into_inner().collect_tuple().expect("children");
                return Ok(make_signed(
                    sign, Expr::Call(Call::Atan(Box::new(make_expr(argy)?),
                                                Box::new(make_expr(argx)?)))));
            }
            Rule::par_ref => return Ok(make_signed(sign, Expr::Par(make_par_ref(pair)?))),
            // rules inside (left-associative) binops
            Rule::expr_atom |
            Rule::expr_pow |
            Rule::expr_mul |
            Rule::expr_add |
            Rule::expr_cmp => {
                if let Some(op) = op.take() {
                    let lhs_expr = lhs.take().expect("LHS expected before op");
                    lhs = Some(Expr::BinOp(op, Box::new(lhs_expr), Box::new(make_expr(pair)?)));
                } else {
                    lhs = Some(make_expr(pair)?);
                }
            }
            Rule::expr_unop => {
                let mut inner = pair.into_inner().collect::<Vec<_>>();
                let expr = make_expr(inner.pop().expect("children"))?;
                let full = if inner.is_empty() || inner[0].as_str() == "+" {
                    expr
                } else {
                    Expr::UnOp(UnOp::Minus, Box::new(expr))
                };
                if let Some(op) = op.take() {
                    let lhs_expr = lhs.take().expect("LHS expected before op");
                    lhs = Some(Expr::BinOp(op, Box::new(lhs_expr), Box::new(full)));
                } else {
                    lhs = Some(full);
                }
            }
            // operators inside binops
            Rule::op_pow => op = Some(Op::Exp),
            Rule::op_mul => op = Some(match pair.as_str() {
                "*" => Op::Mul, "/" => Op::Div, _ => Op::Mod,
            }),
            Rule::op_add => op = Some(match pair.as_str() {
                "+" => Op::Add, _ => Op::Sub,
            }),
            Rule::op_cmp => op = Some(match pair.as_str() {
                x if x.eq_ignore_ascii_case("EQ") => Op::Eq,
                x if x.eq_ignore_ascii_case("NE") => Op::Ne,
                x if x.eq_ignore_ascii_case("GT") => Op::Gt,
                x if x.eq_ignore_ascii_case("GE") => Op::Ge,
                x if x.eq_ignore_ascii_case("LT") => Op::Lt,
                _                                 => Op::Le
            }),
            Rule::op_log => op = Some(match pair.as_str() {
                x if x.eq_ignore_ascii_case("AND") => Op::And,
                x if x.eq_ignore_ascii_case("OR")  => Op::Or,
                _                                  => Op::Xor,
            }),
            _ => unreachable!()
        }
    }
    Ok(lhs.expect("no children in expr?"))
}

fn make_word(pairs: Pairs<Rule>) -> ParseResult<Option<Word>> {
    let (letter, value) = pairs.collect_tuple().expect("children");
    let value = make_expr(value)?;
    match letter.as_str() {
        "o" | "O" => Err(err(letter.as_span(), "O-word control flow is not supported")),
        "n" | "N" => Ok(None),  // line numbers are accepted but ignoredxs
        "g" | "G" => Ok(Some(Word::Gcode(value))),
        "m" | "M" => Ok(Some(Word::Mcode(value))),
        "f" | "F" => Ok(Some(Word::Feed(value))),
        "s" | "S" => Ok(Some(Word::Spindle(value))),
        "t" | "T" => Ok(Some(Word::Tool(value))),
        "a" | "A" => Ok(Some(Word::Arg(Arg::AxisA, value))),
        "b" | "B" => Ok(Some(Word::Arg(Arg::AxisB, value))),
        "c" | "C" => Ok(Some(Word::Arg(Arg::AxisC, value))),
        "u" | "U" => Ok(Some(Word::Arg(Arg::AxisU, value))),
        "v" | "V" => Ok(Some(Word::Arg(Arg::AxisV, value))),
        "w" | "W" => Ok(Some(Word::Arg(Arg::AxisW, value))),
        "x" | "X" => Ok(Some(Word::Arg(Arg::AxisX, value))),
        "y" | "Y" => Ok(Some(Word::Arg(Arg::AxisY, value))),
        "z" | "Z" => Ok(Some(Word::Arg(Arg::AxisZ, value))),
        "i" | "I" => Ok(Some(Word::Arg(Arg::OffsetI, value))),
        "j" | "J" => Ok(Some(Word::Arg(Arg::OffsetJ, value))),
        "k" | "K" => Ok(Some(Word::Arg(Arg::OffsetK, value))),
        "d" | "D" => Ok(Some(Word::Arg(Arg::ParamD, value))),
        "e" | "E" => Ok(Some(Word::Arg(Arg::ParamE, value))),
        "h" | "H" => Ok(Some(Word::Arg(Arg::ParamH, value))),
        "l" | "L" => Ok(Some(Word::Arg(Arg::ParamL, value))),
        "p" | "P" => Ok(Some(Word::Arg(Arg::ParamP, value))),
        "q" | "Q" => Ok(Some(Word::Arg(Arg::ParamQ, value))),
        "r" | "R" => Ok(Some(Word::Arg(Arg::ParamR, value))),
        _ => unreachable!()
    }
}

enum PercentState {
    NotOnFirstLine,
    OnFirstLine,
    SeenTwice,
}

fn make_block(lineno: usize, pairs: Pairs<Rule>, pct: &mut PercentState)
              -> ParseResult<Option<Block>> {
    let mut block = Block { lineno, ..Block::default() };
    for pair in pairs {
        match pair.as_rule() {
            Rule::word => if let Some(word) = make_word(pair.into_inner())? {
                block.words.push(word);
            }
            Rule::par_assign => {
                let (id, value) = pair.into_inner().collect_tuple().expect("children");
                block.assignments.push(ParAssign {
                    id: make_par_ref(id)?,
                    value: make_expr(value)?
                });
            }
            Rule::blockdel => block.blockdel = true,
            Rule::percent => {
                if lineno == 1 {
                    *pct = PercentState::OnFirstLine;
                } else if let PercentState::OnFirstLine = pct  {
                    *pct = PercentState::SeenTwice;
                } else {
                    return Err(err(pair.as_span(), "percent sign missing on first line"));
                }
            }
            _ => unreachable!()
        }
    }
    Ok(if block.words.len() + block.assignments.len() > 0 { Some(block) } else { None })
}

/// Parse a program, coming from *filename*, consisting of the source *text*.
///
/// On parse error, a standard parse error from [pest] is returned.
///
/// [pest]: https://docs.rs/pest
pub fn parse(filename: &str, input: &str) -> ParseResult<Program> {
    let lines = GcodeParser::parse(Rule::file, input).map_err(|e| e.with_path(filename))?;
    let mut prog = Program { filename: filename.into(), blocks: vec![] };
    let mut pct = PercentState::NotOnFirstLine;
    let mut span = None;
    for (lineno, line) in lines.into_iter().enumerate() {
        span = Some(line.as_span());
        if let Some(block) = make_block(lineno + 1, line.into_inner(), &mut pct)? {
            prog.blocks.push(block);
        }
        // After the second percent sign, stop program
        if let PercentState::SeenTwice = pct {
            // if percent signs are used, M2 is optional
            prog.blocks.push(Block { lineno: lineno + 1,
                                     blockdel: false,
                                     words: vec![Word::Mcode(Expr::Num(2.0))],
                                     assignments: vec![] });
            break;
        }
    }
    if let PercentState::OnFirstLine = pct {
        return Err(err(span.unwrap(), "percent sign missing on last line"));
    }
    Ok(prog)
}