ui/gtk/menu.c

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2017 Olaf Wintermann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.
 */

#include <stdio.h>
#include <stdlib.h>
#include <inttypes.h>
#include <stdarg.h>

#include "menu.h"
#include "toolkit.h"
#include "../common/context.h"
#include "../ui/properties.h"
#include "../ui/window.h"
#include "container.h"

#include <cx/linked_list.h>
#include <cx/array_list.h>

static UiMenu *menus_begin;
static UiMenu *menus_end;
static CxList *current;

static void add_menu(UiMenu *menu) {
    cx_linked_list_add(
            (void**)&menus_begin,
            (void**)&menus_end,
            offsetof(UiMenu, item.prev),
            offsetof(UiMenu, item.next),
            menu);
}

static void add_item(UiMenuItemI *item) {
    UiMenu *menu = cxListAt(current, 0);
    cx_linked_list_add(
            (void**)&menu->items_begin,
            (void**)&menu->items_end,
            offsetof(UiMenu, item.prev),
            offsetof(UiMenu, item.next),
            item);
}

void ui_menu(char *label) {
    if(!current) {
        current = cxLinkedListCreate(cxDefaultAllocator, NULL, CX_STORE_POINTERS);
    } else {
        // free current menu hierarchy
        cxListClear(current);
    }
    
    // create menu
    UiMenu *menu = malloc(sizeof(UiMenu));
    menu->item.prev = NULL;
    menu->item.next = NULL;
    menu->item.add_to = (ui_menu_add_f)add_menu_widget;
    
    menu->label        = label;
    menu->items_begin  = NULL;
    menu->items_end    = NULL;
    menu->parent       = NULL;    
    
    add_menu(menu);
    cxListAdd(current, menu);
}

void ui_submenu(char *label) {
    UiMenu *menu = malloc(sizeof(UiMenu));
    menu->item.prev = NULL;
    menu->item.next = NULL;
    menu->item.add_to = (ui_menu_add_f)add_menu_widget;
    
    menu->label       = label;
    menu->items_begin = NULL;
    menu->items_end   = NULL;
    menu->parent      = NULL;
    
    // add submenu to current menu
    add_item((UiMenuItemI*)menu);
    
    // set the submenu to current menu
    cxListInsert(current, 0, menu);
}

void ui_submenu_end() {
    if(current->size < 2) {
        return;
    }
    cxListRemove(current, 0);
}

void ui_menuitem(char *label, ui_callback f, void *userdata) {
    ui_menuitem_gr(label, f, userdata, -1);
}

void ui_menuitem_st(char *stockid, ui_callback f, void *userdata) {
    ui_menuitem_stgr(stockid, f, userdata, -1);
}

void ui_menuitem_gr(char *label, ui_callback f, void *userdata, ...) {
    if(!current) {
        return;
    }
    
    UiMenuItem *item = malloc(sizeof(UiMenuItem));
    item->item.prev = NULL;
    item->item.next = NULL;
    item->item.add_to = (ui_menu_add_f)add_menuitem_widget;
    
    item->label = label;
    item->userdata = userdata;
    item->callback = f;
    item->groups = NULL;
    
    // add groups
    va_list ap;
    va_start(ap, userdata);
    int group;
    while((group = va_arg(ap, int)) != -1) {
        if(!item->groups) {
            item->groups = cxArrayListCreate(cxDefaultAllocator, NULL, sizeof(int), 8);
        }
        cxListAdd(item->groups, &group);
    }
    va_end(ap);
    
    add_item((UiMenuItemI*)item);
}

void ui_menuitem_stgr(char *stockid, ui_callback f, void *userdata, ...) {
    if(!current) {
        return;
    }
    
    UiStMenuItem *item = malloc(sizeof(UiStMenuItem));
    item->item.prev = NULL;
    item->item.next = NULL;
    item->item.add_to = (ui_menu_add_f)add_menuitem_st_widget;
    
    item->stockid = stockid;
    item->userdata = userdata;
    item->callback = f;
    item->groups = NULL;
    
    // add groups
    va_list ap;
    va_start(ap, userdata);
    int group;
    while((group = va_arg(ap, int)) != -1) {
        if(!item->groups) {
            item->groups = cxArrayListCreate(cxDefaultAllocator, NULL, sizeof(int), 8);
        }
        cxListAdd(item->groups, &group);
    }
    va_end(ap);
    
    add_item((UiMenuItemI*)item);
}

void ui_menuseparator() {
    if(!current) {
        return;
    }
    
    UiMenuItemI  *item = malloc(sizeof(UiMenuItemI));
    item->prev = NULL;
    item->next = NULL;
    item->add_to = (ui_menu_add_f)add_menuseparator_widget;
    
    add_item((UiMenuItemI*)item);
}

