Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Proj::id_code and Proj::id_auth_name #204

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add Proj::id_code and Proj::id_auth_name #204

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
182dc0c
Add Proj::to_epsg
zwishing May 31, 2024
c655515
Add Proj::id_code and Proj::id_auth_name
zwishing Jun 1, 2024
6131e82
cargo fmt code
zwishing Jun 1, 2024
72cf6ab
Merge branch 'main' into main
zwishing Jun 20, 2024
fc1bd90
Merge branch 'main' into main
zwishing Sep 19, 2024
b7027b6
Merge branch 'georust:main' into main
zwishing Nov 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 39 additions & 4 deletions src/proj.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ use proj_sys::{
proj_context_destroy, proj_context_errno, proj_context_get_url_endpoint,
proj_context_is_network_enabled, proj_context_set_search_paths, proj_context_set_url_endpoint,
proj_create, proj_create_crs_to_crs, proj_destroy, proj_errno_string, proj_get_area_of_use,
proj_grid_cache_set_enable, proj_info, proj_normalize_for_visualization, proj_pj_info,
proj_trans, proj_trans_array, proj_trans_bounds, PJconsts, PJ_AREA, PJ_CONTEXT, PJ_COORD,
PJ_DIRECTION_PJ_FWD, PJ_DIRECTION_PJ_INV, PJ_INFO, PJ_LPZT, PJ_XYZT,
proj_get_id_auth_name, proj_get_id_code, proj_grid_cache_set_enable, proj_info,
proj_normalize_for_visualization, proj_pj_info, proj_trans, proj_trans_array,
proj_trans_bounds, PJconsts, PJ, PJ_AREA, PJ_CONTEXT, PJ_COORD, PJ_DIRECTION_PJ_FWD,
PJ_DIRECTION_PJ_INV, PJ_INFO, PJ_LPZT, PJ_XYZT,
};
use std::{
convert, ffi,
fmt::{self, Debug},
str,
ptr, str,
};

#[cfg(feature = "network")]
Expand Down Expand Up @@ -592,6 +593,28 @@ impl Proj {
transform_epsg(ctx, from, to, area)
}

/// Return Authority code for Proj
///
/// # Safety
/// This method contains unsafe code.
pub fn id_code(&self) -> Result<&str, str::Utf8Error> {
let pj = self.c_proj as *const PJ;
let c_char = unsafe { proj_get_id_code(pj, 0) };
let c_str = unsafe { CStr::from_ptr(c_char) };
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe there should be nullptr checking here as proj_get_id_code() might return null in case of error (typically if the CRS is custom and not tied to a known code), and https://doc.rust-lang.org/std/ffi/struct.CStr.html#method.from_ptr indicates the CStr::from_ptr() shouldn't be called with a null ptr

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When testing, I found that the Proj created by proj4str and esriwkt could not recognize the code and name。

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found that the Proj created by proj4str and esriwkt could not recognize the code and name。

Yes, that's fully expected. Not all CRS representations contain an authority name and code

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there are corresponding ideas or methods, converting them would be ideal.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can try using proj_identify() to find a known CRS that is identical to the current one, but there's no guarantee it will succeed. Custom CRS with custom projection parameter values are fully valid

c_str.to_str()
}

/// Return Authority Name for Proj
///
/// # Safety
/// This method contains unsafe code.
pub fn id_auth_name(&self) -> Result<&str, str::Utf8Error> {
let pj = self.c_proj as *const PJ;
let c_char = unsafe { proj_get_id_auth_name(pj, 0) };
let c_str = unsafe { CStr::from_ptr(c_char) };
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above

c_str.to_str()
}

/// Set the bounding box of the area of use
///
/// This bounding box will be used to specify the area of use
Expand Down Expand Up @@ -1484,4 +1507,16 @@ mod test {
assert_eq!(area.north, 84.73);
assert!(name.contains("Europe"));
}
#[test]
fn test_id_code() {
let proj = Proj::new("EPSG:3035").unwrap();
let code = proj.id_code().unwrap();
assert_eq!(code, "3035")
}
#[test]
fn test_id_auth_name() {
let proj = Proj::new("EPSG:3035").unwrap();
let auth_name = proj.id_auth_name().unwrap();
assert_eq!(auth_name, "EPSG")
}
}