path: root/src/xtoq/XtoqController.h

/*Copyright (C) 2012 Aaron Skomra, Braden Wooley, Ben Huddle

   Permission is hereby granted, free of charge, to any person obtaining a copy of
   this software and associated documentation files (the "Software"), to deal in
   the Software without restriction, including without limitation the rights to
   use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
   of the Software, and to permit persons to whom the Software is furnished to do
   so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included in all
   copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   SOFTWARE.
 */

/**
 *  AppController.h
 *  xcwm
 *
 *  TODO: rename this class to XtoqController
 *  This was controller for the Popup to retreive the display number
 *  from the user.
 *
 *  This is the window controller // clean up some of the names
 */

#import <Foundation/Foundation.h>
#import <Cocoa/Cocoa.h>
#include <CoreServices/CoreServices.h> // timestamp
#import <AppKit/AppKit.h>
#import "XtoqWindow.h"
#import "XtoqImageRep.h"
#import "XtoqView.h"
#import <xcwm/xcwm.h>
#import "spawn.h"
#import "crt_externs.h"
#import "sys/times.h"
#import "sys/stat.h"
#import "unistd.h"
#import <dispatch/dispatch.h>

#ifdef __APPLE__
#define environ (*_NSGetEnviron())
#endif

id referenceToSelf;

@interface XtoqController : NSObject {
    XtoqWindow *xcwmWindow;
    XtoqView * ourView;

    dispatch_queue_t xcwmDispatchQueue;

    //The X :1 paramater, updated in the XtoqApplication
    char *screen;

    xcwm_image_t *libImageT;
    xcwm_context_t *rootContext;
    xcb_image_t *imageT;
    XtoqImageRep *image;
    XtoqImageRep *imageNew;
    XtoqView *view;

    int originalHeight;
    int originalWidth;
    NSRect imageRec;
}

/**
 * Initialize
 */
- (id)init;

/**
 * Sent by the default notification center immediately before the
 * application object is initialized.
 * @param A notification named NSApplicationWillFinishLaunchingNotification.
 *        Calling the object method of this notification returns the
 *        NSApplication object itself.
 */
- (void)applicationWillFinishLaunching:(NSNotification *)aNotification;

/**
 * Sent by the default notification center after the application has been
 * launched and initialized but before it has received its first event.
 * @param A notification named NSApplicationWillFinishLaunchingNotification.
 *        Calling the object method of this notification returns the
 *        NSApplication object itself.
 */
- (void)applicationDidFinishLaunching: (NSNotification *)aNotification;

/**
 * Receive notification of a key down event from the view.
 * @param an NSNotification containing an NSEvent
 */
- (void)keyDownInView: (NSNotification *)aNotification;

/**
 * Receive notification of a key up event from the view.
 * @param an NSNotification containing an NSEvent
 */
- (void)keyUpInView: (NSNotification *)aNotification;

/**
 * Receive notification of a mouse button press from the view.
 * @param an NSNotification containing an NSEvent
 */
- (void)mouseButtonDownInView: (NSNotification *)aNotification;

/**
 * Receive notification of a mouse button release from the view.
 * @param an NSNotification containing an NSEvent
 */
- (void)mouseButtonReleaseInView: (NSNotification *)aNotification;

/**
 * Make menu and related selector functions for launching X applications.
 */
- (void)makeMenu;

/**
 * Launches the application based on filename.
 * Launches the selected application based on the filename passed in as an
 * argument.  Uses posix_spawn() to launch the application after the arguments
 * have been filled in.
 * @param filename The name of the application to be run within XtoQ.app.
 */
- (void)launch_client: (NSString *)filename;

/**
 * Runs xeyes.
 * Sends "xeyes" argument to the launch client function to open up the
 * application xeyes within XtoQ.app.
 * @param sender Only needed for functionality with Makemenu's menu system.
 */
- (void)runXeyes: (id)sender;

/**
 * Runs xclock.
 * Sends "xclock" argument to the launch client function to open up the
 * application xclock within XtoQ.app.
 * @param sender Only needed for functionality with Makemenu's menu system.
 */
