annotate mayachemtools/docs/modules/html/TextUtil.html @ 0:73ae111cf86f draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 11:55:01 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 <html>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 <head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 <title>MayaChemTools:Documentation:TextUtil.pm</title>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 </head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 <div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./StatisticsUtil.html" title="StatisticsUtil.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./TimeUtil.html" title="TimeUtil.html">Next</a></td><td width="34%" align="middle"><strong>TextUtil.pm</strong></td><td width="33%" align="right"><a href="././code/TextUtil.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/TextUtil.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/TextUtil.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/TextUtil.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/TextUtil.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 <h2>NAME</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 <p>TextUtil</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 <h2>SYNOPSIS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 <p>use TextUtil;</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 <p>use TextUtil qw(:all);</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 <h2>DESCRIPTION</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 <p><strong>TextUtil</strong> module provides the following functions:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 <p> <a href="#addnumbersuffix">AddNumberSuffix</a>, <a href="#containswhitespaces">ContainsWhiteSpaces</a>, <a href="#gettextfiledatabynonuniquekey">GetTextFileDataByNonUniqueKey</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 , <a href="#gettextfiledatabyuniquekey">GetTextFileDataByUniqueKey</a>, <a href="#gettextline">GetTextLine</a>, <a href="#hashcode">HashCode</a>, <a href="#isempty">IsEmpty</a>, <a href="#isfloat">IsFloat</a>, <a href="#isinteger">IsInteger</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 , <a href="#isnotempty">IsNotEmpty</a>, <a href="#isnumberpowerofnumber">IsNumberPowerOfNumber</a>, <a href="#isnumerical">IsNumerical</a>, <a href="#ispositiveinteger">IsPositiveInteger</a>, <a href="#joinwords">JoinWords</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 , <a href="#quoteaword">QuoteAWord</a>, <a href="#removeleadingandtrailingwhitespaces">RemoveLeadingAndTrailingWhiteSpaces</a>, <a href="#removeleadingwhitespaces">RemoveLeadingWhiteSpaces</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 , <a href="#removetrailingwhitespaces">RemoveTrailingWhiteSpaces</a>, <a href="#splitwords">SplitWords</a>, <a href="#wraptext">WrapText</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 </p><p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 <h2>FUNCTIONS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 <dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 <dt><strong><a name="addnumbersuffix" class="item"><strong>AddNumberSuffix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 $NumberWithSuffix = AddNumberSuffix($IntegerValue);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 <p>Returns number with appropriate suffix: 0, 1st, 2nd, 3rd, 4th, and so on.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 <dt><strong><a name="containswhitespaces" class="item"><strong>ContainsWhiteSpaces</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 $Status = ContainsWhiteSpaces($TheString);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 <p>Returns 1 or 0 based on whether the string contains any white spaces.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 <dt><strong><a name="gettextline" class="item"><strong>GetTextLine</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 $Line = GetTextLine(\*TEXTFILE);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 <p>Reads next line from an already opened text file, takes out any carriage return,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 and returns it as a string. NULL is returned for EOF.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 <dt><strong><a name="gettextfiledatabynonuniquekey" class="item"><strong>GetTextFileDataByNonUniqueKey</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 GetTextFileDataByNonUniqueKey($TextDataFile, $TextDataMapRef,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 $DataKeyColNum, $InDelim);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 <p>Load data from a text file into the specified hash reference using a specific
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 column for non-unique data key values.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 <p>The lines starting with # are treated as comments and ignored. First line
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 not starting with # must contain column labels and the number of columns in
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 all other data rows must match the number of column labels.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 <p>The first column is assumed to contain data key value by default; all other columns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 contain data as indicated in their column labels.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 <p>In order to avoid dependence of data access on the specified column labels, the
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 column data is loaded into hash with Column&lt;Num&gt; hash keys, where column number
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 start from 1. The data key column is not available as Colnum&lt;Num&gt; hash key;</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 <p>The format of the data structure loaded into a specified hash reference is:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 @{$TextDataMapRef-&gt;{DataKeys}} - Array of unique data keys
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 <br/> @{$TextDataMapRef-&gt;{ColLabels}} - Array of column labels
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 <br/> @{$TextDataMapRef-&gt;{DataColIDs}} - Array of data column IDs
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 <br/> $TextDataMapRef-&gt;{NumOfCols} - Number of columns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 <br/> %{$TextDataMapRef-&gt;{DataKey}} - Hash keys pair: &lt;DataKey, DataKey&gt;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 <br/> @{$TextDataMapRef-&gt;{DataCol&lt;Num&gt;}} - Hash keys pair with data as an array:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 &lt;DataCol&lt;Num&gt;, DataKey&gt;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 <dt><strong><a name="gettextfiledatabyuniquekey" class="item"><strong>GetTextFileDataByUniqueKey</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 GetTextFileDataByUniqueKey($TextDataFile, $TextDataMapRef, $DataKeyColNum,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 $InDelim);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 <p>Load data from a text file into the specified hash reference using a a specific
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 column for unique data key values.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 <p>The lines starting with # are treated as comments and ignored. First line
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 not starting with # must contain column labels and the number of columns in
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 all other data rows must match the number of column labels.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 <p>The first column is assumed to contain data key value by default; all other columns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 contain data as indicated in their column labels.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 <p>In order to avoid dependence of data access on the specified column labels, the
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 column data is loaded into hash with Column&lt;Num&gt; hash keys, where column number
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 start from 1. The data key column is not available as Colnum&lt;Num&gt; hash key;</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 <p>The format of the data structure loaded into a specified hash reference is:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 @{$TextDataMapRef-&gt;{DataKeys}} - Array of unique data keys
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 <br/> @{$TextDataMapRef-&gt;{ColLabels}} - Array of column labels
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 <br/> @{$TextDataMapRef-&gt;{DataColIDs}} - Array of data column IDs
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 <br/> $TextDataMapRef-&gt;{NumOfCols} - Number of columns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 <br/> %{$TextDataMapRef-&gt;{DataKey}} - Hash keys pair: &lt;DataKey, DataKey&gt;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 <br/> %{$TextDataMapRef-&gt;{DataCol&lt;Num&gt;}} - Hash keys pair: &lt;DataCol&lt;Num&gt;, DataKey&gt;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 <dt><strong><a name="hashcode" class="item"><strong>HashCode</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 $HashCode = HashCode($TheString);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 <p>Returns a 32 bit integer hash code using One-at-a-time algorithm By Bob Jenkins [Ref 38].
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 It's also implemented in Perl for internal hash keys in hv.h include file.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 <dt><strong><a name="isempty" class="item"><strong>IsEmpty</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 $Status = IsEmpty($TheString);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 <p>Returns 1 or 0 based on whether the string is empty.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 <dt><strong><a name="isinteger" class="item"><strong>IsInteger</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 $Status = IsInteger($TheString);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 <p>Returns 1 or 0 based on whether the string is a positive integer.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 <dt><strong><a name="ispositiveinteger" class="item"><strong>IsPositiveInteger</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 $Status = IsPositiveInteger($TheString);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 <p>Returns 1 or 0 based on whether the string is an integer.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 <dt><strong><a name="isfloat" class="item"><strong>IsFloat</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 $Status = IsFloat($TheString);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 <p>Returns 1 or 0 based on whether the string is a float.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 <dt><strong><a name="isnotempty" class="item"><strong>IsNotEmpty</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 $Status = IsNotEmpty($TheString);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 <p>Returns 0 or 1 based on whether the string is empty.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 <dt><strong><a name="isnumerical" class="item"><strong>IsNumerical</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 $Status = IsNumerical($TheString);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149 <p>Returns 1 or 0 based on whether the string is a number.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 <dt><strong><a name="isnumberpowerofnumber" class="item"><strong>IsNumberPowerOfNumber</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154 $Status = IsNumberPowerOfNumber($FirstNum, $SecondNum);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
155 <p>Returns 1 or 0 based on whether the first number is a power of second number.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
156 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
157 <dt><strong><a name="joinwords" class="item"><strong>JoinWords</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
158 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
159 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
160 $JoinedWords = JoinWords($Words, $Delim, $Quote);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
161 <p>Joins different words using delimiter and quote parameters, and returns it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
162 as a string.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
163 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
164 <dt><strong><a name="quoteaword" class="item"><strong>QuoteAWord</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
165 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
166 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
167 $QuotedWord = QuoteAWord($Word, $Quote);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
168 <p>Returns a quoted string based on <em>Quote</em> value.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
169 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
170 <dt><strong><a name="removeleadingwhitespaces" class="item"><strong>RemoveLeadingWhiteSpaces</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
171 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
172 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
173 $OutString = RemoveLeadingWhiteSpaces($InString);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
174 <p>Returns a string without any leading and traling white spaces.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
175 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
176 <dt><strong><a name="removetrailingwhitespaces" class="item"><strong>RemoveTrailingWhiteSpaces</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
177 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
178 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
179 $OutString = RemoveTrailingWhiteSpaces($InString);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
180 <p>Returns a string without any trailing white spaces.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
181 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
182 <dt><strong><a name="removeleadingandtrailingwhitespaces" class="item"><strong>RemoveLeadingAndTrailingWhiteSpaces</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
183 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
184 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
185 $OutString = RemoveLeadingAndTrailingWhiteSpaces($InString);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
186 <p>Returns a string without any leading and traling white spaces.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
187 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
188 <dt><strong><a name="splitwords" class="item"><strong>SplitWords</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
189 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
190 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
191 @Words = SplitWords($Line, $Delimiter);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
192 <p>Returns an array <em>Words</em> ontaining unquoted words generated after spliting
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
193 string value <em>Line</em> containing quoted or unquoted words.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
194 <p>This function is used to split strings generated by JoinWords as replacement
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
195 for Perl's core module funtion Text::ParseWords::quotewords() which dumps core
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
196 on very long strings.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
197 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
198 <dt><strong><a name="wraptext" class="item"><strong>WrapText</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
199 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
200 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
201 $OutString = WrapText($InString, [$WrapLength, $WrapDelimiter]);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
202 <p>Returns a wrapped string. By default, <em>WrapLenght</em> is <em>40</em> and <em>WrapDelimiter</em>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
203 is Unix new line character.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
204 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
205 </dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
206 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
207 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
208 <h2>AUTHOR</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
209 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
210 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
211 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
212 <h2>SEE ALSO</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
213 <p><a href="./FileUtil.html">FileUtil.pm</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
214 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
215 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
216 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
217 <h2>COPYRIGHT</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
218 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
219 <p>This file is part of MayaChemTools.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
220 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
221 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
222 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
223 any later version.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
224 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
225 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
226 <tr align="left" valign="top"><td width="33%" align="left"><a href="./StatisticsUtil.html" title="StatisticsUtil.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./TimeUtil.html" title="TimeUtil.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>TextUtil.pm</strong></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
227 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
228 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
229 <br />
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
230 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
231 <img src="../../images/h2o2.png">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
232 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
233 </body>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
234 </html>