DragonNest/Common/SVNLib/doc/group__svn__path__uri__stuff.html
2024-12-19 09:48:26 +08:00

280 lines
13 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Subversion: URI/URL conversion</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>URI/URL conversion</h1>URI/URL stuff.
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__svn__path__uri__stuff.html#gdc3807ba2b493fcbfcf21d783ea916c0">svn_path_is_url</a> (const char *path)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return TRUE iff <em>path</em> looks like a valid absolute URL. <a href="#gdc3807ba2b493fcbfcf21d783ea916c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__svn__path__uri__stuff.html#g4cf332a76cc511b00ef847b9b59633ee">svn_path_is_uri_safe</a> (const char *path)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return <code>TRUE</code> iff <em>path</em> is URI-safe, <code>FALSE</code> otherwise. <a href="#g4cf332a76cc511b00ef847b9b59633ee"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__svn__path__uri__stuff.html#g1f2ce01ef7e239a37baad42b40d556e5">svn_path_uri_encode</a> (const char *path, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a URI-encoded copy of <em>path</em>, allocated in <em>pool</em>. <a href="#g1f2ce01ef7e239a37baad42b40d556e5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__svn__path__uri__stuff.html#ge7cd4fc1524784c72709fd55f1d79c88">svn_path_uri_decode</a> (const char *path, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a URI-decoded copy of <em>path</em>, allocated in <em>pool</em>. <a href="#ge7cd4fc1524784c72709fd55f1d79c88"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__svn__path__uri__stuff.html#g1522f308378a4a74c3d53565f627145f">svn_path_url_add_component</a> (const char *url, const char *component, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extend <em>url</em> by <em>component</em>, URI-encoding that <em>component</em> before adding it to the <em>url</em>; return the new <em>url</em>, allocated in <em>pool</em>. <a href="#g1522f308378a4a74c3d53565f627145f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__svn__path__uri__stuff.html#g4c2ae9dba439035b284799fd1f5f1395">svn_path_uri_from_iri</a> (const char *iri, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert <em>iri</em> (Internationalized URI) to an URI. <a href="#g4c2ae9dba439035b284799fd1f5f1395"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__svn__path__uri__stuff.html#gcd52658595e60c5b6a7d989e8f92ecef">svn_path_uri_autoescape</a> (const char *uri, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">URI-encode certain characters in <em>uri</em> that are not valid in an URI, but doesn't have any special meaning in <em>uri</em> at their positions. <a href="#gcd52658595e60c5b6a7d989e8f92ecef"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
URI/URL stuff.
<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g4cf332a76cc511b00ef847b9b59633ee"></a><!-- doxytag: member="svn_path.h::svn_path_is_uri_safe" ref="g4cf332a76cc511b00ef847b9b59633ee" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> svn_path_is_uri_safe </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>path</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return <code>TRUE</code> iff <em>path</em> is URI-safe, <code>FALSE</code> otherwise.
<p>
</div>
</div><p>
<a class="anchor" name="gdc3807ba2b493fcbfcf21d783ea916c0"></a><!-- doxytag: member="svn_path.h::svn_path_is_url" ref="gdc3807ba2b493fcbfcf21d783ea916c0" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> svn_path_is_url </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>path</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return TRUE iff <em>path</em> looks like a valid absolute URL.
<p>
</div>
</div><p>
<a class="anchor" name="gcd52658595e60c5b6a7d989e8f92ecef"></a><!-- doxytag: member="svn_path.h::svn_path_uri_autoescape" ref="gcd52658595e60c5b6a7d989e8f92ecef" args="(const char *uri, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* svn_path_uri_autoescape </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
URI-encode certain characters in <em>uri</em> that are not valid in an URI, but doesn't have any special meaning in <em>uri</em> at their positions.
<p>
If no characters need escaping, just return <em>uri</em>.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Currently, this function escapes &lt;, &gt;, ", space, {, }, |, \, ^, and `. This may be extended in the future to do context-dependent escaping.</dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.1. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ge7cd4fc1524784c72709fd55f1d79c88"></a><!-- doxytag: member="svn_path.h::svn_path_uri_decode" ref="ge7cd4fc1524784c72709fd55f1d79c88" args="(const char *path, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* svn_path_uri_decode </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a URI-decoded copy of <em>path</em>, allocated in <em>pool</em>.
<p>
</div>
</div><p>
<a class="anchor" name="g1f2ce01ef7e239a37baad42b40d556e5"></a><!-- doxytag: member="svn_path.h::svn_path_uri_encode" ref="g1f2ce01ef7e239a37baad42b40d556e5" args="(const char *path, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* svn_path_uri_encode </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a URI-encoded copy of <em>path</em>, allocated in <em>pool</em>.
<p>
</div>
</div><p>
<a class="anchor" name="g4c2ae9dba439035b284799fd1f5f1395"></a><!-- doxytag: member="svn_path.h::svn_path_uri_from_iri" ref="g4c2ae9dba439035b284799fd1f5f1395" args="(const char *iri, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* svn_path_uri_from_iri </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>iri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert <em>iri</em> (Internationalized URI) to an URI.
<p>
The return value may be the same as <em>iri</em> if it was already a URI. Else, allocate the return value in <em>pool</em>.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.1. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g1522f308378a4a74c3d53565f627145f"></a><!-- doxytag: member="svn_path.h::svn_path_url_add_component" ref="g1522f308378a4a74c3d53565f627145f" args="(const char *url, const char *component, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* svn_path_url_add_component </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>component</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Extend <em>url</em> by <em>component</em>, URI-encoding that <em>component</em> before adding it to the <em>url</em>; return the new <em>url</em>, allocated in <em>pool</em>.
<p>
If <em>component</em> is <code>NULL</code>, just return a copy of <em>url</em>, allocated in <em>pool</em>.<p>
<em>component</em> need not be a single path segment, but if it contains multiple segments, they must be separated by '/'. <em>component</em> should not begin with '/', however; if it does, the behavior is undefined.<p>
<em>url</em> need not be a canonical path; it may have a trailing '/'.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>gstein suggests this for when <em>component</em> begins with '/':</dd></dl>
"replace the path entirely <a href="https://example.com:4444/base/path">https://example.com:4444/base/path</a> joined with /leading/slash, should return: <a href="https://example.com:4444/leading/slash">https://example.com:4444/leading/slash</a> per the RFCs on combining URIs"<p>
We may implement that someday, which is why leading '/' is merely undefined right now.
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 24 16:18:30 2008 for Subversion by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>