<!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>string_utils.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">string_utils.h</div> </div>
</div>
<div class="contents">
<a href="string__utils_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_STRING_UTILS_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define MRPT_STRING_UTILS_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"> /** \addtogroup string_manage String management and utilities</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"> /** An OS-independent method for tokenizing a string.</span>
<a name="l00042"></a>00042 <span class="comment"> * The extra parameter "context" must be a pointer to a "char*" variable, which needs no initialization and is used to save information between calls to strtok.</span>
<a name="l00043"></a>00043 <span class="comment"> * \sa system::tokenize</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a>00045 <span class="keywordtype">char</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> *<a class="code" href="group__string__manage.html#ga8072578c501583f9eaaf177bc5b66cf5" title="An OS-independent method for tokenizing a string.">strtok</a>( <span class="keywordtype">char</span> *str, <span class="keyword">const</span> <span class="keywordtype">char</span> *strDelimit, <span class="keywordtype">char</span> **context ) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00046"></a>00046 <span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> /** Tokenizes a string according to a set of delimiting characters.</span>
<a name="l00048"></a>00048 <span class="comment"> * Example:</span>
<a name="l00049"></a>00049 <span class="comment"> * \code</span>
<a name="l00050"></a>00050 <span class="comment"> std::vector<std::string> tokens;</span>
<a name="l00051"></a>00051 <span class="comment"> tokenize( " - Pepe-Er Muo"," -",tokens);</span>
<a name="l00052"></a>00052 <span class="comment"> * \endcode</span>
<a name="l00053"></a>00053 <span class="comment"> *</span>
<a name="l00054"></a>00054 <span class="comment"> * Will generate 3 tokens:</span>
<a name="l00055"></a>00055 <span class="comment"> * - "Pepe"</span>
<a name="l00056"></a>00056 <span class="comment"> * - "Er"</span>
<a name="l00057"></a>00057 <span class="comment"> * - "Muo"</span>
<a name="l00058"></a>00058 <span class="comment"> */</span>
<a name="l00059"></a>00059 <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__string__manage.html#gaf5cda8c9ad3e48a986e53151b6043ce6" title="Tokenizes a string according to a set of delimiting characters.">tokenize</a>(
<a name="l00060"></a>00060 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &inString,
<a name="l00061"></a>00061 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &inDelimiters,
<a name="l00062"></a>00062 <a class="code" href="classstd_1_1deque.html">std::deque<std::string></a> &outTokens ) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00063"></a>00063 <span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment"> /** Tokenizes a string according to a set of delimiting characters.</span>
<a name="l00065"></a>00065 <span class="comment"> * Example:</span>
<a name="l00066"></a>00066 <span class="comment"> * \code</span>
<a name="l00067"></a>00067 <span class="comment"> std::vector<std::string> tokens;</span>
<a name="l00068"></a>00068 <span class="comment"> tokenize( " - Pepe-Er Muo"," -",tokens);</span>
<a name="l00069"></a>00069 <span class="comment"> * \endcode</span>
<a name="l00070"></a>00070 <span class="comment"> *</span>
<a name="l00071"></a>00071 <span class="comment"> * Will generate 3 tokens:</span>
<a name="l00072"></a>00072 <span class="comment"> * - "Pepe"</span>
<a name="l00073"></a>00073 <span class="comment"> * - "Er"</span>
<a name="l00074"></a>00074 <span class="comment"> * - "Muo"</span>
<a name="l00075"></a>00075 <span class="comment"> */</span>
<a name="l00076"></a>00076 <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__string__manage.html#gaf5cda8c9ad3e48a986e53151b6043ce6" title="Tokenizes a string according to a set of delimiting characters.">tokenize</a>(
<a name="l00077"></a>00077 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &inString,
<a name="l00078"></a>00078 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &inDelimiters,
<a name="l00079"></a>00079 <a class="code" href="classstd_1_1vector.html">std::vector<std::string></a> &outTokens ) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00080"></a>00080 <span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment"> /** Removes leading and trailing spaces */</span>
<a name="l00082"></a>00082 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__string__manage.html#ga1845ac57f8d98ab26fec93d2792cc445" title="Removes leading and trailing spaces.">trim</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &str);
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment"> /** Returns a lower-case version of a string.</span>
<a name="l00085"></a>00085 <span class="comment"> * \sa lowerCase */</span>
<a name="l00086"></a>00086 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__string__manage.html#ga5f6a9ebe35c6891045e032cd146c602a" title="Returns a lower-case version of a string.">upperCase</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>& str);
<a name="l00087"></a>00087 <span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment"> /** Returns an upper-case version of a string.</span>
<a name="l00089"></a>00089 <span class="comment"> * \sa upperCase */</span>
<a name="l00090"></a>00090 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__string__manage.html#gaf99191525e46c34c0e26c6a7dea83a65" title="Returns an upper-case version of a string.">lowerCase</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>& str);
<a name="l00091"></a>00091 <span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment"> /** Decodes a UTF-8 string into an UNICODE string.</span>
<a name="l00093"></a>00093 <span class="comment"> * See http://en.wikipedia.org/wiki/UTF-8 and http://www.codeguru.com/cpp/misc/misc/multi-lingualsupport/article.php/c10451/.</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <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__string__manage.html#ga3e9c413b88b15eef86cd20f62b853b22" title="Decodes a UTF-8 string into an UNICODE string.">decodeUTF8</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &strUTF8, <a class="code" href="namespacemrpt.html#a47c2035f9c7d1897b91f97ab90290725">vector_word</a> &out_uniStr );
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment"> /** Encodes a 2-bytes UNICODE string into a UTF-8 string.</span>
<a name="l00098"></a>00098 <span class="comment"> * See http://en.wikipedia.org/wiki/UTF-8 and http://www.codeguru.com/cpp/misc/misc/multi-lingualsupport/article.php/c10451/.</span>
<a name="l00099"></a>00099 <span class="comment"> */</span>
<a name="l00100"></a>00100 <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__string__manage.html#ga02b5d858b55085e58895bf3443d3fdb6" title="Encodes a 2-bytes UNICODE string into a UTF-8 string.">encodeUTF8</a>( <span class="keyword">const</span> <a class="code" href="namespacemrpt.html#a47c2035f9c7d1897b91f97ab90290725">vector_word</a> &input, <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &output );
<a name="l00101"></a>00101 <span class="comment"></span>
<a name="l00102"></a>00102 <span class="comment"> /** Encode a sequence of bytes as a string in base-64.</span>
<a name="l00103"></a>00103 <span class="comment"> * \sa decodeBase64 */</span>
<a name="l00104"></a>00104 <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__string__manage.html#ga5c6b7bdd3ba2ec8ac942286317c6a773" title="Encode a sequence of bytes as a string in base-64.">encodeBase64</a>( <span class="keyword">const</span> <a class="code" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> &inputData, <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &outString );
<a name="l00105"></a>00105 <span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment"> /** Decode a base-64 string into the original sequence of bytes.</span>
<a name="l00107"></a>00107 <span class="comment"> * \sa encodeBase64</span>
<a name="l00108"></a>00108 <span class="comment"> * \return false on invalid base-64 string passed as input, true on success.</span>
<a name="l00109"></a>00109 <span class="comment"> */</span>
<a name="l00110"></a>00110 <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__string__manage.html#gac6d3779d08013438db00f640ced3b5ec" title="Decode a base-64 string into the original sequence of bytes.">decodeBase64</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &inString, <a class="code" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> &outData );
<a name="l00111"></a>00111 <span class="comment"></span>
<a name="l00112"></a>00112 <span class="comment"> /** This function implements formatting with the appropriate SI metric unit prefix: 1e-12->'p', 1e-9->'n', 1e-6->'u', 1e-3->'m', 1->'', 1e3->'K', 1e6->'M', 1e9->'G', 1e12->'T'</span>
<a name="l00113"></a>00113 <span class="comment"> * \sa intervalFormat */</span>
<a name="l00114"></a>00114 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__string__manage.html#ga5f6e0bf73dd504cba8660dc03d8963e1" title="This function implements formatting with the appropriate SI metric unit prefix: 1e-12->'p', 1e-9->'n', 1e-6->'u', 1e-3->'m', 1->'', 1e3->'K', 1e6->'M', 1e9->'G', 1e12->'T'.">unitsFormat</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> val,<span class="keywordtype">int</span> nDecimalDigits=2, <span class="keywordtype">bool</span> middle_space=<span class="keyword">true</span>);
<a name="l00115"></a>00115 <span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment"> /** Enlarge the string with spaces up to the given length. */</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__string__manage.html#gaf1417babb7f6ec4d8264743f191a1fb0" title="Enlarge the string with spaces up to the given length.">rightPad</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &str, <span class="keyword">const</span> <span class="keywordtype">size_t</span> total_len, <span class="keywordtype">bool</span> truncate_if_larger = <span class="keyword">false</span>);
<a name="l00118"></a>00118 <span class="comment"></span>
<a name="l00119"></a>00119 <span class="comment"> /** Return true if the two strings are equal (case sensitive) \sa strCmpI */</span>
<a name="l00120"></a>00120 <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__string__manage.html#ga9664a12c44f80487feca491ff658c74c" title="Return true if the two strings are equal (case sensitive)">strCmp</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &s1, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &s2);
<a name="l00121"></a>00121 <span class="comment"></span>
<a name="l00122"></a>00122 <span class="comment"> /** Return true if the two strings are equal (case insensitive) \sa strCmp */</span>
<a name="l00123"></a>00123 <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__string__manage.html#ga554856afe84963ca30164dfe8fc9b754" title="Return true if the two strings are equal (case insensitive)">strCmpI</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &s1, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &s2);
<a name="l00124"></a>00124 <span class="comment"></span>
<a name="l00125"></a>00125 <span class="comment"> /** Return true if "str" starts with "subStr" (case sensitive) \sa strStartsI */</span>
<a name="l00126"></a>00126 <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__string__manage.html#ga8cf638f3a56c1df7844a1e7a210bcc61" title="Return true if "str" starts with "subStr" (case sensitive)">strStarts</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &str, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &subStr);
<a name="l00127"></a>00127 <span class="comment"></span>
<a name="l00128"></a>00128 <span class="comment"> /** Return true if "str" starts with "subStr" (case insensitive) \sa strStarts */</span>
<a name="l00129"></a>00129 <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__string__manage.html#gaa6784fa3195ea1c2b6f66bae7c112e6d" title="Return true if "str" starts with "subStr" (case insensitive)">strStartsI</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &str, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &subStr);
<a name="l00130"></a>00130 <span class="comment"></span>
<a name="l00131"></a>00131 <span class="comment"> /** @} */</span>
<a name="l00132"></a>00132 } <span class="comment">// End of namespace</span>
<a name="l00133"></a>00133 } <span class="comment">// End of namespace</span>
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <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>
