Simple command line argument parsing utility in PJLIB (#4013)

Author: bennylp

pjlib/build/pjlib.vcproj

@@ -12637,6 +12637,10 @@
 			Name="Header Files"
 			Filter="h;hpp;hxx;hm;inl"
 			>
+			<File
+				RelativePath="..\include\pj\argparse.h"
+				>
+			</File>
 			<File
 				RelativePath="..\include\pj\activesock.h"
 				>

pjlib/build/pjlib.vcxproj

@@ -1036,6 +1036,7 @@
     <ClInclude Include="..\include\pjlib.h" />
     <ClInclude Include="..\include\pj\activesock.h" />
     <ClInclude Include="..\include\pj\addr_resolv.h" />
+    <ClInclude Include="..\include\pj\argparse.h" />
     <ClInclude Include="..\include\pj\array.h" />
     <ClInclude Include="..\include\pj\assert.h" />
     <ClInclude Include="..\include\pj\compat\assert.h" />

pjlib/build/pjlib.vcxproj.filters

@@ -442,5 +442,8 @@
     <ClInclude Include="..\src\pj\ssl_sock_imp_common.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="..\include\pj\argparse.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
 </Project>

pjlib/include/pj/argparse.h

@@ -0,0 +1,205 @@
+/*
+ * Copyright (C) 2008-2024 Teluu Inc. (http://www.teluu.com)
+ *
+ * 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-1307  USA
+ */
+#ifndef __PJ_ARGPARSE_H__
+#define __PJ_ARGPARSE_H__
+
+/**
+ * @file argparse.h
+ * @brief Command line argument parser
+ */
+#include <pj/ctype.h>
+#include <pj/errno.h>
+#include <pj/string.h>
+
+PJ_BEGIN_DECL
+
+/**
+ * Define function to display parsing error.
+ */
+#ifndef PJ_ARGPARSE_ERROR
+#  include <stdio.h>
+#  define PJ_ARGPARSE_ERROR(fmt, arg) printf(fmt "\n", arg)
+#endif
+
+
+/**
+ * @defgroup PJ_ARGPARSE Command line argument parser
+ * @ingroup PJ_MISC
+ * @{
+ *
+ * This module provides header only utilities to parse command line arguments.
+ * This is mostly used by PJSIP test and sample apps. Note that there is
+ * getopt() implementation in PJLIB-UTIL (but it's in PJLIB-UTIL, so it can't
+ * be used by PJLIB).
+ *
+ * Limitations:
+ * - the utility only supports white space(s) as separator between an option
+ *   and its value. Equal sign is not supported.
+ * - the utility does not support double dash (--) as separator between options
+ *   and operands. It will keep treating arguments after -- as possible
+ *   options.
+ */
+
+/**
+ * Peek the next possible option from argv. An argument is considered an
+ * option if it starts with "-".
+ *
+ * @param argv      The argv, which must be null terminated.
+ *
+ * @return          next option or NULL.
+ */
+PJ_INLINE(char*) pj_argparse_peek_next_option(char *const argv[])
+{
+    while (*argv) {
+        const char *arg = *argv;
+        if (*arg=='-') {
+            return *argv;
+        }
+        ++argv;
+    }
+    return NULL;
+}
+
+/**
+ * Check that an option exists, without modifying argv.
+ *
+ * @param argv      The argv, which must be null terminated.
+ * @param opt       The option to find, e.g. "-h", "--help"
+ *
+ * @return          PJ_TRUE if the option exists, else PJ_FALSE.
+ */
+PJ_INLINE(pj_bool_t) pj_argparse_exists(char *const argv[], const char *opt)
+{
+    int i;
+    for (i=1; argv[i]; ++i) {
+        if (pj_ansi_strcmp(argv[i], opt)==0)
+            return PJ_TRUE;
+    }
+    return PJ_FALSE;
+}
+
+/**
+ * Check for an option and if it exists remove that option from argc/argv and
+ * returns PJ_TRUE.
+ *
+ * @param argc      Pointer to argc.
+ * @param argv      Null terminated argv.
+ * @param opt       The option to find, e.g. "-h", "--help"
+ *
+ * @return          PJ_TRUE if the option exists, else PJ_FALSE.
+ */
+PJ_INLINE(pj_bool_t) pj_argparse_get_bool(int *argc, char *argv[],
+                                          const char *opt)
+{
+    int i;
+    for (i=1; argv[i]; ++i) {
+        if (pj_ansi_strcmp(argv[i], opt)==0) {
+            pj_memmove(&argv[i], &argv[i+1], ((*argc)-i)*sizeof(char*));
+            (*argc)--;
+            return PJ_TRUE;
+        }
+    }
+    return PJ_FALSE;
+}
+
+/**
+ * Check for an option and if it exists get the value and remove both
+ * the option and the value from argc/argv. Note that the function only
+ * supports whitespace(s) as separator between option and value (i.e. equal
+ * sign is not supported, e.g. "--server=127.0.0.1" will not be parsed
+ * correctly).
+ *
+ * @param argc          Pointer to argc.
+ * @param argv          Null terminated argv.
+ * @param opt           The option to find, e.g. "-t", "--type"
+ * @param ptr_value     Pointer to receive the value.
+ *
+ * @return              - PJ_SUCCESS if the option exists and value is found
+ *                        or if the option does not exist
+ *                      - PJ_EINVAL if the option exits but value is not found
+ */
+PJ_INLINE(pj_status_t) pj_argparse_get_str(int *argc, char *argv[],
+                                           const char *opt, char **ptr_value)
+{
+    int i;
+    for (i=1; argv[i]; ++i) {
+        if (pj_ansi_strcmp(argv[i], opt)==0) {
+            pj_memmove(&argv[i], &argv[i+1], ((*argc)-i)*sizeof(char*));
+            (*argc)--;
+
+            if (argv[i]) {
+                char *val = argv[i];
+                pj_memmove(&argv[i], &argv[i+1], ((*argc)-i)*sizeof(char*));
+                (*argc)--;
+                *ptr_value = val;
+                return PJ_SUCCESS;
+            } else {
+                PJ_ARGPARSE_ERROR("Error: missing value for %s argument",
+                                  opt);
+                return PJ_EINVAL;
+            }
+        }
+    }
+    return PJ_SUCCESS;
+}
+
+/**
+ * Check for an option and if it exists, get the integer value and remove both
+ * the option and the value from argc/argv. Note that the function only
+ * supports whitespace(s) as separator between option and value (i.e. equal
+ * sign is not supported, e.g. "--port=80" will not be parsed correctly).
+ *
+ * @param opt           The option to find, e.g. "-h", "--help"
+ * @param argc          Pointer to argc.
+ * @param argv          Null terminated argv.
+ * @param ptr_value     Pointer to receive the value.
+ *
+ * @return              - PJ_SUCCESS if the option exists and value is found
+ *                        or if the option does not exist
+ *                      - PJ_EINVAL if the option exits but value is not found,
+ *                        or if the value is not an integer.
+ */
+PJ_INLINE(pj_status_t) pj_argparse_get_int(int *argc, char *argv[],
+                                           const char *opt, int *ptr_value)
+{
+    char *endptr, *sval=NULL;
+    long val;
+    pj_status_t status = pj_argparse_get_str(argc, argv, opt, &sval);
+    if (status!=PJ_SUCCESS || !sval)
+        return status;
+
+    val = strtol(sval, &endptr, 10);
+    if (*endptr) {
+        PJ_ARGPARSE_ERROR("Error: invalid value for %s argument",
+                          opt);
+        return PJ_EINVAL;
+    }
+
+    *ptr_value = (int)val;
+    return PJ_SUCCESS;
+}
+
+/**
+ * @}
+ */
+
+PJ_END_DECL
+
+
+#endif  /* __PJ_ARGPARSE_H__ */
+

pjlib/include/pjlib.h

@@ -27,6 +27,7 @@
 
 #include <pj/activesock.h>
 #include <pj/addr_resolv.h>
+#include <pj/argparse.h>
 #include <pj/array.h>
 #include <pj/assert.h>
 #include <pj/ctype.h>