ccl-tree.h

Go to the documentation of this file.

/*
 * ccl-tree.h -- Generic not ordered tree structure.
 * 
 * This file is a part of the C Common Library (CCL) project. 
 * 
 * Copyright (C) 2010 CNRS UMR 5800 & Université Bordeaux I (see AUTHORS file).
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the AltaRica Public License that comes with this
 * package.
 * 
 * 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. 
 */

#ifndef __CCL_TREE_H__
# define __CCL_TREE_H__

# include <ccl/ccl-protos.h>
# include <ccl/ccl-list.h>

BEGIN_C_DECLS

typedef struct ccl_tree_st ccl_tree;

struct ccl_tree_st
{
  int refcount;
  void *object;

  ccl_delete_proc *del;

  ccl_tree *next;

  ccl_tree *childs;
  ccl_tree *parent;
};

extern ccl_tree *
ccl_tree_create (void *obj, ccl_delete_proc *del);

extern ccl_tree *
ccl_tree_add_reference (ccl_tree *t);

extern void
ccl_tree_del_reference (ccl_tree *t);

extern int
ccl_tree_get_depth (const ccl_tree *t);

extern int
ccl_tree_is_leaf (const ccl_tree *t);

extern int
ccl_tree_get_nb_siblings (const ccl_tree *t);

extern int
ccl_tree_get_nb_childs (const ccl_tree *t);

extern ccl_tree *
ccl_tree_get_child (ccl_tree *t, int index);

extern void
ccl_tree_add_child (ccl_tree *t, ccl_tree *child);

extern void
ccl_tree_set_label (ccl_tree *t, void *obj, ccl_delete_proc *del);

extern ccl_list *
ccl_tree_get_path (ccl_tree *from, ccl_tree *to);

extern ccl_tree *
ccl_tree_least_common_ancestor (ccl_tree *root, ccl_tree *v1, ccl_tree *v2);

END_C_DECLS

#endif /* ! __CCL_TREE_H__ */