|
0
|
1 <html>
|
|
|
2 <head>
|
|
|
3 <title>MayaChemTools:Code:FileIO::FileIO.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-FileIO::FileIO-"></a> 1 <span class="k">package </span><span class="i">FileIO::FileIO</span><span class="sc">;</span>
|
|
|
15 2 <span class="c">#</span>
|
|
|
16 3 <span class="c"># $RCSfile: FileIO.pm,v $</span>
|
|
|
17 4 <span class="c"># $Date: 2015/02/28 20:48:43 $</span>
|
|
|
18 5 <span class="c"># $Revision: 1.27 $</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">Carp</span><span class="sc">;</span>
|
|
|
44 31 <span class="k">use</span> <span class="w">Exporter</span><span class="sc">;</span>
|
|
|
45 32 <span class="k">use</span> <span class="w">FileHandle</span><span class="sc">;</span>
|
|
|
46 33 <span class="k">use</span> <span class="w">ObjectProperty</span><span class="sc">;</span>
|
|
|
47 34
|
|
|
48 35 <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>
|
|
|
49 36
|
|
|
50 37 <span class="i">@ISA</span> = <span class="q">qw(ObjectProperty Exporter)</span><span class="sc">;</span>
|
|
|
51 38 <span class="i">@EXPORT</span> = <span class="q">qw()</span><span class="sc">;</span>
|
|
|
52 39 <span class="i">@EXPORT_OK</span> = <span class="q">qw()</span><span class="sc">;</span>
|
|
|
53 40
|
|
|
54 41 <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>
|
|
|
55 42
|
|
|
56 43 <span class="c"># Setup class variables...</span>
|
|
|
57 44 <span class="k">my</span><span class="s">(</span><span class="i">$ClassName</span><span class="s">)</span><span class="sc">;</span>
|
|
|
58 45 <span class="i">_InitializeClass</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
|
|
|
59 46
|
|
|
60 47 <span class="c"># Class constructor...</span>
|
|
|
61 <a name="new-"></a> 48 <span class="k">sub </span><span class="m">new</span> <span class="s">{</span>
|
|
|
62 49 <span class="k">my</span><span class="s">(</span><span class="i">$Class</span><span class="cm">,</span> <span class="i">%NamesAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
|
|
|
63 50
|
|
|
64 51 <span class="c"># Initialize object...</span>
|
|
|
65 52 <span class="k">my</span> <span class="i">$This</span> = <span class="s">{</span><span class="s">}</span><span class="sc">;</span>
|
|
|
66 53 <span class="k">bless</span> <span class="i">$This</span><span class="cm">,</span> <span class="k">ref</span><span class="s">(</span><span class="i">$Class</span><span class="s">)</span> || <span class="i">$Class</span><span class="sc">;</span>
|
|
|
67 54 <span class="i">$This</span><span class="i">->_InitializeFileIO</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
|
|
|
68 55
|
|
|
69 56 <span class="i">$This</span><span class="i">->_InitializeFileIOProperties</span><span class="s">(</span><span class="i">%NamesAndValues</span><span class="s">)</span><span class="sc">;</span>
|
|
|
70 57
|
|
|
71 58 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
|
|
|
72 59 <span class="s">}</span>
|
|
|
73 60
|
|
|
74 61 <span class="c"># Initialize object data...</span>
|
|
|
75 62 <span class="c">#</span>
|
|
|
76 <a name="_InitializeFileIO-"></a> 63 <span class="k">sub </span><span class="m">_InitializeFileIO</span> <span class="s">{</span>
|
|
|
77 64 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
|
|
|
78 65
|
|
|
79 66 <span class="c"># File name...</span>
|
|
|
80 67 <span class="i">$This</span>->{<span class="w">Name</span>} = <span class="q">''</span><span class="sc">;</span>
|
|
|
81 68
|
|
|
82 69 <span class="c"># Read, write or append...</span>
|
|
|
83 70 <span class="i">$This</span>->{<span class="w">Mode</span>} = <span class="q">'Read'</span><span class="sc">;</span>
|
|
|
84 71
|
|
|
85 72 <span class="c"># Open/close status...</span>
|
|
|
86 73 <span class="i">$This</span>->{<span class="w">Status</span>} = <span class="n">0</span><span class="sc">;</span>
|
|
|
87 74
|
|
|
88 75 <span class="c"># File handle returned by file open...</span>
|
|
|
89 76 <span class="i">$This</span>->{<span class="w">FileHandle</span>} = <span class="q">''</span><span class="sc">;</span>
|
|
|
90 77 <span class="s">}</span>
|
|
|
91 78
|
|
|
92 79 <span class="c"># Initialize class ...</span>
|
|
|
93 <a name="_InitializeClass-"></a> 80 <span class="k">sub </span><span class="m">_InitializeClass</span> <span class="s">{</span>
|
|
|
94 81 <span class="c">#Class name...</span>
|
|
|
95 82 <span class="i">$ClassName</span> = <span class="w">__PACKAGE__</span><span class="sc">;</span>
|
|
|
96 83
|
|
|
97 84 <span class="s">}</span>
|
|
|
98 85
|
|
|
99 86 <span class="c"># Initialize object properties....</span>
|
|
|
100 <a name="_InitializeFileIOProperties-"></a> 87 <span class="k">sub </span><span class="m">_InitializeFileIOProperties</span> <span class="s">{</span>
|
|
|
101 88 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">%NamesAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
|
|
|
102 89
|
|
|
103 90 <span class="k">my</span><span class="s">(</span><span class="i">$Name</span><span class="cm">,</span> <span class="i">$Value</span><span class="cm">,</span> <span class="i">$MethodName</span><span class="s">)</span><span class="sc">;</span>
|
|
|
104 91 <span class="k">while</span> <span class="s">(</span><span class="s">(</span><span class="i">$Name</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="k">each</span> <span class="i">%NamesAndValues</span><span class="s">)</span> <span class="s">{</span>
|
|
|
105 92 <span class="i">$MethodName</span> = <span class="q">"Set${Name}"</span><span class="sc">;</span>
|
|
|
106 93 <span class="i">$This</span><span class="i">->$MethodName</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
|
|
|
107 94 <span class="s">}</span>
|
|
|
108 95
|
|
|
109 96 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
|
|
|
110 97 <span class="s">}</span>
|
|
|
111 98
|
|
|
112 99 <span class="c"># Close any open file...</span>
|
|
|
113 <a name="DESTROY-"></a> 100 <span class="k">sub </span><span class="m">DESTROY</span> <span class="s">{</span>
|
|
|
114 101 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
|
|
|
115 102
|
|
|
116 103 <span class="i">$This</span><span class="i">->Close</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
|
|
|
117 104
|
|
|
118 105 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
|
|
|
119 106 <span class="s">}</span>
|
|
|
120 107
|
|
|
121 108 <span class="c"># Set file name and make sure it's not already set...</span>
|
|
|
122 109 <span class="c">#</span>
|
|
|
123 <a name="SetName-"></a> 110 <span class="k">sub </span><span class="m">SetName</span> <span class="s">{</span>
|
|
|
124 111 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Name</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
|
|
|
125 112
|
|
|
126 113 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">Name</span>}<span class="s">)</span> <span class="s">{</span>
|
|
|
127 114 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->SetName: Can't set file name to $Name: $This->{Name}..."</span><span class="sc">;</span>
|
|
|
128 115 <span class="s">}</span>
|
|
|
129 116
|
|
|
130 117 <span class="i">$This</span>->{<span class="w">Name</span>} = <span class="i">$Name</span><span class="sc">;</span>
|
|
|
131 118
|
|
|
132 119 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
|
|
|
133 120 <span class="s">}</span>
|
|
|
134 121
|
|
|
135 122 <span class="c"># Open file using specified mode...</span>
|
|
|
136 123 <span class="c">#</span>
|
|
|
137 <a name="Open-"></a> 124 <span class="k">sub </span><span class="m">Open</span> <span class="s">{</span>
|
|
|
138 125 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Mode</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
|
|
|
139 126
|
|
|
140 127 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">Status</span>}<span class="s">)</span> <span class="s">{</span>
|
|
|
141 128 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->Open: Can't open file $This->{Name}: It's already open..."</span><span class="sc">;</span>
|
|
|
142 129 <span class="s">}</span>
|
|
|
143 130
|
|
|
144 131 <span class="k">if</span> <span class="s">(</span><span class="k">defined</span> <span class="i">$Mode</span><span class="s">)</span> <span class="s">{</span>
|
|
|
145 132 <span class="c"># Set mode...</span>
|
|
|
146 133 <span class="i">$This</span><span class="i">->SetMode</span><span class="s">(</span><span class="i">$Mode</span><span class="s">)</span><span class="sc">;</span>
|
|
|
147 134 <span class="s">}</span>
|
|
|
148 135
|
|
|
149 136 <span class="c"># Get name and mode...</span>
|
|
|
150 137 <span class="k">my</span><span class="s">(</span><span class="i">$Name</span><span class="s">)</span><span class="sc">;</span>
|
|
|
151 138 <span class="i">$Name</span> = <span class="i">$This</span>->{<span class="w">Name</span>}<span class="sc">;</span>
|
|
|
152 139 <span class="i">$Mode</span> = <span class="i">$This</span><span class="i">->_GetOpenMode</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
|
|
|
153 140
|
|
|
154 141 <span class="c"># Open the file using specified mode and store FileHandle...</span>
|
|
|
155 142 <span class="k">my</span><span class="s">(</span><span class="i">$FileHandle</span><span class="s">)</span><span class="sc">;</span>
|
|
|
156 143 <span class="i">$FileHandle</span> = <span class="i">new</span> <span class="i">FileHandle</span><span class="s">(</span><span class="q">"${Mode}${Name}"</span><span class="s">)</span><span class="sc">;</span>
|
|
|
157 144 <span class="k">if</span> <span class="s">(</span>!<span class="k">defined</span> <span class="i">$FileHandle</span><span class="s">)</span> <span class="s">{</span>
|
|
|
158 145 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->Open: Can't open $Name: $! ..."</span><span class="sc">;</span>
|
|
|
159 146 <span class="s">}</span>
|
|
|
160 147 <span class="i">$This</span>->{<span class="w">FileHandle</span>} = <span class="i">$FileHandle</span><span class="sc">;</span>
|
|
|
161 148 <span class="i">$This</span>->{<span class="w">Status</span>} = <span class="n">1</span><span class="sc">;</span>
|
|
|
162 149
|
|
|
163 150 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
|
|
|
164 151 <span class="s">}</span>
|
|
|
165 152
|
|
|
166 153 <span class="c"># Close an open file...</span>
|
|
|
167 <a name="Close-"></a> 154 <span class="k">sub </span><span class="m">Close</span> <span class="s">{</span>
|
|
|
168 155 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
|
|
|
169 156
|
|
|
170 157 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">Status</span>}<span class="s">)</span> <span class="s">{</span>
|
|
|
171 158 <span class="i">$This</span>->{<span class="w">FileHandle</span>}<span class="i">->close</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
|
|
|
172 159 <span class="s">}</span>
|
|
|
173 160 <span class="i">$This</span>->{<span class="w">Status</span>} = <span class="n">0</span><span class="sc">;</span>
|
|
|
174 161
|
|
|
175 162 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
|
|
|
176 163 <span class="s">}</span>
|
|
|
177 164
|
|
|
178 165 <span class="c"># Supported Mode values are: Read, Write, Append, <, >, >>, r, w, a</span>
|
|
|
179 166 <span class="c">#</span>
|
|
|
180 <a name="SetMode-"></a> 167 <span class="k">sub </span><span class="m">SetMode</span> <span class="s">{</span>
|
|
|
181 168 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$SpecifiedMode</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
|
|
|
182 169 <span class="k">my</span><span class="s">(</span><span class="i">$Mode</span><span class="s">)</span><span class="sc">;</span>
|
|
|
183 170
|
|
|
184 171 <span class="k">if</span> <span class="s">(</span>!<span class="k">defined</span> <span class="i">$SpecifiedMode</span><span class="s">)</span> <span class="s">{</span>
|
|
|
185 172 <span class="i">$SpecifiedMode</span> = <span class="q">'Read'</span><span class="sc">;</span>
|
|
|
186 173 <span class="s">}</span>
|
|
|
187 174
|
|
|
188 175 <span class="j">MODE:</span> <span class="s">{</span>
|
|
|
189 176 <span class="k">if</span> <span class="s">(</span><span class="i">$SpecifiedMode</span> =~ <span class="q">/^(Read|<|r)$/i</span><span class="s">)</span> <span class="s">{</span> <span class="i">$Mode</span> = <span class="q">'Read'</span><span class="sc">;</span> <span class="k">last</span> <span class="j">MODE</span><span class="sc">;</span> <span class="s">}</span>
|
|
|
190 177 <span class="k">if</span> <span class="s">(</span><span class="i">$SpecifiedMode</span> =~ <span class="q">/^(Write|>|w)$/i</span><span class="s">)</span> <span class="s">{</span> <span class="i">$Mode</span> = <span class="q">'Write'</span><span class="sc">;</span> <span class="k">last</span> <span class="j">MODE</span><span class="sc">;</span> <span class="s">}</span>
|
|
|
191 178 <span class="k">if</span> <span class="s">(</span><span class="i">$SpecifiedMode</span> =~ <span class="q">/^(Append|>>|a)$/i</span><span class="s">)</span> <span class="s">{</span> <span class="i">$Mode</span> = <span class="q">'Append'</span><span class="sc">;</span> <span class="k">last</span> <span class="j">MODE</span><span class="sc">;</span> <span class="s">}</span>
|
|
|
192 179 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->SetMode: Specified mode value, $SpecifiedMode, is not valid: Supported values: Read, Write, Append, <, >, >>, r, w, a..."</span><span class="sc">;</span>
|
|
|
193 180 <span class="s">}</span>
|
|
|
194 181 <span class="i">$This</span>->{<span class="w">Mode</span>} = <span class="i">$Mode</span><span class="sc">;</span>
|
|
|
195 182
|
|
|
196 183 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
|
|
|
197 184 <span class="s">}</span>
|
|
|
198 185
|
|
|
199 186 <span class="c"># Get mode values to be used for file open function: <, >, >></span>
|
|
|
200 187 <span class="c">#</span>
|
|
|
201 <a name="_GetOpenMode-"></a> 188 <span class="k">sub </span><span class="m">_GetOpenMode</span> <span class="s">{</span>
|
|
|
202 189 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
|
|
|
203 190 <span class="k">my</span><span class="s">(</span><span class="i">$Mode</span><span class="s">)</span><span class="sc">;</span>
|
|
|
204 191
|
|
|
205 192 <span class="j">MODE:</span> <span class="s">{</span>
|
|
|
206 193 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">Mode</span>} =~ <span class="q">/^(Read|<|r)$/i</span><span class="s">)</span> <span class="s">{</span> <span class="i">$Mode</span> = <span class="q">'<'</span><span class="sc">;</span> <span class="k">last</span> <span class="j">MODE</span><span class="sc">;</span> <span class="s">}</span>
|
|
|
207 194 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">Mode</span>} =~ <span class="q">/^(Write|>|w)$/i</span><span class="s">)</span> <span class="s">{</span> <span class="i">$Mode</span> = <span class="q">'>'</span><span class="sc">;</span> <span class="k">last</span> <span class="j">MODE</span><span class="sc">;</span> <span class="s">}</span>
|
|
|
208 195 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">Mode</span>} =~ <span class="q">/^(Append|>>|a)$/i</span><span class="s">)</span> <span class="s">{</span> <span class="i">$Mode</span> = <span class="q">'>>'</span><span class="sc">;</span> <span class="k">last</span> <span class="j">MODE</span><span class="sc">;</span> <span class="s">}</span>
|
|
|
209 196 <span class="i">$Mode</span> = <span class="q">''</span><span class="sc">;</span>
|
|
|
210 197 <span class="s">}</span>
|
|
|
211 198 <span class="k">return</span> <span class="i">$Mode</span><span class="sc">;</span>
|
|
|
212 199 <span class="s">}</span>
|
|
|
213 200
|
|
|
214 <a name="EOF-"></a></pre>
|
|
|
215 <p> </p>
|
|
|
216 <br />
|
|
|
217 <center>
|
|
|
218 <img src="../../../images/h2o2.png">
|
|
|
219 </center>
|
|
|
220 </body>
|
|
|
221 </html>
|
