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

136 lines
36 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: filelineiter.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>
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('filelineiter_8h_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">filelineiter.h</div> </div>
</div><!--header-->
<div class="contents">
2021-09-20 15:57:27 +02:00
<a href="filelineiter_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="comment">// Allows to read a text file line by line with:</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// for (const std::string&amp; line : FileLines(&quot;myfile.txt&quot;)) { ... }</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// More details:</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">// * The lines are separated by &#39;\n&#39; (which is removed by default) and have no</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">// size limits.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">// * Consecutive &#39;\n&#39; result in empty lines being produced.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">// * If not empty, the string after the last &#39;\n&#39; is produced as the last line.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">// * Options are available to keep the trailing &#39;\n&#39; for each line, to remove</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">// carriage-return chararters (&#39;\r&#39;), and to remove blank lines.</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#ifndef OR_TOOLS_UTIL_FILELINEITER_H_</span></div>
<div class="ttc" id="class_file_line_iterator_html_a7cf75d0cda556348cd270816799f2e9e"><div class="ttname"><a href="class_file_line_iterator.html#a7cf75d0cda556348cd270816799f2e9e">FileLineIterator::FileLineIterator</a></div><div class="ttdeci">FileLineIterator(File *file, int options)</div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00043">filelineiter.h:43</a></div></div>
<div class="ttc" id="class_file_html"><div class="ttname"><a href="class_file.html">File</a></div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8h_source.html#l00032">base/file.h:32</a></div></div>
<div class="ttc" id="class_file_lines_html_a169ecee206a43ba1aecb11797be4f1ba"><div class="ttname"><a href="class_file_lines.html#a169ecee206a43ba1aecb11797be4f1ba">FileLines::FileLines</a></div><div class="ttdeci">FileLines(const std::string &amp;filename)</div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00121">filelineiter.h:121</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="class_file_line_iterator_html"><div class="ttname"><a href="class_file_line_iterator.html">FileLineIterator</a></div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00033">filelineiter.h:33</a></div></div>
<div class="ttc" id="class_file_line_iterator_html_a06fc87d81c62e9abb8790b6e5713c55baf3b6e7197eaaba2a5588efa32373783c"><div class="ttname"><a href="class_file_line_iterator.html#a06fc87d81c62e9abb8790b6e5713c55baf3b6e7197eaaba2a5588efa32373783c">FileLineIterator::REMOVE_LINEFEED</a></div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00037">filelineiter.h:37</a></div></div>
<div class="ttc" id="class_file_lines_html"><div class="ttname"><a href="class_file_lines.html">FileLines</a></div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00115">filelineiter.h: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="class_file_lines_html_a5b047d204fe57607ceb84c6076b4491c"><div class="ttname"><a href="class_file_lines.html#a5b047d204fe57607ceb84c6076b4491c">FileLines::FileLines</a></div><div class="ttdeci">FileLines(const std::string &amp;filename, int options)</div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00117">filelineiter.h:117</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="class_file_line_iterator_html_a06fc87d81c62e9abb8790b6e5713c55ba3de2f8e12c8772d6ff23595910a383bc"><div class="ttname"><a href="class_file_line_iterator.html#a06fc87d81c62e9abb8790b6e5713c55ba3de2f8e12c8772d6ff23595910a383bc">FileLineIterator::KEEP_LINEFEED</a></div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00038">filelineiter.h:38</a></div></div>
<div class="ttc" id="class_file_line_iterator_html_a06fc87d81c62e9abb8790b6e5713c55ba88ec7d5086d2469ba843c7fcceade8a6"><div class="ttname"><a href="class_file_line_iterator.html#a06fc87d81c62e9abb8790b6e5713c55ba88ec7d5086d2469ba843c7fcceade8a6">FileLineIterator::DEFAULT</a></div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00036">filelineiter.h:36</a></div></div>
<div class="ttc" id="class_file_line_iterator_html_a27e1ef3c35c6578807378ae853b45251"><div class="ttname"><a href="class_file_line_iterator.html#a27e1ef3c35c6578807378ae853b45251">FileLineIterator::operator!=</a></div><div class="ttdeci">bool operator!=(const FileLineIterator &amp;other) const</div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00051">filelineiter.h:51</a></div></div>
<div class="ttc" id="class_file_html_a7c528f4c5a9323874493ac186236ac14"><div class="ttname"><a href="class_file.html#a7c528f4c5a9323874493ac186236ac14">File::Read</a></div><div class="ttdeci">size_t Read(void *const buff, size_t size)</div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8cc_source.html#l00070">base/file.cc:70</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="class_file_line_iterator_html_a06fc87d81c62e9abb8790b6e5713c55bab221b5a5b30e0c727ce21768362b5a78"><div class="ttname"><a href="class_file_line_iterator.html#a06fc87d81c62e9abb8790b6e5713c55bab221b5a5b30e0c727ce21768362b5a78">FileLineIterator::REMOVE_INLINE_CR</a></div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00039">filelineiter.h:39</a></div></div>
<div class="ttc" id="class_file_lines_html_a0d44a2050550a578e26adcd44fdf9369"><div class="ttname"><a href="class_file_lines.html#a0d44a2050550a578e26adcd44fdf9369">FileLines::end</a></div><div class="ttdeci">FileLineIterator end() const</div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00130">filelineiter.h:130</a></div></div>
<div class="ttc" id="namespacefile_html_acba1e524f6f44768144843be45405223"><div class="ttname"><a href="namespacefile.html#acba1e524f6f44768144843be45405223">file::Open</a></div><div class="ttdeci">absl::Status Open(const absl::string_view &amp;filename, const absl::string_view &amp;mode, File **f, int flags)</div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8cc_source.html#l00142">base/file.cc:142</a></div></div>
<div class="ttc" id="class_file_line_iterator_html_a00f008b80917746917b874d00abd02a9"><div class="ttname"><a href="class_file_line_iterator.html#a00f008b80917746917b874d00abd02a9">FileLineIterator::operator++</a></div><div class="ttdeci">void operator++()</div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00054">filelineiter.h:54</a></div></div>
<div class="ttc" id="class_file_line_iterator_html_a1f124f8465b6290aa77c5574c908dfde"><div class="ttname"><a href="class_file_line_iterator.html#a1f124f8465b6290aa77c5574c908dfde">FileLineIterator::operator *</a></div><div class="ttdeci">const std::string &amp; operator *() const</div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00050">filelineiter.h:50</a></div></div>
<div class="ttc" id="namespacefile_html"><div class="ttname"><a href="namespacefile.html">file</a></div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8cc_source.html#l00141">base/file.cc:141</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="class_file_line_iterator_html_a06fc87d81c62e9abb8790b6e5713c55badc66361387806a19114d00f5062a9316"><div class="ttname"><a href="class_file_line_iterator.html#a06fc87d81c62e9abb8790b6e5713c55badc66361387806a19114d00f5062a9316">FileLineIterator::REMOVE_BLANK_LINES</a></div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00040">filelineiter.h:40</a></div></div>
<div class="ttc" id="class_file_html_aef7e3d18ef267f23f64ad397fa359cc1"><div class="ttname"><a href="class_file.html#aef7e3d18ef267f23f64ad397fa359cc1">File::Close</a></div><div class="ttdeci">bool Close()</div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8cc_source.html#l00048">base/file.cc:48</a></div></div>
<div class="ttc" id="class_file_lines_html_adbbd9a303282c283474b7a2ee5561eea"><div class="ttname"><a href="class_file_lines.html#adbbd9a303282c283474b7a2ee5561eea">FileLines::~FileLines</a></div><div class="ttdeci">~FileLines()</div><div class="ttdef"><b>Definition:</b> <a href="filelineiter_8h_source.html#l00124">filelineiter.h:124</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_8f9dc966244f4c6e9b2fa0dee1e4ef1a.html">base</a></li><li class="navelem"><a class="el" href="filelineiter_8h.html">filelineiter.h</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>