<!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"/> <meta name="generator" content="Doxygen 1.8.11"/> <title>FGx: src/utilities/zlib/inflate.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { init_search(); }); </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 id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">FGx  <span id="projectnumber">1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <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>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </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>File Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_7b5d38f1875f1b693f62ca6a108a1129.html">utilities</a></li><li class="navelem"><a class="el" href="dir_fe6a68eee28cd4c65df4049e5df14c5b.html">zlib</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">inflate.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* inflate.h -- internal inflate state definition</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 1995-2009 Mark Adler</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * For conditions of distribution and use, see copyright notice in zlib.h</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/* WARNING: this file should *not* be used by applications. It is</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> part of the implementation of the compression library and is</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> subject to change. Applications should only use zlib.h.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> */</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/* define NO_GZIP when compiling if you want to disable gzip header and</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> trailer decoding by inflate(). NO_GZIP would be used to avoid linking in</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> the crc code when it is not needed. For shared libraries, gzip decoding</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> should be left enabled. */</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef NO_GZIP</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"># define GUNZIP</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/* Possible inflate modes between inflate() calls */</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  HEAD, <span class="comment">/* i: waiting for magic header */</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  FLAGS, <span class="comment">/* i: waiting for method and flags (gzip) */</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  TIME, <span class="comment">/* i: waiting for modification time (gzip) */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  OS, <span class="comment">/* i: waiting for extra flags and operating system (gzip) */</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  EXLEN, <span class="comment">/* i: waiting for extra length (gzip) */</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  EXTRA, <span class="comment">/* i: waiting for extra bytes (gzip) */</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  NAME, <span class="comment">/* i: waiting for end of file name (gzip) */</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  COMMENT, <span class="comment">/* i: waiting for end of comment (gzip) */</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  HCRC, <span class="comment">/* i: waiting for header crc (gzip) */</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  DICTID, <span class="comment">/* i: waiting for dictionary check value */</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  DICT, <span class="comment">/* waiting for inflateSetDictionary() call */</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  TYPE, <span class="comment">/* i: waiting for type bits, including last-flag bit */</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  TYPEDO, <span class="comment">/* i: same, but skip check to exit inflate on new block */</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  STORED, <span class="comment">/* i: waiting for stored size (length and complement) */</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  COPY_, <span class="comment">/* i/o: same as COPY below, but only first time in */</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  COPY, <span class="comment">/* i/o: waiting for input or output to copy stored block */</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  TABLE, <span class="comment">/* i: waiting for dynamic block table lengths */</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  LENLENS, <span class="comment">/* i: waiting for code length code lengths */</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  CODELENS, <span class="comment">/* i: waiting for length/lit and distance code lengths */</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  LEN_, <span class="comment">/* i: same as LEN below, but only first time in */</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  LEN, <span class="comment">/* i: waiting for length/lit/eob code */</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  LENEXT, <span class="comment">/* i: waiting for length extra bits */</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  DIST, <span class="comment">/* i: waiting for distance code */</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  DISTEXT, <span class="comment">/* i: waiting for distance extra bits */</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  MATCH, <span class="comment">/* o: waiting for output space to copy string */</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  LIT, <span class="comment">/* o: waiting for output space to write literal */</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  CHECK, <span class="comment">/* i: waiting for 32-bit check value */</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  LENGTH, <span class="comment">/* i: waiting for 32-bit length (gzip) */</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  DONE, <span class="comment">/* finished check, done -- remain here until reset */</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  BAD, <span class="comment">/* got a data error -- remain here until reset */</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  MEM, <span class="comment">/* got an inflate() memory error -- remain here until reset */</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  SYNC <span class="comment">/* looking for synchronization bytes to restart inflate() */</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> } inflate_mode;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/*</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> State transitions between above modes -</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> (most modes can go to BAD or MEM on error -- not shown for clarity)</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> Process header:</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> HEAD -> (gzip) or (zlib) or (raw)</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> (gzip) -> FLAGS -> TIME -> OS -> EXLEN -> EXTRA -> NAME -> COMMENT -></span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> HCRC -> TYPE</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> (zlib) -> DICTID or TYPE</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> DICTID -> DICT -> TYPE</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> (raw) -> TYPEDO</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> Read deflate blocks:</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> TYPE -> TYPEDO -> STORED or TABLE or LEN_ or CHECK</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> STORED -> COPY_ -> COPY -> TYPE</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> TABLE -> LENLENS -> CODELENS -> LEN_</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> LEN_ -> LEN</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> Read deflate codes in fixed or dynamic block:</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> LEN -> LENEXT or LIT or TYPE</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> LENEXT -> DIST -> DISTEXT -> MATCH -> LEN</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> LIT -> LEN</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> Process trailer:</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> CHECK -> LENGTH -> DONE</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> */</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/* state maintained between inflate() calls. Approximately 10K bytes. */</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="structinflate__state.html"> 81</a></span> <span class="keyword">struct </span><a class="code" href="structinflate__state.html">inflate_state</a> {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  inflate_mode mode; <span class="comment">/* current inflate mode */</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">int</span> last; <span class="comment">/* true if processing last block */</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">int</span> wrap; <span class="comment">/* bit 0 true for zlib, bit 1 true for gzip */</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">int</span> havedict; <span class="comment">/* true if dictionary provided */</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">int</span> flags; <span class="comment">/* gzip header method and flags (0 if zlib) */</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">unsigned</span> dmax; <span class="comment">/* zlib header max distance (INFLATE_STRICT) */</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> check; <span class="comment">/* protected copy of check value */</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> total; <span class="comment">/* protected copy of output count */</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="structgz__header__s.html">gz_headerp</a> head; <span class="comment">/* where to save gzip header information */</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">/* sliding window */</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">unsigned</span> wbits; <span class="comment">/* log base 2 of requested window size */</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">unsigned</span> wsize; <span class="comment">/* window size or zero if not using window */</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">unsigned</span> whave; <span class="comment">/* valid bytes in the window */</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">unsigned</span> wnext; <span class="comment">/* window write index */</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> FAR *window; <span class="comment">/* allocated sliding window, if needed */</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment">/* bit accumulator */</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> hold; <span class="comment">/* input bit accumulator */</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">unsigned</span> bits; <span class="comment">/* number of bits in "in" */</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">/* for string and stored block copying */</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">unsigned</span> length; <span class="comment">/* literal or length of data to copy */</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">unsigned</span> offset; <span class="comment">/* distance back to copy string from */</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">/* for table and code decoding */</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">unsigned</span> extra; <span class="comment">/* extra bits needed */</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">/* fixed and dynamic code tables */</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="structcode.html">code</a> <span class="keyword">const</span> FAR *lencode; <span class="comment">/* starting table for length/literal codes */</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="structcode.html">code</a> <span class="keyword">const</span> FAR *distcode; <span class="comment">/* starting table for distance codes */</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">unsigned</span> lenbits; <span class="comment">/* index bits for lencode */</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">unsigned</span> distbits; <span class="comment">/* index bits for distcode */</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">/* dynamic table building */</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">unsigned</span> ncode; <span class="comment">/* number of code length code lengths */</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">unsigned</span> nlen; <span class="comment">/* number of length code lengths */</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">unsigned</span> ndist; <span class="comment">/* number of distance code lengths */</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">unsigned</span> have; <span class="comment">/* number of code lengths in lens[] */</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <a class="code" href="structcode.html">code</a> FAR *next; <span class="comment">/* next available space in codes[] */</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> lens[320]; <span class="comment">/* temporary storage for code lengths */</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> work[288]; <span class="comment">/* work area for code table building */</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="structcode.html">code</a> codes[ENOUGH]; <span class="comment">/* space for code tables */</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">int</span> sane; <span class="comment">/* if false, allow invalid distance too far */</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">int</span> back; <span class="comment">/* bits back of last unprocessed length/lit */</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">unsigned</span> was; <span class="comment">/* initial length of match */</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> };</div><div class="ttc" id="structinflate__state_html"><div class="ttname"><a href="structinflate__state.html">inflate_state</a></div><div class="ttdef"><b>Definition:</b> inflate.h:81</div></div> <div class="ttc" id="structgz__header__s_html"><div class="ttname"><a href="structgz__header__s.html">gz_header_s</a></div><div class="ttdef"><b>Definition:</b> fgx_zlib.h:121</div></div> <div class="ttc" id="structcode_html"><div class="ttname"><a href="structcode.html">code</a></div><div class="ttdef"><b>Definition:</b> inftrees.h:24</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Feb 4 2016 13:59:23 for FGx by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.11 </small></address> </body> </html>