source: mainline/uspace/lib/ui/src/window.c@ f03d1308

/*
 * Copyright (c) 2020 Jiri Svoboda
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup libui
 * @{
 */
/**
 * @file Window
 */

#include <display.h>
#include <errno.h>
#include <gfx/context.h>
#include <io/kbd_event.h>
#include <io/pos_event.h>
#include <mem.h>
#include <stdlib.h>
#include <ui/resource.h>
#include <ui/wdecor.h>
#include <ui/window.h>
#include "../private/dummygc.h"
#include "../private/ui.h"
#include "../private/wdecor.h"
#include "../private/window.h"

static void dwnd_close_event(void *);
static void dwnd_focus_event(void *);
static void dwnd_kbd_event(void *, kbd_event_t *);
static void dwnd_pos_event(void *, pos_event_t *);
static void dwnd_unfocus_event(void *);

static display_wnd_cb_t dwnd_cb = {
        .close_event = dwnd_close_event,
        .focus_event = dwnd_focus_event,
        .kbd_event = dwnd_kbd_event,
        .pos_event = dwnd_pos_event,
        .unfocus_event = dwnd_unfocus_event
};

static void wd_close(ui_wdecor_t *, void *);
static void wd_move(ui_wdecor_t *, void *, gfx_coord2_t *);

static ui_wdecor_cb_t wdecor_cb = {
        .close = wd_close,
        .move = wd_move
};

/** Initialize window parameters structure.
 *
 * Window parameters structure must always be initialized using this function
 * first.
 *
 * @param params Window parameters structure
 */
void ui_wnd_params_init(ui_wnd_params_t *params)
{
        memset(params, 0, sizeof(ui_wnd_params_t));
}

/** Create new window.
 *
 * @param ui User interface
 * @param params Window parameters
 * @param rwindow Place to store pointer to new window
 * @return EOK on success or an error code
 */
errno_t ui_window_create(ui_t *ui, ui_wnd_params_t *params,
    ui_window_t **rwindow)
{
        ui_window_t *window;
        display_wnd_params_t dparams;
        display_window_t *dwindow = NULL;
        gfx_context_t *gc = NULL;
        ui_resource_t *res = NULL;
        ui_wdecor_t *wdecor = NULL;
        dummy_gc_t *dgc = NULL;
        errno_t rc;

        window = calloc(1, sizeof(ui_window_t));
        if (window == NULL)
                return ENOMEM;

        display_wnd_params_init(&dparams);
        dparams.rect = params->rect;

        if (ui->display != NULL) {
                rc = display_window_create(ui->display, &dparams, &dwnd_cb,
                    (void *) window, &dwindow);
                if (rc != EOK)
                        goto error;

                rc = display_window_get_gc(dwindow, &gc);
                if (rc != EOK)
                        goto error;
        } else {
                /* Needed for unit tests */
                rc = dummygc_create(&dgc);
                if (rc != EOK)
                        goto error;

                gc = dummygc_get_ctx(dgc);
        }

        rc = ui_resource_create(gc, &res);
        if (rc != EOK)
                goto error;

        rc = ui_wdecor_create(res, params->caption, &wdecor);
        if (rc != EOK)
                goto error;

        ui_wdecor_set_rect(wdecor, &params->rect);
        ui_wdecor_set_cb(wdecor, &wdecor_cb, (void *) window);
        ui_wdecor_paint(wdecor);

        window->ui = ui;
        window->dwindow = dwindow;
        window->gc = gc;
        window->res = res;
        window->wdecor = wdecor;
        *rwindow = window;
        return EOK;
error:
        if (wdecor != NULL)
                ui_wdecor_destroy(wdecor);
        if (res != NULL)
                ui_resource_destroy(res);
        if (dgc != NULL)
                dummygc_destroy(dgc);
        if (dwindow != NULL)
                display_window_destroy(dwindow);
        free(window);
        return rc;
}

/** Destroy window.
 *
 * @param window Window or @c NULL
 */
void ui_window_destroy(ui_window_t *window)
{
        if (window == NULL)
                return;

        ui_wdecor_destroy(window->wdecor);
        ui_resource_destroy(window->res);
        gfx_context_delete(window->gc);
        display_window_destroy(window->dwindow);
        free(window);
}

