From 972810f6cfd9715de1b182978c4d26e67dcf72cf Mon Sep 17 00:00:00 2001
From: William Wilgus <wilgus.william@gmail.com>
Date: Tue, 15 Nov 2022 11:24:34 -0500
Subject: strlcpy finish cleanup

remove strlcpy & strlcat from string.h

document suspicious strlcpy call

convert strlcat.h users to string-extra

Change-Id: I313e75db86385c0e6d1aee75d252093be4935f60
---
 apps/misc.c                       | 2 +-
 firmware/common/file_internal.c   | 1 +
 firmware/common/strlcpy.c         | 2 +-
 firmware/common/zip.c             | 3 +--
 firmware/drivers/fat.c            | 2 +-
 firmware/libc/include/string.h    | 3 ---
 lib/rbcodec/metadata/replaygain.c | 2 +-
 7 files changed, 6 insertions(+), 9 deletions(-)

diff --git a/apps/misc.c b/apps/misc.c
index fcdbb28fce..0bac986a6f 100644
--- a/apps/misc.c
+++ b/apps/misc.c
@@ -1387,7 +1387,7 @@ int split_string(char *str, const char split_char, char *vector[], const int vec
     char sep[2] = {split_char, '\0'};
     char *e, *p = strtok_r(str, sep, &e);
 
-    /* *p in the condition takes care of trailing splitters */
+    /* strtok takes care of leading & trailing splitters */
     for(i = 0; i < vector_length; i++)
     {
         vector[i] = p;
diff --git a/firmware/common/file_internal.c b/firmware/common/file_internal.c
index 9ddbb232b4..a73d9beaa2 100644
--- a/firmware/common/file_internal.c
+++ b/firmware/common/file_internal.c
@@ -227,6 +227,7 @@ void iso_decode_d_name(char *d_name)
         return;
 
     char shortname[13];
+    /* this only gets called in the case of DOS (8.3) filenames */
     size_t len = strlcpy(shortname, d_name, sizeof (shortname));
     /* This MUST be the default codepage thus not something that could be
        loaded on call */
diff --git a/firmware/common/strlcpy.c b/firmware/common/strlcpy.c
index bfdb6482a4..5107ea1207 100644
--- a/firmware/common/strlcpy.c
+++ b/firmware/common/strlcpy.c
@@ -34,6 +34,6 @@ size_t strlcpy(char *dst, const char *src, size_t siz)
     if (d)
         return (d - dst - 1); /* count does not include NUL */
 
-    /* Not enough room in dst, add NUL and traverse rest of src */
+    /* Not enough room in dst, traverse rest of src */
     return(siz + strlen(src+siz)); /* count does not include NUL */
 }
diff --git a/firmware/common/zip.c b/firmware/common/zip.c
index 22c6226e3b..6d250abb58 100644
--- a/firmware/common/zip.c
+++ b/firmware/common/zip.c
@@ -20,8 +20,7 @@
  ****************************************************************************/
 
 #include "zip.h"
-#include <string.h>
-#include "strlcpy.h"
+#include "string-extra.h"
 #include "file.h"
 #include "dir.h"
 #include "system.h"
diff --git a/firmware/drivers/fat.c b/firmware/drivers/fat.c
index 30d16f3666..20c8f2b8e0 100644
--- a/firmware/drivers/fat.c
+++ b/firmware/drivers/fat.c
@@ -22,7 +22,7 @@
 #include "config.h"
 #include "system.h"
 #include "sys/types.h"
-#include <string.h>
+#include "string-extra.h"
 #include <ctype.h>
 #include <stdlib.h>
 #include <stdio.h>
diff --git a/firmware/libc/include/string.h b/firmware/libc/include/string.h
index 4ec2f8dd67..6217fff15c 100644
--- a/firmware/libc/include/string.h
+++ b/firmware/libc/include/string.h
@@ -40,9 +40,6 @@ size_t   _EXFUN(strspn,(const char *, const char *));
 char    *_EXFUN(strstr,(const char *, const char *));
 char    *_EXFUN(strcasestr,(const char *, const char *));
 
-size_t  strlcpy(char *dst, const char *src, size_t siz);
-size_t  strlcat(char *dst, const char *src, size_t siz);
-
 #ifndef _REENT_ONLY
 char    *_EXFUN(strtok,(char *, const char *));
 #endif
diff --git a/lib/rbcodec/metadata/replaygain.c b/lib/rbcodec/metadata/replaygain.c
index eb98bbc342..d76a1113ea 100644
--- a/lib/rbcodec/metadata/replaygain.c
+++ b/lib/rbcodec/metadata/replaygain.c
@@ -26,7 +26,7 @@
 #include <stdlib.h>
 #include <inttypes.h>
 #include "platform.h"
-#include "strlcpy.h"
+#include "string-extra.h"
 #include "strcasecmp.h"
 #include "metadata.h"
 #include "debug.h"
-- 
cgit v1.2.3