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

added API version

This commit is contained in:
Tim Ruehsen 2014-04-23 17:14:29 +02:00
parent f219eb93eb
commit 308224824b
6 changed files with 56 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-index-full.html
View File

@ -2,10 +2,10 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libpsl Reference Manual: API Index</title>
<title>Libpsl Reference Manual: API Index</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libpsl Reference Manual">
<link rel="up" href="index.html" title="libpsl Reference Manual">
<link rel="home" href="index.html" title="Libpsl Reference Manual">
<link rel="up" href="index.html" title="Libpsl Reference Manual">
<link rel="prev" href="object-tree.html" title="Object Hierarchy">
<link rel="next" href="deprecated-api-index.html" title="Index of deprecated API">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">

6
deprecated-api-index.html
View File

@ -2,10 +2,10 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libpsl Reference Manual: Index of deprecated API</title>
<title>Libpsl Reference Manual: Index of deprecated API</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libpsl Reference Manual">
<link rel="up" href="index.html" title="libpsl Reference Manual">
<link rel="home" href="index.html" title="Libpsl Reference Manual">
<link rel="up" href="index.html" title="Libpsl Reference Manual">
<link rel="prev" href="api-index-full.html" title="API Index">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">

13
index.html
View File

@ -2,10 +2,10 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libpsl Reference Manual: libpsl Reference Manual</title>
<title>Libpsl Reference Manual: Libpsl Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libpsl Reference Manual">
<link rel="next" href="ch01.html" title="libpsl functions">
<link rel="home" href="index.html" title="Libpsl Reference Manual">
<link rel="next" href="libpsl.html" title="Libpsl Overview">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
@ -13,9 +13,10 @@
<div class="book">
<div class="titlepage">
<div>
<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">libpsl Reference Manual</p></th></tr></table></div>
<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">Libpsl Reference Manual</p></th></tr></table></div>
<div><p class="releaseinfo">
for libpsl [VERSION].
for Libpsl 0.1
.
The latest version of this documentation can be found on-line at
<a class="ulink" href="http://github.com/rockdaboot/libpsl" target="_top">GitHub</a>.
</p></div>
@ -23,7 +24,7 @@
<hr>
</div>
<div class="toc"><dl class="toc">
<dt><span class="chapter"><a href="ch01.html">libpsl functions</a></span></dt>
<dt><span class="chapter"><a href="libpsl.html">Libpsl Overview</a></span></dt>
<dd><dl><dt>
<span class="refentrytitle"><a href="libpsl-Public-Suffix-List-functions.html">libpsl</a></span><span class="refpurpose"> — Public Suffix List library functions</span>
</dt></dl></dd>

66
libpsl-Public-Suffix-List-functions.html
View File

