X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=filter.c;h=40fbc844b35c70fa0070ad3d9652110fc6ae83ea;hb=c4b1b0d61d89e027582aaf87aa9fc737ff5554ff;hp=f49042f8c7ecfe901bcb01b5ef889d12e93b71b5;hpb=639a90049f74b4ce528376afe8ec8e84edf16208;p=paraslash.git

diff --git a/filter.c b/filter.c
index f49042f8..40fbc844 100644
--- a/filter.c
+++ b/filter.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
  *     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
@@ -28,17 +28,37 @@
 #include "stdout.h"
 #include "error.h"
 
+/** init the array of errors for para_filter */
 INIT_FILTER_ERRLISTS;
 
+/** the task that reads from stdin */
 static struct stdin_task stdin_task_struct;
+/** pointer to the stdin task */
 static struct stdin_task *sit = &stdin_task_struct;
+
+/** the task that filters the data */
 static struct filter_chain filter_chain_struct;
+/** pointer to the filter chain */
 static struct filter_chain *fc = &filter_chain_struct;
+
+/** the task that writes converted data to stdout */
 static struct stdout_task stdout_task_struct;
+/** pointer to the stdout task */
 static struct stdout_task *sot = &stdout_task_struct;
 
-struct gengetopt_args_info conf;
+/** gengetopt struct that holds the command line args */
+static struct filter_args_info conf;
+
 
+/**
+ * standard log function that always writes to stderr
+ *
+ * \param ll loglevel. If the loglevel of the current message
+ * is less than \a ll, the message is going to be ignored.
+ *
+ * \param fmt the format string describing the log message.
+ *
+ */
 __printf_2_3 void para_log(int ll, const char* fmt,...)
 {
 	va_list argp;
@@ -51,7 +71,7 @@ __printf_2_3 void para_log(int ll, const char* fmt,...)
 	va_end(argp);
 }
 
-void filter_event_handler(struct task *t)
+static void filter_event_handler(struct task *t)
 {
 	PARA_NOTICE_LOG("%s\n", PARA_STRERROR(-t->ret));
 	unregister_task(t);
@@ -69,7 +89,6 @@ static void open_filters(void)
 	}
 }
 
-
 static int init_filter_chain(void)
 {
 	int i, filter_num;
@@ -113,7 +132,7 @@ static int parse_config(int argc, char *argv[])
 	struct stat statbuf;
 	int i;
 
-	if (cmdline_parser(argc, argv, &conf))
+	if (filter_cmdline_parser(argc, argv, &conf))
 		return -E_FILTER_SYNTAX;
 	if (!cf) {
 		char *home = para_homedir();
@@ -121,7 +140,7 @@ static int parse_config(int argc, char *argv[])
 		free(home);
 	}
 	if (!stat(cf, &statbuf)) {
-		if (cmdline_parser_configfile(cf, &conf, 0, 0, 0))
+		if (filter_cmdline_parser_configfile(cf, &conf, 0, 0, 0))
 			return -E_FILTER_SYNTAX;
 	}
 	if (!conf.list_filters_given)
@@ -135,6 +154,18 @@ static int parse_config(int argc, char *argv[])
 	exit(EXIT_SUCCESS);
 }
 
+/**
+ * para_filter's main function.
+ *
+ * para_filter reads data from stdin, converts it by using a chain
+ * of filters (specified on the command line) and writes the resulting
+ * data to stdout.
+ *
+ * \param argc number of command line options
+ * \param argv vector of arguments
+ *
+ * \return \a EXIT_SUCCESS on success, EXIT_FAILURE on errors.
+ */
 int main(int argc, char *argv[])
 {
 	int ret;