Simple embedded shell with runtime pluggable commands.

Dependents:   DataBus2018

Implements a simple unix-like shell for embedded systems with a pluggable command architecture.

Files at this revision

API Documentation at this revision

Comitter:
shimniok
Date:
Mon Dec 31 23:34:17 2018 +0000
Parent:
34:afe994ca0e49
Commit message:
trying wildcards still.

Changed in this revision

SimpleShell.cpp Show annotated file Show diff for this revision Revisions of this file
SimpleShell.h Show annotated file Show diff for this revision Revisions of this file
fnmatch.c Show diff for this revision Revisions of this file
fnmatch.h Show diff for this revision Revisions of this file
diff -r afe994ca0e49 -r 1a8c5fce8895 SimpleShell.cpp
--- a/SimpleShell.cpp	Fri Dec 28 20:34:58 2018 +0000
+++ b/SimpleShell.cpp	Mon Dec 31 23:34:17 2018 +0000
@@ -1,4 +1,5 @@
 #include "SimpleShell.h"
+#include "ff.h"
 #include <ctype.h>
 #include <string>
 #include <list>
@@ -39,9 +40,7 @@
 
 
 bool SimpleShell::haswildcard(char *s) {
-    bool result = \
-        strchr(s, '*') != NULL || strchr(s, '?') != NULL ||
-        (strchr(s, '[') != NULL && strchr(s, ']') != NULL);
+    bool result = strchr(s, '*') != NULL;
     return result;
 }
 
@@ -186,13 +185,7 @@
 }
 
 
-typedef struct {
-    char *dir;
-    char *base;
-} filespec_t;
-
-
-char *dirname(char *path)
+char *SimpleShell::dirname(char *path)
 {
     char *found = strrchr(path, '/');
     char *result = new char[sizeof(path)];
@@ -208,57 +201,105 @@
 }    
 
 
-#include "fnmatch.h"
-
-list<char*> *scandir(char *pattern, char *path)
+/** Attempts to match filename pattern and name.
+ * @param pattern is a pattern containing one '*'
+ * @param name is the name to check for a match to the pattern
+ * @returns 1 if match found, 0 if no match or bad pattern
+ */ 
+int fnmatch(char *pattern, char *name)
 {
-    DIR *d;
-    list<char*> *listp;
-    
+    char *p;
+    char *n;
+    int c;
+
+    // only one * allowed
+    p = pattern;
+    c = 0;
+    p = strchr(p, '*');
+    while (p) {
+        c++;
+        p = strchr(p+1, '*');
+    }
+    if (c != 1) return 0;
+
+    // match first part
+    //puts("first");
+    p = pattern;
+    n = name;
+    char *s = strchr(pattern, '*');
+    while (p != s) {
+        // mismatch before *?
+        if (toupper(*p) != toupper(*n)) {
+            return 0;
+        }
+        p++;
+        n++;
+    }
+    // match last part in reverse
+    //puts("second");
+    p = strchr(pattern, 0)-1;
+    n = strchr(name, 0)-1;
+    while (p != s) {
+        // mismatch before *?
+        //printf("%c %c\n", *p, *n);
+        if (toupper(*p) != toupper(*n)) {
+            return 0;
+        }
+        p--;
+        n--;
+    }
+
+    return 1;
+}
+
+
+// Run the specified callback on each matching filename
+char *SimpleShell::foreach(char *pattern)
+{
+    DIR *d = 0;
+    char *base;
+    char *path;
     struct dirent *p;
+
+    base = basename(pattern);
+    path = dirname(pattern);
+    printf("dir:<%s> base:<%s>\n", path, base);
     if ((d = opendir(path)) != NULL) {
-        listp = new list<char*>;
         while ((p = readdir(d)) != NULL) {
-            if (fnmatch(pattern, p->d_name, FNM_PATHNAME|FNM_CASEFOLD) != FNM_NOMATCH) {
-                char *s = new char[sizeof(p->d_name)];
-                strcpy(s, p->d_name);
-                listp->push_back(s);
-            }
-        }
+            //printf("pattern:<%s> file:<%s>\n", base, p->d_name);
+            if (fnmatch(base, p->d_name) == 1) {
+                char *next = new char[sizeof(base) + sizeof(p->d_name) + 2];
+                sprintf(next, "%s/%s", path, p->d_name);
+                printf("Removing %s...\n", next);
+                int stat = remove(next);
+                //int stat = f_unlink(next);
+                if (stat) {
+                    printf("%s: could not remove. Error %d\n", next, stat);
+                }
+                delete[] next;
+            }//if
+        }//while
         closedir(d);
+    } else {
+        printf("%s: no such directory\n", path);
     }
