From 2fb11492864a773a5d643435e3cbc41c1a560563 Mon Sep 17 00:00:00 2001
From: Nathanael Sensfelder <SpamShield0@MultiAgentSystems.org>
Date: Mon, 25 Sep 2017 11:11:48 +0200
Subject: Untested userfriendliness improvement for timeouts

Will be merged into the master branch after some testing.
---
 src/config.c | 170 +++++++++++++++++++++++++++++++++++++++++++++--------------
 src/config.h |  10 ----
 2 files changed, 131 insertions(+), 49 deletions(-)

diff --git a/src/config.c b/src/config.c
index bb78779..6243db2 100644
--- a/src/config.c
+++ b/src/config.c
@@ -244,11 +244,10 @@ static int read_axis_options
    return -1;
 }
 
-/*
 static int parse_timeout_option
 (
    struct relabsd_config * const conf,
-   FILE * const f
+   const char * const param
 )
 {
    int valc, timeout_msec;
@@ -258,7 +257,7 @@ static int parse_timeout_option
 
    errno = 0;
 
-   valc = fscanf(f, "%d", &timeout_msec);
+   valc = scanf(param, "%d", &timeout_msec);
 
    if (valc == EOF)
    {
@@ -266,14 +265,14 @@ static int parse_timeout_option
       {
          RELABSD_S_FATAL
          (
-            "[CONFIG] Unexpected end of file while reading timeout option."
+            "Unexpected end of file while reading timeout option."
          );
       }
       else
       {
          RELABSD_FATAL
          (
-            "[CONFIG] An error occured while reading timeout option: %s.",
+            "An error occured while reading timeout option: %s.",
             strerror(errno)
          );
       }
@@ -286,7 +285,7 @@ static int parse_timeout_option
    {
       RELABSD_S_FATAL
       (
-         "[CONFIG] Invalid parameter count for timeout option (1 expected)."
+         "Invalid parameter count for timeout option (1 int expected)."
       );
 
       errno = prev_errno;
@@ -294,6 +293,15 @@ static int parse_timeout_option
       return -1;
    }
 
+   if (timeout_msec <= 0)
+   {
+      RELABSD_FATAL
+      (
+         "Illegal value for timeout \"%d\": accepted range is [1, %d].",
+         timeout_msec,
+         INT_MAX
+      );
+   }
    memset((void *) &(conf->timeout), 0, sizeof(struct timeval));
 
    conf->timeout.tv_sec = (time_t) (timeout_msec / 1000);
@@ -306,7 +314,6 @@ static int parse_timeout_option
 
    return 0;
 }
-*/
 
 /*
  * Returns -1 on (fatal) error,
@@ -521,6 +528,27 @@ static int read_config_file
    return 0;
 }
 
+static void print_usage
+(
+   const char * const exec
+)
+{
+   RELABSD_FATAL
+   (
+      "USAGE: %s input_device config_file [<OPTION>+]\n"
+      "<OPTION>:\n"
+      "\t [-n | --name] <relabsd_device_name>: Names the virtual device.\n"
+      "\t [-t | --timeout] <timeout_in_ms>: Resets all enabled axes to zero"
+      " <timeout_in_ms> milliseconds after the last event. Range for"
+      " <timeout_in_ms>: [1, %d].\n"
+      "Alternatively, the previous usage is still supported:\n"
+      "\t%s input_device config_file [<relabsd_device_name>]\n"
+      "However, with that usage, <relabsd_device_name> cannot start with '-'.",
+      exec,
+      INT_MAX,
+      exec
+   );
+}
 /*
  * Returns -1 on (fatal) error,
  *          0 on valid usage.
@@ -531,13 +559,9 @@ static int check_usage
    char * const * const argv
 )
 {
-   if ((argc < 3) || (argc > 4))
+   if (argc < 3)
    {
-      RELABSD_FATAL
-      (
-         "Usage: %s input_device config_file [<relabsd_device_name>]",
-         argv[0]
-      );
+      print_usage(argv[0]);
 
       return -1;
    }
@@ -555,32 +579,21 @@ static void init_axes_config (struct relabsd_config * const conf)
    }
 }
 
-int relabsd_config_parse
+static int parse_options
 (
    struct relabsd_config * const conf,
    int const argc,
    char * const * const argv
 )
 {
-   RELABSD_S_DEBUG(RELABSD_DEBUG_PROGRAM_FLOW, "Parsing config & params...");
+   int i;
 
-   if (check_usage(argc, argv) < 0)
+   if ((argc == 4) && !RELABSD_IS_PREFIX("-", argv[3]))
    {
-      return -1;
-   }
+      /* Old usage */
 
