Files
ortools-clone/docs/cpp/gzipstring_8h_source.html
2021-04-27 23:00:03 +02:00

214 lines
20 KiB
HTML

<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: gzipstring.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="styleSheet.tmp.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="projectlogo"><img alt="Logo" src="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
&#160;<span id="projectnumber">9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('gzipstring_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">gzipstring.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="gzipstring_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2010-2021 Google LLC</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#ifndef OR_TOOLS_BASE_GZIPSTRING_H_</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define OR_TOOLS_BASE_GZIPSTRING_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="base_2logging_8h.html">ortools/base/logging.h</a>&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;zlib.h&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="gzipstring_8h.html#a3834e8b931bd4ecc1a566f2fdf3cb899"> 22</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="gzipstring_8h.html#a3834e8b931bd4ecc1a566f2fdf3cb899">GunzipString</a>(<span class="keyword">const</span> std::string&amp; str, std::string* out) {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; z_stream zs;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; zs.zalloc = Z_NULL;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; zs.zfree = Z_NULL;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; zs.opaque = Z_NULL;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; zs.next_in = Z_NULL;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; zs.avail_in = 0;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; zs.next_out = Z_NULL;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">if</span> (inflateInit2(&amp;zs, <span class="comment">/*window_bits=*/</span>15 + 32) != Z_OK) {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; }</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; zs.next_in = (Bytef*)str.data();</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; zs.avail_in = str.size();</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">int</span> status;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">char</span> buffer[32768];</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// Decompress string by block.</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">do</span> {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; zs.next_out = <span class="keyword">reinterpret_cast&lt;</span>Bytef*<span class="keyword">&gt;</span>(buffer);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; zs.avail_out = <span class="keyword">sizeof</span>(buffer);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; status = inflate(&amp;zs, 0);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">if</span> (out-&gt;size() &lt; zs.total_out) {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; out-&gt;append(buffer, zs.total_out - out-&gt;size());</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; } <span class="keywordflow">while</span> (status == Z_OK);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; inflateEnd(&amp;zs);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">if</span> (status != Z_STREAM_END) { <span class="comment">// an error occurred that was not EOF</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="base_2logging_8h.html#afcaa7cadd41741bb855c2ada1d2ef927">VLOG</a>(1) &lt;&lt; <span class="stringliteral">&quot;Exception during zlib decompression: (&quot;</span> &lt;&lt; status &lt;&lt; <span class="stringliteral">&quot;) &quot;</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; &lt;&lt; zs.msg;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; }</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="gzipstring_8h.html#a261a22a33098cddfef82560d4a9e47a6"> 63</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="gzipstring_8h.html#a261a22a33098cddfef82560d4a9e47a6">GzipString</a>(absl::string_view uncompressed, std::string* <a class="code" href="constraint__solver_8cc.html#ad3abed281c933b061bc42a26033aa7b6">compressed</a>) {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; z_stream zs;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; zs.zalloc = Z_NULL;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; zs.zfree = Z_NULL;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; zs.opaque = Z_NULL;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; zs.next_in = Z_NULL;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; zs.avail_in = 0;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; zs.next_out = Z_NULL;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordflow">if</span> (deflateInit(&amp;zs, Z_BEST_COMPRESSION) != Z_OK) {</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="base_2logging_8h.html#afcaa7cadd41741bb855c2ada1d2ef927">VLOG</a>(1) &lt;&lt; <span class="stringliteral">&quot;Cannot initialize zlib compression.&quot;</span>;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; }</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; zs.next_in = (Bytef*)uncompressed.data();</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; zs.avail_in = uncompressed.size(); <span class="comment">// set the z_stream&#39;s input</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordtype">int</span> status;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">char</span> buffer[32768];</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="comment">// compress block by block.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordflow">do</span> {</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; zs.next_out = <span class="keyword">reinterpret_cast&lt;</span>Bytef*<span class="keyword">&gt;</span>(buffer);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; zs.avail_out = <span class="keyword">sizeof</span>(buffer);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; status = deflate(&amp;zs, Z_FINISH);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="constraint__solver_8cc.html#ad3abed281c933b061bc42a26033aa7b6">compressed</a>-&gt;size() &lt; zs.total_out) {</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <a class="code" href="constraint__solver_8cc.html#ad3abed281c933b061bc42a26033aa7b6">compressed</a>-&gt;append(buffer, zs.total_out - <a class="code" href="constraint__solver_8cc.html#ad3abed281c933b061bc42a26033aa7b6">compressed</a>-&gt;size());</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; }</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; } <span class="keywordflow">while</span> (status == Z_OK);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; deflateEnd(&amp;zs);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">if</span> (status != Z_STREAM_END) { <span class="comment">// an error occurred that was not EOF</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <a class="code" href="base_2logging_8h.html#afcaa7cadd41741bb855c2ada1d2ef927">VLOG</a>(1) &lt;&lt; <span class="stringliteral">&quot;Exception during zlib compression: (&quot;</span> &lt;&lt; status &lt;&lt; <span class="stringliteral">&quot;) &quot;</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; &lt;&lt; zs.msg;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; }</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;}</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_BASE_GZIPSTRING_H_</span></div>
<div class="ttc" id="abase_2logging_8h_html"><div class="ttname"><a href="base_2logging_8h.html">logging.h</a></div></div>
<div class="ttc" id="abase_2logging_8h_html_afcaa7cadd41741bb855c2ada1d2ef927"><div class="ttname"><a href="base_2logging_8h.html#afcaa7cadd41741bb855c2ada1d2ef927">VLOG</a></div><div class="ttdeci">#define VLOG(verboselevel)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00986">base/logging.h:986</a></div></div>
<div class="ttc" id="aconstraint__solver_8cc_html_ad3abed281c933b061bc42a26033aa7b6"><div class="ttname"><a href="constraint__solver_8cc.html#ad3abed281c933b061bc42a26033aa7b6">compressed</a></div><div class="ttdeci">std::string compressed</div><div class="ttdef"><b>Definition:</b> <a href="constraint__solver_8cc_source.html#l00676">constraint_solver.cc:676</a></div></div>
<div class="ttc" id="agzipstring_8h_html_a261a22a33098cddfef82560d4a9e47a6"><div class="ttname"><a href="gzipstring_8h.html#a261a22a33098cddfef82560d4a9e47a6">GzipString</a></div><div class="ttdeci">void GzipString(absl::string_view uncompressed, std::string *compressed)</div><div class="ttdef"><b>Definition:</b> <a href="gzipstring_8h_source.html#l00063">gzipstring.h:63</a></div></div>
<div class="ttc" id="agzipstring_8h_html_a3834e8b931bd4ecc1a566f2fdf3cb899"><div class="ttname"><a href="gzipstring_8h.html#a3834e8b931bd4ecc1a566f2fdf3cb899">GunzipString</a></div><div class="ttdeci">bool GunzipString(const std::string &amp;str, std::string *out)</div><div class="ttdef"><b>Definition:</b> <a href="gzipstring_8h_source.html#l00022">gzipstring.h:22</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_8f9dc966244f4c6e9b2fa0dee1e4ef1a.html">base</a></li><li class="navelem"><a class="el" href="gzipstring_8h.html">gzipstring.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>