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
|
/**
* @file
* Header for showing progress dialogs.
*
* @author Jeremy A. Mowery jmowery@tresys.com
* @author Jason Tang jtang@tresys.com
*
* Copyright (C) 2006-2007 Tresys Technology, LLC
*
* This program 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.
*
* 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. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef PROGRESS_H
#define PROGRESS_H
typedef struct progress progress_t;
#include "toplevel.h"
#include <apol/policy.h>
#include <poldiff/poldiff.h>
/**
* Allocate and return a new progress dialog object.
*
* @param top Toplevel object that will control the progress object.
*
* @return An initialized progress object, or NULL upon error. The
* caller is responsible for calling progress_destroy() afterwards.
*/
progress_t *progress_create(toplevel_t * top);
/**
* Destroy a progress dialog. Does nothing if the pointer is already
* NULL.
*
* @param prefs Reference to a progress object to destroy. This will
* be set to NULL afterwards.
*/
void progress_destroy(progress_t ** progress);
/**
* Display a progress dialog.
*
* @param progress Progress dialog to show.
* @param title Title for the progress window.
*/
void progress_show(progress_t * progress, const char *title);
/**
* Hide the progress dialog. Note that this does not actually destroy
* the object.
*
* @param progress Progress dialog to hide.
*/
void progress_hide(progress_t * progress);
/* the rest of these are for multi-threaded progress dialog */
/**
* Block the current thread until the progress dialog receives a done
* signal via progress_done() or progress_abort(). The dialog will
* periodically awake and update the user interface, based upon
* message received by its handle implementations.
*
* @param progress Progress object to wait against.
*
* @return 0 if the progress object got a progress_done(), < 0 if
* progress_abort().
*/
int progress_wait(progress_t * progress);
/**
* Signal to a progress object that this thread is ending
* successfully. This will cause all threads waiting upon the
* progress object to resume.
*
* @param progress Progress object to signal completion.
*/
void progress_done(progress_t * progress);
/**
* Signal to a progress object that this thread completed with
* warnings. This will cause all threads waiting upon the progress
* object to resume.
*
* @param progress Progress object to signal completion.
* @param reason Explanation for warning, or NULL to use most recently
* written message as the reason.
*/
void progress_warn(progress_t * progress, char *reason, ...) __attribute__ ((format(printf, 2, 3)));
/**
* Signal to a progress object that this thread is aborting. This
* will cause all threads waiting upon the progress object to resume.
*
* @param progress Progress object to signal completion.
* @param reason Explanation for abort, or NULL to abort for no
* reason. The most recently written message will be used as the
* reason.
*/
void progress_abort(progress_t * progress, char *reason, ...) __attribute__ ((format(printf, 2, 3)));
/**
* Have the progress dialog show a message upon its next refresh.
*
* @param progress Progress object to update.
* @param fmt Format for string to display.
*/
void progress_update(progress_t * progress, char *fmt, ...) __attribute__ ((format(printf, 2, 3)));
/**
* Implementation of libpoldiff's message callback function. This
* will route messages generated by libpoldiff to the progress
* dialog's display. To use this, pass the progress_t object as
* poldiff_create()'s callback_arg parameter.
*/
void progress_poldiff_handle_func(void *arg, const poldiff_t * diff, int level, const char *fmt, va_list va_args);
/**
* Implementation of a libapol message callback function. This will
* route messages generated by libapol to the progress dialog's
* display. To use this, pass the progress_t object as
* apol_policy_open()'s varg parameter.
*/
void progress_apol_handle_func(void *varg, const apol_policy_t * p, int level, const char *fmt, va_list argp);
#endif
|
