From cfe32d3dda9144a05d9e82995306371a6e031ccf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20R=C3=BChsen?= Date: Sat, 30 Jul 2016 14:21:26 +0200 Subject: [PATCH] updated to V0.14.0 --- api-index-full.html | 66 +++- deprecated-api-index.html | 6 +- index.html | 10 +- libpsl-Public-Suffix-List-functions.html | 368 ++++++++++++++++++----- libpsl.devhelp2 | 17 +- object-tree.html | 6 +- 6 files changed, 383 insertions(+), 90 deletions(-) diff --git a/api-index-full.html b/api-index-full.html index c492afc..a019699 100644 --- a/api-index-full.html +++ b/api-index-full.html @@ -3,12 +3,12 @@ API Index: Libpsl Reference Manual - + - + @@ -31,7 +31,11 @@  |  S  |  - U + T +  |  + U +  |  + V Home Prev @@ -46,10 +50,6 @@
-psl_builtin_compile_time, function in Public Suffix List functions -
-
-
psl_builtin_filename, function in Public Suffix List functions
@@ -58,11 +58,19 @@
+psl_builtin_outdated, function in Public Suffix List functions +
+
+
psl_builtin_sha1sum, function in Public Suffix List functions

C

+psl_check_version_number, function in Public Suffix List functions +
+
+
psl_ctx_t, typedef in Public Suffix List functions
@@ -90,6 +98,10 @@ psl_is_public_suffix, function in Public Suffix List functions
+
+psl_is_public_suffix2, function in Public Suffix List functions +
+

L

psl_load_file, function in Public Suffix List functions @@ -117,13 +129,51 @@ psl_suffix_exception_count, function in Public Suffix List functions
+
+psl_suffix_wildcard_count, function in Public Suffix List functions +
+
+

T

+
+PSL_TYPE_ANY, macro in Public Suffix List functions +
+
+
+PSL_TYPE_ICANN, macro in Public Suffix List functions +
+
+
+PSL_TYPE_PRIVATE, macro in Public Suffix List functions +
+

U

psl_unregistrable_domain, function in Public Suffix List functions
+

V

+
+PSL_VERSION, macro in Public Suffix List functions +
+
+
+PSL_VERSION_MAJOR, macro in Public Suffix List functions +
+
+
+PSL_VERSION_MINOR, macro in Public Suffix List functions +
+
+
+PSL_VERSION_NUMBER, macro in Public Suffix List functions +
+
+
+PSL_VERSION_PATCH, macro in Public Suffix List functions +
+
-
Generated by GTK-Doc V1.24
+
Generated by GTK-Doc V1.25 \ No newline at end of file diff --git a/deprecated-api-index.html b/deprecated-api-index.html index f4de39f..011fb31 100644 --- a/deprecated-api-index.html +++ b/deprecated-api-index.html @@ -3,11 +3,11 @@ Index of deprecated API: Libpsl Reference Manual - + - + @@ -24,6 +24,6 @@
-
Generated by GTK-Doc V1.24
+
Generated by GTK-Doc V1.25 \ No newline at end of file diff --git a/index.html b/index.html index bdb6e23..3a2f37f 100644 --- a/index.html +++ b/index.html @@ -3,10 +3,10 @@ Libpsl Reference Manual: Libpsl Reference Manual - + - + @@ -15,10 +15,10 @@

- for Libpsl 0.8.0 + for Libpsl 0.14.0 . The latest version of this documentation can be found on-line at - GitHub. + GitHub.

@@ -34,6 +34,6 @@
-
Generated by GTK-Doc V1.24
+
Generated by GTK-Doc V1.25 \ No newline at end of file diff --git a/libpsl-Public-Suffix-List-functions.html b/libpsl-Public-Suffix-List-functions.html index d26d6de..efac629 100644 --- a/libpsl-Public-Suffix-List-functions.html +++ b/libpsl-Public-Suffix-List-functions.html @@ -3,12 +3,12 @@ libpsl: Libpsl Reference Manual - + - + @@ -37,7 +37,7 @@

Functions

-
+
@@ -83,6 +83,14 @@ + + + + @@ -147,6 +155,14 @@ int + + + + @@ -159,6 +175,14 @@ + + + +
+int + +psl_is_public_suffix2 () +
const char * @@ -114,10 +122,10 @@
-time_t +int -psl_builtin_compile_time () +psl_suffix_wildcard_count ()
+psl_builtin_outdated () +
+int + psl_is_cookie_domain_acceptable ()
+int + +psl_check_version_number () +
psl_error_t @@ -170,13 +194,45 @@

Types and Values

