/*
 * node.h
 *
 *  Created on: Mar 7, 2011
 *      Author: posixninja
 *
 * Copyright (c) 2011 Joshua Hill. All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef NODE_H_
#define NODE_H_

#include "node_list.h"
#include "object.h"

#define NODE_TYPE 1;

#ifndef NODE_MAX_DEPTH
#define NODE_MAX_DEPTH 512
#endif

#define NODE_ERR_SUCCESS       0
#define NODE_ERR_INVALID_ARG  -1
#define NODE_ERR_NO_MEM       -2
#define NODE_ERR_PARENT       -3
#define NODE_ERR_CIRCULAR_REF -4
#define NODE_ERR_MAX_DEPTH    -5
#define NODE_ERR_NOT_FOUND    -6

// This class implements the abstract iterator class
typedef struct node* node_t;
struct node {
	// Super class
	node_t next;
	node_t prev;
	unsigned int count;

	// Local Members
	void *data;
	node_t parent;
	node_list_t children;
};

void node_destroy(node_t node);
node_t node_create(node_t parent, void* data);

int node_attach(node_t parent, node_t child);
int node_detach(node_t parent, node_t child);
int node_insert(node_t parent, unsigned int index, node_t child);

unsigned int node_n_children(node_t node);
node_t node_nth_child(node_t node, unsigned int n);
node_t node_first_child(node_t node);
node_t node_prev_sibling(node_t node);
node_t node_next_sibling(node_t node);
int node_child_position(node_t parent, node_t child);

typedef void* (*copy_func_t)(const void *src);
node_t node_copy_deep(node_t node, copy_func_t copy_func);

void node_debug(node_t node);

#endif /* NODE_H_ */