{"header":{"message":"Add binding for `setSerialMessageCallback` (#327)","description":"* Add binding to setSerialMessageCallback\n\n* Add example\n\n---------\n\nCo-authored-by: Alexander Koz ","timestamp":"2024-05-01T08:26:36Z","authors":[{"email":"84700+paulyoung@users.noreply.github.com","name":"Paul Young"}]},"hash":"NYXUK37PVLPWDMB7ALJUSOEIOCHQQLOMIQOOZO7EEBKBZSPUEYDQC","authors":[],"deps":{"hashes":[["NYXUK37PVLPWDMB7ALJUSOEIOCHQQLOMIQOOZO7EEBKBZSPUEYDQC","Add binding for `setSerialMessageCallback` (#327)"],["AA",null],["V4SK5ZKA2N65GGE2HRB4Y6B64BXQ7D62Q3MOERMEE7SN6IGH6ZNQC","Add system api (#47)"],["CKZVFK24JLPQMVNQ5SEP5VKDJ5K4UFFDHKRWLBPBRXHGDFDCZQWQC","fix missed import 🤦🏻‍♂️"],["IRPWJFHL6T2Z5AK2RW5EFRJPFKMCCHXV74HKGPZHPFC3QIYI23BAC","Api handlers, entry-point and various improvements (#118)"],["4FJROIHD3ZPNVJZ4JRRPZ2RWL7QM6TGSAQV3FBHDVU3LH4OF2NQAC","Add cached api end points (part 1) (#130)"],["SDWZKQ7AU2CRPWATMQDADMSW4ZCYZOTV5YILO5T4YSQCZQ7KQVUAC","Api features refactoring to prevent lang-items duplication (#139)"],["4B6ZRXIQZYCAXEM46BU56RM5IPPH2JCADOTJYW6ALNAK5VQF5YTAC","fix time methods, improve docs, opt crank-indicator"]],"deps":["V4SK5ZKA2N65GGE2HRB4Y6B64BXQ7D62Q3MOERMEE7SN6IGH6ZNQC","CKZVFK24JLPQMVNQ5SEP5VKDJ5K4UFFDHKRWLBPBRXHGDFDCZQWQC","IRPWJFHL6T2Z5AK2RW5EFRJPFKMCCHXV74HKGPZHPFC3QIYI23BAC","4FJROIHD3ZPNVJZ4JRRPZ2RWL7QM6TGSAQV3FBHDVU3LH4OF2NQAC","SDWZKQ7AU2CRPWATMQDADMSW4ZCYZOTV5YILO5T4YSQCZQ7KQVUAC"],"known":["4B6ZRXIQZYCAXEM46BU56RM5IPPH2JCADOTJYW6ALNAK5VQF5YTAC"]},"hunks":[{"Edit":{"inode":{"change":2,"pos":1163},"path":"api/system/src/lib.rs","line":11,"atom":{"NewVertex":{"up_context":[{"change":3,"pos":176}],"down_context":[{"change":2,"pos":1404}],"flag":"BLOCK","start":224,"end":252,"inode":{"change":2,"pos":1163}}},"contents":[{"Add":"use alloc::string::String;"},{"Add":""}]}},{"Replacement":{"inode":{"change":2,"pos":1163},"path":"api/system/src/lib.rs","line":252,"ins":{"up_context":[{"change":2,"pos":9021}],"down_context":[{"change":2,"pos":9023}],"flag":"BLOCK","start":253,"end":1438,"inode":{"change":2,"pos":1163}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":2,"pos":9021},"to":{"change":2,"start":9021,"end":9023},"introduced_by":2}],"inode":{"change":2,"pos":1163}},"ins_contents":[{"Add":""},{"Add":"\t/// Equivalent to [`sys::ffi::playdate_sys::setSerialMessageCallback`]"},{"Add":"\t#[doc(alias = \"sys::ffi::playdate_sys::setSerialMessageCallback\")]"},{"Add":"\tpub fn set_serial_message_callback(&self, callback: Option)"},{"Add":"\t\twhere F: 'static + FnMut(String) + Sized {"},{"Add":"\t\tuse core::ffi::c_char;"},{"Add":"\t\tuse core::ffi::CStr;"},{"Add":"\t\tuse alloc::boxed::Box;"},{"Add":"\t\tuse alloc::string::String;"},{"Add":""},{"Add":""},{"Add":"\t\tstatic mut STORE: Option> = None;"},{"Add":""},{"Add":"\t\tpub unsafe extern \"C\" fn proxy_serial_message_callback(data: *const c_char) {"},{"Add":"\t\t\tlet data = CStr::from_ptr(data as _).to_string_lossy().into_owned();"},{"Add":"\t\t\tif let Some(ref mut f) = STORE.as_mut() {"},{"Add":"\t\t\t\tf(data)"},{"Add":"\t\t\t} else {"},{"Add":"\t\t\t\t// Highly unlikely, mostly impossible case."},{"Add":"\t\t\t\t// Should be unreachable, but still possible in case when"},{"Add":"\t\t\t\t// 0. new callback is None, we have to register it in the System;"},{"Add":"\t\t\t\t// 1. write callback to `STORE`"},{"Add":"\t\t\t\t// 2. interrupt, proxy_serial_message_callback called, BOOM!"},{"Add":"\t\t\t\t// 3. call API::set_serial_message_callback to set our new (None) callback"},{"Add":"\t\t\t\t// So, see difference in how to store & reg callback at couple lines below."},{"Add":"\t\t\t\tpanic!(\"missed callback\")"},{"Add":"\t\t\t}"},{"Add":"\t\t}"},{"Add":""},{"Add":""},{"Add":"\t\tlet f = self.0.set_serial_message_callback();"}],"del_contents":[{"Del":"}\n"}]}},{"Edit":{"inode":{"change":2,"pos":1163},"path":"api/system/src/lib.rs","line":284,"atom":{"NewVertex":{"up_context":[{"change":2,"pos":9024}],"down_context":[{"change":2,"pos":9024}],"flag":"BLOCK","start":1439,"end":1759,"inode":{"change":2,"pos":1163}}},"contents":[{"Add":"\t\tif let Some(callback) = callback {"},{"Add":"\t\t\tlet boxed = Box::new(callback);"},{"Add":"\t\t\t// Store firstly, then register it."},{"Add":"\t\t\tunsafe { STORE = Some(boxed as _) }"},{"Add":"\t\t\tunsafe { f(Some(proxy_serial_message_callback::)) }"},{"Add":"\t\t} else {"},{"Add":"\t\t\t// Set firstly, then clear the `STORE`."},{"Add":"\t\t\tunsafe { f(None) }"},{"Add":"\t\t\tunsafe { STORE = None }"},{"Add":"\t\t}"},{"Add":"\t}"},{"Add":"}"}]}},{"Edit":{"inode":{"change":2,"pos":1163},"path":"api/system/src/lib.rs","line":298,"atom":{"NewVertex":{"up_context":[{"change":2,"pos":9039}],"down_context":[{"change":2,"pos":9039}],"flag":"BLOCK","start":1760,"end":1784,"inode":{"change":2,"pos":1163}}},"contents":[{"Add":"\tuse core::ffi::c_char;"}]}},{"Edit":{"inode":{"change":2,"pos":1163},"path":"api/system/src/lib.rs","line":309,"atom":{"NewVertex":{"up_context":[{"change":5,"pos":414}],"down_context":[{"change":2,"pos":9225}],"flag":"BLOCK","start":1785,"end":1874,"inode":{"change":2,"pos":1163}}},"contents":[{"Add":""},{"Add":""},{"Add":"\tpub type FnSerialMessageCallback = Option;"}]}},{"Edit":{"inode":{"change":2,"pos":1163},"path":"api/system/src/lib.rs","line":468,"atom":{"NewVertex":{"up_context":[{"change":5,"pos":6137}],"down_context":[{"change":5,"pos":6137}],"flag":"BLOCK","start":1875,"end":2213,"inode":{"change":2,"pos":1163}}},"contents":[{"Add":"\t\t}"},{"Add":""},{"Add":"\t\t/// Equivalent to [`sys::ffi::playdate_sys::setSerialMessageCallback`]"},{"Add":"\t\t#[doc(alias = \"sys::ffi::playdate_sys::setSerialMessageCallback\")]"},{"Add":"\t\t#[inline(always)]"},{"Add":"\t\tfn set_serial_message_callback(&self) -> unsafe extern \"C\" fn(callback: FnSerialMessageCallback) {"},{"Add":"\t\t\tself.0.setSerialMessageCallback.expect(\"setSerialMessageCallback\")"}]}},{"Edit":{"inode":{"change":2,"pos":1163},"path":"api/system/src/lib.rs","line":575,"atom":{"NewVertex":{"up_context":[{"change":2,"pos":13658}],"down_context":[{"change":2,"pos":13658}],"flag":"BLOCK","start":2214,"end":2529,"inode":{"change":2,"pos":1163}}},"contents":[{"Add":"\t\t}"},{"Add":""},{"Add":"\t\t/// Equivalent to [`sys::ffi::playdate_sys::setSerialMessageCallback`]"},{"Add":"\t\t#[doc(alias = \"sys::ffi::playdate_sys::setSerialMessageCallback\")]"},{"Add":"\t\t#[inline(always)]"},{"Add":"\t\tfn set_serial_message_callback(&self) -> unsafe extern \"C\" fn(callback: FnSerialMessageCallback) {"},{"Add":"\t\t\t*sys::api!(system.setSerialMessageCallback)"}]}},{"FileAdd":{"meta":{"basename":"set-serial-message-callback.rs","metadata":0},"context":[{"change":4,"pos":13499}],"contents":[{"Add":"#![no_std]"},{"Add":"extern crate alloc;"},{"Add":""},{"Add":"#[macro_use]"},{"Add":"extern crate sys;"},{"Add":"extern crate playdate_system as system;"},{"Add":""},{"Add":"use core::ptr::NonNull;"},{"Add":""},{"Add":"use sys::EventLoopCtrl;"},{"Add":"use sys::ffi::*;"},{"Add":"use system::System;"},{"Add":"use system::event::SystemEventExt as _;"},{"Add":"use system::update::UpdateCtrl;"},{"Add":""},{"Add":""},{"Add":"/// Entry point, event handler"},{"Add":"#[no_mangle]"},{"Add":"fn event_handler(_api: NonNull, event: PDSystemEvent, _: u32) -> EventLoopCtrl {"},{"Add":"\t// Just for this example, ignore all events except init:"},{"Add":"\tif event != PDSystemEvent::Init {"},{"Add":"\t\treturn EventLoopCtrl::Continue;"},{"Add":"\t}"},{"Add":""},{"Add":""},{"Add":"\tlet mut counter: u32 = 0;"},{"Add":""},{"Add":"\tlet callback = move |msg| {"},{"Add":"\t\tcounter += 1;"},{"Add":""},{"Add":"\t\tprintln!(\"[{counter}/3] serial_message_callback: '{}'\", msg);"},{"Add":""},{"Add":"\t\tif counter == 3 {"},{"Add":"\t\t\tprintln!(\"stop receiving serial messages\");"},{"Add":"\t\t\tSystem::Default().set_serial_message_callback(None::);"},{"Add":"\t\t}"},{"Add":"\t};"},{"Add":""},{"Add":"\t// Register callback to start receiving serial messages:"},{"Add":"\tSystem::Default().set_serial_message_callback(Some(callback));"},{"Add":""},{"Add":""},{"Add":"\t// Also set update callback:"},{"Add":"\tSystem::Default().set_update_callback_static(Some(on_update), ());"},{"Add":""},{"Add":"\t// Continue event-loop:"},{"Add":"\tEventLoopCtrl::Continue"},{"Add":"}"},{"Add":""},{"Add":""},{"Add":"/// Update handler"},{"Add":"fn on_update(_: &mut ()) -> UpdateCtrl {"},{"Add":"\t// Continue updates"},{"Add":"\tUpdateCtrl::Continue"},{"Add":"}"},{"Add":""},{"Add":""},{"Add":"// Needed for debug build"},{"Add":"ll_symbols!();"}]}},{"Edit":{"inode":{"change":4,"pos":17338},"path":"api/system/examples/README.md","line":12,"atom":{"NewVertex":{"up_context":[{"change":6,"pos":3660}],"down_context":[{"change":4,"pos":17577}],"flag":"BLOCK","start":3834,"end":3953,"inode":{"change":4,"pos":17338}}},"contents":[{"Add":""},{"Add":"cargo playdate run -p=playdate-system --example=set-serial-message-callback --features=sys/lang-items,sys/entry-point"}]}},{"Edit":{"inode":{"change":2,"pos":14598},"path":"api/system/Cargo.toml","line":47,"atom":{"NewVertex":{"up_context":[{"change":4,"pos":18221}],"down_context":[{"change":6,"pos":3877}],"flag":"BLOCK","start":3956,"end":4149,"inode":{"change":2,"pos":14598}}},"contents":[{"Add":"required-features = [\"sys/entry-point\", \"sys/lang-items\"]"},{"Add":""},{"Add":"[[example]]"},{"Add":"name = \"set-serial-message-callback\""},{"Add":"crate-type = [\"dylib\", \"staticlib\"]"},{"Add":"path = \"examples/set-serial-message-callback.rs\""}]}}],"owner":"fzzr","repo":"playdate","token":"HyWitgdHQu52ZMBxV3f6R7h3UjxEr9iPby6eWPX7WeU=","login":null}

…

Dependencies

Change contents