<!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>filesystem.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">filesystem.h</div> </div>
</div>
<div class="contents">
<a href="filesystem_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 MRPT_FILESYSTEM_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define MRPT_FILESYSTEM_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
<a name="l00033"></a>00033 <span class="keyword">namespace </span>mrpt
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 <span class="keyword">namespace </span>system
<a name="l00036"></a>00036 {<span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment"> /** @defgroup filesystem Directories, files, and file names</span>
<a name="l00038"></a>00038 <span class="comment"> * \ingroup mrpt_base_grp</span>
<a name="l00039"></a>00039 <span class="comment"> * @{ */</span>
<a name="l00040"></a>00040 <span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment"> /** Returns the name of a proposed temporary file name */</span>
<a name="l00042"></a>00042 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga82325926b9a2b34801d64f9c7f38d24f" title="Returns the name of a proposed temporary file name.">getTempFileName</a>();
<a name="l00043"></a>00043 <span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment"> /** Returns the current working directory.</span>
<a name="l00045"></a>00045 <span class="comment"> */</span>
<a name="l00046"></a>00046 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga0f47381c1931e6ece35e41f944bdebb1" title="Returns the current working directory.">getcwd</a>();
<a name="l00047"></a>00047 <span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment"> /** Creates a directory</span>
<a name="l00049"></a>00049 <span class="comment"> * \return Returns false on any error, true on everything OK.</span>
<a name="l00050"></a>00050 <span class="comment"> * \todo Seems to return false on Linux even after creating the directory OK.</span>
<a name="l00051"></a>00051 <span class="comment"> */</span>
<a name="l00052"></a>00052 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#gaa435b18007a6fca5d14ccdf6fc650492" title="Creates a directory.">createDirectory</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &dirName );
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> /** Deletes a single file. For multiple files see deleteFiles</span>
<a name="l00055"></a>00055 <span class="comment"> * \return Returns false on any error, true on everything OK.</span>
<a name="l00056"></a>00056 <span class="comment"> * \sa deleteFiles</span>
<a name="l00057"></a>00057 <span class="comment"> */</span>
<a name="l00058"></a>00058 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga8eb9af5a17fde6c308953303f70e4093" title="Deletes a single file.">deleteFile</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fileName );
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment"> /** Delete one or more files, especified by the (optional) path and the file name (including '?' or '*') - Use forward slash ('/') for directories for compatibility between Windows and Linux, since they will be internally traslated into backward slashes ('\') if MRPT is compiled under Windows.</span>
<a name="l00061"></a>00061 <span class="comment"> * \sa deleteFile</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a>00063 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga71cc493ee11ab1729522a90fb5478c2d" title="Delete one or more files, especified by the (optional) path and the file name (including '...">deleteFiles</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &s);
<a name="l00064"></a>00064 <span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> /** Renames a file - If the target path is different and the filesystem allows it, it will be moved to the new location.</span>
<a name="l00066"></a>00066 <span class="comment"> * \return false on any error. In that case, if a pointer to a receiver string is passed in error_msg, a description of the error is saved there.</span>
<a name="l00067"></a>00067 <span class="comment"> */</span>
<a name="l00068"></a>00068 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga26758c4304f3caec1e58d9382c173e40" title="Renames a file - If the target path is different and the filesystem allows it, it will be moved to th...">renameFile</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &oldFileName, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &newFileName, <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> *error_msg=NULL );
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> /** Delete all the files in a given directory (nothing done if directory does not exists, or path is a file).</span>
<a name="l00071"></a>00071 <span class="comment"> * \sa deleteFile</span>
<a name="l00072"></a>00072 <span class="comment"> * \return true on success</span>
<a name="l00073"></a>00073 <span class="comment"> */</span>
<a name="l00074"></a>00074 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga076a37d5291251595fef9a49c1f3fd46" title="Delete all the files in a given directory (nothing done if directory does not exists, or path is a file).">deleteFilesInDirectory</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &s, <span class="keywordtype">bool</span> deleteDirectoryAsWell = <span class="keyword">false</span> );
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment"> /** Extract just the name (without extension) of a filename from a complete path plus name plus extension.</span>
<a name="l00077"></a>00077 <span class="comment"> * This function works for either "/" or "\" directory separators.</span>
<a name="l00078"></a>00078 <span class="comment"> * \sa extractFileExtension,extractFileDirectory</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a>00080 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga89b806814023cd0411a99d6cb4d54ea9" title="Extract just the name (without extension) of a filename from a complete path plus name plus extension...">extractFileName</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>& filePath);
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /** Extract the extension of a filename.</span>
<a name="l00083"></a>00083 <span class="comment"> * For example, for "dummy.cpp", it will return "cpp".</span>
<a name="l00084"></a>00084 <span class="comment"> * If "ignore_gz" is true, the second extension will be returned if the file name</span>
<a name="l00085"></a>00085 <span class="comment"> * ends in ".gz", for example, for "foo.map.gz", this will return "map".</span>
<a name="l00086"></a>00086 <span class="comment"> * \sa extractFileName,extractFileDirectory</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a>00088 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#gac857ed6d7bd5a5d17c3ab8fc249e8cfa" title="Extract the extension of a filename.">extractFileExtension</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &filePath, <span class="keywordtype">bool</span> ignore_gz = <span class="keyword">false</span> );
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment"> /** Extract the whole path (the directory) of a filename from a complete path plus name plus extension.</span>
<a name="l00091"></a>00091 <span class="comment"> * This function works for either "/" or "\" directory separators.</span>
<a name="l00092"></a>00092 <span class="comment"> * \sa extractFileName,extractFileExtension</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga15e372b32fef4d2135e0d2d96adb766e" title="Extract the whole path (the directory) of a filename from a complete path plus name plus extension...">extractFileDirectory</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &filePath);
<a name="l00095"></a>00095 <span class="comment"></span>
<a name="l00096"></a>00096 <span class="comment"> /** Test if a given file (or directory) exists.</span>
<a name="l00097"></a>00097 <span class="comment"> * \sa directoryExists</span>
<a name="l00098"></a>00098 <span class="comment"> */</span>
<a name="l00099"></a>00099 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#gaa233b191fefbf42cf4d06bce65d2ccc2" title="Test if a given file (or directory) exists.">fileExists</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>& fileName);
<a name="l00100"></a>00100 <span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment"> /** Test if a given directory exists (it fails if the given path refers to an existing file).</span>
<a name="l00102"></a>00102 <span class="comment"> * \sa fileExists</span>
<a name="l00103"></a>00103 <span class="comment"> */</span>
<a name="l00104"></a>00104 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga0a8ee608bba288dbb2ad2b93e0bf91e9" title="Test if a given directory exists (it fails if the given path refers to an existing file)...">directoryExists</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>& fileName);
<a name="l00105"></a>00105 <span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment"> /** Replace invalid filename chars by underscores ('_').</span>
<a name="l00107"></a>00107 <span class="comment"> * Invalid chars are identified by those not being alphanumeric or: ".-#%$&()+[]{}"</span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga3ab2bd0ae86710964f38febf2827ba2f" title="Replace invalid filename chars by underscores ('_').">fileNameStripInvalidChars</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &filename);
<a name="l00110"></a>00110 <span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment"> /** Replace the filename extension by another one.</span>
<a name="l00112"></a>00112 <span class="comment"> * Example:</span>
<a name="l00113"></a>00113 <span class="comment"> * \code</span>
<a name="l00114"></a>00114 <span class="comment"> * fileNameChangeExtension("cool.txt","bar") // -> "cool.bar"</span>
<a name="l00115"></a>00115 <span class="comment"> * \endcode</span>
<a name="l00116"></a>00116 <span class="comment"> */</span>
<a name="l00117"></a>00117 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga603f2e4e59b427db27526a1ffbd26ae2" title="Replace the filename extension by another one.">fileNameChangeExtension</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &filename, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &newExtension );
<a name="l00118"></a>00118 <span class="comment"></span>
<a name="l00119"></a>00119 <span class="comment"> /** Return the size of the given file, or size_t(-1) if some error is found accessing that file.</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a>00121 uint64_t <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__filesystem.html#ga7f6b64000fa073fc067c67ee0f9aaad5" title="Return the size of the given file, or size_t(-1) if some error is found accessing that file...">getFileSize</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fileName);
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment"> /** @} */</span>
<a name="l00124"></a>00124
<a name="l00125"></a>00125
<a name="l00126"></a>00126 } <span class="comment">// End of namespace</span>
<a name="l00127"></a>00127
<a name="l00128"></a>00128 } <span class="comment">// End of namespace</span>
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <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>
