ui/gtk/headerbar.c

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

#include "button.h"
#include "menu.h"
#include "../ui/widget.h"

#include <cx/array_list.h>

#include "../ui/properties.h"

#if GTK_CHECK_VERSION(3, 10, 0)
    
void ui_fill_headerbar(UiObject *obj, GtkWidget *sidebar_headerbar, GtkWidget *main_headerbar, GtkWidget *right_headerbar) {
    CxList *sidebar_left_defaults = uic_get_toolbar_defaults(UI_TOOLBAR_SIDEBAR_LEFT);
    CxList *sidebar_right_defaults = uic_get_toolbar_defaults(UI_TOOLBAR_SIDEBAR_RIGHT);
    
    CxList *left_defaults = uic_get_toolbar_defaults(UI_TOOLBAR_LEFT);
    CxList *center_defaults = uic_get_toolbar_defaults(UI_TOOLBAR_CENTER);
    CxList *right_defaults = uic_get_toolbar_defaults(UI_TOOLBAR_RIGHT);
    
    CxList *rightpanel_left_defaults = uic_get_toolbar_defaults(UI_TOOLBAR_RIGHTPANEL_LEFT);
    CxList *rightpanel_center_defaults = uic_get_toolbar_defaults(UI_TOOLBAR_RIGHTPANEL_CENTER);
    CxList *rightpanel_right_defaults = uic_get_toolbar_defaults(UI_TOOLBAR_RIGHTPANEL_RIGHT);

    UiToolbarMenuItem *appmenu = uic_get_appmenu();
    const char *appmenu_pos_str = ui_get_property("ui.gtk.window.appmenu.position");
    int appmenu_pos = UI_TOOLBAR_RIGHT;
    if(sidebar_headerbar) {
        appmenu_pos = UI_TOOLBAR_SIDEBAR_RIGHT;
    } else if(right_headerbar) {
        appmenu_pos = UI_TOOLBAR_RIGHTPANEL_RIGHT;
    }
    if(appmenu_pos_str) {
        if(!strcmp(appmenu_pos_str, "sidebar") && sidebar_headerbar) {
            appmenu_pos = UI_TOOLBAR_SIDEBAR_RIGHT;
        } else if(!strcmp(appmenu_pos_str, "main")) {
            appmenu_pos = UI_TOOLBAR_RIGHT;
        } else if(!strcmp(appmenu_pos_str, "rightpanel") && right_headerbar) {
            appmenu_pos = UI_TOOLBAR_RIGHTPANEL_RIGHT;
        }
    }
    
    // main toolbar
    ui_headerbar_add_items(obj, main_headerbar, left_defaults, UI_TOOLBAR_LEFT, NULL);
    ui_headerbar_add_items(obj, main_headerbar, center_defaults, UI_TOOLBAR_CENTER, NULL);
    
    if(appmenu && appmenu_pos == UI_TOOLBAR_RIGHT) {
        ui_add_headerbar_menu(main_headerbar, NULL, appmenu, obj, UI_TOOLBAR_RIGHT);
    }
    ui_headerbar_add_items(obj, main_headerbar, right_defaults, UI_TOOLBAR_RIGHT, NULL);
    
    // sidebar
    if(sidebar_headerbar) {
        // ui_headerbar_add_items pos parameter uses only UI_TOOLBAR_LEFT, UI_TOOLBAR_CENTER, UI_TOOLBAR_RIGHT
        ui_headerbar_add_items(obj, sidebar_headerbar, sidebar_left_defaults, UI_TOOLBAR_LEFT, NULL);

        if(appmenu && appmenu_pos == UI_TOOLBAR_SIDEBAR_RIGHT) {
            ui_add_headerbar_menu(sidebar_headerbar, NULL, appmenu, obj, UI_TOOLBAR_RIGHT);
        }
        ui_headerbar_add_items(obj, sidebar_headerbar, sidebar_right_defaults, UI_TOOLBAR_RIGHT, NULL);
    }
    
    // right panel
    if(right_headerbar) {
        // also add central toolbar items, in case the central pane is hidden
        CxList *backup_toolbar_widgets = cxArrayListCreate(obj->ctx->allocator, CX_STORE_POINTERS, 16);
        ui_headerbar_add_items(obj, right_headerbar, left_defaults, UI_TOOLBAR_LEFT, backup_toolbar_widgets);
        ui_headerbar_add_items(obj, right_headerbar, center_defaults, UI_TOOLBAR_LEFT, backup_toolbar_widgets);
        ui_headerbar_add_items(obj, right_headerbar, right_defaults, UI_TOOLBAR_LEFT, backup_toolbar_widgets);
        CxIterator i = cxListIterator(backup_toolbar_widgets);
        cx_foreach(GtkWidget *, w, i) {
            ui_set_visible(w, FALSE);
        }
        g_object_set_data(G_OBJECT(obj->widget), "ui_toolbar_center_backup", backup_toolbar_widgets);
        
        // main items for the right panel
        ui_headerbar_add_items(obj, right_headerbar, rightpanel_left_defaults, UI_TOOLBAR_LEFT, NULL);
        ui_headerbar_add_items(obj, right_headerbar, rightpanel_center_defaults, UI_TOOLBAR_CENTER, NULL);

        if(appmenu && appmenu_pos == UI_TOOLBAR_RIGHTPANEL_RIGHT) {
            ui_add_headerbar_menu(right_headerbar, NULL, appmenu, obj, UI_TOOLBAR_RIGHT);
        }
        ui_headerbar_add_items(obj, right_headerbar, rightpanel_right_defaults, UI_TOOLBAR_RIGHT, NULL);
    }
}