void ui_checkitem(char *label, ui_callback f, void *userdata) {
    if(!current) {
        return;
    }
    
    UiCheckItem *item = malloc(sizeof(UiCheckItem));
    item->item.prev = NULL;
    item->item.next = NULL;
    item->item.add_to = (ui_menu_add_f)add_checkitem_widget;
    item->label = label;
    item->callback = f;
    item->userdata = userdata;
    
    add_item((UiMenuItemI*)item);
}

void ui_checkitem_nv(char *label, char *vname) {
    if(!current) {
        return;
    }
    
    UiCheckItemNV *item = malloc(sizeof(UiCheckItemNV));
    item->item.prev = NULL;
    item->item.next = NULL;
    item->item.add_to = (ui_menu_add_f)add_checkitemnv_widget;
    item->varname = vname;
    item->label = label;
    
    add_item((UiMenuItemI*)item);
}

void ui_menuitem_list(UiList *items, ui_callback f, void *userdata) {
    if(!current) {
        return;
    }
    
    UiMenuItemList *item = malloc(sizeof(UiMenuItemList));
    item->item.prev = NULL;
    item->item.next = NULL;
    item->item.add_to = (ui_menu_add_f)add_menuitem_list_widget;
    item->callback = f;
    item->userdata = userdata;
    item->list = items;
    
    add_item((UiMenuItemI*)item);
}

// private menu functions
GtkWidget *ui_create_menubar(UiObject *obj) {
    if(menus_begin == NULL) {
        return NULL;
    }
    
    GtkWidget *mb = gtk_menu_bar_new();
    
    UiMenu *ls = menus_begin;
    while(ls) {
        UiMenu *menu = ls;
        menu->item.add_to(mb, 0, &menu->item, obj);
        
        ls = (UiMenu*)ls->item.next;
    }
    
    return mb;
}

void add_menu_widget(GtkWidget *parent, int i, UiMenuItemI *item, UiObject *obj) {
    UiMenu *menu = (UiMenu*)item;
    
    GtkWidget *menu_widget = gtk_menu_new();
    GtkWidget *menu_item = gtk_menu_item_new_with_mnemonic(menu->label);
    gtk_menu_item_set_submenu(GTK_MENU_ITEM(menu_item), menu_widget);
    
    UiMenuItemI *it = menu->items_begin;
    int index = 0;
    while(it) {
        it->add_to(menu_widget, index, it, obj);
        
        it = it->next;
        index++;
    }
    
    gtk_menu_shell_append(GTK_MENU_SHELL(parent), menu_item);
}

void add_menuitem_widget(GtkWidget *parent, int index, UiMenuItemI *item, UiObject *obj) {
    UiMenuItem *i = (UiMenuItem*)item;
    
    //GtkWidget *widget = gtk_menu_item_new_with_label(i->title);
    GtkWidget *widget = gtk_menu_item_new_with_mnemonic(i->label);
    
    if(i->callback != NULL) {
        UiEventData *event = malloc(sizeof(UiEventData));
        event->obj = obj;
        event->userdata = i->userdata;
        event->callback = i->callback;
        event->value = 0;

        g_signal_connect(
                widget,
                "activate",
                G_CALLBACK(ui_menu_event_wrapper),
                event);
        g_signal_connect(
                widget,
                "destroy",
                G_CALLBACK(ui_destroy_userdata),
                event);
    }
    
    gtk_menu_shell_append(GTK_MENU_SHELL(parent), widget);
    
    if(i->groups) {
        uic_add_group_widget(obj->ctx, widget, (ui_enablefunc)ui_set_enabled, i->groups);
    }
}

void add_menuitem_st_widget(
        GtkWidget *parent,
        int index,
        UiMenuItemI *item,
        UiObject *obj)
{
    UiStMenuItem *i = (UiStMenuItem*)item;
    
    GtkWidget *widget = gtk_image_menu_item_new_from_stock(i->stockid, obj->ctx->accel_group);
    
    if(i->callback != NULL) {
        UiEventData *event = malloc(sizeof(UiEventData));
        event->obj = obj;
        event->userdata = i->userdata;
        event->callback = i->callback;
        event->value = 0;

        g_signal_connect(
                widget,
                "activate",
                G_CALLBACK(ui_menu_event_wrapper),
                event);
        g_signal_connect(
                widget,
                "destroy",
                G_CALLBACK(ui_destroy_userdata),
                event);
    }
    
    gtk_menu_shell_append(GTK_MENU_SHELL(parent), widget);
    
    if(i->groups) {
        uic_add_group_widget(obj->ctx, widget, (ui_enablefunc)ui_set_enabled, i->groups);
    }
}

void add_menuseparator_widget(
        GtkWidget *parent,
        int index,
        UiMenuItemI *item,
        UiObject *obj)
{
    gtk_menu_shell_append(
            GTK_MENU_SHELL(parent),
            gtk_separator_menu_item_new());
}

