ui/common/menu.h

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

#ifndef UIC_MENU_H
#define UIC_MENU_H

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

#include <cx/linked_list.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct UiMenuItemI      UiMenuItemI;
typedef struct UiMenu           UiMenu;
typedef struct UiMenuItem       UiMenuItem;
typedef struct UiMenuCheckItem  UiMenuCheckItem;
typedef struct UiMenuRadioItem  UiMenuRadioItem;
typedef struct UiMenuItemList   UiMenuItemList;
    
enum UiMenuItemType {
    UI_MENU = 0,
    UI_MENU_ITEM,
    UI_MENU_CHECK_ITEM,
    UI_MENU_RADIO_ITEM,
    UI_MENU_ITEM_LIST,
    UI_MENU_CHECKITEM_LIST,
    UI_MENU_RADIOITEM_LIST,
    UI_MENU_SEPARATOR
};

typedef enum UiMenuItemType UiMenuItemType;
    
struct UiMenuItemI {
    UiMenuItemI    *prev;
    UiMenuItemI    *next;
    UiMenuItemType type;
    char           id[8];
};

struct UiMenu {
    UiMenuItemI    item;
    const char     *label;
    UiMenuItemI    *items_begin;
    UiMenuItemI    *items_end;
    UiMenu         *parent;
    int            end;
};

struct UiMenuItem {
    UiMenuItemI    item;
    ui_callback    callback;
    const char     *label;
    const char     *stockid;
    const char     *icon;
    void           *userdata;
    int            *groups;
    size_t         ngroups;
};

struct UiMenuCheckItem {
    UiMenuItemI    item;
    const char* label;
    const char* stockid;
    const char* icon;
    const char* varname;
    ui_callback    callback;
    void           *userdata;
    int            *groups;
    size_t         ngroups;
};

struct UiMenuRadioItem {
    UiMenuItemI    item;
    const char* label;
    const char* stockid;
    const char* icon;
    ui_callback    callback;
    void* userdata;
    int            *groups;
    size_t         ngroups;
};

struct UiMenuItemList {
    UiMenuItemI     item;
    ui_getvaluefunc getvalue;
    ui_callback     callback;
    void            *userdata;
    const char      *varname;
};


UiMenu* uic_get_menu_list(void);

void uic_add_menu_to_stack(UiMenu* menu);

int* uic_copy_groups(const int* groups, size_t *ngroups);

#ifdef __cplusplus
}
#endif

#endif /* UIC_MENU_H */