static GtkWidget* create_item(UiObject *obj, GtkWidget *headerbar, GtkWidget *box, UiToolbarItemI *i, enum UiToolbarPos pos) {
    switch(i->type) {
        case UI_TOOLBAR_ITEM: {
            return ui_add_headerbar_item(headerbar, box, (UiToolbarItem*)i, obj, pos);
        }
        case UI_TOOLBAR_TOGGLEITEM: {
            return ui_add_headerbar_toggleitem(headerbar, box, (UiToolbarToggleItem*)i, obj, pos);
        }
        case UI_TOOLBAR_MENU: {
            return ui_add_headerbar_menu(headerbar, box, (UiToolbarMenuItem*)i, obj, pos);
        }
        default: fprintf(stderr, "toolbar item type unimplemented: %d\n", (int)i->type);
    }
    return NULL;
}

static void headerbar_add(GtkWidget *headerbar, GtkWidget *box, GtkWidget *item, enum UiToolbarPos pos) {
    switch(pos) {
        case UI_TOOLBAR_LEFT: {
            UI_HEADERBAR_PACK_START(headerbar, item);
            break;
        }
        case UI_TOOLBAR_CENTER: {
            
#if GTK_MAJOR_VERSION >= 4
            gtk_box_append(GTK_BOX(box), item);
#else
            gtk_box_pack_start(GTK_BOX(box), item, 0, 0, 0);
#endif
            break;
        }
        case UI_TOOLBAR_RIGHT: {
            UI_HEADERBAR_PACK_END(headerbar, item);
            break;
        }
    }
}

void ui_headerbar_add_items(UiObject *obj, GtkWidget *headerbar, CxList *items, enum UiToolbarPos pos, CxList *out_items) {
    GtkWidget *box = NULL;
    
    if(pos == UI_TOOLBAR_CENTER && cxListSize(items) > 0) {
        box = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 6);
        UI_HEADERBAR_SET_TITLE_WIDGET(headerbar, box);
        if(out_items) {
            cxListAdd(out_items, box);
        }
    }
    
    CxIterator i = pos == UI_TOOLBAR_RIGHT ? cxListBackwardsIterator(items) : cxListIterator(items);
    cx_foreach(char*, def, i) {
        UiToolbarItemI* item = uic_toolbar_get_item(def);
        if (!item) {
            fprintf(stderr, "unknown toolbar item: %s\n", def);
            continue;
        }
        GtkWidget *item_widget = create_item(obj, headerbar, box, item, pos);
        if(out_items && !box) {
            cxListAdd(out_items, item_widget);
        }
    }
}

GtkWidget* ui_add_headerbar_item(
        GtkWidget *headerbar,
        GtkWidget *box,
        UiToolbarItem *item,
        UiObject *obj,
        enum UiToolbarPos pos)
{
    GtkWidget *button = ui_create_button(obj, item->args.label, item->args.icon, item->args.tooltip, item->args.onclick, item->args.onclickdata, item->args.action, 0, FALSE);
    ui_set_widget_states(obj->ctx, button, item->args.states);
    ui_set_widget_visibility_states(obj->ctx, button, item->args.visibility_states);
    WIDGET_ADD_CSS_CLASS(button, "flat");
    headerbar_add(headerbar, box, button, pos);
    return button;
}

GtkWidget* ui_add_headerbar_toggleitem(
        GtkWidget *headerbar,
        GtkWidget *box,
        UiToolbarToggleItem *item,
        UiObject *obj,
        enum UiToolbarPos pos)
{
    GtkWidget *button = gtk_toggle_button_new();
    ui_set_widget_states(obj->ctx, button, item->args.states);
    ui_set_widget_visibility_states(obj->ctx, button, item->args.visibility_states);
    WIDGET_ADD_CSS_CLASS(button, "flat");
    ui_setup_togglebutton(obj, button, item->args.label, item->args.icon, item->args.tooltip, item->args.varname, NULL, item->args.onchange, item->args.onchangedata, item->args.action, 0);
    headerbar_add(headerbar, box, button, pos);
    return button;
}

GtkWidget* ui_add_headerbar_menu(
        GtkWidget *headerbar,
        GtkWidget *box,
        UiToolbarMenuItem *item,
        UiObject *obj,
        enum UiToolbarPos pos)
{
    
    
#if GTK_MAJOR_VERSION >= 4
    GtkWidget *menubutton = gtk_menu_button_new();
    ui_set_widget_visibility_states(obj->ctx, menubutton, item->args.visibility_states);
    if(item->args.label) {
        gtk_menu_button_set_label(GTK_MENU_BUTTON(menubutton), item->args.label);
    }
    if(item->args.icon) {
        gtk_menu_button_set_icon_name(GTK_MENU_BUTTON(menubutton), item->args.icon); 
    }
    
    if(!item->args.label && !item->args.icon) {
        gtk_menu_button_set_icon_name(GTK_MENU_BUTTON(menubutton), "open-menu-symbolic"); 
    }
    
    GMenu *menu = g_menu_new();
    ui_gmenu_add_menu_items(menu, 0, &item->menu, obj);
    
    gtk_menu_button_set_menu_model(GTK_MENU_BUTTON(menubutton), G_MENU_MODEL(menu));
#else
    GtkWidget *menubutton = gtk_menu_button_new();
    GtkWidget *menu = gtk_menu_new();
    ui_add_menu_items(menu, 0, &item->menu, obj); 
    gtk_widget_show_all(menu);
    gtk_menu_button_set_popup(GTK_MENU_BUTTON(menubutton), menu);
    
#endif
    
    headerbar_add(headerbar, box, menubutton, pos);
    
    return menubutton;
}
    
#endif // GTK_CHECK_VERSION(3, 10, 0)