source: mainline/uspace/lib/ui/src/wdecor.c@ 25f26600

/*
 * 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 decoration
 */

#include <assert.h>
#include <errno.h>
#include <gfx/color.h>
#include <gfx/context.h>
#include <gfx/render.h>
#include <gfx/text.h>
#include <io/pos_event.h>
#include <stdlib.h>
#include <str.h>
#include <ui/paint.h>
#include <ui/pbutton.h>
#include <ui/wdecor.h>
#include "../private/resource.h"
#include "../private/wdecor.h"

static void ui_wdecor_btn_clicked(ui_pbutton_t *, void *);

static ui_pbutton_cb_t ui_wdecor_btn_close_cb = {
        .clicked = ui_wdecor_btn_clicked
};

enum {
        wdecor_corner_w = 24,
        wdecor_corner_h = 24,
        wdecor_edge_w = 4,
        wdecor_edge_h = 4
};

/** Create new window decoration.
 *
 * @param resource UI resource
 * @param caption Window caption
 * @param style Style
 * @param rwdecor Place to store pointer to new window decoration
 * @return EOK on success, ENOMEM if out of memory
 */
errno_t ui_wdecor_create(ui_resource_t *resource, const char *caption,
    ui_wdecor_style_t style, ui_wdecor_t **rwdecor)
{
        ui_wdecor_t *wdecor;
        errno_t rc;

        wdecor = calloc(1, sizeof(ui_wdecor_t));
        if (wdecor == NULL)
                return ENOMEM;

        wdecor->caption = str_dup(caption);
        if (wdecor->caption == NULL) {
                free(wdecor);
                return ENOMEM;
        }

        rc = ui_pbutton_create(resource, "X", &wdecor->btn_close);
        if (rc != EOK) {
                free(wdecor->caption);
                free(wdecor);
                return rc;
        }

        ui_pbutton_set_cb(wdecor->btn_close, &ui_wdecor_btn_close_cb,
            (void *)wdecor);

        wdecor->res = resource;
        wdecor->active = true;
        wdecor->style = style;
        *rwdecor = wdecor;
        return EOK;
}

/** Destroy window decoration.
 *
 * @param wdecor Window decoration or @c NULL
 */
void ui_wdecor_destroy(ui_wdecor_t *wdecor)
{
        if (wdecor == NULL)
                return;

        ui_pbutton_destroy(wdecor->btn_close);
        free(wdecor->caption);
        free(wdecor);
}

/** Set window decoration callbacks.
 *
 * @param wdecor Window decoration
 * @param cb Window decoration callbacks
 * @param arg Callback argument
 */
void ui_wdecor_set_cb(ui_wdecor_t *wdecor, ui_wdecor_cb_t *cb, void *arg)
{
        wdecor->cb = cb;
        wdecor->arg = arg;
}

/** Set window decoration rectangle.
 *
 * @param wdecor Window decoration
 * @param rect New window decoration rectangle
 */
void ui_wdecor_set_rect(ui_wdecor_t *wdecor, gfx_rect_t *rect)
{
        ui_wdecor_geom_t geom;

        wdecor->rect = *rect;

        ui_wdecor_get_geom(wdecor, &geom);
        ui_pbutton_set_rect(wdecor->btn_close, &geom.btn_close_rect);
}

/** Set active flag.
 *
 * Active window is the one receiving keyboard events.
 *
 * @param wdecor Window decoration
 * @param active @c true iff window is active
 */
void ui_wdecor_set_active(ui_wdecor_t *wdecor, bool active)
{
        wdecor->active = active;
}

/** Paint window decoration.
 *
 * @param wdecor Window decoration
 * @return EOK on success or an error code
 */
