libbindle: adding bindle_basename() and bindle_basename_r()

4 files changed, 318 insertions, 0 deletions

diff --git a/build-aux/makefile-libbindle.am b/build-aux/makefile-libbindle.am
index 48422e3..19a9089 100644
--- a/build-aux/makefile-libbindle.am
+++ b/build-aux/makefile-libbindle.am
@@ -31,6 +31,7 @@
 EXTRA_PROGRAMS                          += tests/bindle-array-queue \
                                            tests/bindle-array-sorted \
                                            tests/bindle-array-stack \
+                                           tests/bindle-str-basename \
                                            tests/bindle-str-expand \
                                            tests/bindle-str-split \
                                            tests/bindle-url-encoding \
@@ -38,6 +39,7 @@ EXTRA_PROGRAMS				+= tests/bindle-array-queue \
 LIBBINDLE_TESTS                         =  tests/bindle-array-queue \
                                            tests/bindle-array-sorted \
                                            tests/bindle-array-stack \
+                                           tests/bindle-str-basename \
                                            tests/bindle-str-expand \
                                            tests/bindle-str-split \
                                            tests/bindle-url-encoding \
@@ -108,6 +110,15 @@ tests_bindle_array_stack_SOURCES	= $(bindletools_srcdir)/include/bindle.h \
                                           $(bindletools_srcdir)/checks/bindle-array-stack.c
 
 
+# macros for tests/bindle-str-basename
+tests_bindle_str_basename_DEPENDENCIES  = lib/libbindle.a
+tests_bindle_str_basename_LDADD         = lib/libbindle.a
+tests_bindle_str_basename_SOURCES       = $(bindletools_srcdir)/include/bindle.h \
+                                          $(bindletools_srcdir)/checks/bindle-tests.h \
+                                          $(bindletools_srcdir)/checks/bindle-tests.c \
+                                          $(bindletools_srcdir)/checks/bindle-str-basename.c
+
+
 # macros for tests/bindle-str-expand
 tests_bindle_str_expand_DEPENDENCIES    = lib/libbindle.a
 tests_bindle_str_expand_LDADD           = lib/libbindle.a
