/mnt/hgfs/jamie_On_My_Mac/store/version_control/svn/integralive/library/trunk/Integra/integra_instance.h

Go to the documentation of this file.

/* libIntegra multimedia module definition interface
 *  
 * Copyright (C) 2007 Jamie Bullock, Henrik Frisk
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
 * USA.
 */

#ifndef INTEGRA_INSTANCE_H
#define INTEGRA_INSTANCE_H

#ifdef __cplusplus
extern "C" {
#endif

#include <Integra/integra_attribute.h>
#include <Integra/integra_port.h>
#include <Integra/integra_path.h>
#include <Integra/integra_error.h>


typedef struct ntg_instance_ {

    ntg_id id;

    ntg_id class_id;

    char *name;

    struct ntg_instance_ *next;

    struct ntg_instance_ *prev;

    struct ntg_instance_ *parent;

    struct ntg_instance_ *instances; 

    /* FIX: maybe this should be an array, so we don't need to search 
     * the list for index match */
    ntg_instance_attribute *attributes;

    /* Pointer to the current attribute. Used to mark the last 'found' 
     * location in the list */
    ntg_instance_attribute *attribute_current;

    /* Pointer to the last attribute in the list. Used as a marker for creating
     * the 'circular' link back to the root of the list */
    ntg_instance_attribute *attribute_last;

    int n_attributes;

    int dirty;

} ntg_instance;


typedef struct ntg_instance_count_ {
    ntg_id class_id;
    unsigned int n_instances;
    struct ntg_instance_count_ *next;
} ntg_instance_count;

ntg_instance *ntg_instance_new(void);

void ntg_add_instance(ntg_instance *instance, ntg_instance *container);

ntg_instance *ntg_instance_find_by_name(const ntg_instance *container,
        const char *instance_name);

ntg_instance *ntg_instance_find_by_name_r(const ntg_instance *root, 
        const char *name);

ntg_instance *ntg_instance_find_by_path(const ntg_path *path, 
        const ntg_instance *container);

ntg_instance *ntg_instance_find_by_id(const ntg_instance *container,
        const ntg_id instance_id);

ntg_instance *ntg_instance_find_by_id_r(const ntg_instance *root, 
        const ntg_id id);




void ntg_instance_unlink(ntg_instance *instance);

ntg_error_code ntg_instance_set_name(ntg_instance *instance, const char *class_name, const char *name);

ntg_error_code ntg_instance_set_class_id(ntg_instance *instance, ntg_id id);

unsigned long ntg_instance_get_id(ntg_instance *instance);

ntg_error_code ntg_instance_add(ntg_instance *collection, ntg_instance *instance);

ntg_instance_attribute *ntg_instance_get_attribute_root(
        const ntg_instance *instance);

ntg_instance_attribute *ntg_instance_get_attribute_current(
        const ntg_instance *instance);

void ntg_instance_set_attribute_current(ntg_instance *instance, 
        ntg_instance_attribute *current);

ntg_instance_attribute *ntg_instance_attribute_find_by_name(
        const ntg_instance *instance,
        const char *name);


int ntg_instance_increment_count(ntg_instance *instance);

int ntg_instance_decrement_count(ntg_instance *instance);

int  ntg_instance_get_count(ntg_instance *instance);

ntg_id * ntg_instance_get_class_id(ntg_instance *instance);

void ntg_free_instance_counts(void);


void ntg_instance_register_namespace(ntg_instance *instance);


ntg_instance *ntg_instance_add_attributes(ntg_instance *instance,
        ntg_attribute_list *attribute_list);

char *ntg_instance_name_from_path(const ntg_instance *instance, const ntg_path *path);

bool ntg_instance_is_sibling(const ntg_instance *instance, 
        const ntg_instance *sibling);

ntg_path *ntg_instance_get_path(const ntg_instance *instance);

ntg_path *ntg_path_reverse_elements(ntg_path *path);

ntg_error_code ntg_instance_free(ntg_instance *instance);


#ifdef __cplusplus
}
#endif

#endif

---