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