g-win 0.1.0

A winnow parser for .gcode files
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

# g-win


  

[![Crates.io](https://img.shields.io/crates/v/g-win.svg)](https://crates.io/crates/g-win)

[![Documentation](https://docs.rs/g-win/badge.svg)](https://docs.rs/g-win)

[![License](https://img.shields.io/crates/l/g-win.svg)](https://github.com/mj10021/g-win/blob/main/LICENSE)

  

**`g-win`** is a G-code parsing crate for Rust, built with [`winnow`](https://crates.io/crates/winnow). It aims to maximize compatibility by preserving unrecognized commands for later processing, ensuring compatibility across environments and handling of features like macros and templating.

  

## Table of Contents


  

- [Features](#features)

- [Installation](#installation)

- [Usage](#usage)

- [Contributing](#contributing)

- [License](#license)

  

## Design Goals


  


-  **Preserves Unrecognized Commands:** Stores any unrecognized or custom commands as strings in place.

-  **Custom Command Handling:** Easily add rules to parse any command.

- **Lightweight:** Minimal API designed to streamline implementation.

  

## Installation


  

Add `g-win` to your `Cargo.toml`:

  

```toml

[dependencies]

g-win = "0.1.0"

```

  

Then, run:

  

```bash

cargo build

```

  

## Usage


  

### Parsing G-code


  All G-code file information is stored in the `GCodeModel` struct.  The parser is implemented through the `FromStr` trait, returning a result of the type `Result<GCodeModel, GCodeParseError>`.
```rust

use  g_win::GCodeModel;

let  gcode = "
	G21 ; Set units to millimeters
	G90 ; Absolute positioning
	M107 ; Fan Off
	G28 ; Home
	G1 Z15.0 F9000 ; Move Z Axis up
	MCustomCommand ; This is a custom command
	";
	
let  gcode: GCodeModel = gcode.parse().expect("failed to parse");
println!("{:?}", gcode);

```

  

### Handling Unrecognized Commands


`g-win` stores unrecognized or custom commands as `Command::Raw(String)`, preserving their original content.


## Contributing


  

Contributions are welcome! Please submit a pull request or open an issue for suggestions and improvements.

  

1. Fork the repository.

2. Create a new branch: `git checkout -b feature/your-feature-name`.

3. Commit your changes: `git commit 'Add some feature'`.

4. Push to the branch: `git push origin feature/your-feature-name`.

5. Open a pull request.

  

## License


Licensed under either of

 * Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE))
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT))

at your option.

## Contribution


Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.