- (void)runXclock: (id)sender;

/**
 * Runs xlogo.
 * Sends "xlogo" argument to the launch client function to open up the
 * application xlogo within XtoQ.app.
 * @param sender Only needed for functionality with Makemenu's menu system.
 */
- (void)runXlogo: (id)sender;

/**
 * Receive notification of mouse movement from the app
 * @param aNotification A notification containing an NSEvent
 */
- (void)mouseMovedInApp: (NSNotification *)aNotification;

/**
 * Runs xterm.
 * Sends "xterm" argument to the launch client function to open up the
 * application xterm within XtoQ.app.
 * @param sender Only needed for functionality with Makemenu's menu system.
 */
- (void)runXterm: (id)sender;

/**
 * Runs xman
 * Sends "xman" argument to the launch client function to open up the
 * application xman within XtoQ.app.
 * @param sender Olny needed for functionality with Makemenu's menu system.
 */
-(void)runXman: (id)sender;

/**
 * Put a new image in the window / view. Send an image to the view
 * after being notified of a damage event from the event handler.
 * @param window The xcwm_window_t sent from eventHandler
 */
- (void)updateImage: (xcwm_window_t *)window;

/**
 * Creates a new window
 * @param window The xcwm_window_t sent from eventHandler
 *
 */
- (void)createNewWindow: (xcwm_window_t *)window;

/**
 * Closes the window
 * @param window The window to destroy, sent from eventHandler
 */
- (void)destroyWindow: (xcwm_window_t *)window;

/**
 * Send request to close
 * @param an NSNotification containing an NSEvent
 */
- (void)destroy:(NSNotification *)aNotification;

/**
 * Sets the variable screen to correct display.
 * Sets class variable screen to correct display and also sets the environment
 * variable "DISPLAY" to correct value.
 * @param scrn This value is determined in XtoqApplication before connection
 *   to Xorg is established.
 */
- (void)setScreen: (char *)scrn;

//- (void)windowWillMove:(NSNotification*)notification;

/**
 * Informs the delegate that the window has been moved.
 * @param notification A notification named NSWindowDidMoveNotification.
 */
- (void)windowDidMove:(NSNotification *)notification;

/**
 * Informs the delegate that the window has been resized.
 * @param notification A notification named NSWindowDidResizeNotification.
 */
- (void)windowDidResize:(NSNotification *)notification;

/**
 * Sent by the default notification center immediately before
 * the application terminates.
 * @param aNotification A notification named
 *        NSApplicationWillTerminateNotification. Calling the
 *        object method of this notification returns the
 *        NSApplication object itself.
 */
- (void)applicationWillTerminate:(NSNotification *)aNotification;

/**
 * Reshapes the window
 */
- (void)reshape;

/**
 * Converts the Xserver y value to the OSX coordinate system
 * @param yValue an int value of the y coordinat
 * @param windowH int value of the window eight
 * @return an int that has been converted
 */
- (int)xserverToOSX:(int)yValue windowHeight:(int)windowH;

/**
 * Converts the OSX y value to the Xserver coordinate system
 * @param yValue an int value of the y coordinat
 * @param windowH int value of the window eight
 * @return an int that has been converted
 */
- (int)osxToXserver:(int)yValue windowHeight:(int)windowH;

/**
 * Handler for XCWM_WINDOW_NAME event. Updates the name of the window.
 * @param window The window whose name needs updating.
 */
- (void)updateWindowName:(xcwm_window_t *)window;


/**
 * Handler for window miniaturize events.
 * @param notification Notification object for this event.
 */
- (void)windowDidMiniaturize:(NSNotification *)notification;

/**
 * Handler for window de-miniaturize events.
 * @param notification Notification object for this event.
 */
- (void)windowDidDeminiaturize:(NSNotification *)notification;

@end

/**
 * Callback function that will receive events from the xtoq event loop
 * once it is started.
 * @param event The event received.
 */
void
eventHandler(xcwm_event_t *event);