nytprof run results of /variantgraph/<ID> and /relation/<ID>/relationships
[scpubgit/stemmatology.git] / stemmaweb / nytprof-runs / variantgraph-uuid / PPI-Document-pm-996-line.html
CommitLineData
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<!--
4This 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 PPI/Document.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 &micro; ? */
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">&larr; Index</a>
48 </div>
49<div class="headerForeground" style="float: left">
50 <span class="siteTitle">NYTProf Performance Profile</span>
51 <span class="siteSubtitle">&emsp;&emsp;<span>&laquo;&emsp;<span class="mode_btn"><a href="PPI-Document-pm-996-block.html">block view</a></span>&emsp;&bull;&emsp;<span class="mode_btn mode_btn_selected">line view</span>&emsp;&bull;&emsp;<span class="mode_btn"><a href="PPI-Document-pm-996-sub.html">sub view</a></span>&emsp;&raquo;</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">&nbsp;</span>
57 <span class="siteSubtitle">Run on Thu May 31 16:29:39 2012<br />Reported on Thu May 31 16:39:55 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/PPI/Document.pm">/Users/edenc/perl5/lib/perl5/PPI/Document.pm</a></td></tr>
114<tr><td class="h">Statements</td><td align="left">Executed 209 statements in 3.79ms</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">16</td><td class="c1">2</td><td class="c1">2</td><td class="c0"><span title="0.0%">335&micro;s</span></td><td class="c0"><span title="0.0%">9.66ms</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::new</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#148">new</a>&nbsp;(recurses: max depth 1, inclusive time 438&micro;s)</span></td></tr>
130<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c0"><span title="0.0%">237&micro;s</span></td><td class="c0"><span title="0.0%">312&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@86</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#86">BEGIN@86</a></span></td></tr>
131<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c0"><span title="0.0%">208&micro;s</span></td><td class="c0"><span title="0.0%">321&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@74</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#74">BEGIN@74</a></span></td></tr>
132<tr><td class="c0">8</td><td class="c3">1</td><td class="c3">1</td><td class="c0"><span title="0.0%">35&micro;s</span></td><td class="c3"><span title="0.0%">35&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::_setattr</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#275">_setattr</a></span></td></tr>
133<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c0"><span title="0.0%">16&micro;s</span></td><td class="c3"><span title="0.0%">19&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@66</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#66">BEGIN@66</a></span></td></tr>
134<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c0"><span title="0.0%">15&micro;s</span></td><td class="c1"><span title="0.0%">70&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@76</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#76">BEGIN@76</a></span></td></tr>
135<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c2"><span title="0.0%">10&micro;s</span></td><td class="c3"><span title="0.0%">10&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@80</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#80">BEGIN@80</a></span></td></tr>
136<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c2"><span title="0.0%">9&micro;s</span></td><td class="c2"><span title="0.0%">57&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@92</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#92">BEGIN@92</a></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%">8&micro;s</span></td><td class="c3"><span title="0.0%">36&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@77</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#77">BEGIN@77</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%">7&micro;s</span></td><td class="c2"><span title="0.0%">50&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@79</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#79">BEGIN@79</a></span></td></tr>
139<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">7&micro;s</span></td><td class="c3"><span title="0.0%">42&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@69</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#69">BEGIN@69</a></span></td></tr>
140<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">6&micro;s</span></td><td class="c3"><span title="0.0%">35&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@93</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#93">BEGIN@93</a></span></td></tr>
141<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">6&micro;s</span></td><td class="c3"><span title="0.0%">33&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@95</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#95">BEGIN@95</a></span></td></tr>
142<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">6&micro;s</span></td><td class="c3"><span title="0.0%">34&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@96</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#96">BEGIN@96</a></span></td></tr>
143<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">6&micro;s</span></td><td class="c3"><span title="0.0%">34&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@94</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#94">BEGIN@94</a></span></td></tr>
144<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">4&micro;s</span></td><td class="c3"><span title="0.0%">4&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@70</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#70">BEGIN@70</a></span></td></tr>
145<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">4&micro;s</span></td><td class="c3"><span title="0.0%">4&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@67</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#67">BEGIN@67</a></span></td></tr>
146<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">4&micro;s</span></td><td class="c3"><span title="0.0%">4&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@68</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#68">BEGIN@68</a></span></td></tr>
147<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">3&micro;s</span></td><td class="c3"><span title="0.0%">3&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@71</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#71">BEGIN@71</a></span></td></tr>
148<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">3&micro;s</span></td><td class="c3"><span title="0.0%">3&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@73</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#73">BEGIN@73</a></span></td></tr>
149<tr><td class="c3">1</td><td class="c3">1</td><td class="c3">1</td><td class="c3"><span title="0.0%">3&micro;s</span></td><td class="c3"><span title="0.0%">3&micro;s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::BEGIN@72</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#72">BEGIN@72</a></span></td></tr>
150<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::STORABLE_freeze</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#911">STORABLE_freeze</a></span></td></tr>
151<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::STORABLE_thaw</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#918">STORABLE_thaw</a></span></td></tr>
152<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::__ANON__[:192]</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#192">__ANON__[:192]</a></span></td></tr>
153<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::__ANON__[:208]</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#208">__ANON__[:208]</a></span></td></tr>
154<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::__ANON__[:223]</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#223">__ANON__[:223]</a></span></td></tr>
155<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::__ANON__[:238]</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#238">__ANON__[:238]</a></span></td></tr>
156<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::__ANON__[:490]</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#488">__ANON__[:490]</a></span></td></tr>
157<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::__ANON__[:505]</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#498">__ANON__[:505]</a></span></td></tr>
158<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::__ANON__[:820]</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#816">__ANON__[:820]</a></span></td></tr>
159<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::_add_location</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#636">_add_location</a></span></td></tr>
160<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::_clear</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#884">_clear</a></span></td></tr>
161<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::_error</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#877">_error</a></span></td></tr>
162<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::_logical_line_and_file</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#683">_logical_line_and_file</a></span></td></tr>
163<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::_visual_length</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#737">_visual_length</a></span></td></tr>
164<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::complete</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#812">complete</a></span></td></tr>
165<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::errstr</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#900">errstr</a></span></td></tr>
166<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::flush_locations</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#770">flush_locations</a></span></td></tr>
167<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::get_cache</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#330">get_cache</a></span></td></tr>
168<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::hex_id</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#567">hex_id</a></span></td></tr>
169<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::index_locations</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#590">index_locations</a></span></td></tr>
170<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::insert_after</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#859">insert_after</a></span></td></tr>
171<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::insert_before</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#854">insert_before</a></span></td></tr>
172<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::load</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#271">load</a></span></td></tr>
173<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::normalized</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#793">normalized</a></span></td></tr>
174<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::readonly</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#354">readonly</a></span></td></tr>
175<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::replace</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#864">replace</a></span></td></tr>
176<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::save</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#392">save</a></span></td></tr>
177<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::scope</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#845">scope</a></span></td></tr>
178<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::serialize</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#421">serialize</a></span></td></tr>
179<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::set_cache</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#303">set_cache</a></span></td></tr>
180<tr><td class="c3">0</td><td class="c3">0</td><td class="c3">0</td><td class="c3"><span title="0.0%">0s</span></td><td class="c3"><span title="0.0%">0s</span></td><td class="sub_name"><span style="display: none;">PPI::Document::::tab_width</span>PPI::Document::<a href="PPI-Document-pm-996-line.html#374">tab_width</a></span></td></tr>
181</tbody></table>
182 Call graph for these subroutines as a
183 <a href="http://en.wikipedia.org/wiki/Graphviz">Graphviz</a>
184 <a href="Users-edenc-perl5-lib-perl5-PPI-Document-pm.dot">dot language file</a>.
185
186 <table border="1" cellpadding="0">
187 <thead>
188 <tr><th>Line</th>
189 <th><span title="Number of statements executed">State<br />ments</span></th>
190 <th><span title="Time spend executing statements on the line,
191 excluding time spent executing statements in any called subroutines">Time<br />on line</span></th>
192 <th><span title="Number of subroutines calls">Calls</span></th>
193 <th><span title="Time spent in subroutines called (inclusive)">Time<br />in subs</span></th>
194 <th class="left_indent_header">Code</th>
195 </tr>
196
197 </thead>
198 <tbody>
199 <tr><td class="h"><a name="1"></a>1</td><td></td><td></td><td></td><td></td><td class="s">package PPI::Document;</td></tr>
200<tr><td class="h"><a name="2"></a>2</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
201<tr><td class="h"><a name="3"></a>3</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
202<tr><td class="h"><a name="4"></a>4</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
203<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>
204<tr><td class="h"><a name="6"></a>6</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
205<tr><td class="h"><a name="7"></a>7</td><td></td><td></td><td></td><td></td><td class="s">PPI::Document - Object representation of a Perl document</td></tr>
206<tr><td class="h"><a name="8"></a>8</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
207<tr><td class="h"><a name="9"></a>9</td><td></td><td></td><td></td><td></td><td class="s">=head1 INHERITANCE</td></tr>
208<tr><td class="h"><a name="10"></a>10</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
209<tr><td class="h"><a name="11"></a>11</td><td></td><td></td><td></td><td></td><td class="s"> PPI::Document</td></tr>
210<tr><td class="h"><a name="12"></a>12</td><td></td><td></td><td></td><td></td><td class="s"> isa PPI::Node</td></tr>
211<tr><td class="h"><a name="13"></a>13</td><td></td><td></td><td></td><td></td><td class="s"> isa PPI::Element</td></tr>
212<tr><td class="h"><a name="14"></a>14</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
213<tr><td class="h"><a name="15"></a>15</td><td></td><td></td><td></td><td></td><td class="s">=head1 SYNOPSIS</td></tr>
214<tr><td class="h"><a name="16"></a>16</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
215<tr><td class="h"><a name="17"></a>17</td><td></td><td></td><td></td><td></td><td class="s"> use PPI;</td></tr>
216<tr><td class="h"><a name="18"></a>18</td><td></td><td></td><td></td><td></td><td class="s"> </td></tr>
217<tr><td class="h"><a name="19"></a>19</td><td></td><td></td><td></td><td></td><td class="s"> # Load a document from a file</td></tr>
218<tr><td class="h"><a name="20"></a>20</td><td></td><td></td><td></td><td></td><td class="s"> my $Document = PPI::Document-&gt;new('My/Module.pm');</td></tr>
219<tr><td class="h"><a name="21"></a>21</td><td></td><td></td><td></td><td></td><td class="s"> </td></tr>
220<tr><td class="h"><a name="22"></a>22</td><td></td><td></td><td></td><td></td><td class="s"> # Strip out comments</td></tr>
221<tr><td class="h"><a name="23"></a>23</td><td></td><td></td><td></td><td></td><td class="s"> $Document-&gt;prune('PPI::Token::Comment');</td></tr>
222<tr><td class="h"><a name="24"></a>24</td><td></td><td></td><td></td><td></td><td class="s"> </td></tr>
223<tr><td class="h"><a name="25"></a>25</td><td></td><td></td><td></td><td></td><td class="s"> # Find all the named subroutines</td></tr>
224<tr><td class="h"><a name="26"></a>26</td><td></td><td></td><td></td><td></td><td class="s"> my $sub_nodes = $Document-&gt;find( </td></tr>
225<tr><td class="h"><a name="27"></a>27</td><td></td><td></td><td></td><td></td><td class="s"> sub { $_[1]-&gt;isa('PPI::Statement::Sub') and $_[1]-&gt;name }</td></tr>
226<tr><td class="h"><a name="28"></a>28</td><td></td><td></td><td></td><td></td><td class="s"> );</td></tr>
227<tr><td class="h"><a name="29"></a>29</td><td></td><td></td><td></td><td></td><td class="s"> my @sub_names = map { $_-&gt;name } @$sub_nodes;</td></tr>
228<tr><td class="h"><a name="30"></a>30</td><td></td><td></td><td></td><td></td><td class="s"> </td></tr>
229<tr><td class="h"><a name="31"></a>31</td><td></td><td></td><td></td><td></td><td class="s"> # Save the file</td></tr>
230<tr><td class="h"><a name="32"></a>32</td><td></td><td></td><td></td><td></td><td class="s"> $Document-&gt;save('My/Module.pm.stripped');</td></tr>
231<tr><td class="h"><a name="33"></a>33</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
232<tr><td class="h"><a name="34"></a>34</td><td></td><td></td><td></td><td></td><td class="s">=head1 DESCRIPTION</td></tr>
233<tr><td class="h"><a name="35"></a>35</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
234<tr><td class="h"><a name="36"></a>36</td><td></td><td></td><td></td><td></td><td class="s">The C&lt;PPI::Document&gt; class represents a single Perl &quot;document&quot;. A</td></tr>
235<tr><td class="h"><a name="37"></a>37</td><td></td><td></td><td></td><td></td><td class="s">C&lt;PPI::Document&gt; object acts as a root L&lt;PPI::Node&gt;, with some</td></tr>
236<tr><td class="h"><a name="38"></a>38</td><td></td><td></td><td></td><td></td><td class="s">additional methods for loading and saving, and working with</td></tr>
237<tr><td class="h"><a name="39"></a>39</td><td></td><td></td><td></td><td></td><td class="s">the line/column locations of Elements within a file.</td></tr>
238<tr><td class="h"><a name="40"></a>40</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
239<tr><td class="h"><a name="41"></a>41</td><td></td><td></td><td></td><td></td><td class="s">The exemption to its L&lt;PPI::Node&gt;-like behavior this is that a</td></tr>
240<tr><td class="h"><a name="42"></a>42</td><td></td><td></td><td></td><td></td><td class="s">C&lt;PPI::Document&gt; object can NEVER have a parent node, and is always</td></tr>
241<tr><td class="h"><a name="43"></a>43</td><td></td><td></td><td></td><td></td><td class="s">the root node in a tree.</td></tr>
242<tr><td class="h"><a name="44"></a>44</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
243<tr><td class="h"><a name="45"></a>45</td><td></td><td></td><td></td><td></td><td class="s">=head2 Storable Support</td></tr>
244<tr><td class="h"><a name="46"></a>46</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
245<tr><td class="h"><a name="47"></a>47</td><td></td><td></td><td></td><td></td><td class="s">C&lt;PPI::Document&gt; implements the necessary C&lt;STORABLE_freeze&gt; and</td></tr>
246<tr><td class="h"><a name="48"></a>48</td><td></td><td></td><td></td><td></td><td class="s">C&lt;STORABLE_thaw&gt; hooks to provide native support for L&lt;Storable&gt;,</td></tr>
247<tr><td class="h"><a name="49"></a>49</td><td></td><td></td><td></td><td></td><td class="s">if you have it installed.</td></tr>
248<tr><td class="h"><a name="50"></a>50</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
249<tr><td class="h"><a name="51"></a>51</td><td></td><td></td><td></td><td></td><td class="s">However if you want to clone clone a Document, you are highly recommended</td></tr>
250<tr><td class="h"><a name="52"></a>52</td><td></td><td></td><td></td><td></td><td class="s">to use the internal C&lt;$Document-E&lt;gt&gt;clone&gt; method rather than Storable's</td></tr>
251<tr><td class="h"><a name="53"></a>53</td><td></td><td></td><td></td><td></td><td class="s">C&lt;dclone&gt; function (although C&lt;dclone&gt; should still work).</td></tr>
252<tr><td class="h"><a name="54"></a>54</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
253<tr><td class="h"><a name="55"></a>55</td><td></td><td></td><td></td><td></td><td class="s">=head1 METHODS</td></tr>
254<tr><td class="h"><a name="56"></a>56</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
255<tr><td class="h"><a name="57"></a>57</td><td></td><td></td><td></td><td></td><td class="s">Most of the things you are likely to want to do with a Document are</td></tr>
256<tr><td class="h"><a name="58"></a>58</td><td></td><td></td><td></td><td></td><td class="s">probably going to involve the methods from L&lt;PPI::Node&gt; class, of which</td></tr>
257<tr><td class="h"><a name="59"></a>59</td><td></td><td></td><td></td><td></td><td class="s">this is a subclass.</td></tr>
258<tr><td class="h"><a name="60"></a>60</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
259<tr><td class="h"><a name="61"></a>61</td><td></td><td></td><td></td><td></td><td class="s">The methods listed here are the remaining few methods that are truly</td></tr>
260<tr><td class="h"><a name="62"></a>62</td><td></td><td></td><td></td><td></td><td class="s">Document-specific.</td></tr>
261<tr><td class="h"><a name="63"></a>63</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
262<tr><td class="h"><a name="64"></a>64</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
263<tr><td class="h"><a name="65"></a>65</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
264<tr><td class="h"><a name="66"></a>66</td><td class="c3">2</td><td class="c3"><span title="Avg 11&micro;s">23&micro;s</span></td><td class="c3">2</td><td class="c3">23&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 19&micro;s (16+3) within PPI::Document::BEGIN@66 which was called:
265# once (16&micro;s+3&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#66">line 66</a></div></div>use strict;<div class="calls"><div class="calls_out"># spent 19&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#66">PPI::Document::BEGIN@66</a>
266# spent 3&micro;s making 1 call to <a href="strict-pm-3-line.html#34">strict::import</a></div></div></td></tr>
267<tr><td class="h"><a name="67"></a>67</td><td class="c3">2</td><td class="c3"><span title="Avg 9&micro;s">19&micro;s</span></td><td class="c3">1</td><td class="c3">4&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 4&micro;s within PPI::Document::BEGIN@67 which was called:
268# once (4&micro;s+0s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#67">line 67</a></div></div>use Carp ();<div class="calls"><div class="calls_out"># spent 4&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#67">PPI::Document::BEGIN@67</a></div></div></td></tr>
269<tr><td class="h"><a name="68"></a>68</td><td class="c3">2</td><td class="c3"><span title="Avg 11&micro;s">21&micro;s</span></td><td class="c3">1</td><td class="c3">4&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 4&micro;s within PPI::Document::BEGIN@68 which was called:
270# once (4&micro;s+0s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#68">line 68</a></div></div>use List::MoreUtils ();<div class="calls"><div class="calls_out"># spent 4&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#68">PPI::Document::BEGIN@68</a></div></div></td></tr>
271<tr><td class="h"><a name="69"></a>69</td><td class="c3">2</td><td class="c3"><span title="Avg 11&micro;s">23&micro;s</span></td><td class="c3">2</td><td class="c3">76&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 42&micro;s (7+35) within PPI::Document::BEGIN@69 which was called:
272# once (7&micro;s+35&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#69">line 69</a></div></div>use Params::Util qw{_SCALAR0 _ARRAY0 _INSTANCE};<div class="calls"><div class="calls_out"># spent 42&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#69">PPI::Document::BEGIN@69</a>
273# spent 35&micro;s making 1 call to <a href="Exporter-pm-8-line.html#28">Exporter::import</a></div></div></td></tr>
274<tr><td class="h"><a name="70"></a>70</td><td class="c3">2</td><td class="c3"><span title="Avg 9&micro;s">17&micro;s</span></td><td class="c3">1</td><td class="c3">4&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 4&micro;s within PPI::Document::BEGIN@70 which was called:
275# once (4&micro;s+0s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#70">line 70</a></div></div>use Digest::MD5 ();<div class="calls"><div class="calls_out"># spent 4&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#70">PPI::Document::BEGIN@70</a></div></div></td></tr>
276<tr><td class="h"><a name="71"></a>71</td><td class="c3">2</td><td class="c3"><span title="Avg 8&micro;s">16&micro;s</span></td><td class="c3">1</td><td class="c3">3&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 3&micro;s within PPI::Document::BEGIN@71 which was called:
277# once (3&micro;s+0s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#71">line 71</a></div></div>use PPI::Util ();<div class="calls"><div class="calls_out"># spent 3&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#71">PPI::Document::BEGIN@71</a></div></div></td></tr>
278<tr><td class="h"><a name="72"></a>72</td><td class="c3">2</td><td class="c3"><span title="Avg 8&micro;s">16&micro;s</span></td><td class="c3">1</td><td class="c3">3&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 3&micro;s within PPI::Document::BEGIN@72 which was called:
279# once (3&micro;s+0s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#72">line 72</a></div></div>use PPI ();<div class="calls"><div class="calls_out"># spent 3&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#72">PPI::Document::BEGIN@72</a></div></div></td></tr>
280<tr><td class="h"><a name="73"></a>73</td><td class="c3">2</td><td class="c3"><span title="Avg 8&micro;s">17&micro;s</span></td><td class="c3">1</td><td class="c3">3&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 3&micro;s within PPI::Document::BEGIN@73 which was called:
281# once (3&micro;s+0s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#73">line 73</a></div></div>use PPI::Node ();<div class="calls"><div class="calls_out"># spent 3&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#73">PPI::Document::BEGIN@73</a></div></div></td></tr>
282<tr><td class="h"><a name="74"></a>74</td><td class="c3">2</td><td class="c0"><span title="Avg 70&micro;s">140&micro;s</span></td><td class="c3">1</td><td class="c0">321&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 321&micro;s (208+113) within PPI::Document::BEGIN@74 which was called:
283# once (208&micro;s+113&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#74">line 74</a></div></div>use PPI::Exception::ParserTimeout ();<div class="calls"><div class="calls_out"># spent 321&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#74">PPI::Document::BEGIN@74</a></div></div></td></tr>
284<tr><td class="h"><a name="75"></a>75</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
285<tr><td class="h"><a name="76"></a>76</td><td class="c3">2</td><td class="c0"><span title="Avg 22&micro;s">45&micro;s</span></td><td class="c3">2</td><td class="c1">125&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 70&micro;s (15+55) within PPI::Document::BEGIN@76 which was called:
286# once (15&micro;s+55&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#76">line 76</a></div></div>use overload 'bool' =&gt; \&amp;PPI::Util::TRUE;<div class="calls"><div class="calls_out"># spent 70&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#76">PPI::Document::BEGIN@76</a>
287# spent 55&micro;s making 1 call to <a href="overload-pm-29-line.html#30">overload::import</a></div></div></td></tr>
288<tr><td class="h"><a name="77"></a>77</td><td class="c3">2</td><td class="c2"><span title="Avg 14&micro;s">28&micro;s</span></td><td class="c3">2</td><td class="c3">65&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 36&micro;s (8+28) within PPI::Document::BEGIN@77 which was called:
289# once (8&micro;s+28&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#77">line 77</a></div></div>use overload '&quot;&quot;' =&gt; 'content';<div class="calls"><div class="calls_out"># spent 36&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#77">PPI::Document::BEGIN@77</a>
290# spent 28&micro;s making 1 call to <a href="overload-pm-29-line.html#30">overload::import</a></div></div></td></tr>
291<tr><td class="h"><a name="78"></a>78</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
292<tr><td class="h"><a name="79"></a>79</td><td class="c3">2</td><td class="c1"><span title="Avg 21&micro;s">42&micro;s</span></td><td class="c3">2</td><td class="c2">94&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 50&micro;s (7+43) within PPI::Document::BEGIN@79 which was called:
293# once (7&micro;s+43&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#79">line 79</a></div></div>use vars qw{$VERSION @ISA $errstr};<div class="calls"><div class="calls_out"># spent 50&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#79">PPI::Document::BEGIN@79</a>
294# spent 43&micro;s making 1 call to <a href="vars-pm-6-line.html#10">vars::import</a></div></div></td></tr>
295<tr><td class="h"><a name="80"></a>80</td><td></td><td></td><td></td><td></td><td class="s"><div class="calls"><div class="calls_in"># spent 10&micro;s within PPI::Document::BEGIN@80 which was called:
296# once (10&micro;s+0s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#84">line 84</a></div></div>BEGIN {</td></tr>
297<tr><td class="h"><a name="81"></a>81</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.215';</td></tr>
298<tr><td class="h"><a name="82"></a>82</td><td class="c3">1</td><td class="c3"><span title="Avg 6&micro;s">6&micro;s</span></td><td></td><td></td><td class="s"> @ISA = 'PPI::Node';</td></tr>
299<tr><td class="h"><a name="83"></a>83</td><td class="c3">1</td><td class="c3"><span title="Avg 5&micro;s">5&micro;s</span></td><td></td><td></td><td class="s"> $errstr = '';</td></tr>
300<tr><td class="h"><a name="84"></a>84</td><td class="c3">1</td><td class="c3"><span title="Avg 19&micro;s">19&micro;s</span></td><td class="c3">1</td><td class="c3">10&micro;s</td><td class="s">}<div class="calls"><div class="calls_out"># spent 10&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#80">PPI::Document::BEGIN@80</a></div></div></td></tr>
301<tr><td class="h"><a name="85"></a>85</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
302<tr><td class="h"><a name="86"></a>86</td><td class="c3">2</td><td class="c0"><span title="Avg 60&micro;s">119&micro;s</span></td><td class="c3">1</td><td class="c0">312&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 312&micro;s (237+75) within PPI::Document::BEGIN@86 which was called:
303# once (237&micro;s+75&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#86">line 86</a></div></div>use PPI::Document::Fragment ();<div class="calls"><div class="calls_out"># spent 312&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#86">PPI::Document::BEGIN@86</a></div></div></td></tr>
304<tr><td class="h"><a name="87"></a>87</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
305<tr><td class="h"><a name="88"></a>88</td><td></td><td></td><td></td><td></td><td class="s"># Document cache</td></tr>
306<tr><td class="h"><a name="89"></a>89</td><td class="c3">1</td><td class="c3"><span title="Avg 400ns">400ns</span></td><td></td><td></td><td class="s">my $CACHE = undef;</td></tr>
307<tr><td class="h"><a name="90"></a>90</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
308<tr><td class="h"><a name="91"></a>91</td><td></td><td></td><td></td><td></td><td class="s"># Convenience constants related to constants</td></tr>
309<tr><td class="h"><a name="92"></a>92</td><td class="c3">2</td><td class="c2"><span title="Avg 14&micro;s">28&micro;s</span></td><td class="c3">2</td><td class="c2">104&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 57&micro;s (9+47) within PPI::Document::BEGIN@92 which was called:
310# once (9&micro;s+47&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#92">line 92</a></div></div>use constant LOCATION_LINE =&gt; 0;<div class="calls"><div class="calls_out"># spent 57&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#92">PPI::Document::BEGIN@92</a>
311# spent 47&micro;s making 1 call to <a href="constant-pm-28-line.html#42">constant::import</a></div></div></td></tr>
312<tr><td class="h"><a name="93"></a>93</td><td class="c3">2</td><td class="c3"><span title="Avg 12&micro;s">24&micro;s</span></td><td class="c3">2</td><td class="c3">64&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 35&micro;s (6+29) within PPI::Document::BEGIN@93 which was called:
313# once (6&micro;s+29&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#93">line 93</a></div></div>use constant LOCATION_CHARACTER =&gt; 1;<div class="calls"><div class="calls_out"># spent 35&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#93">PPI::Document::BEGIN@93</a>
314# spent 29&micro;s making 1 call to <a href="constant-pm-28-line.html#42">constant::import</a></div></div></td></tr>
315<tr><td class="h"><a name="94"></a>94</td><td class="c3">2</td><td class="c3"><span title="Avg 11&micro;s">23&micro;s</span></td><td class="c3">2</td><td class="c3">62&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 34&micro;s (6+28) within PPI::Document::BEGIN@94 which was called:
316# once (6&micro;s+28&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#94">line 94</a></div></div>use constant LOCATION_COLUMN =&gt; 2;<div class="calls"><div class="calls_out"># spent 34&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#94">PPI::Document::BEGIN@94</a>
317# spent 28&micro;s making 1 call to <a href="constant-pm-28-line.html#42">constant::import</a></div></div></td></tr>
318<tr><td class="h"><a name="95"></a>95</td><td class="c3">2</td><td class="c3"><span title="Avg 11&micro;s">22&micro;s</span></td><td class="c3">2</td><td class="c3">60&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 33&micro;s (6+27) within PPI::Document::BEGIN@95 which was called:
319# once (6&micro;s+27&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#95">line 95</a></div></div>use constant LOCATION_LOGICAL_LINE =&gt; 3;<div class="calls"><div class="calls_out"># spent 33&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#95">PPI::Document::BEGIN@95</a>
320# spent 27&micro;s making 1 call to <a href="constant-pm-28-line.html#42">constant::import</a></div></div></td></tr>
321<tr><td class="h"><a name="96"></a>96</td><td class="c3">2</td><td class="c0"><span title="Avg 1.39ms">2.77ms</span></td><td class="c3">2</td><td class="c3">62&micro;s</td><td class="s"><div class="calls"><div class="calls_in"># spent 34&micro;s (6+28) within PPI::Document::BEGIN@96 which was called:
322# once (6&micro;s+28&micro;s) by PPI::BEGIN@23 at <a href="PPI-Document-pm-996-line.html#96">line 96</a></div></div>use constant LOCATION_LOGICAL_FILE =&gt; 4;<div class="calls"><div class="calls_out"># spent 34&micro;s making 1 call to <a href="PPI-Document-pm-996-line.html#96">PPI::Document::BEGIN@96</a>
323# spent 28&micro;s making 1 call to <a href="constant-pm-28-line.html#42">constant::import</a></div></div></td></tr>
324<tr><td class="h"><a name="97"></a>97</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
325<tr><td class="h"><a name="- -"></a>- -</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
326<tr><td class="h"><a name="102"></a>102</td><td></td><td></td><td></td><td></td><td class="s">#####################################################################</td></tr>
327<tr><td class="h"><a name="103"></a>103</td><td></td><td></td><td></td><td></td><td class="s"># Constructor and Static Methods</td></tr>
328<tr><td class="h"><a name="104"></a>104</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
329<tr><td class="h"><a name="105"></a>105</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
330<tr><td class="h"><a name="106"></a>106</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
331<tr><td class="h"><a name="107"></a>107</td><td></td><td></td><td></td><td></td><td class="s">=head2 new</td></tr>
332<tr><td class="h"><a name="108"></a>108</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
333<tr><td class="h"><a name="109"></a>109</td><td></td><td></td><td></td><td></td><td class="s"> # Simple construction</td></tr>
334<tr><td class="h"><a name="110"></a>110</td><td></td><td></td><td></td><td></td><td class="s"> $doc = PPI::Document-&gt;new( $filename );</td></tr>
335<tr><td class="h"><a name="111"></a>111</td><td></td><td></td><td></td><td></td><td class="s"> $doc = PPI::Document-&gt;new( \$source );</td></tr>
336<tr><td class="h"><a name="112"></a>112</td><td></td><td></td><td></td><td></td><td class="s"> </td></tr>
337<tr><td class="h"><a name="113"></a>113</td><td></td><td></td><td></td><td></td><td class="s"> # With the readonly attribute set</td></tr>
338<tr><td class="h"><a name="114"></a>114</td><td></td><td></td><td></td><td></td><td class="s"> $doc = PPI::Document-&gt;new( $filename,</td></tr>
339<tr><td class="h"><a name="115"></a>115</td><td></td><td></td><td></td><td></td><td class="s"> readonly =&gt; 1,</td></tr>
340<tr><td class="h"><a name="116"></a>116</td><td></td><td></td><td></td><td></td><td class="s"> );</td></tr>
341<tr><td class="h"><a name="117"></a>117</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
342<tr><td class="h"><a name="118"></a>118</td><td></td><td></td><td></td><td></td><td class="s">The C&lt;new&gt; constructor takes as argument a variety of different sources of</td></tr>
343<tr><td class="h"><a name="119"></a>119</td><td></td><td></td><td></td><td></td><td class="s">Perl code, and creates a single cohesive Perl C&lt;PPI::Document&gt;</td></tr>
344<tr><td class="h"><a name="120"></a>120</td><td></td><td></td><td></td><td></td><td class="s">for it.</td></tr>
345<tr><td class="h"><a name="121"></a>121</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
346<tr><td class="h"><a name="122"></a>122</td><td></td><td></td><td></td><td></td><td class="s">If passed a file name as a normal string, it will attempt to load the</td></tr>
347<tr><td class="h"><a name="123"></a>123</td><td></td><td></td><td></td><td></td><td class="s">document from the file.</td></tr>
348<tr><td class="h"><a name="124"></a>124</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
349<tr><td class="h"><a name="125"></a>125</td><td></td><td></td><td></td><td></td><td class="s">If passed a reference to a C&lt;SCALAR&gt;, this is taken to be source code and</td></tr>
350<tr><td class="h"><a name="126"></a>126</td><td></td><td></td><td></td><td></td><td class="s">parsed directly to create the document.</td></tr>
351<tr><td class="h"><a name="127"></a>127</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
352<tr><td class="h"><a name="128"></a>128</td><td></td><td></td><td></td><td></td><td class="s">If passed zero arguments, a &quot;blank&quot; document will be created that contains</td></tr>
353<tr><td class="h"><a name="129"></a>129</td><td></td><td></td><td></td><td></td><td class="s">no content at all.</td></tr>
354<tr><td class="h"><a name="130"></a>130</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
355<tr><td class="h"><a name="131"></a>131</td><td></td><td></td><td></td><td></td><td class="s">In all cases, the document is considered to be &quot;anonymous&quot; and not tied back</td></tr>
356<tr><td class="h"><a name="132"></a>132</td><td></td><td></td><td></td><td></td><td class="s">to where it was created from. Specifically, if you create a PPI::Document from</td></tr>
357<tr><td class="h"><a name="133"></a>133</td><td></td><td></td><td></td><td></td><td class="s">a filename, the document will B&lt;not&gt; remember where it was created from.</td></tr>
358<tr><td class="h"><a name="134"></a>134</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
359<tr><td class="h"><a name="135"></a>135</td><td></td><td></td><td></td><td></td><td class="s">The constructor also takes attribute flags.</td></tr>
360<tr><td class="h"><a name="136"></a>136</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
361<tr><td class="h"><a name="137"></a>137</td><td></td><td></td><td></td><td></td><td class="s">At this time, the only available attribute is the C&lt;readonly&gt; flag.</td></tr>
362<tr><td class="h"><a name="138"></a>138</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
363<tr><td class="h"><a name="139"></a>139</td><td></td><td></td><td></td><td></td><td class="s">Setting C&lt;readonly&gt; to true will allow various systems to provide</td></tr>
364<tr><td class="h"><a name="140"></a>140</td><td></td><td></td><td></td><td></td><td class="s">additional optimisations and caching. Note that because C&lt;readonly&gt; is an</td></tr>
365<tr><td class="h"><a name="141"></a>141</td><td></td><td></td><td></td><td></td><td class="s">optimisation flag, it is off by default and you will need to explicitly</td></tr>
366<tr><td class="h"><a name="142"></a>142</td><td></td><td></td><td></td><td></td><td class="s">enable it.</td></tr>
367<tr><td class="h"><a name="143"></a>143</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
368<tr><td class="h"><a name="144"></a>144</td><td></td><td></td><td></td><td></td><td class="s">Returns a C&lt;PPI::Document&gt; object, or C&lt;undef&gt; if parsing fails.</td></tr>
369<tr><td class="h"><a name="145"></a>145</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
370<tr><td class="h"><a name="146"></a>146</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
371<tr><td class="h"><a name="147"></a>147</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
372<tr><td class="h"><a name="148"></a>148</td><td></td><td></td><td></td><td></td><td class="s"><div class="calls"><div class="calls_in"># spent 9.66ms (335&micro;s+9.33) within PPI::Document::new which was called 16 times, avg 604&micro;s/call:
373# 8 times (198&micro;s+9.47ms) by Parse::Method::Signatures::parse at <a href="Parse-Method-Signatures-pm-911-line.html#128">line 128 of Parse/Method/Signatures.pm</a>, avg 1.21ms/call
374# 8 times (137&micro;s+-137&micro;s) by PPI::Lexer::lex_tokenizer at <a href="PPI-Lexer-pm-1005-line.html#221">line 221 of PPI/Lexer.pm</a>, avg 0s/call</div></div>sub new {</td></tr>
375<tr><td class="h"><a name="149"></a>149</td><td class="c0">16</td><td class="c3"><span title="Avg 237ns">4&micro;s</span></td><td></td><td></td><td class="s"> local $_; # An extra one, just in case</td></tr>
376<tr><td class="h"><a name="150"></a>150</td><td class="c0">16</td><td class="c3"><span title="Avg 675ns">11&micro;s</span></td><td></td><td></td><td class="s"> my $class = ref $_[0] ? ref shift : shift;</td></tr>
377<tr><td class="h"><a name="151"></a>151</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
378<tr><td class="h"><a name="152"></a>152</td><td class="c0">16</td><td class="c3"><span title="Avg 412ns">7&micro;s</span></td><td></td><td></td><td class="s"> unless ( @_ ) {</td></tr>
379<tr><td class="h"><a name="153"></a>153</td><td class="c0">8</td><td class="c0"><span title="Avg 8&micro;s">66&micro;s</span></td><td class="c0">8</td><td class="c0">301&micro;s</td><td class="s"> my $self = $class-&gt;SUPER::new;<div class="calls"><div class="calls_out"> # spent 301&micro;s making 8 calls to <a href="PPI-Node-pm-921-line.html#72">PPI::Node::new</a>, avg 38&micro;s/call</div></div></td></tr>
380<tr><td class="h"><a name="154"></a>154</td><td class="c0">8</td><td class="c3"><span title="Avg 2&micro;s">12&micro;s</span></td><td></td><td></td><td class="s"> $self-&gt;{readonly} = ! 1;</td></tr>
381<tr><td class="h"><a name="155"></a>155</td><td class="c0">8</td><td class="c3"><span title="Avg 763ns">6&micro;s</span></td><td></td><td></td><td class="s"> $self-&gt;{tab_width} = 1;</td></tr>
382<tr><td class="h"><a name="156"></a>156</td><td class="c0">8</td><td class="c2"><span title="Avg 3&micro;s">28&micro;s</span></td><td></td><td></td><td class="s"> return $self;</td></tr>
383<tr><td class="h"><a name="157"></a>157</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
384<tr><td class="h"><a name="158"></a>158</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
385<tr><td class="h"><a name="159"></a>159</td><td></td><td></td><td></td><td></td><td class="s"> # Check constructor attributes</td></tr>
386<tr><td class="h"><a name="160"></a>160</td><td class="c0">8</td><td class="c3"><span title="Avg 350ns">3&micro;s</span></td><td></td><td></td><td class="s"> my $source = shift;</td></tr>
387<tr><td class="h"><a name="161"></a>161</td><td class="c0">8</td><td class="c3"><span title="Avg 1&micro;s">9&micro;s</span></td><td></td><td></td><td class="s"> my %attr = @_;</td></tr>
388<tr><td class="h"><a name="162"></a>162</td><td class="c0">8</td><td class="c3"><span title="Avg 600ns">5&micro;s</span></td><td></td><td></td><td class="s"> my $timeout = delete $attr{timeout};</td></tr>
389<tr><td class="h"><a name="163"></a>163</td><td class="c0">8</td><td class="c3"><span title="Avg 400ns">3&micro;s</span></td><td></td><td></td><td class="s"> if ( $timeout and ! PPI::Util::HAVE_ALARM() ) {</td></tr>
390<tr><td class="h"><a name="164"></a>164</td><td></td><td></td><td></td><td></td><td class="s"> Carp::croak(&quot;This platform does not support PPI parser timeouts&quot;);</td></tr>
391<tr><td class="h"><a name="165"></a>165</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
392<tr><td class="h"><a name="166"></a>166</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
393<tr><td class="h"><a name="167"></a>167</td><td></td><td></td><td></td><td></td><td class="s"> # Check the data source</td></tr>
394<tr><td class="h"><a name="168"></a>168</td><td class="c0">8</td><td class="c0"><span title="Avg 6&micro;s">48&micro;s</span></td><td class="c0">8</td><td class="c3">15&micro;s</td><td class="s"> if ( ! defined $source ) {<div class="calls"><div class="calls_out"> # spent 15&micro;s making 8 calls to <a href="Params-Util-pm-70-line.html#Params__Util___SCALAR0">Params::Util::_SCALAR0</a>, avg 2&micro;s/call</div></div></td></tr>
395<tr><td class="h"><a name="169"></a>169</td><td></td><td></td><td></td><td></td><td class="s"> $class-&gt;_error(&quot;An undefined value was passed to PPI::Document::new&quot;);</td></tr>
396<tr><td class="h"><a name="170"></a>170</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
397<tr><td class="h"><a name="171"></a>171</td><td></td><td></td><td></td><td></td><td class="s"> } elsif ( ! ref $source ) {</td></tr>
398<tr><td class="h"><a name="172"></a>172</td><td></td><td></td><td></td><td></td><td class="s"> # Catch people using the old API</td></tr>
399<tr><td class="h"><a name="173"></a>173</td><td></td><td></td><td></td><td></td><td class="s"> if ( $source =~ /(?:\012|\015)/ ) {</td></tr>
400<tr><td class="h"><a name="174"></a>174</td><td></td><td></td><td></td><td></td><td class="s"> Carp::croak(&quot;API CHANGE: Source code should only be passed to PPI::Document-&gt;new as a SCALAR reference&quot;);</td></tr>
401<tr><td class="h"><a name="175"></a>175</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
402<tr><td class="h"><a name="176"></a>176</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
403<tr><td class="h"><a name="177"></a>177</td><td></td><td></td><td></td><td></td><td class="s"> # When loading from a filename, use the caching layer if it exists.</td></tr>
404<tr><td class="h"><a name="178"></a>178</td><td></td><td></td><td></td><td></td><td class="s"> if ( $CACHE ) {</td></tr>
405<tr><td class="h"><a name="179"></a>179</td><td></td><td></td><td></td><td></td><td class="s"> my $file = $source;</td></tr>
406<tr><td class="h"><a name="180"></a>180</td><td></td><td></td><td></td><td></td><td class="s"> my $source = PPI::Util::_slurp( $file );</td></tr>
407<tr><td class="h"><a name="181"></a>181</td><td></td><td></td><td></td><td></td><td class="s"> unless ( ref $source ) {</td></tr>
408<tr><td class="h"><a name="182"></a>182</td><td></td><td></td><td></td><td></td><td class="s"> # Errors returned as plain string</td></tr>
409<tr><td class="h"><a name="183"></a>183</td><td></td><td></td><td></td><td></td><td class="s"> return $class-&gt;_error($source);</td></tr>
410<tr><td class="h"><a name="184"></a>184</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
411<tr><td class="h"><a name="185"></a>185</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
412<tr><td class="h"><a name="186"></a>186</td><td></td><td></td><td></td><td></td><td class="s"> # Retrieve the document from the cache</td></tr>
413<tr><td class="h"><a name="187"></a>187</td><td></td><td></td><td></td><td></td><td class="s"> my $document = $CACHE-&gt;get_document($source);</td></tr>
414<tr><td class="h"><a name="188"></a>188</td><td></td><td></td><td></td><td></td><td class="s"> return $class-&gt;_setattr( $document, %attr ) if $document;</td></tr>
415<tr><td class="h"><a name="189"></a>189</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
416<tr><td class="h"><a name="190"></a>190</td><td></td><td></td><td></td><td></td><td class="s"> if ( $timeout ) {</td></tr>
417<tr><td class="h"><a name="191"></a>191</td><td></td><td></td><td></td><td></td><td class="s"> eval {</td></tr>
418<tr><td class="h"><a name="192"></a>192</td><td></td><td></td><td></td><td></td><td class="s"> local $SIG{ALRM} = sub { die &quot;alarm\n&quot; };</td></tr>
419<tr><td class="h"><a name="193"></a>193</td><td></td><td></td><td></td><td></td><td class="s"> alarm( $timeout );</td></tr>
420<tr><td class="h"><a name="194"></a>194</td><td></td><td></td><td></td><td></td><td class="s"> $document = PPI::Lexer-&gt;lex_source( $$source );</td></tr>
421<tr><td class="h"><a name="195"></a>195</td><td></td><td></td><td></td><td></td><td class="s"> alarm( 0 );</td></tr>
422<tr><td class="h"><a name="196"></a>196</td><td></td><td></td><td></td><td></td><td class="s"> };</td></tr>
423<tr><td class="h"><a name="197"></a>197</td><td></td><td></td><td></td><td></td><td class="s"> } else {</td></tr>
424<tr><td class="h"><a name="198"></a>198</td><td></td><td></td><td></td><td></td><td class="s"> $document = PPI::Lexer-&gt;lex_source( $$source );</td></tr>
425<tr><td class="h"><a name="199"></a>199</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
426<tr><td class="h"><a name="200"></a>200</td><td></td><td></td><td></td><td></td><td class="s"> if ( $document ) {</td></tr>
427<tr><td class="h"><a name="201"></a>201</td><td></td><td></td><td></td><td></td><td class="s"> # Save in the cache</td></tr>
428<tr><td class="h"><a name="202"></a>202</td><td></td><td></td><td></td><td></td><td class="s"> $CACHE-&gt;store_document( $document );</td></tr>
429<tr><td class="h"><a name="203"></a>203</td><td></td><td></td><td></td><td></td><td class="s"> return $class-&gt;_setattr( $document, %attr );</td></tr>
430<tr><td class="h"><a name="204"></a>204</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
431<tr><td class="h"><a name="205"></a>205</td><td></td><td></td><td></td><td></td><td class="s"> } else {</td></tr>
432<tr><td class="h"><a name="206"></a>206</td><td></td><td></td><td></td><td></td><td class="s"> if ( $timeout ) {</td></tr>
433<tr><td class="h"><a name="207"></a>207</td><td></td><td></td><td></td><td></td><td class="s"> eval {</td></tr>
434<tr><td class="h"><a name="208"></a>208</td><td></td><td></td><td></td><td></td><td class="s"> local $SIG{ALRM} = sub { die &quot;alarm\n&quot; };</td></tr>
435<tr><td class="h"><a name="209"></a>209</td><td></td><td></td><td></td><td></td><td class="s"> alarm( $timeout );</td></tr>
436<tr><td class="h"><a name="210"></a>210</td><td></td><td></td><td></td><td></td><td class="s"> my $document = PPI::Lexer-&gt;lex_file( $source );</td></tr>
437<tr><td class="h"><a name="211"></a>211</td><td></td><td></td><td></td><td></td><td class="s"> return $class-&gt;_setattr( $document, %attr ) if $document;</td></tr>
438<tr><td class="h"><a name="212"></a>212</td><td></td><td></td><td></td><td></td><td class="s"> alarm( 0 );</td></tr>
439<tr><td class="h"><a name="213"></a>213</td><td></td><td></td><td></td><td></td><td class="s"> };</td></tr>
440<tr><td class="h"><a name="214"></a>214</td><td></td><td></td><td></td><td></td><td class="s"> } else {</td></tr>
441<tr><td class="h"><a name="215"></a>215</td><td></td><td></td><td></td><td></td><td class="s"> my $document = PPI::Lexer-&gt;lex_file( $source );</td></tr>
442<tr><td class="h"><a name="216"></a>216</td><td></td><td></td><td></td><td></td><td class="s"> return $class-&gt;_setattr( $document, %attr ) if $document;</td></tr>
443<tr><td class="h"><a name="217"></a>217</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
444<tr><td class="h"><a name="218"></a>218</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
445<tr><td class="h"><a name="219"></a>219</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
446<tr><td class="h"><a name="220"></a>220</td><td></td><td></td><td></td><td></td><td class="s"> } elsif ( _SCALAR0($source) ) {</td></tr>
447<tr><td class="h"><a name="221"></a>221</td><td class="c0">8</td><td class="c3"><span title="Avg 350ns">3&micro;s</span></td><td></td><td></td><td class="s"> if ( $timeout ) {</td></tr>
448<tr><td class="h"><a name="222"></a>222</td><td></td><td></td><td></td><td></td><td class="s"> eval {</td></tr>
449<tr><td class="h"><a name="223"></a>223</td><td></td><td></td><td></td><td></td><td class="s"> local $SIG{ALRM} = sub { die &quot;alarm\n&quot; };</td></tr>
450<tr><td class="h"><a name="224"></a>224</td><td></td><td></td><td></td><td></td><td class="s"> alarm( $timeout );</td></tr>
451<tr><td class="h"><a name="225"></a>225</td><td></td><td></td><td></td><td></td><td class="s"> my $document = PPI::Lexer-&gt;lex_source( $$source );</td></tr>
452<tr><td class="h"><a name="226"></a>226</td><td></td><td></td><td></td><td></td><td class="s"> return $class-&gt;_setattr( $document, %attr ) if $document;</td></tr>
453<tr><td class="h"><a name="227"></a>227</td><td></td><td></td><td></td><td></td><td class="s"> alarm( 0 );</td></tr>
454<tr><td class="h"><a name="228"></a>228</td><td></td><td></td><td></td><td></td><td class="s"> };</td></tr>
455<tr><td class="h"><a name="229"></a>229</td><td></td><td></td><td></td><td></td><td class="s"> } else {</td></tr>
456<tr><td class="h"><a name="230"></a>230</td><td class="c0">8</td><td class="c1"><span title="Avg 5&micro;s">36&micro;s</span></td><td class="c0">8</td><td class="c0">9.41ms</td><td class="s"> my $document = PPI::Lexer-&gt;lex_source( $$source );<div class="calls"><div class="calls_out"> # spent 9.41ms making 8 calls to <a href="PPI-Lexer-pm-1005-line.html#182">PPI::Lexer::lex_source</a>, avg 1.18ms/call</div></div></td></tr>
457<tr><td class="h"><a name="231"></a>231</td><td class="c0">8</td><td class="c0"><span title="Avg 10&micro;s">78&micro;s</span></td><td class="c0">16</td><td class="c3">41&micro;s</td><td class="s"> return $class-&gt;_setattr( $document, %attr ) if $document;<div class="calls"><div class="calls_out"> # spent 35&micro;s making 8 calls to <a href="PPI-Document-pm-996-line.html#275">PPI::Document::_setattr</a>, avg 4&micro;s/call
458 # spent 6&micro;s making 8 calls to <a href="PPI-Util-pm-915-line.html#PPI__Util__TRUE">PPI::Util::TRUE</a>, avg 762ns/call</div></div></td></tr>
459<tr><td class="h"><a name="232"></a>232</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
460<tr><td class="h"><a name="233"></a>233</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
461<tr><td class="h"><a name="234"></a>234</td><td></td><td></td><td></td><td></td><td class="s"> } elsif ( _ARRAY0($source) ) {</td></tr>
462<tr><td class="h"><a name="235"></a>235</td><td></td><td></td><td></td><td></td><td class="s"> $source = join '', map { &quot;$_\n&quot; } @$source;</td></tr>
463<tr><td class="h"><a name="236"></a>236</td><td></td><td></td><td></td><td></td><td class="s"> if ( $timeout ) {</td></tr>
464<tr><td class="h"><a name="237"></a>237</td><td></td><td></td><td></td><td></td><td class="s"> eval {</td></tr>
465<tr><td class="h"><a name="238"></a>238</td><td></td><td></td><td></td><td></td><td class="s"> local $SIG{ALRM} = sub { die &quot;alarm\n&quot; };</td></tr>
466<tr><td class="h"><a name="239"></a>239</td><td></td><td></td><td></td><td></td><td class="s"> alarm( $timeout );</td></tr>
467<tr><td class="h"><a name="240"></a>240</td><td></td><td></td><td></td><td></td><td class="s"> my $document = PPI::Lexer-&gt;lex_source( $source );</td></tr>
468<tr><td class="h"><a name="241"></a>241</td><td></td><td></td><td></td><td></td><td class="s"> return $class-&gt;_setattr( $document, %attr ) if $document;</td></tr>
469<tr><td class="h"><a name="242"></a>242</td><td></td><td></td><td></td><td></td><td class="s"> alarm( 0 );</td></tr>
470<tr><td class="h"><a name="243"></a>243</td><td></td><td></td><td></td><td></td><td class="s"> };</td></tr>
471<tr><td class="h"><a name="244"></a>244</td><td></td><td></td><td></td><td></td><td class="s"> } else {</td></tr>
472<tr><td class="h"><a name="245"></a>245</td><td></td><td></td><td></td><td></td><td class="s"> my $document = PPI::Lexer-&gt;lex_source( $source );</td></tr>
473<tr><td class="h"><a name="246"></a>246</td><td></td><td></td><td></td><td></td><td class="s"> return $class-&gt;_setattr( $document, %attr ) if $document;</td></tr>
474<tr><td class="h"><a name="247"></a>247</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
475<tr><td class="h"><a name="248"></a>248</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
476<tr><td class="h"><a name="249"></a>249</td><td></td><td></td><td></td><td></td><td class="s"> } else {</td></tr>
477<tr><td class="h"><a name="250"></a>250</td><td></td><td></td><td></td><td></td><td class="s"> $class-&gt;_error(&quot;Unknown object or reference was passed to PPI::Document::new&quot;);</td></tr>
478<tr><td class="h"><a name="251"></a>251</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
479<tr><td class="h"><a name="252"></a>252</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
480<tr><td class="h"><a name="253"></a>253</td><td></td><td></td><td></td><td></td><td class="s"> # Pull and store the error from the lexer</td></tr>
481<tr><td class="h"><a name="254"></a>254</td><td></td><td></td><td></td><td></td><td class="s"> my $errstr;</td></tr>
482<tr><td class="h"><a name="255"></a>255</td><td></td><td></td><td></td><td></td><td class="s"> if ( _INSTANCE($@, 'PPI::Exception::Timeout') ) {</td></tr>
483<tr><td class="h"><a name="256"></a>256</td><td></td><td></td><td></td><td></td><td class="s"> $errstr = 'Timed out while parsing document';</td></tr>
484<tr><td class="h"><a name="257"></a>257</td><td></td><td></td><td></td><td></td><td class="s"> } elsif ( _INSTANCE($@, 'PPI::Exception') ) {</td></tr>
485<tr><td class="h"><a name="258"></a>258</td><td></td><td></td><td></td><td></td><td class="s"> $errstr = $@-&gt;message;</td></tr>
486<tr><td class="h"><a name="259"></a>259</td><td></td><td></td><td></td><td></td><td class="s"> } elsif ( $@ ) {</td></tr>
487<tr><td class="h"><a name="260"></a>260</td><td></td><td></td><td></td><td></td><td class="s"> $errstr = $@;</td></tr>
488<tr><td class="h"><a name="261"></a>261</td><td></td><td></td><td></td><td></td><td class="s"> $errstr =~ s/\sat line\s.+$//;</td></tr>
489<tr><td class="h"><a name="262"></a>262</td><td></td><td></td><td></td><td></td><td class="s"> } elsif ( PPI::Lexer-&gt;errstr ) {</td></tr>
490<tr><td class="h"><a name="263"></a>263</td><td></td><td></td><td></td><td></td><td class="s"> $errstr = PPI::Lexer-&gt;errstr;</td></tr>
491<tr><td class="h"><a name="264"></a>264</td><td></td><td></td><td></td><td></td><td class="s"> } else {</td></tr>
492<tr><td class="h"><a name="265"></a>265</td><td></td><td></td><td></td><td></td><td class="s"> $errstr = &quot;Unknown error parsing Perl document&quot;;</td></tr>
493<tr><td class="h"><a name="266"></a>266</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
494<tr><td class="h"><a name="267"></a>267</td><td></td><td></td><td></td><td></td><td class="s"> PPI::Lexer-&gt;_clear;</td></tr>
495<tr><td class="h"><a name="268"></a>268</td><td></td><td></td><td></td><td></td><td class="s"> $class-&gt;_error( $errstr );</td></tr>
496<tr><td class="h"><a name="269"></a>269</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
497<tr><td class="h"><a name="270"></a>270</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
498<tr><td class="h"><a name="271"></a>271</td><td></td><td></td><td></td><td></td><td class="s">sub load {</td></tr>
499<tr><td class="h"><a name="272"></a>272</td><td></td><td></td><td></td><td></td><td class="s"> Carp::croak(&quot;API CHANGE: File names should now be passed to PPI::Document-&gt;new to load a file&quot;);</td></tr>
500<tr><td class="h"><a name="273"></a>273</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
501<tr><td class="h"><a name="274"></a>274</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
502<tr><td class="h"><a name="275"></a>275</td><td></td><td></td><td></td><td></td><td class="s"><div class="calls"><div class="calls_in"># spent 35&micro;s within PPI::Document::_setattr which was called 8 times, avg 4&micro;s/call:
503# 8 times (35&micro;s+0s) by PPI::Document::new at <a href="PPI-Document-pm-996-line.html#231">line 231</a>, avg 4&micro;s/call</div></div>sub _setattr {</td></tr>
504<tr><td class="h"><a name="276"></a>276</td><td class="c0">8</td><td class="c3"><span title="Avg 1&micro;s">10&micro;s</span></td><td></td><td></td><td class="s"> my ($class, $document, %attr) = @_;</td></tr>
505<tr><td class="h"><a name="277"></a>277</td><td class="c0">8</td><td class="c3"><span title="Avg 1&micro;s">9&micro;s</span></td><td></td><td></td><td class="s"> $document-&gt;{readonly} = !! $attr{readonly};</td></tr>
506<tr><td class="h"><a name="278"></a>278</td><td class="c0">8</td><td class="c3"><span title="Avg 2&micro;s">19&micro;s</span></td><td></td><td></td><td class="s"> return $document;</td></tr>
507<tr><td class="h"><a name="279"></a>279</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
508<tr><td class="h"><a name="280"></a>280</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
509<tr><td class="h"><a name="281"></a>281</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
510<tr><td class="h"><a name="282"></a>282</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
511<tr><td class="h"><a name="283"></a>283</td><td></td><td></td><td></td><td></td><td class="s">=head2 set_cache $cache</td></tr>
512<tr><td class="h"><a name="284"></a>284</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
513<tr><td class="h"><a name="285"></a>285</td><td></td><td></td><td></td><td></td><td class="s">As of L&lt;PPI&gt; 1.100, C&lt;PPI::Document&gt; supports parser caching.</td></tr>
514<tr><td class="h"><a name="286"></a>286</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
515<tr><td class="h"><a name="287"></a>287</td><td></td><td></td><td></td><td></td><td class="s">The default cache class L&lt;PPI::Cache&gt; provides a L&lt;Storable&gt;-based</td></tr>
516<tr><td class="h"><a name="288"></a>288</td><td></td><td></td><td></td><td></td><td class="s">caching or the parsed document based on the MD5 hash of the document as</td></tr>
517<tr><td class="h"><a name="289"></a>289</td><td></td><td></td><td></td><td></td><td class="s">a string.</td></tr>
518<tr><td class="h"><a name="290"></a>290</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
519<tr><td class="h"><a name="291"></a>291</td><td></td><td></td><td></td><td></td><td class="s">The static C&lt;set_cache&gt; method is used to set the cache object for</td></tr>
520<tr><td class="h"><a name="292"></a>292</td><td></td><td></td><td></td><td></td><td class="s">C&lt;PPI::Document&gt; to use when loading documents. It takes as argument</td></tr>
521<tr><td class="h"><a name="293"></a>293</td><td></td><td></td><td></td><td></td><td class="s">a L&lt;PPI::Cache&gt; object (or something that C&lt;isa&gt; the same).</td></tr>
522<tr><td class="h"><a name="294"></a>294</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
523<tr><td class="h"><a name="295"></a>295</td><td></td><td></td><td></td><td></td><td class="s">If passed C&lt;undef&gt;, this method will stop using the current cache, if any.</td></tr>
524<tr><td class="h"><a name="296"></a>296</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
525<tr><td class="h"><a name="297"></a>297</td><td></td><td></td><td></td><td></td><td class="s">For more information on caching, see L&lt;PPI::Cache&gt;.</td></tr>
526<tr><td class="h"><a name="298"></a>298</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
527<tr><td class="h"><a name="299"></a>299</td><td></td><td></td><td></td><td></td><td class="s">Returns true on success, or C&lt;undef&gt; if not passed a valid param.</td></tr>
528<tr><td class="h"><a name="300"></a>300</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
529<tr><td class="h"><a name="301"></a>301</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
530<tr><td class="h"><a name="302"></a>302</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
531<tr><td class="h"><a name="303"></a>303</td><td></td><td></td><td></td><td></td><td class="s">sub set_cache {</td></tr>
532<tr><td class="h"><a name="304"></a>304</td><td></td><td></td><td></td><td></td><td class="s"> my $class = ref $_[0] ? ref shift : shift;</td></tr>
533<tr><td class="h"><a name="305"></a>305</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
534<tr><td class="h"><a name="306"></a>306</td><td></td><td></td><td></td><td></td><td class="s"> if ( defined $_[0] ) {</td></tr>
535<tr><td class="h"><a name="307"></a>307</td><td></td><td></td><td></td><td></td><td class="s"> # Enable the cache</td></tr>
536<tr><td class="h"><a name="308"></a>308</td><td></td><td></td><td></td><td></td><td class="s"> my $object = _INSTANCE(shift, 'PPI::Cache') or return undef;</td></tr>
537<tr><td class="h"><a name="309"></a>309</td><td></td><td></td><td></td><td></td><td class="s"> $CACHE = $object;</td></tr>
538<tr><td class="h"><a name="310"></a>310</td><td></td><td></td><td></td><td></td><td class="s"> } else {</td></tr>
539<tr><td class="h"><a name="311"></a>311</td><td></td><td></td><td></td><td></td><td class="s"> # Disable the cache</td></tr>
540<tr><td class="h"><a name="312"></a>312</td><td></td><td></td><td></td><td></td><td class="s"> $CACHE = undef;</td></tr>
541<tr><td class="h"><a name="313"></a>313</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
542<tr><td class="h"><a name="314"></a>314</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
543<tr><td class="h"><a name="315"></a>315</td><td></td><td></td><td></td><td></td><td class="s"> 1;</td></tr>
544<tr><td class="h"><a name="316"></a>316</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
545<tr><td class="h"><a name="317"></a>317</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
546<tr><td class="h"><a name="318"></a>318</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
547<tr><td class="h"><a name="319"></a>319</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
548<tr><td class="h"><a name="320"></a>320</td><td></td><td></td><td></td><td></td><td class="s">=head2 get_cache</td></tr>
549<tr><td class="h"><a name="321"></a>321</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
550<tr><td class="h"><a name="322"></a>322</td><td></td><td></td><td></td><td></td><td class="s">If a document cache is currently set, the C&lt;get_cache&gt; method will</td></tr>
551<tr><td class="h"><a name="323"></a>323</td><td></td><td></td><td></td><td></td><td class="s">return it.</td></tr>
552<tr><td class="h"><a name="324"></a>324</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
553<tr><td class="h"><a name="325"></a>325</td><td></td><td></td><td></td><td></td><td class="s">Returns a L&lt;PPI::Cache&gt; object, or C&lt;undef&gt; if there is no cache</td></tr>
554<tr><td class="h"><a name="326"></a>326</td><td></td><td></td><td></td><td></td><td class="s">currently set for C&lt;PPI::Document&gt;.</td></tr>
555<tr><td class="h"><a name="327"></a>327</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
556<tr><td class="h"><a name="328"></a>328</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
557<tr><td class="h"><a name="329"></a>329</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
558<tr><td class="h"><a name="330"></a>330</td><td></td><td></td><td></td><td></td><td class="s">sub get_cache {</td></tr>
559<tr><td class="h"><a name="331"></a>331</td><td></td><td></td><td></td><td></td><td class="s"> $CACHE; </td></tr>
560<tr><td class="h"><a name="332"></a>332</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
561<tr><td class="h"><a name="333"></a>333</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
562<tr><td class="h"><a name="- -"></a>- -</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
563<tr><td class="h"><a name="338"></a>338</td><td></td><td></td><td></td><td></td><td class="s">#####################################################################</td></tr>
564<tr><td class="h"><a name="339"></a>339</td><td></td><td></td><td></td><td></td><td class="s"># PPI::Document Instance Methods</td></tr>
565<tr><td class="h"><a name="340"></a>340</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
566<tr><td class="h"><a name="341"></a>341</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
567<tr><td class="h"><a name="342"></a>342</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
568<tr><td class="h"><a name="343"></a>343</td><td></td><td></td><td></td><td></td><td class="s">=head2 readonly</td></tr>
569<tr><td class="h"><a name="344"></a>344</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
570<tr><td class="h"><a name="345"></a>345</td><td></td><td></td><td></td><td></td><td class="s">The C&lt;readonly&gt; attribute indicates if the document is intended to be</td></tr>
571<tr><td class="h"><a name="346"></a>346</td><td></td><td></td><td></td><td></td><td class="s">read-only, and will never be modified. This is an advisory flag, that</td></tr>
572<tr><td class="h"><a name="347"></a>347</td><td></td><td></td><td></td><td></td><td class="s">writers of L&lt;PPI&gt;-related systems may or may not use to enable</td></tr>
573<tr><td class="h"><a name="348"></a>348</td><td></td><td></td><td></td><td></td><td class="s">optimisations and caches for your document.</td></tr>
574<tr><td class="h"><a name="349"></a>349</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
575<tr><td class="h"><a name="350"></a>350</td><td></td><td></td><td></td><td></td><td class="s">Returns true if the document is read-only or false if not.</td></tr>
576<tr><td class="h"><a name="351"></a>351</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
577<tr><td class="h"><a name="352"></a>352</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
578<tr><td class="h"><a name="353"></a>353</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
579<tr><td class="h"><a name="354"></a>354</td><td></td><td></td><td></td><td></td><td class="s">sub readonly {</td></tr>
580<tr><td class="h"><a name="355"></a>355</td><td></td><td></td><td></td><td></td><td class="s"> $_[0]-&gt;{readonly};</td></tr>
581<tr><td class="h"><a name="356"></a>356</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
582<tr><td class="h"><a name="357"></a>357</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
583<tr><td class="h"><a name="358"></a>358</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
584<tr><td class="h"><a name="359"></a>359</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
585<tr><td class="h"><a name="360"></a>360</td><td></td><td></td><td></td><td></td><td class="s">=head2 tab_width [ $width ]</td></tr>
586<tr><td class="h"><a name="361"></a>361</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
587<tr><td class="h"><a name="362"></a>362</td><td></td><td></td><td></td><td></td><td class="s">In order to handle support for C&lt;location&gt; correctly, C&lt;Documents&gt;</td></tr>
588<tr><td class="h"><a name="363"></a>363</td><td></td><td></td><td></td><td></td><td class="s">need to understand the concept of tabs and tab width. The C&lt;tab_width&gt;</td></tr>
589<tr><td class="h"><a name="364"></a>364</td><td></td><td></td><td></td><td></td><td class="s">method is used to get and set the size of the tab width.</td></tr>
590<tr><td class="h"><a name="365"></a>365</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
591<tr><td class="h"><a name="366"></a>366</td><td></td><td></td><td></td><td></td><td class="s">At the present time, PPI only supports &quot;naive&quot; (width 1) tabs, but we do</td></tr>
592<tr><td class="h"><a name="367"></a>367</td><td></td><td></td><td></td><td></td><td class="s">plan on supporting arbitrary, default and auto-sensing tab widths later.</td></tr>
593<tr><td class="h"><a name="368"></a>368</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
594<tr><td class="h"><a name="369"></a>369</td><td></td><td></td><td></td><td></td><td class="s">Returns the tab width as an integer, or C&lt;die&gt;s if you attempt to set the</td></tr>
595<tr><td class="h"><a name="370"></a>370</td><td></td><td></td><td></td><td></td><td class="s">tab width.</td></tr>
596<tr><td class="h"><a name="371"></a>371</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
597<tr><td class="h"><a name="372"></a>372</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
598<tr><td class="h"><a name="373"></a>373</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
599<tr><td class="h"><a name="374"></a>374</td><td></td><td></td><td></td><td></td><td class="s">sub tab_width {</td></tr>
600<tr><td class="h"><a name="375"></a>375</td><td></td><td></td><td></td><td></td><td class="s"> my $self = shift;</td></tr>
601<tr><td class="h"><a name="376"></a>376</td><td></td><td></td><td></td><td></td><td class="s"> return $self-&gt;{tab_width} unless @_;</td></tr>
602<tr><td class="h"><a name="377"></a>377</td><td></td><td></td><td></td><td></td><td class="s"> $self-&gt;{tab_width} = shift;</td></tr>
603<tr><td class="h"><a name="378"></a>378</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
604<tr><td class="h"><a name="379"></a>379</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
605<tr><td class="h"><a name="380"></a>380</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
606<tr><td class="h"><a name="381"></a>381</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
607<tr><td class="h"><a name="382"></a>382</td><td></td><td></td><td></td><td></td><td class="s">=head2 save</td></tr>
608<tr><td class="h"><a name="383"></a>383</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
609<tr><td class="h"><a name="384"></a>384</td><td></td><td></td><td></td><td></td><td class="s"> $document-&gt;save( $file )</td></tr>
610<tr><td class="h"><a name="385"></a>385</td><td></td><td></td><td></td><td></td><td class="s"> </td></tr>
611<tr><td class="h"><a name="386"></a>386</td><td></td><td></td><td></td><td></td><td class="s">The C&lt;save&gt; method serializes the C&lt;PPI::Document&gt; object and saves the</td></tr>
612<tr><td class="h"><a name="387"></a>387</td><td></td><td></td><td></td><td></td><td class="s">resulting Perl document to a file. Returns C&lt;undef&gt; on failure to open</td></tr>
613<tr><td class="h"><a name="388"></a>388</td><td></td><td></td><td></td><td></td><td class="s">or write to the file.</td></tr>
614<tr><td class="h"><a name="389"></a>389</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
615<tr><td class="h"><a name="390"></a>390</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
616<tr><td class="h"><a name="391"></a>391</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
617<tr><td class="h"><a name="392"></a>392</td><td></td><td></td><td></td><td></td><td class="s">sub save {</td></tr>
618<tr><td class="h"><a name="393"></a>393</td><td></td><td></td><td></td><td></td><td class="s"> my $self = shift;</td></tr>
619<tr><td class="h"><a name="394"></a>394</td><td></td><td></td><td></td><td></td><td class="s"> local *FILE;</td></tr>
620<tr><td class="h"><a name="395"></a>395</td><td></td><td></td><td></td><td></td><td class="s"> open( FILE, '&gt;', $_[0] ) or return undef;</td></tr>
621<tr><td class="h"><a name="396"></a>396</td><td></td><td></td><td></td><td></td><td class="s"> print FILE $self-&gt;serialize or return undef;</td></tr>
622<tr><td class="h"><a name="397"></a>397</td><td></td><td></td><td></td><td></td><td class="s"> close FILE or return undef;</td></tr>
623<tr><td class="h"><a name="398"></a>398</td><td></td><td></td><td></td><td></td><td class="s"> return 1;</td></tr>
624<tr><td class="h"><a name="399"></a>399</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
625<tr><td class="h"><a name="400"></a>400</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
626<tr><td class="h"><a name="401"></a>401</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
627<tr><td class="h"><a name="402"></a>402</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
628<tr><td class="h"><a name="403"></a>403</td><td></td><td></td><td></td><td></td><td class="s">=head2 serialize</td></tr>
629<tr><td class="h"><a name="404"></a>404</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
630<tr><td class="h"><a name="405"></a>405</td><td></td><td></td><td></td><td></td><td class="s">Unlike the C&lt;content&gt; method, which shows only the immediate content</td></tr>
631<tr><td class="h"><a name="406"></a>406</td><td></td><td></td><td></td><td></td><td class="s">within an element, Document objects also have to be able to be written</td></tr>
632<tr><td class="h"><a name="407"></a>407</td><td></td><td></td><td></td><td></td><td class="s">out to a file again.</td></tr>
633<tr><td class="h"><a name="408"></a>408</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
634<tr><td class="h"><a name="409"></a>409</td><td></td><td></td><td></td><td></td><td class="s">When doing this we need to take into account some additional factors.</td></tr>
635<tr><td class="h"><a name="410"></a>410</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
636<tr><td class="h"><a name="411"></a>411</td><td></td><td></td><td></td><td></td><td class="s">Primarily, we need to handle here-docs correctly, so that are written</td></tr>
637<tr><td class="h"><a name="412"></a>412</td><td></td><td></td><td></td><td></td><td class="s">to the file in the expected place.</td></tr>
638<tr><td class="h"><a name="413"></a>413</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
639<tr><td class="h"><a name="414"></a>414</td><td></td><td></td><td></td><td></td><td class="s">The C&lt;serialize&gt; method generates the actual file content for a given</td></tr>
640<tr><td class="h"><a name="415"></a>415</td><td></td><td></td><td></td><td></td><td class="s">Document object. The resulting string can be written straight to a file.</td></tr>
641<tr><td class="h"><a name="416"></a>416</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
642<tr><td class="h"><a name="417"></a>417</td><td></td><td></td><td></td><td></td><td class="s">Returns the serialized document as a string.</td></tr>
643<tr><td class="h"><a name="418"></a>418</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
644<tr><td class="h"><a name="419"></a>419</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
645<tr><td class="h"><a name="420"></a>420</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
646<tr><td class="h"><a name="421"></a>421</td><td></td><td></td><td></td><td></td><td class="s">sub serialize {</td></tr>
647<tr><td class="h"><a name="422"></a>422</td><td></td><td></td><td></td><td></td><td class="s"> my $self = shift;</td></tr>
648<tr><td class="h"><a name="423"></a>423</td><td></td><td></td><td></td><td></td><td class="s"> my @tokens = $self-&gt;tokens;</td></tr>
649<tr><td class="h"><a name="424"></a>424</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
650<tr><td class="h"><a name="425"></a>425</td><td></td><td></td><td></td><td></td><td class="s"> # The here-doc content buffer</td></tr>
651<tr><td class="h"><a name="426"></a>426</td><td></td><td></td><td></td><td></td><td class="s"> my $heredoc = '';</td></tr>
652<tr><td class="h"><a name="427"></a>427</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
653<tr><td class="h"><a name="428"></a>428</td><td></td><td></td><td></td><td></td><td class="s"> # Start the main loop</td></tr>
654<tr><td class="h"><a name="429"></a>429</td><td></td><td></td><td></td><td></td><td class="s"> my $output = '';</td></tr>
655<tr><td class="h"><a name="430"></a>430</td><td></td><td></td><td></td><td></td><td class="s"> foreach my $i ( 0 .. $#tokens ) {</td></tr>
656<tr><td class="h"><a name="431"></a>431</td><td></td><td></td><td></td><td></td><td class="s"> my $Token = $tokens[$i];</td></tr>
657<tr><td class="h"><a name="432"></a>432</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
658<tr><td class="h"><a name="433"></a>433</td><td></td><td></td><td></td><td></td><td class="s"> # Handle normal tokens</td></tr>
659<tr><td class="h"><a name="434"></a>434</td><td></td><td></td><td></td><td></td><td class="s"> unless ( $Token-&gt;isa('PPI::Token::HereDoc') ) {</td></tr>
660<tr><td class="h"><a name="435"></a>435</td><td></td><td></td><td></td><td></td><td class="s"> my $content = $Token-&gt;content;</td></tr>
661<tr><td class="h"><a name="436"></a>436</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
662<tr><td class="h"><a name="437"></a>437</td><td></td><td></td><td></td><td></td><td class="s"> # Handle the trivial cases</td></tr>
663<tr><td class="h"><a name="438"></a>438</td><td></td><td></td><td></td><td></td><td class="s"> unless ( $heredoc ne '' and $content =~ /\n/ ) {</td></tr>
664<tr><td class="h"><a name="439"></a>439</td><td></td><td></td><td></td><td></td><td class="s"> $output .= $content;</td></tr>
665<tr><td class="h"><a name="440"></a>440</td><td></td><td></td><td></td><td></td><td class="s"> next;</td></tr>
666<tr><td class="h"><a name="441"></a>441</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
667<tr><td class="h"><a name="442"></a>442</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
668<tr><td class="h"><a name="443"></a>443</td><td></td><td></td><td></td><td></td><td class="s"> # We have pending here-doc content that needs to be</td></tr>
669<tr><td class="h"><a name="444"></a>444</td><td></td><td></td><td></td><td></td><td class="s"> # inserted just after the first newline in the content.</td></tr>
670<tr><td class="h"><a name="445"></a>445</td><td></td><td></td><td></td><td></td><td class="s"> if ( $content eq &quot;\n&quot; ) {</td></tr>
671<tr><td class="h"><a name="446"></a>446</td><td></td><td></td><td></td><td></td><td class="s"> # Shortcut the most common case for speed</td></tr>
672<tr><td class="h"><a name="447"></a>447</td><td></td><td></td><td></td><td></td><td class="s"> $output .= $content . $heredoc;</td></tr>
673<tr><td class="h"><a name="448"></a>448</td><td></td><td></td><td></td><td></td><td class="s"> } else {</td></tr>
674<tr><td class="h"><a name="449"></a>449</td><td></td><td></td><td></td><td></td><td class="s"> # Slower and more general version</td></tr>
675<tr><td class="h"><a name="450"></a>450</td><td></td><td></td><td></td><td></td><td class="s"> $content =~ s/\n/\n$heredoc/;</td></tr>
676<tr><td class="h"><a name="451"></a>451</td><td></td><td></td><td></td><td></td><td class="s"> $output .= $content;</td></tr>
677<tr><td class="h"><a name="452"></a>452</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
678<tr><td class="h"><a name="453"></a>453</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
679<tr><td class="h"><a name="454"></a>454</td><td></td><td></td><td></td><td></td><td class="s"> $heredoc = '';</td></tr>
680<tr><td class="h"><a name="455"></a>455</td><td></td><td></td><td></td><td></td><td class="s"> next;</td></tr>
681<tr><td class="h"><a name="456"></a>456</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
682<tr><td class="h"><a name="457"></a>457</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
683<tr><td class="h"><a name="458"></a>458</td><td></td><td></td><td></td><td></td><td class="s"> # This token is a HereDoc.</td></tr>
684<tr><td class="h"><a name="459"></a>459</td><td></td><td></td><td></td><td></td><td class="s"> # First, add the token content as normal, which in this</td></tr>
685<tr><td class="h"><a name="460"></a>460</td><td></td><td></td><td></td><td></td><td class="s"> # case will definately not contain a newline.</td></tr>
686<tr><td class="h"><a name="461"></a>461</td><td></td><td></td><td></td><td></td><td class="s"> $output .= $Token-&gt;content;</td></tr>
687<tr><td class="h"><a name="462"></a>462</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
688<tr><td class="h"><a name="463"></a>463</td><td></td><td></td><td></td><td></td><td class="s"> # Now add all of the here-doc content to the heredoc buffer.</td></tr>
689<tr><td class="h"><a name="464"></a>464</td><td></td><td></td><td></td><td></td><td class="s"> foreach my $line ( $Token-&gt;heredoc ) {</td></tr>
690<tr><td class="h"><a name="465"></a>465</td><td></td><td></td><td></td><td></td><td class="s"> $heredoc .= $line;</td></tr>
691<tr><td class="h"><a name="466"></a>466</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
692<tr><td class="h"><a name="467"></a>467</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
693<tr><td class="h"><a name="468"></a>468</td><td></td><td></td><td></td><td></td><td class="s"> if ( $Token-&gt;{_damaged} ) {</td></tr>
694<tr><td class="h"><a name="469"></a>469</td><td></td><td></td><td></td><td></td><td class="s"> # Special Case:</td></tr>
695<tr><td class="h"><a name="470"></a>470</td><td></td><td></td><td></td><td></td><td class="s"> # There are a couple of warning/bug situations</td></tr>
696<tr><td class="h"><a name="471"></a>471</td><td></td><td></td><td></td><td></td><td class="s"> # that can occur when a HereDoc content was read in</td></tr>
697<tr><td class="h"><a name="472"></a>472</td><td></td><td></td><td></td><td></td><td class="s"> # from the end of a file that we silently allow.</td></tr>
698<tr><td class="h"><a name="473"></a>473</td><td></td><td></td><td></td><td></td><td class="s"> #</td></tr>
699<tr><td class="h"><a name="474"></a>474</td><td></td><td></td><td></td><td></td><td class="s"> # When writing back out to the file we have to</td></tr>
700<tr><td class="h"><a name="475"></a>475</td><td></td><td></td><td></td><td></td><td class="s"> # auto-repair these problems if we arn't going back</td></tr>
701<tr><td class="h"><a name="476"></a>476</td><td></td><td></td><td></td><td></td><td class="s"> # on to the end of the file.</td></tr>
702<tr><td class="h"><a name="477"></a>477</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
703<tr><td class="h"><a name="478"></a>478</td><td></td><td></td><td></td><td></td><td class="s"> # When calculating $last_line, ignore the final token if</td></tr>
704<tr><td class="h"><a name="479"></a>479</td><td></td><td></td><td></td><td></td><td class="s"> # and only if it has a single newline at the end.</td></tr>
705<tr><td class="h"><a name="480"></a>480</td><td></td><td></td><td></td><td></td><td class="s"> my $last_index = $#tokens;</td></tr>
706<tr><td class="h"><a name="481"></a>481</td><td></td><td></td><td></td><td></td><td class="s"> if ( $tokens[$last_index]-&gt;{content} =~ /^[^\n]*\n$/ ) {</td></tr>
707<tr><td class="h"><a name="482"></a>482</td><td></td><td></td><td></td><td></td><td class="s"> $last_index--;</td></tr>
708<tr><td class="h"><a name="483"></a>483</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
709<tr><td class="h"><a name="484"></a>484</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
710<tr><td class="h"><a name="485"></a>485</td><td></td><td></td><td></td><td></td><td class="s"> # This is a two part test.</td></tr>
711<tr><td class="h"><a name="486"></a>486</td><td></td><td></td><td></td><td></td><td class="s"> # First, are we on the last line of the</td></tr>
712<tr><td class="h"><a name="487"></a>487</td><td></td><td></td><td></td><td></td><td class="s"> # content part of the file</td></tr>
713<tr><td class="h"><a name="488"></a>488</td><td></td><td></td><td></td><td></td><td class="s"> my $last_line = List::MoreUtils::none {</td></tr>
714<tr><td class="h"><a name="489"></a>489</td><td></td><td></td><td></td><td></td><td class="s"> $tokens[$_] and $tokens[$_]-&gt;{content} =~ /\n/</td></tr>
715<tr><td class="h"><a name="490"></a>490</td><td></td><td></td><td></td><td></td><td class="s"> } (($i + 1) .. $last_index);</td></tr>
716<tr><td class="h"><a name="491"></a>491</td><td></td><td></td><td></td><td></td><td class="s"> if ( ! defined $last_line ) {</td></tr>
717<tr><td class="h"><a name="492"></a>492</td><td></td><td></td><td></td><td></td><td class="s"> # Handles the null list case</td></tr>
718<tr><td class="h"><a name="493"></a>493</td><td></td><td></td><td></td><td></td><td class="s"> $last_line = 1;</td></tr>
719<tr><td class="h"><a name="494"></a>494</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
720<tr><td class="h"><a name="495"></a>495</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
721<tr><td class="h"><a name="496"></a>496</td><td></td><td></td><td></td><td></td><td class="s"> # Secondly, are their any more here-docs after us,</td></tr>
722<tr><td class="h"><a name="497"></a>497</td><td></td><td></td><td></td><td></td><td class="s"> # (with content or a terminator)</td></tr>
723<tr><td class="h"><a name="498"></a>498</td><td></td><td></td><td></td><td></td><td class="s"> my $any_after = List::MoreUtils::any {</td></tr>
724<tr><td class="h"><a name="499"></a>499</td><td></td><td></td><td></td><td></td><td class="s"> $tokens[$_]-&gt;isa('PPI::Token::HereDoc')</td></tr>
725<tr><td class="h"><a name="500"></a>500</td><td></td><td></td><td></td><td></td><td class="s"> and (</td></tr>
726<tr><td class="h"><a name="501"></a>501</td><td></td><td></td><td></td><td></td><td class="s"> scalar(@{$tokens[$_]-&gt;{_heredoc}})</td></tr>
727<tr><td class="h"><a name="502"></a>502</td><td></td><td></td><td></td><td></td><td class="s"> or</td></tr>
728<tr><td class="h"><a name="503"></a>503</td><td></td><td></td><td></td><td></td><td class="s"> defined $tokens[$_]-&gt;{_terminator_line}</td></tr>
729<tr><td class="h"><a name="504"></a>504</td><td></td><td></td><td></td><td></td><td class="s"> )</td></tr>
730<tr><td class="h"><a name="505"></a>505</td><td></td><td></td><td></td><td></td><td class="s"> } (($i + 1) .. $#tokens);</td></tr>
731<tr><td class="h"><a name="506"></a>506</td><td></td><td></td><td></td><td></td><td class="s"> if ( ! defined $any_after ) {</td></tr>
732<tr><td class="h"><a name="507"></a>507</td><td></td><td></td><td></td><td></td><td class="s"> # Handles the null list case</td></tr>
733<tr><td class="h"><a name="508"></a>508</td><td></td><td></td><td></td><td></td><td class="s"> $any_after = '';</td></tr>
734<tr><td class="h"><a name="509"></a>509</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
735<tr><td class="h"><a name="510"></a>510</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
736<tr><td class="h"><a name="511"></a>511</td><td></td><td></td><td></td><td></td><td class="s"> # We don't need to repair the last here-doc on the</td></tr>
737<tr><td class="h"><a name="512"></a>512</td><td></td><td></td><td></td><td></td><td class="s"> # last line. But we do need to repair anything else.</td></tr>
738<tr><td class="h"><a name="513"></a>513</td><td></td><td></td><td></td><td></td><td class="s"> unless ( $last_line and ! $any_after ) {</td></tr>
739<tr><td class="h"><a name="514"></a>514</td><td></td><td></td><td></td><td></td><td class="s"> # Add a terminating string if it didn't have one</td></tr>
740<tr><td class="h"><a name="515"></a>515</td><td></td><td></td><td></td><td></td><td class="s"> unless ( defined $Token-&gt;{_terminator_line} ) {</td></tr>
741<tr><td class="h"><a name="516"></a>516</td><td></td><td></td><td></td><td></td><td class="s"> $Token-&gt;{_terminator_line} = $Token-&gt;{_terminator};</td></tr>
742<tr><td class="h"><a name="517"></a>517</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
743<tr><td class="h"><a name="518"></a>518</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
744<tr><td class="h"><a name="519"></a>519</td><td></td><td></td><td></td><td></td><td class="s"> # Add a trailing newline to the terminating</td></tr>
745<tr><td class="h"><a name="520"></a>520</td><td></td><td></td><td></td><td></td><td class="s"> # string if it didn't have one.</td></tr>
746<tr><td class="h"><a name="521"></a>521</td><td></td><td></td><td></td><td></td><td class="s"> unless ( $Token-&gt;{_terminator_line} =~ /\n$/ ) {</td></tr>
747<tr><td class="h"><a name="522"></a>522</td><td></td><td></td><td></td><td></td><td class="s"> $Token-&gt;{_terminator_line} .= &quot;\n&quot;;</td></tr>
748<tr><td class="h"><a name="523"></a>523</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
749<tr><td class="h"><a name="524"></a>524</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
750<tr><td class="h"><a name="525"></a>525</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
751<tr><td class="h"><a name="526"></a>526</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
752<tr><td class="h"><a name="527"></a>527</td><td></td><td></td><td></td><td></td><td class="s"> # Now add the termination line to the heredoc buffer</td></tr>
753<tr><td class="h"><a name="528"></a>528</td><td></td><td></td><td></td><td></td><td class="s"> if ( defined $Token-&gt;{_terminator_line} ) {</td></tr>
754<tr><td class="h"><a name="529"></a>529</td><td></td><td></td><td></td><td></td><td class="s"> $heredoc .= $Token-&gt;{_terminator_line};</td></tr>
755<tr><td class="h"><a name="530"></a>530</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
756<tr><td class="h"><a name="531"></a>531</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
757<tr><td class="h"><a name="532"></a>532</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
758<tr><td class="h"><a name="533"></a>533</td><td></td><td></td><td></td><td></td><td class="s"> # End of tokens</td></tr>
759<tr><td class="h"><a name="534"></a>534</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
760<tr><td class="h"><a name="535"></a>535</td><td></td><td></td><td></td><td></td><td class="s"> if ( $heredoc ne '' ) {</td></tr>
761<tr><td class="h"><a name="536"></a>536</td><td></td><td></td><td></td><td></td><td class="s"> # If the file doesn't end in a newline, we need to add one</td></tr>
762<tr><td class="h"><a name="537"></a>537</td><td></td><td></td><td></td><td></td><td class="s"> # so that the here-doc content starts on the next line.</td></tr>
763<tr><td class="h"><a name="538"></a>538</td><td></td><td></td><td></td><td></td><td class="s"> unless ( $output =~ /\n$/ ) {</td></tr>
764<tr><td class="h"><a name="539"></a>539</td><td></td><td></td><td></td><td></td><td class="s"> $output .= &quot;\n&quot;;</td></tr>
765<tr><td class="h"><a name="540"></a>540</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
766<tr><td class="h"><a name="541"></a>541</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
767<tr><td class="h"><a name="542"></a>542</td><td></td><td></td><td></td><td></td><td class="s"> # Now we add the remaining here-doc content</td></tr>
768<tr><td class="h"><a name="543"></a>543</td><td></td><td></td><td></td><td></td><td class="s"> # to the end of the file.</td></tr>
769<tr><td class="h"><a name="544"></a>544</td><td></td><td></td><td></td><td></td><td class="s"> $output .= $heredoc;</td></tr>
770<tr><td class="h"><a name="545"></a>545</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
771<tr><td class="h"><a name="546"></a>546</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
772<tr><td class="h"><a name="547"></a>547</td><td></td><td></td><td></td><td></td><td class="s"> $output;</td></tr>
773<tr><td class="h"><a name="548"></a>548</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
774<tr><td class="h"><a name="549"></a>549</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
775<tr><td class="h"><a name="550"></a>550</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
776<tr><td class="h"><a name="551"></a>551</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
777<tr><td class="h"><a name="552"></a>552</td><td></td><td></td><td></td><td></td><td class="s">=head2 hex_id</td></tr>
778<tr><td class="h"><a name="553"></a>553</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
779<tr><td class="h"><a name="554"></a>554</td><td></td><td></td><td></td><td></td><td class="s">The C&lt;hex_id&gt; method generates an unique identifier for the Perl document.</td></tr>
780<tr><td class="h"><a name="555"></a>555</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
781<tr><td class="h"><a name="556"></a>556</td><td></td><td></td><td></td><td></td><td class="s">This identifier is basically just the serialized document, with</td></tr>
782<tr><td class="h"><a name="557"></a>557</td><td></td><td></td><td></td><td></td><td class="s">Unix-specific newlines, passed through MD5 to produce a hexadecimal string.</td></tr>
783<tr><td class="h"><a name="558"></a>558</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
784<tr><td class="h"><a name="559"></a>559</td><td></td><td></td><td></td><td></td><td class="s">This identifier is used by a variety of systems (such as L&lt;PPI::Cache&gt;</td></tr>
785<tr><td class="h"><a name="560"></a>560</td><td></td><td></td><td></td><td></td><td class="s">and L&lt;Perl::Metrics&gt;) as a unique key against which to store or cache</td></tr>
786<tr><td class="h"><a name="561"></a>561</td><td></td><td></td><td></td><td></td><td class="s">information about a document (or indeed, to cache the document itself).</td></tr>
787<tr><td class="h"><a name="562"></a>562</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
788<tr><td class="h"><a name="563"></a>563</td><td></td><td></td><td></td><td></td><td class="s">Returns a 32 character hexadecimal string.</td></tr>
789<tr><td class="h"><a name="564"></a>564</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
790<tr><td class="h"><a name="565"></a>565</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
791<tr><td class="h"><a name="566"></a>566</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
792<tr><td class="h"><a name="567"></a>567</td><td></td><td></td><td></td><td></td><td class="s">sub hex_id {</td></tr>
793<tr><td class="h"><a name="568"></a>568</td><td></td><td></td><td></td><td></td><td class="s"> PPI::Util::md5hex($_[0]-&gt;serialize);</td></tr>
794<tr><td class="h"><a name="569"></a>569</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
795<tr><td class="h"><a name="570"></a>570</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
796<tr><td class="h"><a name="571"></a>571</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
797<tr><td class="h"><a name="572"></a>572</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
798<tr><td class="h"><a name="573"></a>573</td><td></td><td></td><td></td><td></td><td class="s">=head2 index_locations</td></tr>
799<tr><td class="h"><a name="574"></a>574</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
800<tr><td class="h"><a name="575"></a>575</td><td></td><td></td><td></td><td></td><td class="s">Within a document, all L&lt;PPI::Element&gt; objects can be considered to have a</td></tr>
801<tr><td class="h"><a name="576"></a>576</td><td></td><td></td><td></td><td></td><td class="s">&quot;location&quot;, a line/column position within the document when considered as a</td></tr>
802<tr><td class="h"><a name="577"></a>577</td><td></td><td></td><td></td><td></td><td class="s">file. This position is primarily useful for debugging type activities.</td></tr>
803<tr><td class="h"><a name="578"></a>578</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
804<tr><td class="h"><a name="579"></a>579</td><td></td><td></td><td></td><td></td><td class="s">The method for finding the position of a single Element is a bit laborious,</td></tr>
805<tr><td class="h"><a name="580"></a>580</td><td></td><td></td><td></td><td></td><td class="s">and very slow if you need to do it a lot. So the C&lt;index_locations&gt; method</td></tr>
806<tr><td class="h"><a name="581"></a>581</td><td></td><td></td><td></td><td></td><td class="s">will index and save the locations of every Element within the Document in</td></tr>
807<tr><td class="h"><a name="582"></a>582</td><td></td><td></td><td></td><td></td><td class="s">advance, making future calls to &lt;PPI::Element::location&gt; virtually free.</td></tr>
808<tr><td class="h"><a name="583"></a>583</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
809<tr><td class="h"><a name="584"></a>584</td><td></td><td></td><td></td><td></td><td class="s">Please note that this index should always be cleared using C&lt;flush_locations&gt;</td></tr>
810<tr><td class="h"><a name="585"></a>585</td><td></td><td></td><td></td><td></td><td class="s">once you are finished with the locations. If content is added to or removed</td></tr>
811<tr><td class="h"><a name="586"></a>586</td><td></td><td></td><td></td><td></td><td class="s">from the file, these indexed locations will be B&lt;wrong&gt;.</td></tr>
812<tr><td class="h"><a name="587"></a>587</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
813<tr><td class="h"><a name="588"></a>588</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
814<tr><td class="h"><a name="589"></a>589</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
815<tr><td class="h"><a name="590"></a>590</td><td></td><td></td><td></td><td></td><td class="s">sub index_locations {</td></tr>
816<tr><td class="h"><a name="591"></a>591</td><td></td><td></td><td></td><td></td><td class="s"> my $self = shift;</td></tr>
817<tr><td class="h"><a name="592"></a>592</td><td></td><td></td><td></td><td></td><td class="s"> my @tokens = $self-&gt;tokens;</td></tr>
818<tr><td class="h"><a name="593"></a>593</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
819<tr><td class="h"><a name="594"></a>594</td><td></td><td></td><td></td><td></td><td class="s"> # Whenever we hit a heredoc we will need to increment by</td></tr>
820<tr><td class="h"><a name="595"></a>595</td><td></td><td></td><td></td><td></td><td class="s"> # the number of lines in it's content section when when we</td></tr>
821<tr><td class="h"><a name="596"></a>596</td><td></td><td></td><td></td><td></td><td class="s"> # encounter the next token with a newline in it.</td></tr>
822<tr><td class="h"><a name="597"></a>597</td><td></td><td></td><td></td><td></td><td class="s"> my $heredoc = 0;</td></tr>
823<tr><td class="h"><a name="598"></a>598</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
824<tr><td class="h"><a name="599"></a>599</td><td></td><td></td><td></td><td></td><td class="s"> # Find the first Token without a location</td></tr>
825<tr><td class="h"><a name="600"></a>600</td><td></td><td></td><td></td><td></td><td class="s"> my ($first, $location) = ();</td></tr>
826<tr><td class="h"><a name="601"></a>601</td><td></td><td></td><td></td><td></td><td class="s"> foreach ( 0 .. $#tokens ) {</td></tr>
827<tr><td class="h"><a name="602"></a>602</td><td></td><td></td><td></td><td></td><td class="s"> my $Token = $tokens[$_];</td></tr>
828<tr><td class="h"><a name="603"></a>603</td><td></td><td></td><td></td><td></td><td class="s"> next if $Token-&gt;{_location};</td></tr>
829<tr><td class="h"><a name="604"></a>604</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
830<tr><td class="h"><a name="605"></a>605</td><td></td><td></td><td></td><td></td><td class="s"> # Found the first Token without a location</td></tr>
831<tr><td class="h"><a name="606"></a>606</td><td></td><td></td><td></td><td></td><td class="s"> # Calculate the new location if needed.</td></tr>
832<tr><td class="h"><a name="607"></a>607</td><td></td><td></td><td></td><td></td><td class="s"> if ($_) {</td></tr>
833<tr><td class="h"><a name="608"></a>608</td><td></td><td></td><td></td><td></td><td class="s"> $location =</td></tr>
834<tr><td class="h"><a name="609"></a>609</td><td></td><td></td><td></td><td></td><td class="s"> $self-&gt;_add_location( $location, $tokens[$_ - 1], \$heredoc );</td></tr>
835<tr><td class="h"><a name="610"></a>610</td><td></td><td></td><td></td><td></td><td class="s"> } else {</td></tr>
836<tr><td class="h"><a name="611"></a>611</td><td></td><td></td><td></td><td></td><td class="s"> my $logical_file =</td></tr>
837<tr><td class="h"><a name="612"></a>612</td><td></td><td></td><td></td><td></td><td class="s"> $self-&gt;can('filename') ? $self-&gt;filename : undef;</td></tr>
838<tr><td class="h"><a name="613"></a>613</td><td></td><td></td><td></td><td></td><td class="s"> $location = [ 1, 1, 1, 1, $logical_file ];</td></tr>
839<tr><td class="h"><a name="614"></a>614</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
840<tr><td class="h"><a name="615"></a>615</td><td></td><td></td><td></td><td></td><td class="s"> $first = $_;</td></tr>
841<tr><td class="h"><a name="616"></a>616</td><td></td><td></td><td></td><td></td><td class="s"> last;</td></tr>
842<tr><td class="h"><a name="617"></a>617</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
843<tr><td class="h"><a name="618"></a>618</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
844<tr><td class="h"><a name="619"></a>619</td><td></td><td></td><td></td><td></td><td class="s"> # Calculate locations for the rest</td></tr>
845<tr><td class="h"><a name="620"></a>620</td><td></td><td></td><td></td><td></td><td class="s"> if ( defined $first ) {</td></tr>
846<tr><td class="h"><a name="621"></a>621</td><td></td><td></td><td></td><td></td><td class="s"> foreach ( $first .. $#tokens ) {</td></tr>
847<tr><td class="h"><a name="622"></a>622</td><td></td><td></td><td></td><td></td><td class="s"> my $Token = $tokens[$_];</td></tr>
848<tr><td class="h"><a name="623"></a>623</td><td></td><td></td><td></td><td></td><td class="s"> $Token-&gt;{_location} = $location;</td></tr>
849<tr><td class="h"><a name="624"></a>624</td><td></td><td></td><td></td><td></td><td class="s"> $location = $self-&gt;_add_location( $location, $Token, \$heredoc );</td></tr>
850<tr><td class="h"><a name="625"></a>625</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
851<tr><td class="h"><a name="626"></a>626</td><td></td><td></td><td></td><td></td><td class="s"> # Add any here-doc lines to the counter</td></tr>
852<tr><td class="h"><a name="627"></a>627</td><td></td><td></td><td></td><td></td><td class="s"> if ( $Token-&gt;isa('PPI::Token::HereDoc') ) {</td></tr>
853<tr><td class="h"><a name="628"></a>628</td><td></td><td></td><td></td><td></td><td class="s"> $heredoc += $Token-&gt;heredoc + 1;</td></tr>
854<tr><td class="h"><a name="629"></a>629</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
855<tr><td class="h"><a name="630"></a>630</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
856<tr><td class="h"><a name="631"></a>631</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
857<tr><td class="h"><a name="632"></a>632</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
858<tr><td class="h"><a name="633"></a>633</td><td></td><td></td><td></td><td></td><td class="s"> 1;</td></tr>
859<tr><td class="h"><a name="634"></a>634</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
860<tr><td class="h"><a name="635"></a>635</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
861<tr><td class="h"><a name="636"></a>636</td><td></td><td></td><td></td><td></td><td class="s">sub _add_location {</td></tr>
862<tr><td class="h"><a name="637"></a>637</td><td></td><td></td><td></td><td></td><td class="s"> my ($self, $start, $Token, $heredoc) = @_;</td></tr>
863<tr><td class="h"><a name="638"></a>638</td><td></td><td></td><td></td><td></td><td class="s"> my $content = $Token-&gt;{content};</td></tr>
864<tr><td class="h"><a name="639"></a>639</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
865<tr><td class="h"><a name="640"></a>640</td><td></td><td></td><td></td><td></td><td class="s"> # Does the content contain any newlines</td></tr>
866<tr><td class="h"><a name="641"></a>641</td><td></td><td></td><td></td><td></td><td class="s"> my $newlines =()= $content =~ /\n/g;</td></tr>
867<tr><td class="h"><a name="642"></a>642</td><td></td><td></td><td></td><td></td><td class="s"> my ($logical_line, $logical_file) =</td></tr>
868<tr><td class="h"><a name="643"></a>643</td><td></td><td></td><td></td><td></td><td class="s"> $self-&gt;_logical_line_and_file($start, $Token, $newlines);</td></tr>
869<tr><td class="h"><a name="644"></a>644</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
870<tr><td class="h"><a name="645"></a>645</td><td></td><td></td><td></td><td></td><td class="s"> unless ( $newlines ) {</td></tr>
871<tr><td class="h"><a name="646"></a>646</td><td></td><td></td><td></td><td></td><td class="s"> # Handle the simple case</td></tr>
872<tr><td class="h"><a name="647"></a>647</td><td></td><td></td><td></td><td></td><td class="s"> return [</td></tr>
873<tr><td class="h"><a name="648"></a>648</td><td></td><td></td><td></td><td></td><td class="s"> $start-&gt;[LOCATION_LINE],</td></tr>
874<tr><td class="h"><a name="649"></a>649</td><td></td><td></td><td></td><td></td><td class="s"> $start-&gt;[LOCATION_CHARACTER] + length($content),</td></tr>
875<tr><td class="h"><a name="650"></a>650</td><td></td><td></td><td></td><td></td><td class="s"> $start-&gt;[LOCATION_COLUMN]</td></tr>
876<tr><td class="h"><a name="651"></a>651</td><td></td><td></td><td></td><td></td><td class="s"> + $self-&gt;_visual_length(</td></tr>
877<tr><td class="h"><a name="652"></a>652</td><td></td><td></td><td></td><td></td><td class="s"> $content,</td></tr>
878<tr><td class="h"><a name="653"></a>653</td><td></td><td></td><td></td><td></td><td class="s"> $start-&gt;[LOCATION_COLUMN]</td></tr>
879<tr><td class="h"><a name="654"></a>654</td><td></td><td></td><td></td><td></td><td class="s"> ),</td></tr>
880<tr><td class="h"><a name="655"></a>655</td><td></td><td></td><td></td><td></td><td class="s"> $logical_line,</td></tr>
881<tr><td class="h"><a name="656"></a>656</td><td></td><td></td><td></td><td></td><td class="s"> $logical_file,</td></tr>
882<tr><td class="h"><a name="657"></a>657</td><td></td><td></td><td></td><td></td><td class="s"> ];</td></tr>
883<tr><td class="h"><a name="658"></a>658</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
884<tr><td class="h"><a name="659"></a>659</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
885<tr><td class="h"><a name="660"></a>660</td><td></td><td></td><td></td><td></td><td class="s"> # This is the more complex case where we hit or</td></tr>
886<tr><td class="h"><a name="661"></a>661</td><td></td><td></td><td></td><td></td><td class="s"> # span a newline boundary.</td></tr>
887<tr><td class="h"><a name="662"></a>662</td><td></td><td></td><td></td><td></td><td class="s"> my $physical_line = $start-&gt;[LOCATION_LINE] + $newlines;</td></tr>
888<tr><td class="h"><a name="663"></a>663</td><td></td><td></td><td></td><td></td><td class="s"> my $location = [ $physical_line, 1, 1, $logical_line, $logical_file ];</td></tr>
889<tr><td class="h"><a name="664"></a>664</td><td></td><td></td><td></td><td></td><td class="s"> if ( $heredoc and $$heredoc ) {</td></tr>
890<tr><td class="h"><a name="665"></a>665</td><td></td><td></td><td></td><td></td><td class="s"> $location-&gt;[LOCATION_LINE] += $$heredoc;</td></tr>
891<tr><td class="h"><a name="666"></a>666</td><td></td><td></td><td></td><td></td><td class="s"> $location-&gt;[LOCATION_LOGICAL_LINE] += $$heredoc;</td></tr>
892<tr><td class="h"><a name="667"></a>667</td><td></td><td></td><td></td><td></td><td class="s"> $$heredoc = 0;</td></tr>
893<tr><td class="h"><a name="668"></a>668</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
894<tr><td class="h"><a name="669"></a>669</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
895<tr><td class="h"><a name="670"></a>670</td><td></td><td></td><td></td><td></td><td class="s"> # Does the token have additional characters</td></tr>
896<tr><td class="h"><a name="671"></a>671</td><td></td><td></td><td></td><td></td><td class="s"> # after their last newline.</td></tr>
897<tr><td class="h"><a name="672"></a>672</td><td></td><td></td><td></td><td></td><td class="s"> if ( $content =~ /\n([^\n]+?)\z/ ) {</td></tr>
898<tr><td class="h"><a name="673"></a>673</td><td></td><td></td><td></td><td></td><td class="s"> $location-&gt;[LOCATION_CHARACTER] += length($1);</td></tr>
899<tr><td class="h"><a name="674"></a>674</td><td></td><td></td><td></td><td></td><td class="s"> $location-&gt;[LOCATION_COLUMN] +=</td></tr>
900<tr><td class="h"><a name="675"></a>675</td><td></td><td></td><td></td><td></td><td class="s"> $self-&gt;_visual_length(</td></tr>
901<tr><td class="h"><a name="676"></a>676</td><td></td><td></td><td></td><td></td><td class="s"> $1, $location-&gt;[LOCATION_COLUMN],</td></tr>
902<tr><td class="h"><a name="677"></a>677</td><td></td><td></td><td></td><td></td><td class="s"> );</td></tr>
903<tr><td class="h"><a name="678"></a>678</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
904<tr><td class="h"><a name="679"></a>679</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
905<tr><td class="h"><a name="680"></a>680</td><td></td><td></td><td></td><td></td><td class="s"> $location;</td></tr>
906<tr><td class="h"><a name="681"></a>681</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
907<tr><td class="h"><a name="682"></a>682</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
908<tr><td class="h"><a name="683"></a>683</td><td></td><td></td><td></td><td></td><td class="s">sub _logical_line_and_file {</td></tr>
909<tr><td class="h"><a name="684"></a>684</td><td></td><td></td><td></td><td></td><td class="s"> my ($self, $start, $Token, $newlines) = @_;</td></tr>
910<tr><td class="h"><a name="685"></a>685</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
911<tr><td class="h"><a name="686"></a>686</td><td></td><td></td><td></td><td></td><td class="s"> # Regex taken from perlsyn, with the correction that there's no space</td></tr>
912<tr><td class="h"><a name="687"></a>687</td><td></td><td></td><td></td><td></td><td class="s"> # required between the line number and the file name.</td></tr>
913<tr><td class="h"><a name="688"></a>688</td><td></td><td></td><td></td><td></td><td class="s"> if ($start-&gt;[LOCATION_CHARACTER] == 1) {</td></tr>
914<tr><td class="h"><a name="689"></a>689</td><td></td><td></td><td></td><td></td><td class="s"> if ( $Token-&gt;isa('PPI::Token::Comment') ) {</td></tr>
915<tr><td class="h"><a name="690"></a>690</td><td></td><td></td><td></td><td></td><td class="s"> if (</td></tr>
916<tr><td class="h"><a name="691"></a>691</td><td></td><td></td><td></td><td></td><td class="s"> $Token-&gt;content =~ m&lt;</td></tr>
917<tr><td class="h"><a name="692"></a>692</td><td></td><td></td><td></td><td></td><td class="s"> \A</td></tr>
918<tr><td class="h"><a name="693"></a>693</td><td></td><td></td><td></td><td></td><td class="s"> \# \s*</td></tr>
919<tr><td class="h"><a name="694"></a>694</td><td></td><td></td><td></td><td></td><td class="s"> line \s+</td></tr>
920<tr><td class="h"><a name="695"></a>695</td><td></td><td></td><td></td><td></td><td class="s"> (\d+) \s*</td></tr>
921<tr><td class="h"><a name="696"></a>696</td><td></td><td></td><td></td><td></td><td class="s"> (?: (\&quot;?) ([^\&quot;]* [^\s\&quot;]) \2 )?</td></tr>
922<tr><td class="h"><a name="697"></a>697</td><td></td><td></td><td></td><td></td><td class="s"> \s*</td></tr>
923<tr><td class="h"><a name="698"></a>698</td><td></td><td></td><td></td><td></td><td class="s"> \z</td></tr>
924<tr><td class="h"><a name="699"></a>699</td><td></td><td></td><td></td><td></td><td class="s"> &gt;xms</td></tr>
925<tr><td class="h"><a name="700"></a>700</td><td></td><td></td><td></td><td></td><td class="s"> ) {</td></tr>
926<tr><td class="h"><a name="701"></a>701</td><td></td><td></td><td></td><td></td><td class="s"> return $1, ($3 || $start-&gt;[LOCATION_LOGICAL_FILE]);</td></tr>
927<tr><td class="h"><a name="702"></a>702</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
928<tr><td class="h"><a name="703"></a>703</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
929<tr><td class="h"><a name="704"></a>704</td><td></td><td></td><td></td><td></td><td class="s"> elsif ( $Token-&gt;isa('PPI::Token::Pod') ) {</td></tr>
930<tr><td class="h"><a name="705"></a>705</td><td></td><td></td><td></td><td></td><td class="s"> my $content = $Token-&gt;content;</td></tr>
931<tr><td class="h"><a name="706"></a>706</td><td></td><td></td><td></td><td></td><td class="s"> my $line;</td></tr>
932<tr><td class="h"><a name="707"></a>707</td><td></td><td></td><td></td><td></td><td class="s"> my $file = $start-&gt;[LOCATION_LOGICAL_FILE];</td></tr>
933<tr><td class="h"><a name="708"></a>708</td><td></td><td></td><td></td><td></td><td class="s"> my $end_of_directive;</td></tr>
934<tr><td class="h"><a name="709"></a>709</td><td></td><td></td><td></td><td></td><td class="s"> while (</td></tr>
935<tr><td class="h"><a name="710"></a>710</td><td></td><td></td><td></td><td></td><td class="s"> $content =~ m&lt;</td></tr>
936<tr><td class="h"><a name="711"></a>711</td><td></td><td></td><td></td><td></td><td class="s"> ^</td></tr>
937<tr><td class="h"><a name="712"></a>712</td><td></td><td></td><td></td><td></td><td class="s"> \# \s*?</td></tr>
938<tr><td class="h"><a name="713"></a>713</td><td></td><td></td><td></td><td></td><td class="s"> line \s+?</td></tr>
939<tr><td class="h"><a name="714"></a>714</td><td></td><td></td><td></td><td></td><td class="s"> (\d+) (?: (?! \n) \s)*</td></tr>
940<tr><td class="h"><a name="715"></a>715</td><td></td><td></td><td></td><td></td><td class="s"> (?: (\&quot;?) ([^\&quot;]*? [^\s\&quot;]) \2 )??</td></tr>
941<tr><td class="h"><a name="716"></a>716</td><td></td><td></td><td></td><td></td><td class="s"> \s*?</td></tr>
942<tr><td class="h"><a name="717"></a>717</td><td></td><td></td><td></td><td></td><td class="s"> $</td></tr>
943<tr><td class="h"><a name="718"></a>718</td><td></td><td></td><td></td><td></td><td class="s"> &gt;xmsg</td></tr>
944<tr><td class="h"><a name="719"></a>719</td><td></td><td></td><td></td><td></td><td class="s"> ) {</td></tr>
945<tr><td class="h"><a name="720"></a>720</td><td></td><td></td><td></td><td></td><td class="s"> ($line, $file) = ($1, ( $3 || $file ) );</td></tr>
946<tr><td class="h"><a name="721"></a>721</td><td></td><td></td><td></td><td></td><td class="s"> $end_of_directive = pos $content;</td></tr>
947<tr><td class="h"><a name="722"></a>722</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
948<tr><td class="h"><a name="723"></a>723</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
949<tr><td class="h"><a name="724"></a>724</td><td></td><td></td><td></td><td></td><td class="s"> if (defined $line) {</td></tr>
950<tr><td class="h"><a name="725"></a>725</td><td></td><td></td><td></td><td></td><td class="s"> pos $content = $end_of_directive;</td></tr>
951<tr><td class="h"><a name="726"></a>726</td><td></td><td></td><td></td><td></td><td class="s"> my $post_directive_newlines =()= $content =~ m&lt; \G [^\n]* \n &gt;xmsg;</td></tr>
952<tr><td class="h"><a name="727"></a>727</td><td></td><td></td><td></td><td></td><td class="s"> return $line + $post_directive_newlines - 1, $file;</td></tr>
953<tr><td class="h"><a name="728"></a>728</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
954<tr><td class="h"><a name="729"></a>729</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
955<tr><td class="h"><a name="730"></a>730</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
956<tr><td class="h"><a name="731"></a>731</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
957<tr><td class="h"><a name="732"></a>732</td><td></td><td></td><td></td><td></td><td class="s"> return</td></tr>
958<tr><td class="h"><a name="733"></a>733</td><td></td><td></td><td></td><td></td><td class="s"> $start-&gt;[LOCATION_LOGICAL_LINE] + $newlines,</td></tr>
959<tr><td class="h"><a name="734"></a>734</td><td></td><td></td><td></td><td></td><td class="s"> $start-&gt;[LOCATION_LOGICAL_FILE];</td></tr>
960<tr><td class="h"><a name="735"></a>735</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
961<tr><td class="h"><a name="736"></a>736</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
962<tr><td class="h"><a name="737"></a>737</td><td></td><td></td><td></td><td></td><td class="s">sub _visual_length {</td></tr>
963<tr><td class="h"><a name="738"></a>738</td><td></td><td></td><td></td><td></td><td class="s"> my ($self, $content, $pos) = @_;</td></tr>
964<tr><td class="h"><a name="739"></a>739</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
965<tr><td class="h"><a name="740"></a>740</td><td></td><td></td><td></td><td></td><td class="s"> my $tab_width = $self-&gt;tab_width;</td></tr>
966<tr><td class="h"><a name="741"></a>741</td><td></td><td></td><td></td><td></td><td class="s"> my ($length, $vis_inc);</td></tr>
967<tr><td class="h"><a name="742"></a>742</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
968<tr><td class="h"><a name="743"></a>743</td><td></td><td></td><td></td><td></td><td class="s"> return length $content if $content !~ /\t/;</td></tr>
969<tr><td class="h"><a name="744"></a>744</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
970<tr><td class="h"><a name="745"></a>745</td><td></td><td></td><td></td><td></td><td class="s"> # Split the content in tab and non-tab parts and calculate the</td></tr>
971<tr><td class="h"><a name="746"></a>746</td><td></td><td></td><td></td><td></td><td class="s"> # &quot;visual increase&quot; of each part.</td></tr>
972<tr><td class="h"><a name="747"></a>747</td><td></td><td></td><td></td><td></td><td class="s"> for my $part ( split(/(\t)/, $content) ) {</td></tr>
973<tr><td class="h"><a name="748"></a>748</td><td></td><td></td><td></td><td></td><td class="s"> if ($part eq &quot;\t&quot;) {</td></tr>
974<tr><td class="h"><a name="749"></a>749</td><td></td><td></td><td></td><td></td><td class="s"> $vis_inc = $tab_width - ($pos-1) % $tab_width;</td></tr>
975<tr><td class="h"><a name="750"></a>750</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
976<tr><td class="h"><a name="751"></a>751</td><td></td><td></td><td></td><td></td><td class="s"> else {</td></tr>
977<tr><td class="h"><a name="752"></a>752</td><td></td><td></td><td></td><td></td><td class="s"> $vis_inc = length $part;</td></tr>
978<tr><td class="h"><a name="753"></a>753</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
979<tr><td class="h"><a name="754"></a>754</td><td></td><td></td><td></td><td></td><td class="s"> $length += $vis_inc;</td></tr>
980<tr><td class="h"><a name="755"></a>755</td><td></td><td></td><td></td><td></td><td class="s"> $pos += $vis_inc;</td></tr>
981<tr><td class="h"><a name="756"></a>756</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
982<tr><td class="h"><a name="757"></a>757</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
983<tr><td class="h"><a name="758"></a>758</td><td></td><td></td><td></td><td></td><td class="s"> $length;</td></tr>
984<tr><td class="h"><a name="759"></a>759</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
985<tr><td class="h"><a name="760"></a>760</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
986<tr><td class="h"><a name="761"></a>761</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
987<tr><td class="h"><a name="762"></a>762</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
988<tr><td class="h"><a name="763"></a>763</td><td></td><td></td><td></td><td></td><td class="s">=head2 flush_locations</td></tr>
989<tr><td class="h"><a name="764"></a>764</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
990<tr><td class="h"><a name="765"></a>765</td><td></td><td></td><td></td><td></td><td class="s">When no longer needed, the C&lt;flush_locations&gt; method clears all location data</td></tr>
991<tr><td class="h"><a name="766"></a>766</td><td></td><td></td><td></td><td></td><td class="s">from the tokens.</td></tr>
992<tr><td class="h"><a name="767"></a>767</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
993<tr><td class="h"><a name="768"></a>768</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
994<tr><td class="h"><a name="769"></a>769</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
995<tr><td class="h"><a name="770"></a>770</td><td></td><td></td><td></td><td></td><td class="s">sub flush_locations {</td></tr>
996<tr><td class="h"><a name="771"></a>771</td><td></td><td></td><td></td><td></td><td class="s"> shift-&gt;_flush_locations(@_);</td></tr>
997<tr><td class="h"><a name="772"></a>772</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
998<tr><td class="h"><a name="773"></a>773</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
999<tr><td class="h"><a name="774"></a>774</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
1000<tr><td class="h"><a name="775"></a>775</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1001<tr><td class="h"><a name="776"></a>776</td><td></td><td></td><td></td><td></td><td class="s">=head2 normalized</td></tr>
1002<tr><td class="h"><a name="777"></a>777</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1003<tr><td class="h"><a name="778"></a>778</td><td></td><td></td><td></td><td></td><td class="s">The C&lt;normalized&gt; method is used to generate a &quot;Layer 1&quot;</td></tr>
1004<tr><td class="h"><a name="779"></a>779</td><td></td><td></td><td></td><td></td><td class="s">L&lt;PPI::Document::Normalized&gt; object for the current Document.</td></tr>
1005<tr><td class="h"><a name="780"></a>780</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1006<tr><td class="h"><a name="781"></a>781</td><td></td><td></td><td></td><td></td><td class="s">A &quot;normalized&quot; Perl Document is an arbitrary structure that removes any</td></tr>
1007<tr><td class="h"><a name="782"></a>782</td><td></td><td></td><td></td><td></td><td class="s">irrelevant parts of the document and refactors out variations in style,</td></tr>
1008<tr><td class="h"><a name="783"></a>783</td><td></td><td></td><td></td><td></td><td class="s">to attempt to approach something that is closer to the &quot;true meaning&quot;</td></tr>
1009<tr><td class="h"><a name="784"></a>784</td><td></td><td></td><td></td><td></td><td class="s">of the Document.</td></tr>
1010<tr><td class="h"><a name="785"></a>785</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1011<tr><td class="h"><a name="786"></a>786</td><td></td><td></td><td></td><td></td><td class="s">See L&lt;PPI::Normal&gt; for more information on document normalization and</td></tr>
1012<tr><td class="h"><a name="787"></a>787</td><td></td><td></td><td></td><td></td><td class="s">the tasks for which it is useful.</td></tr>
1013<tr><td class="h"><a name="788"></a>788</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1014<tr><td class="h"><a name="789"></a>789</td><td></td><td></td><td></td><td></td><td class="s">Returns a L&lt;PPI::Document::Normalized&gt; object, or C&lt;undef&gt; on error.</td></tr>
1015<tr><td class="h"><a name="790"></a>790</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1016<tr><td class="h"><a name="791"></a>791</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
1017<tr><td class="h"><a name="792"></a>792</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1018<tr><td class="h"><a name="793"></a>793</td><td></td><td></td><td></td><td></td><td class="s">sub normalized {</td></tr>
1019<tr><td class="h"><a name="794"></a>794</td><td></td><td></td><td></td><td></td><td class="s"> # The normalization process will utterly destroy and mangle</td></tr>
1020<tr><td class="h"><a name="795"></a>795</td><td></td><td></td><td></td><td></td><td class="s"> # anything passed to it, so we are going to only give it a</td></tr>
1021<tr><td class="h"><a name="796"></a>796</td><td></td><td></td><td></td><td></td><td class="s"> # clone of ourself.</td></tr>
1022<tr><td class="h"><a name="797"></a>797</td><td></td><td></td><td></td><td></td><td class="s"> PPI::Normal-&gt;process( $_[0]-&gt;clone );</td></tr>
1023<tr><td class="h"><a name="798"></a>798</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
1024<tr><td class="h"><a name="799"></a>799</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1025<tr><td class="h"><a name="800"></a>800</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
1026<tr><td class="h"><a name="801"></a>801</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1027<tr><td class="h"><a name="802"></a>802</td><td></td><td></td><td></td><td></td><td class="s">=head1 complete</td></tr>
1028<tr><td class="h"><a name="803"></a>803</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1029<tr><td class="h"><a name="804"></a>804</td><td></td><td></td><td></td><td></td><td class="s">The C&lt;complete&gt; method is used to determine if a document is cleanly</td></tr>
1030<tr><td class="h"><a name="805"></a>805</td><td></td><td></td><td></td><td></td><td class="s">structured, all braces are closed, the final statement is</td></tr>
1031<tr><td class="h"><a name="806"></a>806</td><td></td><td></td><td></td><td></td><td class="s">fully terminated and all heredocs are fully entered.</td></tr>
1032<tr><td class="h"><a name="807"></a>807</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1033<tr><td class="h"><a name="808"></a>808</td><td></td><td></td><td></td><td></td><td class="s">Returns true if the document is complete or false if not.</td></tr>
1034<tr><td class="h"><a name="809"></a>809</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1035<tr><td class="h"><a name="810"></a>810</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
1036<tr><td class="h"><a name="811"></a>811</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1037<tr><td class="h"><a name="812"></a>812</td><td></td><td></td><td></td><td></td><td class="s">sub complete {</td></tr>
1038<tr><td class="h"><a name="813"></a>813</td><td></td><td></td><td></td><td></td><td class="s"> my $self = shift;</td></tr>
1039<tr><td class="h"><a name="814"></a>814</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1040<tr><td class="h"><a name="815"></a>815</td><td></td><td></td><td></td><td></td><td class="s"> # Every structure has to be complete</td></tr>
1041<tr><td class="h"><a name="816"></a>816</td><td></td><td></td><td></td><td></td><td class="s"> $self-&gt;find_any( sub {</td></tr>
1042<tr><td class="h"><a name="817"></a>817</td><td></td><td></td><td></td><td></td><td class="s"> $_[1]-&gt;isa('PPI::Structure')</td></tr>
1043<tr><td class="h"><a name="818"></a>818</td><td></td><td></td><td></td><td></td><td class="s"> and</td></tr>
1044<tr><td class="h"><a name="819"></a>819</td><td></td><td></td><td></td><td></td><td class="s"> ! $_[1]-&gt;complete</td></tr>
1045<tr><td class="h"><a name="820"></a>820</td><td></td><td></td><td></td><td></td><td class="s"> } )</td></tr>
1046<tr><td class="h"><a name="821"></a>821</td><td></td><td></td><td></td><td></td><td class="s"> and return '';</td></tr>
1047<tr><td class="h"><a name="822"></a>822</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1048<tr><td class="h"><a name="823"></a>823</td><td></td><td></td><td></td><td></td><td class="s"> # Strip anything that isn't a statement off the end</td></tr>
1049<tr><td class="h"><a name="824"></a>824</td><td></td><td></td><td></td><td></td><td class="s"> my @child = $self-&gt;children;</td></tr>
1050<tr><td class="h"><a name="825"></a>825</td><td></td><td></td><td></td><td></td><td class="s"> while ( @child and not $child[-1]-&gt;isa('PPI::Statement') ) {</td></tr>
1051<tr><td class="h"><a name="826"></a>826</td><td></td><td></td><td></td><td></td><td class="s"> pop @child;</td></tr>
1052<tr><td class="h"><a name="827"></a>827</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
1053<tr><td class="h"><a name="828"></a>828</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1054<tr><td class="h"><a name="829"></a>829</td><td></td><td></td><td></td><td></td><td class="s"> # We must have at least one statement</td></tr>
1055<tr><td class="h"><a name="830"></a>830</td><td></td><td></td><td></td><td></td><td class="s"> return '' unless @child;</td></tr>
1056<tr><td class="h"><a name="831"></a>831</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1057<tr><td class="h"><a name="832"></a>832</td><td></td><td></td><td></td><td></td><td class="s"> # Check the completeness of the last statement</td></tr>
1058<tr><td class="h"><a name="833"></a>833</td><td></td><td></td><td></td><td></td><td class="s"> return $child[-1]-&gt;_complete;</td></tr>
1059<tr><td class="h"><a name="834"></a>834</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
1060<tr><td class="h"><a name="835"></a>835</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1061<tr><td class="h"><a name="- -"></a>- -</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1062<tr><td class="h"><a name="840"></a>840</td><td></td><td></td><td></td><td></td><td class="s">#####################################################################</td></tr>
1063<tr><td class="h"><a name="841"></a>841</td><td></td><td></td><td></td><td></td><td class="s"># PPI::Node Methods</td></tr>
1064<tr><td class="h"><a name="842"></a>842</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1065<tr><td class="h"><a name="843"></a>843</td><td></td><td></td><td></td><td></td><td class="s"># We are a scope boundary</td></tr>
1066<tr><td class="h"><a name="844"></a>844</td><td></td><td></td><td></td><td></td><td class="s">### XS -&gt; PPI/XS.xs:_PPI_Document__scope 0.903+</td></tr>
1067<tr><td class="h"><a name="845"></a>845</td><td></td><td></td><td></td><td></td><td class="s">sub scope { 1 }</td></tr>
1068<tr><td class="h"><a name="846"></a>846</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1069<tr><td class="h"><a name="- -"></a>- -</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1070<tr><td class="h"><a name="851"></a>851</td><td></td><td></td><td></td><td></td><td class="s">#####################################################################</td></tr>
1071<tr><td class="h"><a name="852"></a>852</td><td></td><td></td><td></td><td></td><td class="s"># PPI::Element Methods</td></tr>
1072<tr><td class="h"><a name="853"></a>853</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1073<tr><td class="h"><a name="854"></a>854</td><td></td><td></td><td></td><td></td><td class="s">sub insert_before {</td></tr>
1074<tr><td class="h"><a name="855"></a>855</td><td></td><td></td><td></td><td></td><td class="s"> return undef;</td></tr>
1075<tr><td class="h"><a name="856"></a>856</td><td></td><td></td><td></td><td></td><td class="s"> # die &quot;Cannot insert_before a PPI::Document&quot;;</td></tr>
1076<tr><td class="h"><a name="857"></a>857</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
1077<tr><td class="h"><a name="858"></a>858</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1078<tr><td class="h"><a name="859"></a>859</td><td></td><td></td><td></td><td></td><td class="s">sub insert_after {</td></tr>
1079<tr><td class="h"><a name="860"></a>860</td><td></td><td></td><td></td><td></td><td class="s"> return undef;</td></tr>
1080<tr><td class="h"><a name="861"></a>861</td><td></td><td></td><td></td><td></td><td class="s"> # die &quot;Cannot insert_after a PPI::Document&quot;;</td></tr>
1081<tr><td class="h"><a name="862"></a>862</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
1082<tr><td class="h"><a name="863"></a>863</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1083<tr><td class="h"><a name="864"></a>864</td><td></td><td></td><td></td><td></td><td class="s">sub replace {</td></tr>
1084<tr><td class="h"><a name="865"></a>865</td><td></td><td></td><td></td><td></td><td class="s"> return undef;</td></tr>
1085<tr><td class="h"><a name="866"></a>866</td><td></td><td></td><td></td><td></td><td class="s"> # die &quot;Cannot replace a PPI::Document&quot;;</td></tr>
1086<tr><td class="h"><a name="867"></a>867</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
1087<tr><td class="h"><a name="868"></a>868</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1088<tr><td class="h"><a name="- -"></a>- -</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1089<tr><td class="h"><a name="873"></a>873</td><td></td><td></td><td></td><td></td><td class="s">#####################################################################</td></tr>
1090<tr><td class="h"><a name="874"></a>874</td><td></td><td></td><td></td><td></td><td class="s"># Error Handling</td></tr>
1091<tr><td class="h"><a name="875"></a>875</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1092<tr><td class="h"><a name="876"></a>876</td><td></td><td></td><td></td><td></td><td class="s"># Set the error message</td></tr>
1093<tr><td class="h"><a name="877"></a>877</td><td></td><td></td><td></td><td></td><td class="s">sub _error {</td></tr>
1094<tr><td class="h"><a name="878"></a>878</td><td></td><td></td><td></td><td></td><td class="s"> $errstr = $_[1];</td></tr>
1095<tr><td class="h"><a name="879"></a>879</td><td></td><td></td><td></td><td></td><td class="s"> undef;</td></tr>
1096<tr><td class="h"><a name="880"></a>880</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
1097<tr><td class="h"><a name="881"></a>881</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1098<tr><td class="h"><a name="882"></a>882</td><td></td><td></td><td></td><td></td><td class="s"># Clear the error message.</td></tr>
1099<tr><td class="h"><a name="883"></a>883</td><td></td><td></td><td></td><td></td><td class="s"># Returns the object as a convenience.</td></tr>
1100<tr><td class="h"><a name="884"></a>884</td><td></td><td></td><td></td><td></td><td class="s">sub _clear {</td></tr>
1101<tr><td class="h"><a name="885"></a>885</td><td></td><td></td><td></td><td></td><td class="s"> $errstr = '';</td></tr>
1102<tr><td class="h"><a name="886"></a>886</td><td></td><td></td><td></td><td></td><td class="s"> $_[0];</td></tr>
1103<tr><td class="h"><a name="887"></a>887</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
1104<tr><td class="h"><a name="888"></a>888</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1105<tr><td class="h"><a name="889"></a>889</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
1106<tr><td class="h"><a name="890"></a>890</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1107<tr><td class="h"><a name="891"></a>891</td><td></td><td></td><td></td><td></td><td class="s">=head2 errstr</td></tr>
1108<tr><td class="h"><a name="892"></a>892</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1109<tr><td class="h"><a name="893"></a>893</td><td></td><td></td><td></td><td></td><td class="s">For error that occur when loading and saving documents, you can use</td></tr>
1110<tr><td class="h"><a name="894"></a>894</td><td></td><td></td><td></td><td></td><td class="s">C&lt;errstr&gt;, as either a static or object method, to access the error message.</td></tr>
1111<tr><td class="h"><a name="895"></a>895</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1112<tr><td class="h"><a name="896"></a>896</td><td></td><td></td><td></td><td></td><td class="s">If a Document loads or saves without error, C&lt;errstr&gt; will return false.</td></tr>
1113<tr><td class="h"><a name="897"></a>897</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1114<tr><td class="h"><a name="898"></a>898</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
1115<tr><td class="h"><a name="899"></a>899</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1116<tr><td class="h"><a name="900"></a>900</td><td></td><td></td><td></td><td></td><td class="s">sub errstr {</td></tr>
1117<tr><td class="h"><a name="901"></a>901</td><td></td><td></td><td></td><td></td><td class="s"> $errstr;</td></tr>
1118<tr><td class="h"><a name="902"></a>902</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
1119<tr><td class="h"><a name="903"></a>903</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1120<tr><td class="h"><a name="- -"></a>- -</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1121<tr><td class="h"><a name="908"></a>908</td><td></td><td></td><td></td><td></td><td class="s">#####################################################################</td></tr>
1122<tr><td class="h"><a name="909"></a>909</td><td></td><td></td><td></td><td></td><td class="s"># Native Storable Support</td></tr>
1123<tr><td class="h"><a name="910"></a>910</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1124<tr><td class="h"><a name="911"></a>911</td><td></td><td></td><td></td><td></td><td class="s">sub STORABLE_freeze {</td></tr>
1125<tr><td class="h"><a name="912"></a>912</td><td></td><td></td><td></td><td></td><td class="s"> my $self = shift;</td></tr>
1126<tr><td class="h"><a name="913"></a>913</td><td></td><td></td><td></td><td></td><td class="s"> my $class = ref $self;</td></tr>
1127<tr><td class="h"><a name="914"></a>914</td><td></td><td></td><td></td><td></td><td class="s"> my %hash = %$self;</td></tr>
1128<tr><td class="h"><a name="915"></a>915</td><td></td><td></td><td></td><td></td><td class="s"> return ($class, \%hash);</td></tr>
1129<tr><td class="h"><a name="916"></a>916</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
1130<tr><td class="h"><a name="917"></a>917</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1131<tr><td class="h"><a name="918"></a>918</td><td></td><td></td><td></td><td></td><td class="s">sub STORABLE_thaw {</td></tr>
1132<tr><td class="h"><a name="919"></a>919</td><td></td><td></td><td></td><td></td><td class="s"> my ($self, undef, $class, $hash) = @_;</td></tr>
1133<tr><td class="h"><a name="920"></a>920</td><td></td><td></td><td></td><td></td><td class="s"> bless $self, $class;</td></tr>
1134<tr><td class="h"><a name="921"></a>921</td><td></td><td></td><td></td><td></td><td class="s"> foreach ( keys %$hash ) {</td></tr>
1135<tr><td class="h"><a name="922"></a>922</td><td></td><td></td><td></td><td></td><td class="s"> $self-&gt;{$_} = delete $hash-&gt;{$_};</td></tr>
1136<tr><td class="h"><a name="923"></a>923</td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
1137<tr><td class="h"><a name="924"></a>924</td><td></td><td></td><td></td><td></td><td class="s"> $self-&gt;__link_children;</td></tr>
1138<tr><td class="h"><a name="925"></a>925</td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
1139<tr><td class="h"><a name="926"></a>926</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1140<tr><td class="h"><a name="927"></a>927</td><td class="c3">1</td><td class="c3"><span title="Avg 4&micro;s">4&micro;s</span></td><td></td><td></td><td class="s">1;</td></tr>
1141<tr><td class="h"><a name="928"></a>928</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1142<tr><td class="h"><a name="929"></a>929</td><td></td><td></td><td></td><td></td><td class="s">=pod</td></tr>
1143<tr><td class="h"><a name="930"></a>930</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1144<tr><td class="h"><a name="931"></a>931</td><td></td><td></td><td></td><td></td><td class="s">=head1 TO DO</td></tr>
1145<tr><td class="h"><a name="932"></a>932</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1146<tr><td class="h"><a name="933"></a>933</td><td></td><td></td><td></td><td></td><td class="s">- May need to overload some methods to forcefully prevent Document</td></tr>
1147<tr><td class="h"><a name="934"></a>934</td><td></td><td></td><td></td><td></td><td class="s">objects becoming children of another Node.</td></tr>
1148<tr><td class="h"><a name="935"></a>935</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1149<tr><td class="h"><a name="936"></a>936</td><td></td><td></td><td></td><td></td><td class="s">=head1 SUPPORT</td></tr>
1150<tr><td class="h"><a name="937"></a>937</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1151<tr><td class="h"><a name="938"></a>938</td><td></td><td></td><td></td><td></td><td class="s">See the L&lt;support section|PPI/SUPPORT&gt; in the main module.</td></tr>
1152<tr><td class="h"><a name="939"></a>939</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1153<tr><td class="h"><a name="940"></a>940</td><td></td><td></td><td></td><td></td><td class="s">=head1 AUTHOR</td></tr>
1154<tr><td class="h"><a name="941"></a>941</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1155<tr><td class="h"><a name="942"></a>942</td><td></td><td></td><td></td><td></td><td class="s">Adam Kennedy E&lt;lt&gt;adamk@cpan.orgE&lt;gt&gt;</td></tr>
1156<tr><td class="h"><a name="943"></a>943</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1157<tr><td class="h"><a name="944"></a>944</td><td></td><td></td><td></td><td></td><td class="s">=head1 SEE ALSO</td></tr>
1158<tr><td class="h"><a name="945"></a>945</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1159<tr><td class="h"><a name="946"></a>946</td><td></td><td></td><td></td><td></td><td class="s">L&lt;PPI&gt;, L&lt;http://ali.as/&gt;</td></tr>
1160<tr><td class="h"><a name="947"></a>947</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1161<tr><td class="h"><a name="948"></a>948</td><td></td><td></td><td></td><td></td><td class="s">=head1 COPYRIGHT</td></tr>
1162<tr><td class="h"><a name="949"></a>949</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1163<tr><td class="h"><a name="950"></a>950</td><td></td><td></td><td></td><td></td><td class="s">Copyright 2001 - 2011 Adam Kennedy.</td></tr>
1164<tr><td class="h"><a name="951"></a>951</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1165<tr><td class="h"><a name="952"></a>952</td><td></td><td></td><td></td><td></td><td class="s">This program is free software; you can redistribute</td></tr>
1166<tr><td class="h"><a name="953"></a>953</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>
1167<tr><td class="h"><a name="954"></a>954</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1168<tr><td class="h"><a name="955"></a>955</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>
1169<tr><td class="h"><a name="956"></a>956</td><td></td><td></td><td></td><td></td><td class="s">LICENSE file included with this module.</td></tr>
1170<tr><td class="h"><a name="957"></a>957</td><td></td><td></td><td></td><td></td><td class="s"></td></tr>
1171<tr><td class="h"><a name="958"></a>958</td><td></td><td></td><td></td><td></td><td class="s">=cut</td></tr>
1172</tbody></table></div>
1173
1174 <script type="text/javascript"> $(document).ready(function() {
1175
1176 $("#subs_table").tablesorter({
1177 sortList: [[3,1]],
1178 headers: {
1179 3: { sorter: 'fmt_time' },
1180 4: { sorter: 'fmt_time' }
1181 }
1182 });
1183
1184 } ); </script>
1185
1186 <div class="footer">Report produced by the
1187 <a href="http://search.cpan.org/dist/Devel-NYTProf/">NYTProf 4.06</a>
1188 Perl profiler, developed by
1189 <a href="http://www.linkedin.com/in/timbunce">Tim Bunce</a> and
1190 <a href="http://code.nytimes.com">Adam Kaplan</a>.
1191 </div>
1192 <br /><br /><br /><br /><br /><br /><br /><br /><br /><br />
1193 </body></html>