gnunet_strings_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2001-2013 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet 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
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#if ! defined (__GNUNET_UTIL_LIB_H_INSIDE__)
#error "Only <gnunet_util_lib.h> can be included directly."
#endif
 
#if ! defined (__GNUNET_UTIL_LIB_H_INSIDE__)
#error "Only <gnunet_util_lib.h> can be included directly."
#endif
 
#ifndef GNUNET_STRINGS_LIB_H
#define GNUNET_STRINGS_LIB_H
 
/* we need size_t, and since it can be both unsigned int
   or unsigned long long, this IS platform dependent;
   but "stdlib.h" should be portable 'enough' to be
   unconditionally available... */
 
#include <stdlib.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <netinet/ip.h>
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
#include "gnunet_time_lib.h"
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size,
                                    unsigned long long *size);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_time,
                                       struct GNUNET_TIME_Relative *rtime);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_fancy_time_to_absolute (const char *fancy_time,
                                       struct GNUNET_TIME_Absolute *atime);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_fancy_time_to_timestamp (const char *fancy_time,
                                        struct GNUNET_TIME_Timestamp *atime);
 
 
char *
GNUNET_STRINGS_byte_size_fancy (unsigned long long size);
 
 
char *
GNUNET_STRINGS_conv (const char *input,
                     size_t len,
                     const char *input_charset,
                     const char *output_charset);
 
 
char *
GNUNET_STRINGS_to_utf8 (const char *input,
                        size_t len,
                        const char *charset);
 
 
char*
GNUNET_STRINGS_utf8_normalize (const char *input);
 
 
char *
GNUNET_STRINGS_from_utf8 (const char *input,
                          size_t len,
                          const char *charset);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_utf8_tolower (const char *input,
                             char *output);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_utf8_toupper (const char *input,
                             char *output);
 
 
char *
GNUNET_STRINGS_filename_expand (const char *fil);
 
 
size_t
GNUNET_STRINGS_buffer_fill (char *buffer,
                            size_t size,
                            unsigned int count,
                            ...);
 
 
unsigned int
GNUNET_STRINGS_buffer_tokenize (const char *buffer,
                                size_t size,
                                unsigned int count, ...);
 
 
const char *
GNUNET_STRINGS_timestamp_to_string (struct GNUNET_TIME_Timestamp t);
 
const char *
GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t);
 
 
const char *
GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta,
                                        int do_round);
 
 
const char *
GNUNET_STRINGS_get_short_name (const char *filename);
 
 
char *
GNUNET_STRINGS_data_to_string (const void *data,
                               size_t size,
                               char *out,
                               size_t out_size);
 
 
char *
GNUNET_STRINGS_data_to_string_alloc (const void *buf,
                                     size_t size);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_string_to_data (const char *enc,
                               size_t enclen,
                               void *out,
                               size_t out_size);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_string_to_data_alloc (const char *enc,
                                     size_t enclen,
                                     void **out,
                                     size_t *out_size);
 
 
size_t
GNUNET_STRINGS_base64_encode (const void *in,
                              size_t len,
                              char **output);
 
 
size_t
GNUNET_STRINGS_urlencode (size_t len,
                          const char data[static len],
                          char **out);
 
 
size_t
GNUNET_STRINGS_base64url_encode (const void *in,
                                 size_t len,
                                 char **output);
 
 
size_t
GNUNET_STRINGS_base64_decode (const char *data,
                              size_t len,
                              void **output);
 
 
size_t
GNUNET_STRINGS_base64url_decode (const char *data,
                                 size_t len,
                                 void **out);
 
size_t
GNUNET_STRINGS_urldecode (const char *data,
                          size_t len,
                          char **out);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_parse_uri (const char *path,
                          char **scheme_part,
                          const char **path_part);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_path_is_absolute (const char *filename,
                                 int can_be_uri,
                                 int *r_is_uri,
                                 char **r_uri_scheme);
 
 
enum GNUNET_STRINGS_FilenameCheck
{
  GNUNET_STRINGS_CHECK_EXISTS = 0x00000001,
 
  GNUNET_STRINGS_CHECK_IS_DIRECTORY = 0x00000002,
 
  GNUNET_STRINGS_CHECK_IS_LINK = 0x00000004,
 
  GNUNET_STRINGS_CHECK_IS_ABSOLUTE = 0x00000008
};
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_check_filename (const char *filename,
                               enum GNUNET_STRINGS_FilenameCheck checks);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_to_address_ipv6 (const char *zt_addr,
                                size_t addrlen,
                                struct sockaddr_in6 *r_buf);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr,
                                size_t addrlen,
                                struct sockaddr_in *r_buf);
 
 
size_t
GNUNET_STRINGS_parse_socket_addr (const char *addr,
                                  uint8_t *af,
                                  struct sockaddr **sa);
 
 
enum GNUNET_GenericReturnValue
GNUNET_STRINGS_to_address_ip (const char *addr,
                              uint16_t addrlen,
                              struct sockaddr_storage *r_buf);
 
 
size_t
GNUNET_strlcpy (char *dst,
                const char *src,
                size_t n);
 
 
char *
GNUNET_STRINGS_get_suffix_from_binary_name (const char *argv0);
 
 
/* ***************** IPv4/IPv6 parsing ****************** */
 
struct GNUNET_STRINGS_PortPolicy
{
  uint16_t start_port;
 
  uint16_t end_port;
 
  int negate_portrange;
};
 
 
struct GNUNET_STRINGS_IPv4NetworkPolicy
{
  struct in_addr network;
 
  struct in_addr netmask;
 
  struct GNUNET_STRINGS_PortPolicy pp;
};
 
 
struct GNUNET_STRINGS_IPv6NetworkPolicy
{
  struct in6_addr network;
 
  struct in6_addr netmask;
 
  struct GNUNET_STRINGS_PortPolicy pp;
};
 
 
struct GNUNET_STRINGS_IPv4NetworkPolicy *
GNUNET_STRINGS_parse_ipv4_policy (const char *routeListX);
 
 
struct GNUNET_STRINGS_IPv6NetworkPolicy *
GNUNET_STRINGS_parse_ipv6_policy (const char *routeListX);
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
/* ifndef GNUNET_UTIL_STRING_H */
#endif
  /* end of group */
 /* end of group addition */
 
/* end of gnunet_util_string.h */