Constify argument of check_filter_arg().
[paraslash.git] / filter.c
index 599aaad97815b67c68464c094866ce4d1bd6e5a4..9378e4695b6b113843d7d1b34a96ded4bdebd79e 100644 (file)
--- a/filter.c
+++ b/filter.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -7,7 +7,6 @@
 /** \file filter.c The stand-alone filter program. */
 
 #include <regex.h>
-#include <stdbool.h>
 
 #include "para.h"
 #include "filter.cmdline.h"
 #include "stdin.h"
 #include "stdout.h"
 #include "error.h"
+#include "version.h"
 
 /** The list of all status items used by para_{server,audiod,gui}. */
 const char *status_item_list[] = {STATUS_ITEM_ARRAY};
 
+/**
+ * Dummy version which only contains NULL pointers.
+ *
+ * This is used by the amp filter which first tries to obtain the amplification
+ * value from an element in this array.
+ */
 char *stat_item_values[NUM_STAT_ITEMS] = {NULL};
 
 /** Initialize the array of errors for para_filter. */
@@ -34,11 +40,6 @@ 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. */
@@ -50,91 +51,24 @@ static struct filter_args_info conf;
 static int loglevel;
 INIT_STDERR_LOGGING(loglevel);
 
-static void open_filters(void)
-{
-       int i;
-       struct filter_node *fn;
-
-       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->outbufp = &fn->buf;
-               fc->out_loaded = &fn->loaded;
-       }
-}
-
-static void free_filter_confs(void)
-{
-       int i;
-       struct filter_node *fn;
-
-       FOR_EACH_FILTER_NODE(fn, fc, i)
-               free(fn->conf);
-}
-
-static int init_filter_chain(void)
-{
-       int i, ret;
-       struct filter_node *fn;
-
-       if (!conf.filter_given)
-               return -E_NO_FILTERS;
-       fc->num_filters = conf.filter_given;
-       fc->filter_nodes = para_calloc(fc->num_filters * sizeof(struct filter_node));
-       fc->inbufp = &sit->buf;
-       fc->in_loaded = &sit->loaded;
-       fc->input_error = &sit->task.error;
-       fc->task.error = 0;
-       fc->output_error = &sot->task.error;
-       fc->task.post_select = filter_post_select;
-       sprintf(fc->task.status, "filter chain");
-
-       FOR_EACH_FILTER_NODE(fn, fc, i) {
-               char *fa = conf.filter_arg[i];
-               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);
-               PARA_DEBUG_LOG("filter #%d: %s\n", i, filters[fn->filter_num].name);
-       }
-       open_filters();
-       return 1;
-err:
-       free_filter_confs();
-       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;
+       struct ggo_help h = DEFINE_GGO_HELP(filter);
+       bool d = conf.detailed_help_given;
 
-       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);
+       ggo_print_help(&h, d? GPH_STANDARD_FLAGS_DETAILED : GPH_STANDARD_FLAGS);
+       print_filter_helps(d? GPH_MODULE_FLAGS_DETAILED : GPH_MODULE_FLAGS);
+       exit(EXIT_SUCCESS);
 }
 
-static int parse_config(int argc, char *argv[])
+static int parse_config(void)
 {
        static char *cf; /* config file */
        struct stat statbuf;
 
-       if (filter_cmdline_parser(argc, argv, &conf))
-               return -E_FILTER_SYNTAX;
-       HANDLE_VERSION_FLAG("filter", conf);
+       version_handle_flag("filter", conf.version_given);
        if (conf.help_given || conf.detailed_help_given)
                print_help_and_die();
-       loglevel = get_loglevel_by_name(conf.loglevel_arg);
        if (!cf) {
                char *home = para_homedir();
                cf = make_message("%s/.paraslash/filter.conf", home);
@@ -148,121 +82,96 @@ static int parse_config(int argc, char *argv[])
                        .check_ambiguity = 0,
                        .print_errors = 1
                };
-               if (filter_cmdline_parser_config_file(cf, &conf, &params))
-                       return -E_FILTER_SYNTAX;
+               filter_cmdline_parser_config_file(cf, &conf, &params);
+               loglevel = get_loglevel_by_name(conf.loglevel_arg);
        }
+       if (!conf.filter_given)
+               return -E_NO_FILTERS;
        return 1;
 }
 
