Mercurial > repos > deepakjadmin > mayatool3_test3
diff mayachemtools/docs/modules/html/code/TextUtil.html @ 0:73ae111cf86f draft
Uploaded
| author | deepakjadmin |
|---|---|
| date | Wed, 20 Jan 2016 11:55:01 -0500 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mayachemtools/docs/modules/html/code/TextUtil.html Wed Jan 20 11:55:01 2016 -0500 @@ -0,0 +1,594 @@ +<html> +<head> +<title>MayaChemTools:Code:TextUtil.pm</title> +<meta http-equiv="content-type" content="text/html;charset=utf-8"> +<link rel="stylesheet" type="text/css" href="../../../css/MayaChemToolsCode.css"> +</head> +<body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10"> +<br/> +<center> +<a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a> +</center> +<br/> +<pre> +<a name="package-TextUtil-"></a> 1 <span class="k">package </span><span class="i">TextUtil</span><span class="sc">;</span> + 2 <span class="c">#</span> + 3 <span class="c"># $RCSfile: TextUtil.pm,v $</span> + 4 <span class="c"># $Date: 2015/03/22 20:08:26 $</span> + 5 <span class="c"># $Revision: 1.45 $</span> + 6 <span class="c">#</span> + 7 <span class="c"># Author: Manish Sud <msud@san.rr.com></span> + 8 <span class="c">#</span> + 9 <span class="c"># Copyright (C) 2015 Manish Sud. All rights reserved.</span> + 10 <span class="c">#</span> + 11 <span class="c"># This file is part of MayaChemTools.</span> + 12 <span class="c">#</span> + 13 <span class="c"># MayaChemTools is free software; you can redistribute it and/or modify it under</span> + 14 <span class="c"># the terms of the GNU Lesser General Public License as published by the Free</span> + 15 <span class="c"># Software Foundation; either version 3 of the License, or (at your option) any</span> + 16 <span class="c"># later version.</span> + 17 <span class="c">#</span> + 18 <span class="c"># MayaChemTools is distributed in the hope that it will be useful, but without</span> + 19 <span class="c"># any warranty; without even the implied warranty of merchantability of fitness</span> + 20 <span class="c"># for a particular purpose. See the GNU Lesser General Public License for more</span> + 21 <span class="c"># details.</span> + 22 <span class="c">#</span> + 23 <span class="c"># You should have received a copy of the GNU Lesser General Public License</span> + 24 <span class="c"># along with MayaChemTools; if not, see <http://www.gnu.org/licenses/> or</span> + 25 <span class="c"># write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,</span> + 26 <span class="c"># Boston, MA, 02111-1307, USA.</span> + 27 <span class="c">#</span> + 28 + 29 <span class="k">use</span> <span class="w">strict</span><span class="sc">;</span> + 30 <span class="k">use</span> <span class="w">Exporter</span><span class="sc">;</span> + 31 + 32 <span class="k">use</span> <span class="w">vars</span> <span class="q">qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS)</span><span class="sc">;</span> + 33 + 34 <span class="i">@ISA</span> = <span class="q">qw(Exporter)</span><span class="sc">;</span> + 35 <span class="i">@EXPORT</span> = <span class="q">qw(AddNumberSuffix ContainsWhiteSpaces GetTextLine GetTextFileDataByUniqueKey GetTextFileDataByNonUniqueKey HashCode IsEmpty IsNumberPowerOfNumber IsInteger IsPositiveInteger IsFloat IsNotEmpty IsNumerical JoinWords SplitWords QuoteAWord RemoveLeadingWhiteSpaces RemoveTrailingWhiteSpaces RemoveLeadingAndTrailingWhiteSpaces WrapText)</span><span class="sc">;</span> + 36 <span class="i">@EXPORT_OK</span> = <span class="q">qw()</span><span class="sc">;</span> + 37 <span class="i">%EXPORT_TAGS</span> = <span class="s">(</span><span class="w">all</span> <span class="cm">=></span> <span class="s">[</span><span class="i">@EXPORT</span><span class="cm">,</span> <span class="i">@EXPORT_OK</span><span class="s">]</span><span class="s">)</span><span class="sc">;</span> + 38 + 39 <span class="c"># Add number suffix...</span> +<a name="AddNumberSuffix-"></a> 40 <span class="k">sub </span><span class="m">AddNumberSuffix</span> <span class="s">{</span> + 41 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 42 <span class="k">my</span><span class="s">(</span><span class="i">$ValueWithSuffix</span><span class="cm">,</span> <span class="i">$Suffix</span><span class="s">)</span><span class="sc">;</span> + 43 + 44 <span class="i">$ValueWithSuffix</span> = <span class="i">$Value</span><span class="sc">;</span> + 45 <span class="k">if</span> <span class="s">(</span>!<span class="i">IsPositiveInteger</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 46 <span class="k">return</span> <span class="i">$ValueWithSuffix</span><span class="sc">;</span> + 47 <span class="s">}</span> + 48 <span class="i">$Suffix</span> = <span class="q">"th"</span><span class="sc">;</span> + 49 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> < <span class="n">10</span> || <span class="i">$Value</span> > <span class="n">20</span><span class="s">)</span> <span class="s">{</span> + 50 <span class="k">my</span> <span class="i">$Remainder</span> = <span class="i">$Value</span> % <span class="n">10</span><span class="sc">;</span> + 51 <span class="i">$Suffix</span> = <span class="s">(</span><span class="i">$Remainder</span> == <span class="n">1</span><span class="s">)</span> ? <span class="q">"st"</span> <span class="co">:</span> <span class="s">(</span><span class="s">(</span><span class="i">$Remainder</span> == <span class="n">2</span><span class="s">)</span> ? <span class="q">"nd"</span> <span class="co">:</span> <span class="s">(</span><span class="s">(</span><span class="i">$Remainder</span> == <span class="n">3</span><span class="s">)</span> ? <span class="q">"rd"</span> <span class="co">:</span> <span class="q">"th"</span><span class="s">)</span><span class="s">)</span><span class="sc">;</span> + 52 <span class="s">}</span> + 53 <span class="i">$ValueWithSuffix</span> = <span class="q">"${ValueWithSuffix}${Suffix}"</span><span class="sc">;</span> + 54 <span class="k">return</span> <span class="i">$ValueWithSuffix</span><span class="sc">;</span> + 55 <span class="s">}</span> + 56 + 57 <span class="c"># Check out the string: Doen it contain any white space characters?</span> +<a name="ContainsWhiteSpaces-"></a> 58 <span class="k">sub </span><span class="m">ContainsWhiteSpaces</span> <span class="s">{</span> + 59 <span class="k">my</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 60 <span class="k">my</span><span class="s">(</span><span class="i">$Status</span><span class="s">)</span> = <span class="n">0</span><span class="sc">;</span> + 61 + 62 <span class="k">if</span> <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> && <span class="k">length</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 63 <span class="i">$Status</span> = <span class="s">(</span><span class="i">$TheString</span> =~ <span class="q">/[ \t\r\n\f]/</span> <span class="s">)</span> ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span> + 64 <span class="s">}</span> + 65 <span class="k">return</span> <span class="i">$Status</span><span class="sc">;</span> + 66 <span class="s">}</span> + 67 + 68 <span class="c"># Read the line, change to UNIX new line char, and chop off new line char as well...</span> +<a name="GetTextLine-"></a> 69 <span class="k">sub </span><span class="m">GetTextLine</span> <span class="s">{</span> + 70 <span class="k">my</span><span class="s">(</span><span class="i">$TextFileRef</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 71 <span class="k">my</span><span class="s">(</span><span class="i">$Line</span><span class="s">)</span> = <span class="q">''</span><span class="sc">;</span> + 72 + 73 <span class="c"># Get the next non empty line...</span> + 74 <span class="j">LINE:</span> <span class="k">while</span> <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$_</span> = <span class="q"><$TextFileRef></span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 75 <span class="c"># Change Windows and Mac new line char to UNIX...</span> + 76 <span class="q">s/(\r\n)|(\r)/\n/g</span><span class="sc">;</span> + 77 + 78 <span class="c"># Take out any new line char at the end by explicitly removing it instead of using</span> + 79 <span class="c"># chomp, which might not always work correctly on files generated on a system</span> + 80 <span class="c"># with a value of input line separator different from the current system...</span> + 81 <span class="q">s/\n$//g</span><span class="sc">;</span> + 82 + 83 <span class="c"># Doesn't hurt to chomp...</span> + 84 <span class="k">chomp</span><span class="sc">;</span> + 85 + 86 <span class="i">$Line</span> = <span class="i">$_</span><span class="sc">;</span> + 87 <span class="k">if</span> <span class="s">(</span><span class="k">length</span> <span class="i">$Line</span><span class="s">)</span> <span class="s">{</span> + 88 <span class="k">last</span> <span class="j">LINE</span><span class="sc">;</span> + 89 <span class="s">}</span> + 90 <span class="s">}</span> + 91 <span class="k">return</span> <span class="i">$Line</span><span class="sc">;</span> + 92 <span class="s">}</span> + 93 + 94 <span class="c"># Load data from a CSV file into the specified hash reference using a specific</span> + 95 <span class="c"># column for unique data key values.</span> + 96 <span class="c">#</span> + 97 <span class="c"># The lines starting with # are treated as comments and ignored. First line</span> + 98 <span class="c"># not starting with # must contain column labels and the number of columns in</span> + 99 <span class="c"># all other data rows must match the number of column labels.</span> + 100 <span class="c">#</span> + 101 <span class="c"># The first column is assumed to contain data key value by default; all other columns</span> + 102 <span class="c"># contain data as indicated in their column labels.</span> + 103 <span class="c">#</span> + 104 <span class="c"># In order to avoid dependence of data access on the specified column labels, the</span> + 105 <span class="c"># column data is loaded into hash with Column<Num> hash keys, where column number</span> + 106 <span class="c"># start from 1. The data key column is not available as Colnum<Num> hash key;</span> + 107 <span class="c">#</span> + 108 <span class="c"># The format of the data structure loaded into a specified hash reference is:</span> + 109 <span class="c">#</span> + 110 <span class="c"># @{$TextDataMapRef->{DataKeys}} - Array of unique data keys</span> + 111 <span class="c"># @{$TextDataMapRef->{ColLabels}} - Array of column labels</span> + 112 <span class="c"># @{$TextDataMapRef->{DataColIDs}} - Array of data column IDs</span> + 113 <span class="c"># $TextDataMapRef->{NumOfCols} - Number of columns</span> + 114 <span class="c"># %{$TextDataMapRef->{DataKey}} - Hash keys pair: <DataKey, DataKey></span> + 115 <span class="c"># %{$TextDataMapRef->{DataCol<Num>}} - Hash keys pair: <DataCol<Num>, DataKey></span> + 116 <span class="c">#</span> + 117 <span class="c"># Caveats:</span> + 118 <span class="c"># . The column number start from 1.</span> + 119 <span class="c"># . Column data for data key column column is not loaded into <Column<Num>, DataKey> hash keys pairs.</span> + 120 <span class="c">#</span> +<a name="GetTextFileDataByUniqueKey-"></a> 121 <span class="k">sub </span><span class="m">GetTextFileDataByUniqueKey</span> <span class="s">{</span> + 122 <span class="k">my</span><span class="s">(</span><span class="i">$TextDataFile</span><span class="cm">,</span> <span class="i">$TextDataMapRef</span><span class="cm">,</span> <span class="i">$DataKeyColNum</span><span class="cm">,</span> <span class="i">$InDelim</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 123 + 124 <span class="k">return</span> <span class="i">_GetTextFileData</span><span class="s">(</span><span class="q">"UniqueKey"</span><span class="cm">,</span> <span class="i">$TextDataFile</span><span class="cm">,</span> <span class="i">$TextDataMapRef</span><span class="cm">,</span> <span class="i">$DataKeyColNum</span><span class="cm">,</span> <span class="i">$InDelim</span><span class="s">)</span><span class="sc">;</span> + 125 <span class="s">}</span> + 126 + 127 <span class="c"># Load data from a CSV file into the specified hash reference using a specific</span> + 128 <span class="c"># column for non-unique data key values.</span> + 129 <span class="c">#</span> + 130 <span class="c"># The lines starting with # are treated as comments and ignored. First line</span> + 131 <span class="c"># not starting with # must contain column labels and the number of columns in</span> + 132 <span class="c"># all other data rows must match the number of column labels.</span> + 133 <span class="c">#</span> + 134 <span class="c"># The first column is assumed to contain data key value by default; all other columns</span> + 135 <span class="c"># contain data as indicated in their column labels.</span> + 136 <span class="c">#</span> + 137 <span class="c"># In order to avoid dependence of data access on the specified column labels, the</span> + 138 <span class="c"># column data is loaded into hash with Column<Num> hash keys, where column number</span> + 139 <span class="c"># start from 1. The data key column is not available as Colnum<Num> hash key;</span> + 140 <span class="c">#</span> + 141 <span class="c"># The format of the data structure loaded into a specified hash reference is:</span> + 142 <span class="c">#</span> + 143 <span class="c"># @{$TextDataMapRef->{DataKeys}} - Array of unique data keys</span> + 144 <span class="c"># @{$TextDataMapRef->{ColLabels}} - Array of column labels</span> + 145 <span class="c"># @{$TextDataMapRef->{DataColIDs}} - Array of data column IDs</span> + 146 <span class="c"># $TextDataMapRef->{NumOfCols} - Number of columns</span> + 147 <span class="c"># %{$TextDataMapRef->{DataKey}} - Hash keys pair: <DataKey, DataKey></span> + 148 <span class="c"># @{$TextDataMapRef->{DataCol<Num>}} - Hash keys pair with data as an array: <DataCol<Num>, DataKey></span> + 149 <span class="c">#</span> + 150 <span class="c"># Caveats:</span> + 151 <span class="c"># . The column number start from 1.</span> + 152 <span class="c"># . Column data for data key column column is not loaded into <Column<Num>, DataKey> hash keys pairs.</span> + 153 <span class="c">#</span> +<a name="GetTextFileDataByNonUniqueKey-"></a> 154 <span class="k">sub </span><span class="m">GetTextFileDataByNonUniqueKey</span> <span class="s">{</span> + 155 <span class="k">my</span><span class="s">(</span><span class="i">$TextDataFile</span><span class="cm">,</span> <span class="i">$TextDataMapRef</span><span class="cm">,</span> <span class="i">$DataKeyColNum</span><span class="cm">,</span> <span class="i">$InDelim</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 156 + 157 <span class="k">return</span> <span class="i">_GetTextFileData</span><span class="s">(</span><span class="q">"NonUniqueKey"</span><span class="cm">,</span> <span class="i">$TextDataFile</span><span class="cm">,</span> <span class="i">$TextDataMapRef</span><span class="cm">,</span> <span class="i">$DataKeyColNum</span><span class="cm">,</span> <span class="i">$InDelim</span><span class="s">)</span><span class="sc">;</span> + 158 <span class="s">}</span> + 159 + 160 <span class="c"># Loadtext file data using unique or non-uniqye data column key...</span> + 161 <span class="c">#</span> +<a name="_GetTextFileData-"></a> 162 <span class="k">sub </span><span class="m">_GetTextFileData</span> <span class="s">{</span> + 163 <span class="k">my</span><span class="s">(</span><span class="i">$DataKeyMode</span><span class="cm">,</span> <span class="i">$TextDataFile</span><span class="cm">,</span> <span class="i">$TextDataMapRef</span><span class="cm">,</span> <span class="i">$DataKeyColNum</span><span class="cm">,</span> <span class="i">$InDelim</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 164 <span class="k">my</span><span class="s">(</span><span class="i">$DataKeyColIndex</span><span class="cm">,</span> <span class="i">$LineCount</span><span class="cm">,</span> <span class="i">$IgnoredLineCount</span><span class="cm">,</span> <span class="i">$UniqueDataKeyMode</span><span class="cm">,</span> <span class="i">$DataKey</span><span class="cm">,</span> <span class="i">$Line</span><span class="cm">,</span> <span class="i">$NumOfCols</span><span class="cm">,</span> <span class="i">$ColIndex</span><span class="cm">,</span> <span class="i">$ColNum</span><span class="cm">,</span> <span class="i">$ColID</span><span class="cm">,</span> <span class="i">$ColValue</span><span class="cm">,</span> <span class="i">@LineWords</span><span class="cm">,</span> <span class="i">@ColLabels</span><span class="cm">,</span> <span class="i">@DataColIDs</span><span class="cm">,</span> <span class="i">@DataColNums</span><span class="s">)</span><span class="sc">;</span> + 165 + 166 <span class="k">print</span> <span class="q">"\nProcessing text data file $TextDataFile...\n"</span><span class="sc">;</span> + 167 + 168 <span class="i">$UniqueDataKeyMode</span> = <span class="n">0</span><span class="sc">;</span> + 169 <span class="k">if</span> <span class="s">(</span><span class="i">$DataKeyMode</span> =~ <span class="q">/^UniqueKey$/i</span><span class="s">)</span> <span class="s">{</span> + 170 <span class="i">$UniqueDataKeyMode</span> = <span class="n">1</span><span class="sc">;</span> + 171 <span class="s">}</span> + 172 + 173 <span class="c"># Setup default values...</span> + 174 <span class="i">$DataKeyColNum</span> = <span class="k">defined</span> <span class="i">$DataKeyColNum</span> ? <span class="i">$DataKeyColNum</span> <span class="co">:</span> <span class="n">1</span><span class="sc">;</span> + 175 + 176 <span class="k">if</span> <span class="s">(</span><span class="i">$TextDataFile</span> =~ <span class="q">/^\.tsv$/i</span><span class="s">)</span> <span class="s">{</span> + 177 <span class="i">$InDelim</span> = <span class="q">"\t"</span><span class="sc">;</span> + 178 <span class="s">}</span> + 179 <span class="k">else</span> <span class="s">{</span> + 180 <span class="i">$InDelim</span> = <span class="q">"\,"</span><span class="sc">;</span> + 181 <span class="k">if</span> <span class="s">(</span><span class="i">$InDelim</span> =~ <span class="q">/^semicolon$/i</span><span class="s">)</span> <span class="s">{</span> + 182 <span class="i">$InDelim</span> = <span class="q">"\;"</span><span class="sc">;</span> + 183 <span class="s">}</span> + 184 <span class="s">}</span> + 185 + 186 <span class="s">(</span><span class="i">$LineCount</span><span class="cm">,</span> <span class="i">$IgnoredLineCount</span><span class="s">)</span> = <span class="s">(</span><span class="n">0</span><span class="s">)</span> x <span class="n">2</span><span class="sc">;</span> + 187 + 188 <span class="k">open</span> <span class="w">TEXTDATAFILE</span><span class="cm">,</span> <span class="q">"$TextDataFile"</span> <span class="k">or</span> <span class="k">die</span> <span class="q">"Couldn't open $TextDataFile: $! ..."</span><span class="sc">;</span> + 189 + 190 <span class="c"># Skip lines up to column labels...</span> + 191 <span class="j">LINE:</span> <span class="k">while</span> <span class="s">(</span><span class="i">$Line</span> = <span class="i">TextUtil::GetTextLine</span><span class="s">(</span>\<span class="i">*TEXTDATAFILE</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 192 <span class="i">$LineCount</span>++<span class="sc">;</span> + 193 <span class="k">if</span> <span class="s">(</span><span class="i">$Line</span> =~ <span class="q">/^#/</span><span class="s">)</span> <span class="s">{</span> + 194 <span class="i">$IgnoredLineCount</span>++<span class="sc">;</span> + 195 <span class="s">}</span> + 196 <span class="k">else</span> <span class="s">{</span> + 197 <span class="k">last</span> <span class="j">LINE</span><span class="sc">;</span> + 198 <span class="s">}</span> + 199 <span class="s">}</span> + 200 + 201 <span class="c"># Initialize data map...</span> + 202 <span class="i">%</span>{<span class="i">$TextDataMapRef</span>} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> + 203 <span class="i">@</span>{<span class="i">$TextDataMapRef</span>->{<span class="w">DataKeys</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> + 204 <span class="i">@</span>{<span class="i">$TextDataMapRef</span>->{<span class="w">ColLabels</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> + 205 <span class="i">@</span>{<span class="i">$TextDataMapRef</span>->{<span class="w">DataColIDs</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> + 206 <span class="i">$TextDataMapRef</span>->{<span class="w">NumOfCols</span>} = <span class="k">undef</span><span class="sc">;</span> + 207 + 208 <span class="c"># Process column labels...</span> + 209 <span class="i">@ColLabels</span>= <span class="i">quotewords</span><span class="s">(</span><span class="i">$InDelim</span><span class="cm">,</span> <span class="n">0</span><span class="cm">,</span> <span class="i">$Line</span><span class="s">)</span><span class="sc">;</span> + 210 <span class="i">$NumOfCols</span> = <span class="i">@ColLabels</span><span class="sc">;</span> + 211 + 212 <span class="k">if</span> <span class="s">(</span><span class="i">$DataKeyColNum</span> < <span class="n">1</span> || <span class="i">$DataKeyColNum</span> > <span class="i">$NumOfCols</span><span class="s">)</span> <span class="s">{</span> + 213 <span class="k">warn</span> <span class="q">"Warning: Ignoring text data file $TextDataFile: Invalid data key column number, $DataKeyColNum, specified. It must be > 0 or <= $NumOfCols, number of columns in the text file ..."</span><span class="sc">;</span> + 214 <span class="k">return</span><span class="sc">;</span> + 215 <span class="s">}</span> + 216 <span class="i">$DataKeyColIndex</span> = <span class="i">$DataKeyColNum</span> - <span class="n">1</span><span class="sc">;</span> + 217 + 218 <span class="i">$TextDataMapRef</span>->{<span class="w">NumOfCols</span>} = <span class="i">$NumOfCols</span><span class="sc">;</span> + 219 <span class="k">push</span> <span class="i">@</span>{<span class="i">$TextDataMapRef</span>->{<span class="w">ColLabels</span>}}<span class="cm">,</span> <span class="i">@ColLabels</span><span class="sc">;</span> + 220 + 221 <span class="c"># Set up column data IDs for tracking the data...</span> + 222 <span class="i">@DataColNums</span> = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> + 223 <span class="i">@DataColIDs</span> = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> + 224 <span class="j">COLNUM:</span> <span class="k">for</span> <span class="i">$ColNum</span> <span class="s">(</span><span class="n">1</span> .. <span class="i">$NumOfCols</span><span class="s">)</span> <span class="s">{</span> + 225 <span class="k">if</span> <span class="s">(</span><span class="i">$ColNum</span> == <span class="i">$DataKeyColNum</span><span class="s">)</span> <span class="s">{</span> + 226 <span class="k">next</span> <span class="j">COLNUM</span><span class="sc">;</span> + 227 <span class="s">}</span> + 228 <span class="k">push</span> <span class="i">@DataColNums</span><span class="cm">,</span> <span class="i">$ColNum</span><span class="sc">;</span> + 229 <span class="i">$ColID</span> = <span class="q">"DataCol${ColNum}"</span><span class="sc">;</span> + 230 <span class="k">push</span> <span class="i">@DataColIDs</span><span class="cm">,</span> <span class="i">$ColID</span><span class="sc">;</span> + 231 <span class="s">}</span> + 232 <span class="k">push</span> <span class="i">@</span>{<span class="i">$TextDataMapRef</span>->{<span class="w">DataColIDs</span>}}<span class="cm">,</span> <span class="i">@DataColIDs</span><span class="sc">;</span> + 233 + 234 <span class="c"># Initialize column data hash...</span> + 235 <span class="i">%</span>{<span class="i">$TextDataMapRef</span>->{<span class="w">DataKey</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> + 236 <span class="k">for</span> <span class="i">$ColIndex</span> <span class="s">(</span><span class="n">0</span> .. <span class="i">$#DataColNums</span><span class="s">)</span> <span class="s">{</span> + 237 <span class="i">$ColNum</span> = <span class="i">$DataColNums</span>[<span class="i">$ColIndex</span>]<span class="sc">;</span> + 238 <span class="i">$ColID</span> = <span class="i">$DataColIDs</span>[<span class="i">$ColIndex</span>]<span class="sc">;</span> + 239 <span class="i">%</span>{<span class="i">$TextDataMapRef</span>->{<span class="i">$ColID</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> + 240 <span class="s">}</span> + 241 + 242 <span class="j">LINE:</span> <span class="k">while</span> <span class="s">(</span><span class="i">$Line</span> = <span class="i">TextUtil::GetTextLine</span><span class="s">(</span>\<span class="i">*TEXTDATAFILE</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 243 <span class="i">$LineCount</span>++<span class="sc">;</span> + 244 <span class="k">if</span> <span class="s">(</span><span class="i">$Line</span> =~ <span class="q">/^#/</span><span class="s">)</span> <span class="s">{</span> + 245 <span class="i">$IgnoredLineCount</span>++<span class="sc">;</span> + 246 <span class="k">next</span> <span class="j">LINE</span><span class="sc">;</span> + 247 <span class="s">}</span> + 248 + 249 <span class="i">@LineWords</span> = <span class="i">quotewords</span><span class="s">(</span><span class="i">$InDelim</span><span class="cm">,</span> <span class="n">0</span><span class="cm">,</span> <span class="i">$Line</span><span class="s">)</span><span class="sc">;</span> + 250 <span class="k">if</span> <span class="s">(</span><span class="i">@LineWords</span> != <span class="i">$NumOfCols</span><span class="s">)</span> <span class="s">{</span> + 251 <span class="i">$IgnoredLineCount</span>++<span class="sc">;</span> + 252 <span class="k">warn</span> <span class="q">"Warning: The number of data fields, @LineWords, in $TextDataFile must be $NumOfCols.\nIgnoring line number $LineCount: $Line...\n"</span><span class="sc">;</span> + 253 <span class="k">next</span> <span class="j">LINE</span><span class="sc">;</span> + 254 <span class="s">}</span> + 255 <span class="i">$DataKey</span> = <span class="i">$LineWords</span>[<span class="i">$DataKeyColIndex</span>]<span class="sc">;</span> + 256 + 257 <span class="k">if</span> <span class="s">(</span><span class="i">$UniqueDataKeyMode</span><span class="s">)</span> <span class="s">{</span> + 258 <span class="k">if</span> <span class="s">(</span><span class="k">exists</span> <span class="i">$TextDataMapRef</span>->{<span class="w">DataKey</span>}{<span class="i">$DataKey</span>}<span class="s">)</span> <span class="s">{</span> + 259 <span class="i">$IgnoredLineCount</span>++<span class="sc">;</span> + 260 <span class="k">warn</span> <span class="q">"Warning: The data key, $DataKey, in data column key number, $DataKeyColNum, is already present.\nIgnoring line number $LineCount: $Line...\n"</span><span class="sc">;</span> + 261 <span class="k">next</span> <span class="j">LINE</span><span class="sc">;</span> + 262 <span class="s">}</span> + 263 <span class="k">push</span> <span class="i">@</span>{<span class="i">$TextDataMapRef</span>->{<span class="w">DataKeys</span>}}<span class="cm">,</span> <span class="i">$DataKey</span><span class="sc">;</span> + 264 <span class="i">$TextDataMapRef</span>->{<span class="w">DataKey</span>}{<span class="i">$DataKey</span>} = <span class="i">$DataKey</span><span class="sc">;</span> + 265 <span class="s">}</span> + 266 <span class="k">else</span> <span class="s">{</span> + 267 <span class="k">if</span> <span class="s">(</span>!<span class="k">exists</span> <span class="i">$TextDataMapRef</span>->{<span class="w">DataKey</span>}{<span class="i">$DataKey</span>}<span class="s">)</span> <span class="s">{</span> + 268 <span class="k">push</span> <span class="i">@</span>{<span class="i">$TextDataMapRef</span>->{<span class="w">DataKeys</span>}}<span class="cm">,</span> <span class="i">$DataKey</span><span class="sc">;</span> + 269 <span class="i">$TextDataMapRef</span>->{<span class="w">DataKey</span>}{<span class="i">$DataKey</span>} = <span class="i">$DataKey</span><span class="sc">;</span> + 270 + 271 <span class="k">for</span> <span class="i">$ColIndex</span> <span class="s">(</span><span class="n">0</span> .. <span class="i">$#DataColNums</span><span class="s">)</span> <span class="s">{</span> + 272 <span class="i">$ColNum</span> = <span class="i">$DataColNums</span>[<span class="i">$ColIndex</span>]<span class="sc">;</span> + 273 <span class="i">$ColID</span> = <span class="i">$DataColIDs</span>[<span class="i">$ColIndex</span>]<span class="sc">;</span> + 274 <span class="i">@</span>{<span class="i">$TextDataMapRef</span>->{<span class="i">$ColID</span>}{<span class="i">$DataKey</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> + 275 <span class="s">}</span> + 276 <span class="s">}</span> + 277 <span class="s">}</span> + 278 + 279 <span class="c"># Track column data values...</span> + 280 <span class="k">for</span> <span class="i">$ColIndex</span> <span class="s">(</span><span class="n">0</span> .. <span class="i">$#DataColNums</span><span class="s">)</span> <span class="s">{</span> + 281 <span class="i">$ColID</span> = <span class="i">$DataColIDs</span>[<span class="i">$ColIndex</span>]<span class="sc">;</span> + 282 + 283 <span class="i">$ColNum</span> = <span class="i">$DataColNums</span>[<span class="i">$ColIndex</span>]<span class="sc">;</span> + 284 <span class="i">$ColValue</span> = <span class="i">$LineWords</span>[<span class="i">$ColNum</span> - <span class="n">1</span>]<span class="sc">;</span> + 285 + 286 <span class="k">if</span> <span class="s">(</span><span class="i">$UniqueDataKeyMode</span><span class="s">)</span> <span class="s">{</span> + 287 <span class="i">$TextDataMapRef</span>->{<span class="i">$ColID</span>}{<span class="i">$DataKey</span>} = <span class="i">$ColValue</span><span class="sc">;</span> + 288 <span class="s">}</span> + 289 <span class="k">else</span> <span class="s">{</span> + 290 <span class="k">push</span> <span class="i">@</span>{<span class="i">$TextDataMapRef</span>->{<span class="i">$ColID</span>}{<span class="i">$DataKey</span>}}<span class="cm">,</span> <span class="i">$ColValue</span><span class="sc">;</span> + 291 <span class="s">}</span> + 292 <span class="s">}</span> + 293 + 294 <span class="s">}</span> + 295 + 296 <span class="k">print</span> <span class="q">"\nTotal number of lines in file $TextDataFile: $LineCount\n"</span><span class="sc">;</span> + 297 <span class="k">print</span> <span class="q">"Total number of lines ignored: $IgnoredLineCount\n"</span><span class="sc">;</span> + 298 + 299 <span class="k">close</span> <span class="w">TEXTDATAFILE</span><span class="sc">;</span> + 300 <span class="s">}</span> + 301 + 302 <span class="c"># Returns a 32 bit integer hash code using One-at-a-time algorithm By Bob Jenkins [Ref 38]. It's also implemented in</span> + 303 <span class="c"># Perl for internal hash keys in hv.h include file.</span> + 304 <span class="c">#</span> + 305 <span class="c"># It's not clear how to force Perl perform unsigned integer arithmetic irrespective of the OS/Platform and</span> + 306 <span class="c"># the value of use64bitint flag used during its compilation.</span> + 307 <span class="c">#</span> + 308 <span class="c"># In order to generate a consistent 32 bit has code across OS/platforms, the following methodology appear</span> + 309 <span class="c"># to work:</span> + 310 <span class="c">#</span> + 311 <span class="c"># o Use MaxHashCodeMask to retrieve appropriate bits after left shifting by bit operators and additions</span> + 312 <span class="c"># o Stay away from "use integer" to avoid signed integer arithmetic for bit operators</span> + 313 <span class="c">#</span> + 314 <span class="c">#</span> + 315 <span class="c"># MaxHashCodeMask (2147483647) corresponds to the maximum value which can be stored in 31 bits</span> + 316 <span class="c">#</span> + 317 <span class="k">my</span><span class="s">(</span><span class="i">$MaxHashCodeMask</span><span class="s">)</span><span class="sc">;</span> + 318 <span class="i">$MaxHashCodeMask</span> = <span class="n">2</span>**<span class="n">31</span> - <span class="n">1</span><span class="sc">;</span> + 319 +<a name="HashCode-"></a> 320 <span class="k">sub </span><span class="m">HashCode</span> <span class="s">{</span> + 321 <span class="k">my</span><span class="s">(</span><span class="i">$String</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 322 <span class="k">my</span><span class="s">(</span><span class="i">$HashCode</span><span class="cm">,</span> <span class="i">$Value</span><span class="cm">,</span> <span class="i">$ShiftedHashCode</span><span class="s">)</span><span class="sc">;</span> + 323 + 324 <span class="i">$HashCode</span> = <span class="n">0</span><span class="sc">;</span> + 325 <span class="k">for</span> <span class="i">$Value</span> <span class="s">(</span><span class="k">unpack</span><span class="s">(</span><span class="q">'C*'</span><span class="cm">,</span> <span class="i">$String</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 326 <span class="i">$HashCode</span> += <span class="i">$Value</span><span class="sc">;</span> + 327 + 328 <span class="i">$ShiftedHashCode</span> = <span class="i">$HashCode</span> << <span class="n">10</span><span class="sc">;</span> + 329 <span class="k">if</span> <span class="s">(</span><span class="i">$ShiftedHashCode</span> > <span class="i">$MaxHashCodeMask</span><span class="s">)</span> <span class="s">{</span> + 330 <span class="i">$ShiftedHashCode</span> = <span class="i">$ShiftedHashCode</span> & <span class="i">$MaxHashCodeMask</span><span class="sc">;</span> + 331 <span class="s">}</span> + 332 + 333 <span class="i">$HashCode</span> += <span class="i">$ShiftedHashCode</span><span class="sc">;</span> + 334 <span class="k">if</span> <span class="s">(</span><span class="i">$HashCode</span> > <span class="i">$MaxHashCodeMask</span><span class="s">)</span> <span class="s">{</span> + 335 <span class="i">$HashCode</span> = <span class="i">$HashCode</span> & <span class="i">$MaxHashCodeMask</span><span class="sc">;</span> + 336 <span class="s">}</span> + 337 + 338 <span class="i">$HashCode</span> ^= <span class="s">(</span><span class="i">$HashCode</span> >> <span class="n">6</span><span class="s">)</span><span class="sc">;</span> + 339 <span class="s">}</span> + 340 + 341 <span class="i">$ShiftedHashCode</span> = <span class="i">$HashCode</span> << <span class="n">3</span><span class="sc">;</span> + 342 <span class="k">if</span> <span class="s">(</span><span class="i">$ShiftedHashCode</span> > <span class="i">$MaxHashCodeMask</span><span class="s">)</span> <span class="s">{</span> + 343 <span class="i">$ShiftedHashCode</span> = <span class="i">$ShiftedHashCode</span> & <span class="i">$MaxHashCodeMask</span><span class="sc">;</span> + 344 <span class="s">}</span> + 345 + 346 <span class="i">$HashCode</span> += <span class="i">$ShiftedHashCode</span><span class="sc">;</span> + 347 <span class="k">if</span> <span class="s">(</span><span class="i">$HashCode</span> > <span class="i">$MaxHashCodeMask</span><span class="s">)</span> <span class="s">{</span> + 348 <span class="i">$HashCode</span> = <span class="i">$HashCode</span> & <span class="i">$MaxHashCodeMask</span><span class="sc">;</span> + 349 <span class="s">}</span> + 350 <span class="i">$HashCode</span> ^= <span class="s">(</span><span class="i">$HashCode</span> >> <span class="n">11</span><span class="s">)</span><span class="sc">;</span> + 351 + 352 <span class="i">$ShiftedHashCode</span> = <span class="i">$HashCode</span> << <span class="n">15</span><span class="sc">;</span> + 353 <span class="k">if</span> <span class="s">(</span><span class="i">$ShiftedHashCode</span> > <span class="i">$MaxHashCodeMask</span><span class="s">)</span> <span class="s">{</span> + 354 <span class="i">$ShiftedHashCode</span> = <span class="i">$ShiftedHashCode</span> & <span class="i">$MaxHashCodeMask</span><span class="sc">;</span> + 355 <span class="s">}</span> + 356 + 357 <span class="i">$HashCode</span> += <span class="i">$ShiftedHashCode</span><span class="sc">;</span> + 358 <span class="k">if</span> <span class="s">(</span><span class="i">$HashCode</span> > <span class="i">$MaxHashCodeMask</span><span class="s">)</span> <span class="s">{</span> + 359 <span class="i">$HashCode</span> = <span class="i">$HashCode</span> & <span class="i">$MaxHashCodeMask</span><span class="sc">;</span> + 360 <span class="s">}</span> + 361 <span class="k">return</span> <span class="i">$HashCode</span><span class="sc">;</span> + 362 <span class="s">}</span> + 363 + 364 <span class="c"># Check out the string: Is it defined and has a non zero length?</span> +<a name="IsEmpty-"></a> 365 <span class="k">sub </span><span class="m">IsEmpty</span> <span class="s">{</span> + 366 <span class="k">my</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 367 <span class="k">my</span><span class="s">(</span><span class="i">$Status</span><span class="s">)</span> = <span class="n">1</span><span class="sc">;</span> + 368 + 369 <span class="i">$Status</span> = <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> && <span class="k">length</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span><span class="s">)</span> ? <span class="n">0</span> <span class="co">:</span> <span class="n">1</span><span class="sc">;</span> + 370 + 371 <span class="k">return</span> <span class="i">$Status</span><span class="sc">;</span> + 372 <span class="s">}</span> + 373 + 374 <span class="c"># Is first specified number power of second specified number...</span> +<a name="IsNumberPowerOfNumber-"></a> 375 <span class="k">sub </span><span class="m">IsNumberPowerOfNumber</span> <span class="s">{</span> + 376 <span class="k">my</span><span class="s">(</span><span class="i">$FirstNum</span><span class="cm">,</span> <span class="i">$SecondNum</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 377 <span class="k">my</span><span class="s">(</span><span class="i">$PowerValue</span><span class="s">)</span><span class="sc">;</span> + 378 + 379 <span class="i">$PowerValue</span> = <span class="k">log</span><span class="s">(</span><span class="i">$FirstNum</span><span class="s">)</span>/<span class="k">log</span><span class="s">(</span><span class="i">$SecondNum</span><span class="s">)</span><span class="sc">;</span> + 380 + 381 <span class="k">return</span> <span class="i">IsInteger</span><span class="s">(</span><span class="i">$PowerValue</span><span class="s">)</span> ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span> + 382 <span class="s">}</span> + 383 + 384 <span class="c"># Check out the string: Is it an integer?</span> +<a name="IsInteger-"></a> 385 <span class="k">sub </span><span class="m">IsInteger</span> <span class="s">{</span> + 386 <span class="k">my</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 387 <span class="k">my</span><span class="s">(</span><span class="i">$Status</span><span class="s">)</span> = <span class="n">0</span><span class="sc">;</span> + 388 + 389 <span class="k">if</span> <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> && <span class="k">length</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 390 <span class="i">$TheString</span> = <span class="i">RemoveLeadingAndTrailingWhiteSpaces</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span><span class="sc">;</span> + 391 <span class="i">$TheString</span> =~ <span class="q">s/^[+-]//</span><span class="sc">;</span> + 392 <span class="i">$Status</span> = <span class="s">(</span><span class="i">$TheString</span> =~ <span class="q">/[^0-9]/</span><span class="s">)</span> ? <span class="n">0</span> <span class="co">:</span> <span class="n">1</span><span class="sc">;</span> + 393 <span class="s">}</span> + 394 <span class="k">return</span> <span class="i">$Status</span><span class="sc">;</span> + 395 <span class="s">}</span> + 396 + 397 <span class="c"># Check out the string: Is it an integer with value > 0?</span> +<a name="IsPositiveInteger-"></a> 398 <span class="k">sub </span><span class="m">IsPositiveInteger</span> <span class="s">{</span> + 399 <span class="k">my</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 400 <span class="k">my</span><span class="s">(</span><span class="i">$Status</span><span class="s">)</span> = <span class="n">0</span><span class="sc">;</span> + 401 + 402 <span class="i">$Status</span> = <span class="i">IsInteger</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> ? <span class="s">(</span><span class="i">$TheString</span> > <span class="n">0</span> ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="s">)</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span> + 403 + 404 <span class="k">return</span> <span class="i">$Status</span><span class="sc">;</span> + 405 <span class="s">}</span> + 406 + 407 + 408 <span class="c"># Check out the string: Is it a float?</span> +<a name="IsFloat-"></a> 409 <span class="k">sub </span><span class="m">IsFloat</span> <span class="s">{</span> + 410 <span class="k">my</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 411 <span class="k">my</span><span class="s">(</span><span class="i">$Status</span><span class="s">)</span> = <span class="n">0</span><span class="sc">;</span> + 412 + 413 <span class="k">if</span> <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> && <span class="k">length</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 414 <span class="i">$TheString</span> = <span class="i">RemoveLeadingAndTrailingWhiteSpaces</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span><span class="sc">;</span> + 415 <span class="i">$TheString</span> =~ <span class="q">s/^[+-]//</span><span class="sc">;</span> + 416 <span class="i">$Status</span> = <span class="s">(</span><span class="i">$TheString</span> =~ <span class="q">/[^0-9.eE]/</span><span class="s">)</span> ? <span class="n">0</span> <span class="co">:</span> <span class="s">(</span><span class="s">(</span><span class="s">(</span><span class="k">length</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> == <span class="n">1</span><span class="s">)</span> && <span class="s">(</span><span class="i">$TheString</span> =~ <span class="q">/[.eE]/</span><span class="s">)</span><span class="s">)</span> ? <span class="n">0</span> <span class="co">:</span> <span class="n">1</span><span class="s">)</span><span class="sc">;</span> + 417 <span class="s">}</span> + 418 <span class="k">return</span> <span class="i">$Status</span><span class="sc">;</span> + 419 <span class="s">}</span> + 420 + 421 <span class="c"># Check out the string: Is it defined and has a non zero length?</span> +<a name="IsNotEmpty-"></a> 422 <span class="k">sub </span><span class="m">IsNotEmpty</span> <span class="s">{</span> + 423 <span class="k">my</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 424 <span class="k">my</span><span class="s">(</span><span class="i">$Status</span><span class="s">)</span><span class="sc">;</span> + 425 + 426 <span class="i">$Status</span> = <span class="i">IsEmpty</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> ? <span class="n">0</span> <span class="co">:</span> <span class="n">1</span><span class="sc">;</span> + 427 + 428 <span class="k">return</span> <span class="i">$Status</span><span class="sc">;</span> + 429 <span class="s">}</span> + 430 + 431 <span class="c"># Check out the string: Does it only contain numerical data?</span> +<a name="IsNumerical-"></a> 432 <span class="k">sub </span><span class="m">IsNumerical</span> <span class="s">{</span> + 433 <span class="k">my</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 434 <span class="k">my</span><span class="s">(</span><span class="i">$Status</span><span class="s">)</span> = <span class="n">0</span><span class="sc">;</span> + 435 + 436 <span class="k">if</span> <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> && <span class="k">length</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 437 <span class="i">$TheString</span> = <span class="i">RemoveLeadingAndTrailingWhiteSpaces</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span><span class="sc">;</span> + 438 <span class="i">$TheString</span> =~ <span class="q">s/^[+-]//</span><span class="sc">;</span> + 439 <span class="i">$Status</span> = <span class="s">(</span><span class="i">$TheString</span> =~ <span class="q">/[^0-9.eE]/</span><span class="s">)</span> ? <span class="n">0</span> <span class="co">:</span> <span class="s">(</span><span class="s">(</span><span class="s">(</span><span class="k">length</span><span class="s">(</span><span class="i">$TheString</span><span class="s">)</span> == <span class="n">1</span><span class="s">)</span> && <span class="s">(</span><span class="i">$TheString</span> =~ <span class="q">/[.eE]/</span><span class="s">)</span><span class="s">)</span> ? <span class="n">0</span> <span class="co">:</span> <span class="n">1</span><span class="s">)</span><span class="sc">;</span> + 440 <span class="s">}</span> + 441 <span class="k">return</span> <span class="i">$Status</span><span class="sc">;</span> + 442 <span class="s">}</span> + 443 + 444 <span class="c"># Join different words using delimiter and quote parameters. And return as</span> + 445 <span class="c"># a string value.</span> +<a name="JoinWords-"></a> 446 <span class="k">sub </span><span class="m">JoinWords</span> <span class="s">{</span> + 447 <span class="k">my</span><span class="s">(</span><span class="i">$Words</span><span class="cm">,</span> <span class="i">$Delim</span><span class="cm">,</span> <span class="i">$Quote</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 448 + 449 <span class="k">if</span> <span class="s">(</span>!<span class="i">@$Words</span><span class="s">)</span> <span class="s">{</span> + 450 <span class="k">return</span> <span class="q">""</span><span class="sc">;</span> + 451 <span class="s">}</span> + 452 + 453 <span class="i">$Quote</span> = <span class="i">$Quote</span> ? <span class="q">"\""</span> <span class="co">:</span> <span class="q">""</span><span class="sc">;</span> + 454 <span class="k">my</span><span class="s">(</span><span class="i">@NewWords</span><span class="s">)</span> = <span class="k">map</span> <span class="s">{</span> <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$_</span><span class="s">)</span> && <span class="k">length</span><span class="s">(</span><span class="i">$_</span><span class="s">)</span><span class="s">)</span> ? <span class="q">"${Quote}$_${Quote}"</span> <span class="co">:</span> <span class="q">"${Quote}${Quote}"</span> <span class="s">}</span> <span class="i">@$Words</span><span class="sc">;</span> + 455 + 456 <span class="k">return</span> <span class="k">join</span> <span class="i">$Delim</span><span class="cm">,</span> <span class="i">@NewWords</span><span class="sc">;</span> + 457 <span class="s">}</span> + 458 + 459 <span class="c"># Split string value containing quoted or unquoted words in to an array containing</span> + 460 <span class="c"># unquoted words.</span> + 461 <span class="c">#</span> + 462 <span class="c"># This function is used to split strings generated by JoinWords.</span> + 463 <span class="c">#</span> +<a name="SplitWords-"></a> 464 <span class="k">sub </span><span class="m">SplitWords</span> <span class="s">{</span> + 465 <span class="k">my</span><span class="s">(</span><span class="i">$Line</span><span class="cm">,</span> <span class="i">$Delim</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 466 + 467 <span class="k">if</span> <span class="s">(</span>!<span class="i">$Line</span><span class="s">)</span> <span class="s">{</span> + 468 <span class="k">return</span> <span class="s">(</span><span class="s">)</span><span class="sc">;</span> + 469 <span class="s">}</span> + 470 + 471 <span class="c"># Is it a quoted string?</span> + 472 <span class="k">if</span> <span class="s">(</span><span class="i">$Line</span> =~ <span class="q">/^\"/</span><span class="s">)</span> <span class="s">{</span> + 473 <span class="c"># Take out first and last quote...</span> + 474 <span class="i">$Line</span> =~ <span class="q">s/^\"//</span><span class="sc">;</span> <span class="i">$Line</span> =~ <span class="q">s/\"$//</span><span class="sc">;</span> + 475 + 476 <span class="i">$Delim</span> = <span class="q">"\"$Delim\""</span><span class="sc">;</span> + 477 <span class="s">}</span> + 478 <span class="k">return</span> <span class="k">split</span> <span class="q">/$Delim/</span><span class="cm">,</span> <span class="i">$Line</span><span class="sc">;</span> + 479 <span class="s">}</span> + 480 + 481 <span class="c"># Based on quote parameter, figure out what to do</span> +<a name="QuoteAWord-"></a> 482 <span class="k">sub </span><span class="m">QuoteAWord</span> <span class="s">{</span> + 483 <span class="k">my</span><span class="s">(</span><span class="i">$Word</span><span class="cm">,</span> <span class="i">$Quote</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 484 <span class="k">my</span><span class="s">(</span><span class="i">$QuotedWord</span><span class="s">)</span><span class="sc">;</span> + 485 + 486 <span class="i">$QuotedWord</span> = <span class="q">""</span><span class="sc">;</span> + 487 <span class="k">if</span> <span class="s">(</span><span class="i">$Word</span><span class="s">)</span> <span class="s">{</span> + 488 <span class="i">$QuotedWord</span> = <span class="i">$Word</span><span class="sc">;</span> + 489 <span class="s">}</span> + 490 <span class="k">if</span> <span class="s">(</span><span class="i">$Quote</span><span class="s">)</span> <span class="s">{</span> + 491 <span class="i">$QuotedWord</span> = <span class="q">"\"$QuotedWord\""</span><span class="sc">;</span> + 492 <span class="s">}</span> + 493 <span class="k">return</span> <span class="s">(</span><span class="i">$QuotedWord</span><span class="s">)</span><span class="sc">;</span> + 494 <span class="s">}</span> + 495 + 496 <span class="c"># Remove leading white space characters from the string...</span> +<a name="RemoveLeadingWhiteSpaces-"></a> 497 <span class="k">sub </span><span class="m">RemoveLeadingWhiteSpaces</span> <span class="s">{</span> + 498 <span class="k">my</span><span class="s">(</span><span class="i">$InString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 499 <span class="k">my</span><span class="s">(</span><span class="i">$OutString</span><span class="cm">,</span> <span class="i">$TrailingString</span><span class="cm">,</span> <span class="i">$LeadingWhiteSpace</span><span class="s">)</span><span class="sc">;</span> + 500 + 501 <span class="i">$OutString</span> = <span class="i">$InString</span><span class="sc">;</span> + 502 <span class="k">if</span> <span class="s">(</span><span class="k">length</span><span class="s">(</span><span class="i">$InString</span><span class="s">)</span> && <span class="i">ContainsWhiteSpaces</span><span class="s">(</span><span class="i">$InString</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 503 <span class="i">$OutString</span> =~ <span class="q">s/^([ \t\r\n\f]*)(.*?)$/$2/</span><span class="sc">;</span> + 504 <span class="s">}</span> + 505 <span class="k">return</span> <span class="i">$OutString</span><span class="sc">;</span> + 506 <span class="s">}</span> + 507 + 508 <span class="c"># Remove Trailing white space characters from the string...</span> +<a name="RemoveTrailingWhiteSpaces-"></a> 509 <span class="k">sub </span><span class="m">RemoveTrailingWhiteSpaces</span> <span class="s">{</span> + 510 <span class="k">my</span><span class="s">(</span><span class="i">$InString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 511 <span class="k">my</span><span class="s">(</span><span class="i">$OutString</span><span class="cm">,</span> <span class="i">$LeadingString</span><span class="cm">,</span> <span class="i">$TrailingWhiteSpace</span><span class="s">)</span><span class="sc">;</span> + 512 + 513 <span class="i">$OutString</span> = <span class="i">$InString</span><span class="sc">;</span> + 514 <span class="k">if</span> <span class="s">(</span><span class="k">length</span><span class="s">(</span><span class="i">$InString</span><span class="s">)</span> && <span class="i">ContainsWhiteSpaces</span><span class="s">(</span><span class="i">$InString</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 515 <span class="i">$OutString</span> =~ <span class="q">s/^(.*?)([ \t\r\n\f]*)$/$1/</span><span class="sc">;</span> + 516 <span class="s">}</span> + 517 <span class="k">return</span> <span class="i">$OutString</span><span class="sc">;</span> + 518 <span class="s">}</span> + 519 + 520 <span class="c"># Remove both leading and trailing white space characters from the string...</span> +<a name="RemoveLeadingAndTrailingWhiteSpaces-"></a> 521 <span class="k">sub </span><span class="m">RemoveLeadingAndTrailingWhiteSpaces</span> <span class="s">{</span> + 522 <span class="k">my</span><span class="s">(</span><span class="i">$InString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 523 <span class="k">my</span><span class="s">(</span><span class="i">$OutString</span><span class="s">)</span><span class="sc">;</span> + 524 + 525 <span class="i">$OutString</span> = <span class="i">$InString</span><span class="sc">;</span> + 526 <span class="k">if</span> <span class="s">(</span><span class="k">length</span><span class="s">(</span><span class="i">$InString</span><span class="s">)</span> && <span class="i">ContainsWhiteSpaces</span><span class="s">(</span><span class="i">$InString</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 527 <span class="i">$OutString</span> =~ <span class="q">s/^([ \t\r\n\f]*)(.*?)([ \t\r\n\f]*)$/$2/</span><span class="sc">;</span> + 528 <span class="s">}</span> + 529 <span class="k">return</span> <span class="i">$OutString</span><span class="sc">;</span> + 530 <span class="s">}</span> + 531 + 532 <span class="c"># Wrap text string...</span> +<a name="WrapText-"></a> 533 <span class="k">sub </span><span class="m">WrapText</span> <span class="s">{</span> + 534 <span class="k">my</span><span class="s">(</span><span class="i">$InString</span><span class="cm">,</span> <span class="i">$WrapLength</span><span class="cm">,</span> <span class="i">$WrapDelimiter</span><span class="s">)</span><span class="sc">;</span> + 535 <span class="k">my</span><span class="s">(</span><span class="i">$OutString</span><span class="s">)</span><span class="sc">;</span> + 536 + 537 <span class="i">$WrapLength</span> = <span class="n">40</span><span class="sc">;</span> + 538 <span class="i">$WrapDelimiter</span> = <span class="q">"\n"</span><span class="sc">;</span> + 539 <span class="k">if</span> <span class="s">(</span><span class="i">@_</span> == <span class="n">3</span><span class="s">)</span> <span class="s">{</span> + 540 <span class="s">(</span><span class="i">$InString</span><span class="cm">,</span> <span class="i">$WrapLength</span><span class="cm">,</span> <span class="i">$WrapDelimiter</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 541 <span class="s">}</span> + 542 <span class="k">elsif</span> <span class="s">(</span><span class="i">@_</span> == <span class="n">2</span><span class="s">)</span> <span class="s">{</span> + 543 <span class="s">(</span><span class="i">$InString</span><span class="cm">,</span> <span class="i">$WrapLength</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 544 <span class="s">}</span> + 545 <span class="k">else</span> <span class="s">{</span> + 546 <span class="s">(</span><span class="i">$InString</span><span class="cm">,</span> <span class="i">$WrapLength</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> + 547 <span class="s">}</span> + 548 <span class="i">$OutString</span> = <span class="i">$InString</span><span class="sc">;</span> + 549 <span class="k">if</span> <span class="s">(</span><span class="i">$InString</span> && <span class="s">(</span><span class="k">length</span><span class="s">(</span><span class="i">$InString</span><span class="s">)</span> > <span class="i">$WrapLength</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> + 550 <span class="i">$OutString</span> = <span class="q">""</span><span class="sc">;</span> + 551 <span class="k">my</span><span class="s">(</span><span class="i">$Index</span><span class="cm">,</span> <span class="i">$Length</span><span class="cm">,</span> <span class="i">$FirstPiece</span><span class="cm">,</span> <span class="i">$StringPiece</span><span class="s">)</span><span class="sc">;</span> + 552 <span class="i">$Index</span> = <span class="n">0</span><span class="sc">;</span> <span class="i">$Length</span> = <span class="k">length</span><span class="s">(</span><span class="i">$InString</span><span class="s">)</span><span class="sc">;</span> + 553 <span class="i">$FirstPiece</span> = <span class="n">1</span><span class="sc">;</span> + 554 <span class="k">for</span> <span class="s">(</span><span class="i">$Index</span> = <span class="n">0</span><span class="sc">;</span> <span class="i">$Index</span> < <span class="i">$Length</span><span class="sc">;</span> <span class="i">$Index</span> += <span class="i">$WrapLength</span><span class="s">)</span> <span class="s">{</span> + 555 <span class="k">if</span> <span class="s">(</span><span class="s">(</span><span class="i">$Index</span> + <span class="i">$WrapLength</span><span class="s">)</span> < <span class="i">$Length</span><span class="s">)</span> <span class="s">{</span> + 556 <span class="i">$StringPiece</span> = <span class="k">substr</span><span class="s">(</span><span class="i">$InString</span><span class="cm">,</span> <span class="i">$Index</span><span class="cm">,</span> <span class="i">$WrapLength</span><span class="s">)</span><span class="sc">;</span> + 557 <span class="s">}</span> + 558 <span class="k">else</span> <span class="s">{</span> + 559 <span class="c"># Last piece of the string...</span> + 560 <span class="i">$StringPiece</span> = <span class="k">substr</span><span class="s">(</span><span class="i">$InString</span><span class="cm">,</span> <span class="i">$Index</span><span class="cm">,</span> <span class="i">$WrapLength</span><span class="s">)</span><span class="sc">;</span> + 561 <span class="s">}</span> + 562 <span class="k">if</span> <span class="s">(</span><span class="i">$FirstPiece</span><span class="s">)</span> <span class="s">{</span> + 563 <span class="i">$FirstPiece</span> = <span class="n">0</span><span class="sc">;</span> + 564 <span class="i">$OutString</span> = <span class="i">$StringPiece</span><span class="sc">;</span> + 565 <span class="s">}</span> + 566 <span class="k">else</span> <span class="s">{</span> + 567 <span class="i">$OutString</span> .= <span class="q">"${WrapDelimiter}${StringPiece}"</span><span class="sc">;</span> + 568 <span class="s">}</span> + 569 <span class="s">}</span> + 570 <span class="s">}</span> + 571 <span class="k">return</span> <span class="i">$OutString</span><span class="sc">;</span> + 572 <span class="s">}</span> + 573 +<a name="EOF-"></a></pre> +<p> </p> +<br /> +<center> +<img src="../../../images/h2o2.png"> +</center> +</body> +</html>