para.h: Add documentation of PARA_MAX, PARA_MIN, PARA_ABS
[paraslash.git] / filter.c
index 0d1c2e2..d1f8853 100644 (file)
--- 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
 #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 filter_args_info conf;
+/** gengetopt struct that holds the command line args */
+static struct filter_args_info conf;
 
-__printf_2_3 void para_log(int ll, const char* fmt,...)
-{
-       va_list argp;
-
-       /* ignore log message if loglevel is not high enough */
-       if (ll < conf.loglevel_arg)
-               return;
-       va_start(argp, fmt);
-       vfprintf(stderr, fmt, argp);
-       va_end(argp);
-}
+INIT_STDERR_LOGGING(conf.loglevel_arg);
 
-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 +69,6 @@ static void open_filters(void)
        }
 }
 
-
 static int init_filter_chain(void)
 {
        int i, filter_num;
@@ -115,6 +114,7 @@ static int parse_config(int argc, char *argv[])
 
        if (filter_cmdline_parser(argc, argv, &conf))
                return -E_FILTER_SYNTAX;
+       HANDLE_VERSION_FLAG("filter", conf);
        if (!cf) {
                char *home = para_homedir();
                cf = make_message("%s/.paraslash/filter.conf", home);
@@ -135,6 +135,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;