diff mayachemtools/docs/modules/html/code/PackageInfo.html @ 0:73ae111cf86f draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 11:55:01 -0500
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mayachemtools/docs/modules/html/code/PackageInfo.html	Wed Jan 20 11:55:01 2016 -0500
@@ -0,0 +1,175 @@
+<html>
+<head>
+<title>MayaChemTools:Code:PackageInfo.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-PackageInfo-"></a>   1 <span class="k">package </span><span class="i">PackageInfo</span><span class="sc">;</span>
+   2 <span class="c">#</span>
+   3 <span class="c"># $RCSfile: PackageInfo.pm,v $</span>
+   4 <span class="c"># $Date: 2015/02/28 20:47:18 $</span>
+   5 <span class="c"># $Revision: 1.9 $</span>
+   6 <span class="c">#</span>
+   7 <span class="c"># Author: Manish Sud &lt;msud@san.rr.com&gt;</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 &lt;http://www.gnu.org/licenses/&gt; or</span>
+  25 <span class="c"># write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,</span>
+  26 <span class="c"># Boston, MA, 02111-1307, USA.</span>
+  27 <span class="c">#</span>
+  28 
+  29 <span class="k">use</span> <span class="w">strict</span><span class="sc">;</span>
+  30 <span class="k">use</span> <span class="w">Exporter</span><span class="sc">;</span>
+  31 <span class="k">use</span> <span class="w">Carp</span><span class="sc">;</span>
+  32 <span class="k">use</span> <span class="w">Text::ParseWords</span><span class="sc">;</span>
+  33 <span class="k">use</span> <span class="w">TextUtil</span><span class="sc">;</span>
+  34 <span class="k">use</span> <span class="w">FileUtil</span><span class="sc">;</span>
+  35 
+  36 <span class="k">use</span> <span class="w">vars</span> <span class="q">qw($AUTOLOAD @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS)</span><span class="sc">;</span>
+  37 
+  38 <span class="i">@ISA</span> = <span class="q">qw(Exporter)</span><span class="sc">;</span>
+  39 <span class="i">@EXPORT</span> = <span class="q">qw(GetPackageKeyValue SetPackageKeyValue IsPackageKeyNameAvailable)</span><span class="sc">;</span>
+  40 <span class="i">@EXPORT_OK</span> = <span class="q">qw()</span><span class="sc">;</span>
+  41 <span class="i">%EXPORT_TAGS</span> = <span class="s">(</span><span class="w">all</span>  <span class="cm">=&gt;</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">#</span>
+  44 <span class="c"># Load package data...</span>
+  45 <span class="c">#</span>
+  46 <span class="k">my</span><span class="s">(</span><span class="i">%PackageDataMap</span><span class="s">)</span><span class="sc">;</span>
+  47 <span class="i">_LoadPackageData</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
+  48 
+  49 <span class="c"># Return value of a specific key...</span>
+  50 <span class="c">#</span>
+<a name="GetPackageKeyValue-"></a>  51 <span class="k">sub </span><span class="m">GetPackageKeyValue</span> <span class="s">{</span>
+  52   <span class="k">my</span><span class="s">(</span><span class="i">$KeyName</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+  53 
+  54   <span class="k">return</span> <span class="k">exists</span> <span class="i">$PackageDataMap</span>{<span class="i">$KeyName</span>} ? <span class="i">$PackageDataMap</span>{<span class="i">$KeyName</span>} <span class="co">:</span> <span class="q">&#39;Not Available&#39;</span><span class="sc">;</span>
+  55 <span class="s">}</span>
+  56 
+  57 <span class="c"># Set value of a specific key...</span>
+  58 <span class="c">#</span>
+<a name="SetPackageKeyValue-"></a>  59 <span class="k">sub </span><span class="m">SetPackageKeyValue</span> <span class="s">{</span>
+  60   <span class="k">my</span><span class="s">(</span><span class="i">$KeyName</span><span class="cm">,</span> <span class="i">$KeyValue</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+  61 
+  62   <span class="i">$PackageDataMap</span>{<span class="i">$KeyName</span>} = <span class="i">$KeyValue</span><span class="sc">;</span>
+  63 <span class="s">}</span>
+  64 
+  65 <span class="c"># Check availability of a package key name...</span>
+  66 <span class="c">#</span>
+<a name="IsPackageKeyNameAvailable-"></a>  67 <span class="k">sub </span><span class="m">IsPackageKeyNameAvailable</span> <span class="s">{</span>
+  68   <span class="k">my</span><span class="s">(</span><span class="i">$KeyName</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+  69 
+  70   <span class="k">return</span> <span class="k">exists</span> <span class="i">$PackageDataMap</span>{<span class="i">$KeyName</span>} ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span>
+  71 <span class="s">}</span>
+  72 
+  73 <span class="c"># Implements Set&lt;KeyName&gt; and Get&lt;KeyName&gt; functions...</span>
+  74 <span class="c">#</span>
+<a name="AUTOLOAD-"></a>  75 <span class="k">sub </span><span class="m">AUTOLOAD</span> <span class="s">{</span>
+  76   <span class="k">my</span><span class="s">(</span><span class="i">$KeyValue</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+  77   <span class="k">my</span><span class="s">(</span><span class="i">$PackageName</span><span class="cm">,</span> <span class="i">$FunctionName</span><span class="cm">,</span> <span class="i">$KeyName</span><span class="s">)</span><span class="sc">;</span>
+  78 
+  79   <span class="s">(</span><span class="i">$PackageName</span><span class="cm">,</span> <span class="i">$FunctionName</span><span class="s">)</span> = <span class="i">$AUTOLOAD</span> =~ <span class="q">/^(.*?)::(.*?)$/</span><span class="sc">;</span>
+  80 
+  81   <span class="k">if</span> <span class="s">(</span>!<span class="s">(</span><span class="i">$FunctionName</span> =~ <span class="q">/^Get/</span> || <span class="i">$FunctionName</span> =~ <span class="q">/^Set/</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span>
+  82     <span class="w">croak</span> <span class="q">&quot;Error: Can&#39;t locate function \&quot;$FunctionName\&quot; via package \&quot;$PackageName\&quot;: This function is not automatically implemented by AUTOLOAD: Only Get&lt;KeyName&gt; and Set&lt;KeyName&gt; functions are implemented via AUTOLOAD...&quot;</span><span class="sc">;</span>
+  83   <span class="s">}</span>
+  84 
+  85   <span class="s">(</span><span class="i">$KeyName</span><span class="s">)</span> = <span class="i">$FunctionName</span> =~ <span class="q">/^[SG]et(.*?)$/</span><span class="sc">;</span>
+  86 
+  87   <span class="k">if</span> <span class="s">(</span><span class="i">$FunctionName</span> =~ <span class="q">/^Set/</span> &amp;&amp; !<span class="k">defined</span><span class="s">(</span><span class="i">$KeyValue</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span>
+  88     <span class="w">carp</span> <span class="q">&quot;Warning:  ${PackageName}::${FunctionName}: Didn&#39;t set value for key $KeyName: Key value for must be specified...\n&quot;</span><span class="sc">;</span>
+  89     <span class="k">return</span> <span class="k">undef</span><span class="sc">;</span>
+  90   <span class="s">}</span>
+  91 
+  92   <span class="k">if</span> <span class="s">(</span><span class="i">$FunctionName</span> =~ <span class="q">/^Get/</span><span class="s">)</span> <span class="s">{</span>
+  93     <span class="k">return</span> <span class="i">GetPackageKeyValue</span><span class="s">(</span><span class="i">$KeyName</span><span class="s">)</span><span class="sc">;</span>
+  94   <span class="s">}</span>
+  95   <span class="k">elsif</span> <span class="s">(</span><span class="i">$FunctionName</span> =~ <span class="q">/^Set/</span><span class="s">)</span> <span class="s">{</span>
+  96     <span class="k">return</span> <span class="i">SetPackageKeyValue</span><span class="s">(</span><span class="i">$KeyName</span><span class="cm">,</span> <span class="i">$KeyValue</span><span class="s">)</span><span class="sc">;</span>
+  97   <span class="s">}</span>
+  98 
+  99 <span class="s">}</span>
+ 100 
+ 101 <span class="c"># Load PackageInfo.csv files from &lt;MayaChemTools&gt;/lib directory...</span>
+ 102 <span class="c">#</span>
+<a name="_LoadPackageData-"></a> 103 <span class="k">sub </span><span class="m">_LoadPackageData</span> <span class="s">{</span>
+ 104   <span class="k">my</span><span class="s">(</span><span class="i">$PackageDataFile</span><span class="cm">,</span> <span class="i">$MayaChemToolsLibDir</span><span class="cm">,</span> <span class="i">$Key</span><span class="cm">,</span> <span class="i">$Value</span><span class="cm">,</span> <span class="i">$Line</span><span class="cm">,</span> <span class="i">$InDelim</span><span class="cm">,</span> <span class="i">@LineWords</span><span class="s">)</span><span class="sc">;</span>
+ 105 
+ 106   <span class="i">$MayaChemToolsLibDir</span> = <span class="i">GetMayaChemToolsLibDirName</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
+ 107   <span class="i">$PackageDataFile</span> =  <span class="q">&quot;$MayaChemToolsLibDir&quot;</span> . <span class="q">&quot;/data/PackageInfo.csv&quot;</span><span class="sc">;</span>
+ 108 
+ 109   <span class="k">if</span> <span class="s">(</span>! <span class="k">-e</span> <span class="q">&quot;$PackageDataFile&quot;</span><span class="s">)</span> <span class="s">{</span>
+ 110     <span class="w">croak</span> <span class="q">&quot;Error: MayaChemTools package file, $PackageDataFile, is missing: Possible installation problems...&quot;</span><span class="sc">;</span>
+ 111   <span class="s">}</span>
+ 112 
+ 113   <span class="c">#</span>
+ 114   <span class="c"># Format:</span>
+ 115   <span class="c">#</span>
+ 116   <span class="c"># &quot;Key&quot;,&quot;Value&quot;</span>
+ 117   <span class="c"># &quot;PackageName&quot;,&quot;MayaChemTools&quot;</span>
+ 118   <span class="c"># ... ...</span>
+ 119   <span class="c">#</span>
+ 120 
+ 121   <span class="i">%PackageDataMap</span> = <span class="s">(</span><span class="s">)</span><span class="sc">;</span>
+ 122   <span class="i">$InDelim</span> = <span class="q">&quot;\,&quot;</span><span class="sc">;</span>
+ 123 
+ 124   <span class="k">open</span> <span class="w">PACKAGEDATAFILE</span><span class="cm">,</span> <span class="q">&quot;$PackageDataFile&quot;</span> <span class="k">or</span> <span class="w">croak</span> <span class="q">&quot;Couldn&#39;t open $PackageDataFile: $! ...&quot;</span><span class="sc">;</span>
+ 125 
+ 126   <span class="c"># Skip lines up to column labels...</span>
+ 127   <span class="j">LINE:</span> <span class="k">while</span> <span class="s">(</span><span class="i">$Line</span> = <span class="i">GetTextLine</span><span class="s">(</span>\<span class="i">*PACKAGEDATAFILE</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span>
+ 128     <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>
+ 129       <span class="k">last</span> <span class="j">LINE</span><span class="sc">;</span>
+ 130     <span class="s">}</span>
+ 131   <span class="s">}</span>
+ 132 
+ 133   <span class="c"># Process key/value pairs...</span>
+ 134   <span class="j">LINE:</span> <span class="k">while</span> <span class="s">(</span><span class="i">$Line</span> = <span class="i">GetTextLine</span><span class="s">(</span>\<span class="i">*PACKAGEDATAFILE</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span>
+ 135     <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>
+ 136       <span class="k">next</span> <span class="j">LINE</span><span class="sc">;</span>
+ 137     <span class="s">}</span>
+ 138     <span class="i">@LineWords</span> = <span class="s">(</span><span class="s">)</span><span class="sc">;</span>
+ 139     <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>
+ 140     <span class="k">if</span> <span class="s">(</span><span class="i">@LineWords</span> != <span class="n">2</span><span class="s">)</span> <span class="s">{</span>
+ 141       <span class="w">croak</span> <span class="q">&quot;Error: The number of data fields, @LineWords, in $PackageDataFile must be 2.\nLine: $Line...&quot;</span><span class="sc">;</span>
+ 142     <span class="s">}</span>
+ 143     <span class="s">(</span><span class="i">$Key</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="i">@LineWords</span><span class="sc">;</span>
+ 144 
+ 145     <span class="k">if</span> <span class="s">(</span><span class="k">exists</span> <span class="i">$PackageDataMap</span>{<span class="i">$Key</span>}<span class="s">)</span> <span class="s">{</span>
+ 146       <span class="w">carp</span> <span class="q">&quot;Warning: Multiple entries for key, $Key, in $PackageDataFile. Ignoring current line.\nLine: $Line...&quot;</span><span class="sc">;</span>
+ 147       <span class="k">next</span> <span class="j">LINE</span><span class="sc">;</span>
+ 148     <span class="s">}</span>
+ 149 
+ 150     <span class="i">$PackageDataMap</span>{<span class="i">$Key</span>} = <span class="i">$Value</span><span class="sc">;</span>
+ 151   <span class="s">}</span>
+ 152   <span class="k">close</span> <span class="w">PACKAGEDATAFILE</span><span class="sc">;</span>
+ 153 <span class="s">}</span>
+ 154 
+<a name="EOF-"></a></pre>
+<p>&nbsp;</p>
+<br />
+<center>
+<img src="../../../images/h2o2.png">
+</center>
+</body>
+</html>