#![allow(clippy::too_many_arguments)]
use crate::sys;
use std::any::TypeId;
use std::collections::HashMap;
use std::pin::Pin;
pub use sys::SIMCONNECT_OBJECT_ID_USER;
pub use msfs_derive::sim_connect_client_data_definition as client_data_definition;
pub use msfs_derive::sim_connect_data_definition as data_definition;
pub type DataXYZ = sys::SIMCONNECT_DATA_XYZ;
pub type InitPosition = sys::SIMCONNECT_DATA_INITPOSITION;
pub trait DataDefinition: 'static {
#[doc(hidden)]
const DEFINITIONS: &'static [(&'static str, &'static str, f32, sys::SIMCONNECT_DATATYPE)];
}
pub trait ClientDataDefinition: 'static {
#[doc(hidden)]
fn get_definitions() -> Vec<(usize, usize, f32)>;
}
#[allow(dead_code)]
#[derive(Debug)]
pub struct HResult(sys::HRESULT);
impl std::fmt::Display for HResult {
fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
std::fmt::Debug::fmt(self, fmt)
}
}
impl std::error::Error for HResult {}
pub type Result<T> = std::result::Result<T, HResult>;
#[inline(always)]
fn map_err(result: sys::HRESULT) -> Result<()> {
if result >= 0 {
Ok(())
} else {
Err(HResult(result))
}
}
type SimConnectCallback<'a> = dyn FnMut(&mut SimConnect, SimConnectRecv) + 'a;
pub struct SimConnect<'a> {
handle: sys::HANDLE,
callback: Box<SimConnectCallback<'a>>,
data_definitions: HashMap<TypeId, sys::SIMCONNECT_DATA_DEFINITION_ID>,
client_data_definitions: HashMap<TypeId, sys::SIMCONNECT_CLIENT_DATA_DEFINITION_ID>,
event_id_counter: sys::DWORD,
client_data_id_counter: sys::DWORD,
}
impl<'a> std::fmt::Debug for SimConnect<'a> {
fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
fmt.debug_struct("SimConnect").finish()
}
}
impl<'a> SimConnect<'a> {
pub fn open<F>(name: &str, callback: F) -> Result<Pin<Box<SimConnect<'a>>>>
where
F: FnMut(&mut SimConnect, SimConnectRecv) + 'a,
{
unsafe {
let mut handle = 0;
let name = std::ffi::CString::new(name).unwrap();
map_err(sys::SimConnect_Open(
&mut handle,
name.as_ptr(),
std::ptr::null_mut(),
0,
0,
0,
))?;
debug_assert!(handle != 0);
let mut sim = Box::pin(SimConnect {
handle,
callback: Box::new(callback),
data_definitions: HashMap::new(),
client_data_definitions: HashMap::new(),
event_id_counter: 0,
client_data_id_counter: 0,
});
sim.call_dispatch()?;
Ok(sim)
}
}
pub fn call_dispatch(&mut self) -> Result<()> {
unsafe {
map_err(sys::SimConnect_CallDispatch(
self.handle,
Some(dispatch_cb),
self as *mut SimConnect as *mut std::ffi::c_void,
))
}
}
fn get_define_id<T: DataDefinition>(&mut self) -> Result<sys::SIMCONNECT_DATA_DEFINITION_ID> {
let handle = self.handle;
SimConnect::get_id::<T, _, _>(
&mut self.data_definitions,
|define_id: sys::SIMCONNECT_DATA_DEFINITION_ID| {
for (datum_name, units_type, epsilon, datatype) in T::DEFINITIONS {
let datum_name = std::ffi::CString::new(*datum_name).unwrap();
let units_type = std::ffi::CString::new(*units_type).unwrap();
unsafe {
map_err(sys::SimConnect_AddToDataDefinition(
handle,
define_id,
datum_name.as_ptr(),
units_type.as_ptr(),
*datatype,
*epsilon,
sys::SIMCONNECT_UNUSED,
))?;
}
}
Ok(())
},
)
}
fn get_client_data_define_id<T: ClientDataDefinition>(
&mut self,
) -> Result<sys::SIMCONNECT_CLIENT_DATA_DEFINITION_ID> {
let handle = self.handle;
SimConnect::get_id::<T, _, _>(&mut self.client_data_definitions, |define_id| {
let mut padding = usize::MAX;
for (offset, size, epsilon) in T::get_definitions() {
padding = padding.min(std::mem::size_of::<T>() - (offset + size));
unsafe {
map_err(sys::SimConnect_AddToClientDataDefinition(
handle,
define_id,
offset as sys::DWORD,
size as sys::DWORD,
epsilon,
sys::SIMCONNECT_UNUSED,
))?;
}
}
if padding > 0 && padding != usize::MAX {
unsafe {
map_err(sys::SimConnect_AddToClientDataDefinition(
handle,
define_id,
(std::mem::size_of::<T>() - padding) as sys::DWORD,
padding as sys::DWORD,
0.0,
sys::SIMCONNECT_UNUSED,
))?;
}
}
Ok(())
})
}
fn get_id<T: 'static, U: std::convert::TryFrom<usize> + Copy, F: Fn(U) -> Result<()>>(
map: &mut HashMap<TypeId, U>,
insert_fn: F,
) -> Result<U> {
let key = TypeId::of::<T>();
let maybe_id = U::try_from(map.len()).unwrap_or_else(|_| unreachable!());
match map.entry(key) {
std::collections::hash_map::Entry::Vacant(entry) => {
insert_fn(maybe_id)?;
entry.insert(maybe_id);
Ok(maybe_id)
}
std::collections::hash_map::Entry::Occupied(entry) => Ok(*entry.get()),
}
}
pub fn set_data_on_sim_object<T: DataDefinition>(
&mut self,
object_id: sys::SIMCONNECT_OBJECT_ID,
data: &T,
) -> Result<()> {
let define_id = self.get_define_id::<T>()?;
unsafe {
map_err(sys::SimConnect_SetDataOnSimObject(
self.handle,
define_id,
object_id,
0,
0,
std::mem::size_of_val(data) as sys::DWORD,
data as *const T as *mut std::ffi::c_void,
))
}
}
pub fn request_data_on_sim_object_type<T: DataDefinition>(
&mut self,
request_id: sys::SIMCONNECT_DATA_REQUEST_ID,
radius: sys::DWORD,
r#type: sys::SIMCONNECT_SIMOBJECT_TYPE,
) -> Result<()> {
let define_id = self.get_define_id::<T>()?;
unsafe {
map_err(sys::SimConnect_RequestDataOnSimObjectType(
self.handle,
request_id,
define_id,
radius,
r#type,
))
}
}
pub fn request_data_on_sim_object<T: DataDefinition>(
&mut self,
request_id: sys::SIMCONNECT_DATA_REQUEST_ID,
object_id: sys::SIMCONNECT_OBJECT_ID,
period: Period,
) -> Result<()> {
let define_id = self.get_define_id::<T>()?;
unsafe {
map_err(sys::SimConnect_RequestDataOnSimObject(
self.handle,
request_id,
define_id,
object_id,
period as sys::SIMCONNECT_PERIOD,
sys::SIMCONNECT_DATA_REQUEST_FLAG_CHANGED,
0,
0,
0,
))
}
}
pub fn map_client_event_to_sim_event(
&mut self,
event_name: &str,
mask: bool,
) -> Result<sys::DWORD> {
let event_id = self.event_id_counter;
self.event_id_counter += 1;
let event_name = std::ffi::CString::new(event_name).unwrap();
unsafe {
map_err(sys::SimConnect_MapClientEventToSimEvent(
self.handle,
event_id,
event_name.as_ptr(),
))?;
map_err(sys::SimConnect_AddClientEventToNotificationGroup(
self.handle,
0,
event_id,
mask.into(),
))?;
map_err(sys::SimConnect_SetNotificationGroupPriority(
self.handle,
0,
sys::SIMCONNECT_GROUP_PRIORITY_HIGHEST_MASKABLE,
))?;
}
Ok(event_id)
}
pub fn transmit_client_event(
&mut self,
object_id: sys::SIMCONNECT_OBJECT_ID,
event_id: sys::DWORD,
data: sys::DWORD,
) -> Result<()> {
unsafe {
map_err(sys::SimConnect_TransmitClientEvent(
self.handle,
object_id,
event_id,
data,
0,
0,
))
}
}
pub fn transmit_client_event_ex1(
&mut self,
object_id: sys::SIMCONNECT_OBJECT_ID,
event_id: sys::DWORD,
data: [sys::DWORD; 5],
) -> Result<()> {
unsafe {
map_err(sys::SimConnect_TransmitClientEvent_EX1(
self.handle,
object_id,
event_id,
0,
0,
data[0],
data[1],
data[2],
data[3],
data[4],
))
}
}
fn get_client_data_id(&mut self, name: &str) -> Result<sys::SIMCONNECT_CLIENT_DATA_ID> {
let client_id = self.client_data_id_counter;
self.client_data_id_counter += 1;
let name = std::ffi::CString::new(name).unwrap();
unsafe {
map_err(sys::SimConnect_MapClientDataNameToID(
self.handle,
name.as_ptr(),
client_id,
))?;
}
Ok(client_id)
}
pub fn create_client_data<T: ClientDataDefinition>(
&mut self,
name: &str,
) -> Result<ClientDataArea<T>> {
let client_id = self.get_client_data_id(name)?;
unsafe {
map_err(sys::SimConnect_CreateClientData(
self.handle,
client_id,
std::mem::size_of::<T>() as sys::DWORD,
0,
))?;
}
Ok(ClientDataArea {
client_id,
phantom: std::marker::PhantomData,
})
}
pub fn get_client_area<T: ClientDataDefinition>(
&mut self,
name: &str,
) -> Result<ClientDataArea<T>> {
let client_id = self.get_client_data_id(name)?;
Ok(ClientDataArea {
client_id,
phantom: std::marker::PhantomData,
})
}
pub fn request_client_data<T: ClientDataDefinition>(
&mut self,
request_id: sys::SIMCONNECT_DATA_REQUEST_ID,
name: &str,
) -> Result<()> {
let define_id = self.get_client_data_define_id::<T>()?;
let client_id = self.get_client_data_id(name)?;
unsafe {
map_err(sys::SimConnect_RequestClientData(
self.handle,
client_id,
request_id,
define_id,
sys::SIMCONNECT_CLIENT_DATA_PERIOD_SIMCONNECT_CLIENT_DATA_PERIOD_ON_SET,
sys::SIMCONNECT_CLIENT_DATA_REQUEST_FLAG_CHANGED,
0,
0,
0,
))?;
}
Ok(())
}
pub fn set_client_data<T: ClientDataDefinition>(
&mut self,
area: &ClientDataArea<T>,
data: &T,
) -> Result<()> {
unsafe {
map_err(sys::SimConnect_SetClientData(
self.handle,
area.client_id,
self.get_client_data_define_id::<T>()?,
0,
0,
std::mem::size_of::<T>() as sys::DWORD,
data as *const _ as *mut std::ffi::c_void,
))?;
}
Ok(())
}
pub fn ai_create_non_atc_aircraft(
&mut self,
container_title: &str,
tail_number: &str,
init_position: sys::SIMCONNECT_DATA_INITPOSITION,
request_id: sys::SIMCONNECT_DATA_REQUEST_ID,
) -> Result<()> {
let container_title = std::ffi::CString::new(container_title).unwrap();
let tail_number = std::ffi::CString::new(tail_number).unwrap();
unsafe {
map_err(sys::SimConnect_AICreateNonATCAircraft(
self.handle,
container_title.as_ptr(),
tail_number.as_ptr(),
init_position,
request_id,
))?;
}
Ok(())
}
pub fn ai_create_parked_atc_aircraft(
&mut self,
container_title: &str,
tail_number: &str,
icao: &str,
request_id: sys::SIMCONNECT_DATA_REQUEST_ID,
) -> Result<()> {
let container_title = std::ffi::CString::new(container_title).unwrap();
let tail_number = std::ffi::CString::new(tail_number).unwrap();
let icao = std::ffi::CString::new(icao).unwrap();
unsafe {
map_err(sys::SimConnect_AICreateParkedATCAircraft(
self.handle,
container_title.as_ptr(),
tail_number.as_ptr(),
icao.as_ptr(),
request_id,
))?;
}
Ok(())
}
pub fn ai_remove_object(
&mut self,
object_id: sys::SIMCONNECT_OBJECT_ID,
request_id: sys::SIMCONNECT_DATA_REQUEST_ID,
) -> Result<()> {
unsafe {
map_err(sys::SimConnect_AIRemoveObject(
self.handle,
object_id,
request_id,
))?;
}
Ok(())
}
pub fn subscribe_to_system_event(&mut self, system_event_name: &str) -> Result<sys::DWORD> {
let event_id = self.event_id_counter;
self.event_id_counter += 1;
let system_event_name = std::ffi::CString::new(system_event_name).unwrap();
unsafe {
map_err(sys::SimConnect_SubscribeToSystemEvent(
self.handle,
event_id,
system_event_name.as_ptr(),
))?;
}
Ok(event_id)
}
pub fn unsubscribe_from_system_event(
&mut self,
event_id: sys::SIMCONNECT_CLIENT_EVENT_ID,
) -> Result<()> {
unsafe {
map_err(sys::SimConnect_UnsubscribeFromSystemEvent(
self.handle,
event_id,
))?;
}
Ok(())
}
pub fn set_system_event_state(
&mut self,
event_id: sys::SIMCONNECT_CLIENT_EVENT_ID,
on: bool,
) -> Result<()> {
let state = on.into();
unsafe {
map_err(sys::SimConnect_SetSystemEventState(
self.handle,
event_id,
state,
))?;
}
Ok(())
}
}
impl<'a> Drop for SimConnect<'a> {
fn drop(&mut self) {
unsafe {
map_err(sys::SimConnect_Close(self.handle)).expect("SimConnect_Close");
}
}
}
macro_rules! recv {
($V:ident) => {
$V! {
(
SIMCONNECT_RECV_ID_SIMCONNECT_RECV_ID_EXCEPTION,
SIMCONNECT_RECV_EXCEPTION,
Exception
),
(
SIMCONNECT_RECV_ID_SIMCONNECT_RECV_ID_OPEN,
SIMCONNECT_RECV_OPEN,
Open
),
(
SIMCONNECT_RECV_ID_SIMCONNECT_RECV_ID_QUIT,
SIMCONNECT_RECV_QUIT,
Quit
),
(
SIMCONNECT_RECV_ID_SIMCONNECT_RECV_ID_EVENT,
SIMCONNECT_RECV_EVENT,
Event
),
(
SIMCONNECT_RECV_ID_SIMCONNECT_RECV_ID_EVENT_EX1,
SIMCONNECT_RECV_EVENT_EX1,
EventEx1
),
(
SIMCONNECT_RECV_ID_SIMCONNECT_RECV_ID_SIMOBJECT_DATA,
SIMCONNECT_RECV_SIMOBJECT_DATA,
SimObjectData
),
(
SIMCONNECT_RECV_ID_SIMCONNECT_RECV_ID_CLIENT_DATA,
SIMCONNECT_RECV_CLIENT_DATA,
ClientData
),
(
SIMCONNECT_RECV_ID_SIMCONNECT_RECV_ID_ASSIGNED_OBJECT_ID,
SIMCONNECT_RECV_ASSIGNED_OBJECT_ID,
AssignedObjectId
),
}
};
}
extern "C" fn dispatch_cb(
recv: *mut sys::SIMCONNECT_RECV,
_cb_data: sys::DWORD,
p_context: *mut std::ffi::c_void,
) {
macro_rules! recv_cb {
($( ($ID:ident, $T:ident, $E:ident), )*) => {
unsafe {
match (*recv).dwID as sys::SIMCONNECT_RECV_ID {
sys::SIMCONNECT_RECV_ID_SIMCONNECT_RECV_ID_NULL => Some(SimConnectRecv::Null),
$(
sys::$ID => Some(SimConnectRecv::$E(&*(recv as *mut sys::$T))),
)*
sys::SIMCONNECT_RECV_ID_SIMCONNECT_RECV_ID_SIMOBJECT_DATA_BYTYPE => {
Some(SimConnectRecv::SimObjectData(&*(recv as *mut sys::SIMCONNECT_RECV_SIMOBJECT_DATA)))
}
_ => None,
}
}
}
}
let recv = recv!(recv_cb);
if let Some(recv) = recv {
let sim = unsafe { &mut *(p_context as *mut SimConnect) };
(sim.callback)(unsafe { &mut *(p_context as *mut SimConnect) }, recv);
}
}
macro_rules! recv_enum {
($( ($ID:ident, $T:ident, $E:ident), )*) => {
#[derive(Debug)]
pub enum SimConnectRecv<'a> {
Null,
$(
$E(&'a sys::$T),
)*
}
}
}
recv!(recv_enum);
impl sys::SIMCONNECT_RECV_EVENT {
pub fn id(&self) -> sys::DWORD {
self.uEventID
}
pub fn data(&self) -> sys::DWORD {
self.dwData
}
}
impl sys::SIMCONNECT_RECV_EVENT_EX1 {
pub fn id(&self) -> sys::DWORD {
self.uEventID
}
pub fn data(&self) -> [sys::DWORD; 5] {
[
self.dwData0,
self.dwData1,
self.dwData2,
self.dwData3,
self.dwData4,
]
}
}
impl sys::SIMCONNECT_RECV_ASSIGNED_OBJECT_ID {
pub fn id(&self) -> sys::DWORD {
self.dwRequestID
}
pub fn object_id(&self) -> sys::DWORD {
self.dwObjectID
}
}
impl sys::SIMCONNECT_RECV_SIMOBJECT_DATA {
pub fn id(&self) -> sys::DWORD {
self.dwRequestID
}
pub fn into<T: DataDefinition>(&self, sim: &SimConnect) -> Option<&T> {
let define_id = sim.data_definitions[&TypeId::of::<T>()];
if define_id == self.dwDefineID {
Some(unsafe { &*(std::ptr::addr_of!(self.dwData) as *const T) })
} else {
None
}
}
}
impl sys::SIMCONNECT_RECV_CLIENT_DATA {
pub fn id(&self) -> sys::DWORD {
self._base.dwRequestID
}
pub fn into<T: ClientDataDefinition>(&self, sim: &SimConnect) -> Option<&T> {
let define_id = sim.client_data_definitions[&TypeId::of::<T>()];
if define_id == self._base.dwDefineID {
Some(unsafe { &*(std::ptr::addr_of!(self._base.dwData) as *const T) })
} else {
None
}
}
}
#[derive(Debug)]
pub enum Period {
Never = sys::SIMCONNECT_PERIOD_SIMCONNECT_PERIOD_NEVER as isize,
Once = sys::SIMCONNECT_PERIOD_SIMCONNECT_PERIOD_ONCE as isize,
VisualFrame = sys::SIMCONNECT_PERIOD_SIMCONNECT_PERIOD_VISUAL_FRAME as isize,
SimFrame = sys::SIMCONNECT_PERIOD_SIMCONNECT_PERIOD_SIM_FRAME as isize,
Second = sys::SIMCONNECT_PERIOD_SIMCONNECT_PERIOD_SECOND as isize,
}
pub struct ClientDataArea<T: ClientDataDefinition> {
client_id: sys::SIMCONNECT_CLIENT_DATA_ID,
phantom: std::marker::PhantomData<T>,
}