Mercurial > repos > deepakjadmin > mayatool3_test3
view mayachemtools/docs/modules/html/code/FileIO.html @ 9:ab29fa5c8c1f draft default tip
Uploaded
| author | deepakjadmin |
|---|---|
| date | Thu, 15 Dec 2016 14:18:03 -0500 |
| parents | 73ae111cf86f |
| children |
line wrap: on
line source
<html> <head> <title>MayaChemTools:Code:FileIO::FileIO.pm</title> <meta http-equiv="content-type" content="text/html;charset=utf-8"> <link rel="stylesheet" type="text/css" href="../../../css/MayaChemToolsCode.css"> </head> <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10"> <br/> <center> <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a> </center> <br/> <pre> <a name="package-FileIO::FileIO-"></a> 1 <span class="k">package </span><span class="i">FileIO::FileIO</span><span class="sc">;</span> 2 <span class="c">#</span> 3 <span class="c"># $RCSfile: FileIO.pm,v $</span> 4 <span class="c"># $Date: 2015/02/28 20:48:43 $</span> 5 <span class="c"># $Revision: 1.27 $</span> 6 <span class="c">#</span> 7 <span class="c"># Author: Manish Sud <msud@san.rr.com></span> 8 <span class="c">#</span> 9 <span class="c"># Copyright (C) 2015 Manish Sud. All rights reserved.</span> 10 <span class="c">#</span> 11 <span class="c"># This file is part of MayaChemTools.</span> 12 <span class="c">#</span> 13 <span class="c"># MayaChemTools is free software; you can redistribute it and/or modify it under</span> 14 <span class="c"># the terms of the GNU Lesser General Public License as published by the Free</span> 15 <span class="c"># Software Foundation; either version 3 of the License, or (at your option) any</span> 16 <span class="c"># later version.</span> 17 <span class="c">#</span> 18 <span class="c"># MayaChemTools is distributed in the hope that it will be useful, but without</span> 19 <span class="c"># any warranty; without even the implied warranty of merchantability of fitness</span> 20 <span class="c"># for a particular purpose. See the GNU Lesser General Public License for more</span> 21 <span class="c"># details.</span> 22 <span class="c">#</span> 23 <span class="c"># You should have received a copy of the GNU Lesser General Public License</span> 24 <span class="c"># along with MayaChemTools; if not, see <http://www.gnu.org/licenses/> or</span> 25 <span class="c"># write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,</span> 26 <span class="c"># Boston, MA, 02111-1307, USA.</span> 27 <span class="c">#</span> 28 29 <span class="k">use</span> <span class="w">strict</span><span class="sc">;</span> 30 <span class="k">use</span> <span class="w">Carp</span><span class="sc">;</span> 31 <span class="k">use</span> <span class="w">Exporter</span><span class="sc">;</span> 32 <span class="k">use</span> <span class="w">FileHandle</span><span class="sc">;</span> 33 <span class="k">use</span> <span class="w">ObjectProperty</span><span class="sc">;</span> 34 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> 36 37 <span class="i">@ISA</span> = <span class="q">qw(ObjectProperty Exporter)</span><span class="sc">;</span> 38 <span class="i">@EXPORT</span> = <span class="q">qw()</span><span class="sc">;</span> 39 <span class="i">@EXPORT_OK</span> = <span class="q">qw()</span><span class="sc">;</span> 40 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> 42 43 <span class="c"># Setup class variables...</span> 44 <span class="k">my</span><span class="s">(</span><span class="i">$ClassName</span><span class="s">)</span><span class="sc">;</span> 45 <span class="i">_InitializeClass</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> 46 47 <span class="c"># Class constructor...</span> <a name="new-"></a> 48 <span class="k">sub </span><span class="m">new</span> <span class="s">{</span> 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> 50 51 <span class="c"># Initialize object...</span> 52 <span class="k">my</span> <span class="i">$This</span> = <span class="s">{</span><span class="s">}</span><span class="sc">;</span> 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> 54 <span class="i">$This</span><span class="i">->_InitializeFileIO</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> 55 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> 57 58 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> 59 <span class="s">}</span> 60 61 <span class="c"># Initialize object data...</span> 62 <span class="c">#</span> <a name="_InitializeFileIO-"></a> 63 <span class="k">sub </span><span class="m">_InitializeFileIO</span> <span class="s">{</span> 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> 65 66 <span class="c"># File name...</span> 67 <span class="i">$This</span>->{<span class="w">Name</span>} = <span class="q">''</span><span class="sc">;</span> 68 69 <span class="c"># Read, write or append...</span> 70 <span class="i">$This</span>->{<span class="w">Mode</span>} = <span class="q">'Read'</span><span class="sc">;</span> 71 72 <span class="c"># Open/close status...</span> 73 <span class="i">$This</span>->{<span class="w">Status</span>} = <span class="n">0</span><span class="sc">;</span> 74 75 <span class="c"># File handle returned by file open...</span> 76 <span class="i">$This</span>->{<span class="w">FileHandle</span>} = <span class="q">''</span><span class="sc">;</span> 77 <span class="s">}</span> 78 79 <span class="c"># Initialize class ...</span> <a name="_InitializeClass-"></a> 80 <span class="k">sub </span><span class="m">_InitializeClass</span> <span class="s">{</span> 81 <span class="c">#Class name...</span> 82 <span class="i">$ClassName</span> = <span class="w">__PACKAGE__</span><span class="sc">;</span> 83 84 <span class="s">}</span> 85 86 <span class="c"># Initialize object properties....</span> <a name="_InitializeFileIOProperties-"></a> 87 <span class="k">sub </span><span class="m">_InitializeFileIOProperties</span> <span class="s">{</span> 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> 89 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> 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> 92 <span class="i">$MethodName</span> = <span class="q">"Set${Name}"</span><span class="sc">;</span> 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> 94 <span class="s">}</span> 95 96 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> 97 <span class="s">}</span> 98 99 <span class="c"># Close any open file...</span> <a name="DESTROY-"></a> 100 <span class="k">sub </span><span class="m">DESTROY</span> <span class="s">{</span> 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> 102 103 <span class="i">$This</span><span class="i">->Close</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> 104 105 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> 106 <span class="s">}</span> 107 108 <span class="c"># Set file name and make sure it's not already set...</span> 109 <span class="c">#</span> <a name="SetName-"></a> 110 <span class="k">sub </span><span class="m">SetName</span> <span class="s">{</span> 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> 112 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> 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> 115 <span class="s">}</span> 116 117 <span class="i">$This</span>->{<span class="w">Name</span>} = <span class="i">$Name</span><span class="sc">;</span> 118 119 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> 120 <span class="s">}</span> 121 122 <span class="c"># Open file using specified mode...</span> 123 <span class="c">#</span> <a name="Open-"></a> 124 <span class="k">sub </span><span class="m">Open</span> <span class="s">{</span> 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> 126 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> 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> 129 <span class="s">}</span> 130 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> 132 <span class="c"># Set mode...</span> 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> 134 <span class="s">}</span> 135 136 <span class="c"># Get name and mode...</span> 137 <span class="k">my</span><span class="s">(</span><span class="i">$Name</span><span class="s">)</span><span class="sc">;</span> 138 <span class="i">$Name</span> = <span class="i">$This</span>->{<span class="w">Name</span>}<span class="sc">;</span> 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> 140 141 <span class="c"># Open the file using specified mode and store FileHandle...</span> 142 <span class="k">my</span><span class="s">(</span><span class="i">$FileHandle</span><span class="s">)</span><span class="sc">;</span> 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> 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> 145 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->Open: Can't open $Name: $! ..."</span><span class="sc">;</span> 146 <span class="s">}</span> 147 <span class="i">$This</span>->{<span class="w">FileHandle</span>} = <span class="i">$FileHandle</span><span class="sc">;</span> 148 <span class="i">$This</span>->{<span class="w">Status</span>} = <span class="n">1</span><span class="sc">;</span> 149 150 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> 151 <span class="s">}</span> 152 153 <span class="c"># Close an open file...</span> <a name="Close-"></a> 154 <span class="k">sub </span><span class="m">Close</span> <span class="s">{</span> 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> 156 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> 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> 159 <span class="s">}</span> 160 <span class="i">$This</span>->{<span class="w">Status</span>} = <span class="n">0</span><span class="sc">;</span> 161 162 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> 163 <span class="s">}</span> 164 165 <span class="c"># Supported Mode values are: Read, Write, Append, <, >, >>, r, w, a</span> 166 <span class="c">#</span> <a name="SetMode-"></a> 167 <span class="k">sub </span><span class="m">SetMode</span> <span class="s">{</span> 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> 169 <span class="k">my</span><span class="s">(</span><span class="i">$Mode</span><span class="s">)</span><span class="sc">;</span> 170 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> 172 <span class="i">$SpecifiedMode</span> = <span class="q">'Read'</span><span class="sc">;</span> 173 <span class="s">}</span> 174 175 <span class="j">MODE:</span> <span class="s">{</span> 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> 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> 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> 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> 180 <span class="s">}</span> 181 <span class="i">$This</span>->{<span class="w">Mode</span>} = <span class="i">$Mode</span><span class="sc">;</span> 182 183 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> 184 <span class="s">}</span> 185 186 <span class="c"># Get mode values to be used for file open function: <, >, >></span> 187 <span class="c">#</span> <a name="_GetOpenMode-"></a> 188 <span class="k">sub </span><span class="m">_GetOpenMode</span> <span class="s">{</span> 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> 190 <span class="k">my</span><span class="s">(</span><span class="i">$Mode</span><span class="s">)</span><span class="sc">;</span> 191 192 <span class="j">MODE:</span> <span class="s">{</span> 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> 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> 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> 196 <span class="i">$Mode</span> = <span class="q">''</span><span class="sc">;</span> 197 <span class="s">}</span> 198 <span class="k">return</span> <span class="i">$Mode</span><span class="sc">;</span> 199 <span class="s">}</span> 200 <a name="EOF-"></a></pre> <p> </p> <br /> <center> <img src="../../../images/h2o2.png"> </center> </body> </html>