errno_t ui_wdecor_paint(ui_wdecor_t *wdecor)
{
        errno_t rc;
        gfx_rect_t rect;
        gfx_rect_t trect;
        gfx_text_fmt_t fmt;
        gfx_coord2_t pos;
        ui_wdecor_geom_t geom;

        rect = wdecor->rect;
        ui_wdecor_get_geom(wdecor, &geom);

        if ((wdecor->style & ui_wds_frame) != 0) {
                rc = ui_paint_bevel(wdecor->res->gc, &rect,
                    wdecor->res->wnd_frame_hi_color,
                    wdecor->res->wnd_frame_sh_color, 1, &rect);
                if (rc != EOK)
                        return rc;

                rc = ui_paint_bevel(wdecor->res->gc, &rect,
                    wdecor->res->wnd_highlight_color,
                    wdecor->res->wnd_shadow_color, 1, &rect);
                if (rc != EOK)
                        return rc;

                rc = ui_paint_bevel(wdecor->res->gc, &rect,
                    wdecor->res->wnd_face_color,
                    wdecor->res->wnd_face_color, 2, &rect);
                if (rc != EOK)
                        return rc;
        }

        if ((wdecor->style & ui_wds_titlebar) != 0) {
                trect = geom.title_bar_rect;

                rc = ui_paint_bevel(wdecor->res->gc, &trect,
                    wdecor->res->wnd_shadow_color,
                    wdecor->res->wnd_highlight_color, 1, &trect);
                if (rc != EOK)
                        return rc;

                rc = gfx_set_color(wdecor->res->gc, wdecor->active ?
                    wdecor->res->tbar_act_bg_color :
                    wdecor->res->tbar_inact_bg_color);
                if (rc != EOK)
                        return rc;

                rc = gfx_fill_rect(wdecor->res->gc, &trect);
                if (rc != EOK)
                        return rc;

                gfx_text_fmt_init(&fmt);
                fmt.halign = gfx_halign_center;
                fmt.valign = gfx_valign_center;

                pos.x = (trect.p0.x + trect.p1.x) / 2;
                pos.y = (trect.p0.y + trect.p1.y) / 2;

                rc = gfx_set_color(wdecor->res->gc, wdecor->active ?
                    wdecor->res->tbar_act_text_color :
                    wdecor->res->tbar_inact_text_color);
                if (rc != EOK)
                        return rc;

                rc = gfx_puttext(wdecor->res->font, &pos, &fmt, wdecor->caption);
                if (rc != EOK)
                        return rc;

                if ((wdecor->style & ui_wds_close_btn) != 0) {
                        rc = ui_pbutton_paint(wdecor->btn_close);
                        if (rc != EOK)
                                return rc;
                }
        }

        return EOK;
}

/** Send decoration close event.
 *
 * @param wdecor Window decoration
 */
void ui_wdecor_close(ui_wdecor_t *wdecor)
{
        if (wdecor->cb != NULL && wdecor->cb->close != NULL)
                wdecor->cb->close(wdecor, wdecor->arg);
}

/** Send decoration move event.
 *
 * @param wdecor Window decoration
 * @param pos Position where the title bar was pressed
 */
void ui_wdecor_move(ui_wdecor_t *wdecor, gfx_coord2_t *pos)
{
        if (wdecor->cb != NULL && wdecor->cb->move != NULL)
                wdecor->cb->move(wdecor, wdecor->arg, pos);
}

/** Send decoration resize event.
 *
 * @param wdecor Window decoration
 * @param rsztype Resize type
 * @param pos Position where the button was pressed
 */
void ui_wdecor_resize(ui_wdecor_t *wdecor, ui_wdecor_rsztype_t rsztype,
    gfx_coord2_t *pos)
{
        if (wdecor->cb != NULL && wdecor->cb->resize != NULL)
                wdecor->cb->resize(wdecor, wdecor->arg, rsztype, pos);
}

/** Send cursor change event.
 *
 * @param wdecor Window decoration
 * @param cursor Cursor
 */
void ui_wdecor_set_cursor(ui_wdecor_t *wdecor, ui_stock_cursor_t cursor)
{
        if (wdecor->cb != NULL && wdecor->cb->set_cursor != NULL)
                wdecor->cb->set_cursor(wdecor, wdecor->arg, cursor);
}

/** Get window decoration geometry.
 *
 * @param wdecor Window decoration
 * @param geom Structure to fill in with computed geometry
 */
