ui/common/object.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 "object.h"
#include "context.h"

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

#include "../ui/container.h"

static CxList *creation_callbacks;
static CxList *destruction_callbacks;

static CxList *objects;

typedef struct objcallback {
    ui_object_callback func;
    void *userdata;
} objcallback;

void ui_register_object_creation_callback(ui_object_callback func, void *userdata) {
    if(!creation_callbacks) {
        creation_callbacks = cxLinkedListCreate(NULL, sizeof(objcallback));
    }
    objcallback cb = { func, userdata };
    cxListAdd(creation_callbacks, &cb);
}

void ui_register_object_destruction_callback(ui_object_callback func, void *userdata) {
    if(!destruction_callbacks) {
        destruction_callbacks = cxLinkedListCreate(NULL, sizeof(objcallback));
    }
    objcallback cb = { func, userdata };
    cxListAdd(destruction_callbacks, &cb);
}

UiObject* ui_dummy_object(void) {
    UiObject *obj = uic_object_new_toplevel();
    obj->ref = 1;
    return obj;
}

void uic_object_created(UiObject *obj) {
    if(!objects) {
        objects = cxLinkedListCreate(NULL, CX_STORE_POINTERS);
    }
    cxListAdd(objects, obj);
    
    CxIterator i = cxListIterator(creation_callbacks);
    cx_foreach(objcallback *, cb, i) {
        cb->func(obj, cb->userdata);
    }
}

void uic_object_destroyed(UiObject *obj) {
    if(objects) {
        cxListFindRemove(objects, obj);
    }
    
    CxIterator i = cxListIterator(destruction_callbacks);
    cx_foreach(objcallback *, cb, i) {
        cb->func(obj, cb->userdata);
    }
}

CxList* uic_object_list(void) {
    return objects ? objects : cxEmptyList;
}

void ui_object_ref(UiObject *obj) {
    obj->ref++;
}

int ui_object_unref(UiObject *obj) {
    // it is possible to have 0 references, in case
    // a window was created but ui_show was never called
    if(obj->ref == 0 || --obj->ref == 0) {
        if(obj->destroy) {
            obj->destroy(obj);
        }
        uic_object_destroy(obj);
        return 0;
    }
    return 1;
}

void uic_object_destroy(UiObject *obj) {
    uic_object_destroyed(obj);
    uic_context_destroy(obj->ctx, obj->ctx->document);
}

UiObject* uic_object_new_toplevel(void) {
    CxMempool *mp = cxMempoolCreateSimple(256);
    UiObject *obj = cxCalloc(mp->allocator, 1, sizeof(UiObjectPrivate));
    obj->ctx = uic_context(obj, mp);
    obj->ctx->parent = ui_global_context();
    uic_object_created(obj);
    return obj;
}

UiObject* uic_ctx_object_new(UiContext *ctx, UIWIDGET widget) {
    UiObject *newobj = cxCalloc(ctx->allocator, 1, sizeof(UiObjectPrivate));
    newobj->ctx = ctx;
    newobj->widget = widget;
    uic_object_created(newobj);
    return newobj;
}

void uic_object_push_container(UiObject *toplevel, UiContainer *newcontainer) {
    newcontainer->prev = toplevel->container_end;
    if(toplevel->container_end) {
        toplevel->container_end->next = newcontainer;
        toplevel->container_end = newcontainer;
    } else {
        toplevel->container_begin = newcontainer;
        toplevel->container_end = newcontainer;
    }
}

void uic_object_pop_container(UiObject *toplevel) {
    toplevel->container_end = toplevel->container_end->prev;
    if(toplevel->container_end) {
        toplevel->container_end->next = NULL;
    } else {
        toplevel->container_begin = NULL;
    }
    
    // TODO: free container?
}

/*
 * This might look like a weird function, but in case a container creates a
 * sub-container, 2 container objects are added to the list, however we want
 * only one container, otherwise ui_container_finish() would not work
 */
void uic_object_remove_second_last_container(UiObject *toplevel) {
    if(toplevel->container_end && toplevel->container_end->prev) {
        UiContainer *end = toplevel->container_end;
        UiContainer *rm = toplevel->container_end->prev;
        
        end->prev = rm->prev;
        if(rm->prev) {
            rm->prev->next = end;
        } else {
            toplevel->container_begin = end;
        }
        
        // TODO: free container?
    } else {
        fprintf(stderr, "Error: uic_object_remove_second_last_container expected at least 2 containers\n");
    }
}

// public API

void ui_object_set(UiObject *obj, const char *key, void *data) {
    UiObjectPrivate *p = (UiObjectPrivate*)obj;
    if(!p->ext) {
        p->ext = cxHashMapCreate(obj->ctx->mp->allocator, CX_STORE_POINTERS, 4);
    }
    if(data) {
        cxMapPut(p->ext, key, data);
    } else {
        cxMapRemove(p->ext, key);
    }
}

void* ui_object_get(UiObject *obj, const char *key) {
    UiObjectPrivate *p = (UiObjectPrivate*)obj;
    return p->ext ? cxMapGet(p->ext, key) : NULL;
}