walkero
/
libpsl
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

added punycode considerations to the API docs

This commit is contained in:
Tim Ruehsen 2014-04-22 16:49:00 +02:00
parent ed9562848c
commit 608d9d951f
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/psl.c
View File

@ -419,6 +419,14 @@ const char *psl_registrable_domain(const psl_ctx_t *psl, const char *domain)
* This function loads the public suffixes file named @fname. * This function loads the public suffixes file named @fname.
* To free the allocated resources, call psl_free(). * To free the allocated resources, call psl_free().
* *
* If you want to use punycode representations for functions like psl_is_public_suffix(),
* these have to exist as entries within @fname. This is a design decision to not pull in
* dependencies for UTF-8 case-handling and IDNA libraries.
*
* On the contrary, the builtin data already contains punycode entries.
*
* Have a look into psl2c.c for example code on how to convert UTF-8 to lowercase and to punycode.
*
* Returns: Pointer to a PSL context or %NULL on failure. * Returns: Pointer to a PSL context or %NULL on failure.
* *
* Since: 0.1 * Since: 0.1
@ -446,6 +454,8 @@ psl_ctx_t *psl_load_file(const char *fname)
* This function loads the public suffixes from a FILE pointer. * This function loads the public suffixes from a FILE pointer.
* To free the allocated resources, call psl_free(). * To free the allocated resources, call psl_free().
* *
* Have a look at psl_load_fp() for punycode considerations.
*
* Returns: Pointer to a PSL context or %NULL on failure. * Returns: Pointer to a PSL context or %NULL on failure.
* *
* Since: 0.1 * Since: 0.1
@ -530,7 +540,11 @@ void psl_free(psl_ctx_t *psl)
* This function returns the PSL context that has been generated and built in at compile-time. * This function returns the PSL context that has been generated and built in at compile-time.
* You don't have to free the returned context explicitely. * You don't have to free the returned context explicitely.
* *
* The builtin data also contains punycode entries, one for each international domain name.
*
* If the generation of built-in data has been disabled during compilation, %NULL will be returned. * If the generation of built-in data has been disabled during compilation, %NULL will be returned.
* So if using the builtin psl context, you can provide UTF-8 or punycode representations of domains to
* functions like psl_is_public_suffix().
* *
* Returns: Pointer to the built in PSL data or NULL if this data is not available. * Returns: Pointer to the built in PSL data or NULL if this data is not available.
* *