void add_checkitem_widget(GtkWidget *p, int index, UiMenuItemI *item, UiObject *obj) {
    UiCheckItem *ci = (UiCheckItem*)item;
    GtkWidget *widget = gtk_check_menu_item_new_with_mnemonic(ci->label);
    gtk_menu_shell_append(GTK_MENU_SHELL(p), widget);
    
    if(ci->callback) {
        UiEventData *event = malloc(sizeof(UiEventData));
        event->obj = obj;
        event->userdata = ci->userdata;
        event->callback = ci->callback;
        event->value = 0;

        g_signal_connect(
                widget,
                "toggled",
                G_CALLBACK(ui_menu_event_toggled),
                event);
        g_signal_connect(
                widget,
                "destroy",
                G_CALLBACK(ui_destroy_userdata),
                event);
    }
}

void add_checkitemnv_widget(GtkWidget *p, int index, UiMenuItemI *item, UiObject *obj) {
    UiCheckItemNV *ci = (UiCheckItemNV*)item;
    GtkWidget *widget = gtk_check_menu_item_new_with_mnemonic(ci->label);
    gtk_menu_shell_append(GTK_MENU_SHELL(p), widget);
    
    UiVar *var = uic_create_var(obj->ctx, ci->varname, UI_VAR_INTEGER);
    if(var) {
        UiInteger *value = var->value;
        value->obj = widget;
        value->get = ui_checkitem_get;
        value->set = ui_checkitem_set;
        value = 0;
    } else {
        // TODO: error
    }
}

void add_menuitem_list_widget(GtkWidget *p, int index, UiMenuItemI *item, UiObject *obj) {
    UiMenuItemList *il = (UiMenuItemList*)item;
    const CxAllocator *a = obj->ctx->allocator;
    
    UiActiveMenuItemList *ls = cxMalloc(
            a,
            sizeof(UiActiveMenuItemList));
    
    ls->object = obj;
    ls->menu = GTK_MENU_SHELL(p);
    ls->index = index;
    ls->oldcount = 0;
    ls->list = il->list;
    ls->callback = il->callback;
    ls->userdata = il->userdata;
    
    ls->list->observers = ui_add_observer(
            ls->list->observers,
            (ui_callback)ui_update_menuitem_list,
            ls);
    
    ui_update_menuitem_list(NULL, ls);
}


void ui_update_menuitem_list(UiEvent *event, UiActiveMenuItemList *list) {    
    // remove old items
    if(list->oldcount > 0) {
        int i = 0;
        GList *mi = gtk_container_get_children(GTK_CONTAINER(list->menu));
        while(mi) {
            if(i >= list->index && i < list->index + list->oldcount) {
                //gtk_container_remove(GTK_CONTAINER(list->menu), mi->data);
                gtk_widget_destroy(mi->data);
            }
            mi = mi->next;
            i++;
        }
    }
    
    char *str = ui_list_first(list->list);
    if(str) {
        GtkWidget *widget = gtk_separator_menu_item_new();
        gtk_menu_shell_insert(list->menu, widget, list->index);
        gtk_widget_show(widget);
    }
    int i = 1;
    while(str) {
        GtkWidget *widget = gtk_menu_item_new_with_label(str);
        gtk_menu_shell_insert(list->menu, widget, list->index + i);
        gtk_widget_show(widget);
        
        if(list->callback) {
            // TODO: use mempool
            UiEventData *event = malloc(sizeof(UiEventData));
            event->obj = list->object;
            event->userdata = list->userdata;
            event->callback = list->callback;
            event->value = i - 1;

            g_signal_connect(
                widget,
                "activate",
                G_CALLBACK(ui_menu_event_wrapper),
                event);
            g_signal_connect(
                widget,
                "destroy",
                G_CALLBACK(ui_destroy_userdata),
                event);
        }
        
        str = ui_list_next(list->list);
        i++;
    }
    
    list->oldcount = i;
}

void ui_menu_event_wrapper(GtkMenuItem *item, UiEventData *event) {
    UiEvent evt;
    evt.obj = event->obj;
    evt.window = event->obj->window;
    evt.document = event->obj->ctx->document;
    evt.eventdata = NULL;
    evt.intval = event->value;
    event->callback(&evt, event->userdata);    
}

void ui_menu_event_toggled(GtkCheckMenuItem *ci, UiEventData *event) {
    UiEvent evt;
    evt.obj = event->obj;
    evt.window = event->obj->window;
    evt.document = event->obj->ctx->document;
    evt.eventdata = NULL;
    evt.intval = gtk_check_menu_item_get_active(ci);
    event->callback(&evt, event->userdata);    
}

int64_t ui_checkitem_get(UiInteger *i) {
    int state = gtk_check_menu_item_get_active(i->obj);
    i->value = state;
    return state;
}

