ui/motif/menu.c

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2014 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 <stdarg.h>

#include "menu.h"
#include "button.h"
#include "toolkit.h"
#include "stock.h"
#include "container.h"
#include "../common/context.h"
#include "../common/menu.h"
#include "../common/types.h"
#include "../ui/window.h"

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


static ui_menu_add_f createMenuItem[] = {
    /* UI_MENU                 */ add_menu_widget,
    /* UI_MENU_ITEM            */ add_menuitem_widget,
    /* UI_MENU_CHECK_ITEM      */ add_checkitem_widget,
    /* UI_MENU_RADIO_ITEM      */ add_radioitem_widget,
    /* UI_MENU_ITEM_LIST       */ add_menuitem_list_widget,
    /* UI_MENU_CHECKITEM_LIST  */ add_menuitem_list_widget,
    /* UI_MENU_RADIOITEM_LIST  */ add_menuitem_list_widget,
    /* UI_MENU_SEPARATOR       */ add_menuseparator_widget
};

Widget ui_create_menubar(UiObject *obj, Widget window) {
    UiMenu *menus_begin = uic_get_menu_list();
    if(!menus_begin) {
        return NULL;
    }
    
    Widget menubar = XmCreateMenuBar(window, "menubar", NULL, 0);
    XtManageChild(menubar);
    
    UiMenu *ls = menus_begin;
    while(ls) {
        UiMenu *menu = ls;
        add_menu_widget(menubar, 0, &menu->item, obj);
        ls = (UiMenu*)ls->item.next;
    }
    
    return menubar;
}

void ui_add_menu_items(Widget parent, int i, UiMenu *menu, UiObject *obj) {
    UiMenuItemI *it = menu->items_begin;
    int index = 0;
    while(it) {
        createMenuItem[it->type](parent, index, it, obj);
        it = it->next;
        index++;
    }
}

void add_menu_widget(Widget parent, int i, UiMenuItemI *item, UiObject *obj) {
    UiMenu *menu = (UiMenu*)item;
    Arg args[4];
    int n = 0;
    
    XmString s = NULL;
    if(menu->label) {
        s = XmStringCreateLocalized((char*)menu->label);
        XtSetArg(args[n], XmNlabelString, s); n++;
    }
    
    Widget submenu = XmCreatePulldownMenu(parent, "menu_pulldown", NULL, 0);
    XtSetArg(args[n], XmNsubMenuId, submenu); n++;
    (void)XtCreateManagedWidget(
            "menuitem",
            xmCascadeButtonWidgetClass,
            parent,
            args,
            n);
    
    if(s) {
        XmStringFree(s);
    }
    
    ui_add_menu_items(submenu, i, menu, obj);
}

void add_menuitem_widget(Widget parent, int i, UiMenuItemI *item, UiObject *obj) {
    UiMenuItem *it = (UiMenuItem*)item;
    
    XmString s = NULL;
    Arg args[4];
    int n = 0;
    if(it->label) {
        s = XmStringCreateLocalized((char*)it->label);
        XtSetArg(args[n], XmNlabelString, s); n++;
    }
    
    Widget mitem = XtCreateManagedWidget(
            "menubutton",
            xmPushButtonWidgetClass,
            parent,
            args,
            n);
    if(s) {
        XmStringFree(s);
    }
    
    if(it->callback) {
        UiEventData *eventdata = malloc(sizeof(UiEventData));
        eventdata->callback = it->callback;
        eventdata->userdata = it->userdata;
        eventdata->obj = obj;
        eventdata->value = 0;
        XtAddCallback(
                mitem,
                XmNactivateCallback,
                (XtCallbackProc)ui_push_button_callback,
                eventdata);
       XtAddCallback(
                mitem,
                XmNdestroyCallback,
                (XtCallbackProc)ui_destroy_data,
                eventdata);
    }
    
    ui_set_widget_groups(obj->ctx, mitem, it->states);
}

void add_menuseparator_widget(Widget p, int i, UiMenuItemI *item, UiObject *obj) {
    Widget s = XmCreateSeparatorGadget (p, "menuseparator", NULL, 0);
    XtManageChild(s);
}

void add_checkitem_widget(Widget p, int i, UiMenuItemI *item, UiObject *obj) {
    UiMenuCheckItem *it = (UiMenuCheckItem*)item;
    
    Arg args[4];
    int n = 0;
    XmString s = NULL;
    if(it->label) {
        s = XmStringCreateLocalized(it->label);
        XtSetArg(args[n], XmNlabelString, s); n++;
    }
    
    //XtSetArg(args[n], XmNvisibleWhenOff, 0); n++;
    Widget checkbox = XtCreateManagedWidget(
            "menutogglebutton",
            xmToggleButtonWidgetClass,
            p,
            args,
            n);
    if(s) {
        XmStringFree(s);
    }
    
    ui_bind_togglebutton(obj, checkbox, it->varname, NULL, it->callback, it->userdata, 0);
    
    ui_set_widget_groups(obj->ctx, checkbox, it->states);
}

