unicode-accentfold.js.html revision 7d9dd27c758ee750e3ea3b2cf2932691378d5cdd
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: unicode unicode-accentfold.js (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
<h3>unicode&nbsp; <span class="subtitle">3.3.0</span></h3>
<a href="/index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
&gt; <a href="/module_unicode.html" title="unicode">unicode</a>
&gt; unicode-accentfold.js (source view)
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
&nbsp;
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<div id="srcout">
<style>
#doc3 .classopts { display:none; }
</style>
<div class="highlight"><pre><span class="cm">/**</span>
<span class="cm"> * Unicode utilities.</span>
<span class="cm"> *</span>
<span class="cm"> * @module unicode</span>
<span class="cm"> * @since 3.3.0</span>
<span class="cm"> */</span>
<span class="cm">/**</span>
<span class="cm"> * &lt;p&gt;</span>
<span class="cm"> * Provides a basic Unicode accent folding implementation that converts common</span>
<span class="cm"> * accented letters (like &quot;รก&quot;) to their non-accented forms (like &quot;a&quot;).</span>
<span class="cm"> * &lt;/p&gt;</span>
<span class="cm"> *</span>
<span class="cm"> * &lt;p&gt;</span>
<span class="cm"> * This implementation is not comprehensive, and should only be used as a last</span>
<span class="cm"> * resort when accent folding can&#39;t be done on the server. A comprehensive</span>
<span class="cm"> * accent folding implementation would require much more character data to be</span>
<span class="cm"> * sent to the browser, resulting in a significant performance penalty. This</span>
<span class="cm"> * implementation strives for a compromise between usefulness and performance.</span>
<span class="cm"> * &lt;/p&gt;</span>
<span class="cm"> *</span>
<span class="cm"> * &lt;p&gt;</span>
<span class="cm"> * Accent folding is a destructive operation that can&#39;t be reversed, and may</span>
<span class="cm"> * change or destroy the actual meaning of the text depending on the language.</span>
<span class="cm"> * It should not be used on strings that will later be displayed to a user,</span>
<span class="cm"> * unless this is done with the understanding that linguistic meaning may be</span>
<span class="cm"> * lost and that you may in fact confuse or insult the user by doing so.</span>
<span class="cm"> * &lt;/p&gt;</span>
<span class="cm"> *</span>
<span class="cm"> * @module unicode</span>
<span class="cm"> * @submodule unicode-accentfold</span>
<span class="cm"> * @class Unicode.AccentFold</span>
<span class="cm"> * @static</span>
<span class="cm"> */</span>
<span class="kd">var</span> <span class="nx">YArray</span> <span class="o">=</span> <span class="nx">Y</span><span class="p">.</span><span class="nb">Array</span><span class="p">,</span>
<span class="nx">Unicode</span> <span class="o">=</span> <span class="nx">Y</span><span class="p">.</span><span class="nx">Unicode</span><span class="p">,</span>
<span class="nx">FoldData</span> <span class="o">=</span> <span class="nx">Unicode</span><span class="p">.</span><span class="nx">Data</span><span class="p">.</span><span class="nx">AccentFold</span><span class="p">,</span>
<span class="nx">AccentFold</span> <span class="o">=</span> <span class="p">{</span>
<span class="c1">// -- Public Static Methods ------------------------------------------------</span>
<span class="cm">/**</span>
<span class="cm"> * Returns &lt;code&gt;true&lt;/code&gt; if the specified string contains one or more</span>
<span class="cm"> * characters that can be folded, &lt;code&gt;false&lt;/code&gt; otherwise.</span>
<span class="cm"> *</span>
<span class="cm"> * @method canFold</span>
<span class="cm"> * @param {String} string String to test.</span>
<span class="cm"> * @return {Boolean}</span>
<span class="cm"> * @static</span>
<span class="cm"> */</span>
<span class="nx">canFold</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">string</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">letter</span><span class="p">;</span>
<span class="k">for</span> <span class="p">(</span><span class="nx">letter</span> <span class="k">in</span> <span class="nx">FoldData</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">FoldData</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="nx">letter</span><span class="p">)</span> <span class="o">&amp;&amp;</span>
<span class="nx">string</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span><span class="nx">FoldData</span><span class="p">[</span><span class="nx">letter</span><span class="p">])</span> <span class="o">!==</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="kc">true</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">return</span> <span class="kc">false</span><span class="p">;</span>
<span class="p">},</span>
<span class="cm">/**</span>
<span class="cm"> * Compares the accent-folded versions of two strings and returns</span>
<span class="cm"> * &lt;code&gt;true&lt;/code&gt; if they&#39;re the same, &lt;code&gt;false&lt;/code&gt; otherwise. If</span>
<span class="cm"> * a custom comparison function is supplied, the accent-folded strings will</span>
<span class="cm"> * be passed to that function for comparison.</span>
<span class="cm"> *</span>
<span class="cm"> * @method compare</span>
<span class="cm"> * @param {String} a First string to compare.</span>
<span class="cm"> * @param {String} b Second string to compare.</span>
<span class="cm"> * @param {Function} func (optional) Custom comparison function. Should</span>
<span class="cm"> * return a truthy or falsy value.</span>
<span class="cm"> * @return {Boolean} Results of the comparison.</span>
<span class="cm"> * @static</span>
<span class="cm"> */</span>
<span class="nx">compare</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">a</span><span class="p">,</span> <span class="nx">b</span><span class="p">,</span> <span class="nx">func</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">aFolded</span> <span class="o">=</span> <span class="nx">AccentFold</span><span class="p">.</span><span class="nx">fold</span><span class="p">(</span><span class="nx">a</span><span class="p">),</span>
<span class="nx">bFolded</span> <span class="o">=</span> <span class="nx">AccentFold</span><span class="p">.</span><span class="nx">fold</span><span class="p">(</span><span class="nx">b</span><span class="p">);</span>
<span class="k">return</span> <span class="nx">func</span> <span class="o">?</span> <span class="o">!!</span><span class="nx">func</span><span class="p">(</span><span class="nx">aFolded</span><span class="p">,</span> <span class="nx">bFolded</span><span class="p">)</span> <span class="o">:</span> <span class="nx">aFolded</span> <span class="o">===</span> <span class="nx">bFolded</span><span class="p">;</span>
<span class="p">},</span>
<span class="cm">/**</span>
<span class="cm"> * &lt;p&gt;</span>
<span class="cm"> * Returns a copy of &lt;em&gt;haystack&lt;/em&gt; containing only the strings for which</span>
<span class="cm"> * the supplied function returns &lt;code&gt;true&lt;/code&gt;.</span>
<span class="cm"> * &lt;/p&gt;</span>
<span class="cm"> *</span>
<span class="cm"> * &lt;p&gt;</span>
<span class="cm"> * While comparisons will be made using accent-folded strings, the returned</span>
<span class="cm"> * array of matches will contain the original strings that were passed in.</span>
<span class="cm"> * &lt;/p&gt;</span>
<span class="cm"> *</span>
<span class="cm"> * @method filter</span>
<span class="cm"> * @param {Array} haystack Array of strings to filter.</span>
<span class="cm"> * @param {Function} func Comparison function. Will receive an accent-folded</span>
<span class="cm"> * haystack string as an argument, and should return a truthy or falsy</span>
<span class="cm"> * value.</span>
<span class="cm"> * @return {Array} Filtered copy of &lt;em&gt;haystack&lt;/em&gt;.</span>
<span class="cm"> * @static</span>
<span class="cm"> */</span>
<span class="nx">filter</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">haystack</span><span class="p">,</span> <span class="nx">func</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">YArray</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="nx">haystack</span><span class="p">,</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">item</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">func</span><span class="p">(</span><span class="nx">AccentFold</span><span class="p">.</span><span class="nx">fold</span><span class="p">(</span><span class="nx">item</span><span class="p">));</span>
<span class="p">});</span>
<span class="p">},</span>
<span class="cm">/**</span>
<span class="cm"> * Accent-folds the specified string or array of strings and returns a copy</span>
<span class="cm"> * in which common accented letters have been converted to their closest</span>
<span class="cm"> * non-accented, lowercase forms.</span>
<span class="cm"> *</span>
<span class="cm"> * @method fold</span>
<span class="cm"> * @param {String|Array} input String or array of strings to be folded.</span>
<span class="cm"> * @return {String|Array} Folded string or array of strings.</span>
<span class="cm"> * @static</span>
<span class="cm"> */</span>
<span class="nx">fold</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">input</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">Y</span><span class="p">.</span><span class="nx">Lang</span><span class="p">.</span><span class="nx">isArray</span><span class="p">(</span><span class="nx">input</span><span class="p">))</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">YArray</span><span class="p">.</span><span class="nx">map</span><span class="p">(</span><span class="nx">input</span><span class="p">,</span> <span class="nx">AccentFold</span><span class="p">.</span><span class="nx">fold</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">input</span> <span class="o">=</span> <span class="nx">input</span><span class="p">.</span><span class="nx">toLowerCase</span><span class="p">();</span>
<span class="nx">Y</span><span class="p">.</span><span class="nb">Object</span><span class="p">.</span><span class="nx">each</span><span class="p">(</span><span class="nx">FoldData</span><span class="p">,</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">regex</span><span class="p">,</span> <span class="nx">letter</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">input</span> <span class="o">=</span> <span class="nx">input</span><span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="nx">regex</span><span class="p">,</span> <span class="nx">letter</span><span class="p">);</span>
<span class="p">});</span>
<span class="k">return</span> <span class="nx">input</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">Unicode</span><span class="p">.</span><span class="nx">AccentFold</span> <span class="o">=</span> <span class="nx">AccentFold</span><span class="p">;</span>
</pre></div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_align-plugin.html" title="align-plugin">align-plugin</a></li>
<li class=""><a href="module_anim.html" title="anim">anim</a></li>
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li>
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
<li class=""><a href="module_autocomplete.html" title="autocomplete">autocomplete</a></li>
<li class=""><a href="module_base.html" title="base">base</a></li>
<li class=""><a href="module_cache.html" title="cache">cache</a></li>
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_collection.html" title="collection">collection</a></li>
<li class=""><a href="module_console.html" title="console">console</a></li>
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
<li class=""><a href="module_dd.html" title="dd">dd</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
<li class=""><a href="module_dump.html" title="dump">dump</a></li>
<li class=""><a href="module_editor.html" title="editor">editor</a></li>
<li class=""><a href="module_escape.html" title="escape">escape</a></li>
<li class=""><a href="module_event.html" title="event">event</a></li>
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
<li class=""><a href="module_event-gestures.html" title="event-gestures">event-gestures</a></li>
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
<li class=""><a href="module_event-touch.html" title="event-touch">event-touch</a></li>
<li class=""><a href="module_event-valuechange.html" title="event-valuechange">event-valuechange</a></li>
<li class=""><a href="module_highlight.html" title="highlight">highlight</a></li>
<li class=""><a href="module_history.html" title="history">history</a></li>
<li class=""><a href="module_history-deprecated.html" title="history-deprecated">history-deprecated</a></li>
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
<li class=""><a href="module_intl.html" title="intl">intl</a></li>
<li class=""><a href="module_io.html" title="io">io</a></li>
<li class=""><a href="module_json.html" title="json">json</a></li>
<li class=""><a href="module_jsonp.html" title="jsonp">jsonp</a></li>
<li class=""><a href="module_loader.html" title="loader">loader</a></li>
<li class=""><a href="module_node.html" title="node">node</a></li>
<li class=""><a href="module_node-flick.html" title="node-flick">node-flick</a></li>
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
<li class=""><a href="module_oop.html" title="oop">oop</a></li>
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
<li class=""><a href="module_pluginhost.html" title="pluginhost">pluginhost</a></li>
<li class=""><a href="module_pluginhost-base.html" title="pluginhost-base">pluginhost-base</a></li>
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
<li class=""><a href="module_querystring.html" title="querystring">querystring</a></li>
<li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li>
<li class=""><a href="module_resize.html" title="resize">resize</a></li>
<li class=""><a href="module_scrollview.html" title="scrollview">scrollview</a></li>
<li class=""><a href="module_scrollview-base.html" title="scrollview-base">scrollview-base</a></li>
<li class=""><a href="module_scrollview-paginator.html" title="scrollview-paginator">scrollview-paginator</a></li>
<li class=""><a href="module_scrollview-scrollbars.html" title="scrollview-scrollbars">scrollview-scrollbars</a></li>
<li class=""><a href="module_shim-plugin.html" title="shim-plugin">shim-plugin</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_sortable.html" title="sortable">sortable</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
<li class=""><a href="module_swf.html" title="swf">swf</a></li>
<li class=""><a href="module_swfdetect.html" title="swfdetect">swfdetect</a></li>
<li class=""><a href="module_tabview.html" title="tabview">tabview</a></li>
<li class=""><a href="module_test.html" title="test">test</a></li>
<li class=""><a href="module_transition.html" title="transition">transition</a></li>
<li class="selected"><a href="module_unicode.html" title="unicode">unicode</a></li>
<li class=""><a href="module_uploader.html" title="uploader">uploader</a></li>
<li class=""><a href="module_widget.html" title="widget">widget</a></li>
<li class=""><a href="module_widget-anim.html" title="widget-anim">widget-anim</a></li>
<li class=""><a href="module_widget-child.html" title="widget-child">widget-child</a></li>
<li class=""><a href="module_widget-locale.html" title="widget-locale">widget-locale</a></li>
<li class=""><a href="module_widget-parent.html" title="widget-parent">widget-parent</a></li>
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
<li class=""><a href="module_widget-position-align.html" title="widget-position-align">widget-position-align</a></li>
<li class=""><a href="module_widget-position-constrain.html" title="widget-position-constrain">widget-position-constrain</a></li>
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
<li class=""><a href="module_yql.html" title="yql">yql</a></li>
<li class=""><a href="module_yui.html" title="yui">yui</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="Unicode.AccentFold.html" title="Unicode.AccentFold">Unicode.AccentFold</a></li>
<li class=""><a href="Unicode.Data.AccentFold.html" title="Unicode.Data.AccentFold">Unicode.Data.AccentFold</a></li>
<li class=""><a href="Unicode.Data.WordBreak.html" title="Unicode.Data.WordBreak">Unicode.Data.WordBreak</a></li>
<li class=""><a href="Unicode.WordBreak.html" title="Unicode.WordBreak">Unicode.WordBreak</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class="selected"><a href="unicode-accentfold.js.html" title="unicode-accentfold.js">unicode-accentfold.js</a></li>
<li class=""><a href="unicode-data-accentfold.js.html" title="unicode-data-accentfold.js">unicode-data-accentfold.js</a></li>
<li class=""><a href="unicode-data-wordbreak.js.html" title="unicode-data-wordbreak.js">unicode-data-wordbreak.js</a></li>
<li class=""><a href="unicode-wordbreak.js.html" title="unicode-wordbreak.js">unicode-wordbreak.js</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2010 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
var ALL_YUI_PROPS = [{"access": "", "host": "Unicode.AccentFold", "name": "canFold", "url": "Unicode.AccentFold.html#method_canFold", "type": "method"}, {"access": "protected", "host": "Unicode.WordBreak", "name": "_classify", "url": "Unicode.WordBreak.html#method__classify", "type": "method"}, {"access": "", "host": "Unicode.AccentFold", "name": "compare", "url": "Unicode.AccentFold.html#method_compare", "type": "method"}, {"access": "", "host": "Unicode.AccentFold", "name": "filter", "url": "Unicode.AccentFold.html#method_filter", "type": "method"}, {"access": "", "host": "Unicode.AccentFold", "name": "fold", "url": "Unicode.AccentFold.html#method_fold", "type": "method"}, {"access": "", "host": "Unicode.WordBreak", "name": "getUniqueWords", "url": "Unicode.WordBreak.html#method_getUniqueWords", "type": "method"}, {"access": "", "host": "Unicode.WordBreak", "name": "getWords", "url": "Unicode.WordBreak.html#method_getWords", "type": "method"}, {"access": "protected", "host": "Unicode.WordBreak", "name": "_isWordBoundary", "url": "Unicode.WordBreak.html#method__isWordBoundary", "type": "method"}, {"access": "", "host": "Unicode.WordBreak", "name": "isWordBoundary", "url": "Unicode.WordBreak.html#method_isWordBoundary", "type": "method"}];
</script>
</body>
</html>