Rename osx->cocoa

src/cocoa/mod.rs

@@ -0,0 +1,574 @@
+#[cfg(feature = "headless")]
+pub use self::headless::HeadlessContext;
+
+use {CreationError, Event, MouseCursor};
+use CreationError::OsError;
+use libc;
+
+use BuilderAttribs;
+
+use cocoa::base::{Class, id, YES, NO, NSUInteger, nil, objc_allocateClassPair, class, objc_registerClassPair};
+use cocoa::base::{selector, msg_send, msg_send_stret, class_addMethod, class_addIvar};
+use cocoa::base::{object_setInstanceVariable, object_getInstanceVariable};
+use cocoa::appkit;
+use cocoa::appkit::*;
+
+use core_foundation::base::TCFType;
+use core_foundation::string::CFString;
+use core_foundation::bundle::{CFBundleGetBundleWithIdentifier, CFBundleGetFunctionPointerForName};
+
+use std::cell::Cell;
+use std::ffi::{CString, c_str_to_bytes};
+use std::mem;
+use std::ptr;
+use std::collections::RingBuf;
+use std::str::FromStr;
+use std::str::from_utf8;
+use std::ascii::AsciiExt;
+
+use events::Event::{MouseInput, MouseMoved, ReceivedCharacter, KeyboardInput, MouseWheel};
+use events::ElementState::{Pressed, Released};
+use events::MouseButton::{LeftMouseButton, RightMouseButton};
+use events;
+
+pub use self::monitor::{MonitorID, get_available_monitors, get_primary_monitor};
+
+mod monitor;
+mod event;
+
+#[cfg(feature = "headless")]
+mod headless;
+
+static mut shift_pressed: bool = false;
+static mut ctrl_pressed: bool = false;
+static mut win_pressed: bool = false;
+static mut alt_pressed: bool = false;
+
+struct DelegateState<'a> {
+    is_closed: bool,
+    context: id,
+    view: id,
+    window: id,
+    handler: Option<fn(u32, u32)>,
+}
+
+struct WindowDelegate {
+    this: id,
+}
+
+impl WindowDelegate {
+    fn class_name() -> &'static [u8] {
+        b"GlutinWindowDelegate\0"
+    }
+
+    fn state_ivar_name() -> &'static [u8] {
+        b"glutinState"
+    }
+
+    /// Get the delegate class, initiailizing it neccessary
+    fn class() -> Class {
+        use std::sync::{Once, ONCE_INIT};
+        use std::rt;
+
+        extern fn window_should_close(this: id, _: id) -> id {
+            unsafe {
+                let delegate = WindowDelegate { this: this };
+                (*delegate.get_state()).is_closed = true;
+                mem::forget(delegate);
+            }
+            0
+        }
+
+        extern fn window_did_resize(this: id, _: id) -> id {
+            unsafe {
+                let delegate = WindowDelegate { this: this };
+                let state = &mut *delegate.get_state();
+                mem::forget(delegate);
+
+                let _: id = msg_send()(state.context, selector("update"));
+
+                if let Some(handler) = state.handler {
+                    let rect = NSView::frame(state.view);
+                    let scale_factor = state.window.backingScaleFactor() as f32;
+                    (handler)((scale_factor * rect.size.width as f32) as u32,
+                              (scale_factor * rect.size.height as f32) as u32);
+                }
+            }
+            0
+        }
+
+        static mut delegate_class: Class = nil;
+        static mut init: Once = ONCE_INIT;
+
+        unsafe {
+            init.call_once(|| {
+                let ptr_size = mem::size_of::<libc::intptr_t>();
+                    // Create new NSWindowDelegate
+                    delegate_class = objc_allocateClassPair(
+                        class("NSObject"),
+                        WindowDelegate::class_name().as_ptr() as *const i8, 0);
+                    // Add callback methods
+                    class_addMethod(delegate_class,
+                                    selector("windowShouldClose:"),
+                                    window_should_close,
+                                    CString::from_slice("B@:@".as_bytes()).as_ptr());
+                    class_addMethod(delegate_class,
+                                    selector("windowDidResize:"),
+                                    window_did_resize,
+                                    CString::from_slice("V@:@".as_bytes()).as_ptr());
+                    // Store internal state as user data
+                    class_addIvar(delegate_class, WindowDelegate::state_ivar_name().as_ptr() as *const i8,
+                                  ptr_size as u64, 3,
+                                  CString::from_slice("?".as_bytes()).as_ptr());
+                    objc_registerClassPair(delegate_class);
+                // Free class at exit
+                rt::at_exit(|| {
+                    // objc_disposeClassPair(delegate_class);
+                });
+            });
+            delegate_class
+        }
+    }
+
+    fn new(window: id) -> WindowDelegate {
+        unsafe {
+            let delegate: id = msg_send()(WindowDelegate::class(), selector("new"));
+            let _: id = msg_send()(window, selector("setDelegate:"), delegate);
+            WindowDelegate { this: delegate }
+        }
+    }
+
+    unsafe fn set_state(&self, state: *mut DelegateState) {
+        object_setInstanceVariable(self.this,
+                                   WindowDelegate::state_ivar_name().as_ptr() as *const i8,
+                                   state as *mut libc::c_void);
+    }
+
+    fn get_state(&self) -> *mut DelegateState {
+        unsafe {
+            let mut state = ptr::null_mut();
+            object_getInstanceVariable(self.this,
+                                       WindowDelegate::state_ivar_name().as_ptr() as *const i8,
+                                       &mut state);
+            state as *mut DelegateState
+        }
+    }
+}
+
+pub struct Window {
+    view: id,
+    window: id,
+    context: id,
+    delegate: WindowDelegate,
+    resize: Option<fn(u32, u32)>,
+
+    is_closed: Cell<bool>,
+}
+
+#[cfg(feature = "window")]
+unsafe impl Send for Window {}
+#[cfg(feature = "window")]
+unsafe impl Sync for Window {}
+
+#[cfg(feature = "window")]
+#[derive(Clone)]
+pub struct WindowProxy;
+
+impl WindowProxy {
+    pub fn wakeup_event_loop(&self) {
+        unsafe {
+            let pool = NSAutoreleasePool::new(nil);
+            let event =
+                NSEvent::otherEventWithType_location_modifierFlags_timestamp_windowNumber_context_subtype_data1_data2(
+                    nil, NSApplicationDefined, NSPoint::new(0.0, 0.0), 0, 0.0, 0, ptr::null_mut(), 0, 0, 0);
+            NSApp().postEvent_atStart_(event, YES);
+            pool.drain();
+        }
+    }
+}
+
+impl Window {
+    #[cfg(feature = "window")]
+    pub fn new(builder: BuilderAttribs) -> Result<Window, CreationError> {
+        if builder.sharing.is_some() {
+            unimplemented!()
+        }
+
+        let app = match Window::create_app() {
+            Some(app) => app,
+            None      => { return Err(OsError(format!("Couldn't create NSApplication"))); },
+        };
+        let window = match Window::create_window(builder.dimensions.unwrap_or((800, 600)),
+                                                 &*builder.title,
+                                                 builder.monitor)
+        {
+            Some(window) => window,
+            None         => { return Err(OsError(format!("Couldn't create NSWindow"))); },
+        };
+        let view = match Window::create_view(window) {
+            Some(view) => view,
+            None       => { return Err(OsError(format!("Couldn't create NSView"))); },
+        };
+
+        let context = match Window::create_context(view, builder.vsync, builder.gl_version) {
+            Some(context) => context,
+            None          => { return Err(OsError(format!("Couldn't create OpenGL context"))); },
+        };
+
+        unsafe {
+            app.activateIgnoringOtherApps_(YES);
+            if builder.visible {
+                window.makeKeyAndOrderFront_(nil);
+            } else {
+                window.makeKeyWindow();
+            }
+        }
+
+        let window = Window {
+            view: view,
+            window: window,
+            context: context,
+            delegate: WindowDelegate::new(window),
+            resize: None,
+
+            is_closed: Cell::new(false),
+        };
+
+        Ok(window)
+    }
+
+    fn create_app() -> Option<id> {
+        unsafe {
+            let app = NSApp();
+            if app == nil {
+                None
+            } else {
+                app.setActivationPolicy_(NSApplicationActivationPolicyRegular);
+                app.finishLaunching();
+                Some(app)
+            }
+        }
+    }
+
+    fn create_window(dimensions: (u32, u32), title: &str, monitor: Option<MonitorID>) -> Option<id> {
+        unsafe {
+            let frame = if monitor.is_some() {
+                let screen = NSScreen::mainScreen(nil);
+                NSScreen::frame(screen)
+            } else {
+                let (width, height) = dimensions;
+                NSRect::new(NSPoint::new(0., 0.), NSSize::new(width as f64, height as f64))
+            };
+
+            let masks = if monitor.is_some() {
+                NSBorderlessWindowMask as NSUInteger
+            } else {
+                NSTitledWindowMask as NSUInteger |
+                NSClosableWindowMask as NSUInteger |
+                NSMiniaturizableWindowMask as NSUInteger |
+                NSResizableWindowMask as NSUInteger
+            };
+
+            let window = NSWindow::alloc(nil).initWithContentRect_styleMask_backing_defer_(
+                frame,
+                masks,
+                NSBackingStoreBuffered,
+                NO,
+            );
+
+            if window == nil {
+                None
+            } else {
+                let title = NSString::alloc(nil).init_str(title);
+                window.setTitle_(title);
+                window.setAcceptsMouseMovedEvents_(YES);
+                if monitor.is_some() {
+                    window.setLevel_(NSMainMenuWindowLevel as i64 + 1);
+                }
+                else {
+                    window.center();
+                }
+                Some(window)
+            }
+        }
+    }
+
+    fn create_view(window: id) -> Option<id> {
+        unsafe {
+            let view = NSView::alloc(nil).init();
+            if view == nil {
+                None
+            } else {
+                view.setWantsBestResolutionOpenGLSurface_(YES);
+                window.setContentView_(view);
+                Some(view)
+            }
+        }
+    }
+
+    fn create_context(view: id, vsync: bool, gl_version: Option<(u32, u32)>) -> Option<id> {
+        let profile = match gl_version {
+            None | Some((0...2, _)) | Some((3, 0)) => NSOpenGLProfileVersionLegacy as u32,
+            Some((3, 1...2)) => NSOpenGLProfileVersion3_2Core as u32,
+            Some((_, _)) => NSOpenGLProfileVersion4_1Core as u32,
+        };
+        unsafe {
+            let attributes = [
+                NSOpenGLPFADoubleBuffer as u32,
+                NSOpenGLPFAClosestPolicy as u32,
+                NSOpenGLPFAColorSize as u32, 24,
+                NSOpenGLPFAAlphaSize as u32, 8,
+                NSOpenGLPFADepthSize as u32, 24,
+                NSOpenGLPFAStencilSize as u32, 8,
+                NSOpenGLPFAOpenGLProfile as u32, profile,
+                0
+            ];
+
+            let pixelformat = NSOpenGLPixelFormat::alloc(nil).initWithAttributes_(&attributes);
+            if pixelformat == nil {
+                return None;
+            }
+
+            let context = NSOpenGLContext::alloc(nil).initWithFormat_shareContext_(pixelformat, nil);
+            if context == nil {
+                None
+            } else {
+                context.setView_(view);
+                if vsync {
+                    let value = 1;
+                    context.setValues_forParameter_(&value, NSOpenGLContextParameter::NSOpenGLCPSwapInterval);
+                }
+                Some(context)
+            }
+        }
+    }
+
+    pub fn is_closed(&self) -> bool {
+        self.is_closed.get()
+    }
+
+    pub fn set_title(&self, title: &str) {
+        unsafe {
+            let title = NSString::alloc(nil).init_str(title);
+            self.window.setTitle_(title);
+        }
+    }
+
+    pub fn show(&self) {
+        unsafe { NSWindow::makeKeyAndOrderFront_(self.window, nil); }
+    }
+
+    pub fn hide(&self) {
+        unsafe { NSWindow::orderOut_(self.window, nil); }
+    }
+
+    pub fn get_position(&self) -> Option<(i32, i32)> {
+        unsafe {
+            // let content_rect = NSWindow::contentRectForFrameRect_(self.window, NSWindow::frame(self.window));
+            let content_rect: NSRect = msg_send_stret()(self.window,
+                                                        selector("contentRectForFrameRect:"),
+                                                        NSWindow::frame(self.window));
+            // NOTE: coordinate system might be inconsistent with other backends
+            Some((content_rect.origin.x as i32, content_rect.origin.y as i32))
+        }
+    }
+
+    pub fn set_position(&self, x: i32, y: i32) {
+        unsafe {
+            // NOTE: coordinate system might be inconsistent with other backends
+            NSWindow::setFrameOrigin_(self.window, NSPoint::new(x as f64, y as f64));
+        }
+    }
+
+    pub fn get_inner_size(&self) -> Option<(u32, u32)> {
+        unsafe {
+            let view_frame = NSView::frame(self.view);
+            Some((view_frame.size.width as u32, view_frame.size.height as u32))
+        }
+    }
+
+    pub fn get_outer_size(&self) -> Option<(u32, u32)> {
+        unsafe {
+            let window_frame = NSWindow::frame(self.window);
+            Some((window_frame.size.width as u32, window_frame.size.height as u32))
+        }
+    }
+
+    pub fn set_inner_size(&self, width: u32, height: u32) {
+        unsafe {
+            NSWindow::setContentSize_(self.window, NSSize::new(width as f64, height as f64));
+        }
+    }
+
+    pub fn create_window_proxy(&self) -> WindowProxy {
+        WindowProxy
+    }
+
+    pub fn poll_events(&self) -> RingBuf<Event> {
+        let mut events = RingBuf::new();
+
+        loop {
+            unsafe {
+                let event = NSApp().nextEventMatchingMask_untilDate_inMode_dequeue_(
+                    NSAnyEventMask as u64,
+                    NSDate::distantPast(nil),
+                    NSDefaultRunLoopMode,
+                    YES);
+                if event == nil { break; }
+                {
+                    // Create a temporary structure with state that delegates called internally
+                    // by sendEvent can read and modify. When that returns, update window state.
+                    // This allows the synchronous resize loop to continue issuing callbacks
+                    // to the user application, by passing handler through to the delegate state.
+                    let mut ds = DelegateState {
+                        is_closed: self.is_closed.get(),
+                        context: self.context,
+                        window: self.window,
+                        view: self.view,
+                        handler: self.resize,
+                    };
+                    self.delegate.set_state(&mut ds);
+                    NSApp().sendEvent_(event);
+                    self.delegate.set_state(ptr::null_mut());
+                    self.is_closed.set(ds.is_closed);
+                }
+
+                match event.get_type() {
+                    NSLeftMouseDown         => { events.push_back(MouseInput(Pressed, LeftMouseButton)); },
+                    NSLeftMouseUp           => { events.push_back(MouseInput(Released, LeftMouseButton)); },
+                    NSRightMouseDown        => { events.push_back(MouseInput(Pressed, RightMouseButton)); },
+                    NSRightMouseUp          => { events.push_back(MouseInput(Released, RightMouseButton)); },
+                    NSMouseMoved            => {
+                        let window_point = event.locationInWindow();
+                        let window: id = msg_send()(event, selector("window"));
+                        let view_point = if window == 0 {
+                            let window_rect = self.window.convertRectFromScreen_(NSRect::new(window_point, NSSize::new(0.0, 0.0)));
+                            self.view.convertPoint_fromView_(window_rect.origin, nil)
+                        } else {
+                            self.view.convertPoint_fromView_(window_point, nil)
+                        };
+                        let view_rect = NSView::frame(self.view);
+                        let scale_factor = self.hidpi_factor();
+                        events.push_back(MouseMoved(((scale_factor * view_point.x as f32) as i32,
+                                                     (scale_factor * (view_rect.size.height - view_point.y) as f32) as i32)));
+                    },
+                    NSKeyDown               => {
+                        let received_c_str = event.characters().UTF8String();
+                        let received_str = CString::from_slice(c_str_to_bytes(&received_c_str));
+                        for received_char in from_utf8(received_str.as_bytes()).unwrap().chars() {
+                            if received_char.is_ascii() {
+                                events.push_back(ReceivedCharacter(received_char));
+                            }
+                        }
+
+                        let vkey =  event::vkeycode_to_element(event.keycode());
+                        events.push_back(KeyboardInput(Pressed, event.keycode() as u8, vkey));
+                    },
+                    NSKeyUp                 => {
+                        let vkey =  event::vkeycode_to_element(event.keycode());
+                        events.push_back(KeyboardInput(Released, event.keycode() as u8, vkey));
+                    },
+                    NSFlagsChanged          => {
+                        let shift_modifier = Window::modifier_event(event, appkit::NSShiftKeyMask as u64, events::VirtualKeyCode::LShift, shift_pressed);
+                        if shift_modifier.is_some() {
+                            shift_pressed = !shift_pressed;
+                            events.push_back(shift_modifier.unwrap());
+                        }
+                        let ctrl_modifier = Window::modifier_event(event, appkit::NSControlKeyMask as u64, events::VirtualKeyCode::LControl, ctrl_pressed);
+                        if ctrl_modifier.is_some() {
+                            ctrl_pressed = !ctrl_pressed;
+                            events.push_back(ctrl_modifier.unwrap());
+                        }
+                        let win_modifier = Window::modifier_event(event, appkit::NSCommandKeyMask as u64, events::VirtualKeyCode::LWin, win_pressed);
+                        if win_modifier.is_some() {
+                            win_pressed = !win_pressed;
+                            events.push_back(win_modifier.unwrap());
+                        }
+                        let alt_modifier = Window::modifier_event(event, appkit::NSAlternateKeyMask as u64, events::VirtualKeyCode::LAlt, alt_pressed);
+                        if alt_modifier.is_some() {
+                            alt_pressed = !alt_pressed;
+                            events.push_back(alt_modifier.unwrap());
+                        }
+                    },
+                    NSScrollWheel           => { events.push_back(MouseWheel(-event.scrollingDeltaY() as i32)); },
+                    NSOtherMouseDown        => { },
+                    NSOtherMouseUp          => { },
+                    NSOtherMouseDragged     => { },
+                    _                       => { },
+                }
+            }
+        }
+        events
+    }
+
+    unsafe fn modifier_event(event: id, keymask: u64, key: events::VirtualKeyCode, key_pressed: bool) -> Option<Event> {
+        if !key_pressed && Window::modifier_key_pressed(event, keymask) {
+            return Some(KeyboardInput(Pressed, event.keycode() as u8, Some(key)));
+        }
+        else if key_pressed && !Window::modifier_key_pressed(event, keymask) {
+            return Some(KeyboardInput(Released, event.keycode() as u8, Some(key)));
+        }
+
+        return None;
+    }
+
+    unsafe fn modifier_key_pressed(event: id, modifier: u64) -> bool {
+        event.modifierFlags() & modifier != 0
+    }
+
+    pub fn wait_events(&self) -> RingBuf<Event> {
+        unsafe {
+            let event = NSApp().nextEventMatchingMask_untilDate_inMode_dequeue_(
+                NSAnyEventMask as u64,
+                NSDate::distantFuture(nil),
+                NSDefaultRunLoopMode,
+                NO);
+            NSApp().sendEvent_(event);
+
+            self.poll_events()
+        }
+    }
+
+    pub unsafe fn make_current(&self) {
+        let _: id = msg_send()(self.context, selector("update"));
+        self.context.makeCurrentContext();
+    }
+
+    pub fn get_proc_address(&self, _addr: &str) -> *const () {
+        let symbol_name: CFString = FromStr::from_str(_addr).unwrap();
+        let framework_name: CFString = FromStr::from_str("com.apple.opengl").unwrap();
+        let framework = unsafe {
+            CFBundleGetBundleWithIdentifier(framework_name.as_concrete_TypeRef())
+        };
+        let symbol = unsafe {
+            CFBundleGetFunctionPointerForName(framework, symbol_name.as_concrete_TypeRef())
+        };
+        symbol as *const ()
+    }
+
+    pub fn swap_buffers(&self) {
+        unsafe { self.context.flushBuffer(); }
+    }
+
+    pub fn platform_display(&self) -> *mut libc::c_void {
+        unimplemented!()
+    }
+
+    pub fn get_api(&self) -> ::Api {
+        ::Api::OpenGl
+    }
+
+    pub fn set_window_resize_callback(&mut self, callback: Option<fn(u32, u32)>) {
+        self.resize = callback;
+    }
+
+    pub fn set_cursor(&self, cursor: MouseCursor) {
+        unimplemented!()
+    }
+
+    pub fn hidpi_factor(&self) -> f32 {
+        unsafe {
+            self.window.backingScaleFactor() as f32
+        }
+    }
+}