Make functions for printing recv/filter/write help public.

[paraslash.git] / filter.c

diff --git a/filter.c b/filter.c
index 81d5df1a635044e61ee66aba03eca876c8bee398..d67aeae44a8d226866c6fcf1a46c192ea4a15cc7 100644 (file)
--- a/filter.c
+++ b/filter.c
@@ -3,38 +3,45 @@
  *
  * 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 the array of errors for para_filter */
+/** The list of all status items used by para_{server,audiod,gui}. */
+const char *status_item_list[] = {STATUS_ITEM_ARRAY};
+
+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 */
+/** The task that reads from stdin. */
 static struct stdin_task stdin_task_struct;
-/** pointer to the stdin task */
+/** pointer to the stdin task. */
 static struct stdin_task *sit = &stdin_task_struct;
 
-/** the task that filters the data */
+/** The task that filters the data. */
 static struct filter_chain filter_chain_struct;
-/** pointer to the filter chain */
+/** Pointer to the filter chain. */
 static struct filter_chain *fc = &filter_chain_struct;
 
-/** the task that writes converted data to stdout */
+/** The task that writes converted data to stdout. */
 static struct stdout_task stdout_task_struct;
-/** pointer to the stdout task */
+/** Pointer to the stdout task. */
 static struct stdout_task *sot = &stdout_task_struct;
 
-/** gengetopt struct that holds the command line args */
+/** Gengetopt struct that holds the command line args. */
 static struct filter_args_info conf;
 
 INIT_STDERR_LOGGING(conf.loglevel_arg);
@@ -75,7 +82,7 @@ static int init_filter_chain(void)
                fn = fc->filter_nodes + i;
                ret = check_filter_arg(fa, &fn->conf);
                if (ret < 0)
-                       return ret;
+                       goto err;
                fn->filter_num = ret;
                fn->fc = fc;
                INIT_LIST_HEAD(&fn->callbacks);
@@ -83,17 +90,36 @@ static int init_filter_chain(void)
        }
        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 (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);
@@ -109,33 +135,25 @@ static int parse_config(int argc, char *argv[])
                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;
 }
 
 /**
- * para_filter's main function.
+ * The main function of para_filter.
  *
- * para_filter reads data from stdin, converts it by using a chain
+ * 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
+ * \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;
 
        stdin_set_defaults(sit);
        sit->buf = para_malloc(sit->bufsize),
@@ -147,6 +165,7 @@ 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);
        sot->buf = fc->outbuf;
@@ -159,9 +178,9 @@ int main(int argc, char *argv[])
        s.default_timeout.tv_sec = 1;
        s.default_timeout.tv_usec = 0;
        ret = schedule(&s);
+       close_filters(fc);
 out:
        free(sit->buf);
-       close_filters(fc);
        if (ret < 0)
                PARA_EMERG_LOG("%s\n", para_strerror(-ret));
        return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;