@ -2,11 +2,11 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libpsl Reference Manual: libpsl</title>
<title>Libpsl Reference Manual: libpsl</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libpsl Reference Manual">
<link rel="up" href="ch01.html" title="libpsl functions">
<link rel="prev" href="ch01.html" title="libpsl functions">
<link rel="home" href="index.html" title="Libpsl Reference Manual">
<link rel="up" href="libpsl.html" title="Libpsl Overview">
<link rel="prev" href="libpsl.html" title="Libpsl Overview">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
@ -19,8 +19,8 @@
<a href="#libpsl-Public-Suffix-List-functions.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libpsl.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libpsl.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
@ -190,8 +190,14 @@ psl_load_file (<em class="parameter"><code>const <span class="type">char</span>
<p>This function loads the public suffixes file named <em class="parameter"><code>fname</code></em>
.
To free the allocated resources, call <a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-free" title="psl_free ()"><code class="function">psl_free()</code></a>.</p>
<p>If you want to use punycode representations for functions like <a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-is-public-suffix" title="psl_is_public_suffix ()"><code class="function">psl_is_public_suffix()</code></a>,
these have to exist as entries within <em class="parameter"><code>fname</code></em>
. This is a design decision to not pull in
dependencies for UTF-8 case-handling and IDNA libraries.</p>
<p>On the contrary, the builtin data already contains punycode entries.</p>
<p>Have a look into psl2c.c for example code on how to convert UTF-8 to lowercase and to punycode.</p>
<div class="refsect3">
<a name="id-1.2.2.9.2.5"></a><h4>Parameters</h4>
<a name="id-1.2.3.9.2.8"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
@ -206,7 +212,7 @@ To free the allocated resources, call <a class="link" href="libpsl-Public-Suffix
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.2.6"></a><h4>Returns</h4>
<a name="id-1.2.3.9.2.9"></a><h4>Returns</h4>
<p> Pointer to a PSL context or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure.</p>
<p></p>
</div>
@ -219,8 +225,9 @@ To free the allocated resources, call <a class="link" href="libpsl-Public-Suffix
psl_load_fp (<em class="parameter"><code><span class="type">FILE</span> *fp</code></em>);</pre>
<p>This function loads the public suffixes from a FILE pointer.
To free the allocated resources, call <a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-free" title="psl_free ()"><code class="function">psl_free()</code></a>.</p>
<p>Have a look at <a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-load-fp" title="psl_load_fp ()"><code class="function">psl_load_fp()</code></a> for punycode considerations.</p>
<div class="refsect3">
<a name="id-1.2.2.9.3.5"></a><h4>Parameters</h4>
<a name="id-1.2.3.9.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
@ -235,7 +242,7 @@ To free the allocated resources, call <a class="link" href="libpsl-Public-Suffix
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.3.6"></a><h4>Returns</h4>
<a name="id-1.2.3.9.3.7"></a><h4>Returns</h4>
<p> Pointer to a PSL context or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure.</p>
<p></p>
</div>
@ -248,9 +255,12 @@ To free the allocated resources, call <a class="link" href="libpsl-Public-Suffix
psl_builtin (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>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.</p>
<p>If the generation of built-in data has been disabled during compilation, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned.</p>
<p>The builtin data also contains punycode entries, one for each international domain name.</p>
<p>If the generation of built-in data has been disabled during compilation, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned.
So if using the builtin psl context, you can provide UTF-8 or punycode representations of domains to
functions like <a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-is-public-suffix" title="psl_is_public_suffix ()"><code class="function">psl_is_public_suffix()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.9.4.6"></a><h4>Returns</h4>
<a name="id-1.2.3.9.4.7"></a><h4>Returns</h4>
<p> Pointer to the built in PSL data or NULL if this data is not available.</p>
<p></p>
</div>
@ -276,7 +286,7 @@ psl_is_public_suffix (<em class="parameter"><code>const <a class="link" href="li
is a context returned by either <a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-load-file" title="psl_load_file ()"><code class="function">psl_load_file()</code></a>, <a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-load-fp" title="psl_load_fp ()"><code class="function">psl_load_fp()</code></a> or
<a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-builtin" title="psl_builtin ()"><code class="function">psl_builtin()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.9.6.7"></a><h4>Parameters</h4>
<a name="id-1.2.3.9.6.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
@ -298,7 +308,7 @@ psl_is_public_suffix (<em class="parameter"><code>const <a class="link" href="li
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.6.8"></a><h4>Returns</h4>
<a name="id-1.2.3.9.6.8"></a><h4>Returns</h4>
<p> 1 if domain is a public suffix, 0 if not.</p>
<p></p>
</div>
@ -317,7 +327,7 @@ of the <a class="ulink" href="http://publicsuffix.org" target="_top">Mozilla Pub
is a context returned by either <a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-load-file" title="psl_load_file ()"><code class="function">psl_load_file()</code></a>, <a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-load-fp" title="psl_load_fp ()"><code class="function">psl_load_fp()</code></a> or
<a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-builtin" title="psl_builtin ()"><code class="function">psl_builtin()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.9.7.6"></a><h4>Parameters</h4>
<a name="id-1.2.3.9.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
@ -339,7 +349,7 @@ of the <a class="ulink" href="http://publicsuffix.org" target="_top">Mozilla Pub
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.7.7"></a><h4>Returns</h4>
<a name="id-1.2.3.9.7.7"></a><h4>Returns</h4>
<p> Pointer to longest public suffix part of <em class="parameter"><code>domain</code></em>
or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>domain</code></em>
does not contain a public suffix (or if <em class="parameter"><code>psl</code></em>
@ -361,7 +371,7 @@ of the <a class="ulink" href="http://publicsuffix.org" target="_top">Mozilla Pub
is a context returned by either <a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-load-file" title="psl_load_file ()"><code class="function">psl_load_file()</code></a>, <a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-load-fp" title="psl_load_fp ()"><code class="function">psl_load_fp()</code></a> or
<a class="link" href="libpsl-Public-Suffix-List-functions.html#psl-builtin" title="psl_builtin ()"><code class="function">psl_builtin()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.9.8.6"></a><h4>Parameters</h4>
<a name="id-1.2.3.9.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
@ -383,7 +393,7 @@ of the <a class="ulink" href="http://publicsuffix.org" target="_top">Mozilla Pub
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.8.7"></a><h4>Returns</h4>
<a name="id-1.2.3.9.8.7"></a><h4>Returns</h4>
<p> Pointer to shortest private suffix part of <em class="parameter"><code>domain</code></em>
or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>domain</code></em>
does not contain a private suffix (or if <em class="parameter"><code>psl</code></em>
@ -402,7 +412,7 @@ psl_suffix_count (<em class="parameter"><code>const <a class="link" href="libpsl
The number of exceptions within the Public Suffix List are not included.</p>
<p>If the generation of built-in data has been disabled during compilation, 0 will be returned.</p>
<div class="refsect3">
<a name="id-1.2.2.9.9.6"></a><h4>Parameters</h4>
<a name="id-1.2.3.9.9.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
@ -417,7 +427,7 @@ The number of exceptions within the Public Suffix List are not included.</p>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.9.7"></a><h4>Returns</h4>
<a name="id-1.2.3.9.9.7"></a><h4>Returns</h4>
<p> Number of public suffixes entries in PSL context.</p>
<p></p>
</div>
@ -432,7 +442,7 @@ psl_suffix_exception_count (<em class="parameter"><code>const <a class="link" hr
.</p>
<p>If the generation of built-in data has been disabled during compilation, 0 will be returned.</p>
<div class="refsect3">
<a name="id-1.2.2.9.10.6"></a><h4>Parameters</h4>
<a name="id-1.2.3.9.10.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
@ -447,7 +457,7 @@ psl_suffix_exception_count (<em class="parameter"><code>const <a class="link" hr
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.10.7"></a><h4>Returns</h4>
<a name="id-1.2.3.9.10.7"></a><h4>Returns</h4>
<p> Number of public suffix exceptions in PSL context.</p>
<p></p>
</div>
@ -461,7 +471,7 @@ psl_builtin_compile_time (<em class="parameter"><code><span class="type">void</s
<p>This function returns the time when the Publix Suffix List has been compiled into C code (by psl2c).</p>
<p>If the generation of built-in data has been disabled during compilation, 0 will be returned.</p>
<div class="refsect3">
<a name="id-1.2.2.9.11.6"></a><h4>Returns</h4>
<a name="id-1.2.3.9.11.6"></a><h4>Returns</h4>
<p> time_t value or 0.</p>
<p></p>
</div>
@ -475,7 +485,7 @@ psl_builtin_file_time (<em class="parameter"><code><span class="type">void</span
<p>This function returns the mtime of the Publix Suffix List file that has been built in.</p>
<p>If the generation of built-in data has been disabled during compilation, 0 will be returned.</p>
<div class="refsect3">
<a name="id-1.2.2.9.12.6"></a><h4>Returns</h4>
<a name="id-1.2.3.9.12.6"></a><h4>Returns</h4>
<p> time_t value or 0.</p>
<p></p>
</div>
@ -490,7 +500,7 @@ psl_builtin_sha1sum (<em class="parameter"><code><span class="type">void</span><
The returned string is in lowercase hex encoding, e.g. "2af1e9e3044eda0678bb05949d7cca2f769901d8".</p>
<p>If the generation of built-in data has been disabled during compilation, an empty string will be returned.</p>
<div class="refsect3">
<a name="id-1.2.2.9.13.6"></a><h4>Returns</h4>
<a name="id-1.2.3.9.13.6"></a><h4>Returns</h4>
<p> String containing SHA1 checksum or an empty string.</p>
<p></p>
</div>
@ -504,7 +514,7 @@ psl_builtin_filename (<em class="parameter"><code><span class="type">void</span>
<p>This function returns the file name of the Publix Suffix List file that has been built in.</p>
<p>If the generation of built-in data has been disabled during compilation, an empty string will be returned.</p>
<div class="refsect3">
<a name="id-1.2.2.9.14.6"></a><h4>Returns</h4>
<a name="id-1.2.3.9.14.6"></a><h4>Returns</h4>
<p> String containing the PSL file name or an empty string.</p>
<p></p>
</div>
@ -529,7 +539,7 @@ but '.com' or 'com' would NOT be acceptable since 'com' is a public suffix.</p><
but NOT for 'forgot.his.name' since 'forgot.his.name' is a public suffix.</p></li>
</ol></div>
<div class="refsect3">
<a name="id-1.2.2.9.15.7"></a><h4>Parameters</h4>
<a name="id-1.2.3.9.15.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
@ -556,7 +566,7 @@ but NOT for 'forgot.his.name' since 'forgot.his.name' is a public suffix.</p></l
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.15.8"></a><h4>Returns</h4>
<a name="id-1.2.3.9.15.8"></a><h4>Returns</h4>
<p> 1 if acceptable, 0 if not acceptable.</p>
<p></p>
</div>

4
libpsl.devhelp2
View File

@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "">
<book xmlns="http://www.devhelp.net/book" title="libpsl Reference Manual" link="index.html" author="" name="libpsl" version="2" language="c">
<book xmlns="http://www.devhelp.net/book" title="Libpsl Reference Manual" link="index.html" author="" name="libpsl" version="2" language="c">
<chapters>
<sub name="libpsl functions" link="ch01.html">
<sub name="Libpsl Overview" link="libpsl.html">
<sub name="libpsl" link="libpsl-Public-Suffix-List-functions.html"/>
</sub>
<sub name="Object Hierarchy" link="object-tree.html"/>

6
object-tree.html
View File

@ -2,10 +2,10 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libpsl Reference Manual: Object Hierarchy</title>
<title>Libpsl Reference Manual: Object Hierarchy</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libpsl Reference Manual">
<link rel="up" href="index.html" title="libpsl Reference Manual">
<link rel="home" href="index.html" title="Libpsl Reference Manual">
<link rel="up" href="index.html" title="Libpsl Reference Manual">
<link rel="prev" href="libpsl-Public-Suffix-List-functions.html" title="libpsl">
<link rel="next" href="api-index-full.html" title="API Index">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">