void ui_wdecor_get_geom(ui_wdecor_t *wdecor, ui_wdecor_geom_t *geom)
{
        /* Does window have a frame? */
        if ((wdecor->style & ui_wds_frame) != 0) {
                geom->interior_rect.p0.x = wdecor->rect.p0.x + 4;
                geom->interior_rect.p0.y = wdecor->rect.p0.y + 4;
                geom->interior_rect.p1.x = wdecor->rect.p1.x - 4;
                geom->interior_rect.p1.y = wdecor->rect.p1.y - 4;
        } else {
                geom->interior_rect = wdecor->rect;
        }

        /* Does window have a title bar? */
        if ((wdecor->style & ui_wds_titlebar) != 0) {
                geom->title_bar_rect.p0 = geom->interior_rect.p0;
                geom->title_bar_rect.p1.x = geom->interior_rect.p1.x;
                geom->title_bar_rect.p1.y = geom->interior_rect.p0.y + 22;

                geom->app_area_rect.p0.x = geom->interior_rect.p0.x;
                geom->app_area_rect.p0.y = geom->title_bar_rect.p1.y;
                geom->app_area_rect.p1 = geom->interior_rect.p1;
        } else {
                geom->title_bar_rect.p0.x = 0;
                geom->title_bar_rect.p0.y = 0;
                geom->title_bar_rect.p1.x = 0;
                geom->title_bar_rect.p1.y = 0;

                geom->app_area_rect = geom->interior_rect;
        }

        /* Does window have a close button? */
        if ((wdecor->style & ui_wds_close_btn) != 0) {
                geom->btn_close_rect.p0.x = geom->title_bar_rect.p1.x - 1 - 20;
                geom->btn_close_rect.p0.y = geom->title_bar_rect.p0.y + 1;
                geom->btn_close_rect.p1.x = geom->title_bar_rect.p1.x - 1;
                geom->btn_close_rect.p1.y = geom->title_bar_rect.p0.y + 1 + 20;
        } else {
                geom->btn_close_rect.p0.x = 0;
                geom->btn_close_rect.p0.y = 0;
                geom->btn_close_rect.p1.x = 0;
                geom->btn_close_rect.p1.y = 0;
        }
}

/** Get outer rectangle from application area rectangle.
 *
 * Note that this needs to work just based on a UI, without having an actual
 * window decoration, since we need it in order to create the window
 * and its decoration.
 *
 * @param style Decoration style
 * @param app Application area rectangle
 * @param rect Place to store (outer) window decoration rectangle
 */
void ui_wdecor_rect_from_app(ui_wdecor_style_t style, gfx_rect_t *app,
    gfx_rect_t *rect)
{
        *rect = *app;

        if ((style & ui_wds_frame) != 0) {
                rect->p0.x -= wdecor_edge_w;
                rect->p0.y -= wdecor_edge_h;
                rect->p1.x += wdecor_edge_w;
                rect->p1.y += wdecor_edge_h;
        }

        if ((style & ui_wds_titlebar) != 0)
                rect->p0.y -= 22;
}

/** Application area rectangle from window rectangle.
 *
 * Note that this needs to work just based on a UI, without having an actual
 * window decoration, since we need it in process of resizing the window,
 * before it is actually resized.
 *
 * @param style Decoration style
 * @param rect Window decoration rectangle
 * @param app Place to store application area rectangle
 */
void ui_wdecor_app_from_rect(ui_wdecor_style_t style, gfx_rect_t *rect,
    gfx_rect_t *app)
{
        *app = *rect;

        if ((style & ui_wds_frame) != 0) {
                app->p0.x += wdecor_edge_w;
                app->p0.y += wdecor_edge_h;
                app->p1.x -= wdecor_edge_w;
                app->p1.y -= wdecor_edge_h;
        }

        if ((style & ui_wds_titlebar) != 0)
                app->p0.y += 22;
}

/** Get resize type for pointer at the specified position.
 *
 * @param wdecor Window decoration
 * @param pos Pointer position
 * @return Resize type
 */
