summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2002-11-18 17:07:31 +0000
committerSergey Poznyakoff <gray@gnu.org.ua>2002-11-18 17:07:31 +0000
commitef72d1bf38bb982ccac6aabeca68b43f8960dffd (patch)
treec53688cfe8202fc6011b027615a8b6dc9296537e /include
parentbb957397c13ca9f7df29ede24d5eac4d3e3800a1 (diff)
downloadmailutils-ef72d1bf38bb982ccac6aabeca68b43f8960dffd.tar.gz
mailutils-ef72d1bf38bb982ccac6aabeca68b43f8960dffd.tar.bz2
Added comments.
Diffstat (limited to 'include')
-rw-r--r--include/mailutils/libsieve.h102
1 files changed, 59 insertions, 43 deletions
diff --git a/include/mailutils/libsieve.h b/include/mailutils/libsieve.h
index 14035b0da..c67506e64 100644
--- a/include/mailutils/libsieve.h
+++ b/include/mailutils/libsieve.h
@@ -15,10 +15,17 @@
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
+#ifndef _MAILUTILS_LIBSIEVE_H
+#define _MAILUTILS_LIBSIEVE_H
+
#include <sys/types.h>
#include <stdarg.h>
#include <mailutils/mailutils.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
+
typedef struct sieve_machine *sieve_machine_t;
typedef int (*sieve_handler_t) __PMT((sieve_machine_t mach,
@@ -100,16 +107,17 @@ typedef struct {
extern int sieve_yydebug;
+/* Memory allocation functions */
void *sieve_alloc __P((size_t size));
void *sieve_palloc __P((list_t *pool, size_t size));
void *sieve_prealloc __P((list_t *pool, void *ptr, size_t size));
void sieve_pfree __P((list_t *pool, void *ptr));
char *sieve_pstrdup __P((list_t *pool, const char *str));
-int sieve_compile __P((sieve_machine_t mach, const char *name));
-
-sieve_value_t * sieve_value_create __P((sieve_data_type type, void *data));
+sieve_value_t *sieve_value_create __P((sieve_data_type type, void *data));
+void sieve_slist_destroy __P((list_t *plist));
+/* Symbol space functions */
sieve_register_t *sieve_test_lookup __P((const char *name));
sieve_register_t *sieve_action_lookup __P((const char *name));
int sieve_register_test __P((const char *name, sieve_handler_t handler,
@@ -118,64 +126,72 @@ int sieve_register_test __P((const char *name, sieve_handler_t handler,
int sieve_register_action __P((const char *name, sieve_handler_t handler,
sieve_data_type *arg_types,
sieve_tag_group_t *tags, int required));
+int sieve_register_comparator __P((const char *name,
+ int required,
+ sieve_comparator_t is,
+ sieve_comparator_t contains,
+ sieve_comparator_t matches,
+ sieve_comparator_t regex));
+sieve_comparator_t sieve_comparator_lookup __P((const char *name,
+ int matchtype));
-void sieve_slist_destroy __P((list_t *plist));
+sieve_comparator_t sieve_get_comparator __P((list_t tags));
void sieve_require __P((list_t slist));
-void sieve_abort __P((sieve_machine_t mach));
+/* Operations in value lists */
+sieve_value_t *sieve_value_get __P((list_t vlist, size_t index));
+int sieve_vlist_do __P((sieve_value_t *val, list_action_t *ac, void *data));
+int sieve_vlist_compare __P((sieve_value_t *a, sieve_value_t *b,
+ sieve_comparator_t comp, sieve_retrieve_t ac,
+ void *data));
+
+/* Functions to create and destroy sieve machine */
+int sieve_machine_init __P((sieve_machine_t *mach, void *data));
+void sieve_machine_destroy __P((sieve_machine_t *pmach));
+int sieve_machine_add_destructor __P((sieve_machine_t mach,
+ sieve_destructor_t destr,
+ void *ptr));
+/* Functions for accessing sieve machine internals */
void *sieve_get_data __P((sieve_machine_t mach));
message_t sieve_get_message __P((sieve_machine_t mach));
size_t sieve_get_message_num __P((sieve_machine_t mach));
int sieve_get_debug_level __P((sieve_machine_t mach));
ticket_t sieve_get_ticket __P((sieve_machine_t mach));
+mailer_t sieve_get_mailer __P((sieve_machine_t mach));
+char *sieve_get_daemon_email __P((sieve_machine_t mach));
+
+void sieve_set_error __P((sieve_machine_t mach, sieve_printf_t error_printer));
+void sieve_set_parse_error __P((sieve_machine_t mach, sieve_parse_error_t p));
+void sieve_set_debug __P((sieve_machine_t mach, sieve_printf_t debug));
+void sieve_set_debug_level __P((sieve_machine_t mach, mu_debug_t dbg,
+ int level));
+void sieve_set_logger __P((sieve_machine_t mach, sieve_action_log_t logger));
+void sieve_set_ticket __P((sieve_machine_t mach, ticket_t ticket));
+void sieve_set_mailer __P((sieve_machine_t mach, mailer_t mailer));
+void sieve_set_daemon_email __P((sieve_machine_t mach, const char *email));
+
+/* Logging and diagnostic functions */
void sieve_error __P((sieve_machine_t mach, const char *fmt, ...));
void sieve_debug __P((sieve_machine_t mach, const char *fmt, ...));
void sieve_log_action __P((sieve_machine_t mach, const char *action,
const char *fmt, ...));
+void sieve_abort __P((sieve_machine_t mach));
-int sieve_mailbox __P((sieve_machine_t mach, mailbox_t mbox));
-int sieve_disass __P((sieve_machine_t mach));
-
-int sieve_machine_init __P((sieve_machine_t *mach, void *data));
-void sieve_machine_destroy __P((sieve_machine_t *pmach));
-int sieve_machine_add_destructor __P((sieve_machine_t mach,
- sieve_destructor_t destr,
- void *ptr));
-
-void sieve_machine_set_error __P((sieve_machine_t mach,
- sieve_printf_t error_printer));
-void sieve_machine_set_parse_error __P((sieve_machine_t mach,
- sieve_parse_error_t p));
-void sieve_machine_set_debug __P((sieve_machine_t mach,
- sieve_printf_t debug));
-void sieve_machine_set_debug_level __P((sieve_machine_t mach,
- mu_debug_t dbg,
- int level));
-void sieve_machine_set_logger __P((sieve_machine_t mach,
- sieve_action_log_t logger));
-void sieve_machine_set_ticket __P((sieve_machine_t mach,
- ticket_t ticket));
-sieve_value_t *sieve_value_get __P((list_t vlist, size_t index));
int sieve_is_dry_run __P((sieve_machine_t mach));
+const char *sieve_type_str __P((sieve_data_type type));
-int sieve_vlist_do __P((sieve_value_t *val, list_action_t *ac, void *data));
-int sieve_vlist_compare __P((sieve_value_t *a, sieve_value_t *b,
- sieve_comparator_t comp, sieve_retrieve_t ac,
- void *data));
-
+/* Principal entry points */
-int sieve_register_comparator __P((const char *name,
- int required,
- sieve_comparator_t is,
- sieve_comparator_t contains,
- sieve_comparator_t matches,
- sieve_comparator_t regex));
-sieve_comparator_t sieve_comparator_lookup __P((const char *name,
- int matchtype));
+int sieve_compile __P((sieve_machine_t mach, const char *name));
+int sieve_mailbox __P((sieve_machine_t mach, mailbox_t mbox));
+int sieve_message __P((sieve_machine_t mach, message_t message));
+int sieve_disass __P((sieve_machine_t mach));
-sieve_comparator_t sieve_get_comparator __P((list_t tags));
+#ifdef __cplusplus
+}
+#endif
-const char *sieve_type_str __P((sieve_data_type type));
+#endif

Return to:

Send suggestions and report system problems to the System administrator.