Issue #5 - Suppport GPX 1.0 #6
Conversation
|
@brendanashworth any interest in reviewing this? otherwise i can try to find some time this next week |
|
@hfiguiere thanks for putting this together, apologies for letting it slide through the cracks. I'll be reviewing it over the next few days. |
src/parser/gpx.rs
Outdated
| match version_str { | ||
| "1.0" => GpxVersion::Gpx10, | ||
| "1.1" => GpxVersion::Gpx11, | ||
| _ => GpxVersion::Unknown |
There was a problem hiding this comment.
Is there a requirement to have GpxVersion::Unknown part of the enum? Are we able to always error out if the version 1) isn't provided or 2) is malformed?
I see that the GPX version is required ("You must include the version number in your GPX document."), but perhaps I'm missing something.
There was a problem hiding this comment.
Returning an error here is probably better. As for the enum, there is a purpose.
src/parser/gpx.rs
Outdated
| use super::consume; | ||
|
|
||
| #[test] | ||
| fn consume_gpx() { | ||
| let gpx = consume!("<gpx></gpx>"); | ||
| let gpx = consume!("<gpx></gpx>", GpxVersion::Gpx11); |
There was a problem hiding this comment.
In retrospect, this should technically error as it lacks a version=....
There was a problem hiding this comment.
This is will be handled as an error. My updated PR has a bit more test case for this.
src/parser/string.rs
Outdated
| /// consume consumes a single string as tag content. | ||
| pub fn consume<R: Read>(reader: &mut Peekable<Events<R>>) -> Result<String> { | ||
| pub fn consume<R: Read>(reader: &mut Peekable<Events<R>>, _version: GpxVersion) -> Result<String> { |
There was a problem hiding this comment.
I feel as if this version passing becomes an antipattern, this file being a good example. It comes with lots of boiler plate code that, while consistent, isn't clean. What do you think of some sort of larger struct with version data as an alternative?
pub fn consume<R: Read>(context: &mut GpxContext<Peekable<Events<R>>>) -> Result<String> {
for event in context.reader() {
// ...
if (context.version() == GpxVersion::11) { /* ... */ }
// ...
}
}While the signature is ugly (GpxContext<Peekable<Events<Read>>>), I'd genuinely like to hear your opinion.
There was a problem hiding this comment.
How about context: &mut Context<R: Read> ? I have a patch doing that.
src/parser/waypoint.rs
Outdated
| "speed" => { | ||
| if version == GpxVersion::Gpx10 { | ||
| // Speed is from GPX 1.0 | ||
| // Ignore. |
There was a problem hiding this comment.
Might this be something we should add to parse-able data, noting it's only for GPX 1.0?
There was a problem hiding this comment.
I added it in Waypoint now
| #[derive(Clone, Copy, Debug, PartialEq)] | ||
| pub enum GpxVersion { | ||
| Unknown, | ||
| Gpx10, |
There was a problem hiding this comment.
Any thoughts on alternative naming, like GpxVersion::OneZero, GpxVersion:Gpx1_0? Also, from above, the Unknown value is questionable.
There was a problem hiding this comment.
The Unknown value is needed for consume when we don't know the version yet.
There was a problem hiding this comment.
GpxVersion::Gpx1_0 trigger a warning from the compiler. I don't find GpxVersion::OneZero intuitive.
src/parser/bounds.rs
Outdated
| use GpxVersion; | ||
|
|
||
| /// consume consumes an element as a nothing. | ||
| pub fn consume<R: Read>(reader: &mut Peekable<Events<R>>, _version: GpxVersion) -> Result<Bbox<f64>> { |
There was a problem hiding this comment.
Also, you should run rust-fmt, Travis is complaining.
There was a problem hiding this comment.
Done. This is will be in the updated PR.
|
Updated the PR with most feedback (see inline comments). Improved some of the syntax and ran rust fmt. |
|
@hfiguiere thank you for your contributions! I've merged these in as 6e07049, 9680234, and 385ca1c, and will be sending out a new release over the weekend. |
GPX is still generated by gpsbabel when loading tracks from various devices.
The PR add support for the GPX 1.0 format.