Move ggo files to a separate directory.
[paraslash.git] / filter.c
index ee7e6dbcd1270a89939d8c30ca46db08acb97c3c..50b17ad7f41293fd63068303bba5c1bef5e33605 100644 (file)
--- a/filter.c
+++ b/filter.c
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2009 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 */
+
+/** \file filter.c The stand-alone filter program. */
 
 #include "para.h"
 
 #include "filter.cmdline.h"
 #include "list.h"
 #include "sched.h"
+#include "ggo.h"
 #include "filter.h"
 #include "string.h"
 #include "stdin.h"
 #include "stdout.h"
 #include "error.h"
 
-INIT_FILTER_ERRLISTS;
+/** The list of all status items used by para_{server,audiod,gui}. */
+const char *status_item_list[] = {STATUS_ITEM_ARRAY};
 
-#define INBUF_SIZE 32 * 1024
+char *stat_item_values[NUM_STAT_ITEMS] = {NULL};
 
+/** Initialize 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);
-}
-
-void filter_event_handler(struct task *t)
-{
-       PARA_NOTICE_LOG("%s\n", PARA_STRERROR(-t->ret));
-       unregister_task(t);
-}
+INIT_STDERR_LOGGING(conf.loglevel_arg);
 
 static void open_filters(void)
 {
+       int i;
        struct filter_node *fn;
 
-       list_for_each_entry(fn, &fc->filters, node) {
-               fn->filter->open(fn);
-               PARA_INFO_LOG("opened %s filter\n", fn->filter->name);
+       FOR_EACH_FILTER_NODE(fn, fc, i) {
+               struct filter *f = filters + fn->filter_num;
+               f->open(fn);
+               PARA_INFO_LOG("opened %s filter\n", f->name);
                fc->outbuf = fn->buf;
                fc->out_loaded = &fn->loaded;
        }
 }
 
-
 static int init_filter_chain(void)
 {
-       int i, filter_num;
+       int i, ret;
        struct filter_node *fn;
 
-       INIT_LIST_HEAD(&fc->filters);
-
+       if (!conf.filter_given)
+               return -E_NO_FILTERS;
+       fc->num_filters = conf.filter_given;
+       fc->filter_nodes = para_malloc(fc->num_filters * sizeof(struct filter_node));
        fc->inbuf = sit->buf;
        fc->in_loaded = &sit->loaded;
-       fc->input_eof = &sit->eof;
-       fc->eof = 0;
-       fc->output_eof = &sot->eof;
-       fc->task.private_data = fc;
+       fc->input_error = &sit->task.error;
+       fc->task.error = 0;
+       fc->output_error = &sot->task.error;
        fc->task.pre_select = filter_pre_select;
-       fc->task.event_handler = filter_event_handler;
        sprintf(fc->task.status, "filter chain");
 
-       for (i = 0; i < conf.filter_given; i++) {
+       FOR_EACH_FILTER_NODE(fn, fc, i) {
                char *fa = conf.filter_arg[i];
-               fn = para_calloc(sizeof(struct filter_node));
-               filter_num = check_filter_arg(fa, &fn->conf);
-               if (filter_num < 0) {
-                       free(fn);
-                       return filter_num;
-               }
+               fn = fc->filter_nodes + i;
+               ret = check_filter_arg(fa, &fn->conf);
+               if (ret < 0)
+                       goto err;
+               fn->filter_num = ret;
                fn->fc = fc;
                INIT_LIST_HEAD(&fn->callbacks);
-               fn->filter = &filters[filter_num];
-               PARA_DEBUG_LOG("adding %s to filter chain\n", fn->filter->name);
-               list_add_tail(&fn->node, &fc->filters);
+               PARA_DEBUG_LOG("filter #%d: %s\n", i, filters[fn->filter_num].name);
        }
-       if (list_empty(&fc->filters))
-               return -E_NO_FILTERS;
        open_filters();
        return 1;
+err:
+       free(fc->filter_nodes);
+       return ret;
+}
+
+__noreturn static void print_help_and_die(void)
+{
+       int d = conf.detailed_help_given;
+       const char **p = d? filter_args_info_detailed_help
+               : filter_args_info_help;
+
+       printf_or_die("%s\n\n", FILTER_CMDLINE_PARSER_PACKAGE "-"
+               FILTER_CMDLINE_PARSER_VERSION);
+       printf_or_die("%s\n\n", filter_args_info_usage);
+       for (; *p; p++)
+               printf_or_die("%s\n", *p);
+       print_filter_helps(d);
+       exit(0);
 }
 
 static int parse_config(int argc, char *argv[])
 {
        static char *cf; /* config file */
        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 (conf.help_given || conf.detailed_help_given)
+               print_help_and_die();
        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)
-               return 1;
-       printf("available filters: ");
-       for (i = 0; filters[i].name; i++)
-               printf("%s%s%s", i? " " : "", filters[i].name,
-                       filters[i].parse_config? "*": "");
-       printf("\nFilters marked with \"*\" have further command line options. Try\n"
-               "\tpara_filter -f '<filtername> -h'\nfor more information.\n");
-       exit(EXIT_SUCCESS);
+       return 1;
 }
 
+/**
+ * The main function of para_filter.
+ *
+ * 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;
-       struct sched s;
+       static struct sched s;
 
-       init_sched();
        stdin_set_defaults(sit);
        sit->buf = para_malloc(sit->bufsize),
 
@@ -153,24 +165,23 @@ int main(int argc, char *argv[])
        ret = init_filter_chain();
        if (ret < 0)
                goto out;
+       sit->output_error = &fc->task.error;
 
        stdout_set_defaults(sot);
-       PARA_EMERG_LOG("fc->output_eof: %d\n", *fc->output_eof);
        sot->buf = fc->outbuf;
        sot->loaded = fc->out_loaded;
-       sot->input_eof = &fc->eof;
+       sot->input_error = &fc->task.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;
-       PARA_EMERG_LOG("fc->output_eof: %d\n", *fc->output_eof);
-       ret = sched(&s);
+       ret = schedule(&s);
+       close_filters(fc);
 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;
 }