void ui_checkitem_set(UiInteger *i, int64_t value) {
    i->value = value;
    gtk_check_menu_item_set_active(i->obj, value);
}


/*
 * widget menu functions
 */

static gboolean ui_button_press_event(GtkWidget *widget, GdkEvent *event, GtkMenu *menu) {
    if(event->type == GDK_BUTTON_PRESS) {
        GdkEventButton *e = (GdkEventButton*)event;
        if(e->button == 3) {
            gtk_widget_show_all(GTK_WIDGET(menu));
            ui_contextmenu_popup(menu);
            return TRUE;
        }
    }
    return FALSE;
}

UIMENU ui_contextmenu(UiObject *obj) {
    UiContainer *ct = uic_get_current_container(obj);
    return ui_contextmenu_w(obj, ct->current);
}

UIMENU ui_contextmenu_w(UiObject *obj, UIWIDGET widget) {
    UiContainer *ct = uic_get_current_container(obj);
    
    GtkMenu *menu = GTK_MENU(gtk_menu_new());
    g_signal_connect(widget, "button-press-event", (GCallback) ui_button_press_event, menu);
    
    ct->menu = menu;
    return menu;
}

void ui_contextmenu_popup(UIMENU menu) {
#if GTK_MAJOR_VERSION >= 3 && GTK_MINOR_VERSION >= 16
    gtk_menu_popup_at_pointer(menu, NULL);
#else
    gtk_menu_popup(menu, NULL, NULL, 0, 0, 0, gtk_get_current_event_time());
#endif
}

void ui_widget_menuitem(UiObject *obj, char *label, ui_callback f, void *userdata) {
    ui_widget_menuitem_gr(obj, label, f, userdata, -1);
}

void ui_widget_menuitem_gr(UiObject *obj, char *label, ui_callback f, void *userdata, ...) {
    UiContainer *ct = uic_get_current_container(obj);
    if(!ct->menu) {
        return;
    }
    
    // add groups
    CxList *groups = NULL;
    va_list ap;
    va_start(ap, userdata);
    int group;
    while((group = va_arg(ap, int)) != -1) {
        if(!groups) {
            groups = cxArrayListCreate(cxDefaultAllocator, NULL, sizeof(int), 16);
        }
        cxListAdd(groups, &group);
    }
    va_end(ap);
    
    // create menuitem
    GtkWidget *widget = gtk_menu_item_new_with_mnemonic(label);
    gtk_widget_show(widget);
    
    if(f) {
        UiEventData *event = malloc(sizeof(UiEventData));
        event->obj = obj;
        event->userdata = userdata;
        event->callback = f;
        event->value = 0;

        g_signal_connect(
                widget,
                "activate",
                G_CALLBACK(ui_menu_event_wrapper),
                event);
        g_signal_connect(
                widget,
                "destroy",
                G_CALLBACK(ui_destroy_userdata),
                event);
    }
    
    gtk_menu_shell_append(GTK_MENU_SHELL(ct->menu), widget);
    
    if(groups) {
        uic_add_group_widget(obj->ctx, widget, (ui_enablefunc)ui_set_enabled, groups);
        cxListDestroy(groups);
    }
}

void ui_widget_menuitem_st(UiObject *obj, char *stockid, ui_callback f, void *userdata) {
    ui_widget_menuitem_stgr(obj, stockid, f, userdata, -1);
}

void ui_widget_menuitem_stgr(UiObject *obj, char *stockid, ui_callback f, void *userdata, ...) {
    UiContainer *ct = uic_get_current_container(obj);
    if(!ct->menu) {
        return;
    }
    
    // add groups
    CxList *groups = NULL;
    va_list ap;
    va_start(ap, userdata);
    int group;
    while((group = va_arg(ap, int)) != -1) {
        if(!groups) {
            groups = cxArrayListCreate(cxDefaultAllocator, NULL, sizeof(int), 16);
        }
        cxListAdd(groups, &group);
    }
    va_end(ap);
    
    // create menuitem
    GtkWidget *widget = gtk_image_menu_item_new_from_stock(stockid, obj->ctx->accel_group);
    gtk_widget_show(widget);
    
    if(f) {
        UiEventData *event = malloc(sizeof(UiEventData));
        event->obj = obj;
        event->userdata = userdata;
        event->callback = f;
        event->value = 0;

        g_signal_connect(
                widget,
                "activate",
                G_CALLBACK(ui_menu_event_wrapper),
                event);
        g_signal_connect(
                widget,
                "destroy",
                G_CALLBACK(ui_destroy_userdata),
                event);
    }
    
    gtk_menu_shell_append(GTK_MENU_SHELL(ct->menu), widget);
    
    if(groups) {
        uic_add_group_widget(obj->ctx, widget, (ui_enablefunc)ui_set_enabled, groups);
        cxListDestroy(groups);
    }
}