-
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -194,7 +250,7 @@

Description

-

Public Suffix List library functions.

+

Public Suffix List library functions.

Functions

@@ -207,8 +263,8 @@ psl_load_file (const char To free the allocated resources, call psl_free().

The suffixes are expected to be lowercase UTF-8 encoded if they are international.

-

Parameters

-
#definePSL_VERSION
#definePSL_VERSION_MAJOR
#definePSL_VERSION_MINOR
#definePSL_VERSION_NUMBER
#definePSL_VERSION_PATCH
#definePSL_TYPE_ICANN
#definePSL_TYPE_PRIVATE
#definePSL_TYPE_ANY
enum psl_error_t
+

Parameters

+
@@ -222,8 +278,8 @@ To free the allocated resources, call -

Returns

-

Pointer to a PSL context or NULL on failure.

+

Returns

+

Pointer to a PSL context or NULL on failure.

Since: 0.1

@@ -236,8 +292,8 @@ psl_load_fp (FILE *fppsl_free().

The suffixes are expected to be lowercase UTF-8 encoded if they are international.

-

Parameters

-
+

Parameters

+
@@ -251,8 +307,8 @@ To free the allocated resources, call -

Returns

-

Pointer to a PSL context or NULL on failure.

+

Returns

+

Pointer to a PSL context or NULL on failure.

Since: 0.1

@@ -264,11 +320,11 @@ psl_builtin (voidThis 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.

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. -So if using the builtin psl context, you can provide UTF-8 or punycode representations of domains to +

If the generation of built-in data has been disabled during compilation, NULL will be returned. +When using the builtin psl context, you can provide UTF-8 or punycode representations of domains to functions like psl_is_public_suffix().

-

Returns

+

Returns

Pointer to the built in PSL data or NULL if this data is not available.

Since: 0.1

@@ -278,6 +334,24 @@ functions like

psl_free ()

void
 psl_free (psl_ctx_t *psl);
+

This function frees the the PSL context that has been retrieved via +psl_load_fp() or psl_load_file().

+
+

Parameters

+
+++++ + + + + + +

psl

PSL context pointer

 
+
+

Since: 0.1

@@ -287,7 +361,7 @@ psl_is_public_suffix (const const char *domain);

This function checks if domain is a public suffix by the means of the -Mozilla Public Suffix List.

+Mozilla Public Suffix List.

For cookie domain checking see psl_is_cookie_domain_acceptable().

International domain names have to be either in lowercase UTF-8 or in ASCII form (punycode). @@ -296,8 +370,8 @@ Other encodings result in unexpected behavior.

is a context returned by either psl_load_file(), psl_load_fp() or psl_builtin().

-

Parameters

-
+

Parameters

+
@@ -318,7 +392,59 @@ Other encodings result in unexpected behavior.

-

Returns

+

Returns

+

1 if domain is a public suffix, 0 if not.

+
+

Since: 0.1

+
+
+
+

psl_is_public_suffix2 ()

+
int
+psl_is_public_suffix2 (const psl_ctx_t *psl,
+                       const char *domain,
+                       int type);
+

This function checks if domain + is a public suffix by the means of the +Mozilla Public Suffix List.

+

type + specifies the PSL section where to perform the lookup. Valid values are +PSL_TYPE_PRIVATE, PSL_TYPE_ICANN and PSL_TYPE_ANY.

+

International domain + names have to be either in lowercase UTF-8 or in ASCII form (punycode). +Other encodings result in unexpected behavior.

+

psl + is a context returned by either psl_load_file(), psl_load_fp() or +psl_builtin().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

psl

PSL context

 

domain

Domain string

 

type

Domain type

 
+
+
+

Returns

1 if domain is a public suffix, 0 if not.

Since: 0.1

@@ -329,9 +455,9 @@ Other encodings result in unexpected behavior.

const char *
 psl_unregistrable_domain (const psl_ctx_t *psl,
                           const char *domain);
-

This function finds the longest publix suffix part of domain +

This function finds the longest public suffix part of domain by the means -of the Mozilla Public Suffix List.

+of the Mozilla Public Suffix List.

International domain names have to be either in lowercase UTF-8 or in ASCII form (punycode). Other encodings result in unexpected behavior.

@@ -339,8 +465,8 @@ Other encodings result in unexpected behavior.

is a context returned by either psl_load_file(), psl_load_fp() or psl_builtin().

-

Parameters

-
+

Parameters

+
@@ -361,11 +487,11 @@ Other encodings result in unexpected behavior.

-

Returns

+

Returns

Pointer to longest public suffix part of domain -or NULL if domain +or NULL if domain does not contain a public suffix (or if psl -is NULL).

+is NULL).

Since: 0.1

@@ -377,7 +503,7 @@ psl_registrable_domain (const const char *domain);

This function finds the shortest private suffix part of domain by the means -of the Mozilla Public Suffix List.

+of the Mozilla Public Suffix List.

International domain names have to be either in lowercase UTF-8 or in ASCII form (punycode). Other encodings result in unexpected behavior.

@@ -385,8 +511,8 @@ Other encodings result in unexpected behavior.

is a context returned by either psl_load_file(), psl_load_fp() or psl_builtin().

-

Parameters

-
+

Parameters

+
@@ -407,11 +533,11 @@ Other encodings result in unexpected behavior.

-

Returns

+

Returns

Pointer to shortest private suffix part of domain -or NULL if domain +or NULL if domain does not contain a private suffix (or if psl -is NULL).

+is NULL).

Since: 0.1

@@ -423,10 +549,9 @@ psl_suffix_count (const psl . The number of exceptions within the Public Suffix List are not included.

-

If the generation of built-in data has been disabled during compilation, 0 will be returned.

-

Parameters

-
+

Parameters

+
@@ -440,7 +565,7 @@ The number of exceptions within the Public Suffix List are not included.

-

Returns

+

Returns

Number of public suffixes entries in PSL context.

Since: 0.1

@@ -452,10 +577,9 @@ The number of exceptions within the Public Suffix List are not included.

psl_suffix_exception_count (const psl_ctx_t *psl);

This function returns number of public suffix exceptions maintained by psl .

-

If the generation of built-in data has been disabled during compilation, 0 will be returned.

-

Parameters

-
+

Parameters

+
@@ -469,23 +593,38 @@ psl_suffix_exception_count (const
-

Returns

+

Returns

Number of public suffix exceptions in PSL context.

Since: 0.1

-

psl_builtin_compile_time ()

-
time_t
-psl_builtin_compile_time (void);
-

This function returns the time when the Publix Suffix List has been compiled into C code (by psl2c).

-

If the generation of built-in data has been disabled during compilation, 0 will be returned.

+

psl_suffix_wildcard_count ()

+
int
+psl_suffix_wildcard_count (const psl_ctx_t *psl);
+

This function returns number of public suffix wildcards maintained by psl +.

-

Returns

-

time_t value or 0.

+

Parameters

+
+++++ + + + + + +

psl

PSL context pointer

 
-

Since: 0.1

+
+

Returns

+

Number of public suffix wildcards in PSL context.

+
+

Since: 0.10.0

@@ -495,7 +634,7 @@ psl_builtin_file_time (voidThis function returns the mtime of the Publix Suffix List file that has been built in.

If the generation of built-in data has been disabled during compilation, 0 will be returned.

-

Returns

+

Returns

time_t value or 0.

Since: 0.1

@@ -509,7 +648,7 @@ psl_builtin_sha1sum (void< The returned string is in lowercase hex encoding, e.g. "2af1e9e3044eda0678bb05949d7cca2f769901d8".

If the generation of built-in data has been disabled during compilation, an empty string will be returned.

-

Returns

+

Returns

String containing SHA1 checksum or an empty string.

Since: 0.1

@@ -522,13 +661,28 @@ psl_builtin_filename (void

This function returns the file name of the Publix Suffix List file that has been built in.

If the generation of built-in data has been disabled during compilation, an empty string will be returned.

-

Returns

+

Returns

String containing the PSL file name or an empty string.

Since: 0.1

+

psl_builtin_outdated ()

+
int
+psl_builtin_outdated (void);
+

This function checks if the built-in data is older than the file it has been created from. +If it is, it might be a good idea for the application to reload the PSL. +The mtime is taken as reference.

+

If the PSL file does not exist, it is assumed that the built-in data is not outdated.

+
+

Returns

+

1 if the built-in is outdated, 0 otherwise.

+
+

Since: 0.10.0

+
+
+

psl_is_cookie_domain_acceptable ()

int
 psl_is_cookie_domain_acceptable (const psl_ctx_t *psl,
@@ -550,8 +704,8 @@ but '.com' or 'com' would NOT be acceptable since 'com' is a public suffix.
<
 but NOT for 'forgot.his.name' since 'forgot.his.name' is a public suffix.
-

Parameters

-
+

Parameters

+
@@ -577,7 +731,7 @@ but NOT for 'forgot.his.name' since 'forgot.his.name' is a public suffix.

-

Returns

+

Returns

1 if acceptable, 0 if not acceptable.

Since: 0.1

@@ -589,13 +743,43 @@ but NOT for 'forgot.his.name' since 'forgot.his.name' is a public suffix.

void);

Get libpsl version.

-

Returns

+

Returns

String containing version of libpsl.

Since: 0.2.5

+

psl_check_version_number ()

+
int
+psl_check_version_number (int version);
+

Check the given version number is at minimum the current library version number. +The version number must be a hexadecimal number like 0x000a01 (V0.10.1).

+
+

Parameters

+
+++++ + + + + + +

version

Version number (hex) to check against.

 
+
+
+

Returns

+

Returns the library version number if the given version number is at least +the version of the library, else return 0; If the argument is 0, the function returns +the library version number without performing a check.

+
+

Since: 0.11.0

+ +
+

psl_str_to_utf8lower ()

psl_error_t
 psl_str_to_utf8lower (const char *str,
@@ -605,11 +789,11 @@ psl_str_to_utf8lower (const char<
 
This helper function converts a string to lowercase UTF-8 representation.
 Lowercase UTF-8 is needed as input to the domain checking functions.

 
lower
- is set to NULL on error.

+ is set to NULL on error.

 
The return value 'lower' must be freed after usage.

 

-
Parameters

-

+
Parameters

+
@@ -624,13 +808,13 @@ Lowercase UTF-8 is needed as input to the domain checking functions.

+, e.g. 'iso-8859-1' or NULL

+for to lowercase conversion, e.g. 'de' or NULL

@@ -642,11 +826,11 @@ for to lowercase conversion, e.g. 'de' or 
-
Returns

+
Returns
 psl_error_t value.
 PSL_SUCCESS: Success
 PSL_ERR_INVALID_ARG: str
-is a NULL value.
+is a NULL value.
 PSL_ERR_CONVERTER: Failed to open the unicode converter with name encoding
 PSL_ERR_TO_UTF16: Failed to convert str
 to unicode
@@ -659,13 +843,61 @@ PSL_ERR_TO_UTF8: Failed to convert unicode to UTF-8

 
Types and Values

 

+
PSL_VERSION

+
#define PSL_VERSION "0.14.0"
+

+

+

+

+
PSL_VERSION_MAJOR

+
#define PSL_VERSION_MAJOR 0
+

+

+

+

+
PSL_VERSION_MINOR

+
#define PSL_VERSION_MINOR 14
+

+

+

+

+
PSL_VERSION_NUMBER

+
#define PSL_VERSION_NUMBER 0x000e00
+

+

+

+

+
PSL_VERSION_PATCH

+
#define PSL_VERSION_PATCH 0
+

+

+

+

+
PSL_TYPE_ICANN

+
#define PSL_TYPE_ICANN   (1<<0)
+

+

+

+

+
PSL_TYPE_PRIVATE

+
#define PSL_TYPE_PRIVATE (1<<1)
+

+

+

+

+
PSL_TYPE_ANY

+
#define PSL_TYPE_ANY     (PSL_TYPE_ICANN | PSL_TYPE_PRIVATE)
+

+

+

+

 
enum psl_error_t

 
Return codes for PSL functions.
 Negative return codes mean failure.
 Positive values are reserved for non-error return codes.

 

-
Members

-

 
 
 

 

 
encoding

 
charset encoding of str
-, e.g. 'iso-8859-1' or NULL

  
 

 

 
locale

 
locale of str
-for to lowercase conversion, e.g. 'de' or NULL

  
 

 

 
 

+
Members

+
@@ -727,6 +959,6 @@ Positive values are reserved for non-error return codes.

-
Generated by GTK-Doc V1.24

+
Generated by GTK-Doc V1.25
\ No newline at end of file
diff --git a/libpsl.devhelp2 b/libpsl.devhelp2
index 4eea0d3..660db0b 100644
--- a/libpsl.devhelp2
+++ b/libpsl.devhelp2
@@ -1,5 +1,5 @@
 
-
+
   
     
       
@@ -12,19 +12,30 @@
     
     
     
-    
+    
     
+    
     
     
     
     
-    
+    
     
     
     
+    
     
     
+    
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
diff --git a/object-tree.html b/object-tree.html
index 29474d0..48b720a 100644
--- a/object-tree.html
+++ b/object-tree.html
@@ -3,12 +3,12 @@
 
 
 Object Hierarchy: Libpsl Reference Manual
-
+
 
 
 
 
-
+
 
 
 
@@ -27,6 +27,6 @@
 
 
 

-
Generated by GTK-Doc V1.24

+
Generated by GTK-Doc V1.25
 
 
\ No newline at end of file