Files
ortools-clone/docs/cpp/file__util_8cc_source.html

135 lines
42 KiB
HTML
Raw Normal View History

2020-09-01 16:00:33 +02:00
<!-- 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"/>
2021-09-20 15:57:27 +02:00
<meta name="generator" content="Doxygen 1.8.15"/>
2020-09-01 16:00:33 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: file_util.cc 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>
2021-09-20 15:57:27 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
2020-09-01 16:00:33 +02:00
<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
2021-09-20 15:57:27 +02:00
&#160;<span id="projectnumber">9.1</span>
2020-09-01 16:00:33 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2021-09-20 15:57:27 +02:00
<!-- Generated by Doxygen 1.8.15 -->
2020-09-01 16:00:33 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2021-09-20 15:57:27 +02:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2020-09-01 16:00:33 +02:00
/* @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 */
2021-09-20 15:57:27 +02:00
$(document).ready(function(){initNavTree('file__util_8cc_source.html','');});
2020-09-01 16:00:33 +02:00
/* @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">file_util.cc</div> </div>
</div><!--header-->
<div class="contents">
2021-09-20 15:57:27 +02:00
<a href="file__util_8cc.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">#include &quot;<a class="code" href="file__util_8h.html">ortools/util/file_util.h</a>&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;absl/status/statusor.h&quot;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;absl/strings/str_cat.h&quot;</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;google/protobuf/descriptor.h&quot;</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;google/protobuf/io/zero_copy_stream_impl_lite.h&quot;</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;google/protobuf/message.h&quot;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;google/protobuf/text_format.h&quot;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;google/protobuf/util/json_util.h&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="base_2file_8h.html">ortools/base/file.h</a>&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="gzipstring_8h.html">ortools/base/gzipstring.h</a>&quot;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<s
<div class="ttc" id="namespaceoperations__research_html_aaf9694f57960ede8c406e3bd923bcd72adb5cce9ced76fea1f9c1e9f3e5cb1d90"><div class="ttname"><a href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72adb5cce9ced76fea1f9c1e9f3e5cb1d90">operations_research::ProtoWriteFormat::kCanonicalJson</a></div></div>
<div class="ttc" id="base_2logging_8h_html_a9f96ed9f06763f0821fdbb4d29031d8d"><div class="ttname"><a href="base_2logging_8h.html#a9f96ed9f06763f0821fdbb4d29031d8d">CHECK_OK</a></div><div class="ttdeci">#define CHECK_OK(x)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00042">base/logging.h:42</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a319f5b5c935d6fb479624ae04d60d5ea"><div class="ttname"><a href="namespaceoperations__research.html#a319f5b5c935d6fb479624ae04d60d5ea">operations_research::ReadFileToString</a></div><div class="ttdeci">absl::StatusOr&lt; std::string &gt; ReadFileToString(absl::string_view filename)</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8cc_source.html#l00034">file_util.cc:34</a></div></div>
<div class="ttc" id="base_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#l00979">base/logging.h:979</a></div></div>
<div class="ttc" id="gzipstring_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 class="ttc" id="gzipstring_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="base_2logging_8h_html_accad43a85d781d53381cd53a9894b6ae"><div class="ttname"><a href="base_2logging_8h.html#accad43a85d781d53381cd53a9894b6ae">LOG</a></div><div class="ttdeci">#define LOG(severity)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00416">base/logging.h:416</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_aaf9694f57960ede8c406e3bd923bcd72adfcd8e748f506324dff6a9d5e7aea00b"><div class="ttname"><a href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72adfcd8e748f506324dff6a9d5e7aea00b">operations_research::ProtoWriteFormat::kProtoText</a></div></div>
<div class="ttc" id="cp__model__fz__solver_8cc_html_aed003f5eb5197bc586b7ef2c36a63da2"><div class="ttname"><a href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a></div><div class="ttdeci">CpModelProto proto</div><div class="ttdef"><b>Definition:</b> <a href="cp__model__fz__solver_8cc_source.html#l00115">cp_model_fz_solver.cc:115</a></div></div>
<div class="ttc" id="log__severity_8h_html_a50e5762f38854b37ee3e2851bc1bb0e7"><div class="ttname"><a href="log__severity_8h.html#a50e5762f38854b37ee3e2851bc1bb0e7">WARNING</a></div><div class="ttdeci">const int WARNING</div><div class="ttdef"><b>Definition:</b> <a href="log__severity_8h_source.html#l00031">log_severity.h:31</a></div></div>
<div class="ttc" id="namespacefile_html_a1abdf766bb120d38e7a4dfa200972681"><div class="ttname"><a href="namespacefile.html#a1abdf766bb120d38e7a4dfa200972681">file::Defaults</a></div><div class="ttdeci">int Defaults()</div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8h_source.html#l00119">base/file.h:119</a></div></div>
<div class="ttc" id="gzipstring_8h_html"><div class="ttname"><a href="gzipstring_8h.html">gzipstring.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a57741d0280e266642d7d146d0d0beedb"><div class="ttname"><a href="namespaceoperations__research.html#a57741d0280e266642d7d146d0d0beedb">operations_research::WriteProtoToFile</a></div><div class="ttdeci">bool WriteProtoToFile(absl::string_view filename, const google::protobuf::Message &amp;proto, ProtoWriteFormat proto_write_format, bool gzipped, bool append_extension_to_file_name)</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8cc_source.html#l00106">file_util.cc:106</a></div></div>
<div class="ttc" id="file__util_8h_html"><div class="ttname"><a href="file__util_8h.html">file_util.h</a></div></div>
<div class="ttc" id="namespacefile_html_ae612ac5fffd37d180718bfe45d8ee445"><div class="ttname"><a href="namespacefile.html#ae612ac5fffd37d180718bfe45d8ee445">file::SetContents</a></div><div class="ttdeci">absl::Status SetContents(const absl::string_view &amp;filename, const absl::string_view &amp;contents, int flags)</div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8cc_source.html#l00196">base/file.cc:196</a></div></div>
<div class="ttc" id="base_2logging_8h_html"><div class="ttname"><a href="base_2logging_8h.html">logging.h</a></div></div>
<div class="ttc" id="namespacefile_html_a0d5c85404c75c45579847f873589737f"><div class="ttname"><a href="namespacefile.html#a0d5c85404c75c45579847f873589737f">file::GetContents</a></div><div class="ttdeci">absl::Status GetContents(const absl::string_view &amp;filename, std::string *output, int flags)</div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8cc_source.html#l00163">base/file.cc:163</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_ac9d6b171922e3bb93b3795f4241c70e4"><div class="ttname"><a href="namespaceoperations__research.html#ac9d6b171922e3bb93b3795f4241c70e4">operations_research::ReadFileToProto</a></div><div class="ttdeci">bool ReadFileToProto(absl::string_view filename, google::protobuf::Message *proto)</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8cc_source.html#l00045">file_util.cc:45</a></div></div>
<div class="ttc" id="status__macros_8h_html"><div class="ttname"><a href="status__macros_8h.html">status_macros.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">Collection of objects used to extend the Constraint Solver library.</div><div class="ttdef"><b>Definition:</b> <a href="dense__doubly__linked__list_8h_source.html#l00021">dense_doubly_linked_list.h:21</a></div></div>
<div class="ttc" id="status__macros_8h_html_acdc223d8c59d5c591dc6b4e88257627b"><div class="ttname"><a href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a></div><div class="ttdeci">#define RETURN_IF_ERROR(expr)</div><div class="ttdef"><b>Definition:</b> <a href="status__macros_8h_source.html#l00029">status_macros.h:29</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_aaf9694f57960ede8c406e3bd923bcd72aa0af2ac06be96f6784af5295aab62c76"><div class="ttname"><a href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72aa0af2ac06be96f6784af5295aab62c76">operations_research::ProtoWriteFormat::kProtoBinary</a></div></div>
<div class="ttc" id="base_2file_8h_html"><div class="ttname"><a href="base_2file_8h.html">file.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_aaf9694f57960ede8c406e3bd923bcd72a319f3b99b8d96c21e2f6b7ebc6fe8d8f"><div class="ttname"><a href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72a319f3b99b8d96c21e2f6b7ebc6fe8d8f">operations_research::ProtoWriteFormat::kJson</a></div></div>
2021-01-26 11:28:50 +01:00
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
2020-09-01 16:00:33 +02:00
<!-- 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_a3328a0ea67a2aaa160c2783ffbaa5dc.html">util</a></li><li class="navelem"><a class="el" href="file__util_8cc.html">file_util.cc</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
2021-09-20 15:57:27 +02:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
2020-09-01 16:00:33 +02:00
</ul>
</div>
</body>
</html>