-   if (argc == 3)
-   {
-      conf->device_name = NULL;
+      RELABSD_S_DEBUG(RELABSD_DEBUG_CONFIG, "Old usage detected.");
 
-      RELABSD_S_DEBUG
-      (
-         RELABSD_DEBUG_CONFIG,
-         "No virtual device name param, will use the real device's."
-      );
-   }
-   else
-   {
       conf->device_name = argv[3];
 
       RELABSD_DEBUG
@@ -589,6 +602,95 @@ int relabsd_config_parse
          "Virtual device name param set to '%s'.",
          conf->device_name
       );
+
+      return 0;
+   }
+
+   conf->device_name = NULL;
+   conf->enable_timeout = 0;
+
+   for (i = 3; i < argc; ++i)
+   {
+      if
+      (
+         RELABSD_STRING_EQUALS("-n", argv[i])
+         || RELABSD_STRING_EQUALS("--name", argv[i])
+      )
+      {
+         i += 1;
+
+         if (i >= argc)
+         {
+            RELABSD_S_FATAL
+            (
+               "Missing value for parameter \"--name\"."
+            );
+
+            print_usage(argv[0]);
+
+            return -1;
+         }
+
+         conf->device_name = argv[i];
+      }
+      else if
+      (
+         RELABSD_STRING_EQUALS("-t", argv[i])
+         || RELABSD_STRING_EQUALS("--timeout", argv[i])
+      )
+      {
+         i += 1;
+
+         if (i >= argc)
+         {
+            RELABSD_S_FATAL
+            (
+               "Missing value for parameter \"--timeout\"."
+            );
+
+            print_usage(argv[0]);
+
+            return -1;
+         }
+
+         if (parse_timeout_option(conf, argv[i]) < 0)
+         {
+            return -1;
+         }
+      }
+      else
+      {
+         RELABSD_FATAL
+         (
+            "Unknown parameter \"%s\".",
+            argv[i]
+         );
+
+         print_usage(argv[0]);
+
+         return -1;
+      }
+   }
+
+   return 0;
+}
+int relabsd_config_parse
+(
+   struct relabsd_config * const conf,
+   int const argc,
+   char * const * const argv
+)
+{
+   RELABSD_S_DEBUG(RELABSD_DEBUG_PROGRAM_FLOW, "Parsing config & params...");
+
+   if (check_usage(argc, argv) < 0)
+   {
+      return -1;
+   }
+
+   if (parse_options(conf, argc, argv) < 0)
+   {
+      return -1;
    }
 
    conf->input_file = argv[1];
@@ -607,16 +709,6 @@ int relabsd_config_parse
       return -1;
    }
 
-   conf->enable_timeout = RELABSD_ENABLE_TIMEOUT;
-
-   conf->timeout.tv_sec = (time_t) (RELABSD_TIMEOUT_MSEC / 1000);
-
-   conf->timeout.tv_usec =
-      (
-         ((suseconds_t) RELABSD_TIMEOUT_MSEC)
-         * ((suseconds_t) 1000)
-      );
-
    return 0;
 }
 
diff --git a/src/config.h b/src/config.h
index 92852d9..3aa1a13 100644
--- a/src/config.h
+++ b/src/config.h
@@ -11,16 +11,6 @@
 /* Number of options that can be configured. */
 #define RELABSD_OPTIONS_COUNT 3
 
-/* TODO: turn this into a runtime parameter */
-#ifndef RELABSD_ENABLE_TIMEOUT
-   #define RELABSD_ENABLE_TIMEOUT 1
-#endif
-
-/* TODO: turn this into a runtime parameter */
-#ifndef RELABSD_TIMEOUT_MSEC
-   #define RELABSD_TIMEOUT_MSEC 100
-#endif
-
 enum relabsd_option
 {
    RELABSD_DIRECT_OPTION,
-- 
cgit v1.2.3-70-g09d2