Files
wget2/libwget/utils.c
Tim Rühsen d1e0a2e98d Add gnulib modules c-strcase, c-ctype and strcase
* autogen.sh: Add gnulib modules c-strcase, c-ctype and strcase
* configure.ac: Remove search for string.h, strings.h, str(n)casecmp
* libwget/utils.c: Use c_str(n)casecmp, c_isupper, c_isxdigit
2016-01-11 16:23:07 +01:00

361 lines
8.1 KiB
C

/*
* Copyright(c) 2012 Tim Ruehsen
* Copyright(c) 2015 Free Software Foundation, Inc.
*
* This file is part of libwget.
*
* Libwget is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Libwget 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with libwget. If not, see <http://www.gnu.org/licenses/>.
*
*
* a collection of utility routines
*
* Changelog
* 25.04.2012 Tim Ruehsen created
*
*/
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include <stddef.h>
#include <string.h>
#include <strings.h>
#include <unistd.h>
#include <time.h>
#include "c-ctype.h"
#include "c-strcase.h"
#include <libwget.h>
#include "private.h"
/**
* SECTION:libwget-utils
* @short_description: General utility functions
* @title: libwget-utils
* @stability: stable
* @include: libwget.h
*
* This is a collections of short routines that are used with libwget and/or Wget code.
* They may be useful to other developers that is why they are exported.
*/
/**
* wget_strcmp:
* @s1: String
* @s2: String
*
* This functions compares @s1 and @s2 in the same way as strcmp() does,
* except that it also handles %NULL values. It returns 0 if both @s1 and @s2
* are %NULL. It returns -1 if @s1 is %NULL and @s2 is not %NULL. It returns 1 if
* @s2 is %NULL and @s1 is not %NULL.
*
* Returns: Same as strcmp() if none of @s1 or @s2 is %NULL. Else see above.
*/
int wget_strcmp(const char *s1, const char *s2)
{
if (!s1) {
if (!s2)
return 0;
else
return -1;
} else {
if (!s2)
return 1;
else
return strcmp(s1, s2);
}
}
/**
* wget_strcasecmp:
* @s1: String
* @s2: String
*
* This functions compares @s1 and @s2 in the same way as strcasecmp() does,
* except that it also handles %NULL values. It returns 0 if both @s1 and @s2
* are %NULL. It returns -1 if @s1 is %NULL and @s2 is not %NULL. It returns 1 if
* @s2 is %NULL and @s1 is not %NULL.
*
* Returns: Same as strcasecmp() if none of @s1 or @s2 is %NULL. Else see above.
*/
int wget_strcasecmp(const char *s1, const char *s2)
{
if (!s1) {
if (!s2)
return 0;
else
return -1;
} else {
if (!s2)
return 1;
else
return strcasecmp(s1, s2);
}
}
/**
* wget_strcasecmp_ascii:
* @s1: String
* @s2: String
*
* This functions compares @s1 and @s2 case insensitive ignoring locale settings.
* It also accepts %NULL values.
*
* It returns 0 if both @s1 and @s2 are the same disregarding case for ASCII letters a-z.
* It returns 0 if both @s1 and @s2 are %NULL.
* It returns <0 if @s1 is %NULL and @s2 is not %NULL or s1 is smaller than s2.
* It returns >0 if @s2 is %NULL and @s1 is not %NULL or s1 is greater than s2.
*
* Returns: An integer value described above.
*/
int wget_strcasecmp_ascii(const char *s1, const char *s2)
{
if (!s1) {
if (!s2)
return 0;
else
return -1;
} else {
if (!s2)
return 1;
else
return c_strcasecmp(s1, s2);
}
}
/**
* wget_strncasecmp_ascii:
* @s1: String
* @s2: String
* @n: Max. number of chars to compare
*
* This functions compares @s1 and @s2 case insensitive ignoring locale settings up to a max number of @n chars.
* It also accepts %NULL values.
*
* It returns 0 if both @s1 and @s2 are the same disregarding case for ASCII letters a-z.
* It returns 0 if both @s1 and @s2 are %NULL.
* It returns <0 if @s1 is %NULL and @s2 is not %NULL or s1 is smaller than s2.
* It returns >0 if @s2 is %NULL and @s1 is not %NULL or s1 is greater than s2.
*
* Returns: An integer value described above.
*/
int wget_strncasecmp_ascii(const char *s1, const char *s2, size_t n)
{
if (!s1) {
if (!s2)
return 0;
else
return -1;
} else {
if (!s2)
return 1;
else
return c_strncasecmp(s1, s2, n);
}
}
/**
* wget_strtolower:
* @s: String to convert
*
* Converts string @s to lowercase in place.
*
* Returns: Same value as @s.
*/
char *wget_strtolower(char *s)
{
if (s) {
for (char *d = s; *d; d++) {
if (c_isupper(*d))
*d = c_tolower(*d);
}
}
return s;
}
/**
* wget_strncmp:
* @s1: String
* @s2: String
* @n: Max. number of chars to compare
*
* This functions compares @s1 and @s2 in the same way as strncmp() does,
* except that it also handles %NULL values. It returns 0 if both @s1 and @s2
* are %NULL. It returns -1 if @s1 is %NULL and @s2 is not %NULL. It returns 1 if
* @s2 is %NULL and @s1 is not %NULL.
*
* Returns: Same as strncmp() if none of @s1 or @s2 is %NULL. Else see above.
*/
int wget_strncmp(const char *s1, const char *s2, size_t n)
{
if (!s1) {
if (!s2)
return 0;
else
return -1;
} else {
if (!s2)
return 1;
else
return strncmp(s1, s2, n);
}
}
/**
* wget_strncasecmp:
* @s1: String
* @s2: String
* @n: Max. number of chars to compare
*
* This functions compares @s1 and @s2 in the same way as strncasecmp() does,
* except that it also handles %NULL values. It returns 0 if both @s1 and @s2
* are %NULL. It returns -1 if @s1 is %NULL and @s2 is not %NULL. It returns 1 if
* @s2 is %NULL and @s1 is not %NULL.
*
* Returns: Same as strncasecmp() if none of @s1 or @s2 is %NULL. Else see above.
*/
int wget_strncasecmp(const char *s1, const char *s2, size_t n)
{
if (!s1) {
if (!s2)
return 0;
else
return -1;
} else {
if (!s2)
return 1;
else
return strncasecmp(s1, s2, n);
}
}
/**
* wget_memtohex:
* @src: Pointer to bytes to encode
* @src_len: Number of bytes to encode
* @dst: Buffer to hold the encoded string
* @dst_size: Size in bytes of @dst
*
* Encodes a number of bytes into a lowercase hexadecimal string.
*/
void wget_memtohex(const unsigned char *src, size_t src_len, char *dst, size_t dst_size)
{
size_t it;
int adjust = 0, c;
if (dst_size == 0)
return;
if (src_len * 2 >= dst_size) {
src_len = (dst_size - 1) / 2;
adjust = 1;
}
for (it = 0; it < src_len; it++, src++) {
*dst++ = (c = (*src >> 4)) >= 10 ? c + 'a' - 10 : c + '0';
*dst++ = (c = (*src & 0xf)) >= 10 ? c + 'a' - 10 : c + '0';
}
if (adjust && (dst_size & 1) == 0)
*dst++ = (c = (*src >> 4)) >= 10 ? c + 'a' - 10 : c + '0';
*dst = 0;
}
/**
* wget_millisleep:
* @ms: Number of milliseconds to sleep
*
* Pause for @ms milliseconds.
*/
void wget_millisleep(int ms)
{
if (ms <= 0)
return;
nanosleep(&(struct timespec){ .tv_sec = ms / 1000, .tv_nsec = (ms % 1000) * 1000000 }, NULL);
}
static inline unsigned char G_GNUC_WGET_CONST _unhex(unsigned char c)
{
return c <= '9' ? c - '0' : (c <= 'F' ? c - 'A' + 10 : c - 'a' + 10);
}
/**
* wget_percent_unescape:
* @src: String to unescape
*
* Does an inline percent unescape.
* Each occurrence of %xx (x = hex digit) will converted into it's byte representation.
*
* Returns: 0 if the string did not change, 1 if unescaping took place.
*/
int wget_percent_unescape(char *_src)
{
int ret = 0;
unsigned char *src = (unsigned char *)_src; // just a helper to avoid casting a lot
unsigned char *dst = src;
while (*src) {
if (*src == '%') {
if (c_isxdigit(src[1]) && c_isxdigit(src[2])) {
*dst++ = (_unhex(src[1]) << 4) | _unhex(src[2]);
src += 3;
ret = 1;
continue;
}
}
*dst++ = *src++;
}
*dst = 0;
return ret;
}
/**
* wget_match_tail:
* @s: String
* @tail: String
*
* Checks if @tail matches the end of the string @s.
*
* Returns: 1 if @tail matches the end of @s, 0 if not.
*/
int wget_match_tail(const char *s, const char *tail)
{
const char *p = s + strlen(s) - strlen(tail);
return p >= s && !strcmp(p, tail);
}
/**
* wget_match_tail_nocase:
* @s: String
* @tail: String
*
* Checks if @tail matches the end of the string @s, disregarding the case.
*
* Returns: 1 if @tail matches the end of @s, 0 if not.
*/
int wget_match_tail_nocase(const char *s, const char *tail)
{
const char *p = s + strlen(s) - strlen(tail);
return p >= s && !wget_strcasecmp_ascii(p, tail);
}