/**
 *  @file
 *  Protected interface for computing semantic differences in
 *  categories.
 *
 *  @author Jeremy A. Mowery jmowery@tresys.com
 *  @author Jason Tang jtang@tresys.com
 *
 *  Copyright (C) 2007 Tresys Technology, LLC
 *
 *  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 St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef POLDIFF_CAT_INTERNAL_H
#define POLDIFF_CAT_INTERNAL_H

#ifdef	__cplusplus
extern "C"
{
#endif

	typedef struct poldiff_cat_summary poldiff_cat_summary_t;

/**
 * Allocate and return a new poldiff_cat_summary_t object.
 *
 * @return A new category summary.  The caller must call cat_destroy()
 * afterwards.  On error, return NULL and set errno.
 */
	poldiff_cat_summary_t *cat_create(void);

/**
 * Deallocate all space associated with a poldiff_cat_summary_t
 * object, including the pointer itself.  If the pointer is already
 * NULL then do nothing.
 *
 * @param cs Reference to a category summary to destroy.  The pointer
 * will be set to NULL afterwards.
 */
	void cat_destroy(poldiff_cat_summary_t ** cs);

/**
 * Reset the state of all category differences.
 * @param diff The policy difference structure containing the differences
 * to reset.
 * @return 0 on success and < 0 on error; if the call fails,
 * errno will be set and the user should call poldiff_destroy() on diff.
 */
	int cat_reset(poldiff_t * diff);

/**
 * Get a vector of all categoriess from the given policy, sorted by name.
 *
 * @param diff Policy diff error handler.
 * @param policy The policy from which to get the items.
 *
 * @return a newly allocated vector of all categories.  The caller is
 * responsible for calling apol_vector_destroy() afterwards.  On
 * error, return NULL and set errno.
 */
	apol_vector_t *cat_get_items(poldiff_t * diff, const apol_policy_t * policy);

/**
 * Compare two qpol_cat_t objects, determining if they have the same
 * level name or not.
 *
 * @param x The category from the original policy.
 * @param y The category from the modified policy.
 * @param diff The policy difference structure associated with both
 * policies.
 *
 * @return < 0, 0, or > 0 if category x is respectively less than, equal
 * to, or greater than category y.
 */
	int cat_comp(const void *x, const void *y, const poldiff_t * diff);

/**
 * Create, initialize, and insert a new semantic difference entry for
 * a category.
 *
 * @param diff The policy difference structure to which to add the entry.
 * @param form The form of the difference.
 * @param item Item for which the entry is being created.
 *
 * @return 0 on success and < 0 on error; if the call fails, set errno
 * and leave the policy difference structure unchanged.
 */
	int cat_new_diff(poldiff_t * diff, poldiff_form_e form, const void *item);

/**
 * Compute the semantic difference of two categories for which the compare
 * callback returns 0. Categories cannot be modified only added or removed.
 * This function always returns 0.
 *
 * @param diff The policy difference structure associated with both
 * categories.
 * @param x The category from the original policy.
 * @param y The category from the modified policy.
 *
 * @return always 0.
 */
	int cat_deep_diff(poldiff_t * diff, const void *x, const void *y);

#ifdef	__cplusplus
}
#endif

#endif				       /* POLDIFF_CAT_INTERNAL_H */