ui/common/context.h

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

#ifndef UIC_CONTEXT_H
#define	UIC_CONTEXT_H

#include "../ui/toolkit.h"
#include <cx/map.h>
#include <cx/hash_map.h>
#include <cx/mempool.h>
#include <cx/list.h>
#include <cx/linked_list.h>

#ifdef	__cplusplus
extern "C" {
#endif

typedef struct UiVar            UiVar;
typedef struct UiListPtr        UiListPtr;
typedef struct UiListVar        UiListVar;
typedef struct UiStateWidget    UiStateWidget;
typedef struct UiDestroyHandler UiDestroyHandler;

typedef enum UiVarType {
    UI_VAR_SPECIAL = 0,
    UI_VAR_INTEGER,
    UI_VAR_DOUBLE,
    UI_VAR_STRING,
    UI_VAR_TEXT,
    UI_VAR_LIST,
    UI_VAR_RANGE,
    UI_VAR_GENERIC
} UiVarType;

struct UiContext {
    UiContext     *parent;
    UiObject      *obj;
    CxMempool *mp;
    const CxAllocator *allocator;
    CxList *destroy_handler;
    
    void          *document;
    CxList        *documents;
    
    CxMap         *vars;
    
    CxList        *states; // int list
    CxList        *state_widgets; // UiGroupWidget list
    
    void (*attach_document)(UiContext *ctx, void *document);
    void (*detach_document2)(UiContext *ctx, void *document); 
    
    char          *title;
    
#ifdef UI_GTK
#if GTK_CHECK_VERSION(4, 0, 0)
    GActionMap *action_map;
#elif UI_GTK2 || UI_GTK3
    GtkAccelGroup *accel_group;
#endif 
#endif
    
    // allow only one document to be attached
    // attaching a document will automatically detach the current document
    UiBool single_document_mode;
    
    ui_callback   close_callback;
    void          *close_data;
};

struct UiVar {
    void      *value;
    void      *original_value;
    UiVarType type;
    UiVar     *from;
    UiContext *from_ctx;
    UiBool    bound;
};

struct UiStateWidget {
    void          *widget;
    ui_enablefunc enable;
    int           *states;
    int           numstates;
};

struct UiDestroyHandler {
    cx_destructor_func destructor;
    void *data;
};


void uic_init_global_context(void);

UiContext* uic_context(UiObject *toplevel, CxMempool *mp);
UiContext* uic_root_context(UiContext *ctx);
void uic_context_add_destructor(UiContext *ctx, cx_destructor_func func, void *data);

void uic_context_prepare_close(UiContext *ctx);

void uic_context_attach_document(UiContext *ctx, void *document);
void uic_context_detach_document(UiContext *ctx, void *document);
void uic_context_attach_context(UiContext *ctx, UiContext *doc_ctx); // TODO
void uic_context_detach_context(UiContext *ctx, UiContext *doc_ctx); // TODO
void uic_context_detach_all(UiContext *ctx);

UiVar* uic_get_var(UiContext *ctx, const char *name);
UiVar* uic_get_var_t(UiContext *ctx, const char *name, UiVarType type);
UiVar* uic_create_var(UiContext *ctx, const char *name, UiVarType type);
UiVar* uic_create_value_var(UiContext *ctx, void *value);
void* uic_create_value(UiContext *ctx, UiVarType type);
void uic_destroy_value(UiContext *ctx, UiVarType type, void *value);

UiVar* uic_widget_var(UiContext *toplevel, UiContext *current, void *value, const char *varname, UiVarType type);

void uic_copy_var_binding(UiVar *from, UiVar *to, UiBool copytodoc);
void uic_copy_value_binding(UiVarType type, void *from, void *to);
void uic_save_var(UiVar *var);
void uic_unbind_var(UiVar *var);
const char *uic_type2str(UiVarType type);

void uic_reg_var(UiContext *ctx, const char *name, UiVarType type, void *value);

size_t uic_state_array_size(const int *states);
void uic_check_state_widgets(UiContext *ctx);
void uic_add_state_widget(UiContext *ctx, void *widget, ui_enablefunc enable, CxList *states);
void uic_add_state_widget_i(UiContext *ctx, void *widget, ui_enablefunc enable, const int *states, size_t numstates);
void uic_remove_state_widget(UiContext *ctx, void *widget);

#ifdef	__cplusplus
}
#endif

#endif	/* UIC_CONTEXT_H */