FEATURES: Fix a typo and use uniform capitalization for list items.

[paraslash.git] / filter.c

diff --git a/filter.c b/filter.c
index f49042f8c7ecfe901bcb01b5ef889d12e93b71b5..af62ba6a846663ecc8a08565c7c2f2b6f615ea89 100644 (file)
--- a/filter.c
+++ b/filter.c
@@ -1,19 +1,7 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2008 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
- *     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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 /** \file filter.c the stand-alone filter program */
 
@@ -28,32 +16,32 @@
 #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;
 
-__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));
+       PARA_NOTICE_LOG("%s\n", para_strerror(-t->ret));
        unregister_task(t);
 }
 
@@ -69,7 +57,6 @@ static void open_filters(void)
        }
 }
 
-
 static int init_filter_chain(void)
 {
        int i, filter_num;
@@ -79,9 +66,9 @@ static int init_filter_chain(void)
 
        fc->inbuf = sit->buf;
        fc->in_loaded = &sit->loaded;
-       fc->input_eof = &sit->eof;
-       fc->eof = 0;
-       fc->output_eof = &sot->eof;
+       fc->input_error = &sit->error;
+       fc->error = 0;
+       fc->output_error = &sot->error;
        fc->task.private_data = fc;
        fc->task.pre_select = filter_pre_select;
        fc->task.event_handler = filter_event_handler;
@@ -113,15 +100,22 @@ 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;
+       HANDLE_VERSION_FLAG("filter", conf);
        if (!cf) {
                char *home = para_homedir();
                cf = make_message("%s/.paraslash/filter.conf", home);
                free(home);
        }
        if (!stat(cf, &statbuf)) {
-               if (cmdline_parser_configfile(cf, &conf, 0, 0, 0))
+               struct filter_cmdline_parser_params params = {
+                       .override = 0,
+                       .initialize = 0,
+                       .check_required = 0,
+                       .check_ambiguity = 0
+               };
+               if (filter_cmdline_parser_config_file(cf, &conf, &params))
                        return -E_FILTER_SYNTAX;
        }
        if (!conf.list_filters_given)
@@ -135,6 +129,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;
@@ -154,18 +160,18 @@ int main(int argc, char *argv[])
        stdout_set_defaults(sot);
        sot->buf = fc->outbuf;
        sot->loaded = fc->out_loaded;
-       sot->input_eof = &fc->eof;
+       sot->input_error = &fc->error;
 
-       register_task(&sot->task);
-       register_task(&fc->task);
        register_task(&sit->task);
+       register_task(&fc->task);
+       register_task(&sot->task);
        s.default_timeout.tv_sec = 1;
        s.default_timeout.tv_usec = 0;
-       ret = sched(&s);
+       ret = schedule(&s);
 out:
        free(sit->buf);
        close_filters(fc);
        if (ret < 0)
-               PARA_EMERG_LOG("%s\n", PARA_STRERROR(-ret));
+               PARA_EMERG_LOG("%s\n", para_strerror(-ret));
        return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
 }