Files
bootloader/doc/host_html/classblfwk_1_1_glob_matcher.html
László Monda e6c1fce5b4 Add KBOOT.
2016-08-10 01:45:15 +02:00

275 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Kinetis Bootloader Host: blfwk::GlobMatcher Class Reference</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>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.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="nxp_logo_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kinetis Bootloader Host
&#160;<span id="projectnumber">2.0.0</span>
</div>
<div id="projectbrief">Host Tools for Kinetis devices</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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>Introduction</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</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">
$(document).ready(function(){initNavTree('classblfwk_1_1_glob_matcher.html','');});
</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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classblfwk_1_1_glob_matcher-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">blfwk::GlobMatcher Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class uses glob pattern matching to match strings.
<a href="classblfwk_1_1_glob_matcher.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="src_2blfwk_2_glob_matcher_8h_source.html">GlobMatcher.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for blfwk::GlobMatcher:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classblfwk_1_1_glob_matcher__inherit__graph.svg" width="192" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for blfwk::GlobMatcher:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classblfwk_1_1_glob_matcher__coll__graph.svg" width="279" height="218"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2b79bd9a72c831090e338970f7f4661b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b79bd9a72c831090e338970f7f4661b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_glob_matcher.html#a2b79bd9a72c831090e338970f7f4661b">GlobMatcher</a> (const std::string &amp;pattern)</td></tr>
<tr class="memdesc:a2b79bd9a72c831090e338970f7f4661b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a2b79bd9a72c831090e338970f7f4661b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c2c9b8d4514b85ddea0267246b59ceb"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_glob_matcher.html#a5c2c9b8d4514b85ddea0267246b59ceb">match</a> (const std::string &amp;testValue)</td></tr>
<tr class="memdesc:a5c2c9b8d4514b85ddea0267246b59ceb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether <em>testValue</em> matches the glob pattern. <a href="#a5c2c9b8d4514b85ddea0267246b59ceb">More...</a><br /></td></tr>
<tr class="separator:a5c2c9b8d4514b85ddea0267246b59ceb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:acee3e2a63d6ddf3eebc02c9136c50743"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_glob_matcher.html#acee3e2a63d6ddf3eebc02c9136c50743">globMatch</a> (const char *str, const char *p)</td></tr>
<tr class="memdesc:acee3e2a63d6ddf3eebc02c9136c50743"><td class="mdescLeft">&#160;</td><td class="mdescRight">Glob implementation. <a href="#acee3e2a63d6ddf3eebc02c9136c50743">More...</a><br /></td></tr>
<tr class="separator:acee3e2a63d6ddf3eebc02c9136c50743"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a3876ebea9f4af5e8be2a76b8238dff98"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3876ebea9f4af5e8be2a76b8238dff98"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_glob_matcher.html#a3876ebea9f4af5e8be2a76b8238dff98">m_pattern</a></td></tr>
<tr class="memdesc:a3876ebea9f4af5e8be2a76b8238dff98"><td class="mdescLeft">&#160;</td><td class="mdescRight">The glob pattern to match against. <br /></td></tr>
<tr class="separator:a3876ebea9f4af5e8be2a76b8238dff98"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class uses glob pattern matching to match strings. </p>
<p>Glob patterns:</p><ul>
<li>* matches zero or more characters</li>
<li>? matches any single character</li>
<li>[set] matches any character in the set</li>
<li>[^set] matches any character NOT in the set where a set is a group of characters or ranges. a range is written as two characters seperated with a hyphen: a-z denotes all characters between a to z inclusive.</li>
<li>[-set] set matches a literal hypen and any character in the set</li>
<li>[]set] matches a literal close bracket and any character in the set</li>
<li>char matches itself except where char is '*' or '?' or '['</li>
<li>\char matches char, including any pattern character</li>
</ul>
<p>Examples:</p><ul>
<li>a*c ac abc abbc ...</li>
<li>a?c acc abc aXc ...</li>
<li>a[a-z]c aac abc acc ...</li>
<li>a[-a-z]c a-c aac abc ... </li>
</ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acee3e2a63d6ddf3eebc02c9136c50743"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool GlobMatcher::globMatch </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>p</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Glob implementation. </p>
<dl class="section note"><dt>Note</dt><dd>This glob implementation was originally written by ozan s. yigit in December 1994. This is public domain source code. </dd></dl>
</div>
</div>
<a class="anchor" id="a5c2c9b8d4514b85ddea0267246b59ceb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool GlobMatcher::match </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>testValue</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether <em>testValue</em> matches the glob pattern. </p>
<p>The glob pattern must match the <em>entire</em> test value argument in order for the match to be considered successful. Thus, even if, for example, the pattern matches all but the last character the result will be false.</p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">true</td><td>The test value does match the glob pattern. </td></tr>
<tr><td class="paramname">false</td><td>The test value does not match the glob pattern. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classblfwk_1_1_string_matcher.html#a9460659b659827ce222e8c06e74c3b64">blfwk::StringMatcher</a>.</p>
<p>Reimplemented in <a class="el" href="classblfwk_1_1_excludes_list_matcher.html#a262053381ffc163cd3d4cecb2a5efa33">blfwk::ExcludesListMatcher</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="src_2blfwk_2_glob_matcher_8h_source.html">src/blfwk/GlobMatcher.h</a></li>
<li>src/blfwk/src/GlobMatcher.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>blfwk</b></li><li class="navelem"><a class="el" href="classblfwk_1_1_glob_matcher.html">GlobMatcher</a></li>
<li class="footer">Generated on Mon Mar 7 2016 16:49:51 for Kinetis Bootloader Host by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>