/*
 * Copyright (c) 2012, Raphael Manfredi
 *
 *----------------------------------------------------------------------
 * This file is part of gtk-gnutella.
 *
 *  gtk-gnutella 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.
 *
 *  gtk-gnutella 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 gtk-gnutella; if not, write to the Free Software
 *  Foundation, Inc.:
 *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *----------------------------------------------------------------------
 */

/**
 * @ingroup core
 * @file
 *
 * G2 packet management.
 *
 * @author Raphael Manfredi
 * @date 2012
 */

#ifndef _core_g2_tree_h_
#define _core_g2_tree_h_

struct g2_tree;
typedef struct g2_tree g2_tree_t;

/*
 * Public interface.
 */

bool g2_tree_is_valid(const struct g2_tree * const t);
g2_tree_t *g2_tree_lookup(const g2_tree_t *root, const char *path);
const char *g2_tree_name(const g2_tree_t *node);
g2_tree_t *g2_tree_root(const g2_tree_t *node);
const void *g2_tree_payload(const g2_tree_t *root, const char *path, size_t *l);
const void *g2_tree_node_payload(const g2_tree_t *node, size_t *paylen);
void g2_tree_child_foreach(const g2_tree_t *root, data_fn_t cb, void *data);
g2_tree_t *g2_tree_first_child(const g2_tree_t *root);
g2_tree_t *g2_tree_next_sibling(const g2_tree_t *child);
g2_tree_t *g2_tree_next_twin(const g2_tree_t *child);
g2_tree_t *g2_tree_alloc_empty(const char *name);
g2_tree_t *g2_tree_alloc(const char *name, const void *payload, size_t paylen);
g2_tree_t *g2_tree_alloc_copy(const char *name,
	const void *payload, size_t paylen);
void g2_tree_set_payload(g2_tree_t *root,
	const void *payload, size_t paylen, bool copy);
size_t g2_tree_append_payload(g2_tree_t *root,
	const void *payload, size_t paylen);
void g2_tree_add_child(g2_tree_t *parent, g2_tree_t *child);
void g2_tree_reverse_children(g2_tree_t *node);
void g2_tree_free_null(g2_tree_t **root_ptr);

void g2_tree_enter_leave(g2_tree_t *root,
	match_fn_t enter, data_fn_t leave, void *data);

void g2_tree_test(void);

static inline void
g2_tree_free_null_const(const g2_tree_t **root_ptr)
{
	g2_tree_free_null(deconstify_pointer(root_ptr));
}

#define G2_TREE_CHILD_FOREACH(t, c) \
	for (c = g2_tree_first_child(t); c != NULL; c = g2_tree_next_sibling(c))

#endif /* _core_g2_tree_h_ */

/* vi: set ts=4 sw=4 cindent: */
