/usr/share/doc/liblzma-doc/html/filter__common_8c.html is in liblzma-doc 5.1.1alpha+20120614-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>XZ Utils: liblzma/common/filter_common.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">XZ Utils
 <span id="projectnumber">5.1.0alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_2e0898c272e1f0f93c8ef15f5da2a912.html">liblzma</a></li><li class="navelem"><a class="el" href="dir_db777975f8e21a5de5f283e04473bf67.html">common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">filter_common.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Filter-specific stuff common for both encoder and decoder.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "filter_common.h"</code><br/>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a81cd5593eb33e5e62a0fd5112e87d831"><td class="memItemLeft" align="right" valign="top"><a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="filter__common_8c.html#a81cd5593eb33e5e62a0fd5112e87d831">lzma_filters_copy</a> (const <a class="el" href="structlzma__filter.html">lzma_filter</a> *src, <a class="el" href="structlzma__filter.html">lzma_filter</a> *dest, <a class="el" href="structlzma__allocator.html">lzma_allocator</a> *allocator)</td></tr>
<tr class="memdesc:a81cd5593eb33e5e62a0fd5112e87d831"><td class="mdescLeft"> </td><td class="mdescRight">Copy the filters array. <a href="#a81cd5593eb33e5e62a0fd5112e87d831"></a><br/></td></tr>
<tr class="memitem:a86c7af045ea6eac6133d22c110d43ca2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86c7af045ea6eac6133d22c110d43ca2"></a>
static <a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><b>validate_chain</b> (const <a class="el" href="structlzma__filter.html">lzma_filter</a> *<a class="el" href="coder_8c.html#a9325236d5759d4eaadcba08a6bb5c96f">filters</a>, size_t *count)</td></tr>
<tr class="memitem:a1be9cd8ce7549e35f6ed23a316984214"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1be9cd8ce7549e35f6ed23a316984214"></a>
<a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><b>lzma_raw_coder_init</b> (<a class="el" href="structlzma__next__coder__s.html">lzma_next_coder</a> *next, <a class="el" href="structlzma__allocator.html">lzma_allocator</a> *allocator, const <a class="el" href="structlzma__filter.html">lzma_filter</a> *options, lzma_filter_find coder_find, bool is_encoder)</td></tr>
<tr class="memitem:a12438a58b047ffe81f8a5496421cc28c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12438a58b047ffe81f8a5496421cc28c"></a>
uint64_t </td><td class="memItemRight" valign="bottom"><b>lzma_raw_coder_memusage</b> (lzma_filter_find coder_find, const <a class="el" href="structlzma__filter.html">lzma_filter</a> *<a class="el" href="coder_8c.html#a9325236d5759d4eaadcba08a6bb5c96f">filters</a>)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a94b5fee053422f22b42acc30cb9aee0a"><td class="memItemLeft" ><a class="anchor" id="a94b5fee053422f22b42acc30cb9aee0a"></a>
struct {</td></tr>
<tr class="memitem:ab88c40e707fd77bdae129028260be81e"><td class="memItemLeft" >   <a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a>   <a class="el" href="filter__common_8c.html#a3ee597b96b2ff619e515fac79a1ba1c5">id</a></td></tr>
<tr class="memdesc:ab88c40e707fd77bdae129028260be81e"><td class="mdescLeft"> </td><td class="mdescRight">Filter ID. <a href="#ab88c40e707fd77bdae129028260be81e"></a><br/></td></tr>
<tr class="memitem:a87f1e2a1736d0fe4fdfe74a3fc266375"><td class="memItemLeft" >   size_t   <a class="el" href="filter__common_8c.html#ae3be9ce6129a435b24496c57bc8141a6">options_size</a></td></tr>
<tr class="memdesc:a87f1e2a1736d0fe4fdfe74a3fc266375"><td class="mdescLeft"> </td><td class="mdescRight">Size of the filter-specific options structure. <a href="#a87f1e2a1736d0fe4fdfe74a3fc266375"></a><br/></td></tr>
<tr class="memitem:aa6f45e094ad4754df046a45f6bc03edc"><td class="memItemLeft" >   bool   <a class="el" href="filter__common_8c.html#ad703ac63a7997112bb46bcb488bd83a5">non_last_ok</a></td></tr>
<tr class="memitem:a959b422cae3ed33e64690b75a5be97ca"><td class="memItemLeft" >   bool   <a class="el" href="filter__common_8c.html#abccb55bd90f3f71fbeca1ca96f77fa40">last_ok</a></td></tr>
<tr class="memitem:aff49007393da7c37b527bf7cdf960345"><td class="memItemLeft" >   bool   <a class="el" href="filter__common_8c.html#ab49ba4b830db7487db6793b6bae9dc16">changes_size</a></td></tr>
<tr class="memitem:a94b5fee053422f22b42acc30cb9aee0a"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><b>features</b> []</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Filter-specific stuff common for both encoder and decoder. </p>
</div><h2>Function Documentation</h2>
<a class="anchor" id="a81cd5593eb33e5e62a0fd5112e87d831"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> lzma_filters_copy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structlzma__filter.html">lzma_filter</a> * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structlzma__filter.html">lzma_filter</a> * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structlzma__allocator.html">lzma_allocator</a> * </td>
<td class="paramname"><em>allocator</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy the filters array. </p>
<p>Copy the Filter IDs and filter-specific options from src to dest. Up to LZMA_FILTERS_MAX filters are copied, plus the terminating .id == LZMA_VLI_UNKNOWN. Thus, dest should have at least LZMA_FILTERS_MAX + 1 elements space unless the caller knows that src is smaller than that.</p>
<p>Unless the filter-specific options is NULL, the Filter ID has to be supported by liblzma, because liblzma needs to know the size of every filter-specific options structure. The filter-specific options are not validated. If options is NULL, any unsupported Filter IDs are copied without returning an error.</p>
<p>Old filter-specific options in dest are not freed, so dest doesn't need to be initialized by the caller in any way.</p>
<p>If an error occurs, memory possibly already allocated by this function is always freed.</p>
<dl class="section return"><dt>Returns</dt><dd>- LZMA_OK<ul>
<li>LZMA_MEM_ERROR</li>
<li>LZMA_OPTIONS_ERROR: Unsupported Filter ID and its options is not NULL.</li>
<li>LZMA_PROG_ERROR: src or dest is NULL. </li>
</ul>
</dd></dl>
<p>References <a class="el" href="common_8h.html#ac58f96267a4f66bb15db736968b98008">lzma_alloc()</a>, <a class="el" href="filter_8h.html#ab33c0cc1728bf390e5b84f8bce1928ba">LZMA_FILTERS_MAX</a>, <a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6ea567e1464feca03900a5425fb45b2f5b6">LZMA_MEM_ERROR</a>, <a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6eac003781ccb81bbd5578e29abed8a8cfe">LZMA_OK</a>, <a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6eaa9ff6dfee36b7aba4fae60706d37425f">LZMA_OPTIONS_ERROR</a>, <a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6ea2dac8d451cb38da8550653d0d7be4ec2">LZMA_PROG_ERROR</a>, <a class="el" href="vli_8h.html#a5a4b28254a30c859018b896ed371d69a">LZMA_VLI_UNKNOWN</a>, and <a class="el" href="filter__common_8c.html#ae3be9ce6129a435b24496c57bc8141a6">options_size</a>.</p>
</div>
</div>
<h2>Variable Documentation</h2>
<a class="anchor" id="a3ee597b96b2ff619e515fac79a1ba1c5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Filter ID. </p>
<p>Referenced by <a class="el" href="coder_8h.html#a8884012fc28d467d3429070f270f7171">coder_add_filter()</a>.</p>
</div>
</div>
<a class="anchor" id="ae3be9ce6129a435b24496c57bc8141a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t options_size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the filter-specific options structure. </p>
<p>Referenced by <a class="el" href="filter__common_8c.html#a81cd5593eb33e5e62a0fd5112e87d831">lzma_filters_copy()</a>.</p>
</div>
</div>
<a class="anchor" id="ad703ac63a7997112bb46bcb488bd83a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool non_last_ok</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if it is OK to use this filter as non-last filter in the chain. </p>
</div>
</div>
<a class="anchor" id="abccb55bd90f3f71fbeca1ca96f77fa40"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool last_ok</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if it is OK to use this filter as the last filter in the chain. </p>
</div>
</div>
<a class="anchor" id="ab49ba4b830db7487db6793b6bae9dc16"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool changes_size</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if the filter may change the size of the data (that is, the amount of encoded output can be different than the amount of uncompressed input). </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 18 2012 19:30:21 for XZ Utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
|