summaryrefslogtreecommitdiffstats
path: root/libpoldiff/include/poldiff/bool_diff.h
blob: e64d33cc8f4ad3bbf2b0c671fdd48a8710790646 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/**
 *  @file
 *  Public interface for computing semantic differences in booleans.
 *
 *  @author Jeremy A. Mowery jmowery@tresys.com
 *  @author Jason Tang jtang@tresys.com
 *  @author Randy Wicks rwicks@tresys.com
 *
 *  Copyright (C) 2006-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_BOOL_DIFF_H
#define POLDIFF_BOOL_DIFF_H

#ifdef	__cplusplus
extern "C"
{
#endif

#include <apol/vector.h>
#include <poldiff/poldiff.h>

	typedef struct poldiff_bool poldiff_bool_t;

/**
 *  Get an array of statistics for the number of differences of each
 *  form for bools.
 *
 *  @param diff The policy difference structure from which to get the
 *  stats.
 *  @param stats Array into which to write the numbers (array must be
 *  pre-allocated). The order of the values written to the array is as
 *  follows:  number of items of form POLDIFF_FORM_ADDED, number of
 *  POLDIFF_FORM_REMOVED, number of POLDIFF_FORM_MODIFIED, number of
 *  form POLDIFF_FORM_ADD_TYPE, and number of
 *  POLDIFF_FORM_REMOVE_TYPE.
 */
	extern void poldiff_bool_get_stats(const poldiff_t * diff, size_t stats[5]);

/**
 *  Get the vector of bool differences from the boolean difference
 *  summary.
 *
 *  @param diff The policy difference structure associated with the
 *  bool difference summary.
 *
 *  @return A vector of elements of type poldiff_bool_t, or NULL on
 *  error.  The caller should <b>not</b> destroy the vector
 *  returned.  If the call fails, errno will be set.
 */
	extern const apol_vector_t *poldiff_get_bool_vector(const poldiff_t * diff);

/**
 *  Obtain a newly allocated string representation of a difference in
 *  a bool.
 *
 *  @param diff The policy difference structure associated with the bool.
 *  @param item The bool from which to generate the string.
 *
 *  @return A string representation of bool difference; the caller is
 *  responsible for free()ing this string.  On error, return NULL and
 *  set errno.
 */
	extern char *poldiff_bool_to_string(const poldiff_t * diff, const void *boolean);

/**
 *  Get the number of added bools from a policy difference
 *  structure.
 *
 *  @param diff The policy difference structure from which to get the
 *  number of added bools.
 *
 *  @return The number of added bools or 0 if not yet run.  (The
 *  number of differences could also be zero.)
 */
	extern size_t poldiff_get_num_added_bools(const poldiff_t * diff);

/**
 *  Get the number of removed bools from a policy difference
 *  structure.
 *
 *  @param diff The policy difference structure from which to get the
 *  number of removed bools.
 *
 *  @return The number of removed bools or 0 if not yet run.  (The
 *  number of differences could also be zero.)
 */
	extern size_t poldiff_get_num_removed_bools(const poldiff_t * diff);

/**
 *  Get the number of modified bools from a policy difference
 *  structure.
 *
 *  @param diff The policy difference structure from which to get the
 *  number of modified bools.
 *
 *  @return The number of modified bools or 0 if not yet run.  (The
 *  number of differences could also be zero.)
 */
	extern size_t poldiff_get_num_modified_bools(const poldiff_t * diff);

/**
 *  Get the name of the bool from a bool diff.
 *
 *  @param diff The policy difference structure associated with the
 *  bool diff.
 *  @param cls The bool from which to get the name.
 *
 *  @return Name of the bool on success and NULL on failure; if the
 *  call fails, errno will be set. The caller should not free the
 *  returned string.
 */
	extern const char *poldiff_bool_get_name(const poldiff_bool_t * boolean);

/**
 *  Get the form of difference from a bool diff.
 *
 *  @param diff The policy difference structure associated with the
 *  bool diff.
 *
 *  @param cls The bool from which to get the difference form.
 *
 *  @return The form of difference (one of POLDIFF_FORM_*) or
 *  POLDIFF_FORM_NONE on error.  If the call fails, errno will be set.
 */
	extern poldiff_form_e poldiff_bool_get_form(const void *boolean);

#ifdef	__cplusplus
}
#endif

#endif				       /* POLDIFF_BOOL_DIFF_H */