-/* TODO: support buffer tree, not just a chain. */
-static int __noreturn main_btr(void)
+/**
+ * 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[])
 {
        static struct sched s;
        int i, ret;
-       struct filter *f;
+       const struct filter *f;
        struct btr_node *parent;
        struct filter_node **fns;
 
-       sit->btrn = btr_new_node("stdin", NULL, NULL, NULL);
-       stdin_set_defaults(sit);
-       register_task(&sit->task);
+       filter_cmdline_parser(argc, argv, &conf); /* aborts on errors */
+       loglevel = get_loglevel_by_name(conf.loglevel_arg);
+       filter_init();
+       ret = parse_config();
+       if (ret < 0)
+               goto out;
+       sit->btrn = btr_new_node(&(struct btr_node_description)
+               EMBRACE(.name = "stdin"));
+       stdin_task_register(sit, &s);
 
        fns = para_malloc(conf.filter_given * sizeof(*fns));
        for (i = 0, parent = sit->btrn; i < conf.filter_given; i++) {
                char *fa = conf.filter_arg[i];
                struct filter_node *fn;
+               struct task_info ti;
 
                fn = fns[i] = para_calloc(sizeof(*fn));
                ret = check_filter_arg(fa, &fn->conf);
                if (ret < 0) {
                        free(fn);
-                       goto out;
+                       goto out_cleanup;
                }
                fn->filter_num = ret;
-               f = filters + fn->filter_num;
-               sprintf(fn->task.status, "%s", f->name);
+               f = filter_get(fn->filter_num);
                PARA_DEBUG_LOG("filter #%d: %s\n", i, f->name);
-               fn->btrn = btr_new_node(f->name, parent, f->execute, fn);
-               fn->task.pre_select = f->pre_select;
-               fn->task.post_select = f->post_select;
+               fn->btrn = btr_new_node(&(struct btr_node_description)
+                       EMBRACE(.name = f->name, .parent = parent,
+                       .handler = f->execute, .context = fn));
+               ti.name = f->name;
+               ti.pre_select = f->pre_select;
+               ti.post_select = f->post_select;
+               ti.context = fn;
                f->open(fn);
-               register_task(&fn->task);
+               fn->task = task_register(&ti, &s);
                parent = fn->btrn;
        }
-       sot->btrn = btr_new_node("stdout", parent, NULL, NULL);
-       stdout_set_defaults(sot);
-       register_task(&sot->task);
+       sot->btrn = btr_new_node(&(struct btr_node_description)
+               EMBRACE(.name = "stdout", .parent = parent));
+       stdout_task_register(sot, &s);
 
        s.default_timeout.tv_sec = 1;
        s.default_timeout.tv_usec = 0;
        btr_log_tree(sit->btrn, LL_INFO);
        ret = schedule(&s);
-out:
+       sched_shutdown(&s);
+out_cleanup:
        for (i--; i >= 0; i--) {
                struct filter_node *fn = fns[i];
 
-               f = filters + fn->filter_num;
-               f->close(fn);
-               btr_free_node(fn->btrn);
-               free(fn->conf);
+               f = filter_get(fn->filter_num);
+               if (f->close)
+                       f->close(fn);
+               btr_remove_node(&fn->btrn);
+               if (f->free_config)
+                       f->free_config(fn->conf);
                free(fn);
        }
        free(fns);
-       btr_free_node(sit->btrn);
-       btr_free_node(sot->btrn);
-       if (ret < 0)
-               PARA_EMERG_LOG("%s\n", para_strerror(-ret));
-       exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
-}
-
-/**
- * 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;
-       static struct sched s;
-
-       filter_init();
-       ret = parse_config(argc, argv);
-       if (ret < 0)
-               goto out;
-       if (conf.buffer_tree_given) {
-               ret = main_btr();
-               goto out;
-       }
-       stdin_set_defaults(sit);
-       sit->buf = para_malloc(sit->bufsize),
-
-       ret = init_filter_chain();
-       if (ret < 0)
-               goto out;
-       sit->output_error = &fc->task.error;
-
-       stdout_set_defaults(sot);
-       sot->bufp = fc->outbufp;
-       sot->loaded = fc->out_loaded;
-       sot->input_error = &fc->task.error;
-
-       register_task(&sit->task);
-       register_task(&sot->task);
-       register_task(&fc->task);
-       s.default_timeout.tv_sec = 1;
-       s.default_timeout.tv_usec = 0;
-       ret = schedule(&s);
-       close_filters(fc);
+       btr_remove_node(&sit->btrn);
+       btr_remove_node(&sot->btrn);
 out:
-       free(sit->buf);
        if (ret < 0)
                PARA_EMERG_LOG("%s\n", para_strerror(-ret));
-       return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
+       exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
 }