ui_wdecor_rsztype_t ui_wdecor_get_rsztype(ui_wdecor_t *wdecor,
    gfx_coord2_t *pos)
{
        bool eleft, eright;
        bool etop, ebottom;
        bool edge;
        bool cleft, cright;
        bool ctop, cbottom;

        /* Window not resizable? */
        if ((wdecor->style & ui_wds_resizable) == 0)
                return ui_wr_none;

        /* Position not inside window? */
        if (!gfx_pix_inside_rect(pos, &wdecor->rect))
                return ui_wr_none;

        /* Position is within edge width from the outside */
        eleft = (pos->x < wdecor->rect.p0.x + wdecor_edge_w);
        eright = (pos->x >= wdecor->rect.p1.x - wdecor_edge_w);
        etop = (pos->y < wdecor->rect.p0.y + wdecor_edge_h);
        ebottom = (pos->y >= wdecor->rect.p1.y - wdecor_edge_h);

        /* Position is on one of the four edges */
        edge = eleft || eright || etop || ebottom;

        /* Position is within resize-corner distance from the outside */
        cleft = (pos->x < wdecor->rect.p0.x + wdecor_corner_w);
        cright = (pos->x >= wdecor->rect.p1.x - wdecor_corner_w);
        ctop = (pos->y < wdecor->rect.p0.y + wdecor_corner_h);
        cbottom = (pos->y >= wdecor->rect.p1.y - wdecor_corner_h);

        /* Top-left corner */
        if (edge && cleft && ctop)
                return ui_wr_top_left;

        /* Top-right corner */
        if (edge && cright && ctop)
                return ui_wr_top_right;

        /* Bottom-left corner */
        if (edge && cleft && cbottom)
                return ui_wr_bottom_left;

        /* Bottom-right corner */
        if (edge && cright && cbottom)
                return ui_wr_bottom_right;

        /* Left edge */
        if (eleft)
                return ui_wr_left;

        /* Right edge */
        if (eright)
                return ui_wr_right;

        /* Top edge */
        if (etop)
                return ui_wr_top;

        /* Bottom edge */
        if (ebottom)
                return ui_wr_bottom;

        return ui_wr_none;
}

/** Get stock cursor to use for the specified window resize type.
 *
 * The resize type must be valid, otherwise behavior is undefined.
 *
 * @param rsztype Resize type
 * @return Cursor to use for this resize type
 */
ui_stock_cursor_t ui_wdecor_cursor_from_rsztype(ui_wdecor_rsztype_t rsztype)
{
        switch (rsztype) {
        case ui_wr_none:
                return ui_curs_arrow;

        case ui_wr_top:
        case ui_wr_bottom:
                return ui_curs_size_ud;

        case ui_wr_left:
        case ui_wr_right:
                return ui_curs_size_lr;

        case ui_wr_top_left:
        case ui_wr_bottom_right:
                return ui_curs_size_uldr;

        case ui_wr_top_right:
        case ui_wr_bottom_left:
                return ui_curs_size_urdl;

        default:
                assert(false);
                return ui_curs_arrow;
        }
}

/** Handle window frame position event.
 *
 * @param wdecor Window decoration
 * @param pos_event Position event
 */
void ui_wdecor_frame_pos_event(ui_wdecor_t *wdecor, pos_event_t *event)
{
        gfx_coord2_t pos;
        ui_wdecor_rsztype_t rsztype;
        ui_stock_cursor_t cursor;

        pos.x = event->hpos;
        pos.y = event->vpos;

        /* Set appropriate resizing cursor, or set arrow cursor */

        rsztype = ui_wdecor_get_rsztype(wdecor, &pos);
        cursor = ui_wdecor_cursor_from_rsztype(rsztype);

        ui_wdecor_set_cursor(wdecor, cursor);

        /* Press on window border? */
        if (rsztype != ui_wr_none && event->type == POS_PRESS)
                ui_wdecor_resize(wdecor, rsztype, &pos);
}

/** Handle window decoration position event.
 *
 * @param wdecor Window decoration
 * @param pos_event Position event
 */
void ui_wdecor_pos_event(ui_wdecor_t *wdecor, pos_event_t *event)
{
        gfx_coord2_t pos;
        ui_wdecor_geom_t geom;
        ui_evclaim_t claim;

        pos.x = event->hpos;
        pos.y = event->vpos;

        ui_wdecor_get_geom(wdecor, &geom);

        if ((wdecor->style & ui_wds_close_btn) != 0) {
                claim = ui_pbutton_pos_event(wdecor->btn_close, event);
                if (claim == ui_claimed)
                        return;
        }

        ui_wdecor_frame_pos_event(wdecor, event);

        if ((wdecor->style & ui_wds_titlebar) != 0)  {
                if (event->type == POS_PRESS &&
                    gfx_pix_inside_rect(&pos, &geom.title_bar_rect))
                        ui_wdecor_move(wdecor, &pos);
        }
}

/** Window decoration close button was clicked.
 *
 * @param pbutton Close button
 * @param arg Argument (ui_wdecor_t)
 */
static void ui_wdecor_btn_clicked(ui_pbutton_t *pbutton, void *arg)
{
        ui_wdecor_t *wdecor = (ui_wdecor_t *) arg;

        (void) pbutton;
        ui_wdecor_close(wdecor);
}

/** @}
 */