Doxify error2.c and add GPL header.
[paraslash.git] / filter_common.c
index ffb2199b60e75836c345f09ef8cac1b1202d1956..2616c9bdfc940a3415ef6e5abd3a446d4e859b7e 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2012 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2013 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -41,25 +41,16 @@ void filter_init(void)
 static int parse_filter_args(int filter_num, char *options, void **conf)
 {
        struct filter *f = &filters[filter_num];
-       int ret, i, argc = 2;
+       int ret, argc;
        char **argv;
 
-//     PARA_DEBUG_LOG("%s, options: %s, parser: %p\n", f->name,
-//             options? options : "(none)", f->parse_config);
        if (!f->parse_config)
                return strlen(options)? -E_BAD_FILTER_OPTIONS : filter_num;
-//     PARA_DEBUG_LOG("options: %s\n", options);
-       argc = create_argv(options, " \t", &argv);
+       argc = create_shifted_argv(options, " \t", &argv);
        if (argc < 0)
                return -E_BAD_FILTER_OPTIONS;
-       PARA_DEBUG_LOG("argc = %d, argv[0]: %s\n", argc, argv[0]);
-       for (i = argc - 1; i >= 0; i--)
-               argv[i + 1] = argv[i];
        argv[0] = para_strdup(f->name);
-       argc++;
        ret = f->parse_config(argc, argv, conf);
-       free(argv[argc - 1]);
-       argv[argc - 1] = NULL;
        free_argv(argv);
        return ret < 0? ret : filter_num;
 }
@@ -110,35 +101,41 @@ int check_filter_arg(char *fa, void **conf)
 /**
  * Print help text of each filter to stdout.
  *
- * \param detailed If non-zero, print detailed help.
+ * \param flags Passed to \ref ggo_print_help().
  */
-void print_filter_helps(int detailed)
+void print_filter_helps(unsigned flags)
 {
-       int i;
+       int i, num = 0;
 
-       printf_or_die("\nAvailable filters: \n\t");
-       FOR_EACH_SUPPORTED_FILTER(i)
-               printf_or_die("%s%s", i? " " : "", filters[i].name);
-       printf_or_die("\n\n");
+       printf_or_die("\nAvailable filters: ");
+       FOR_EACH_SUPPORTED_FILTER(i) {
+               if (num > 50) {
+                       printf_or_die("\n                  ");
+                       num = 0;
+               }
+               num += printf_or_die("%s%s", i? " " : "", filters[i].name);
+       }
+       printf_or_die("\n");
 
        FOR_EACH_SUPPORTED_FILTER(i) {
                struct filter *f = filters + i;
 
                if (!f->help.short_help)
                        continue;
-               printf_or_die("Options for %s:\n", f->name);
-               ggo_print_help(&f->help, detailed);
+               printf_or_die("\nOptions for %s (%s):", f->name,
+                       f->help.purpose);
+               ggo_print_help(&f->help, flags);
        }
 }
 
 /**
- * Set select timeout of the the scheduler.
+ * Set select timeout of the scheduler.
  *
  * \param s The scheduler.
  * \param t The task struct of this filter.
  *
  * This looks at the status of the btr node of the filter. If data is available
- * in the input queue of the filter, or if an error occured, a minimal timeout
+ * in the input queue of the filter, or if an error occurred, a minimal timeout
  * for the next select call is requested from the scheduler. Otherwise the
  * scheduler timeout is left unchanged.
  */