| Commit | Line | Data |
|---|
| 8e30e889 |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 | <!-- |
| 4 | This file was generated by Devel::NYTProf version 4.06 |
| 5 | --> |
| 6 | <head> |
| 7 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| 8 | <meta http-equiv="Content-Language" content="en-us" /> |
| 9 | <title>Profile of Params/Util.pm</title> |
| 10 | <link rel="stylesheet" type="text/css" href="style.css" /> |
| 11 | <script type="text/javascript" src="js/jquery-min.js"></script> |
| 12 | |
| 13 | <script type="text/javascript" src="js/jquery-tablesorter-min.js"></script> |
| 14 | <link rel="stylesheet" type="text/css" href="js/style-tablesorter.css" /> |
| 15 | <script type="text/javascript"> |
| 16 | // when a column is first clicked on to sort it, use descending order |
| 17 | // XXX doesn't seem to work (and not just because the tablesorter formatSortingOrder() is broken) |
| 18 | $.tablesorter.defaults.sortInitialOrder = "desc"; |
| 19 | // add parser through the tablesorter addParser method |
| 20 | $.tablesorter.addParser({ |
| 21 | id: 'fmt_time', // name of this parser |
| 22 | is: function(s) { |
| 23 | return false; // return false so this parser is not auto detected |
| 24 | }, |
| 25 | format: function(orig) { // format data for normalization |
| 26 | // console.log(orig); |
| 27 | val = orig.replace(/ns/,''); |
| 28 | if (val != orig) { return val / (1000*1000*1000); } |
| 29 | val = orig.replace(/µs/,''); /* XXX use µ ? */ |
| 30 | if (val != orig) { return val / (1000*1000); } |
| 31 | var val = orig.replace(/ms/,''); |
| 32 | if (val != orig) { return val / (1000); } |
| 33 | var val = orig.replace(/s/,''); |
| 34 | if (val != orig) { return val; } |
| 35 | if (orig == '0') { return orig; } |
| 36 | console.log('no match for fmt_time of '.concat(orig)); |
| 37 | return orig; |
| 38 | }, |
| 39 | type: 'numeric' // set type, either numeric or text |
| 40 | }); |
| 41 | </script> |
| 42 | </head> |
| 43 | |
| 44 | <body > |
| 45 | <div class="header" style="position: relative; overflow-x: hidden; overflow-y: hidden; z-index: 0; "> |
| 46 | <div class="header_back"> |
| 47 | <a href="index.html">← Index</a> |
| 48 | </div> |
| 49 | <div class="headerForeground" style="float: left"> |
| 50 | <span class="siteTitle">NYTProf Performance Profile</span> |
| 51 | <span class="siteSubtitle">  <span>« <span class="mode_btn mode_btn_selected">block view</span> • <span class="mode_btn"><a href="Params-Util-pm-70-line.html">line view</a></span> • <span class="mode_btn"><a href="Params-Util-pm-70-sub.html">sub view</a></span> »</span><br /> |
| 52 | For script/nytprof.pl |
| 53 | </span> |
| 54 | </div> |
| 55 | <div class="headerForeground" style="float: right; text-align: right"> |
| 56 | <span class="siteTitle"> </span> |
| 57 | <span class="siteSubtitle">Run on Thu May 31 16:29:39 2012<br />Reported on Thu May 31 16:35:21 2012</span> |
| 58 | </div> |
| 59 | <div style="position: absolute; left: 0px; top: 0%; width: 100%; height: 101%; z-index: -1; background-color: rgb(17, 136, 255); "></div> |
| 60 | <div style="position: absolute; left: 0px; top: 2%; width: 100%; height: 99%; z-index: -1; background-color: rgb(16, 134, 253); "></div> |
| 61 | <div style="position: absolute; left: 0px; top: 4%; width: 100%; height: 97%; z-index: -1; background-color: rgb(16, 133, 252); "></div> |
| 62 | <div style="position: absolute; left: 0px; top: 6%; width: 100%; height: 95%; z-index: -1; background-color: rgb(15, 131, 250); "></div> |
| 63 | <div style="position: absolute; left: 0px; top: 8%; width: 100%; height: 93%; z-index: -1; background-color: rgb(15, 130, 249); "></div> |
| 64 | <div style="position: absolute; left: 0px; top: 10%; width: 100%; height: 91%; z-index: -1; background-color: rgb(15, 129, 248); "></div> |
| 65 | <div style="position: absolute; left: 0px; top: 12%; width: 100%; height: 89%; z-index: -1; background-color: rgb(14, 127, 246); "></div> |
| 66 | <div style="position: absolute; left: 0px; top: 14%; width: 100%; height: 87%; z-index: -1; background-color: rgb(14, 126, 245); "></div> |
| 67 | <div style="position: absolute; left: 0px; top: 16%; width: 100%; height: 85%; z-index: -1; background-color: rgb(14, 125, 244); "></div> |
| 68 | <div style="position: absolute; left: 0px; top: 18%; width: 100%; height: 83%; z-index: -1; background-color: rgb(13, 123, 242); "></div> |
| 69 | <div style="position: absolute; left: 0px; top: 20%; width: 100%; height: 81%; z-index: -1; background-color: rgb(13, 122, 241); "></div> |
| 70 | <div style="position: absolute; left: 0px; top: 22%; width: 100%; height: 79%; z-index: -1; background-color: rgb(13, 121, 240); "></div> |
| 71 | <div style="position: absolute; left: 0px; top: 24%; width: 100%; height: 77%; z-index: -1; background-color: rgb(12, 119, 238); "></div> |
| 72 | <div style="position: absolute; left: 0px; top: 26%; width: 100%; height: 75%; z-index: -1; background-color: rgb(12, 118, 237); "></div> |
| 73 | <div style="position: absolute; left: 0px; top: 28%; width: 100%; height: 73%; z-index: -1; background-color: rgb(12, 116, 235); "></div> |
| 74 | <div style="position: absolute; left: 0px; top: 30%; width: 100%; height: 71%; z-index: -1; background-color: rgb(11, 115, 234); "></div> |
| 75 | <div style="position: absolute; left: 0px; top: 32%; width: 100%; height: 69%; z-index: -1; background-color: rgb(11, 114, 233); "></div> |
| 76 | <div style="position: absolute; left: 0px; top: 34%; width: 100%; height: 67%; z-index: -1; background-color: rgb(11, 112, 231); "></div> |
| 77 | <div style="position: absolute; left: 0px; top: 36%; width: 100%; height: 65%; z-index: -1; background-color: rgb(10, 111, 230); "></div> |
| 78 | <div style="position: absolute; left: 0px; top: 38%; width: 100%; height: 63%; z-index: -1; background-color: rgb(10, 110, 229); "></div> |
| 79 | <div style="position: absolute; left: 0px; top: 40%; width: 100%; height: 61%; z-index: -1; background-color: rgb(10, 108, 227); "></div> |
| 80 | <div style="position: absolute; left: 0px; top: 42%; width: 100%; height: 59%; z-index: -1; background-color: rgb(9, 107, 226); "></div> |
| 81 | <div style="position: absolute; left: 0px; top: 44%; width: 100%; height: 57%; z-index: -1; background-color: rgb(9, 106, 225); "></div> |
| 82 | <div style="position: absolute; left: 0px; top: 46%; width: 100%; height: 55%; z-index: -1; background-color: rgb(9, 104, 223); "></div> |
| 83 | <div style="position: absolute; left: 0px; top: 48%; width: 100%; height: 53%; z-index: -1; background-color: rgb(8, 103, 222); "></div> |
| 84 | <div style="position: absolute; left: 0px; top: 50%; width: 100%; height: 51%; z-index: -1; background-color: rgb(8, 102, 221); "></div> |
| 85 | <div style="position: absolute; left: 0px; top: 52%; width: 100%; height: 49%; z-index: -1; background-color: rgb(8, 100, 219); "></div> |
| 86 | <div style="position: absolute; left: 0px; top: 54%; width: 100%; height: 47%; z-index: -1; background-color: rgb(7, 99, 218); "></div> |
| 87 | <div style="position: absolute; left: 0px; top: 56%; width: 100%; height: 45%; z-index: -1; background-color: rgb(7, 97, 216); "></div> |
| 88 | <div style="position: absolute; left: 0px; top: 58%; width: 100%; height: 43%; z-index: -1; background-color: rgb(7, 96, 215); "></div> |
| 89 | <div style="position: absolute; left: 0px; top: 60%; width: 100%; height: 41%; z-index: -1; background-color: rgb(6, 95, 214); "></div> |
| 90 | <div style="position: absolute; left: 0px; top: 62%; width: 100%; height: 39%; z-index: -1; background-color: rgb(6, 93, 212); "></div> |
| 91 | <div style="position: absolute; left: 0px; top: 64%; width: 100%; height: 37%; z-index: -1; background-color: rgb(6, 92, 211); "></div> |
| 92 | <div style="position: absolute; left: 0px; top: 66%; width: 100%; height: 35%; z-index: -1; background-color: rgb(5, 91, 210); "></div> |
| 93 | <div style="position: absolute; left: 0px; top: 68%; width: 100%; height: 33%; z-index: -1; background-color: rgb(5, 89, 208); "></div> |
| 94 | <div style="position: absolute; left: 0px; top: 70%; width: 100%; height: 31%; z-index: -1; background-color: rgb(5, 88, 207); "></div> |
| 95 | <div style="position: absolute; left: 0px; top: 72%; width: 100%; height: 29%; z-index: -1; background-color: rgb(4, 87, 206); "></div> |
| 96 | <div style="position: absolute; left: 0px; top: 74%; width: 100%; height: 27%; z-index: -1; background-color: rgb(4, 85, 204); "></div> |
| 97 | <div style="position: absolute; left: 0px; top: 76%; width: 100%; height: 25%; z-index: -1; background-color: rgb(4, 84, 203); "></div> |
| 98 | <div style="position: absolute; left: 0px; top: 78%; width: 100%; height: 23%; z-index: -1; background-color: rgb(3, 82, 201); "></div> |
| 99 | <div style="position: absolute; left: 0px; top: 80%; width: 100%; height: 21%; z-index: -1; background-color: rgb(3, 81, 200); "></div> |
| 100 | <div style="position: absolute; left: 0px; top: 82%; width: 100%; height: 19%; z-index: -1; background-color: rgb(3, 80, 199); "></div> |
| 101 | <div style="position: absolute; left: 0px; top: 84%; width: 100%; height: 17%; z-index: -1; background-color: rgb(2, 78, 197); "></div> |
| 102 | <div style="position: absolute; left: 0px; top: 86%; width: 100%; height: 15%; z-index: -1; background-color: rgb(2, 77, 196); "></div> |
| 103 | <div style="position: absolute; left: 0px; top: 88%; width: 100%; height: 13%; z-index: -1; background-color: rgb(2, 76, 195); "></div> |
| 104 | <div style="position: absolute; left: 0px; top: 90%; width: 100%; height: 11%; z-index: -1; background-color: rgb(1, 74, 193); "></div> |
| 105 | <div style="position: absolute; left: 0px; top: 92%; width: 100%; height: 9%; z-index: -1; background-color: rgb(1, 73, 192); "></div> |
| 106 | <div style="position: absolute; left: 0px; top: 94%; width: 100%; height: 7%; z-index: -1; background-color: rgb(1, 72, 191); "></div> |
| 107 | <div style="position: absolute; left: 0px; top: 96%; width: 100%; height: 5%; z-index: -1; background-color: rgb(0, 70, 189); "></div> |
| 108 | <div style="position: absolute; left: 0px; top: 98%; width: 100%; height: 3%; z-index: -1; background-color: rgb(0, 69, 188); "></div> |
| 109 | <div style="position: absolute; left: 0px; top: 100%; width: 100%; height: 1%; z-index: -1; background-color: rgb(0, 68, 187); "></div> |
| 110 | </div> |
| 111 | |
| 112 | <div class="body_content"><br /> |
| 113 | <table class="file_summary"><tr><td class="h">Filename</td><td align="left"><a href="file:///Users/edenc/perl5/lib/perl5/darwin-multi-2level/Params/Util.pm">/Users/edenc/perl5/lib/perl5/darwin-multi-2level/Params/Util.pm</a></td></tr> |
| 114 | <tr><td class="h">Statements</td><td align="left">Executed 48 statements in 1.74ms</td></tr></table> |
| 115 | |
| 116 | <table id="subs_table" border="1" cellpadding="0" class="tablesorter"> |
| 117 | <caption>Subroutines</caption> |
| 118 | <thead> |
| 119 | <tr> |
| 120 | <th>Calls</th> |
| 121 | <th><span title="Number of Places sub is called from">P</span></th> |
| 122 | <th><span title="Number of Files sub is called from">F</span></th> |
| 123 | <th>Exclusive<br />Time</th> |
| 124 | <th>Inclusive<br />Time</th> |
| 125 | <th>Subroutine</th> |
| 126 | </tr> |
| 127 | </thead> |
| 128 | <tbody> |
| 129 | <tr><td class="c0">5033</td><td class="c0">5</td><td class="c0">3</td><td class="c0"><span title="0.0%">3.36ms</span></td><td class="c0"><span title="0.0%">3.36ms</span></td><td class="sub_name"><span style="display: none;">Params::Util::::_CODELIKE</span>Params::Util::<a href="Params-Util-pm-70-block.html#Params__Util___CODELIKE">_CODELIKE</a> (xsub)</span></td></tr> |
| 130 | <tr><td class="c0">835</td><td class="c1">2</td><td class="c3">1</td><td class="c0"><span title="0.0%">690µs</span></td><td class="c0"><span title="0.0%">690µs</span></td><td class="sub_name"><span style="display: none;">Params::Util::::_HASHLIKE</span>Params::Util::<a href="Params-Util-pm-70-block.html#Params__Util___HASHLIKE">_HASHLIKE</a> (xsub)</span></td></tr> |
| 131 | <tr><td class="c0">591</td><td class="c0">5</td><td class="c0">4</td><td class="c0"><span title="0.0%">495µs</span></td><td class="c0"><span title="0.0%">495µs</span></td><td class="sub_name"><span style="display: none;">Params::Util::::_SCALAR0</span>Params::Util::<a href="Params-Util-pm-70-block.html#Params__Util___SCALAR0">_SCALAR0</a> (xsub)</span></td></tr> |
| 132 | <tr><td class="c1">48</td><td class="c0">6</td><td class="c0">4</td><td class="c0"><span title="0.0%">214µs</span></td><td class="c0"><span title="0.0%">255µs</span></td><td class="sub_name"><span style="display: none;">Params::Util::::_INSTANCE</span>Params::Util::<a href="Params-Util-pm-70-block.html#Params__Util___INSTANCE">_INSTANCE</a> (xsub)</span></td></tr> |
| 133 | <tr><td class="c2">32</td><td class="c3">1</td><td class="c3">1</td><td class="c0"><span title="0.0%">109µs</span></td><td class="c2"><span title="0.0%">109µs</span></td><td class="sub_name"><span style="display: none;">Params::Util::::CORE:match</span>Params::Util::<a href="Params-Util-pm-70-block.html#Params__Util__CORE_match">CORE:match</a> (opcode)</span></td></tr> |
| 134 | <tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">35µs</span></td><td class="c3"><span title="0.0%">35µs</span></td><td class="sub_name"><span style="display: none;">Params::Util::::bootstrap</span>Params::Util::<a href="Params-Util-pm-70-block.html#Params__Util__bootstrap">bootstrap</a> (xsub)</span></td></tr> |
| 135 | <tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">22µs</span></td><td class="c3"><span title="0.0%">22µs</span></td><td class="sub_name"><span style="display: none;">Params::Util::::BEGIN@58</span>Params::Util::<a href="Params-Util-pm-70-block.html#58">BEGIN@58</a></span></td></tr> |
| 136 | <tr><td class="c3">18</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">18µs</span></td><td class="c3"><span title="0.0%">18µs</span></td><td class="sub_name"><span style="display: none;">Params::Util::::_ARRAYLIKE</span>Params::Util::<a href="Params-Util-pm-70-block.html#Params__Util___ARRAYLIKE">_ARRAYLIKE</a> (xsub)</span></td></tr> |
| 137 | <tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">7µs</span></td><td class="c3"><span title="0.0%">10µs</span></td><td class="sub_name"><span style="display: none;">Params::Util::::BEGIN@59</span>Params::Util::<a href="Params-Util-pm-70-block.html#59">BEGIN@59</a></span></td></tr> |
| 138 | <tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">6µs</span></td><td class="c3"><span title="0.0%">63µs</span></td><td class="sub_name"><span style="display: none;">Params::Util::::BEGIN@65</span>Params::Util::<a href="Params-Util-pm-70-block.html#65">BEGIN@65</a></span></td></tr> |
| 139 | <tr><td class="c3">3</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">4µs</span></td><td class="c3"><span title="0.0%">4µs</span></td><td class="sub_name"><span style="display: none;">Params::Util::::_HASH0</span>Params::Util::<a href="Params-Util-pm-70-block.html#Params__Util___HASH0">_HASH0</a> (xsub)</span></td></tr> |
| 140 | </tbody></table> |
| 141 | Call graph for these subroutines as a |
| 142 | <a href="http://en.wikipedia.org/wiki/Graphviz">Graphviz</a> |
| 143 | <a href="Users-edenc-perl5-lib-perl5-darwin-multi-2level-Params-Util-pm.dot">dot language file</a>. |
| 144 | |
| 145 | <table border="1" cellpadding="0"> |
| 146 | <thead> |
| 147 | <tr><th>Line</th> |
| 148 | <th><span title="Number of statements executed">State<br />ments</span></th> |
| 149 | <th><span title="Time spend executing statements on the line, |
| 150 | excluding time spent executing statements in any called subroutines">Time<br />on line</span></th> |
| 151 | <th><span title="Number of subroutines calls">Calls</span></th> |
| 152 | <th><span title="Time spent in subroutines called (inclusive)">Time<br />in subs</span></th> |
| 153 | <th class="left_indent_header">Code</th> |
| 154 | </tr> |
| 155 | |
| 156 | </thead> |
| 157 | <tbody> |
| 158 | <tr><td class="h"><a name="1"></a>1</td><td></td><td></td><td></td><td></td><td class="s">package Params::Util;</td></tr> |
| 159 | <tr><td class="h"><a name="2"></a>2</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 160 | <tr><td class="h"><a name="3"></a>3</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 161 | <tr><td class="h"><a name="4"></a>4</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 162 | <tr><td class="h"><a name="5"></a>5</td><td></td><td></td><td></td><td></td><td class="s">=head1 NAME</td></tr> |
| 163 | <tr><td class="h"><a name="6"></a>6</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 164 | <tr><td class="h"><a name="7"></a>7</td><td></td><td></td><td></td><td></td><td class="s">Params::Util - Simple, compact and correct param-checking functions</td></tr> |
| 165 | <tr><td class="h"><a name="8"></a>8</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 166 | <tr><td class="h"><a name="9"></a>9</td><td></td><td></td><td></td><td></td><td class="s">=head1 SYNOPSIS</td></tr> |
| 167 | <tr><td class="h"><a name="10"></a>10</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 168 | <tr><td class="h"><a name="11"></a>11</td><td></td><td></td><td></td><td></td><td class="s"> # Import some functions</td></tr> |
| 169 | <tr><td class="h"><a name="12"></a>12</td><td></td><td></td><td></td><td></td><td class="s"> use Params::Util qw{_SCALAR _HASH _INSTANCE};</td></tr> |
| 170 | <tr><td class="h"><a name="13"></a>13</td><td></td><td></td><td></td><td></td><td class="s"> </td></tr> |
| 171 | <tr><td class="h"><a name="14"></a>14</td><td></td><td></td><td></td><td></td><td class="s"> # If you are lazy, or need a lot of them...</td></tr> |
| 172 | <tr><td class="h"><a name="15"></a>15</td><td></td><td></td><td></td><td></td><td class="s"> use Params::Util ':ALL';</td></tr> |
| 173 | <tr><td class="h"><a name="16"></a>16</td><td></td><td></td><td></td><td></td><td class="s"> </td></tr> |
| 174 | <tr><td class="h"><a name="17"></a>17</td><td></td><td></td><td></td><td></td><td class="s"> sub foo {</td></tr> |
| 175 | <tr><td class="h"><a name="18"></a>18</td><td></td><td></td><td></td><td></td><td class="s"> my $object = _INSTANCE(shift, 'Foo') or return undef;</td></tr> |
| 176 | <tr><td class="h"><a name="19"></a>19</td><td></td><td></td><td></td><td></td><td class="s"> my $image = _SCALAR(shift) or return undef;</td></tr> |
| 177 | <tr><td class="h"><a name="20"></a>20</td><td></td><td></td><td></td><td></td><td class="s"> my $options = _HASH(shift) or return undef;</td></tr> |
| 178 | <tr><td class="h"><a name="21"></a>21</td><td></td><td></td><td></td><td></td><td class="s"> # etc...</td></tr> |
| 179 | <tr><td class="h"><a name="22"></a>22</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 180 | <tr><td class="h"><a name="23"></a>23</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 181 | <tr><td class="h"><a name="24"></a>24</td><td></td><td></td><td></td><td></td><td class="s">=head1 DESCRIPTION</td></tr> |
| 182 | <tr><td class="h"><a name="25"></a>25</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 183 | <tr><td class="h"><a name="26"></a>26</td><td></td><td></td><td></td><td></td><td class="s">C<Params::Util> provides a basic set of importable functions that makes</td></tr> |
| 184 | <tr><td class="h"><a name="27"></a>27</td><td></td><td></td><td></td><td></td><td class="s">checking parameters a hell of a lot easier</td></tr> |
| 185 | <tr><td class="h"><a name="28"></a>28</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 186 | <tr><td class="h"><a name="29"></a>29</td><td></td><td></td><td></td><td></td><td class="s">While they can be (and are) used in other contexts, the main point</td></tr> |
| 187 | <tr><td class="h"><a name="30"></a>30</td><td></td><td></td><td></td><td></td><td class="s">behind this module is that the functions B<both> Do What You Mean,</td></tr> |
| 188 | <tr><td class="h"><a name="31"></a>31</td><td></td><td></td><td></td><td></td><td class="s">and Do The Right Thing, so they are most useful when you are getting</td></tr> |
| 189 | <tr><td class="h"><a name="32"></a>32</td><td></td><td></td><td></td><td></td><td class="s">params passed into your code from someone and/or somewhere else</td></tr> |
| 190 | <tr><td class="h"><a name="33"></a>33</td><td></td><td></td><td></td><td></td><td class="s">and you can't really trust the quality.</td></tr> |
| 191 | <tr><td class="h"><a name="34"></a>34</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 192 | <tr><td class="h"><a name="35"></a>35</td><td></td><td></td><td></td><td></td><td class="s">Thus, C<Params::Util> is of most use at the edges of your API, where</td></tr> |
| 193 | <tr><td class="h"><a name="36"></a>36</td><td></td><td></td><td></td><td></td><td class="s">params and data are coming in from outside your code.</td></tr> |
| 194 | <tr><td class="h"><a name="37"></a>37</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 195 | <tr><td class="h"><a name="38"></a>38</td><td></td><td></td><td></td><td></td><td class="s">The functions provided by C<Params::Util> check in the most strictly</td></tr> |
| 196 | <tr><td class="h"><a name="39"></a>39</td><td></td><td></td><td></td><td></td><td class="s">correct manner known, are documented as thoroughly as possible so their</td></tr> |
| 197 | <tr><td class="h"><a name="40"></a>40</td><td></td><td></td><td></td><td></td><td class="s">exact behaviour is clear, and heavily tested so make sure they are not</td></tr> |
| 198 | <tr><td class="h"><a name="41"></a>41</td><td></td><td></td><td></td><td></td><td class="s">fooled by weird data and Really Bad Things.</td></tr> |
| 199 | <tr><td class="h"><a name="42"></a>42</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 200 | <tr><td class="h"><a name="43"></a>43</td><td></td><td></td><td></td><td></td><td class="s">To use, simply load the module providing the functions you want to use</td></tr> |
| 201 | <tr><td class="h"><a name="44"></a>44</td><td></td><td></td><td></td><td></td><td class="s">as arguments (as shown in the SYNOPSIS).</td></tr> |
| 202 | <tr><td class="h"><a name="45"></a>45</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 203 | <tr><td class="h"><a name="46"></a>46</td><td></td><td></td><td></td><td></td><td class="s">To aid in maintainability, C<Params::Util> will B<never> export by</td></tr> |
| 204 | <tr><td class="h"><a name="47"></a>47</td><td></td><td></td><td></td><td></td><td class="s">default.</td></tr> |
| 205 | <tr><td class="h"><a name="48"></a>48</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 206 | <tr><td class="h"><a name="49"></a>49</td><td></td><td></td><td></td><td></td><td class="s">You must explicitly name the functions you want to export, or use the</td></tr> |
| 207 | <tr><td class="h"><a name="50"></a>50</td><td></td><td></td><td></td><td></td><td class="s">C<:ALL> param to just have it export everything (although this is not</td></tr> |
| 208 | <tr><td class="h"><a name="51"></a>51</td><td></td><td></td><td></td><td></td><td class="s">recommended if you have any _FOO functions yourself with which future</td></tr> |
| 209 | <tr><td class="h"><a name="52"></a>52</td><td></td><td></td><td></td><td></td><td class="s">additions to C<Params::Util> may clash)</td></tr> |
| 210 | <tr><td class="h"><a name="53"></a>53</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 211 | <tr><td class="h"><a name="54"></a>54</td><td></td><td></td><td></td><td></td><td class="s">=head1 FUNCTIONS</td></tr> |
| 212 | <tr><td class="h"><a name="55"></a>55</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 213 | <tr><td class="h"><a name="56"></a>56</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 214 | <tr><td class="h"><a name="57"></a>57</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 215 | <tr><td class="h"><a name="58"></a>58</td><td class="c1">2</td><td class="c0"><span title="Avg 22µs">44µs</span></td><td class="c3">1</td><td class="c3">22µs</td><td class="s"><div class="calls"><div class="calls_in"># spent 22µs within Params::Util::BEGIN@58 which was called: |
| 216 | # once (22µs+0s) by Data::OptList::BEGIN@10 at <a href="Params-Util-pm-70-block.html#58">line 58</a></div></div>use 5.00503;<div class="calls"><div class="calls_out"># spent 22µs making 1 call to <a href="Params-Util-pm-70-block.html#58">Params::Util::BEGIN@58</a></div></div></td></tr> |
| 217 | <tr><td class="h"><a name="59"></a>59</td><td class="c1">2</td><td class="c0"><span title="Avg 18µs">35µs</span></td><td class="c1">2</td><td class="c3">12µs</td><td class="s"><div class="calls"><div class="calls_in"># spent 10µs (7+3) within Params::Util::BEGIN@59 which was called: |
| 218 | # once (7µs+3µs) by Data::OptList::BEGIN@10 at <a href="Params-Util-pm-70-block.html#59">line 59</a></div></div>use strict;<div class="calls"><div class="calls_out"># spent 10µs making 1 call to <a href="Params-Util-pm-70-block.html#59">Params::Util::BEGIN@59</a> |
| 219 | # spent 3µs making 1 call to <a href="strict-pm-3-block.html#34">strict::import</a></div></div></td></tr> |
| 220 | <tr><td class="h"><a name="60"></a>60</td><td class="c3">1</td><td class="c3"><span title="Avg 400ns">400ns</span></td><td></td><td></td><td class="s">require overload;</td></tr> |
| 221 | <tr><td class="h"><a name="61"></a>61</td><td class="c3">1</td><td class="c3"><span title="Avg 100ns">100ns</span></td><td></td><td></td><td class="s">require Exporter;</td></tr> |
| 222 | <tr><td class="h"><a name="62"></a>62</td><td class="c3">1</td><td class="c3"><span title="Avg 200ns">200ns</span></td><td></td><td></td><td class="s">require Scalar::Util;</td></tr> |
| 223 | <tr><td class="h"><a name="63"></a>63</td><td class="c3">1</td><td class="c0"><span title="Avg 127µs">127µs</span></td><td></td><td></td><td class="s">require DynaLoader;</td></tr> |
| 224 | <tr><td class="h"><a name="64"></a>64</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 225 | <tr><td class="h"><a name="65"></a>65</td><td class="c1">2</td><td class="c0"><span title="Avg 322µs">644µs</span></td><td class="c1">2</td><td class="c0">120µs</td><td class="s"><div class="calls"><div class="calls_in"># spent 63µs (6+57) within Params::Util::BEGIN@65 which was called: |
| 226 | # once (6µs+57µs) by Data::OptList::BEGIN@10 at <a href="Params-Util-pm-70-block.html#65">line 65</a></div></div>use vars qw{$VERSION @ISA @EXPORT_OK %EXPORT_TAGS};<div class="calls"><div class="calls_out"># spent 63µs making 1 call to <a href="Params-Util-pm-70-block.html#65">Params::Util::BEGIN@65</a> |
| 227 | # spent 57µs making 1 call to <a href="vars-pm-6-block.html#10">vars::import</a></div></div></td></tr> |
| 228 | <tr><td class="h"><a name="66"></a>66</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 229 | <tr><td class="h"><a name="67"></a>67</td><td class="c3">1</td><td class="c3"><span title="Avg 400ns">400ns</span></td><td></td><td></td><td class="s">$VERSION = '1.07';</td></tr> |
| 230 | <tr><td class="h"><a name="68"></a>68</td><td class="c3">1</td><td class="c3"><span title="Avg 7µs">7µs</span></td><td></td><td></td><td class="s">@ISA = qw{</td></tr> |
| 231 | <tr><td class="h"><a name="69"></a>69</td><td></td><td></td><td></td><td></td><td class="s"> Exporter</td></tr> |
| 232 | <tr><td class="h"><a name="70"></a>70</td><td></td><td></td><td></td><td></td><td class="s"> DynaLoader</td></tr> |
| 233 | <tr><td class="h"><a name="71"></a>71</td><td></td><td></td><td></td><td></td><td class="s">};</td></tr> |
| 234 | <tr><td class="h"><a name="72"></a>72</td><td class="c3">1</td><td class="c3"><span title="Avg 5µs">5µs</span></td><td></td><td></td><td class="s">@EXPORT_OK = qw{</td></tr> |
| 235 | <tr><td class="h"><a name="73"></a>73</td><td></td><td></td><td></td><td></td><td class="s"> _STRING _IDENTIFIER</td></tr> |
| 236 | <tr><td class="h"><a name="74"></a>74</td><td></td><td></td><td></td><td></td><td class="s"> _CLASS _CLASSISA _SUBCLASS _DRIVER _CLASSDOES</td></tr> |
| 237 | <tr><td class="h"><a name="75"></a>75</td><td></td><td></td><td></td><td></td><td class="s"> _NUMBER _POSINT _NONNEGINT</td></tr> |
| 238 | <tr><td class="h"><a name="76"></a>76</td><td></td><td></td><td></td><td></td><td class="s"> _SCALAR _SCALAR0</td></tr> |
| 239 | <tr><td class="h"><a name="77"></a>77</td><td></td><td></td><td></td><td></td><td class="s"> _ARRAY _ARRAY0 _ARRAYLIKE</td></tr> |
| 240 | <tr><td class="h"><a name="78"></a>78</td><td></td><td></td><td></td><td></td><td class="s"> _HASH _HASH0 _HASHLIKE</td></tr> |
| 241 | <tr><td class="h"><a name="79"></a>79</td><td></td><td></td><td></td><td></td><td class="s"> _CODE _CODELIKE</td></tr> |
| 242 | <tr><td class="h"><a name="80"></a>80</td><td></td><td></td><td></td><td></td><td class="s"> _INVOCANT _REGEX _INSTANCE _INSTANCEDOES</td></tr> |
| 243 | <tr><td class="h"><a name="81"></a>81</td><td></td><td></td><td></td><td></td><td class="s"> _SET _SET0</td></tr> |
| 244 | <tr><td class="h"><a name="82"></a>82</td><td></td><td></td><td></td><td></td><td class="s"> _HANDLE</td></tr> |
| 245 | <tr><td class="h"><a name="83"></a>83</td><td></td><td></td><td></td><td></td><td class="s">};</td></tr> |
| 246 | <tr><td class="h"><a name="84"></a>84</td><td class="c3">1</td><td class="c3"><span title="Avg 1µs">1µs</span></td><td></td><td></td><td class="s">%EXPORT_TAGS = ( ALL => \@EXPORT_OK );</td></tr> |
| 247 | <tr><td class="h"><a name="85"></a>85</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 248 | <tr><td class="h"><a name="86"></a>86</td><td class="c0">4</td><td class="c3"><span title="Avg 2µs">8µs</span></td><td></td><td></td><td class="s">eval {</td></tr> |
| 249 | <tr><td class="h"><a name="87"></a>87</td><td></td><td></td><td></td><td></td><td class="s"> local $ENV{PERL_DL_NONLAZY} = 0 if $ENV{PERL_DL_NONLAZY};</td></tr> |
| 250 | <tr><td class="h"><a name="88"></a>88</td><td></td><td></td><td class="c3">1</td><td class="c0">260µs</td><td class="s"> bootstrap Params::Util $VERSION;<div class="calls"><div class="calls_out"> # spent 260µs making 1 call to <a href="DynaLoader-pm-71-block.html#108">DynaLoader::bootstrap</a></div></div></td></tr> |
| 251 | <tr><td class="h"><a name="89"></a>89</td><td></td><td></td><td></td><td></td><td class="s"> 1;</td></tr> |
| 252 | <tr><td class="h"><a name="90"></a>90</td><td></td><td></td><td></td><td></td><td class="s">} unless $ENV{PERL_PARAMS_UTIL_PP};</td></tr> |
| 253 | <tr><td class="h"><a name="91"></a>91</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 254 | <tr><td class="h"><a name="92"></a>92</td><td></td><td></td><td></td><td></td><td class="s"># Use a private pure-perl copy of looks_like_number if the version of</td></tr> |
| 255 | <tr><td class="h"><a name="93"></a>93</td><td></td><td></td><td></td><td></td><td class="s"># Scalar::Util is old (for whatever reason).</td></tr> |
| 256 | <tr><td class="h"><a name="94"></a>94</td><td class="c3">1</td><td class="c1"><span title="Avg 18µs">18µs</span></td><td></td><td></td><td class="s">my $SU = eval "$Scalar::Util::VERSION" || 0;<div class="calls"><div class="calls_out"># spent 2µs executing statements in <a href="(eval 19)[Params-Util-pm-94]-72-line.html">string eval</a></div></div></td></tr> |
| 257 | <tr><td class="h"><a name="95"></a>95</td><td class="c3">1</td><td class="c3"><span title="Avg 3µs">3µs</span></td><td class="c3">1</td><td class="c3">29µs</td><td class="s">if ( $SU >= 1.18 ) { <div class="calls"><div class="calls_out"># spent 29µs making 1 call to <a href="Exporter-pm-8-block.html#28">Exporter::import</a></div></div></td></tr> |
| 258 | <tr><td class="h"><a name="96"></a>96</td><td></td><td></td><td></td><td></td><td class="s"> Scalar::Util->import('looks_like_number');</td></tr> |
| 259 | <tr><td class="h"><a name="97"></a>97</td><td></td><td></td><td></td><td></td><td class="s">} else {</td></tr> |
| 260 | <tr><td class="h"><a name="98"></a>98</td><td></td><td></td><td></td><td></td><td class="s"> eval <<'END_PERL';</td></tr> |
| 261 | <tr><td class="h"><a name="99"></a>99</td><td></td><td></td><td></td><td></td><td class="s">sub looks_like_number {</td></tr> |
| 262 | <tr><td class="h"><a name="100"></a>100</td><td></td><td></td><td></td><td></td><td class="s"> local $_ = shift;</td></tr> |
| 263 | <tr><td class="h"><a name="101"></a>101</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 264 | <tr><td class="h"><a name="102"></a>102</td><td></td><td></td><td></td><td></td><td class="s"> # checks from perlfaq4</td></tr> |
| 265 | <tr><td class="h"><a name="103"></a>103</td><td></td><td></td><td></td><td></td><td class="s"> return 0 if !defined($_);</td></tr> |
| 266 | <tr><td class="h"><a name="104"></a>104</td><td></td><td></td><td></td><td></td><td class="s"> if (ref($_)) {</td></tr> |
| 267 | <tr><td class="h"><a name="105"></a>105</td><td></td><td></td><td></td><td></td><td class="s"> return overload::Overloaded($_) ? defined(0 + $_) : 0;</td></tr> |
| 268 | <tr><td class="h"><a name="106"></a>106</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 269 | <tr><td class="h"><a name="107"></a>107</td><td></td><td></td><td></td><td></td><td class="s"> return 1 if (/^[+-]?[0-9]+$/); # is a +/- integer</td></tr> |
| 270 | <tr><td class="h"><a name="108"></a>108</td><td></td><td></td><td></td><td></td><td class="s"> return 1 if (/^([+-]?)(?=[0-9]|\.[0-9])[0-9]*(\.[0-9]*)?([Ee]([+-]?[0-9]+))?$/); # a C float</td></tr> |
| 271 | <tr><td class="h"><a name="109"></a>109</td><td></td><td></td><td></td><td></td><td class="s"> return 1 if ($] >= 5.008 and /^(Inf(inity)?|NaN)$/i) or ($] >= 5.006001 and /^Inf$/i);</td></tr> |
| 272 | <tr><td class="h"><a name="110"></a>110</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 273 | <tr><td class="h"><a name="111"></a>111</td><td></td><td></td><td></td><td></td><td class="s"> 0;</td></tr> |
| 274 | <tr><td class="h"><a name="112"></a>112</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 275 | <tr><td class="h"><a name="113"></a>113</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 276 | <tr><td class="h"><a name="114"></a>114</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 277 | <tr><td class="h"><a name="115"></a>115</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 278 | <tr><td class="h"><a name="- -"></a>- -</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 279 | <tr><td class="h"><a name="120"></a>120</td><td></td><td></td><td></td><td></td><td class="s">#####################################################################</td></tr> |
| 280 | <tr><td class="h"><a name="121"></a>121</td><td></td><td></td><td></td><td></td><td class="s"># Param Checking Functions</td></tr> |
| 281 | <tr><td class="h"><a name="122"></a>122</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 282 | <tr><td class="h"><a name="123"></a>123</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 283 | <tr><td class="h"><a name="124"></a>124</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 284 | <tr><td class="h"><a name="125"></a>125</td><td></td><td></td><td></td><td></td><td class="s">=head2 _STRING $string</td></tr> |
| 285 | <tr><td class="h"><a name="126"></a>126</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 286 | <tr><td class="h"><a name="127"></a>127</td><td></td><td></td><td></td><td></td><td class="s">The C<_STRING> function is intended to be imported into your</td></tr> |
| 287 | <tr><td class="h"><a name="128"></a>128</td><td></td><td></td><td></td><td></td><td class="s">package, and provides a convenient way to test to see if a value is</td></tr> |
| 288 | <tr><td class="h"><a name="129"></a>129</td><td></td><td></td><td></td><td></td><td class="s">a normal non-false string of non-zero length.</td></tr> |
| 289 | <tr><td class="h"><a name="130"></a>130</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 290 | <tr><td class="h"><a name="131"></a>131</td><td></td><td></td><td></td><td></td><td class="s">Note that this will NOT do anything magic to deal with the special</td></tr> |
| 291 | <tr><td class="h"><a name="132"></a>132</td><td></td><td></td><td></td><td></td><td class="s">C<'0'> false negative case, but will return it.</td></tr> |
| 292 | <tr><td class="h"><a name="133"></a>133</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 293 | <tr><td class="h"><a name="134"></a>134</td><td></td><td></td><td></td><td></td><td class="s"> # '0' not considered valid data</td></tr> |
| 294 | <tr><td class="h"><a name="135"></a>135</td><td></td><td></td><td></td><td></td><td class="s"> my $name = _STRING(shift) or die "Bad name";</td></tr> |
| 295 | <tr><td class="h"><a name="136"></a>136</td><td></td><td></td><td></td><td></td><td class="s"> </td></tr> |
| 296 | <tr><td class="h"><a name="137"></a>137</td><td></td><td></td><td></td><td></td><td class="s"> # '0' is considered valid data</td></tr> |
| 297 | <tr><td class="h"><a name="138"></a>138</td><td></td><td></td><td></td><td></td><td class="s"> my $string = _STRING($_[0]) ? shift : die "Bad string";</td></tr> |
| 298 | <tr><td class="h"><a name="139"></a>139</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 299 | <tr><td class="h"><a name="140"></a>140</td><td></td><td></td><td></td><td></td><td class="s">Please also note that this function expects a normal string. It does</td></tr> |
| 300 | <tr><td class="h"><a name="141"></a>141</td><td></td><td></td><td></td><td></td><td class="s">not support overloading or other magic techniques to get a string.</td></tr> |
| 301 | <tr><td class="h"><a name="142"></a>142</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 302 | <tr><td class="h"><a name="143"></a>143</td><td></td><td></td><td></td><td></td><td class="s">Returns the string as a conveince if it is a valid string, or</td></tr> |
| 303 | <tr><td class="h"><a name="144"></a>144</td><td></td><td></td><td></td><td></td><td class="s">C<undef> if not.</td></tr> |
| 304 | <tr><td class="h"><a name="145"></a>145</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 305 | <tr><td class="h"><a name="146"></a>146</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 306 | <tr><td class="h"><a name="147"></a>147</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 307 | <tr><td class="h"><a name="148"></a>148</td><td class="c3">1</td><td class="c3"><span title="Avg 300ns">300ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_STRING;</td></tr> |
| 308 | <tr><td class="h"><a name="149"></a>149</td><td></td><td></td><td></td><td></td><td class="s">sub _STRING ($) {</td></tr> |
| 309 | <tr><td class="h"><a name="150"></a>150</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and ! ref $_[0] and length($_[0])) ? $_[0] : undef;</td></tr> |
| 310 | <tr><td class="h"><a name="151"></a>151</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 311 | <tr><td class="h"><a name="152"></a>152</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 312 | <tr><td class="h"><a name="153"></a>153</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 313 | <tr><td class="h"><a name="154"></a>154</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 314 | <tr><td class="h"><a name="155"></a>155</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 315 | <tr><td class="h"><a name="156"></a>156</td><td></td><td></td><td></td><td></td><td class="s">=head2 _IDENTIFIER $string</td></tr> |
| 316 | <tr><td class="h"><a name="157"></a>157</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 317 | <tr><td class="h"><a name="158"></a>158</td><td></td><td></td><td></td><td></td><td class="s">The C<_IDENTIFIER> function is intended to be imported into your</td></tr> |
| 318 | <tr><td class="h"><a name="159"></a>159</td><td></td><td></td><td></td><td></td><td class="s">package, and provides a convenient way to test to see if a value is</td></tr> |
| 319 | <tr><td class="h"><a name="160"></a>160</td><td></td><td></td><td></td><td></td><td class="s">a string that is a valid Perl identifier.</td></tr> |
| 320 | <tr><td class="h"><a name="161"></a>161</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 321 | <tr><td class="h"><a name="162"></a>162</td><td></td><td></td><td></td><td></td><td class="s">Returns the string as a convenience if it is a valid identifier, or</td></tr> |
| 322 | <tr><td class="h"><a name="163"></a>163</td><td></td><td></td><td></td><td></td><td class="s">C<undef> if not.</td></tr> |
| 323 | <tr><td class="h"><a name="164"></a>164</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 324 | <tr><td class="h"><a name="165"></a>165</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 325 | <tr><td class="h"><a name="166"></a>166</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 326 | <tr><td class="h"><a name="167"></a>167</td><td class="c3">1</td><td class="c0"><span title="Avg 60µs">60µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_IDENTIFIER;</td></tr> |
| 327 | <tr><td class="h"><a name="168"></a>168</td><td></td><td></td><td></td><td></td><td class="s">sub _IDENTIFIER ($) {</td></tr> |
| 328 | <tr><td class="h"><a name="169"></a>169</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and ! ref $_[0] and $_[0] =~ m/^[^\W\d]\w*\z/s) ? $_[0] : undef;</td></tr> |
| 329 | <tr><td class="h"><a name="170"></a>170</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 330 | <tr><td class="h"><a name="171"></a>171</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 331 | <tr><td class="h"><a name="172"></a>172</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 332 | <tr><td class="h"><a name="173"></a>173</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 333 | <tr><td class="h"><a name="174"></a>174</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 334 | <tr><td class="h"><a name="175"></a>175</td><td></td><td></td><td></td><td></td><td class="s">=head2 _CLASS $string</td></tr> |
| 335 | <tr><td class="h"><a name="176"></a>176</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 336 | <tr><td class="h"><a name="177"></a>177</td><td></td><td></td><td></td><td></td><td class="s">The C<_CLASS> function is intended to be imported into your</td></tr> |
| 337 | <tr><td class="h"><a name="178"></a>178</td><td></td><td></td><td></td><td></td><td class="s">package, and provides a convenient way to test to see if a value is</td></tr> |
| 338 | <tr><td class="h"><a name="179"></a>179</td><td></td><td></td><td></td><td></td><td class="s">a string that is a valid Perl class.</td></tr> |
| 339 | <tr><td class="h"><a name="180"></a>180</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 340 | <tr><td class="h"><a name="181"></a>181</td><td></td><td></td><td></td><td></td><td class="s">This function only checks that the format is valid, not that the</td></tr> |
| 341 | <tr><td class="h"><a name="182"></a>182</td><td></td><td></td><td></td><td></td><td class="s">class is actually loaded. It also assumes "normalised" form, and does</td></tr> |
| 342 | <tr><td class="h"><a name="183"></a>183</td><td></td><td></td><td></td><td></td><td class="s">not accept class names such as C<::Foo> or C<D'Oh>.</td></tr> |
| 343 | <tr><td class="h"><a name="184"></a>184</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 344 | <tr><td class="h"><a name="185"></a>185</td><td></td><td></td><td></td><td></td><td class="s">Returns the string as a convenience if it is a valid class name, or</td></tr> |
| 345 | <tr><td class="h"><a name="186"></a>186</td><td></td><td></td><td></td><td></td><td class="s">C<undef> if not.</td></tr> |
| 346 | <tr><td class="h"><a name="187"></a>187</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 347 | <tr><td class="h"><a name="188"></a>188</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 348 | <tr><td class="h"><a name="189"></a>189</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 349 | <tr><td class="h"><a name="190"></a>190</td><td class="c3">1</td><td class="c0"><span title="Avg 57µs">57µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_CLASS;<div class="calls"><div class="calls_out"># spent 260µs executing statements in <a href="(eval 21)[Params-Util-pm-190]-1291-line.html">string eval</a><br /># includes 135µs spent executing 32 calls to 1 sub defined therein.</div></div></td></tr> |
| 350 | <tr><td class="h"><a name="191"></a>191</td><td></td><td></td><td></td><td></td><td class="s">sub _CLASS ($) {</td></tr> |
| 351 | <tr><td class="h"><a name="192"></a>192</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and ! ref $_[0] and $_[0] =~ m/^[^\W\d]\w*(?:::\w+)*\z/s) ? $_[0] : undef;</td></tr> |
| 352 | <tr><td class="h"><a name="193"></a>193</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 353 | <tr><td class="h"><a name="194"></a>194</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 354 | <tr><td class="h"><a name="195"></a>195</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 355 | <tr><td class="h"><a name="196"></a>196</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 356 | <tr><td class="h"><a name="197"></a>197</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 357 | <tr><td class="h"><a name="198"></a>198</td><td></td><td></td><td></td><td></td><td class="s">=head2 _CLASSISA $string, $class</td></tr> |
| 358 | <tr><td class="h"><a name="199"></a>199</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 359 | <tr><td class="h"><a name="200"></a>200</td><td></td><td></td><td></td><td></td><td class="s">The C<_CLASSISA> function is intended to be imported into your</td></tr> |
| 360 | <tr><td class="h"><a name="201"></a>201</td><td></td><td></td><td></td><td></td><td class="s">package, and provides a convenient way to test to see if a value is</td></tr> |
| 361 | <tr><td class="h"><a name="202"></a>202</td><td></td><td></td><td></td><td></td><td class="s">a string that is a particularly class, or a subclass of it.</td></tr> |
| 362 | <tr><td class="h"><a name="203"></a>203</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 363 | <tr><td class="h"><a name="204"></a>204</td><td></td><td></td><td></td><td></td><td class="s">This function checks that the format is valid and calls the -E<gt>isa</td></tr> |
| 364 | <tr><td class="h"><a name="205"></a>205</td><td></td><td></td><td></td><td></td><td class="s">method on the class name. It does not check that the class is actually</td></tr> |
| 365 | <tr><td class="h"><a name="206"></a>206</td><td></td><td></td><td></td><td></td><td class="s">loaded.</td></tr> |
| 366 | <tr><td class="h"><a name="207"></a>207</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 367 | <tr><td class="h"><a name="208"></a>208</td><td></td><td></td><td></td><td></td><td class="s">It also assumes "normalised" form, and does</td></tr> |
| 368 | <tr><td class="h"><a name="209"></a>209</td><td></td><td></td><td></td><td></td><td class="s">not accept class names such as C<::Foo> or C<D'Oh>.</td></tr> |
| 369 | <tr><td class="h"><a name="210"></a>210</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 370 | <tr><td class="h"><a name="211"></a>211</td><td></td><td></td><td></td><td></td><td class="s">Returns the string as a convenience if it is a valid class name, or</td></tr> |
| 371 | <tr><td class="h"><a name="212"></a>212</td><td></td><td></td><td></td><td></td><td class="s">C<undef> if not.</td></tr> |
| 372 | <tr><td class="h"><a name="213"></a>213</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 373 | <tr><td class="h"><a name="214"></a>214</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 374 | <tr><td class="h"><a name="215"></a>215</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 375 | <tr><td class="h"><a name="216"></a>216</td><td class="c3">1</td><td class="c0"><span title="Avg 58µs">58µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_CLASSISA;</td></tr> |
| 376 | <tr><td class="h"><a name="217"></a>217</td><td></td><td></td><td></td><td></td><td class="s">sub _CLASSISA ($$) {</td></tr> |
| 377 | <tr><td class="h"><a name="218"></a>218</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and ! ref $_[0] and $_[0] =~ m/^[^\W\d]\w*(?:::\w+)*\z/s and $_[0]->isa($_[1])) ? $_[0] : undef;</td></tr> |
| 378 | <tr><td class="h"><a name="219"></a>219</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 379 | <tr><td class="h"><a name="220"></a>220</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 380 | <tr><td class="h"><a name="221"></a>221</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 381 | <tr><td class="h"><a name="222"></a>222</td><td></td><td></td><td></td><td></td><td class="s">=head2 _CLASSDOES $string, $role</td></tr> |
| 382 | <tr><td class="h"><a name="223"></a>223</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 383 | <tr><td class="h"><a name="224"></a>224</td><td></td><td></td><td></td><td></td><td class="s">This routine behaves exactly like C<L</_CLASSISA>>, but checks with C<< ->DOES</td></tr> |
| 384 | <tr><td class="h"><a name="225"></a>225</td><td></td><td></td><td></td><td></td><td class="s">>> rather than C<< ->isa >>. This is probably only a good idea to use on Perl</td></tr> |
| 385 | <tr><td class="h"><a name="226"></a>226</td><td></td><td></td><td></td><td></td><td class="s">5.10 or later, when L<UNIVERSAL::DOES|UNIVERSAL::DOES/DOES> has been</td></tr> |
| 386 | <tr><td class="h"><a name="227"></a>227</td><td></td><td></td><td></td><td></td><td class="s">implemented.</td></tr> |
| 387 | <tr><td class="h"><a name="228"></a>228</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 388 | <tr><td class="h"><a name="229"></a>229</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 389 | <tr><td class="h"><a name="230"></a>230</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 390 | <tr><td class="h"><a name="231"></a>231</td><td class="c3">1</td><td class="c0"><span title="Avg 64µs">64µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_CLASSDOES;</td></tr> |
| 391 | <tr><td class="h"><a name="232"></a>232</td><td></td><td></td><td></td><td></td><td class="s">sub _CLASSDOES ($$) {</td></tr> |
| 392 | <tr><td class="h"><a name="233"></a>233</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and ! ref $_[0] and $_[0] =~ m/^[^\W\d]\w*(?:::\w+)*\z/s and $_[0]->DOES($_[1])) ? $_[0] : undef;</td></tr> |
| 393 | <tr><td class="h"><a name="234"></a>234</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 394 | <tr><td class="h"><a name="235"></a>235</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 395 | <tr><td class="h"><a name="236"></a>236</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 396 | <tr><td class="h"><a name="237"></a>237</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 397 | <tr><td class="h"><a name="238"></a>238</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 398 | <tr><td class="h"><a name="239"></a>239</td><td></td><td></td><td></td><td></td><td class="s">=head2 _SUBCLASS $string, $class</td></tr> |
| 399 | <tr><td class="h"><a name="240"></a>240</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 400 | <tr><td class="h"><a name="241"></a>241</td><td></td><td></td><td></td><td></td><td class="s">The C<_SUBCLASS> function is intended to be imported into your</td></tr> |
| 401 | <tr><td class="h"><a name="242"></a>242</td><td></td><td></td><td></td><td></td><td class="s">package, and provides a convenient way to test to see if a value is</td></tr> |
| 402 | <tr><td class="h"><a name="243"></a>243</td><td></td><td></td><td></td><td></td><td class="s">a string that is a subclass of a specified class.</td></tr> |
| 403 | <tr><td class="h"><a name="244"></a>244</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 404 | <tr><td class="h"><a name="245"></a>245</td><td></td><td></td><td></td><td></td><td class="s">This function checks that the format is valid and calls the -E<gt>isa</td></tr> |
| 405 | <tr><td class="h"><a name="246"></a>246</td><td></td><td></td><td></td><td></td><td class="s">method on the class name. It does not check that the class is actually</td></tr> |
| 406 | <tr><td class="h"><a name="247"></a>247</td><td></td><td></td><td></td><td></td><td class="s">loaded.</td></tr> |
| 407 | <tr><td class="h"><a name="248"></a>248</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 408 | <tr><td class="h"><a name="249"></a>249</td><td></td><td></td><td></td><td></td><td class="s">It also assumes "normalised" form, and does</td></tr> |
| 409 | <tr><td class="h"><a name="250"></a>250</td><td></td><td></td><td></td><td></td><td class="s">not accept class names such as C<::Foo> or C<D'Oh>.</td></tr> |
| 410 | <tr><td class="h"><a name="251"></a>251</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 411 | <tr><td class="h"><a name="252"></a>252</td><td></td><td></td><td></td><td></td><td class="s">Returns the string as a convenience if it is a valid class name, or</td></tr> |
| 412 | <tr><td class="h"><a name="253"></a>253</td><td></td><td></td><td></td><td></td><td class="s">C<undef> if not.</td></tr> |
| 413 | <tr><td class="h"><a name="254"></a>254</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 414 | <tr><td class="h"><a name="255"></a>255</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 415 | <tr><td class="h"><a name="256"></a>256</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 416 | <tr><td class="h"><a name="257"></a>257</td><td class="c3">1</td><td class="c0"><span title="Avg 63µs">63µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_SUBCLASS;</td></tr> |
| 417 | <tr><td class="h"><a name="258"></a>258</td><td></td><td></td><td></td><td></td><td class="s">sub _SUBCLASS ($$) {</td></tr> |
| 418 | <tr><td class="h"><a name="259"></a>259</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and ! ref $_[0] and $_[0] =~ m/^[^\W\d]\w*(?:::\w+)*\z/s and $_[0] ne $_[1] and $_[0]->isa($_[1])) ? $_[0] : undef;</td></tr> |
| 419 | <tr><td class="h"><a name="260"></a>260</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 420 | <tr><td class="h"><a name="261"></a>261</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 421 | <tr><td class="h"><a name="262"></a>262</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 422 | <tr><td class="h"><a name="263"></a>263</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 423 | <tr><td class="h"><a name="264"></a>264</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 424 | <tr><td class="h"><a name="265"></a>265</td><td></td><td></td><td></td><td></td><td class="s">=head2 _NUMBER $scalar</td></tr> |
| 425 | <tr><td class="h"><a name="266"></a>266</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 426 | <tr><td class="h"><a name="267"></a>267</td><td></td><td></td><td></td><td></td><td class="s">The C<_NUMBER> function is intended to be imported into your</td></tr> |
| 427 | <tr><td class="h"><a name="268"></a>268</td><td></td><td></td><td></td><td></td><td class="s">package, and provides a convenient way to test to see if a value is</td></tr> |
| 428 | <tr><td class="h"><a name="269"></a>269</td><td></td><td></td><td></td><td></td><td class="s">a number. That is, it is defined and perl thinks it's a number.</td></tr> |
| 429 | <tr><td class="h"><a name="270"></a>270</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 430 | <tr><td class="h"><a name="271"></a>271</td><td></td><td></td><td></td><td></td><td class="s">This function is basically a Params::Util-style wrapper around the</td></tr> |
| 431 | <tr><td class="h"><a name="272"></a>272</td><td></td><td></td><td></td><td></td><td class="s">L<Scalar::Util> C<looks_like_number> function.</td></tr> |
| 432 | <tr><td class="h"><a name="273"></a>273</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 433 | <tr><td class="h"><a name="274"></a>274</td><td></td><td></td><td></td><td></td><td class="s">Returns the value as a convience, or C<undef> if the value is not a</td></tr> |
| 434 | <tr><td class="h"><a name="275"></a>275</td><td></td><td></td><td></td><td></td><td class="s">number.</td></tr> |
| 435 | <tr><td class="h"><a name="276"></a>276</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 436 | <tr><td class="h"><a name="277"></a>277</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 437 | <tr><td class="h"><a name="278"></a>278</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 438 | <tr><td class="h"><a name="279"></a>279</td><td class="c3">1</td><td class="c3"><span title="Avg 400ns">400ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_NUMBER;</td></tr> |
| 439 | <tr><td class="h"><a name="280"></a>280</td><td></td><td></td><td></td><td></td><td class="s">sub _NUMBER ($) {</td></tr> |
| 440 | <tr><td class="h"><a name="281"></a>281</td><td></td><td></td><td></td><td></td><td class="s"> ( defined $_[0] and ! ref $_[0] and looks_like_number($_[0]) )</td></tr> |
| 441 | <tr><td class="h"><a name="282"></a>282</td><td></td><td></td><td></td><td></td><td class="s"> ? $_[0]</td></tr> |
| 442 | <tr><td class="h"><a name="283"></a>283</td><td></td><td></td><td></td><td></td><td class="s"> : undef;</td></tr> |
| 443 | <tr><td class="h"><a name="284"></a>284</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 444 | <tr><td class="h"><a name="285"></a>285</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 445 | <tr><td class="h"><a name="286"></a>286</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 446 | <tr><td class="h"><a name="287"></a>287</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 447 | <tr><td class="h"><a name="288"></a>288</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 448 | <tr><td class="h"><a name="289"></a>289</td><td></td><td></td><td></td><td></td><td class="s">=head2 _POSINT $integer</td></tr> |
| 449 | <tr><td class="h"><a name="290"></a>290</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 450 | <tr><td class="h"><a name="291"></a>291</td><td></td><td></td><td></td><td></td><td class="s">The C<_POSINT> function is intended to be imported into your</td></tr> |
| 451 | <tr><td class="h"><a name="292"></a>292</td><td></td><td></td><td></td><td></td><td class="s">package, and provides a convenient way to test to see if a value is</td></tr> |
| 452 | <tr><td class="h"><a name="293"></a>293</td><td></td><td></td><td></td><td></td><td class="s">a positive integer (of any length).</td></tr> |
| 453 | <tr><td class="h"><a name="294"></a>294</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 454 | <tr><td class="h"><a name="295"></a>295</td><td></td><td></td><td></td><td></td><td class="s">Returns the value as a convience, or C<undef> if the value is not a</td></tr> |
| 455 | <tr><td class="h"><a name="296"></a>296</td><td></td><td></td><td></td><td></td><td class="s">positive integer.</td></tr> |
| 456 | <tr><td class="h"><a name="297"></a>297</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 457 | <tr><td class="h"><a name="298"></a>298</td><td></td><td></td><td></td><td></td><td class="s">The name itself is derived from the XML schema constraint of the same</td></tr> |
| 458 | <tr><td class="h"><a name="299"></a>299</td><td></td><td></td><td></td><td></td><td class="s">name.</td></tr> |
| 459 | <tr><td class="h"><a name="300"></a>300</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 460 | <tr><td class="h"><a name="301"></a>301</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 461 | <tr><td class="h"><a name="302"></a>302</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 462 | <tr><td class="h"><a name="303"></a>303</td><td class="c3">1</td><td class="c0"><span title="Avg 58µs">58µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_POSINT;</td></tr> |
| 463 | <tr><td class="h"><a name="304"></a>304</td><td></td><td></td><td></td><td></td><td class="s">sub _POSINT ($) {</td></tr> |
| 464 | <tr><td class="h"><a name="305"></a>305</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and ! ref $_[0] and $_[0] =~ m/^[1-9]\d*$/) ? $_[0] : undef;</td></tr> |
| 465 | <tr><td class="h"><a name="306"></a>306</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 466 | <tr><td class="h"><a name="307"></a>307</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 467 | <tr><td class="h"><a name="308"></a>308</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 468 | <tr><td class="h"><a name="309"></a>309</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 469 | <tr><td class="h"><a name="310"></a>310</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 470 | <tr><td class="h"><a name="311"></a>311</td><td></td><td></td><td></td><td></td><td class="s">=head2 _NONNEGINT $integer</td></tr> |
| 471 | <tr><td class="h"><a name="312"></a>312</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 472 | <tr><td class="h"><a name="313"></a>313</td><td></td><td></td><td></td><td></td><td class="s">The C<_NONNEGINT> function is intended to be imported into your</td></tr> |
| 473 | <tr><td class="h"><a name="314"></a>314</td><td></td><td></td><td></td><td></td><td class="s">package, and provides a convenient way to test to see if a value is</td></tr> |
| 474 | <tr><td class="h"><a name="315"></a>315</td><td></td><td></td><td></td><td></td><td class="s">a non-negative integer (of any length). That is, a positive integer,</td></tr> |
| 475 | <tr><td class="h"><a name="316"></a>316</td><td></td><td></td><td></td><td></td><td class="s">or zero.</td></tr> |
| 476 | <tr><td class="h"><a name="317"></a>317</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 477 | <tr><td class="h"><a name="318"></a>318</td><td></td><td></td><td></td><td></td><td class="s">Returns the value as a convience, or C<undef> if the value is not a</td></tr> |
| 478 | <tr><td class="h"><a name="319"></a>319</td><td></td><td></td><td></td><td></td><td class="s">non-negative integer.</td></tr> |
| 479 | <tr><td class="h"><a name="320"></a>320</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 480 | <tr><td class="h"><a name="321"></a>321</td><td></td><td></td><td></td><td></td><td class="s">As with other tests that may return false values, care should be taken</td></tr> |
| 481 | <tr><td class="h"><a name="322"></a>322</td><td></td><td></td><td></td><td></td><td class="s">to test via "defined" in boolean validy contexts.</td></tr> |
| 482 | <tr><td class="h"><a name="323"></a>323</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 483 | <tr><td class="h"><a name="324"></a>324</td><td></td><td></td><td></td><td></td><td class="s"> unless ( defined _NONNEGINT($value) ) {</td></tr> |
| 484 | <tr><td class="h"><a name="325"></a>325</td><td></td><td></td><td></td><td></td><td class="s"> die "Invalid value";</td></tr> |
| 485 | <tr><td class="h"><a name="326"></a>326</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 486 | <tr><td class="h"><a name="327"></a>327</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 487 | <tr><td class="h"><a name="328"></a>328</td><td></td><td></td><td></td><td></td><td class="s">The name itself is derived from the XML schema constraint of the same</td></tr> |
| 488 | <tr><td class="h"><a name="329"></a>329</td><td></td><td></td><td></td><td></td><td class="s">name.</td></tr> |
| 489 | <tr><td class="h"><a name="330"></a>330</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 490 | <tr><td class="h"><a name="331"></a>331</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 491 | <tr><td class="h"><a name="332"></a>332</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 492 | <tr><td class="h"><a name="333"></a>333</td><td class="c3">1</td><td class="c0"><span title="Avg 50µs">50µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_NONNEGINT;</td></tr> |
| 493 | <tr><td class="h"><a name="334"></a>334</td><td></td><td></td><td></td><td></td><td class="s">sub _NONNEGINT ($) {</td></tr> |
| 494 | <tr><td class="h"><a name="335"></a>335</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and ! ref $_[0] and $_[0] =~ m/^(?:0|[1-9]\d*)$/) ? $_[0] : undef;</td></tr> |
| 495 | <tr><td class="h"><a name="336"></a>336</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 496 | <tr><td class="h"><a name="337"></a>337</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 497 | <tr><td class="h"><a name="338"></a>338</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 498 | <tr><td class="h"><a name="339"></a>339</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 499 | <tr><td class="h"><a name="340"></a>340</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 500 | <tr><td class="h"><a name="341"></a>341</td><td></td><td></td><td></td><td></td><td class="s">=head2 _SCALAR \$scalar</td></tr> |
| 501 | <tr><td class="h"><a name="342"></a>342</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 502 | <tr><td class="h"><a name="343"></a>343</td><td></td><td></td><td></td><td></td><td class="s">The C<_SCALAR> function is intended to be imported into your package,</td></tr> |
| 503 | <tr><td class="h"><a name="344"></a>344</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test for a raw and unblessed</td></tr> |
| 504 | <tr><td class="h"><a name="345"></a>345</td><td></td><td></td><td></td><td></td><td class="s">C<SCALAR> reference, with content of non-zero length.</td></tr> |
| 505 | <tr><td class="h"><a name="346"></a>346</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 506 | <tr><td class="h"><a name="347"></a>347</td><td></td><td></td><td></td><td></td><td class="s">For a version that allows zero length C<SCALAR> references, see</td></tr> |
| 507 | <tr><td class="h"><a name="348"></a>348</td><td></td><td></td><td></td><td></td><td class="s">the C<_SCALAR0> function.</td></tr> |
| 508 | <tr><td class="h"><a name="349"></a>349</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 509 | <tr><td class="h"><a name="350"></a>350</td><td></td><td></td><td></td><td></td><td class="s">Returns the C<SCALAR> reference itself as a convenience, or C<undef></td></tr> |
| 510 | <tr><td class="h"><a name="351"></a>351</td><td></td><td></td><td></td><td></td><td class="s">if the value provided is not a C<SCALAR> reference.</td></tr> |
| 511 | <tr><td class="h"><a name="352"></a>352</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 512 | <tr><td class="h"><a name="353"></a>353</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 513 | <tr><td class="h"><a name="354"></a>354</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 514 | <tr><td class="h"><a name="355"></a>355</td><td class="c3">1</td><td class="c3"><span title="Avg 300ns">300ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_SCALAR;</td></tr> |
| 515 | <tr><td class="h"><a name="356"></a>356</td><td></td><td></td><td></td><td></td><td class="s">sub _SCALAR ($) {</td></tr> |
| 516 | <tr><td class="h"><a name="357"></a>357</td><td></td><td></td><td></td><td></td><td class="s"> (ref $_[0] eq 'SCALAR' and defined ${$_[0]} and ${$_[0]} ne '') ? $_[0] : undef;</td></tr> |
| 517 | <tr><td class="h"><a name="358"></a>358</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 518 | <tr><td class="h"><a name="359"></a>359</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 519 | <tr><td class="h"><a name="360"></a>360</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 520 | <tr><td class="h"><a name="361"></a>361</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 521 | <tr><td class="h"><a name="362"></a>362</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 522 | <tr><td class="h"><a name="363"></a>363</td><td></td><td></td><td></td><td></td><td class="s">=head2 _SCALAR0 \$scalar</td></tr> |
| 523 | <tr><td class="h"><a name="364"></a>364</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 524 | <tr><td class="h"><a name="365"></a>365</td><td></td><td></td><td></td><td></td><td class="s">The C<_SCALAR0> function is intended to be imported into your package,</td></tr> |
| 525 | <tr><td class="h"><a name="366"></a>366</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test for a raw and unblessed</td></tr> |
| 526 | <tr><td class="h"><a name="367"></a>367</td><td></td><td></td><td></td><td></td><td class="s">C<SCALAR0> reference, allowing content of zero-length.</td></tr> |
| 527 | <tr><td class="h"><a name="368"></a>368</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 528 | <tr><td class="h"><a name="369"></a>369</td><td></td><td></td><td></td><td></td><td class="s">For a simpler "give me some content" version that requires non-zero</td></tr> |
| 529 | <tr><td class="h"><a name="370"></a>370</td><td></td><td></td><td></td><td></td><td class="s">length, C<_SCALAR> function.</td></tr> |
| 530 | <tr><td class="h"><a name="371"></a>371</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 531 | <tr><td class="h"><a name="372"></a>372</td><td></td><td></td><td></td><td></td><td class="s">Returns the C<SCALAR> reference itself as a convenience, or C<undef></td></tr> |
| 532 | <tr><td class="h"><a name="373"></a>373</td><td></td><td></td><td></td><td></td><td class="s">if the value provided is not a C<SCALAR> reference.</td></tr> |
| 533 | <tr><td class="h"><a name="374"></a>374</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 534 | <tr><td class="h"><a name="375"></a>375</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 535 | <tr><td class="h"><a name="376"></a>376</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 536 | <tr><td class="h"><a name="377"></a>377</td><td class="c3">1</td><td class="c3"><span title="Avg 100ns">100ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_SCALAR0;</td></tr> |
| 537 | <tr><td class="h"><a name="378"></a>378</td><td></td><td></td><td></td><td></td><td class="s">sub _SCALAR0 ($) {</td></tr> |
| 538 | <tr><td class="h"><a name="379"></a>379</td><td></td><td></td><td></td><td></td><td class="s"> ref $_[0] eq 'SCALAR' ? $_[0] : undef;</td></tr> |
| 539 | <tr><td class="h"><a name="380"></a>380</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 540 | <tr><td class="h"><a name="381"></a>381</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 541 | <tr><td class="h"><a name="382"></a>382</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 542 | <tr><td class="h"><a name="383"></a>383</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 543 | <tr><td class="h"><a name="384"></a>384</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 544 | <tr><td class="h"><a name="385"></a>385</td><td></td><td></td><td></td><td></td><td class="s">=head2 _ARRAY $value</td></tr> |
| 545 | <tr><td class="h"><a name="386"></a>386</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 546 | <tr><td class="h"><a name="387"></a>387</td><td></td><td></td><td></td><td></td><td class="s">The C<_ARRAY> function is intended to be imported into your package,</td></tr> |
| 547 | <tr><td class="h"><a name="388"></a>388</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test for a raw and unblessed</td></tr> |
| 548 | <tr><td class="h"><a name="389"></a>389</td><td></td><td></td><td></td><td></td><td class="s">C<ARRAY> reference containing B<at least> one element of any kind.</td></tr> |
| 549 | <tr><td class="h"><a name="390"></a>390</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 550 | <tr><td class="h"><a name="391"></a>391</td><td></td><td></td><td></td><td></td><td class="s">For a more basic form that allows zero length ARRAY references, see</td></tr> |
| 551 | <tr><td class="h"><a name="392"></a>392</td><td></td><td></td><td></td><td></td><td class="s">the C<_ARRAY0> function.</td></tr> |
| 552 | <tr><td class="h"><a name="393"></a>393</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 553 | <tr><td class="h"><a name="394"></a>394</td><td></td><td></td><td></td><td></td><td class="s">Returns the C<ARRAY> reference itself as a convenience, or C<undef></td></tr> |
| 554 | <tr><td class="h"><a name="395"></a>395</td><td></td><td></td><td></td><td></td><td class="s">if the value provided is not an C<ARRAY> reference.</td></tr> |
| 555 | <tr><td class="h"><a name="396"></a>396</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 556 | <tr><td class="h"><a name="397"></a>397</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 557 | <tr><td class="h"><a name="398"></a>398</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 558 | <tr><td class="h"><a name="399"></a>399</td><td class="c3">1</td><td class="c3"><span title="Avg 100ns">100ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_ARRAY;</td></tr> |
| 559 | <tr><td class="h"><a name="400"></a>400</td><td></td><td></td><td></td><td></td><td class="s">sub _ARRAY ($) {</td></tr> |
| 560 | <tr><td class="h"><a name="401"></a>401</td><td></td><td></td><td></td><td></td><td class="s"> (ref $_[0] eq 'ARRAY' and @{$_[0]}) ? $_[0] : undef;</td></tr> |
| 561 | <tr><td class="h"><a name="402"></a>402</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 562 | <tr><td class="h"><a name="403"></a>403</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 563 | <tr><td class="h"><a name="404"></a>404</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 564 | <tr><td class="h"><a name="405"></a>405</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 565 | <tr><td class="h"><a name="406"></a>406</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 566 | <tr><td class="h"><a name="407"></a>407</td><td></td><td></td><td></td><td></td><td class="s">=head2 _ARRAY0 $value</td></tr> |
| 567 | <tr><td class="h"><a name="408"></a>408</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 568 | <tr><td class="h"><a name="409"></a>409</td><td></td><td></td><td></td><td></td><td class="s">The C<_ARRAY0> function is intended to be imported into your package,</td></tr> |
| 569 | <tr><td class="h"><a name="410"></a>410</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test for a raw and unblessed</td></tr> |
| 570 | <tr><td class="h"><a name="411"></a>411</td><td></td><td></td><td></td><td></td><td class="s">C<ARRAY> reference, allowing C<ARRAY> references that contain no</td></tr> |
| 571 | <tr><td class="h"><a name="412"></a>412</td><td></td><td></td><td></td><td></td><td class="s">elements.</td></tr> |
| 572 | <tr><td class="h"><a name="413"></a>413</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 573 | <tr><td class="h"><a name="414"></a>414</td><td></td><td></td><td></td><td></td><td class="s">For a more basic "An array of something" form that also requires at</td></tr> |
| 574 | <tr><td class="h"><a name="415"></a>415</td><td></td><td></td><td></td><td></td><td class="s">least one element, see the C<_ARRAY> function.</td></tr> |
| 575 | <tr><td class="h"><a name="416"></a>416</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 576 | <tr><td class="h"><a name="417"></a>417</td><td></td><td></td><td></td><td></td><td class="s">Returns the C<ARRAY> reference itself as a convenience, or C<undef></td></tr> |
| 577 | <tr><td class="h"><a name="418"></a>418</td><td></td><td></td><td></td><td></td><td class="s">if the value provided is not an C<ARRAY> reference.</td></tr> |
| 578 | <tr><td class="h"><a name="419"></a>419</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 579 | <tr><td class="h"><a name="420"></a>420</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 580 | <tr><td class="h"><a name="421"></a>421</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 581 | <tr><td class="h"><a name="422"></a>422</td><td class="c3">1</td><td class="c3"><span title="Avg 100ns">100ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_ARRAY0;</td></tr> |
| 582 | <tr><td class="h"><a name="423"></a>423</td><td></td><td></td><td></td><td></td><td class="s">sub _ARRAY0 ($) {</td></tr> |
| 583 | <tr><td class="h"><a name="424"></a>424</td><td></td><td></td><td></td><td></td><td class="s"> ref $_[0] eq 'ARRAY' ? $_[0] : undef;</td></tr> |
| 584 | <tr><td class="h"><a name="425"></a>425</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 585 | <tr><td class="h"><a name="426"></a>426</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 586 | <tr><td class="h"><a name="427"></a>427</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 587 | <tr><td class="h"><a name="428"></a>428</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 588 | <tr><td class="h"><a name="429"></a>429</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 589 | <tr><td class="h"><a name="430"></a>430</td><td></td><td></td><td></td><td></td><td class="s">=head2 _ARRAYLIKE $value</td></tr> |
| 590 | <tr><td class="h"><a name="431"></a>431</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 591 | <tr><td class="h"><a name="432"></a>432</td><td></td><td></td><td></td><td></td><td class="s">The C<_ARRAYLIKE> function tests whether a given scalar value can respond to</td></tr> |
| 592 | <tr><td class="h"><a name="433"></a>433</td><td></td><td></td><td></td><td></td><td class="s">array dereferencing. If it can, the value is returned. If it cannot,</td></tr> |
| 593 | <tr><td class="h"><a name="434"></a>434</td><td></td><td></td><td></td><td></td><td class="s">C<_ARRAYLIKE> returns C<undef>.</td></tr> |
| 594 | <tr><td class="h"><a name="435"></a>435</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 595 | <tr><td class="h"><a name="436"></a>436</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 596 | <tr><td class="h"><a name="437"></a>437</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 597 | <tr><td class="h"><a name="438"></a>438</td><td class="c3">1</td><td class="c3"><span title="Avg 100ns">100ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_ARRAYLIKE;</td></tr> |
| 598 | <tr><td class="h"><a name="439"></a>439</td><td></td><td></td><td></td><td></td><td class="s">sub _ARRAYLIKE {</td></tr> |
| 599 | <tr><td class="h"><a name="440"></a>440</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and ref $_[0] and (</td></tr> |
| 600 | <tr><td class="h"><a name="441"></a>441</td><td></td><td></td><td></td><td></td><td class="s"> (Scalar::Util::reftype($_[0]) eq 'ARRAY')</td></tr> |
| 601 | <tr><td class="h"><a name="442"></a>442</td><td></td><td></td><td></td><td></td><td class="s"> or</td></tr> |
| 602 | <tr><td class="h"><a name="443"></a>443</td><td></td><td></td><td></td><td></td><td class="s"> overload::Method($_[0], '@{}')</td></tr> |
| 603 | <tr><td class="h"><a name="444"></a>444</td><td></td><td></td><td></td><td></td><td class="s"> )) ? $_[0] : undef;</td></tr> |
| 604 | <tr><td class="h"><a name="445"></a>445</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 605 | <tr><td class="h"><a name="446"></a>446</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 606 | <tr><td class="h"><a name="447"></a>447</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 607 | <tr><td class="h"><a name="448"></a>448</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 608 | <tr><td class="h"><a name="449"></a>449</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 609 | <tr><td class="h"><a name="450"></a>450</td><td></td><td></td><td></td><td></td><td class="s">=head2 _HASH $value</td></tr> |
| 610 | <tr><td class="h"><a name="451"></a>451</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 611 | <tr><td class="h"><a name="452"></a>452</td><td></td><td></td><td></td><td></td><td class="s">The C<_HASH> function is intended to be imported into your package,</td></tr> |
| 612 | <tr><td class="h"><a name="453"></a>453</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test for a raw and unblessed</td></tr> |
| 613 | <tr><td class="h"><a name="454"></a>454</td><td></td><td></td><td></td><td></td><td class="s">C<HASH> reference with at least one entry.</td></tr> |
| 614 | <tr><td class="h"><a name="455"></a>455</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 615 | <tr><td class="h"><a name="456"></a>456</td><td></td><td></td><td></td><td></td><td class="s">For a version of this function that allows the C<HASH> to be empty,</td></tr> |
| 616 | <tr><td class="h"><a name="457"></a>457</td><td></td><td></td><td></td><td></td><td class="s">see the C<_HASH0> function.</td></tr> |
| 617 | <tr><td class="h"><a name="458"></a>458</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 618 | <tr><td class="h"><a name="459"></a>459</td><td></td><td></td><td></td><td></td><td class="s">Returns the C<HASH> reference itself as a convenience, or C<undef></td></tr> |
| 619 | <tr><td class="h"><a name="460"></a>460</td><td></td><td></td><td></td><td></td><td class="s">if the value provided is not an C<HASH> reference.</td></tr> |
| 620 | <tr><td class="h"><a name="461"></a>461</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 621 | <tr><td class="h"><a name="462"></a>462</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 622 | <tr><td class="h"><a name="463"></a>463</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 623 | <tr><td class="h"><a name="464"></a>464</td><td class="c3">1</td><td class="c3"><span title="Avg 100ns">100ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_HASH;</td></tr> |
| 624 | <tr><td class="h"><a name="465"></a>465</td><td></td><td></td><td></td><td></td><td class="s">sub _HASH ($) {</td></tr> |
| 625 | <tr><td class="h"><a name="466"></a>466</td><td></td><td></td><td></td><td></td><td class="s"> (ref $_[0] eq 'HASH' and scalar %{$_[0]}) ? $_[0] : undef;</td></tr> |
| 626 | <tr><td class="h"><a name="467"></a>467</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 627 | <tr><td class="h"><a name="468"></a>468</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 628 | <tr><td class="h"><a name="469"></a>469</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 629 | <tr><td class="h"><a name="470"></a>470</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 630 | <tr><td class="h"><a name="471"></a>471</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 631 | <tr><td class="h"><a name="472"></a>472</td><td></td><td></td><td></td><td></td><td class="s">=head2 _HASH0 $value</td></tr> |
| 632 | <tr><td class="h"><a name="473"></a>473</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 633 | <tr><td class="h"><a name="474"></a>474</td><td></td><td></td><td></td><td></td><td class="s">The C<_HASH0> function is intended to be imported into your package,</td></tr> |
| 634 | <tr><td class="h"><a name="475"></a>475</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test for a raw and unblessed</td></tr> |
| 635 | <tr><td class="h"><a name="476"></a>476</td><td></td><td></td><td></td><td></td><td class="s">C<HASH> reference, regardless of the C<HASH> content.</td></tr> |
| 636 | <tr><td class="h"><a name="477"></a>477</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 637 | <tr><td class="h"><a name="478"></a>478</td><td></td><td></td><td></td><td></td><td class="s">For a simpler "A hash of something" version that requires at least one</td></tr> |
| 638 | <tr><td class="h"><a name="479"></a>479</td><td></td><td></td><td></td><td></td><td class="s">element, see the C<_HASH> function.</td></tr> |
| 639 | <tr><td class="h"><a name="480"></a>480</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 640 | <tr><td class="h"><a name="481"></a>481</td><td></td><td></td><td></td><td></td><td class="s">Returns the C<HASH> reference itself as a convenience, or C<undef></td></tr> |
| 641 | <tr><td class="h"><a name="482"></a>482</td><td></td><td></td><td></td><td></td><td class="s">if the value provided is not an C<HASH> reference.</td></tr> |
| 642 | <tr><td class="h"><a name="483"></a>483</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 643 | <tr><td class="h"><a name="484"></a>484</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 644 | <tr><td class="h"><a name="485"></a>485</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 645 | <tr><td class="h"><a name="486"></a>486</td><td class="c3">1</td><td class="c3"><span title="Avg 100ns">100ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_HASH0;</td></tr> |
| 646 | <tr><td class="h"><a name="487"></a>487</td><td></td><td></td><td></td><td></td><td class="s">sub _HASH0 ($) {</td></tr> |
| 647 | <tr><td class="h"><a name="488"></a>488</td><td></td><td></td><td></td><td></td><td class="s"> ref $_[0] eq 'HASH' ? $_[0] : undef;</td></tr> |
| 648 | <tr><td class="h"><a name="489"></a>489</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 649 | <tr><td class="h"><a name="490"></a>490</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 650 | <tr><td class="h"><a name="491"></a>491</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 651 | <tr><td class="h"><a name="492"></a>492</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 652 | <tr><td class="h"><a name="493"></a>493</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 653 | <tr><td class="h"><a name="494"></a>494</td><td></td><td></td><td></td><td></td><td class="s">=head2 _HASHLIKE $value</td></tr> |
| 654 | <tr><td class="h"><a name="495"></a>495</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 655 | <tr><td class="h"><a name="496"></a>496</td><td></td><td></td><td></td><td></td><td class="s">The C<_HASHLIKE> function tests whether a given scalar value can respond to</td></tr> |
| 656 | <tr><td class="h"><a name="497"></a>497</td><td></td><td></td><td></td><td></td><td class="s">hash dereferencing. If it can, the value is returned. If it cannot,</td></tr> |
| 657 | <tr><td class="h"><a name="498"></a>498</td><td></td><td></td><td></td><td></td><td class="s">C<_HASHLIKE> returns C<undef>.</td></tr> |
| 658 | <tr><td class="h"><a name="499"></a>499</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 659 | <tr><td class="h"><a name="500"></a>500</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 660 | <tr><td class="h"><a name="501"></a>501</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 661 | <tr><td class="h"><a name="502"></a>502</td><td class="c3">1</td><td class="c3"><span title="Avg 100ns">100ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_HASHLIKE;</td></tr> |
| 662 | <tr><td class="h"><a name="503"></a>503</td><td></td><td></td><td></td><td></td><td class="s">sub _HASHLIKE {</td></tr> |
| 663 | <tr><td class="h"><a name="504"></a>504</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and ref $_[0] and (</td></tr> |
| 664 | <tr><td class="h"><a name="505"></a>505</td><td></td><td></td><td></td><td></td><td class="s"> (Scalar::Util::reftype($_[0]) eq 'HASH')</td></tr> |
| 665 | <tr><td class="h"><a name="506"></a>506</td><td></td><td></td><td></td><td></td><td class="s"> or</td></tr> |
| 666 | <tr><td class="h"><a name="507"></a>507</td><td></td><td></td><td></td><td></td><td class="s"> overload::Method($_[0], '%{}')</td></tr> |
| 667 | <tr><td class="h"><a name="508"></a>508</td><td></td><td></td><td></td><td></td><td class="s"> )) ? $_[0] : undef;</td></tr> |
| 668 | <tr><td class="h"><a name="509"></a>509</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 669 | <tr><td class="h"><a name="510"></a>510</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 670 | <tr><td class="h"><a name="511"></a>511</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 671 | <tr><td class="h"><a name="512"></a>512</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 672 | <tr><td class="h"><a name="513"></a>513</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 673 | <tr><td class="h"><a name="514"></a>514</td><td></td><td></td><td></td><td></td><td class="s">=head2 _CODE $value</td></tr> |
| 674 | <tr><td class="h"><a name="515"></a>515</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 675 | <tr><td class="h"><a name="516"></a>516</td><td></td><td></td><td></td><td></td><td class="s">The C<_CODE> function is intended to be imported into your package,</td></tr> |
| 676 | <tr><td class="h"><a name="517"></a>517</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test for a raw and unblessed</td></tr> |
| 677 | <tr><td class="h"><a name="518"></a>518</td><td></td><td></td><td></td><td></td><td class="s">C<CODE> reference.</td></tr> |
| 678 | <tr><td class="h"><a name="519"></a>519</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 679 | <tr><td class="h"><a name="520"></a>520</td><td></td><td></td><td></td><td></td><td class="s">Returns the C<CODE> reference itself as a convenience, or C<undef></td></tr> |
| 680 | <tr><td class="h"><a name="521"></a>521</td><td></td><td></td><td></td><td></td><td class="s">if the value provided is not an C<CODE> reference.</td></tr> |
| 681 | <tr><td class="h"><a name="522"></a>522</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 682 | <tr><td class="h"><a name="523"></a>523</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 683 | <tr><td class="h"><a name="524"></a>524</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 684 | <tr><td class="h"><a name="525"></a>525</td><td class="c3">1</td><td class="c3"><span title="Avg 100ns">100ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_CODE;</td></tr> |
| 685 | <tr><td class="h"><a name="526"></a>526</td><td></td><td></td><td></td><td></td><td class="s">sub _CODE ($) {</td></tr> |
| 686 | <tr><td class="h"><a name="527"></a>527</td><td></td><td></td><td></td><td></td><td class="s"> ref $_[0] eq 'CODE' ? $_[0] : undef;</td></tr> |
| 687 | <tr><td class="h"><a name="528"></a>528</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 688 | <tr><td class="h"><a name="529"></a>529</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 689 | <tr><td class="h"><a name="530"></a>530</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 690 | <tr><td class="h"><a name="531"></a>531</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 691 | <tr><td class="h"><a name="532"></a>532</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 692 | <tr><td class="h"><a name="533"></a>533</td><td></td><td></td><td></td><td></td><td class="s">=head2 _CODELIKE $value</td></tr> |
| 693 | <tr><td class="h"><a name="534"></a>534</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 694 | <tr><td class="h"><a name="535"></a>535</td><td></td><td></td><td></td><td></td><td class="s">The C<_CODELIKE> is the more generic version of C<_CODE>. Unlike C<_CODE>,</td></tr> |
| 695 | <tr><td class="h"><a name="536"></a>536</td><td></td><td></td><td></td><td></td><td class="s">which checks for an explicit C<CODE> reference, the C<_CODELIKE> function</td></tr> |
| 696 | <tr><td class="h"><a name="537"></a>537</td><td></td><td></td><td></td><td></td><td class="s">also includes things that act like them, such as blessed objects that</td></tr> |
| 697 | <tr><td class="h"><a name="538"></a>538</td><td></td><td></td><td></td><td></td><td class="s">overload C<'&{}'>.</td></tr> |
| 698 | <tr><td class="h"><a name="539"></a>539</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 699 | <tr><td class="h"><a name="540"></a>540</td><td></td><td></td><td></td><td></td><td class="s">Please note that in the case of objects overloaded with '&{}', you will</td></tr> |
| 700 | <tr><td class="h"><a name="541"></a>541</td><td></td><td></td><td></td><td></td><td class="s">almost always end up also testing it in 'bool' context at some stage.</td></tr> |
| 701 | <tr><td class="h"><a name="542"></a>542</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 702 | <tr><td class="h"><a name="543"></a>543</td><td></td><td></td><td></td><td></td><td class="s">For example:</td></tr> |
| 703 | <tr><td class="h"><a name="544"></a>544</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 704 | <tr><td class="h"><a name="545"></a>545</td><td></td><td></td><td></td><td></td><td class="s"> sub foo {</td></tr> |
| 705 | <tr><td class="h"><a name="546"></a>546</td><td></td><td></td><td></td><td></td><td class="s"> my $code1 = _CODELIKE(shift) or die "No code param provided";</td></tr> |
| 706 | <tr><td class="h"><a name="547"></a>547</td><td></td><td></td><td></td><td></td><td class="s"> my $code2 = _CODELIKE(shift);</td></tr> |
| 707 | <tr><td class="h"><a name="548"></a>548</td><td></td><td></td><td></td><td></td><td class="s"> if ( $code2 ) {</td></tr> |
| 708 | <tr><td class="h"><a name="549"></a>549</td><td></td><td></td><td></td><td></td><td class="s"> print "Got optional second code param";</td></tr> |
| 709 | <tr><td class="h"><a name="550"></a>550</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 710 | <tr><td class="h"><a name="551"></a>551</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 711 | <tr><td class="h"><a name="552"></a>552</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 712 | <tr><td class="h"><a name="553"></a>553</td><td></td><td></td><td></td><td></td><td class="s">As such, you will most likely always want to make sure your class has</td></tr> |
| 713 | <tr><td class="h"><a name="554"></a>554</td><td></td><td></td><td></td><td></td><td class="s">at least the following to allow it to evaluate to true in boolean</td></tr> |
| 714 | <tr><td class="h"><a name="555"></a>555</td><td></td><td></td><td></td><td></td><td class="s">context.</td></tr> |
| 715 | <tr><td class="h"><a name="556"></a>556</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 716 | <tr><td class="h"><a name="557"></a>557</td><td></td><td></td><td></td><td></td><td class="s"> # Always evaluate to true in boolean context</td></tr> |
| 717 | <tr><td class="h"><a name="558"></a>558</td><td></td><td></td><td></td><td></td><td class="s"> use overload 'bool' => sub () { 1 };</td></tr> |
| 718 | <tr><td class="h"><a name="559"></a>559</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 719 | <tr><td class="h"><a name="560"></a>560</td><td></td><td></td><td></td><td></td><td class="s">Returns the callable value as a convenience, or C<undef> if the</td></tr> |
| 720 | <tr><td class="h"><a name="561"></a>561</td><td></td><td></td><td></td><td></td><td class="s">value provided is not callable.</td></tr> |
| 721 | <tr><td class="h"><a name="562"></a>562</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 722 | <tr><td class="h"><a name="563"></a>563</td><td></td><td></td><td></td><td></td><td class="s">Note - This function was formerly known as _CALLABLE but has been renamed</td></tr> |
| 723 | <tr><td class="h"><a name="564"></a>564</td><td></td><td></td><td></td><td></td><td class="s">for greater symmetry with the other _XXXXLIKE functions.</td></tr> |
| 724 | <tr><td class="h"><a name="565"></a>565</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 725 | <tr><td class="h"><a name="566"></a>566</td><td></td><td></td><td></td><td></td><td class="s">The use of _CALLABLE has been deprecated. It will continue to work, but</td></tr> |
| 726 | <tr><td class="h"><a name="567"></a>567</td><td></td><td></td><td></td><td></td><td class="s">with a warning, until end-2006, then will be removed.</td></tr> |
| 727 | <tr><td class="h"><a name="568"></a>568</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 728 | <tr><td class="h"><a name="569"></a>569</td><td></td><td></td><td></td><td></td><td class="s">I apologise for any inconvenience caused.</td></tr> |
| 729 | <tr><td class="h"><a name="570"></a>570</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 730 | <tr><td class="h"><a name="571"></a>571</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 731 | <tr><td class="h"><a name="572"></a>572</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 732 | <tr><td class="h"><a name="573"></a>573</td><td class="c3">1</td><td class="c3"><span title="Avg 200ns">200ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_CODELIKE;</td></tr> |
| 733 | <tr><td class="h"><a name="574"></a>574</td><td></td><td></td><td></td><td></td><td class="s">sub _CODELIKE($) {</td></tr> |
| 734 | <tr><td class="h"><a name="575"></a>575</td><td></td><td></td><td></td><td></td><td class="s"> (</td></tr> |
| 735 | <tr><td class="h"><a name="576"></a>576</td><td></td><td></td><td></td><td></td><td class="s"> (Scalar::Util::reftype($_[0])||'') eq 'CODE'</td></tr> |
| 736 | <tr><td class="h"><a name="577"></a>577</td><td></td><td></td><td></td><td></td><td class="s"> or</td></tr> |
| 737 | <tr><td class="h"><a name="578"></a>578</td><td></td><td></td><td></td><td></td><td class="s"> Scalar::Util::blessed($_[0]) and overload::Method($_[0],'&{}')</td></tr> |
| 738 | <tr><td class="h"><a name="579"></a>579</td><td></td><td></td><td></td><td></td><td class="s"> )</td></tr> |
| 739 | <tr><td class="h"><a name="580"></a>580</td><td></td><td></td><td></td><td></td><td class="s"> ? $_[0] : undef;</td></tr> |
| 740 | <tr><td class="h"><a name="581"></a>581</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 741 | <tr><td class="h"><a name="582"></a>582</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 742 | <tr><td class="h"><a name="583"></a>583</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 743 | <tr><td class="h"><a name="584"></a>584</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 744 | <tr><td class="h"><a name="585"></a>585</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 745 | <tr><td class="h"><a name="586"></a>586</td><td></td><td></td><td></td><td></td><td class="s">=head2 _INVOCANT $value</td></tr> |
| 746 | <tr><td class="h"><a name="587"></a>587</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 747 | <tr><td class="h"><a name="588"></a>588</td><td></td><td></td><td></td><td></td><td class="s">This routine tests whether the given value is a valid method invocant.</td></tr> |
| 748 | <tr><td class="h"><a name="589"></a>589</td><td></td><td></td><td></td><td></td><td class="s">This can be either an instance of an object, or a class name.</td></tr> |
| 749 | <tr><td class="h"><a name="590"></a>590</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 750 | <tr><td class="h"><a name="591"></a>591</td><td></td><td></td><td></td><td></td><td class="s">If so, the value itself is returned. Otherwise, C<_INVOCANT></td></tr> |
| 751 | <tr><td class="h"><a name="592"></a>592</td><td></td><td></td><td></td><td></td><td class="s">returns C<undef>.</td></tr> |
| 752 | <tr><td class="h"><a name="593"></a>593</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 753 | <tr><td class="h"><a name="594"></a>594</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 754 | <tr><td class="h"><a name="595"></a>595</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 755 | <tr><td class="h"><a name="596"></a>596</td><td class="c3">1</td><td class="c0"><span title="Avg 53µs">53µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_INVOCANT;</td></tr> |
| 756 | <tr><td class="h"><a name="597"></a>597</td><td></td><td></td><td></td><td></td><td class="s">sub _INVOCANT($) {</td></tr> |
| 757 | <tr><td class="h"><a name="598"></a>598</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and</td></tr> |
| 758 | <tr><td class="h"><a name="599"></a>599</td><td></td><td></td><td></td><td></td><td class="s"> (defined Scalar::Util::blessed($_[0])</td></tr> |
| 759 | <tr><td class="h"><a name="600"></a>600</td><td></td><td></td><td></td><td></td><td class="s"> or </td></tr> |
| 760 | <tr><td class="h"><a name="601"></a>601</td><td></td><td></td><td></td><td></td><td class="s"> # We used to check for stash definedness, but any class-like name is a</td></tr> |
| 761 | <tr><td class="h"><a name="602"></a>602</td><td></td><td></td><td></td><td></td><td class="s"> # valid invocant for UNIVERSAL methods, so we stopped. -- rjbs, 2006-07-02</td></tr> |
| 762 | <tr><td class="h"><a name="603"></a>603</td><td></td><td></td><td></td><td></td><td class="s"> Params::Util::_CLASS($_[0]))</td></tr> |
| 763 | <tr><td class="h"><a name="604"></a>604</td><td></td><td></td><td></td><td></td><td class="s"> ) ? $_[0] : undef;</td></tr> |
| 764 | <tr><td class="h"><a name="605"></a>605</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 765 | <tr><td class="h"><a name="606"></a>606</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 766 | <tr><td class="h"><a name="607"></a>607</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 767 | <tr><td class="h"><a name="608"></a>608</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 768 | <tr><td class="h"><a name="609"></a>609</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 769 | <tr><td class="h"><a name="610"></a>610</td><td></td><td></td><td></td><td></td><td class="s">=head2 _INSTANCE $object, $class</td></tr> |
| 770 | <tr><td class="h"><a name="611"></a>611</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 771 | <tr><td class="h"><a name="612"></a>612</td><td></td><td></td><td></td><td></td><td class="s">The C<_INSTANCE> function is intended to be imported into your package,</td></tr> |
| 772 | <tr><td class="h"><a name="613"></a>613</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test for an object of a particular class</td></tr> |
| 773 | <tr><td class="h"><a name="614"></a>614</td><td></td><td></td><td></td><td></td><td class="s">in a strictly correct manner.</td></tr> |
| 774 | <tr><td class="h"><a name="615"></a>615</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 775 | <tr><td class="h"><a name="616"></a>616</td><td></td><td></td><td></td><td></td><td class="s">Returns the object itself as a convenience, or C<undef> if the value</td></tr> |
| 776 | <tr><td class="h"><a name="617"></a>617</td><td></td><td></td><td></td><td></td><td class="s">provided is not an object of that type.</td></tr> |
| 777 | <tr><td class="h"><a name="618"></a>618</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 778 | <tr><td class="h"><a name="619"></a>619</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 779 | <tr><td class="h"><a name="620"></a>620</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 780 | <tr><td class="h"><a name="621"></a>621</td><td class="c3">1</td><td class="c3"><span title="Avg 300ns">300ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_INSTANCE;</td></tr> |
| 781 | <tr><td class="h"><a name="622"></a>622</td><td></td><td></td><td></td><td></td><td class="s">sub _INSTANCE ($$) {</td></tr> |
| 782 | <tr><td class="h"><a name="623"></a>623</td><td></td><td></td><td></td><td></td><td class="s"> (Scalar::Util::blessed($_[0]) and $_[0]->isa($_[1])) ? $_[0] : undef;</td></tr> |
| 783 | <tr><td class="h"><a name="624"></a>624</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 784 | <tr><td class="h"><a name="625"></a>625</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 785 | <tr><td class="h"><a name="626"></a>626</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 786 | <tr><td class="h"><a name="627"></a>627</td><td></td><td></td><td></td><td></td><td class="s">=head2 _INSTANCEDOES $object, $role</td></tr> |
| 787 | <tr><td class="h"><a name="628"></a>628</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 788 | <tr><td class="h"><a name="629"></a>629</td><td></td><td></td><td></td><td></td><td class="s">This routine behaves exactly like C<L</_INSTANCE>>, but checks with C<< ->DOES</td></tr> |
| 789 | <tr><td class="h"><a name="630"></a>630</td><td></td><td></td><td></td><td></td><td class="s">>> rather than C<< ->isa >>. This is probably only a good idea to use on Perl</td></tr> |
| 790 | <tr><td class="h"><a name="631"></a>631</td><td></td><td></td><td></td><td></td><td class="s">5.10 or later, when L<UNIVERSAL::DOES|UNIVERSAL::DOES/DOES> has been</td></tr> |
| 791 | <tr><td class="h"><a name="632"></a>632</td><td></td><td></td><td></td><td></td><td class="s">implemented.</td></tr> |
| 792 | <tr><td class="h"><a name="633"></a>633</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 793 | <tr><td class="h"><a name="634"></a>634</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 794 | <tr><td class="h"><a name="635"></a>635</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 795 | <tr><td class="h"><a name="636"></a>636</td><td class="c3">1</td><td class="c0"><span title="Avg 45µs">45µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_INSTANCEDOES;</td></tr> |
| 796 | <tr><td class="h"><a name="637"></a>637</td><td></td><td></td><td></td><td></td><td class="s">sub _INSTANCEDOES ($$) {</td></tr> |
| 797 | <tr><td class="h"><a name="638"></a>638</td><td></td><td></td><td></td><td></td><td class="s"> (Scalar::Util::blessed($_[0]) and $_[0]->DOES($_[1])) ? $_[0] : undef;</td></tr> |
| 798 | <tr><td class="h"><a name="639"></a>639</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 799 | <tr><td class="h"><a name="640"></a>640</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 800 | <tr><td class="h"><a name="641"></a>641</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 801 | <tr><td class="h"><a name="642"></a>642</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 802 | <tr><td class="h"><a name="643"></a>643</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 803 | <tr><td class="h"><a name="644"></a>644</td><td></td><td></td><td></td><td></td><td class="s">=head2 _REGEX $value</td></tr> |
| 804 | <tr><td class="h"><a name="645"></a>645</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 805 | <tr><td class="h"><a name="646"></a>646</td><td></td><td></td><td></td><td></td><td class="s">The C<_REGEX> function is intended to be imported into your package,</td></tr> |
| 806 | <tr><td class="h"><a name="647"></a>647</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test for a regular expression.</td></tr> |
| 807 | <tr><td class="h"><a name="648"></a>648</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 808 | <tr><td class="h"><a name="649"></a>649</td><td></td><td></td><td></td><td></td><td class="s">Returns the value itself as a convenience, or C<undef> if the value</td></tr> |
| 809 | <tr><td class="h"><a name="650"></a>650</td><td></td><td></td><td></td><td></td><td class="s">provided is not a regular expression.</td></tr> |
| 810 | <tr><td class="h"><a name="651"></a>651</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 811 | <tr><td class="h"><a name="652"></a>652</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 812 | <tr><td class="h"><a name="653"></a>653</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 813 | <tr><td class="h"><a name="654"></a>654</td><td class="c3">1</td><td class="c3"><span title="Avg 200ns">200ns</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_REGEX;</td></tr> |
| 814 | <tr><td class="h"><a name="655"></a>655</td><td></td><td></td><td></td><td></td><td class="s">sub _REGEX ($) {</td></tr> |
| 815 | <tr><td class="h"><a name="656"></a>656</td><td></td><td></td><td></td><td></td><td class="s"> (defined $_[0] and 'Regexp' eq ref($_[0])) ? $_[0] : undef;</td></tr> |
| 816 | <tr><td class="h"><a name="657"></a>657</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 817 | <tr><td class="h"><a name="658"></a>658</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 818 | <tr><td class="h"><a name="659"></a>659</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 819 | <tr><td class="h"><a name="660"></a>660</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 820 | <tr><td class="h"><a name="661"></a>661</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 821 | <tr><td class="h"><a name="662"></a>662</td><td></td><td></td><td></td><td></td><td class="s">=head2 _SET \@array, $class</td></tr> |
| 822 | <tr><td class="h"><a name="663"></a>663</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 823 | <tr><td class="h"><a name="664"></a>664</td><td></td><td></td><td></td><td></td><td class="s">The C<_SET> function is intended to be imported into your package,</td></tr> |
| 824 | <tr><td class="h"><a name="665"></a>665</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test for set of at least one object of</td></tr> |
| 825 | <tr><td class="h"><a name="666"></a>666</td><td></td><td></td><td></td><td></td><td class="s">a particular class in a strictly correct manner.</td></tr> |
| 826 | <tr><td class="h"><a name="667"></a>667</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 827 | <tr><td class="h"><a name="668"></a>668</td><td></td><td></td><td></td><td></td><td class="s">The set is provided as a reference to an C<ARRAY> of objects of the</td></tr> |
| 828 | <tr><td class="h"><a name="669"></a>669</td><td></td><td></td><td></td><td></td><td class="s">class provided.</td></tr> |
| 829 | <tr><td class="h"><a name="670"></a>670</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 830 | <tr><td class="h"><a name="671"></a>671</td><td></td><td></td><td></td><td></td><td class="s">For an alternative function that allows zero-length sets, see the</td></tr> |
| 831 | <tr><td class="h"><a name="672"></a>672</td><td></td><td></td><td></td><td></td><td class="s">C<_SET0> function.</td></tr> |
| 832 | <tr><td class="h"><a name="673"></a>673</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 833 | <tr><td class="h"><a name="674"></a>674</td><td></td><td></td><td></td><td></td><td class="s">Returns the C<ARRAY> reference itself as a convenience, or C<undef> if</td></tr> |
| 834 | <tr><td class="h"><a name="675"></a>675</td><td></td><td></td><td></td><td></td><td class="s">the value provided is not a set of that class.</td></tr> |
| 835 | <tr><td class="h"><a name="676"></a>676</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 836 | <tr><td class="h"><a name="677"></a>677</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 837 | <tr><td class="h"><a name="678"></a>678</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 838 | <tr><td class="h"><a name="679"></a>679</td><td class="c3">1</td><td class="c0"><span title="Avg 53µs">53µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_SET;</td></tr> |
| 839 | <tr><td class="h"><a name="680"></a>680</td><td></td><td></td><td></td><td></td><td class="s">sub _SET ($$) {</td></tr> |
| 840 | <tr><td class="h"><a name="681"></a>681</td><td></td><td></td><td></td><td></td><td class="s"> my $set = shift;</td></tr> |
| 841 | <tr><td class="h"><a name="682"></a>682</td><td></td><td></td><td></td><td></td><td class="s"> _ARRAY($set) or return undef;</td></tr> |
| 842 | <tr><td class="h"><a name="683"></a>683</td><td></td><td></td><td></td><td></td><td class="s"> foreach my $item ( @$set ) {</td></tr> |
| 843 | <tr><td class="h"><a name="684"></a>684</td><td></td><td></td><td></td><td></td><td class="s"> _INSTANCE($item,$_[0]) or return undef;</td></tr> |
| 844 | <tr><td class="h"><a name="685"></a>685</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 845 | <tr><td class="h"><a name="686"></a>686</td><td></td><td></td><td></td><td></td><td class="s"> $set;</td></tr> |
| 846 | <tr><td class="h"><a name="687"></a>687</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 847 | <tr><td class="h"><a name="688"></a>688</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 848 | <tr><td class="h"><a name="689"></a>689</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 849 | <tr><td class="h"><a name="690"></a>690</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 850 | <tr><td class="h"><a name="691"></a>691</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 851 | <tr><td class="h"><a name="692"></a>692</td><td></td><td></td><td></td><td></td><td class="s">=head2 _SET0 \@array, $class</td></tr> |
| 852 | <tr><td class="h"><a name="693"></a>693</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 853 | <tr><td class="h"><a name="694"></a>694</td><td></td><td></td><td></td><td></td><td class="s">The C<_SET0> function is intended to be imported into your package,</td></tr> |
| 854 | <tr><td class="h"><a name="695"></a>695</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test for a set of objects of a</td></tr> |
| 855 | <tr><td class="h"><a name="696"></a>696</td><td></td><td></td><td></td><td></td><td class="s">particular class in a strictly correct manner, allowing for zero objects.</td></tr> |
| 856 | <tr><td class="h"><a name="697"></a>697</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 857 | <tr><td class="h"><a name="698"></a>698</td><td></td><td></td><td></td><td></td><td class="s">The set is provided as a reference to an C<ARRAY> of objects of the</td></tr> |
| 858 | <tr><td class="h"><a name="699"></a>699</td><td></td><td></td><td></td><td></td><td class="s">class provided.</td></tr> |
| 859 | <tr><td class="h"><a name="700"></a>700</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 860 | <tr><td class="h"><a name="701"></a>701</td><td></td><td></td><td></td><td></td><td class="s">For an alternative function that requires at least one object, see the</td></tr> |
| 861 | <tr><td class="h"><a name="702"></a>702</td><td></td><td></td><td></td><td></td><td class="s">C<_SET> function.</td></tr> |
| 862 | <tr><td class="h"><a name="703"></a>703</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 863 | <tr><td class="h"><a name="704"></a>704</td><td></td><td></td><td></td><td></td><td class="s">Returns the C<ARRAY> reference itself as a convenience, or C<undef> if</td></tr> |
| 864 | <tr><td class="h"><a name="705"></a>705</td><td></td><td></td><td></td><td></td><td class="s">the value provided is not a set of that class.</td></tr> |
| 865 | <tr><td class="h"><a name="706"></a>706</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 866 | <tr><td class="h"><a name="707"></a>707</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 867 | <tr><td class="h"><a name="708"></a>708</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 868 | <tr><td class="h"><a name="709"></a>709</td><td class="c3">1</td><td class="c0"><span title="Avg 49µs">49µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_SET0;</td></tr> |
| 869 | <tr><td class="h"><a name="710"></a>710</td><td></td><td></td><td></td><td></td><td class="s">sub _SET0 ($$) {</td></tr> |
| 870 | <tr><td class="h"><a name="711"></a>711</td><td></td><td></td><td></td><td></td><td class="s"> my $set = shift;</td></tr> |
| 871 | <tr><td class="h"><a name="712"></a>712</td><td></td><td></td><td></td><td></td><td class="s"> _ARRAY0($set) or return undef;</td></tr> |
| 872 | <tr><td class="h"><a name="713"></a>713</td><td></td><td></td><td></td><td></td><td class="s"> foreach my $item ( @$set ) {</td></tr> |
| 873 | <tr><td class="h"><a name="714"></a>714</td><td></td><td></td><td></td><td></td><td class="s"> _INSTANCE($item,$_[0]) or return undef;</td></tr> |
| 874 | <tr><td class="h"><a name="715"></a>715</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 875 | <tr><td class="h"><a name="716"></a>716</td><td></td><td></td><td></td><td></td><td class="s"> $set;</td></tr> |
| 876 | <tr><td class="h"><a name="717"></a>717</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 877 | <tr><td class="h"><a name="718"></a>718</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 878 | <tr><td class="h"><a name="719"></a>719</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 879 | <tr><td class="h"><a name="720"></a>720</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 880 | <tr><td class="h"><a name="721"></a>721</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 881 | <tr><td class="h"><a name="722"></a>722</td><td></td><td></td><td></td><td></td><td class="s">=head2 _HANDLE</td></tr> |
| 882 | <tr><td class="h"><a name="723"></a>723</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 883 | <tr><td class="h"><a name="724"></a>724</td><td></td><td></td><td></td><td></td><td class="s">The C<_HANDLE> function is intended to be imported into your package,</td></tr> |
| 884 | <tr><td class="h"><a name="725"></a>725</td><td></td><td></td><td></td><td></td><td class="s">and provides a convenient way to test whether or not a single scalar</td></tr> |
| 885 | <tr><td class="h"><a name="726"></a>726</td><td></td><td></td><td></td><td></td><td class="s">value is a file handle.</td></tr> |
| 886 | <tr><td class="h"><a name="727"></a>727</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 887 | <tr><td class="h"><a name="728"></a>728</td><td></td><td></td><td></td><td></td><td class="s">Unfortunately, in Perl the definition of a file handle can be a little</td></tr> |
| 888 | <tr><td class="h"><a name="729"></a>729</td><td></td><td></td><td></td><td></td><td class="s">bit fuzzy, so this function is likely to be somewhat imperfect (at first</td></tr> |
| 889 | <tr><td class="h"><a name="730"></a>730</td><td></td><td></td><td></td><td></td><td class="s">anyway).</td></tr> |
| 890 | <tr><td class="h"><a name="731"></a>731</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 891 | <tr><td class="h"><a name="732"></a>732</td><td></td><td></td><td></td><td></td><td class="s">That said, it is implement as well or better than the other file handle</td></tr> |
| 892 | <tr><td class="h"><a name="733"></a>733</td><td></td><td></td><td></td><td></td><td class="s">detectors in existance (and we stole from the best of them).</td></tr> |
| 893 | <tr><td class="h"><a name="734"></a>734</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 894 | <tr><td class="h"><a name="735"></a>735</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 895 | <tr><td class="h"><a name="736"></a>736</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 896 | <tr><td class="h"><a name="737"></a>737</td><td></td><td></td><td></td><td></td><td class="s"># We're doing this longhand for now. Once everything is perfect,</td></tr> |
| 897 | <tr><td class="h"><a name="738"></a>738</td><td></td><td></td><td></td><td></td><td class="s"># we'll compress this into something that compiles more efficiently.</td></tr> |
| 898 | <tr><td class="h"><a name="739"></a>739</td><td></td><td></td><td></td><td></td><td class="s"># Further, testing file handles is not something that is generally</td></tr> |
| 899 | <tr><td class="h"><a name="740"></a>740</td><td></td><td></td><td></td><td></td><td class="s"># done millions of times, so doing it slowly is not a big speed hit.</td></tr> |
| 900 | <tr><td class="h"><a name="741"></a>741</td><td class="c3">1</td><td class="c0"><span title="Avg 116µs">116µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_HANDLE;</td></tr> |
| 901 | <tr><td class="h"><a name="742"></a>742</td><td></td><td></td><td></td><td></td><td class="s">sub _HANDLE {</td></tr> |
| 902 | <tr><td class="h"><a name="743"></a>743</td><td></td><td></td><td></td><td></td><td class="s"> my $it = shift;</td></tr> |
| 903 | <tr><td class="h"><a name="744"></a>744</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 904 | <tr><td class="h"><a name="745"></a>745</td><td></td><td></td><td></td><td></td><td class="s"> # It has to be defined, of course</td></tr> |
| 905 | <tr><td class="h"><a name="746"></a>746</td><td></td><td></td><td></td><td></td><td class="s"> unless ( defined $it ) {</td></tr> |
| 906 | <tr><td class="h"><a name="747"></a>747</td><td></td><td></td><td></td><td></td><td class="s"> return undef;</td></tr> |
| 907 | <tr><td class="h"><a name="748"></a>748</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 908 | <tr><td class="h"><a name="749"></a>749</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 909 | <tr><td class="h"><a name="750"></a>750</td><td></td><td></td><td></td><td></td><td class="s"> # Normal globs are considered to be file handles</td></tr> |
| 910 | <tr><td class="h"><a name="751"></a>751</td><td></td><td></td><td></td><td></td><td class="s"> if ( ref $it eq 'GLOB' ) {</td></tr> |
| 911 | <tr><td class="h"><a name="752"></a>752</td><td></td><td></td><td></td><td></td><td class="s"> return $it;</td></tr> |
| 912 | <tr><td class="h"><a name="753"></a>753</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 913 | <tr><td class="h"><a name="754"></a>754</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 914 | <tr><td class="h"><a name="755"></a>755</td><td></td><td></td><td></td><td></td><td class="s"> # Check for a normal tied filehandle</td></tr> |
| 915 | <tr><td class="h"><a name="756"></a>756</td><td></td><td></td><td></td><td></td><td class="s"> # Side Note: 5.5.4's tied() and can() doesn't like getting undef</td></tr> |
| 916 | <tr><td class="h"><a name="757"></a>757</td><td></td><td></td><td></td><td></td><td class="s"> if ( tied($it) and tied($it)->can('TIEHANDLE') ) {</td></tr> |
| 917 | <tr><td class="h"><a name="758"></a>758</td><td></td><td></td><td></td><td></td><td class="s"> return $it;</td></tr> |
| 918 | <tr><td class="h"><a name="759"></a>759</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 919 | <tr><td class="h"><a name="760"></a>760</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 920 | <tr><td class="h"><a name="761"></a>761</td><td></td><td></td><td></td><td></td><td class="s"> # There are no other non-object handles that we support</td></tr> |
| 921 | <tr><td class="h"><a name="762"></a>762</td><td></td><td></td><td></td><td></td><td class="s"> unless ( Scalar::Util::blessed($it) ) {</td></tr> |
| 922 | <tr><td class="h"><a name="763"></a>763</td><td></td><td></td><td></td><td></td><td class="s"> return undef;</td></tr> |
| 923 | <tr><td class="h"><a name="764"></a>764</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 924 | <tr><td class="h"><a name="765"></a>765</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 925 | <tr><td class="h"><a name="766"></a>766</td><td></td><td></td><td></td><td></td><td class="s"> # Check for a common base classes for conventional IO::Handle object</td></tr> |
| 926 | <tr><td class="h"><a name="767"></a>767</td><td></td><td></td><td></td><td></td><td class="s"> if ( $it->isa('IO::Handle') ) {</td></tr> |
| 927 | <tr><td class="h"><a name="768"></a>768</td><td></td><td></td><td></td><td></td><td class="s"> return $it;</td></tr> |
| 928 | <tr><td class="h"><a name="769"></a>769</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 929 | <tr><td class="h"><a name="770"></a>770</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 930 | <tr><td class="h"><a name="771"></a>771</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 931 | <tr><td class="h"><a name="772"></a>772</td><td></td><td></td><td></td><td></td><td class="s"> # Check for tied file handles using Tie::Handle</td></tr> |
| 932 | <tr><td class="h"><a name="773"></a>773</td><td></td><td></td><td></td><td></td><td class="s"> if ( $it->isa('Tie::Handle') ) {</td></tr> |
| 933 | <tr><td class="h"><a name="774"></a>774</td><td></td><td></td><td></td><td></td><td class="s"> return $it;</td></tr> |
| 934 | <tr><td class="h"><a name="775"></a>775</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 935 | <tr><td class="h"><a name="776"></a>776</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 936 | <tr><td class="h"><a name="777"></a>777</td><td></td><td></td><td></td><td></td><td class="s"> # IO::Scalar is not a proper seekable, but it is valid is a</td></tr> |
| 937 | <tr><td class="h"><a name="778"></a>778</td><td></td><td></td><td></td><td></td><td class="s"> # regular file handle</td></tr> |
| 938 | <tr><td class="h"><a name="779"></a>779</td><td></td><td></td><td></td><td></td><td class="s"> if ( $it->isa('IO::Scalar') ) {</td></tr> |
| 939 | <tr><td class="h"><a name="780"></a>780</td><td></td><td></td><td></td><td></td><td class="s"> return $it;</td></tr> |
| 940 | <tr><td class="h"><a name="781"></a>781</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 941 | <tr><td class="h"><a name="782"></a>782</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 942 | <tr><td class="h"><a name="783"></a>783</td><td></td><td></td><td></td><td></td><td class="s"> # Yet another special case for IO::String, which refuses (for now</td></tr> |
| 943 | <tr><td class="h"><a name="784"></a>784</td><td></td><td></td><td></td><td></td><td class="s"> # anyway) to become a subclass of IO::Handle.</td></tr> |
| 944 | <tr><td class="h"><a name="785"></a>785</td><td></td><td></td><td></td><td></td><td class="s"> if ( $it->isa('IO::String') ) {</td></tr> |
| 945 | <tr><td class="h"><a name="786"></a>786</td><td></td><td></td><td></td><td></td><td class="s"> return $it;</td></tr> |
| 946 | <tr><td class="h"><a name="787"></a>787</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 947 | <tr><td class="h"><a name="788"></a>788</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 948 | <tr><td class="h"><a name="789"></a>789</td><td></td><td></td><td></td><td></td><td class="s"> # This is not any sort of object we know about</td></tr> |
| 949 | <tr><td class="h"><a name="790"></a>790</td><td></td><td></td><td></td><td></td><td class="s"> return undef;</td></tr> |
| 950 | <tr><td class="h"><a name="791"></a>791</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 951 | <tr><td class="h"><a name="792"></a>792</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 952 | <tr><td class="h"><a name="793"></a>793</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 953 | <tr><td class="h"><a name="794"></a>794</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 954 | <tr><td class="h"><a name="795"></a>795</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 955 | <tr><td class="h"><a name="796"></a>796</td><td></td><td></td><td></td><td></td><td class="s">=head2 _DRIVER $string</td></tr> |
| 956 | <tr><td class="h"><a name="797"></a>797</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 957 | <tr><td class="h"><a name="798"></a>798</td><td></td><td></td><td></td><td></td><td class="s"> sub foo {</td></tr> |
| 958 | <tr><td class="h"><a name="799"></a>799</td><td></td><td></td><td></td><td></td><td class="s"> my $class = _DRIVER(shift, 'My::Driver::Base') or die "Bad driver";</td></tr> |
| 959 | <tr><td class="h"><a name="800"></a>800</td><td></td><td></td><td></td><td></td><td class="s"> ...</td></tr> |
| 960 | <tr><td class="h"><a name="801"></a>801</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr> |
| 961 | <tr><td class="h"><a name="802"></a>802</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 962 | <tr><td class="h"><a name="803"></a>803</td><td></td><td></td><td></td><td></td><td class="s">The C<_DRIVER> function is intended to be imported into your</td></tr> |
| 963 | <tr><td class="h"><a name="804"></a>804</td><td></td><td></td><td></td><td></td><td class="s">package, and provides a convenient way to load and validate</td></tr> |
| 964 | <tr><td class="h"><a name="805"></a>805</td><td></td><td></td><td></td><td></td><td class="s">a driver class.</td></tr> |
| 965 | <tr><td class="h"><a name="806"></a>806</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 966 | <tr><td class="h"><a name="807"></a>807</td><td></td><td></td><td></td><td></td><td class="s">The most common pattern when taking a driver class as a parameter</td></tr> |
| 967 | <tr><td class="h"><a name="808"></a>808</td><td></td><td></td><td></td><td></td><td class="s">is to check that the name is a class (i.e. check against _CLASS)</td></tr> |
| 968 | <tr><td class="h"><a name="809"></a>809</td><td></td><td></td><td></td><td></td><td class="s">and then to load the class (if it exists) and then ensure that</td></tr> |
| 969 | <tr><td class="h"><a name="810"></a>810</td><td></td><td></td><td></td><td></td><td class="s">the class returns true for the isa method on some base driver name.</td></tr> |
| 970 | <tr><td class="h"><a name="811"></a>811</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 971 | <tr><td class="h"><a name="812"></a>812</td><td></td><td></td><td></td><td></td><td class="s">Return the value as a convenience, or C<undef> if the value is not</td></tr> |
| 972 | <tr><td class="h"><a name="813"></a>813</td><td></td><td></td><td></td><td></td><td class="s">a class name, the module does not exist, the module does not load,</td></tr> |
| 973 | <tr><td class="h"><a name="814"></a>814</td><td></td><td></td><td></td><td></td><td class="s">or the class fails the isa test.</td></tr> |
| 974 | <tr><td class="h"><a name="815"></a>815</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 975 | <tr><td class="h"><a name="816"></a>816</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 976 | <tr><td class="h"><a name="817"></a>817</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 977 | <tr><td class="h"><a name="818"></a>818</td><td class="c3">1</td><td class="c0"><span title="Avg 61µs">61µs</span></td><td></td><td></td><td class="s">eval <<'END_PERL' unless defined &_DRIVER;</td></tr> |
| 978 | <tr><td class="h"><a name="819"></a>819</td><td></td><td></td><td></td><td></td><td class="s">sub _DRIVER ($$) {</td></tr> |
| 979 | <tr><td class="h"><a name="820"></a>820</td><td></td><td></td><td></td><td></td><td class="s"> (defined _CLASS($_[0]) and eval "require $_[0];" and ! $@ and $_[0]->isa($_[1]) and $_[0] ne $_[1]) ? $_[0] : undef;</td></tr> |
| 980 | <tr><td class="h"><a name="821"></a>821</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr> |
| 981 | <tr><td class="h"><a name="822"></a>822</td><td></td><td></td><td></td><td></td><td class="s">END_PERL</td></tr> |
| 982 | <tr><td class="h"><a name="823"></a>823</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 983 | <tr><td class="h"><a name="824"></a>824</td><td class="c3">1</td><td class="c0"><span title="Avg 59µs">59µs</span></td><td></td><td></td><td class="s">1;</td></tr> |
| 984 | <tr><td class="h"><a name="825"></a>825</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 985 | <tr><td class="h"><a name="826"></a>826</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr> |
| 986 | <tr><td class="h"><a name="827"></a>827</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 987 | <tr><td class="h"><a name="828"></a>828</td><td></td><td></td><td></td><td></td><td class="s">=head1 TO DO</td></tr> |
| 988 | <tr><td class="h"><a name="829"></a>829</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 989 | <tr><td class="h"><a name="830"></a>830</td><td></td><td></td><td></td><td></td><td class="s">- Add _CAN to help resolve the UNIVERSAL::can debacle</td></tr> |
| 990 | <tr><td class="h"><a name="831"></a>831</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 991 | <tr><td class="h"><a name="832"></a>832</td><td></td><td></td><td></td><td></td><td class="s">- Would be even nicer if someone would demonstrate how the hell to</td></tr> |
| 992 | <tr><td class="h"><a name="833"></a>833</td><td></td><td></td><td></td><td></td><td class="s">build a Module::Install dist of the ::Util dual Perl/XS type. :/</td></tr> |
| 993 | <tr><td class="h"><a name="834"></a>834</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 994 | <tr><td class="h"><a name="835"></a>835</td><td></td><td></td><td></td><td></td><td class="s">- Implement an assertion-like version of this module, that dies on</td></tr> |
| 995 | <tr><td class="h"><a name="836"></a>836</td><td></td><td></td><td></td><td></td><td class="s">error.</td></tr> |
| 996 | <tr><td class="h"><a name="837"></a>837</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 997 | <tr><td class="h"><a name="838"></a>838</td><td></td><td></td><td></td><td></td><td class="s">- Implement a Test:: version of this module, for use in testing</td></tr> |
| 998 | <tr><td class="h"><a name="839"></a>839</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 999 | <tr><td class="h"><a name="840"></a>840</td><td></td><td></td><td></td><td></td><td class="s">=head1 SUPPORT</td></tr> |
| 1000 | <tr><td class="h"><a name="841"></a>841</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1001 | <tr><td class="h"><a name="842"></a>842</td><td></td><td></td><td></td><td></td><td class="s">Bugs should be reported via the CPAN bug tracker at</td></tr> |
| 1002 | <tr><td class="h"><a name="843"></a>843</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1003 | <tr><td class="h"><a name="844"></a>844</td><td></td><td></td><td></td><td></td><td class="s">L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Params-Util></td></tr> |
| 1004 | <tr><td class="h"><a name="845"></a>845</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1005 | <tr><td class="h"><a name="846"></a>846</td><td></td><td></td><td></td><td></td><td class="s">For other issues, contact the author.</td></tr> |
| 1006 | <tr><td class="h"><a name="847"></a>847</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1007 | <tr><td class="h"><a name="848"></a>848</td><td></td><td></td><td></td><td></td><td class="s">=head1 AUTHOR</td></tr> |
| 1008 | <tr><td class="h"><a name="849"></a>849</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1009 | <tr><td class="h"><a name="850"></a>850</td><td></td><td></td><td></td><td></td><td class="s">Adam Kennedy E<lt>adamk@cpan.orgE<gt></td></tr> |
| 1010 | <tr><td class="h"><a name="851"></a>851</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1011 | <tr><td class="h"><a name="852"></a>852</td><td></td><td></td><td></td><td></td><td class="s">=head1 SEE ALSO</td></tr> |
| 1012 | <tr><td class="h"><a name="853"></a>853</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1013 | <tr><td class="h"><a name="854"></a>854</td><td></td><td></td><td></td><td></td><td class="s">L<Params::Validate></td></tr> |
| 1014 | <tr><td class="h"><a name="855"></a>855</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1015 | <tr><td class="h"><a name="856"></a>856</td><td></td><td></td><td></td><td></td><td class="s">=head1 COPYRIGHT</td></tr> |
| 1016 | <tr><td class="h"><a name="857"></a>857</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1017 | <tr><td class="h"><a name="858"></a>858</td><td></td><td></td><td></td><td></td><td class="s">Copyright 2005 - 2012 Adam Kennedy.</td></tr> |
| 1018 | <tr><td class="h"><a name="859"></a>859</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1019 | <tr><td class="h"><a name="860"></a>860</td><td></td><td></td><td></td><td></td><td class="s">This program is free software; you can redistribute</td></tr> |
| 1020 | <tr><td class="h"><a name="861"></a>861</td><td></td><td></td><td></td><td></td><td class="s">it and/or modify it under the same terms as Perl itself.</td></tr> |
| 1021 | <tr><td class="h"><a name="862"></a>862</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1022 | <tr><td class="h"><a name="863"></a>863</td><td></td><td></td><td></td><td></td><td class="s">The full text of the license can be found in the</td></tr> |
| 1023 | <tr><td class="h"><a name="864"></a>864</td><td></td><td></td><td></td><td></td><td class="s">LICENSE file included with this module.</td></tr> |
| 1024 | <tr><td class="h"><a name="865"></a>865</td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1025 | <tr><td class="h"><a name="866"></a>866</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr> |
| 1026 | <tr><td class="s"><a name=""></a> </td><td></td><td></td><td></td><td></td><td class="s"></td></tr> |
| 1027 | <tr><td class="h"><a name="Params__Util__CORE_match"></a></td><td></td><td></td><td></td><td></td><td class="s"><div class="calls"><div class="calls_in"># spent 109µs within Params::Util::CORE:match which was called 32 times, avg 3µs/call: |
| 1028 | # 32 times (109µs+0s) by Params::Util::_CLASS at <a href="(eval 21)[Params-Util-pm-190]-1291-line.html#2">line 2 of (eval 21)[Params/Util.pm:190]</a>, avg 3µs/call</div></div>sub Params::Util::CORE:match; # opcode<br /> </td></tr> |
| 1029 | <tr><td class="h"><a name="Params__Util___ARRAYLIKE"></a></td><td></td><td></td><td></td><td></td><td class="s"><div class="calls"><div class="calls_in"># spent 18µs within Params::Util::_ARRAYLIKE which was called 18 times, avg 989ns/call: |
| 1030 | # 18 times (18µs+0s) by Data::OptList::__is_a at <a href="Data-OptList-pm-69-block.html#30">line 30 of Data/OptList.pm</a>, avg 989ns/call</div></div>sub Params::Util::_ARRAYLIKE; # xsub<br /> </td></tr> |
| 1031 | <tr><td class="h"><a name="Params__Util___CODELIKE"></a></td><td></td><td></td><td></td><td></td><td class="s"><div class="calls"><div class="calls_in"># spent 3.36ms within Params::Util::_CODELIKE which was called 5033 times, avg 668ns/call: |
| 1032 | # 3771 times (2.20ms+0s) by Sub::Exporter::default_generator at <a href="Sub-Exporter-pm-112-block.html#856">line 856 of Sub/Exporter.pm</a>, avg 584ns/call |
| 1033 | # 656 times (441µs+0s) by Data::OptList::__is_a at <a href="Data-OptList-pm-69-block.html#30">line 30 of Data/OptList.pm</a>, avg 673ns/call |
| 1034 | # 559 times (679µs+0s) by Sub::Exporter::_expand_group at <a href="Sub-Exporter-pm-112-block.html#481">line 481 of Sub/Exporter.pm</a>, avg 1µs/call |
| 1035 | # 32 times (23µs+0s) by PPI::Node::_wanted at <a href="PPI-Node-pm-921-block.html#609">line 609 of PPI/Node.pm</a>, avg 719ns/call |
| 1036 | # 15 times (19µs+0s) by Sub::Exporter::_do_import at <a href="Sub-Exporter-pm-112-block.html#771">line 771 of Sub/Exporter.pm</a>, avg 1µs/call</div></div>sub Params::Util::_CODELIKE; # xsub<br /> </td></tr> |
| 1037 | <tr><td class="h"><a name="Params__Util___HASH0"></a></td><td></td><td></td><td></td><td></td><td class="s"><div class="calls"><div class="calls_in"># spent 4µs within Params::Util::_HASH0 which was called 3 times, avg 1µs/call: |
| 1038 | # 3 times (4µs+0s) by Package::DeprecationManager::import at <a href="Package-DeprecationManager-pm-80-block.html#18">line 18 of Package/DeprecationManager.pm</a>, avg 1µs/call</div></div>sub Params::Util::_HASH0; # xsub<br /> </td></tr> |
| 1039 | <tr><td class="h"><a name="Params__Util___HASHLIKE"></a></td><td></td><td></td><td></td><td></td><td class="s"><div class="calls"><div class="calls_in"># spent 690µs within Params::Util::_HASHLIKE which was called 835 times, avg 826ns/call: |
| 1040 | # 817 times (667µs+0s) by Data::OptList::mkopt at <a href="Data-OptList-pm-69-block.html#42">line 42 of Data/OptList.pm</a>, avg 817ns/call |
| 1041 | # 18 times (22µs+0s) by Data::OptList::__is_a at <a href="Data-OptList-pm-69-block.html#30">line 30 of Data/OptList.pm</a>, avg 1µs/call</div></div>sub Params::Util::_HASHLIKE; # xsub<br /> </td></tr> |
| 1042 | <tr><td class="h"><a name="Params__Util___INSTANCE"></a></td><td></td><td></td><td></td><td></td><td class="s"><div class="calls"><div class="calls_in"># spent 255µs (214+40) within Params::Util::_INSTANCE which was called 48 times, avg 5µs/call: |
| 1043 | # 8 times (81µs+10µs) by PPI::Lexer::lex_tokenizer at <a href="PPI-Lexer-pm-1005-block.html#215">line 215 of PPI/Lexer.pm</a>, avg 11µs/call |
| 1044 | # 8 times (40µs+16µs) by PPI::Lexer::_statement at <a href="PPI-Lexer-pm-1005-block.html#585">line 585 of PPI/Lexer.pm</a>, avg 7µs/call |
| 1045 | # 8 times (36µs+8µs) by PPI::Node::add_element at <a href="PPI-Node-pm-921-block.html#114">line 114 of PPI/Node.pm</a>, avg 6µs/call |
| 1046 | # 8 times (35µs+6µs) by PPI::Statement::new at <a href="PPI-Statement-pm-969-block.html#203">line 203 of PPI/Statement.pm</a>, avg 5µs/call |
| 1047 | # 8 times (13µs+0s) by PPI::Lexer::lex_source at <a href="PPI-Lexer-pm-1005-block.html#193">line 193 of PPI/Lexer.pm</a>, avg 2µs/call |
| 1048 | # 8 times (9µs+0s) by PPI::Token::Symbol::symbol at <a href="PPI-Token-Symbol-pm-936-block.html#98">line 98 of PPI/Token/Symbol.pm</a>, avg 1µs/call</div></div>sub Params::Util::_INSTANCE; # xsub<br /> </td></tr> |
| 1049 | <tr><td class="h"><a name="Params__Util___SCALAR0"></a></td><td></td><td></td><td></td><td></td><td class="s"><div class="calls"><div class="calls_in"># spent 495µs within Params::Util::_SCALAR0 which was called 591 times, avg 838ns/call: |
| 1050 | # 559 times (452µs+0s) by Sub::Exporter::_expand_group at <a href="Sub-Exporter-pm-112-block.html#481">line 481 of Sub/Exporter.pm</a>, avg 809ns/call |
| 1051 | # 14 times (18µs+0s) by Sub::Exporter::__ANON__[/Users/edenc/perl5/lib/perl5/Sub/Exporter.pm:544] at <a href="Sub-Exporter-pm-112-block.html#536">line 536 of Sub/Exporter.pm</a>, avg 1µs/call |
| 1052 | # 8 times (15µs+0s) by PPI::Document::new at <a href="PPI-Document-pm-996-block.html#168">line 168 of PPI/Document.pm</a>, avg 2µs/call |
| 1053 | # 8 times (8µs+0s) by PPI::Tokenizer::new at <a href="PPI-Tokenizer-pm-1003-block.html#148">line 148 of PPI/Tokenizer.pm</a>, avg 1µs/call |
| 1054 | # 2 times (2µs+0s) by Data::OptList::__is_a at <a href="Data-OptList-pm-69-block.html#30">line 30 of Data/OptList.pm</a>, avg 850ns/call</div></div>sub Params::Util::_SCALAR0; # xsub<br /> </td></tr> |
| 1055 | <tr><td class="h"><a name="Params__Util__bootstrap"></a></td><td></td><td></td><td></td><td></td><td class="s"><div class="calls"><div class="calls_in"># spent 35µs within Params::Util::bootstrap which was called: |
| 1056 | # once (35µs+0s) by DynaLoader::bootstrap at <a href="DynaLoader-pm-71-block.html#217">line 217 of DynaLoader.pm</a></div></div>sub Params::Util::bootstrap; # xsub<br /> </td></tr> |
| 1057 | </tbody></table></div> |
| 1058 | |
| 1059 | <script type="text/javascript"> $(document).ready(function() { |
| 1060 | |
| 1061 | $("#subs_table").tablesorter({ |
| 1062 | sortList: [[3,1]], |
| 1063 | headers: { |
| 1064 | 3: { sorter: 'fmt_time' }, |
| 1065 | 4: { sorter: 'fmt_time' } |
| 1066 | } |
| 1067 | }); |
| 1068 | |
| 1069 | } ); </script> |
| 1070 | |
| 1071 | <div class="footer">Report produced by the |
| 1072 | <a href="http://search.cpan.org/dist/Devel-NYTProf/">NYTProf 4.06</a> |
| 1073 | Perl profiler, developed by |
| 1074 | <a href="http://www.linkedin.com/in/timbunce">Tim Bunce</a> and |
| 1075 | <a href="http://code.nytimes.com">Adam Kaplan</a>. |
| 1076 | </div> |
| 1077 | <br /><br /><br /><br /><br /><br /><br /><br /><br /><br /> |
| 1078 | </body></html> |
projects / scpubgit/stemmatology.git / blame