void add_radioitem_widget(Widget p, int index, UiMenuItemI *item, UiObject *obj) {
    UiMenuRadioItem *it = (UiMenuRadioItem*)item;
    
    Arg args[4];
    int n = 0;
    XmString s = NULL;
    if(it->label) {
        s = XmStringCreateLocalized(it->label);
        XtSetArg(args[n], XmNlabelString, s); n++;
    }
    XtSetArg(args[n], XmNindicatorType, XmONE_OF_MANY_ROUND); n++;
    
    Widget button = XmCreateToggleButton(p, "menuradiobutton", args, n);
    XtManageChild(button);
    
    ui_bind_radiobutton(obj, button, NULL, it->varname, it->callback, it->userdata, 0);
}

static void menuitem_list_remove_binding(void *obj) {
    UiActiveMenuItemList *ls = obj;
    UiList *list = ls->var->value;
    CxList *bindings = list->obj;
    if(bindings) {
        (void)cxListFindRemove(bindings, obj);
        if(cxListSize(bindings) == 0) {
            cxListFree(bindings);
            list->obj = NULL;
            list->update = NULL;
        }
    }
}

void add_menuitem_list_widget(Widget p, int i, 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 = p;
    ls->index = i;
    ls->oldcount = 0;
    ls->getvalue = il->getvalue;
    ls->callback = il->callback;
    ls->userdata = il->userdata;
    ls->addseparator = il->addseparator;
    
    ls->var = uic_create_var(ui_global_context(), il->varname, UI_VAR_LIST);
    if(ls->var) {
        UiList *list = ls->var->value;
        list->update = ui_menulist_update;
        list->getselection = NULL;
        list->setselection = NULL;
        
        // It is possible, that the UiVar is from a global shared context,
        // used by multiple windows. To support this usecase, the list->obj
        // binding object is a list of all connected UiActiveMenuItemList.
        CxList *bindings = list->obj;
        if(!bindings) {
            bindings = cxLinkedListCreate(ls->var->from_ctx->mp->allocator, NULL, CX_STORE_POINTERS);
            list->obj = bindings;
        }
        cxListAdd(bindings, ls);
        
        // The destruction of the toplevel obj must remove the menulist binding
        uic_context_add_destructor(obj->ctx, menuitem_list_remove_binding, ls);
        
        ui_update_menuitem_list(ls);
    }
}

void ui_menulist_update(UiList *list, int ignored) {
    CxList *bindings = list->obj;
    CxIterator i = cxListIterator(bindings);
    cx_foreach(UiActiveMenuItemList *, ls, i) {
        ui_update_menuitem_list(ls);
    }
}

void ui_update_menuitem_list(UiActiveMenuItemList *list) {
    XmString s = NULL;
    Arg args[4];
    int n;
    
    UiList *ls;
    if(list->var && list->var->value) {
        ls = list->var->value;
    } else {
        return;
    }
    
    if(list->oldcount > 0) {
        Widget *children;
        int nc;
        
        XtVaGetValues(
                list->menu,
                XmNchildren,
                &children,
                XmNnumChildren,
                &nc,
                NULL);
        
        for(int i=0;i<list->oldcount;i++) {
            XtDestroyWidget(children[list->index + i]);
        }
    }
    
    void* elm = ui_list_first(ls);
    int i = 0;
    if(elm && list->addseparator) {
        XtSetArg(args[0], XmNpositionIndex, list->index);
        Widget s = XmCreateSeparatorGadget(list->menu, "menuseparator", args, 1);
        XtManageChild(s);
        i++;
    }
    
    ui_getvaluefunc getvalue = list->getvalue;
    int pos = list->index;
    while(elm) {
        n = 0;
        char *label = (char*) (getvalue ? getvalue(elm, 0) : elm);
        if(label) {
            s = XmStringCreateLocalized(label);
            XtSetArg(args[n], XmNlabelString, s); n++;
        }
        XtSetArg(args[n], XmNpositionIndex, pos+i); n++;
        
        Widget mitem = XtCreateManagedWidget(
                "menubutton",
                xmPushButtonWidgetClass,
                list->menu,
                args,
                n);
        if(s) {
            XmStringFree(s);
        }

        if(list->callback) {
            UiEventData *eventdata = malloc(sizeof(UiEventData));
            eventdata->callback = list->callback;
            eventdata->userdata = list->userdata;
            eventdata->obj = list->object;
            eventdata->value = 0;
            XtAddCallback(
                    mitem,
                    XmNactivateCallback,
                    (XtCallbackProc)ui_push_button_callback,
                    eventdata);
            XtAddCallback(
                    mitem,
                    XmNdestroyCallback,
                    (XtCallbackProc)ui_destroy_data,
                    eventdata);
        }
        
        elm = ui_list_next(ls);
        i++;
    }
    
    list->oldcount = i;
}