diff --git a/checks/bindle-str-basename.c b/checks/bindle-str-basename.c
new file mode 100644
index 0000000..849068e
--- /dev/null
+++ b/checks/bindle-str-basename.c
@@ -0,0 +1,238 @@
+/*
+ *  Bindle Binaries Tools
+ *  Copyright (C) 2022 David M. Syzdek <david@syzdek.net>.
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions are
+ *  met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of David M. Syzdek nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ *  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DAVID M. SYZDEK BE LIABLE FOR
+ *  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ *  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ *  SUCH DAMAGE.
+ */
+#define _CHECKS_BINDLE_STR_BASENAME_C 1
+
+
+///////////////
+//           //
+//  Headers  //
+//           //
+///////////////
+#pragma mark - Headers
+
+#include "bindle-tests.h"
+
+#include <stdio.h>
+#include <stdarg.h>
+#include <stdlib.h>
+#include <string.h>
+#include <strings.h>
+#include <unistd.h>
+#include <getopt.h>
+#include <assert.h>
+
+
+///////////////////
+//               //
+//  Definitions  //
+//               //
+///////////////////
+#pragma mark - Definitions
+
+#undef PROGRAM_NAME
+#define PROGRAM_NAME "bindle-str-basename"
+
+
+/////////////////
+//             //
+//  Datatypes  //
+//             //
+/////////////////
+#pragma mark - Datatypes
+
+typedef struct my_test_strings
+{
+   const char *   origin;
+   const char *   result;
+} my_test_strings_t;
+
+
+/////////////////
+//             //
+//  Variables  //
+//             //
+/////////////////
+#pragma mark - Variables
+
+static my_test_strings_t  test_strings[] =
+{
+   { .origin = "/etc/passwd",       .result = "passwd" },
+   { .origin = "passwd",            .result = "passwd" },
+   { .origin = "/passwd",           .result = "passwd" },
+   { .origin = "/passwd/",          .result = "passwd" },
+   { .origin = "//passwd/",         .result = "passwd" },
+   { .origin = "//passwd//",        .result = "passwd" },
+   { .origin = "passwd/",           .result = "passwd" },
+   { .origin = "passwd//",          .result = "passwd" },
+   { .origin = "/////////",         .result = "/" },
+   { .origin = "//",                .result = "/" },
+   { .origin = "",                  .result = "." },
+   { .origin = NULL,                .result = NULL }
+};
+
+
+//////////////////
+//              //
+//  Prototypes  //
+//              //
+//////////////////
+#pragma mark - Prototypes
+
+int
+main(
+         int                           argc,
+         char *                        argv[] );
+
+
+/////////////////
+//             //
+//  Functions  //
+//             //
+/////////////////
+#pragma mark - Functions
+
+int
+main(
+         int                           argc,
+         char *                        argv[] )
+{
+   int                           opt;
+   int                           c;
+   int                           opt_index;
+   size_t                        pos;
+   unsigned                      opts;
+   char *                        str;
+
+   // getopt options
+   static char          short_opt[] = "dhVvq";
+   static struct option long_opt[] =
+   {
+      {"debug",            no_argument,       NULL, 'd' },
+      {"help",             no_argument,       NULL, 'h' },
+      {"quiet",            no_argument,       NULL, 'q' },
+      {"silent",           no_argument,       NULL, 'q' },
+      {"version",          no_argument,       NULL, 'V' },
+      {"verbose",          no_argument,       NULL, 'v' },
+      { NULL, 0, NULL, 0 }
+   };
+
+   bindle_tests_initialize(PROGRAM_NAME);
+
+   opts = 0;
+
+   while((c = getopt_long(argc, argv, short_opt, long_opt, &opt_index)) != -1)
+   {
+      switch(c)
+      {
+         case -1:       /* no more arguments */
+         case 0:        /* long options toggles */
+         break;
+
+         case 'd':
+         opt = BNDL_DEBUG_ANY;
+         bindle_set_option(NULL, BNDL_OPT_DEBUG_LEVEL,  &opt);
+         break;
+
+         case 'h':
+         printf("Usage: %s [OPTIONS]\n", PROGRAM_NAME);
+         printf("       %s [OPTIONS] str1 [ str2 [ ... [ strN ] ] ]\n", PROGRAM_NAME);
+         printf("OPTIONS:\n");
+         printf("  -d, --debug               print debug messages\n");
+         printf("  -h, --help                print this help and exit\n");
+         printf("  -q, --quiet, --silent     do not print messages\n");
+         printf("  -V, --version             print version number and exit\n");
+         printf("  -v, --verbose             print verbose messages\n");
+         printf("\n");
+         return(0);
+
+         case 'q':
+         opts |=  BNDLTEST_OPT_QUIET;
+         opts &= ~BNDLTEST_OPT_VERBOSE;
+         break;
+
+         case 'V':
+         bindle_tests_version();
+         return(0);
+
+         case 'v':
+         opts |=  BNDLTEST_OPT_VERBOSE;
+         opts &= ~BNDLTEST_OPT_QUIET;
+         break;
+
+         case '?':
+         fprintf(stderr, "Try `%s --help' for more information.\n", PROGRAM_NAME);
+         return(1);
+
+         default:
+         fprintf(stderr, "%s: unrecognized option `--%c'\n", PROGRAM_NAME, c);
+         fprintf(stderr, "Try `%s --help' for more information.\n", PROGRAM_NAME);
+         return(1);
+      };
+   };
+
+   // expand custom strings
+   if (optind < argc)
+   {
+      while (optind < argc)
+      {
+         bindle_tests_verbose(opts, "test string:  %s", argv[optind]);
+         str = bindle_basename(argv[optind]);
+         if (!(opts & BNDLTEST_OPT_VERBOSE))
+            bindle_tests_print(opts, "%s", str);
+         bindle_tests_verbose(opts, "         ==>  %s", str);
+         optind++;
+         if (optind < argc)
+            bindle_tests_verbose(opts, "");
+     };
+      return(0);
+   };
+
+   // expand and verify test strings
+   for(pos = 0; ((test_strings[pos].origin)); pos++)
+   {
+      bindle_tests_verbose(opts, "test string:    \"%s\"", test_strings[pos].origin);
+      str = bindle_basename(test_strings[pos].origin);
+      bindle_tests_verbose(opts, "   expected ==> \"%s\"", test_strings[pos].result);
+      bindle_tests_verbose(opts, "   result   ==> \"%s\"", str);
+      if ((strcmp(test_strings[pos].result, str)))
+      {
+         bindle_tests_error(opts, NULL, "basename does not match expected result");
+         return(1);
+      };
+      bindle_tests_verbose(opts, "");
+   };
+
+   return(0);
+}
+
+
+/* end of source */
+
diff --git a/include/bindle.h b/include/bindle.h
index 0c8a9e9..d4e55df 100644
--- a/include/bindle.h
+++ b/include/bindle.h
@@ -405,6 +405,18 @@ bindle_set_option(
 #pragma mark string prototypes
 
 _BINDLE_F char *
+bindle_basename(
+         const char *                  path );
+
+
+_BINDLE_F char *
+bindle_basename_r(
+         const char *                  path,
+         char *                        bname,
+         size_t                        bnamelen );
+
+
+_BINDLE_F char *
 bindle_strdup(
          const char *                  s1 );
 
diff --git a/lib/libbindle/lstring.c b/lib/libbindle/lstring.c
index d34dbc3..a24d46a 100644
--- a/lib/libbindle/lstring.c
+++ b/lib/libbindle/lstring.c
@@ -79,6 +79,63 @@
 #pragma mark - Functions
 
 char *
+bindle_basename(
+         const char *                  path )
+{
+   static char bname[512];
+   return(bindle_basename_r(path, bname, sizeof(bname)));
+}
+
+
+char *
+bindle_basename_r(
+         const char *                  path,
+         char *                        bname,
+         size_t                        bnamelen )
+{
+   size_t pos;
+   size_t slash;
+   size_t len;
+
+   assert(bname != NULL);
+   assert(bnamelen > 2);
+
+   // handle empty strings
+   if ( (!(path)) || (path[0] == '\0') )
+   {
+      bindle_strlcpy(bname, ".", bnamelen);
+      return(bname);
+   };
+
+   // skip leading '/' chars
+   while (path[0] == '/')
+      path = &path[1];
+   if (path[0] == '\0')
+   {
+      bindle_strlcpy(bname, "/", bnamelen);
+      return(bname);
+   };
+
+   // find start of trailing slashes, if any
+   for(pos = strlen(path) - 1; (path[pos] == '/'); pos--);
+   slash = pos + 1;
+
+   // find last slash before basename
+   for(pos = slash - 1; ((pos > 0) && (path[pos] != '/')); pos--);
+   if (path[pos] == '/')
+      pos++;
+
+   // copy string
+   len = slash - pos + 1;
+   bnamelen = (len > bnamelen) ? bnamelen : len;
+   bindle_strlcpy(bname, &path[pos], bnamelen);
+
+
+   return(bname);
+}
+
+
+char *
 bindle_strdup(
          const char *                  s1 )
 {