logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

libwget-utils - General utility functions

Author

       Generated automatically by Doxygen for wget2 from the source code.

wget2                                             Version 2.2.0                                 libwget-utils(3)

Detailed Description

       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.

Function Documentation

size_twget_strlcpy(char*dst,constchar*src,size_tsize)Parametersdst Output string buffer
           src Input string
           size Size of dst

       Returns
           Length of src

       Copy string src into dst with overflow checking.

       This is the same as snprintf(dst,size,'%s',src) but faster and more elegant.

       If src is NULL, the return value is 0 and nothing is written. If \ dst is NULL, the return value is the
       length of src and nothing is written.

   ssize_twget_strscpy(char*dst,constchar*src,size_tsize)Parametersdst Output string buffer
           src Input string
           size Size of dst

       Returns
           Number of copied bytes (excluding trailing 0) or -1 when src doesn't fit into dst

       Copy string src into dst with overflow checking.

       If either dst is NULL or size is 0, the return value is -1 and nothing is written. If src is NULL and
       size is 0, the return value is -1. If src is NULL and size is >0, the return value is 0 and dst is an
       empty string.

       Else the return value is the number of bytes copied to dst excluding the terminating 0.

   intwget_strcmp(constchar*s1,constchar*s2)Parameterss1 String
           s2 String

       Returns
           0 if both s1 and s2 are NULL
            -1 if s1 is NULL and s2 is not NULL
            1 if s1 is not NULL and s2 is NULL else it returns strcmp(s1, s2)

       This functions compares s1 and s2 in the same way as strcmp() does, except that it also handles NULL
       values.

   intwget_strcasecmp(constchar*s1,constchar*s2)Parameterss1 String
           s2 String

       Returns
           0 if both s1 and s2 are NULL
            -1 if s1 is NULL and s2 is not NULL
            1 if s1 is not NULL and s2 is NULL else it returns strcasecmp(s1, s2)

       This functions compares s1 and s2 in the same way as strcasecmp() does, except that it also handles NULL
       values.

   intwget_strcasecmp_ascii(constchar*s1,constchar*s2)Parameterss1 String
           s2 String

       Returns
           0 if both s1 and s2 are the same disregarding case for ASCII letters a-z
            0 if both s1 and s2 are NULL
            <0 if s1 is NULL and s2 is not NULL or s1 is smaller than s2
            >0 if s2 is NULL and s1 is not NULL or s1 is greater than s2.

       This functions compares s1 and s2 as ASCII strings, case insensitive. It also accepts NULL values.

   intwget_strncasecmp_ascii(constchar*s1,constchar*s2,size_tn)Parameterss1 String
           s2 String
           n Max. number of chars to compare

       Returns
           0 if both s1 and s2 are the same disregarding case for ASCII letters a-z
            0 if both s1 and s2 are NULL
            <0 if s1 is NULL and s2 is not NULL or s1 is smaller than s2
            >0 if s2 is NULL and s1 is not NULL or s1 is greater than s2.

       This functions compares s1 and s2 as ASCII strings, case insensitive, up to a max number of n chars. It
       also accepts NULL values.

   char*wget_strtolower(char*s)Parameterss String to convert

       Returns
           Value of s

       Converts ASCII string s to lowercase in place.

   intwget_strncmp(constchar*s1,constchar*s2,size_tn)Parameterss1 String
           s2 String
           n Max. number of chars to compare

       Returns
           0 if both s1 and s2 are the same or if both s1 and s2 are NULL
            <0 if s1 is NULL and s2 is not NULL or s1 is smaller than s2
            >0 if s2 is NULL and s1 is not NULL or s1 is greater than s2.

       This functions compares s1 and s2 in the same way as strncmp() does, except that it also handles NULL
       values.

   intwget_strncasecmp(constchar*s1,constchar*s2,size_tn)Parameterss1 String
           s2 String
           n Max. number of chars to compare

       Returns
           0 if both s1 and s2 are the same disregarding case or if both s1 and s2 are NULL
            <0 if s1 is NULL and s2 is not NULL or s1 is smaller than s2
            >0 if s2 is NULL and s1 is not NULL or s1 is greater than s2.

       This functions compares s1 and s2 in the same way as strncasecmp() does, except that it also handles NULL
       values.

   voidwget_memtohex(constunsignedchar*src,size_tsrc_len,char*dst,size_tdst_size)Parameterssrc Pointer to input buffer
           src_len Number of bytes to encode
           dst Buffer to hold the encoded string
           dst_size Size of dst in bytes

       Encodes a number of bytes into a lowercase hexadecimal C string.

   voidwget_millisleep(intms)Parametersms Number of milliseconds to sleep

       Pause for ms milliseconds.

   longlongwget_get_timemillis(void)
       Return the current milliseconds since the epoch.

   intwget_percent_unescape(char*src)Parameterssrc String to unescape

       Returns
           0 if the string did not change
            1 if unescaping took place

       Does an inline percent unescape. Each occurrence of xx (x = hex digit) will converted into it's byte
       representation.

   intwget_match_tail(constchar*s,constchar*tail)Parameterss String
           tail String

       Returns
           1 if tail matches the end of s, 0 if not

       Checks if tail matches the end of the string s.

   intwget_match_tail_nocase(constchar*s,constchar*tail)Parameterss String
           tail String

       Returns
           1 if tail matches the end of s, 0 if not

       Checks if tail matches the end of the string s, disregarding the case, ASCII only.

   char*wget_strnglob(constchar*str,size_tn,intflags)Parametersstr String to run glob() against
           n Length of string
           flags Flags to pass to glob()

       Returns
           Expanded string after running glob

       Finds a pathname by running glob(3) on the pattern in the first n bytes of globstr. Returns a newly
       allocated string with the first n bytes replaced with the matching pattern obtained via glob(3) if one
       was found. Otherwise it returns NULL.

   char*wget_human_readable(char*buf,size_tbufsize,uint64_tn)Parametersbuf Result buffer
           bufsize Size of /p buf
           n Number to convert

       Returns
           Pointer to printable representation of n

       Returns a human readable representation of n. n, a byte quantity, is converted to a human-readable
       abbreviated form a la sizes printed by `ls -lh'. The result is written into the provided buffer.

       Unlike `with_thousand_seps', this approximates to the nearest unit. Quoting GNU libit: 'Most people
       visually process strings of 3-4 digits effectively, but longer strings of digits are more prone to
       misinterpretation.  Hence, converting to an abbreviated form usually improves readability.'

       This intentionally uses kilobyte (KB), megabyte (MB), etc. in their original computer-related meaning of
       'powers of 1024'. We don't use the '*bibyte' names invented in 1998, and seldom used in practice.
       Wikipedia's entry on 'binary prefix' discusses this in some detail.

   intwget_get_screen_size(int*width,int*height)Parameterswidth Number of columns in terminal
           height Number of rows in terminal

       Returns
           Upon successful completion, wget_get_screen_size will return 0, and the values of width and height
           will be set accordingly. If an error was encountered, the function will return -1 without touching
           the values of width and height.

       Get the size of the terminal to which the output is currently printed (stderr). This function accepts two
       int pointers and will set their values to the width and height of the active terminal in number of
       columns. If either of the parameter is NULL, its value will not be set by the function.

Name

       libwget-utils - General utility functions

Synopsis

Functions
       size_t wget_strlcpy (char *dst, const char *src, size_t size)
       ssize_t wget_strscpy (char *dst, const char *src, size_t size)
       int wget_strcmp (const char *s1, const char *s2)
       int wget_strcasecmp (const char *s1, const char *s2)
       int wget_strcasecmp_ascii (const char *s1, const char *s2)
       int wget_strncasecmp_ascii (const char *s1, const char *s2, size_t n)
       char * wget_strtolower (char *s)
       int wget_strncmp (const char *s1, const char *s2, size_t n)
       int wget_strncasecmp (const char *s1, const char *s2, size_t n)
       void wget_memtohex (const unsigned char *src, size_t src_len, char *dst, size_t dst_size)
       void wget_millisleep (int ms)
       long long wget_get_timemillis (void)
       int wget_percent_unescape (char *src)
       int wget_match_tail (const char *s, const char *tail)
       int wget_match_tail_nocase (const char *s, const char *tail)
       char * wget_strnglob (const char *str, size_t n, int flags)
       char * wget_human_readable (char *buf, size_t bufsize, uint64_t n)
       int wget_get_screen_size (int *width, int *height)

See Also