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

scanner: Use std::convert::Infallible in __phantom_lifetime variants #662

Merged
merged 1 commit into from
Sep 25, 2023
Merged

scanner: Use std::convert::Infallible in __phantom_lifetime variants #662

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions wayland-scanner/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

## Unreleased

- Include an `std::convert::Infallible` in hidden `__phantom_lifetime` enum variants,
so they're explicitly unconstructable.

## 0.31.0 -- 2023-09-02

#### Breaking changes
Expand Down
6 changes: 3 additions & 3 deletions wayland-scanner/src/common.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,8 +302,8 @@ pub(crate) fn gen_message_enum(
let (generic, phantom_variant, phantom_case) = if !receiver {
(
quote! { 'a },
quote! { #[doc(hidden)] __phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> } },
quote! { #name::__phantom_lifetime { .. } => unreachable!() },
quote! { #[doc(hidden)] __phantom_lifetime { phantom: std::marker::PhantomData<&'a ()>, never: std::convert::Infallible } },
quote! { #name::__phantom_lifetime { never, .. } => match never {} },
)
} else {
(quote! {}, quote! {}, quote! {})
Expand Down Expand Up @@ -625,7 +625,7 @@ pub(crate) fn gen_write_body(interface: &Interface, side: Side) -> TokenStream {
quote! {
match msg {
#(#arms,)*
#msg_type::__phantom_lifetime { .. } => unreachable!()
#msg_type::__phantom_lifetime { never, .. } => match never {}
}
}
}
63 changes: 42 additions & 21 deletions wayland-scanner/tests/scanner_assets/test-client-code.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,18 @@ pub mod wl_display {
#[doc = "get global registry object\n\nThis request creates a registry object that allows the client\nto list and bind the global objects available from the\ncompositor.\n\nIt should be noted that the server side resources consumed in\nresponse to a get_registry request can only be released when the\nclient disconnects, not when the client side proxy is destroyed.\nTherefore, clients should invoke get_registry as infrequently as\npossible to avoid wasting memory."]
GetRegistry {},
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Request<'a> {
#[doc = "Get the opcode number of this message"]
pub fn opcode(&self) -> u16 {
match *self {
Request::Sync { .. } => 0u16,
Request::GetRegistry { .. } => 1u16,
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -270,7 +273,7 @@ pub mod wl_display {
};
Ok((Message { sender_id: self.id.clone(), opcode: 1u16, args }, child_spec))
}
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -343,14 +346,17 @@ pub mod wl_registry {
id: (&'static Interface, u32),
},
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Request<'a> {
#[doc = "Get the opcode number of this message"]
pub fn opcode(&self) -> u16 {
match *self {
Request::Bind { .. } => 0u16,
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -538,7 +544,7 @@ pub mod wl_registry {
};
Ok((Message { sender_id: self.id.clone(), opcode: 0u16, args }, child_spec))
}
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -579,13 +585,16 @@ pub mod wl_callback {
#[non_exhaustive]
pub enum Request<'a> {
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Request<'a> {
#[doc = "Get the opcode number of this message"]
pub fn opcode(&self) -> u16 {
match *self {
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -723,7 +732,7 @@ pub mod wl_callback {
InvalidId,
> {
match msg {
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -813,7 +822,10 @@ pub mod test_global {
ter: super::tertiary::Tertiary,
},
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Request<'a> {
#[doc = "Get the opcode number of this message"]
Expand All @@ -826,7 +838,7 @@ pub mod test_global {
Request::Destroy => 4u16,
Request::ReverseLink { .. } => 5u16,
Request::NewidAndAllowNull { .. } => 6u16,
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -1179,7 +1191,7 @@ pub mod test_global {
};
Ok((Message { sender_id: self.id.clone(), opcode: 6u16, args }, child_spec))
}
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -1329,14 +1341,17 @@ pub mod secondary {
#[doc = "This is a destructor, once sent this object cannot be used any longer.\nOnly available since version 2 of the interface"]
Destroy,
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Request<'a> {
#[doc = "Get the opcode number of this message"]
pub fn opcode(&self) -> u16 {
match *self {
Request::Destroy => 0u16,
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -1460,7 +1475,7 @@ pub mod secondary {
let args = smallvec::SmallVec::new();
Ok((Message { sender_id: self.id.clone(), opcode: 0u16, args }, child_spec))
}
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -1496,14 +1511,17 @@ pub mod tertiary {
#[doc = "This is a destructor, once sent this object cannot be used any longer.\nOnly available since version 3 of the interface"]
Destroy,
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Request<'a> {
#[doc = "Get the opcode number of this message"]
pub fn opcode(&self) -> u16 {
match *self {
Request::Destroy => 0u16,
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -1627,7 +1645,7 @@ pub mod tertiary {
let args = smallvec::SmallVec::new();
Ok((Message { sender_id: self.id.clone(), opcode: 0u16, args }, child_spec))
}
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -1663,14 +1681,17 @@ pub mod quad {
#[doc = "This is a destructor, once sent this object cannot be used any longer.\nOnly available since version 3 of the interface"]
Destroy,
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Request<'a> {
#[doc = "Get the opcode number of this message"]
pub fn opcode(&self) -> u16 {
match *self {
Request::Destroy => 0u16,
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -1794,7 +1815,7 @@ pub mod quad {
let args = smallvec::SmallVec::new();
Ok((Message { sender_id: self.id.clone(), opcode: 0u16, args }, child_spec))
}
Request::__phantom_lifetime { .. } => unreachable!(),
Request::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down
45 changes: 30 additions & 15 deletions wayland-scanner/tests/scanner_assets/test-server-code.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,17 @@ pub mod wl_callback {
callback_data: u32,
},
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Event<'a> {
#[doc = "Get the opcode number of this message"]
pub fn opcode(&self) -> u16 {
match *self {
Event::Done { .. } => 0u16,
Event::__phantom_lifetime { .. } => unreachable!(),
Event::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -142,7 +145,7 @@ pub mod wl_callback {
vec
},
}),
Event::__phantom_lifetime { .. } => unreachable!(),
Event::__phantom_lifetime { never, .. } => match never {},
}
}
fn __set_object_data(
Expand Down Expand Up @@ -288,7 +291,10 @@ pub mod test_global {
#[doc = "create a new quad optionally replacing a previous one"]
CycleQuad { new_quad: super::quad::Quad, old_quad: Option<super::quad::Quad> },
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Event<'a> {
#[doc = "Get the opcode number of this message"]
Expand All @@ -297,7 +303,7 @@ pub mod test_global {
Event::ManyArgsEvt { .. } => 0u16,
Event::AckSecondary { .. } => 1u16,
Event::CycleQuad { .. } => 2u16,
Event::__phantom_lifetime { .. } => unreachable!(),
Event::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -712,7 +718,7 @@ pub mod test_global {
vec
},
}),
Event::__phantom_lifetime { .. } => unreachable!(),
Event::__phantom_lifetime { never, .. } => match never {},
}
}
fn __set_object_data(
Expand Down Expand Up @@ -794,13 +800,16 @@ pub mod secondary {
#[non_exhaustive]
pub enum Event<'a> {
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Event<'a> {
#[doc = "Get the opcode number of this message"]
pub fn opcode(&self) -> u16 {
match *self {
Event::__phantom_lifetime { .. } => unreachable!(),
Event::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -906,7 +915,7 @@ pub mod secondary {
msg: Self::Event<'a>,
) -> Result<Message<ObjectId, std::os::unix::io::BorrowedFd<'a>>, InvalidId> {
match msg {
Event::__phantom_lifetime { .. } => unreachable!(),
Event::__phantom_lifetime { never, .. } => match never {},
}
}
fn __set_object_data(
Expand Down Expand Up @@ -950,13 +959,16 @@ pub mod tertiary {
#[non_exhaustive]
pub enum Event<'a> {
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Event<'a> {
#[doc = "Get the opcode number of this message"]
pub fn opcode(&self) -> u16 {
match *self {
Event::__phantom_lifetime { .. } => unreachable!(),
Event::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -1062,7 +1074,7 @@ pub mod tertiary {
msg: Self::Event<'a>,
) -> Result<Message<ObjectId, std::os::unix::io::BorrowedFd<'a>>, InvalidId> {
match msg {
Event::__phantom_lifetime { .. } => unreachable!(),
Event::__phantom_lifetime { never, .. } => match never {},
}
}
fn __set_object_data(
Expand Down Expand Up @@ -1106,13 +1118,16 @@ pub mod quad {
#[non_exhaustive]
pub enum Event<'a> {
#[doc(hidden)]
__phantom_lifetime { phantom: std::marker::PhantomData<&'a ()> },
__phantom_lifetime {
phantom: std::marker::PhantomData<&'a ()>,
never: std::convert::Infallible,
},
}
impl<'a> Event<'a> {
#[doc = "Get the opcode number of this message"]
pub fn opcode(&self) -> u16 {
match *self {
Event::__phantom_lifetime { .. } => unreachable!(),
Event::__phantom_lifetime { never, .. } => match never {},
}
}
}
Expand Down Expand Up @@ -1218,7 +1233,7 @@ pub mod quad {
msg: Self::Event<'a>,
) -> Result<Message<ObjectId, std::os::unix::io::BorrowedFd<'a>>, InvalidId> {
match msg {
Event::__phantom_lifetime { .. } => unreachable!(),
Event::__phantom_lifetime { never, .. } => match never {},
}
}
fn __set_object_data(
Expand Down
Loading