Skip to content

Commit

Permalink
Converted Dataset to use foreign-types.
Browse files Browse the repository at this point in the history
  • Loading branch information
@metasim
metasim committed Oct 2, 2023
1 parent 7db2868 commit 2f1a8f1
Show file tree
Hide file tree
Showing 13 changed files with 98 additions and 145 deletions.
125 changes: 56 additions & 69 deletions src/dataset.rs
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
use foreign_types::ForeignTypeRef;
use foreign_types::{foreign_type, ForeignType, ForeignTypeRef};
use std::fmt::{Debug, Formatter};
use std::mem::ManuallyDrop;
use std::{ffi::CString, ffi::NulError, path::Path, ptr};

use gdal_sys::{self, CPLErr, GDALDatasetH, GDALMajorObjectH};
use gdal_sys::{self, CPLErr, GDALMajorObjectH};

use crate::cpl::CslStringList;
use crate::errors::*;
Expand All @@ -13,19 +15,20 @@ use crate::{
gdal_major_object::MajorObject, spatial_ref::SpatialRef, Driver, GeoTransform, Metadata,
};

/// Wrapper around a [`GDALDataset`][GDALDataset] object.
///
/// Represents both a [vector dataset][vector-data-model]
/// containing a collection of layers; and a
/// [raster dataset][raster-data-model] containing a collection of raster-bands.
///
/// [vector-data-model]: https://gdal.org/user/vector_data_model.html
/// [raster-data-model]: https://gdal.org/user/raster_data_model.html
/// [GDALDataset]: https://gdal.org/api/gdaldataset_cpp.html#_CPPv411GDALDataset
#[derive(Debug)]
pub struct Dataset {
c_dataset: GDALDatasetH,
closed: bool,
foreign_type! {
/// Wrapper around a [`GDALDataset`][GDALDataset] object.
///
/// Represents both a [vector dataset][vector-data-model]
/// containing a collection of layers; and a
/// [raster dataset][raster-data-model] containing a collection of raster-bands.
///
/// [vector-data-model]: https://gdal.org/user/vector_data_model.html
/// [raster-data-model]: https://gdal.org/user/raster_data_model.html
/// [GDALDataset]: https://gdal.org/api/gdaldataset_cpp.html#_CPPv411GDALDataset
pub unsafe type Dataset {
type CType = libc::c_void;
fn drop = gdal_sys::GDALClose;
}
}

// GDAL Docs state: The returned dataset should only be accessed by one thread at a time.
Expand All @@ -37,26 +40,6 @@ unsafe impl Send for Dataset {}

/// Core dataset methods
impl Dataset {
/// Returns the wrapped C pointer
///
/// # Safety
/// This method returns a raw C pointer
pub fn c_dataset(&self) -> GDALDatasetH {
self.c_dataset
}

/// Creates a new Dataset by wrapping a C pointer
///
/// # Safety
/// This method operates on a raw C pointer
/// The dataset must not have been closed (using [`GDALClose`]) before.
pub unsafe fn from_c_dataset(c_dataset: GDALDatasetH) -> Dataset {
Dataset {
c_dataset,
closed: false,
}
}

/// Open a dataset at the given `path` with default
/// options.
pub fn open<P: AsRef<Path>>(path: P) -> Result<Dataset> {
Expand Down Expand Up @@ -158,10 +141,7 @@ impl Dataset {
if c_dataset.is_null() {
return Err(_last_null_pointer_err("GDALOpenEx"));
}
Ok(Dataset {
c_dataset,
closed: false,
})
Ok(unsafe { Dataset::from_ptr(c_dataset) })
}

/// Flush all write cached data to disk.
Expand All @@ -172,70 +152,76 @@ impl Dataset {
pub fn flush_cache(&mut self) -> Result<()> {
#[cfg(any(all(major_ge_3, minor_ge_7), major_ge_4))]
{
let rv = unsafe { gdal_sys::GDALFlushCache(self.c_dataset) };
let rv = unsafe { gdal_sys::GDALFlushCache(self.as_ptr()) };
if rv != CPLErr::CE_None {
return Err(_last_cpl_err(rv));
}
}
#[cfg(not(any(all(major_is_3, minor_ge_7), major_ge_4)))]
{
unsafe {
gdal_sys::GDALFlushCache(self.c_dataset);
gdal_sys::GDALFlushCache(self.as_ptr());
}
}
Ok(())
}

/// Close the dataset.
/// Close the dataset, consuming it.
///
/// See [`GDALClose`].
/// See [`GDALClose`](https://gdal.org/api/raster_c_api.html#_CPPv49GDALClose12GDALDatasetH).
///
/// Note: on GDAL versions older than 3.7.0, this function always succeeds.
pub fn close(mut self) -> Result<()> {
self.closed = true;

/// # Notes
/// * `Drop`ing automatically closes the Dataset, so this method is usually not needed.
/// * On GDAL versions older than 3.7.0, this function always succeeds.
pub fn close(self) -> Result<()> {
// According to the C documentation, GDALClose will release all resources
// using the C++ `delete` operator.
// According to https://doc.rust-lang.org/std/mem/fn.forget.html#relationship-with-manuallydrop
// `ManuallyDrop` is the suggested means of transferring memory management while
// robustly preventing a double-free.
let ds = ManuallyDrop::new(self);
#[cfg(any(all(major_ge_3, minor_ge_7), major_ge_4))]
{
let rv = unsafe { gdal_sys::GDALClose(self.c_dataset) };
let rv = unsafe { gdal_sys::GDALClose(ds.as_ptr()) };
if rv != CPLErr::CE_None {
return Err(_last_cpl_err(rv));
}
}
#[cfg(not(any(all(major_is_3, minor_ge_7), major_ge_4)))]
{
unsafe {
gdal_sys::GDALClose(self.c_dataset);
gdal_sys::GDALClose(ds.as_ptr());
}
}
Ok(())
}

/// Fetch the projection definition string for this dataset.
pub fn projection(&self) -> String {
let rv = unsafe { gdal_sys::GDALGetProjectionRef(self.c_dataset) };
let rv = unsafe { gdal_sys::GDALGetProjectionRef(self.as_ptr()) };
_string(rv)
}

/// Set the projection reference string for this dataset.
pub fn set_projection(&mut self, projection: &str) -> Result<()> {
let c_projection = CString::new(projection)?;
unsafe { gdal_sys::GDALSetProjection(self.c_dataset, c_projection.as_ptr()) };
unsafe { gdal_sys::GDALSetProjection(self.as_ptr(), c_projection.as_ptr()) };
Ok(())
}

#[cfg(major_ge_3)]
/// Get the spatial reference system for this dataset.
pub fn spatial_ref(&self) -> Result<SpatialRef> {
Ok(
unsafe { SpatialRefRef::from_ptr(gdal_sys::GDALGetSpatialRef(self.c_dataset)) }
unsafe { SpatialRefRef::from_ptr(gdal_sys::GDALGetSpatialRef(self.as_ptr())) }
.to_owned(),
)
}

#[cfg(major_ge_3)]
/// Set the spatial reference system for this dataset.
pub fn set_spatial_ref(&mut self, spatial_ref: &SpatialRef) -> Result<()> {
let rv = unsafe { gdal_sys::GDALSetSpatialRef(self.c_dataset, spatial_ref.as_ptr()) };
let rv = unsafe { gdal_sys::GDALSetSpatialRef(self.as_ptr(), spatial_ref.as_ptr()) };
if rv != CPLErr::CE_None {
return Err(_last_cpl_err(rv));
}
Expand Down Expand Up @@ -265,7 +251,7 @@ impl Dataset {
gdal_sys::GDALCreateCopy(
driver.c_driver(),
c_filename.as_ptr(),
ds.c_dataset,
ds.as_ptr(),
0,
c_options.as_ptr(),
None,
Expand All @@ -275,15 +261,15 @@ impl Dataset {
if c_dataset.is_null() {
return Err(_last_null_pointer_err("GDALCreateCopy"));
}
Ok(unsafe { Dataset::from_c_dataset(c_dataset) })
Ok(unsafe { Dataset::from_ptr(c_dataset) })
}
_create_copy(self, driver, filename.as_ref(), options)
}

/// Fetch the driver to which this dataset relates.
pub fn driver(&self) -> Driver {
unsafe {
let c_driver = gdal_sys::GDALGetDatasetDriver(self.c_dataset);
let c_driver = gdal_sys::GDALGetDatasetDriver(self.as_ptr());
Driver::from_c_driver(c_driver)
}
}
Expand All @@ -304,7 +290,7 @@ impl Dataset {
pub fn set_geo_transform(&mut self, transformation: &GeoTransform) -> Result<()> {
assert_eq!(transformation.len(), 6);
let rv = unsafe {
gdal_sys::GDALSetGeoTransform(self.c_dataset, transformation.as_ptr() as *mut f64)
gdal_sys::GDALSetGeoTransform(self.as_ptr(), transformation.as_ptr() as *mut f64)
};
if rv != CPLErr::CE_None {
return Err(_last_cpl_err(rv));
Expand All @@ -324,7 +310,7 @@ impl Dataset {
pub fn geo_transform(&self) -> Result<GeoTransform> {
let mut transformation = GeoTransform::default();
let rv =
unsafe { gdal_sys::GDALGetGeoTransform(self.c_dataset, transformation.as_mut_ptr()) };
unsafe { gdal_sys::GDALGetGeoTransform(self.as_ptr(), transformation.as_mut_ptr()) };

// check if the dataset has a GeoTransform
if rv != CPLErr::CE_None {
Expand All @@ -334,24 +320,25 @@ impl Dataset {
}
}

impl Debug for Dataset {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Dataset")
.field(
"description",
&self.description().unwrap_or_else(|_| Default::default()),
)
.finish()
}
}

impl MajorObject for Dataset {
fn gdal_object_ptr(&self) -> GDALMajorObjectH {
self.c_dataset
self.as_ptr()
}
}

impl Metadata for Dataset {}

impl Drop for Dataset {
fn drop(&mut self) {
if !self.closed {
unsafe {
gdal_sys::GDALClose(self.c_dataset);
}
}
}
}

#[cfg(test)]
mod tests {
use gdal_sys::GDALAccess;
Expand Down
3 changes: 2 additions & 1 deletion src/driver.rs
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use foreign_types::ForeignType;
use std::ffi::CString;
use std::path::Path;
use std::sync::Once;
Expand Down Expand Up @@ -223,7 +224,7 @@ impl Driver {
return Err(_last_null_pointer_err("GDALCreate"));
};

Ok(unsafe { Dataset::from_c_dataset(c_dataset) })
Ok(unsafe { Dataset::from_ptr(c_dataset) })
}

/// Convenience for creating a vector-only dataset from a compatible driver.
Expand Down
10 changes: 5 additions & 5 deletions src/gcp.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ impl Dataset {
///
/// See: [`GDALGetGCPSpatialRef`](https://gdal.org/api/raster_c_api.html#_CPPv420GDALGetGCPSpatialRef12GDALDatasetH)
pub fn gcp_spatial_ref(&self) -> Option<SpatialRef> {
let c_ptr = unsafe { gdal_sys::GDALGetGCPSpatialRef(self.c_dataset()) };
let c_ptr = unsafe { gdal_sys::GDALGetGCPSpatialRef(self.as_ptr()) };

if c_ptr.is_null() {
return None;
Expand All @@ -134,7 +134,7 @@ impl Dataset {
///
/// See: [`GDALGetGCPProjection`](https://gdal.org/api/raster_c_api.html#gdal_8h_1a85ffa184d3ecb7c0a59a66096b22b2ec)
pub fn gcp_projection(&self) -> Option<String> {
let cc_ptr = unsafe { gdal_sys::GDALGetGCPProjection(self.c_dataset()) };
let cc_ptr = unsafe { gdal_sys::GDALGetGCPProjection(self.as_ptr()) };
if cc_ptr.is_null() {
return None;
}
Expand All @@ -145,8 +145,8 @@ impl Dataset {
///
/// See: [`GDALDataset::GetGCPs`](https://gdal.org/api/gdaldataset_cpp.html#_CPPv4N11GDALDataset7GetGCPsEv)
pub fn gcps(&self) -> &[GcpRef] {
let len = unsafe { gdal_sys::GDALGetGCPCount(self.c_dataset()) };
let data = unsafe { gdal_sys::GDALGetGCPs(self.c_dataset()) };
let len = unsafe { gdal_sys::GDALGetGCPCount(self.as_ptr()) };
let data = unsafe { gdal_sys::GDALGetGCPs(self.as_ptr()) };
unsafe { std::slice::from_raw_parts(data as *const GcpRef, len as usize) }
}

Expand Down Expand Up @@ -206,7 +206,7 @@ impl Dataset {

let rv = unsafe {
gdal_sys::GDALSetGCPs2(
self.c_dataset(),
self.as_ptr(),
len,
gdal_gcps.as_ptr(),
spatial_ref.as_ptr() as *mut _,
Expand Down
7 changes: 4 additions & 3 deletions src/programs/raster/mdimtranslate.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use crate::{
utils::{_last_null_pointer_err, _path_to_c_string},
Dataset,
};
use foreign_types::ForeignType;
use gdal_sys::{GDALMultiDimTranslate, GDALMultiDimTranslateOptions};
use libc::{c_char, c_int};
use std::{
Expand Down Expand Up @@ -183,12 +184,12 @@ fn _multi_dim_translate(
) -> Result<Dataset> {
let (psz_dest_option, h_dst_ds) = match &destination {
MultiDimTranslateDestination::Path(c_path) => (Some(c_path), null_mut()),
MultiDimTranslateDestination::Dataset { dataset, .. } => (None, dataset.c_dataset()),
MultiDimTranslateDestination::Dataset { dataset, .. } => (None, dataset.as_ptr()),
};

let psz_dest = psz_dest_option.map(|x| x.as_ptr()).unwrap_or_else(null);

let mut pah_src_ds: Vec<gdal_sys::GDALDatasetH> = input.iter().map(|x| x.c_dataset()).collect();
let mut pah_src_ds: Vec<gdal_sys::GDALDatasetH> = input.iter().map(|x| x.as_ptr()).collect();

let ps_options = options
.as_ref()
Expand Down Expand Up @@ -217,7 +218,7 @@ fn _multi_dim_translate(
return Err(_last_null_pointer_err("GDALMultiDimTranslate"));
}

let result = unsafe { Dataset::from_c_dataset(dataset_out) };
let result = unsafe { Dataset::from_ptr(dataset_out) };

Ok(result)
}
Expand Down
5 changes: 3 additions & 2 deletions src/programs/raster/vrt.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use crate::{
utils::{_last_null_pointer_err, _path_to_c_string},
Dataset,
};
use foreign_types::ForeignType;
use gdal_sys::GDALBuildVRTOptions;
use libc::{c_char, c_int};
use std::{
Expand Down Expand Up @@ -101,7 +102,7 @@ fn _build_vrt(
let dataset_out = unsafe {
// Get raw handles to the datasets
let mut datasets_raw: Vec<gdal_sys::GDALDatasetH> =
datasets.iter().map(|x| x.c_dataset()).collect();
datasets.iter().map(|x| x.as_ptr()).collect();

gdal_sys::GDALBuildVRT(
c_dest,
Expand All @@ -117,7 +118,7 @@ fn _build_vrt(
return Err(_last_null_pointer_err("GDALBuildVRT"));
}

let result = unsafe { Dataset::from_c_dataset(dataset_out) };
let result = unsafe { Dataset::from_ptr(dataset_out) };

Ok(result)
}
Loading

0 comments on commit 2f1a8f1

Please sign in to comment.