WindowController.c

Go to the documentation of this file.

/*
 * ObjectivelyMVC: Object oriented MVC framework for SDL3 and C.
 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#include <assert.h>
 
#include <Objectively/String.h>
 
#include "Log.h"
#include "TextView.h"
#include "WindowController.h"
 
#define _Class _WindowController
 
#pragma mark - Delegates
 
static void mouseMotion_enumerate(View *view, ident data) {
 
  const SDL_MouseMotionEvent *event = data;
  const SDL_Point a = MakePoint(event->x - event->xrel, event->y - event->yrel);
  const SDL_Point b = MakePoint(event->x, event->y);
 
  if ($(view, containsPoint, &a) && !$(view, containsPoint, &b)) {
    $(view, emitViewEvent, ViewEventMouseLeave, NULL);
    $(view, invalidateStyle);
  } else if ($(view, containsPoint, &b) && !$(view, containsPoint, &a)) {
    $(view, emitViewEvent, ViewEventMouseEnter, NULL);
    $(view, invalidateStyle);
  }
}
 
#pragma mark - Object
 
static void dealloc(Object *self) {
 
  WindowController *this = (WindowController *) self;
 
  release(this->debugViewController);
  release(this->renderer);
  release(this->theme);
  release(this->viewController);
 
  super(Object, self, dealloc);
}
 
#pragma mark - WindowController
 
static void debug(WindowController *self) {
 
  if (self->viewController && self->debugViewController) {
 
    ViewController *debugViewController = (ViewController *) self->debugViewController;
 
    float mx, my;
    SDL_GetMouseState(&mx, &my);
    SDL_Point point = MakePoint(mx, my);
 
    View *view = $(self->viewController->view, hitTest, &point);
    if (view) {
      $(self->debugViewController, debug, view, self->renderer);
    }
 
    $(debugViewController->view, applyThemeIfNeeded, self->theme);
    $(debugViewController->view, layoutIfNeeded);
 
    MVC_InvalidateRenderFrames();
 
    $(debugViewController->view, draw, self->renderer);
  }
}
 
static View *keyResponder(const WindowController *self) {
  return SDL_GetPointerProperty(SDL_GetWindowProperties(self->window), "keyResponder", NULL);
}
 
static void enumerateKeyResponders(View *view, ident data) {
 
  if ($(view, acceptsKeyResponder) && $(view, isVisible)) {
    $((Array *) data, addObject, view);
  }
}
 
static Array *keyResponders(const WindowController *self) {
 
  Array *array = (Array *) $(alloc(Array), init);
  $(self->viewController->view, enumerateDescendants, enumerateKeyResponders, array);
 
  return array;
}
 
static WindowController *initWithDevice(WindowController *self, RenderDevice *device) {
 
  assert(device);
 
  self = (WindowController *) super(Object, self, init);
  if (self) {
    self->renderer = $(alloc(Renderer), initWithDevice, device);
    assert(self->renderer);
 
    $(self, setWindow, device->window);
    $(self, setViewController, NULL);
    $(self, setTheme, NULL);
 
    $(self->renderer, renderDeviceDidReset);
    $(self->viewController, renderDeviceDidReset);
    $(self->theme, renderDeviceDidReset);
  }
 
  return self;
}
 
static void render(WindowController *self) {
 
  assert(self->renderer);
 
  const RenderDevice *device = self->renderer->device;
  $(self, renderTo, device->commands, device->framebuffer);
}
 
static void renderTo(WindowController *self, CommandBuffer *commands, Framebuffer *framebuffer) {
 
  assert(self->renderer);
  assert(commands);
  assert(framebuffer);
 
  $(self->renderer, beginFrameWith, commands, framebuffer);
 
  $(self->viewController->view, applyThemeIfNeeded, self->theme);
  $(self->viewController->view, layoutIfNeeded);
 
  MVC_InvalidateRenderFrames();
 
  $(self->viewController->view, draw, self->renderer);
 
  $(self, debug);
 
  $(self->renderer, endFrame);
}
 
static View *nextKeyResponder(const WindowController *self, View *keyResponder) {
 
  View *next = NULL;
 
  Array *array = $(self, keyResponders);
 
  if (array->count) {
    if (keyResponder && $(array, containsObject, keyResponder)) {
      const ssize_t index = $(array, indexOfObject, keyResponder);
      next = $(array, objectAtIndex, (index + 1) % array->count);
    } else {
      next = $(array, firstObject);
    }
  }
 
  release(array);
  return next;
}
 
static View *previousKeyResponder(const WindowController *self, View *keyResponder) {
 
  View *prev = NULL;
 
  Array *array = $(self, keyResponders);
 
  if (array->count) {
    if (keyResponder && $(array, containsObject, keyResponder)) {
      const ssize_t index = $(array, indexOfObject, keyResponder);
      prev = $(array, objectAtIndex, (index + array->count - 1) % array->count);
    } else {
      prev = $(array, firstObject);
    }
  }
 
  release(array);
  return prev;
}
 
static void respondToEvent(WindowController *self, const SDL_Event *event) {
 
  if (event->type >= SDL_EVENT_WINDOW_FIRST && event->type <= SDL_EVENT_WINDOW_LAST) {
    if (event->window.windowID != SDL_GetWindowID(self->window)) {
      return;
    }
  }
 
  SDL_SetPointerProperty(SDL_GetWindowProperties(self->window), "event", (ident) event);
 
  switch (event->type) {
    case SDL_EVENT_WINDOW_MOVED:
    case SDL_EVENT_WINDOW_RESIZED:
    case SDL_EVENT_WINDOW_MAXIMIZED:
    case SDL_EVENT_WINDOW_RESTORED:
    case SDL_EVENT_WINDOW_SAFE_AREA_CHANGED:
      $(self, setWindow, self->window);
      break;
    case SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED:
    case SDL_EVENT_WINDOW_DISPLAY_CHANGED:
    case SDL_EVENT_WINDOW_DISPLAY_SCALE_CHANGED: {
      $(self, setWindow, self->window);
 
      $(self->viewController, renderDeviceWillReset);
      $(self->viewController, renderDeviceDidReset);
      $(self->viewController->view, updateBindings, NULL);
      $(self->theme, renderDeviceWillReset);
      $(self->theme, renderDeviceDidReset);
 
      if (self->debugViewController) {
        ViewController *debugViewController = (ViewController *) self->debugViewController;
        $(debugViewController, renderDeviceWillReset);
        $(debugViewController, renderDeviceDidReset);
        $(debugViewController->view, updateBindings, NULL);
      }
    }
      break;
    case SDL_EVENT_WINDOW_DESTROYED:
    case SDL_EVENT_WINDOW_CLOSE_REQUESTED:
      $(self->renderer, renderDeviceWillReset);
      $(self->viewController, renderDeviceWillReset);
      $(self->theme, renderDeviceWillReset);
      break;
    default:
      break;
  }
 
  if (event->type == SDL_EVENT_MOUSE_MOTION) {
    $(self->viewController->view, enumerateVisible, mouseMotion_enumerate, (ident) event);
  }
 
  View *keyResponder = $(self, keyResponder), *touchResponder = $(self, touchResponder);
  
  View *touchTarget = $(self, touchTarget, event);
  
  switch (event->type) {
    case SDL_EVENT_KEY_UP:
    case SDL_EVENT_KEY_DOWN:
    case SDL_EVENT_TEXT_INPUT:
      if (keyResponder) {
        $(keyResponder, respondToEvent, event);
      } else {
        $(self->viewController, respondToEvent, event);
      }
      break;
    case SDL_EVENT_MOUSE_BUTTON_DOWN:
      if (touchTarget) {
        $(touchTarget, becomeTouchResponder);
        $(touchTarget, respondToEvent, event);
      } else if (touchResponder) {
        $(touchResponder, respondToEvent, event);
        $(touchResponder, resignTouchResponder);
      } else {
        $(self->viewController, respondToEvent, event);
      }
      
      touchResponder = $(self, touchResponder);
      if (touchResponder && keyResponder && touchResponder != keyResponder) {
        $(keyResponder, resignKeyResponder);
      }
      break;
    case SDL_EVENT_MOUSE_BUTTON_UP:
      if (touchResponder) {
        $(touchResponder, respondToEvent, event);
      } else if (touchTarget) {
        $(touchTarget, respondToEvent, event);
      } else {
        $(self->viewController, respondToEvent, event);
      }
      break;
    case SDL_EVENT_MOUSE_MOTION:
    case SDL_EVENT_MOUSE_WHEEL:
      if (touchResponder) {
        $(touchResponder, respondToEvent, event);
      } else if (touchTarget) {
        $(touchTarget, respondToEvent, event);
      } else {
        $(self->viewController, respondToEvent, event);
      }
      break;
    default:
      $(self->viewController, respondToEvent, event);
      break;
  }
 
  if (event->type == SDL_EVENT_KEY_DOWN) {
    if (event->key.key == SDLK_TAB || event->key.key == SDLK_KP_TAB) {
 
      View *current = $(self, keyResponder);
 
      // An editing TextView that is still the key responder kept Tab to auto-complete
      const bool consumed = current && current == keyResponder &&
        $((Object *) current, isKindOfClass, _TextView()) &&
        ((TextView *) current)->isEditable &&
        !$((Control *) current, isDisabled);
 
      if (!consumed) {
        if (event->key.mod & SDL_KMOD_SHIFT) {
          keyResponder = $(self, previousKeyResponder, keyResponder);
        } else {
          keyResponder = $(self, nextKeyResponder, keyResponder);
        }
 
        if (keyResponder) {
          $(keyResponder, becomeKeyResponder);
        }
      }
    }
 
    if (event->key.key == SDLK_D) {
      if (event->key.mod & SDL_KMOD_CTRL) {
        $(self, toggleDebugger);
      }
    }
  }
 
  SDL_SetPointerProperty(SDL_GetWindowProperties(self->window), "event", NULL);
}
 
static void setTheme(WindowController *self, Theme *theme) {
 
  if (self->theme != theme || self->theme == NULL) {
 
    release(self->theme);
 
    if (theme) {
      self->theme = retain(theme);
    } else {
      self->theme = $(alloc(Theme), init);
    }
  }
 
  $(self->viewController->view, invalidateStyle);
}
 
static void setViewController(WindowController *self, ViewController *viewController) {
 
  if (self->viewController != viewController || self->viewController == NULL) {
 
    SDL_SetPointerProperty(SDL_GetWindowProperties(self->window), "keyResponder", NULL);
 
    if (self->viewController) {
      $(self->viewController, viewWillDisappear);
      $(self->viewController->view, moveToWindow, NULL);
      $(self->viewController, viewDidDisappear);
    }
 
    release(self->viewController);
 
    if (viewController) {
      self->viewController = retain(viewController);
    } else {
      self->viewController = $(alloc(ViewController), init);
    }
 
    $(self->viewController, loadViewIfNeeded);
 
    $(self->viewController, viewWillAppear);
    $(self->viewController->view, moveToWindow, self->window);
    $(self->viewController, viewDidAppear);
  }
}
 
static void setWindow(WindowController *self, SDL_Window *window) {
 
  assert(window);
 
  self->window = window;
 
  SDL_PropertiesID properties = SDL_GetWindowProperties(self->window);
  
  SDL_SetPointerProperty(properties, "windowController", self);
  SDL_SetPointerProperty(properties, "keyResponder", NULL);
  SDL_SetPointerProperty(properties, "touchResponder", NULL);
 
  if (self->renderer) {
    $(self->renderer->device, setWindow, self->window);
  }
 
  if (self->viewController) {
    $(self->viewController->view, moveToWindow, self->window);
  }
 
  if (self->debugViewController) {
    $(self->debugViewController->viewController.view, moveToWindow, self->window);
  }
}
 
static void toggleDebugger(WindowController *self) {
 
  if (self->debugViewController == NULL) {
 
    self->debugViewController = $(alloc(DebugViewController), init);
    assert(self->debugViewController);
 
    ViewController *debugViewController = (ViewController *) self->debugViewController;
 
    $(debugViewController, loadView);
    $(debugViewController, viewWillAppear);
    $(debugViewController->view, moveToWindow, self->window);
    $(debugViewController, viewDidAppear);
 
    if (self->viewController) {
      $(self->viewController->view, addClassName, "debug");
    }
  } else {
    self->debugViewController = release(self->debugViewController);
 
    if (self->viewController) {
      $(self->viewController->view, removeClassName, "debug");
    }
  }
}
 
static View *touchResponder(const WindowController *self) {
  return SDL_GetPointerProperty(SDL_GetWindowProperties(self->window), "touchResponder", NULL);
}
 
static View *touchTarget(const WindowController *self, const SDL_Event *event) {
  SDL_Point point;
 
  switch (event->type) {
    case SDL_EVENT_MOUSE_BUTTON_DOWN:
      point = MakePoint(event->button.x, event->button.y);
      break;
    case SDL_EVENT_MOUSE_BUTTON_UP:
      point = MakePoint(event->button.x, event->button.y);
      break;
    case SDL_EVENT_MOUSE_MOTION:
      point = MakePoint(event->motion.x, event->motion.y);
      break;
    case SDL_EVENT_MOUSE_WHEEL: {
      float mx, my;
      SDL_GetMouseState(&mx, &my);
      point = MakePoint(mx, my);
      break;
    }
    default:
      return NULL;
  }
 
  return $(self->viewController->view, hitTest, &point);
}
 
static WindowController *windowController(SDL_Window *window) {
 
  assert(window);
 
  return SDL_GetPointerProperty(SDL_GetWindowProperties(window), "windowController", NULL);
}
 
#pragma mark - Class lifecycle
 
static void initialize(Class *clazz) {
 
  ((ObjectInterface *) clazz->interface)->dealloc = dealloc;
 
  ((WindowControllerInterface *) clazz->interface)->debug = debug;
  ((WindowControllerInterface *) clazz->interface)->keyResponder = keyResponder;
  ((WindowControllerInterface *) clazz->interface)->keyResponders = keyResponders;
  ((WindowControllerInterface *) clazz->interface)->initWithDevice = initWithDevice;
  ((WindowControllerInterface *) clazz->interface)->nextKeyResponder = nextKeyResponder;
  ((WindowControllerInterface *) clazz->interface)->previousKeyResponder = previousKeyResponder;
  ((WindowControllerInterface *) clazz->interface)->render = render;
  ((WindowControllerInterface *) clazz->interface)->renderTo = renderTo;
  ((WindowControllerInterface *) clazz->interface)->respondToEvent = respondToEvent;
  ((WindowControllerInterface *) clazz->interface)->setTheme = setTheme;
  ((WindowControllerInterface *) clazz->interface)->setViewController = setViewController;
  ((WindowControllerInterface *) clazz->interface)->setWindow = setWindow;
  ((WindowControllerInterface *) clazz->interface)->toggleDebugger = toggleDebugger;
  ((WindowControllerInterface *) clazz->interface)->touchResponder = touchResponder;
  ((WindowControllerInterface *) clazz->interface)->touchTarget = touchTarget;
  ((WindowControllerInterface *) clazz->interface)->windowController = windowController;
}
 
Class *_WindowController(void) {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "WindowController",
      .superclass = _Object(),
      .instanceSize = sizeof(WindowController),
      .interfaceSize = sizeof(WindowControllerInterface),
      .initialize = initialize,
    });
  });
 
  return clazz;
}
 
#undef _Class