<!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>CDirectoryExplorer.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">CDirectoryExplorer.h</div> </div>
</div>
<div class="contents">
<a href="_c_directory_explorer_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 CDirectoryExplorer_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CDirectoryExplorer_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="os_8h.html">mrpt/system/os.h</a>></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="comment">/*---------------------------------------------------------------</span>
<a name="l00035"></a>00035 <span class="comment"> Class</span>
<a name="l00036"></a>00036 <span class="comment"> ---------------------------------------------------------------*/</span>
<a name="l00037"></a>00037 <span class="keyword">namespace </span>mrpt
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 <span class="keyword">namespace </span>system
<a name="l00040"></a>00040 {
<a name="l00041"></a><a class="code" href="_c_directory_explorer_8h.html#a5ea79e72589d4a8b1d86b3fc89c32652">00041</a> <span class="preprocessor"> #define FILE_ATTRIB_ARCHIVE 0x0020</span>
<a name="l00042"></a><a class="code" href="_c_directory_explorer_8h.html#ae220deae1d6b0adb2a8d91a88f3d8f07">00042</a> <span class="preprocessor"></span><span class="preprocessor"> #define FILE_ATTRIB_DIRECTORY 0x0010</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment"> /** This class allows the enumeration of the files/directories that exist into a given path.</span>
<a name="l00045"></a>00045 <span class="comment"> * The only existing method is "explore" and returns the list of found files & directories.</span>
<a name="l00046"></a>00046 <span class="comment"> * Refer to the example in /samples/UTILS/directoryExplorer</span>
<a name="l00047"></a>00047 <span class="comment"> *</span>
<a name="l00048"></a>00048 <span class="comment"> * \sa CFileSystemWatcher</span>
<a name="l00049"></a>00049 <span class="comment"> * \ingroup mrpt_base_grp</span>
<a name="l00050"></a>00050 <span class="comment"> */</span>
<a name="l00051"></a>00051 <span class="keyword">class </span><a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> CDirectoryExplorer
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> /** This represents the information about each file.</span>
<a name="l00055"></a>00055 <span class="comment"> * \sa</span>
<a name="l00056"></a>00056 <span class="comment"> */</span>
<a name="l00057"></a>00057 <span class="keyword">struct </span><a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> TFileInfo
<a name="l00058"></a>00058 {<span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /** The file name (without the whole path).</span>
<a name="l00060"></a>00060 <span class="comment"> */</span>
<a name="l00061"></a><a class="code" href="structmrpt_1_1system_1_1_c_directory_explorer_1_1_t_file_info.html#a1278a75498338e0ac0a45806bd340c24">00061</a> std::string <a class="code" href="structmrpt_1_1system_1_1_c_directory_explorer_1_1_t_file_info.html#a1278a75498338e0ac0a45806bd340c24" title="The file name (without the whole path).">name</a>;
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> /** The whole file path.</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a><a class="code" href="structmrpt_1_1system_1_1_c_directory_explorer_1_1_t_file_info.html#a054a0a451325c6624a9451e798a87b0a">00065</a> std::string <a class="code" href="structmrpt_1_1system_1_1_c_directory_explorer_1_1_t_file_info.html#a054a0a451325c6624a9451e798a87b0a" title="The whole file path.">wholePath</a>;
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /** Access and modification times.</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a><a class="code" href="structmrpt_1_1system_1_1_c_directory_explorer_1_1_t_file_info.html#adef049bd13380e70c2e5eca4cad6c714">00069</a> time_t accessTime,<a class="code" href="structmrpt_1_1system_1_1_c_directory_explorer_1_1_t_file_info.html#adef049bd13380e70c2e5eca4cad6c714">modTime</a>;
<a name="l00070"></a>00070
<a name="l00071"></a><a class="code" href="structmrpt_1_1system_1_1_c_directory_explorer_1_1_t_file_info.html#a958fd1fad5d2996b799f3c2ec3a59811">00071</a> <span class="keywordtype">bool</span> isDir, <a class="code" href="structmrpt_1_1system_1_1_c_directory_explorer_1_1_t_file_info.html#a958fd1fad5d2996b799f3c2ec3a59811">isSymLink</a>;
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment"> /** The size of the file in bytes.</span>
<a name="l00074"></a>00074 <span class="comment"> */</span>
<a name="l00075"></a><a class="code" href="structmrpt_1_1system_1_1_c_directory_explorer_1_1_t_file_info.html#a9c060c33472a1605304dc2a53db09595">00075</a> uint64_t <a class="code" href="structmrpt_1_1system_1_1_c_directory_explorer_1_1_t_file_info.html#a9c060c33472a1605304dc2a53db09595" title="The size of the file in bytes.">fileSize</a>;
<a name="l00076"></a>00076 };
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment"> /** The list type used in "explore".</span>
<a name="l00079"></a>00079 <span class="comment"> * \sa explore</span>
<a name="l00080"></a>00080 <span class="comment"> */</span>
<a name="l00081"></a><a class="code" href="classmrpt_1_1system_1_1_c_directory_explorer.html#a03004d306573d43603813523e822a36a">00081</a> <span class="keyword">typedef</span> std::deque<TFileInfo> <a class="code" href="classmrpt_1_1system_1_1_c_directory_explorer.html#a03004d306573d43603813523e822a36a" title="The list type used in "explore".">TFileInfoList</a>;
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment"> /** The path of the directory to examine must be passed to this constructor, among the</span>
<a name="l00085"></a>00085 <span class="comment"> * According to the following parameters, the object will collect the list of files, which</span>
<a name="l00086"></a>00086 <span class="comment"> * can be modified later through other methods in this class.</span>
<a name="l00087"></a>00087 <span class="comment"> * \param path The path to examine (IT MUST BE A DIRECTORY), e.g "d:\temp\", or "/usr/include/"</span>
<a name="l00088"></a>00088 <span class="comment"> * \param mask One or the OR'ed combination of the values "FILE_ATTRIB_ARCHIVE" and "FILE_ATTRIB_DIRECTORY", depending on what file types do you want in the list (These values are platform-independent).</span>
<a name="l00089"></a>00089 <span class="comment"> * \param outList The list of found files/directories is stored here.</span>
<a name="l00090"></a>00090 <span class="comment"> * \sa sortByName</span>
<a name="l00091"></a>00091 <span class="comment"> */</span>
<a name="l00092"></a>00092 <span class="keyword">static</span> <span class="keywordtype">void</span> explore(
<a name="l00093"></a>00093 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &path,
<a name="l00094"></a>00094 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> mask,
<a name="l00095"></a>00095 <a class="code" href="classstd_1_1deque.html" title="STL class.">TFileInfoList</a> &outList );
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment"> /** Sort the file entries by name, in ascending or descending order</span>
<a name="l00098"></a>00098 <span class="comment"> */</span>
<a name="l00099"></a>00099 <span class="keyword">static</span> <span class="keywordtype">void</span> sortByName( <a class="code" href="classstd_1_1deque.html" title="STL class.">TFileInfoList</a> &lstFiles, <span class="keywordtype">bool</span> ascendingOrder=<span class="keyword">true</span> );
<a name="l00100"></a>00100 <span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment"> /** Remove from the list of files those whose extension does not coincide (without case) with the given one.</span>
<a name="l00102"></a>00102 <span class="comment"> * Example: filterByExtension(lst,"txt");</span>
<a name="l00103"></a>00103 <span class="comment"> */</span>
<a name="l00104"></a>00104 <span class="keyword">static</span> <span class="keywordtype">void</span> filterByExtension( <a class="code" href="classstd_1_1deque.html" title="STL class.">TFileInfoList</a> &lstFiles, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &extension );
<a name="l00105"></a>00105
<a name="l00106"></a>00106 }; <span class="comment">// End of class def.</span>
<a name="l00107"></a>00107
<a name="l00108"></a>00108 } <span class="comment">// End of namespace</span>
<a name="l00109"></a>00109 } <span class="comment">// End of namespace</span>
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <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>
