libpayload: Fix documentation
[coreboot.git] / payloads / libpayload / libc / string.c
index 1e9b8bc01ca2889effbf48086b26ca8f15ad4329..2e0a558b20c3a89d2f134ca40f67d74183bc6826 100644 (file)
@@ -3,6 +3,7 @@
  *
  * Copyright (C) 2007 Uwe Hermann <uwe@hermann-uwe.de>
  * Copyright (C) 2008 Advanced Micro Devices, Inc.
+ * Copyright (C) 2010 coresystems GmbH
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -29,6 +30,9 @@
  */
 
 #include <libpayload.h>
+#include <string.h>
+#include <ctype.h>
+#include <errno.h>
 
 /**
  * Calculate the length of a fixed-size string.
@@ -83,29 +87,61 @@ size_t strlen(const char *str)
  *        zero, if s1 equals s2. Returns a value greater than zero, if
  *        s1 is longer than s2.
  */
-int strcmp(const char *s1, const char *s2)
+int strcasecmp(const char *s1, const char *s2)
 {
-       char c1, c2;
+       int i, res;
+
+       for (i = 0; 1; i++) {
+               res = tolower(s1[i]) - tolower(s2[i]);
+               if (res || (s1[i] == '\0'))
+                       break;
+       }
 
-       /* Set c1 == c2, so that we can enter the while loop. */
-       c1 = 0;
-       c2 = 0;
+       return res;
+}
 
