From eabf39c174b37928fb65bb8974cfd386022ad462 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20R=C3=BChsen?= Date: Wed, 23 Sep 2015 12:38:34 +0200 Subject: [PATCH] Add version numbers to libpsl.h --- configure.ac | 9 +++ include/libpsl.h.in | 130 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 139 insertions(+) create mode 100644 include/libpsl.h.in diff --git a/configure.ac b/configure.ac index 9e7fa06..cf16859 100644 --- a/configure.ac +++ b/configure.ac @@ -17,6 +17,15 @@ m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) dnl Check that compiler understands inline AC_C_INLINE +# +# Generate version defines for include file +# +AC_SUBST([LIBPSL_VERSION_MAJOR], [`echo -n $VERSION|cut -d'.' -f1`]) +AC_SUBST([LIBPSL_VERSION_MINOR], [`echo -n $VERSION|cut -d'.' -f2`]) +AC_SUBST([LIBPSL_VERSION_PATCH], [`echo -n $VERSION|cut -d'.' -f3`]) +AC_SUBST([LIBPSL_VERSION_NUMBER], [`printf '0x%02x%02x%02x' $LIBPSL_VERSION_MAJOR $LIBPSL_VERSION_MINOR $LIBPSL_VERSION_PATCH`]) +AC_CONFIG_FILES([include/libpsl.h]) + # # Gettext # diff --git a/include/libpsl.h.in b/include/libpsl.h.in new file mode 100644 index 0000000..87f4594 --- /dev/null +++ b/include/libpsl.h.in @@ -0,0 +1,130 @@ +/* + * Copyright(c) 2014 Tim Ruehsen + * + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. + * + * This file is part of libpsl. + * + * Header file for libpsl library routines + * + * Changelog + * 20.03.2014 Tim Ruehsen created + * + */ + +#ifndef _LIBPSL_LIBPSL_H +#define _LIBPSL_LIBPSL_H + +#include +#include + +#define PSL_VERSION "@LIBPSL_VERSION@" +#define PSL_VERSION_MAJOR @LIBPSL_VERSION_MAJOR@ +#define PSL_VERSION_MINOR @LIBPSL_VERSION_MINOR@ +#define PSL_VERSION_PATCH @LIBPSL_VERSION_PATCH@ +#define PSL_VERSION_NUMBER @LIBPSL_VERSION_NUMBER@ + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * psl_error_t: + * @PSL_SUCCESS: Successful return. + * @PSL_ERR_INVALID_ARG: Invalid argument. + * @PSL_ERR_CONVERTER: Failed to open libicu utf-16 converter + * @PSL_ERR_TO_UTF16: Failed to convert to utf-16. + * @PSL_ERR_TO_LOWER: Failed to convert utf-16 to lowercase. + * @PSL_ERR_TO_UTF8: Failed to convert utf-16 to utf-8. + * + * Return codes for PSL functions. + * Negative return codes mean failure. + * Positive values are reserved for non-error return codes. + */ +typedef enum { + PSL_SUCCESS = 0, + PSL_ERR_INVALID_ARG = -1, + PSL_ERR_CONVERTER = -2, /* failed to open libicu utf-16 converter */ + PSL_ERR_TO_UTF16 = -3, /* failed to convert to utf-16 */ + PSL_ERR_TO_LOWER = -4, /* failed to convert utf-16 to lowercase */ + PSL_ERR_TO_UTF8 = -5 /* failed to convert utf-16 to utf-8 */ +} psl_error_t; + +typedef struct _psl_ctx_st psl_ctx_t; + +/* frees PSL context */ +void + psl_free(psl_ctx_t *psl); +/* loads PSL data from file */ +psl_ctx_t * + psl_load_file(const char *fname); +/* loads PSL data from FILE pointer */ +psl_ctx_t * + psl_load_fp(FILE *fp); +/* retrieves builtin PSL data */ +const psl_ctx_t * + psl_builtin(void); +/* checks whether domain is a public suffix or not */ +int + psl_is_public_suffix(const psl_ctx_t *psl, const char *domain); +/* checks whether cookie_domain is acceptable for domain or not */ +int + psl_is_cookie_domain_acceptable(const psl_ctx_t *psl, const char *hostname, const char *cookie_domain); +/* returns the longest not registrable domain within 'domain' or NULL if none found */ +const char * + psl_unregistrable_domain(const psl_ctx_t *psl, const char *domain); +/* returns the shortest possible registrable domain part or NULL if domain is not registrable at all */ +const char * + psl_registrable_domain(const psl_ctx_t *psl, const char *domain); +/* convert a string into lowercase UTF-8 */ +psl_error_t + psl_str_to_utf8lower(const char *str, const char *encoding, const char *locale, char **lower); +/* does not include exceptions */ +int + psl_suffix_count(const psl_ctx_t *psl); +/* just counts exceptions */ +int + psl_suffix_exception_count(const psl_ctx_t *psl); +/* just counts wildcards */ +int + psl_suffix_wildcard_count(const psl_ctx_t *psl); +/* returns compilation time */ +time_t + psl_builtin_compile_time(void); +/* returns mtime of PSL source file */ +time_t + psl_builtin_file_time(void); +/* returns SHA1 checksum (hex-encoded, lowercase) of PSL source file */ +const char * + psl_builtin_sha1sum(void); +/* returns file name of PSL source file */ +const char * + psl_builtin_filename(void); +/* returns library version */ +const char * + psl_get_version(void); +/* returns wether the built-in data is outdated or not */ +int + psl_builtin_outdated(void); + +#ifdef __cplusplus +} +#endif + +#endif /* _LIBPSL_LIBPSL_H */