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.

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

ffi: use recommended stable way to represent an opaque C struct #1312

Merged
merged 1 commit into from
Dec 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Fix `#[text_signature]` interacting badly with rust `r#raw_identifiers`. [#1286](https://github.com/PyO3/pyo3/pull/1286)
- Fix FFI definitions for `PyObject_Vectorcall` and `PyVectorcall_Call`. [#1287](https://github.com/PyO3/pyo3/pull/1285)
- Fix building with Anaconda python inside a virtualenv. [#1290](https://github.com/PyO3/pyo3/pull/1290)
- Fix definition of opaque FFI types. [#1312](https://github.com/PyO3/pyo3/pull/1312)

## [0.12.4] - 2020-11-28
### Fixed
Expand Down
2 changes: 1 addition & 1 deletion src/ffi/code.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use crate::ffi::pyport::Py_ssize_t;
use std::os::raw::{c_char, c_int, c_uchar, c_void};

#[cfg(Py_3_8)]
pub enum _PyOpcache {}
opaque_struct!(_PyOpcache);

#[repr(C)]
#[derive(Copy, Clone)]
Expand Down
12 changes: 11 additions & 1 deletion src/ffi/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
#![cfg_attr(Py_LIMITED_API, allow(unused_imports))]
#![cfg_attr(feature = "cargo-clippy", allow(clippy::inline_always))]

// Until `extern type` is stabilized, use the recommended approach to
// model opaque types:
// https://doc.rust-lang.org/nomicon/ffi.html#representing-opaque-structs
macro_rules! opaque_struct {
($name:ident) => {
#[repr(C)]
pub struct $name([u8; 0]);
};
}

pub use self::bltinmodule::*;
pub use self::boolobject::*;
pub use self::bytearrayobject::*;
Expand Down Expand Up @@ -165,7 +175,7 @@ pub mod structmember; // TODO supports PEP-384 only; needs adjustment for Python
pub mod frameobject;
#[cfg(Py_LIMITED_API)]
pub mod frameobject {
pub enum PyFrameObject {}
opaque_struct!(PyFrameObject);
}

pub(crate) mod datetime;
Expand Down
2 changes: 1 addition & 1 deletion src/ffi/object.rs
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ pub type vectorcallfunc = unsafe extern "C" fn(

#[cfg(Py_LIMITED_API)]
mod typeobject {
pub enum PyTypeObject {}
opaque_struct!(PyTypeObject);
}

#[cfg(not(Py_LIMITED_API))]
Expand Down
2 changes: 1 addition & 1 deletion src/ffi/pyarena.rs
Original file line number Diff line number Diff line change
@@ -1 +1 @@
pub enum PyArena {}
opaque_struct!(PyArena);
6 changes: 3 additions & 3 deletions src/ffi/pythonrun.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ pub struct PyCompilerFlags {
}

#[cfg(not(Py_LIMITED_API))]
pub enum _mod {}
opaque_struct!(_mod);

#[cfg(not(Py_LIMITED_API))]
extern "C" {
Expand Down Expand Up @@ -90,8 +90,8 @@ extern "C" {
) -> *mut _mod;
}

pub enum symtable {}
pub enum _node {}
opaque_struct!(symtable);
opaque_struct!(_node);

#[inline]
pub unsafe fn PyParser_SimpleParseString(s: *const c_char, b: c_int) -> *mut _node {
Expand Down
2 changes: 1 addition & 1 deletion src/ffi/weakrefobject.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use crate::ffi::object::*;
use std::os::raw::c_int;

pub enum PyWeakReference {}
opaque_struct!(PyWeakReference);

extern "C" {
static mut _PyWeakref_RefType: PyTypeObject;
Expand Down