-       /* Compare characters until they differ, or one of the strings ends. */
-       while (c1 == c2) {
-               /* Read the next character from each string. */
-               c1 = *s1++;
-               c2 = *s2++;
+/**
+ * Compare two strings with fixed length.
+ *
+ * @param s1 The first string.
+ * @param s2 The second string.
+ * @param maxlen Return at most maxlen characters as length of the string.
+ * @return A non-zero value if s1 and s2 differ, or zero if s1 equals s2.
+ */
+int strncasecmp(const char *s1, const char *s2, size_t maxlen)
+{
+       int i, res;
 
-               /* Return something negative (if s1 is shorter than s2), or
-                  zero (if s1 equals s2). */
-               if (c1 == '\0')
-                       return c1 - c2;
+       res = 0;
+       for (i = 0; i < maxlen; i++) {
+               res = tolower(s1[i]) - tolower(s2[i]);
+               if (res || (s1[i] == '\0'))
+                       break;
        }
 
-       /* Return something positive (if s1 is longer than s2), or zero (if s1
-          and s2 are equal). */
-       return c1 - c2;
+       return res;
+}
+
+/**
+ * Compare two strings.
+ *
+ * @param s1 The first string.
+ * @param s2 The second string.
+ * @return Returns a value less than zero, if s1 is shorter than s2. Returns
+ *        zero, if s1 equals s2. Returns a value greater than zero, if
+ *        s1 is longer than s2.
+ */
+int strcmp(const char *s1, const char *s2)
+{
+       int i, res;
+
+       for (i = 0; 1; i++) {
+               res = s1[i] - s2[i];
+               if (res || (s1[i] == '\0'))
+                       break;
+       }
+
+       return res;
 }
 
 /**
@@ -116,19 +152,29 @@ int strcmp(const char *s1, const char *s2)
  * @param maxlen Return at most maxlen characters as length of the string.
  * @return A non-zero value if s1 and s2 differ, or zero if s1 equals s2.
  */
-int strncmp(const char *s1, const char *s2, int maxlen)
+int strncmp(const char *s1, const char *s2, size_t maxlen)
 {
-       int i;
+       int i, res;
 
+       res = 0;
        for (i = 0; i < maxlen; i++) {
-               if (s1[i] != s2[i])
-                       return s1[i] - s2[i];
+               res = s1[i] - s2[i];
+               if (res || (s1[i] == '\0'))
+                       break;
        }
 
-       return 0;
+       return res;
 }
 
-char *strncpy(char *d, const char *s, int n)
+/**
+ * Copy a string with a maximum length.
+ *
+ * @param d The destination memory.
+ * @param s The source string.
+ * @param n Copy at most n characters as length of the string.
+ * @return A pointer to the destination memory.
+ */
+char *strncpy(char *d, const char *s, size_t n)
 {
        /* Use +1 to get the NUL terminator. */
        int max = n > strlen(s) + 1 ? strlen(s) + 1 : n;
@@ -140,15 +186,52 @@ char *strncpy(char *d, const char *s, int n)
        return d;
 }
 
+/**
+ * Copy a string.
+ *
+ * @param d The destination memory.
+ * @param s The source string.
+ * @return A pointer to the destination memory.
+ */
 char *strcpy(char *d, const char *s)
 {
        return strncpy(d, s, strlen(s) + 1);
 }
 
-char *strncat(char *d, const char *s, int n)
+/**
+ * Concatenates two strings
+ *
+ * @param d The destination string.
+ * @param s The source string.
+ * @return A pointer to the destination string.
+ */
+char *strcat(char *d, const char *s)
 {
        char *p = d + strlen(d);
-       int max = n > strlen(s) ? strlen(s) : n;
+       int sl = strlen(s);
+       int i;
+
+       for (i = 0; i < sl; i++)
+               p[i] = s[i];
+
+       p[i] = '\0';
+       return d;
+}
+
+/**
+ * Concatenates two strings with a maximum length.
+ *
+ * @param d The destination string.
+ * @param s The source string.
+ * @param n Not more than n characters from s will be appended to d.
+ * @return A pointer to the destination string.
+ */
+char *strncat(char *d, const char *s, size_t n)
+{
+       char *p = d + strlen(d);
+       int sl = strlen(s);
+       int max = n > sl ? sl : n;
+       // int max = n > strlen(s) ? strlen(s) : n;
        int i;
 
        for (i = 0; i < max; i++)
@@ -158,6 +241,38 @@ char *strncat(char *d, const char *s, int n)
        return d;
 }
 
+/**
+ * Concatenates two strings with a maximum length.
+ *
+ * @param d The destination string.
+ * @param s The source string.
+ * @param n d will have at most n-1 characters (plus NUL) after invocation.
+ * @return A pointer to the destination string.
+ */
+size_t strlcat(char *d, const char *s, size_t n)
+{
+       int sl = strlen(s);
+       int dl = strlen(d);
+
+       char *p = d + dl;
+       int max = n > (sl + dl) ? sl : (n - dl - 1);
+       int i;
+
+       for (i = 0; i < max; i++)
+               p[i] = s[i];
+
+       p[i] = '\0';
+       return max;
+}
+
+/**
+ * Find a character in a string.
+ *
+ * @param s The string.
+ * @param c The character.
+ * @return A pointer to the first occurence of the character in the
+ * string, or NULL if the character was not encountered within the string.
+ */
 char *strchr(const char *s, int c)
 {
        char *p = (char *)s;
@@ -170,17 +285,53 @@ char *strchr(const char *s, int c)
        return NULL;
 }
 
+/**
+ * Find a character in a string.
+ *
+ * @param s The string.
+ * @param c The character.
+ * @return A pointer to the last occurence of the character in the
+ * string, or NULL if the character was not encountered within the string.
+ */
+
+char *strrchr(const char *s, int c)
+{
+       char *p = (char *)s + strlen(s);
+
+       for (; p >= s; p--) {
+               if (*p == c)
+                       return p;
+       }
+
+       return NULL;
+}
+
+/**
+ * Duplicate a string.
+ *
+ * @param s The string to duplicate.
+ * @return A pointer to the copy of the original string.
+ */
 char *strdup(const char *s)
 {
        int n = strlen(s);
-       char *p = malloc(n);
+       char *p = malloc(n + 1);
 
-       if (p != NULL)
+       if (p != NULL) {
                strncpy(p, s, n);
-
+               p[n] = 0;
+       }
        return p;
 }
 
+/**
+ * Find a substring within a string.
+ *
+ * @param h The haystack string.
+ * @param n The needle string (substring).
+ * @return A pointer to the first occurence of the substring in
+ * the string, or NULL if the substring was not encountered within the string.
+ */
 char *strstr(const char *h, const char *n)
 {
        int hn = strlen(h);
@@ -188,8 +339,293 @@ char *strstr(const char *h, const char *n)
        int i;
 
        for (i = 0; i <= hn - nn; i++)
-               if (!strcmp(&h[i], n))
+               if (!memcmp(&h[i], n, nn))
                        return (char *)&h[i];
 
        return NULL;
 }
+
+/**
+ * Separate strings.
+ *
+ * @param stringp reference of the string to separate.
+ * @param delim string containing all delimiters.
+ * @return Token string.
+ */
+char *strsep(char **stringp, const char *delim)
+{
+       char *walk, *token;
+
+       if (!stringp || !*stringp || !**stringp)
+               return NULL;
+
+       token = walk = *stringp;
+
+       /* Walk, search for delimiters */
+       while(*walk && !strchr(delim, *walk))
+               walk++;
+
+       if (*walk) {
+               /* NUL terminate */
+               *walk = '\0';
+               walk++;
+       }
+
+       *stringp = walk;
+
+       return token;
+}
+
+/* Check that a character is in the valid range for the
+   given base
+*/
+
+static int _valid(char ch, int base)
+{
+        char end = (base > 9) ? '9' : '0' + (base - 1);
+
+        /* all bases will be some subset of the 0-9 range */
+
+        if (ch >= '0' && ch <= end)
+                return 1;
+
+        /* Bases > 11 will also have to match in the a-z range */
+
+        if (base > 11) {
+                if (tolower(ch) >= 'a' &&
+                    tolower(ch) <= 'a' + (base - 11))
+                        return 1;
+        }
+
+        return 0;
+}
+
+/* Return the "value" of the character in the given base */
+
+static int _offset(char ch, int base)
+{
+        if (ch >= '0' && ch <= '9')
+                return ch - '0';
+        else
+                return 10 + tolower(ch) - 'a';
+}
+
+/**
+ * Convert the initial portion of a string into a signed int
+ * @param ptr A pointer to the string to convert
+ * @param endptr A pointer to the unconverted part of the string
+ * @param base The base of the number to convert, or 0 for auto
+ * @return A signed integer representation of the string
+ */
+
+long int strtol(const char *ptr, char **endptr, int base)
+{
+        int ret = 0;
+       int negative = 1;
+
+       if (endptr != NULL)
+               *endptr = (char *) ptr;
+
+        /* Purge whitespace */
+
+        for( ; *ptr && isspace(*ptr); ptr++);
+
+       if (ptr[0] == '-') {
+               negative = -1;
+               ptr++;
+       }
+
+        if (!*ptr)
+                return 0;
+
+        /* Determine the base */
+
+        if (base == 0) {
+               if (ptr[0] == '0' && (ptr[1] == 'x' || ptr[1] == 'X'))
+                       base = 16;
+               else if (ptr[0] == '0') {
+                       base = 8;
+                       ptr++;
+               }
+               else
+                       base = 10;
+        }
+
+       /* Base 16 allows the 0x on front - so skip over it */
+
+       if (base == 16) {
+               if (ptr[0] == '0' && (ptr[1] == 'x' || ptr[1] == 'X'))
+                       ptr += 2;
+       }
+
+       /* If the first character isn't valid, then don't
+         * bother */
+
+        if (!*ptr || !_valid(*ptr, base))
+                return 0;
+
+        for( ; *ptr && _valid(*ptr, base); ptr++)
+                ret = (ret * base) + _offset(*ptr, base);
+
+       if (endptr != NULL)
+               *endptr = (char *) ptr;
+
+        return ret * negative;
+}
+
+/**
+ * Convert the initial portion of a string into an unsigned int
+ * @param ptr A pointer to the string to convert
+ * @param endptr A pointer to the unconverted part of the string
+ * @param base The base of the number to convert, or 0 for auto
+ * @return An unsigned integer representation of the string
+ */
+
+unsigned long int strtoul(const char *ptr, char **endptr, int base)
+{
+        int ret = 0;
+
+       if (endptr != NULL)
+               *endptr = (char *) ptr;
+
+        /* Purge whitespace */
+
+        for( ; *ptr && isspace(*ptr); ptr++);
+
+        if (!*ptr)
+                return 0;
+
+        /* Determine the base */
+
+        if (base == 0) {
+               if (ptr[0] == '0' && (ptr[1] == 'x' || ptr[1] == 'X'))
+                       base = 16;
+               else if (ptr[0] == '0') {
+                       base = 8;
+                       ptr++;
+               }
+               else
+                       base = 10;
+        }
+
+       /* Base 16 allows the 0x on front - so skip over it */
+
+       if (base == 16) {
+               if (ptr[0] == '0' && (ptr[1] == 'x' || ptr[1] == 'X'))
+                       ptr += 2;
+       }
+
+       /* If the first character isn't valid, then don't
+         * bother */
+
+        if (!*ptr || !_valid(*ptr, base))
+                return 0;
+
+        for( ; *ptr && _valid(*ptr, base); ptr++)
+                ret = (ret * base) + _offset(*ptr, base);
+
+       if (endptr != NULL)
+               *endptr = (char *) ptr;
+
+        return ret;
+}
+
+/**
+ * Determine the number of leading characters in s that match characters in a
+ * @param s A pointer to the string to analyse
+ * @param a A pointer to an array of characters that match the prefix
+ * @return The number of matching characters
+ */
+
+size_t strspn(const char *s, const char *a)
+{
+       int i, j;
+       int al = strlen(a);
+       for (i = 0; s[i] != 0; i++) {
+               int found = 0;
+               for (j = 0; j < al; j++) {
+                       if (s[i] == a[j]) {
+                               found = 1;
+                               break;
+                       }
+               }
+               if (!found)
+                       break;
+       }
+       return i;
+}
+
+/**
+ * Determine the number of leading characters in s that do not match characters in a
+ * @param s A pointer to the string to analyse
+ * @param a A pointer to an array of characters that do not match the prefix
+ * @return The number of not matching characters
+ */
+
+size_t strcspn(const char *s, const char *a)
+{
+       int i, j;
+       int al = strlen(a);
+       for (i = 0; s[i] != 0; i++) {
+               int found = 0;
+               for (j = 0; j < al; j++) {
+                       if (s[i] == a[j]) {
+                               found = 1;
+                               break;
+                       }
+               }
+               if (found)
+                       break;
+       }
+       return i;
+}
+
+/**
+ * Extract first token in string str that is delimited by a character in tokens.
+ * Destroys str and eliminates the token delimiter.
+ * @param str A pointer to the string to tokenize.
+ * @param delim A pointer to an array of characters that delimit the token
+ * @param ptr A pointer to a string pointer to keep state of the tokenizer
+ * @return Pointer to token
+ */
+
+char* strtok_r(char *str, const char *delim, char **ptr)
+{
+       /* start new tokenizing job or continue existing one? */
+       if (str == NULL)
+               str = *ptr;
+
+       /* skip over prefix delimiters */
+       char *start = str + strspn(str, delim);
+
+       /* find first delimiter character */
+       char *end = start + strcspn(start, delim);
+       end[0] = '\0';
+
+       *ptr = end+1;
+       return start;
+}
+
+static char **strtok_global;
+
+/**
+ * Extract first token in string str that is delimited by a character in tokens.
+ * Destroys str, eliminates the token delimiter and uses global state.
+ * @param str A pointer to the string to tokenize.
+ * @param delim A pointer to an array of characters that delimit the token
+ * @return Pointer to token
+ */
+
+char* strtok(char *str, const char *delim)
+{
+       return strtok_r(str, delim, strtok_global);
+}
+
+/**
+ * Print error message and error number
+ * @param s Error message to print
+ */
+void perror(const char *s)
+{
+       printf("%s: %d\n", s?s:"(none)", errno);
+}