-    return listp;
+       
+    return 0;
 }
 
 
 void SimpleShell::rm(int argc, char **argv)
 {
+    char *arg;
+
     if (argc >= 2) {
         for (int i=1; i < argc; i++) {
-            char *arg = canon(argv[i]);
-            char *base = basename(arg);
-            char *dir = dirname(arg);
-            
-            printf("arg=<%s>\nbase=<%s>\ndir=<%s>\n", arg, base, dir);
-
-            // wildcards only valid in basename for now
-            if (haswildcard(base)) {
-                list<char*> *fl = scandir(base, dir);
-                char *s;
-                while (!fl->empty()) {
-                    s = fl->front();
-                    printf("<%s>\n", s);
-                    fl->pop_front();
-                    delete[] s;
-                }
-                delete fl;
-            } else {
-                if (remove(canon(argv[i]))) {
-                    printf("%s: cannot remove\n", argv[i]);
-                }
+            arg = canon(argv[i]);
+            if (haswildcard(argv[i])) {
+                foreach(arg);
+            } else if (remove(canon(argv[i]))) {
+                printf("%s: cannot remove. Error %d\n", argv[i], errno);
             }
-
-            delete[] dir;
         }
     } else {
         puts("usage: rm [file1 [file2 ...]]");
diff -r afe994ca0e49 -r 1a8c5fce8895 SimpleShell.h
--- a/SimpleShell.h	Fri Dec 28 20:34:58 2018 +0000
+++ b/SimpleShell.h	Mon Dec 31 23:34:17 2018 +0000
@@ -2,6 +2,7 @@
 #define __SIMPLESHELL_H
 
 #include "mbed.h"
+#include <vector>
 
 /** A simple, flexible, embedded shell with dynamically added shell commands.
  * Shell commands must be: void(int argc, char **argv)
@@ -72,10 +73,31 @@
     char *canon(char *path);
 
     /** Get the basename of specified path.
+     * For example, basename("/foo/bar/whee") returns "whee"
      * @param path is the path specification, assumed to be canonicalized
      * @returns the basename of the path
      */
     char *basename(char *path);
+    
+    /** Get the parent directory of specified path.
+     * For example, basename("/foo/bar/whee") returns "/foo/bar"
+     * @param path is the path specification, assumed to be canonicalized
+     * @returns the parent directory of the path
+     */
+    char *dirname(char *path);
+    
+    /** Runs a callback on each matching file in the specified pattern
+     * @param pattern is a filename pattern ala Linux fnmatch(3)
+     * @param cb is the int(char*) function on which each file match is called
+     * @return false if cb returns non-zero on any file, true otherwise
+     *
+     * @code
+     * if (foreach("/test/\*.txt", callback(remove)) {
+     *     printf("error!\n");
+     * }
+     * @endcode
+     */
+    char *foreach(char *pattern);
 
 private:
     /// Maximum number of commands
@@ -83,6 +105,9 @@
 
     /// Maximum command line buffer size
     static const int MAXBUF=64;
+    
+    /// Maximum filename size
+    static const int MAXNAMESIZE=64;
 
     /// internal struct to contain a single command
     typedef struct {
@@ -90,6 +115,9 @@
         callback_t cb;
     } command_entry_t;
 
+    /// internal file list for wildcards
+    typedef vector<char*> filelist_t;
+
     /** finds and eturns the callback for a command
      * @return Callback to a function returning void
      */
diff -r afe994ca0e49 -r 1a8c5fce8895 fnmatch.c
--- a/fnmatch.c	Fri Dec 28 20:34:58 2018 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,198 +0,0 @@
-/*
- * Copyright (c) 1989, 1993, 1994
- *  The Regents of the University of California.  All rights reserved.
- *
- * This code is derived from software contributed to Berkeley by
- * Guido van Rossum.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. All advertising materials mentioning features or use of this software
- *    must display the following acknowledgement:
- *  This product includes software developed by the University of
- *  California, Berkeley and its contributors.
- * 4. Neither the name of the University 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 REGENTS 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 THE REGENTS OR CONTRIBUTORS 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.
- *
- * From FreeBSD fnmatch.c 1.11
- * $Id: fnmatch.c,v 1.3 1997/08/19 02:34:30 jdp Exp $
- */
-
-#if defined(LIBC_SCCS) && !defined(lint)
-static char sccsid[] = "@(#)fnmatch.c   8.2 (Berkeley) 4/16/94";
-#endif /* LIBC_SCCS and not lint */
-
-/*
- * Function fnmatch() as specified in POSIX 1003.2-1992, section B.6.
- * Compares a filename or pathname to a pattern.
- */
-
-#include <ctype.h>
-#include <string.h>
-#include <stdio.h>
-
-#include "fnmatch.h"
-
-#define EOS '\0'
-
-static const char *rangematch(const char *, char, int);
-
-int fnmatch(const char *pattern, const char *string, int flags)
-{
-    const char *stringstart;
-    char c, test;
-
-    for (stringstart = string;;)
-        switch (c = *pattern++) {
-        case EOS:
-            if ((flags & FNM_LEADING_DIR) && *string == '/')
-                return (0);
-            return (*string == EOS ? 0 : FNM_NOMATCH);
-        case '?':
-            if (*string == EOS)
-                return (FNM_NOMATCH);
-            if (*string == '/' && (flags & FNM_PATHNAME))
-                return (FNM_NOMATCH);
-            if (*string == '.' && (flags & FNM_PERIOD) &&
-                (string == stringstart ||
-                ((flags & FNM_PATHNAME) && *(string - 1) == '/')))
-                return (FNM_NOMATCH);
-            ++string;
-            break;
-        case '*':
-            c = *pattern;
-            /* Collapse multiple stars. */
-            while (c == '*')
-                c = *++pattern;
-
-            if (*string == '.' && (flags & FNM_PERIOD) &&
-                (string == stringstart ||
-                ((flags & FNM_PATHNAME) && *(string - 1) == '/')))
-                return (FNM_NOMATCH);
-
-            /* Optimize for pattern with * at end or before /. */
-            if (c == EOS)
-                if (flags & FNM_PATHNAME)
-                    return ((flags & FNM_LEADING_DIR) ||
-                        strchr(string, '/') == NULL ?
-                        0 : FNM_NOMATCH);
-                else
-                    return (0);
-            else if (c == '/' && flags & FNM_PATHNAME) {
-                if ((string = strchr(string, '/')) == NULL)
-                    return (FNM_NOMATCH);
-                break;
-            }
-
-            /* General case, use recursion. */
-            while ((test = *string) != EOS) {
-                if (!fnmatch(pattern, string, flags & ~FNM_PERIOD))
-                    return (0);
-                if (test == '/' && flags & FNM_PATHNAME)
-                    break;
-                ++string;
-            }
-            return (FNM_NOMATCH);
-        case '[':
-            if (*string == EOS)
-                return (FNM_NOMATCH);
-            if (*string == '/' && flags & FNM_PATHNAME)
-                return (FNM_NOMATCH);
-            if ((pattern =
-                rangematch(pattern, *string, flags)) == NULL)
-                return (FNM_NOMATCH);
-            ++string;
-            break;
-        case '\\':
-            if (!(flags & FNM_NOESCAPE)) {
-                if ((c = *pattern++) == EOS) {
-                    c = '\\';
-                    --pattern;
-                }
-            }
-            /* FALLTHROUGH */
-        default:
-            if (c == *string)
-                ;
-            else if ((flags & FNM_CASEFOLD) &&
-                 (tolower((unsigned char)c) ==
-                  tolower((unsigned char)*string)))
-                ;
-            else if ((flags & FNM_PREFIX_DIRS) && *string == EOS &&
-                 ((c == '/' && string != stringstart) ||
-                 (string == stringstart+1 && *stringstart == '/')))
-                return (0);
-            else
-                return (FNM_NOMATCH);
-            string++;
-            break;
-        }
-    /* NOTREACHED */
-}
-
-static const char *
-rangematch(const char *pattern, char test, int flags)
-{
-    int negate, ok;
-    char c, c2;
-
-    /*
-     * A bracket expression starting with an unquoted circumflex
-     * character produces unspecified results (IEEE 1003.2-1992,
-     * 3.13.2).  This implementation treats it like '!', for
-     * consistency with the regular expression syntax.
-     * J.T. Conklin (conklin@ngai.kaleida.com)
-     */
-    if ( (negate = (*pattern == '!' || *pattern == '^')) )
-        ++pattern;
-
-    if (flags & FNM_CASEFOLD)
-        test = tolower((unsigned char)test);
-
-    for (ok = 0; (c = *pattern++) != ']';) {
-        if (c == '\\' && !(flags & FNM_NOESCAPE))
-            c = *pattern++;
-        if (c == EOS)
-            return (NULL);
-
-        if (flags & FNM_CASEFOLD)
-            c = tolower((unsigned char)c);
-
-        if (*pattern == '-'
-            && (c2 = *(pattern+1)) != EOS && c2 != ']') {
-            pattern += 2;
-            if (c2 == '\\' && !(flags & FNM_NOESCAPE))
-                c2 = *pattern++;
-            if (c2 == EOS)
-                return (NULL);
-
-            if (flags & FNM_CASEFOLD)
-                c2 = tolower((unsigned char)c2);
-
-            if ((unsigned char)c <= (unsigned char)test &&
-                (unsigned char)test <= (unsigned char)c2)
-                ok = 1;
-        } else if (c == test)
-            ok = 1;
-    }
-    return (ok == negate ? NULL : pattern);
-}
\ No newline at end of file
diff -r afe994ca0e49 -r 1a8c5fce8895 fnmatch.h
--- a/fnmatch.h	Fri Dec 28 20:34:58 2018 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,61 +0,0 @@
-/*-
- * Copyright (c) 1992, 1993
- *  The Regents of the University of California.  All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. All advertising materials mentioning features or use of this software
- *    must display the following acknowledgement:
- *  This product includes software developed by the University of
- *  California, Berkeley and its contributors.
- * 4. Neither the name of the University 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 REGENTS 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 THE REGENTS OR CONTRIBUTORS 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.
- *
- *  @(#)fnmatch.h   8.1 (Berkeley) 6/2/93
- *
- * From FreeBSD fnmatch.h 1.7
- * $Id: fnmatch.h,v 1.4 2001/10/04 02:46:21 jdp Exp $
- */
-
-#ifndef _FNMATCH_H_
-#define _FNMATCH_H_
-
-#define FNM_NOMATCH 1   /* Match failed. */
-
-#define FNM_NOESCAPE    0x01    /* Disable backslash escaping. */
-#define FNM_PATHNAME    0x02    /* Slash must be matched by slash. */
-#define FNM_PERIOD      0x04    /* Period must be matched by period. */
-#define FNM_LEADING_DIR 0x08    /* Ignore /<tail> after Imatch. */
-#define FNM_CASEFOLD    0x10    /* Case insensitive search. */
-#define FNM_PREFIX_DIRS 0x20    /* Directory prefixes of pattern match too. */
-
-/* Make this compile successfully with "gcc -traditional" */
-#ifndef __STDC__
-#define const   /* empty */
-#endif
-
-#ifdef __cplusplus
-extern "C"
-#endif
-int fnmatch(const char *, const char *, int);
-
-#endif /* !_FNMATCH_H_ */
\ No newline at end of file