/** Set window callbacks.
 *
 * @param window Window
 * @param cb Window decoration callbacks
 * @param arg Callback argument
 */
void ui_window_set_cb(ui_window_t *window, ui_window_cb_t *cb, void *arg)
{
        window->cb = cb;
        window->arg = arg;
}

ui_resource_t *ui_window_get_res(ui_window_t *window)
{
        return window->res;
}

gfx_context_t *ui_window_get_gc(ui_window_t *window)
{
        return window->gc;
}

void ui_window_get_app_rect(ui_window_t *window, gfx_rect_t *rect)
{
        ui_wdecor_geom_t geom;

        ui_wdecor_get_geom(window->wdecor, &geom);
        *rect = geom.app_area_rect;
}

/** Handle window close event. */
static void dwnd_close_event(void *arg)
{
        ui_window_t *window = (ui_window_t *) arg;

        ui_window_close(window);
}

/** Handle window focus event. */
static void dwnd_focus_event(void *arg)
{
        ui_window_t *window = (ui_window_t *) arg;

        if (window->wdecor != NULL) {
                ui_wdecor_set_active(window->wdecor, true);
                ui_wdecor_paint(window->wdecor);
        }

        ui_window_focus(window);
}

/** Handle window keyboard event */
static void dwnd_kbd_event(void *arg, kbd_event_t *kbd_event)
{
        ui_window_t *window = (ui_window_t *) arg;

        (void) window;
        ui_window_kbd(window, kbd_event);
}

/** Handle window position event */
static void dwnd_pos_event(void *arg, pos_event_t *event)
{
        ui_window_t *window = (ui_window_t *) arg;

        /* Make sure we don't process events until fully initialized */
        if (window->wdecor == NULL)
                return;

        ui_wdecor_pos_event(window->wdecor, event);
        ui_window_pos(window, event);
}

/** Handle window unfocus event. */
static void dwnd_unfocus_event(void *arg)
{
        ui_window_t *window = (ui_window_t *) arg;

        if (window->wdecor != NULL) {
                ui_wdecor_set_active(window->wdecor, false);
                ui_wdecor_paint(window->wdecor);
        }

        ui_window_unfocus(window);
}

/** Window decoration requested window closure.
 *
 * @param wdecor Window decoration
 * @param arg Argument (demo)
 */
static void wd_close(ui_wdecor_t *wdecor, void *arg)
{
        ui_window_t *window = (ui_window_t *) arg;

        ui_window_close(window);
}

/** Window decoration requested window move.
 *
 * @param wdecor Window decoration
 * @param arg Argument (demo)
 * @param pos Position where the title bar was pressed
 */
static void wd_move(ui_wdecor_t *wdecor, void *arg, gfx_coord2_t *pos)
{
        ui_window_t *window = (ui_window_t *) arg;

        (void) display_window_move_req(window->dwindow, pos);
}

/** Send window close event.
 *
 * @param window Window
 */
void ui_window_close(ui_window_t *window)
{
        if (window->cb != NULL && window->cb->close != NULL)
                window->cb->close(window, window->arg);
}

/** Send window focus event.
 *
 * @param window Window
 */
void ui_window_focus(ui_window_t *window)
{
        if (window->cb != NULL && window->cb->focus != NULL)
                window->cb->focus(window, window->arg);
}

/** Send window keyboard event.
 *
 * @param window Window
 */
void ui_window_kbd(ui_window_t *window, kbd_event_t *kbd)
{
        if (window->cb != NULL && window->cb->kbd != NULL)
                window->cb->kbd(window, window->arg, kbd);
}

/** Send window position event.
 *
 * @param window Window
 */
void ui_window_pos(ui_window_t *window, pos_event_t *pos)
{
        if (window->cb != NULL && window->cb->pos != NULL)
                window->cb->pos(window, window->arg, pos);
}

/** Send window unfocus event.
 *
 * @param window Window
 */
void ui_window_unfocus(ui_window_t *window)
{
        if (window->cb != NULL && window->cb->unfocus != NULL)
                window->cb->unfocus(window, window->arg);
}

/** @}
 */