<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CTextFileLinesParser.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<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="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</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>
<div class="header">
<div class="headertitle">
<div class="title">CTextFileLinesParser.h</div> </div>
</div>
<div class="contents">
<a href="_c_text_file_lines_parser_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span>
<a name="l00002"></a>00002 <span class="comment"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span>
<a name="l00003"></a>00003 <span class="comment"> | |</span>
<a name="l00004"></a>00004 <span class="comment"> | http://www.mrpt.org/ |</span>
<a name="l00005"></a>00005 <span class="comment"> | |</span>
<a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span>
<a name="l00007"></a>00007 <span class="comment"> | |</span>
<a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span>
<a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span>
<a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span>
<a name="l00011"></a>00011 <span class="comment"> | |</span>
<a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span>
<a name="l00013"></a>00013 <span class="comment"> | |</span>
<a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span>
<a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span>
<a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span>
<a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span>
<a name="l00018"></a>00018 <span class="comment"> | |</span>
<a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span>
<a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span>
<a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span>
<a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span>
<a name="l00023"></a>00023 <span class="comment"> | |</span>
<a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span>
<a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef CTextFileLinesParser_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CTextFileLinesParser_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="utils__defs_8h.html">mrpt/utils/utils_defs.h</a>></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="string__utils_8h.html">mrpt/system/string_utils.h</a>></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">namespace </span>mrpt
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 <span class="keyword">namespace </span>utils
<a name="l00037"></a>00037 {<span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment"> /** A class for parsing text files, returning each non-empty and non-comment line, along its line number.</span>
<a name="l00039"></a>00039 <span class="comment"> * Lines are strip out of leading and trailing whitespaces.</span>
<a name="l00040"></a>00040 <span class="comment"> * By default, lines starting with either "#", "//" or "%" are skipped (comment lines),</span>
<a name="l00041"></a>00041 <span class="comment"> * unless this behavior is explicitly disabled with \a enableCommentFilters</span>
<a name="l00042"></a>00042 <span class="comment"> * \ingroup mrpt_base_grp</span>
<a name="l00043"></a>00043 <span class="comment"> */</span>
<a name="l00044"></a>00044 <span class="keyword">class </span><a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> CTextFileLinesParser
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> /** Default constructor; should call \a open() at some moment later. */</span>
<a name="l00048"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a66bee4dd8ff4362dc423e31e6fec7152">00048</a> <a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a66bee4dd8ff4362dc423e31e6fec7152" title="Default constructor; should call open() at some moment later.">CTextFileLinesParser</a>() : m_curLineNum(0), m_filter_MATLAB_comments(true), m_filter_C_comments(true), m_filter_SH_comments(true) { }
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment"> /** Constructor for opening a file \exception std::exception On error opening file */</span>
<a name="l00051"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#ad67704464471fbf06f8d1a0d5d7c9215">00051</a> <a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#ad67704464471fbf06f8d1a0d5d7c9215" title="Constructor for opening a file On error opening file.">CTextFileLinesParser</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fil) : m_filter_MATLAB_comments(true), m_filter_C_comments(true), m_filter_SH_comments(true) {
<a name="l00052"></a>00052 open(fil);
<a name="l00053"></a>00053 }
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment"> /** Open a file (an alternative to the constructor with a file name) */</span>
<a name="l00056"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a7a8b5b0624c2e100e1724abfe03aa1be">00056</a> <span class="keywordtype">void</span> open(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fil)
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 m_curLineNum = 0;
<a name="l00059"></a>00059 m_fileName = fil;
<a name="l00060"></a>00060 m_in.close();
<a name="l00061"></a>00061 m_in.clear();
<a name="l00062"></a>00062 m_in.open(fil.c_str());
<a name="l00063"></a>00063 <span class="keywordflow">if</span> (!m_in.is_open())
<a name="l00064"></a>00064 <a class="code" href="mrpt__macros_8h.html#a61a8d46146210ee20fa1ff423257a5ec">THROW_EXCEPTION_CUSTOM_MSG1</a>(<span class="stringliteral">"Error opening file '%s' for reading"</span>,fil.c_str());
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /** Close the file (no need to call it normally, the file is closed upon destruction) */</span>
<a name="l00068"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a00ec99e286d6f1f6a605db86a99adb21">00068</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a00ec99e286d6f1f6a605db86a99adb21" title="Close the file (no need to call it normally, the file is closed upon destruction)">close</a>() { m_in.close(); }
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> /** Reset the read pointer to the beginning of the file */</span>
<a name="l00071"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#aa8d6ea6a30acda060f8733bd05023b91">00071</a> <span class="keywordtype">void</span> rewind()
<a name="l00072"></a>00072 {
<a name="l00073"></a>00073 m_curLineNum = 0;
<a name="l00074"></a>00074 m_in.clear();
<a name="l00075"></a>00075 m_in.seekg(0);
<a name="l00076"></a>00076 }
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment"> /** Reads from the file and return the next (non-comment) line, as a std::string</span>
<a name="l00079"></a>00079 <span class="comment"> * \return false on EOF.</span>
<a name="l00080"></a>00080 <span class="comment"> */</span>
<a name="l00081"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#ac92ed19f521269dbfbdf5c6d2e698813">00081</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> getNextLine(<a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &out_str)
<a name="l00082"></a>00082 {
<a name="l00083"></a>00083 std<a class="code" href="classstd_1_1istringstream.html" title="STL class.">::istringstream</a> buf;
<a name="l00084"></a>00084 <span class="keywordflow">if</span> (getNextLine(buf))
<a name="l00085"></a>00085 {
<a name="l00086"></a>00086 out_str = buf.str();
<a name="l00087"></a>00087 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089 <span class="keywordflow">else</span>
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 out_str.clear();
<a name="l00092"></a>00092 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095 <span class="comment"></span>
<a name="l00096"></a>00096 <span class="comment"> /** Reads from the file and stores the next (non-comment) line into the given stream buffer.</span>
<a name="l00097"></a>00097 <span class="comment"> * \return false on EOF.</span>
<a name="l00098"></a>00098 <span class="comment"> */</span>
<a name="l00099"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#adf81d6c40eaaee157610ea531ffea418">00099</a> <span class="keywordtype">bool</span> getNextLine( <a class="code" href="classstd_1_1istringstream.html" title="STL class.">std::istringstream</a> &buf )
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 <span class="keywordflow">while</span> (!m_in.fail())
<a name="l00102"></a>00102 {
<a name="l00103"></a>00103 std<a class="code" href="classstd_1_1string.html" title="STL class.">::string</a> lin;
<a name="l00104"></a>00104 std::getline(m_in,lin);
<a name="l00105"></a>00105 m_curLineNum++;
<a name="l00106"></a>00106 lin = <a class="code" href="group__string__manage.html#ga1845ac57f8d98ab26fec93d2792cc445" title="Removes leading and trailing spaces.">mrpt::system::trim</a>(lin);
<a name="l00107"></a>00107 <span class="keywordflow">if</span> (lin.empty()) <span class="keywordflow">continue</span>; <span class="comment">// Ignore empty lines.</span>
<a name="l00108"></a>00108 <span class="comment">// Ignore comments lines, starting with "#" or "//".</span>
<a name="l00109"></a>00109 <span class="keywordflow">if</span> ( (m_filter_SH_comments && <a class="code" href="group__string__manage.html#ga8cf638f3a56c1df7844a1e7a210bcc61" title="Return true if "str" starts with "subStr" (case sensitive)">mrpt::system::strStarts</a>(lin,<span class="stringliteral">"#"</span>))
<a name="l00110"></a>00110 || (m_filter_C_comments && <a class="code" href="group__string__manage.html#ga8cf638f3a56c1df7844a1e7a210bcc61" title="Return true if "str" starts with "subStr" (case sensitive)">mrpt::system::strStarts</a>(lin,<span class="stringliteral">"//"</span>))
<a name="l00111"></a>00111 || (m_filter_MATLAB_comments && <a class="code" href="group__string__manage.html#ga8cf638f3a56c1df7844a1e7a210bcc61" title="Return true if "str" starts with "subStr" (case sensitive)">mrpt::system::strStarts</a>(lin,<span class="stringliteral">"%"</span>)) )
<a name="l00112"></a>00112 <span class="keywordflow">continue</span>;
<a name="l00113"></a>00113 <span class="comment">// Parse the line as a string stream:</span>
<a name="l00114"></a>00114 buf.str(lin);
<a name="l00115"></a>00115 buf.clear();
<a name="l00116"></a>00116 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00117"></a>00117 };
<a name="l00118"></a>00118 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120 <span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment"> /** Return the line number of the last line returned with \a getNextLine */</span>
<a name="l00122"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a8297fb868c0ca7948c94b46e6ef7432f">00122</a> <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a8297fb868c0ca7948c94b46e6ef7432f" title="Return the line number of the last line returned with getNextLine.">getCurrentLineNumber</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_curLineNum; }
<a name="l00123"></a>00123 <span class="comment"></span>
<a name="l00124"></a>00124 <span class="comment"> /** Enable/disable filtering of lines starting with "%", "//" or "#", respectively. */</span>
<a name="l00125"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#ac60f37b9a1e85567f984f656cf26f6f9">00125</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> enableCommentFilters(
<a name="l00126"></a>00126 <span class="keywordtype">bool</span> filter_MATLAB_comments,
<a name="l00127"></a>00127 <span class="keywordtype">bool</span> filter_C_comments,
<a name="l00128"></a>00128 <span class="keywordtype">bool</span> filter_SH_comments
<a name="l00129"></a>00129 )
<a name="l00130"></a>00130 {
<a name="l00131"></a>00131 m_filter_MATLAB_comments = filter_MATLAB_comments;
<a name="l00132"></a>00132 m_filter_C_comments = filter_C_comments;
<a name="l00133"></a>00133 m_filter_SH_comments = filter_SH_comments;
<a name="l00134"></a>00134 }
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="keyword">private</span>:
<a name="l00137"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a393bcb3d6b71c07591c7149b70ada69c">00137</a> std<a class="code" href="classstd_1_1string.html" title="STL class.">::string</a> <a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a393bcb3d6b71c07591c7149b70ada69c">m_fileName</a>;
<a name="l00138"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#af2c03a8c28695e898a14305d107d901d">00138</a> std<a class="code" href="classstd_1_1ifstream.html" title="STL class.">::ifstream</a> <a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#af2c03a8c28695e898a14305d107d901d">m_in</a>;
<a name="l00139"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a88b69374b5a9fa4f0c298fec6cb526d5">00139</a> <span class="keywordtype">size_t</span> <a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a88b69374b5a9fa4f0c298fec6cb526d5">m_curLineNum</a>;
<a name="l00140"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a9e42c8833339c4e93aefb77446d0b7ba">00140</a> <span class="keywordtype">bool</span> <a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a9e42c8833339c4e93aefb77446d0b7ba">m_filter_MATLAB_comments</a>;
<a name="l00141"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#aa2c3bacc3b5365ebf941b3288e3546df">00141</a> <span class="keywordtype">bool</span> <a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#aa2c3bacc3b5365ebf941b3288e3546df">m_filter_C_comments</a>;
<a name="l00142"></a><a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a39956ca96b3cf366f36eeed5dd066765">00142</a> <span class="keywordtype">bool</span> <a class="code" href="classmrpt_1_1utils_1_1_c_text_file_lines_parser.html#a39956ca96b3cf366f36eeed5dd066765">m_filter_SH_comments</a>;
<a name="l00143"></a>00143
<a name="l00144"></a>00144 }; <span class="comment">// end of CTextFileLinesParser</span>
<a name="l00145"></a>00145 } <span class="comment">// End of namespace</span>
<a name="l00146"></a>00146 } <span class="comment">// end of namespace</span>
<a name="l00147"></a>00147 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
