|
1
|
1 <html>
|
|
|
2 <head>
|
|
|
3 <title>MayaChemTools:Code:PackageInfo.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-PackageInfo-"></a> 1 <span class="k">package </span><span class="i">PackageInfo</span><span class="sc">;</span>
|
|
|
15 2 <span class="c">#</span>
|
|
|
16 3 <span class="c"># $RCSfile: PackageInfo.pm,v $</span>
|
|
|
17 4 <span class="c"># $Date: 2015/02/28 20:47:18 $</span>
|
|
|
18 5 <span class="c"># $Revision: 1.9 $</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 <span class="k">use</span> <span class="w">Carp</span><span class="sc">;</span>
|
|
|
45 32 <span class="k">use</span> <span class="w">Text::ParseWords</span><span class="sc">;</span>
|
|
|
46 33 <span class="k">use</span> <span class="w">TextUtil</span><span class="sc">;</span>
|
|
|
47 34 <span class="k">use</span> <span class="w">FileUtil</span><span class="sc">;</span>
|
|
|
48 35
|
|
|
49 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>
|
|
|
50 37
|
|
|
51 38 <span class="i">@ISA</span> = <span class="q">qw(Exporter)</span><span class="sc">;</span>
|
|
|
52 39 <span class="i">@EXPORT</span> = <span class="q">qw(GetPackageKeyValue SetPackageKeyValue IsPackageKeyNameAvailable)</span><span class="sc">;</span>
|
|
|
53 40 <span class="i">@EXPORT_OK</span> = <span class="q">qw()</span><span class="sc">;</span>
|
|
|
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">#</span>
|
|
|
57 44 <span class="c"># Load package data...</span>
|
|
|
58 45 <span class="c">#</span>
|
|
|
59 46 <span class="k">my</span><span class="s">(</span><span class="i">%PackageDataMap</span><span class="s">)</span><span class="sc">;</span>
|
|
|
60 47 <span class="i">_LoadPackageData</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
|
|
|
61 48
|
|
|
62 49 <span class="c"># Return value of a specific key...</span>
|
|
|
63 50 <span class="c">#</span>
|
|
|
64 <a name="GetPackageKeyValue-"></a> 51 <span class="k">sub </span><span class="m">GetPackageKeyValue</span> <span class="s">{</span>
|
|
|
65 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>
|
|
|
66 53
|
|
|
67 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">'Not Available'</span><span class="sc">;</span>
|
|
|
68 55 <span class="s">}</span>
|
|
|
69 56
|
|
|
70 57 <span class="c"># Set value of a specific key...</span>
|
|
|
71 58 <span class="c">#</span>
|
|
|
72 <a name="SetPackageKeyValue-"></a> 59 <span class="k">sub </span><span class="m">SetPackageKeyValue</span> <span class="s">{</span>
|
|
|
73 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>
|
|
|
74 61
|
|
|
75 62 <span class="i">$PackageDataMap</span>{<span class="i">$KeyName</span>} = <span class="i">$KeyValue</span><span class="sc">;</span>
|
|
|
76 63 <span class="s">}</span>
|
|
|
77 64
|
|
|
78 65 <span class="c"># Check availability of a package key name...</span>
|
|
|
79 66 <span class="c">#</span>
|
|
|
80 <a name="IsPackageKeyNameAvailable-"></a> 67 <span class="k">sub </span><span class="m">IsPackageKeyNameAvailable</span> <span class="s">{</span>
|
|
|
81 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>
|
|
|
82 69
|
|
|
83 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>
|
|
|
84 71 <span class="s">}</span>
|
|
|
85 72
|
|
|
86 73 <span class="c"># Implements Set<KeyName> and Get<KeyName> functions...</span>
|
|
|
87 74 <span class="c">#</span>
|
|
|
88 <a name="AUTOLOAD-"></a> 75 <span class="k">sub </span><span class="m">AUTOLOAD</span> <span class="s">{</span>
|
|
|
89 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>
|
|
|
90 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>
|
|
|
91 78
|
|
|
92 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>
|
|
|
93 80
|
|
|
94 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>
|
|
|
95 82 <span class="w">croak</span> <span class="q">"Error: Can't locate function \"$FunctionName\" via package \"$PackageName\": This function is not automatically implemented by AUTOLOAD: Only Get<KeyName> and Set<KeyName> functions are implemented via AUTOLOAD..."</span><span class="sc">;</span>
|
|
|
96 83 <span class="s">}</span>
|
|
|
97 84
|
|
|
98 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>
|
|
|
99 86
|
|
|
100 87 <span class="k">if</span> <span class="s">(</span><span class="i">$FunctionName</span> =~ <span class="q">/^Set/</span> && !<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>
|
|
|
101 88 <span class="w">carp</span> <span class="q">"Warning: ${PackageName}::${FunctionName}: Didn't set value for key $KeyName: Key value for must be specified...\n"</span><span class="sc">;</span>
|
|
|
102 89 <span class="k">return</span> <span class="k">undef</span><span class="sc">;</span>
|
|
|
103 90 <span class="s">}</span>
|
|
|
104 91
|
|
|
105 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>
|
|
|
106 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>
|
|
|
107 94 <span class="s">}</span>
|
|
|
108 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>
|
|
|
109 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>
|
|
|
110 97 <span class="s">}</span>
|
|
|
111 98
|
|
|
112 99 <span class="s">}</span>
|
|
|
113 100
|
|
|
114 101 <span class="c"># Load PackageInfo.csv files from <MayaChemTools>/lib directory...</span>
|
|
|
115 102 <span class="c">#</span>
|
|
|
116 <a name="_LoadPackageData-"></a> 103 <span class="k">sub </span><span class="m">_LoadPackageData</span> <span class="s">{</span>
|
|
|
117 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>
|
|
|
118 105
|
|
|
119 106 <span class="i">$MayaChemToolsLibDir</span> = <span class="i">GetMayaChemToolsLibDirName</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
|
|
|
120 107 <span class="i">$PackageDataFile</span> = <span class="q">"$MayaChemToolsLibDir"</span> . <span class="q">"/data/PackageInfo.csv"</span><span class="sc">;</span>
|
|
|
121 108
|
|
|
122 109 <span class="k">if</span> <span class="s">(</span>! <span class="k">-e</span> <span class="q">"$PackageDataFile"</span><span class="s">)</span> <span class="s">{</span>
|
|
|
123 110 <span class="w">croak</span> <span class="q">"Error: MayaChemTools package file, $PackageDataFile, is missing: Possible installation problems..."</span><span class="sc">;</span>
|
|
|
124 111 <span class="s">}</span>
|
|
|
125 112
|
|
|
126 113 <span class="c">#</span>
|
|
|
127 114 <span class="c"># Format:</span>
|
|
|
128 115 <span class="c">#</span>
|
|
|
129 116 <span class="c"># "Key","Value"</span>
|
|
|
130 117 <span class="c"># "PackageName","MayaChemTools"</span>
|
|
|
131 118 <span class="c"># ... ...</span>
|
|
|
132 119 <span class="c">#</span>
|
|
|
133 120
|
|
|
134 121 <span class="i">%PackageDataMap</span> = <span class="s">(</span><span class="s">)</span><span class="sc">;</span>
|
|
|
135 122 <span class="i">$InDelim</span> = <span class="q">"\,"</span><span class="sc">;</span>
|
|
|
136 123
|
|
|
137 124 <span class="k">open</span> <span class="w">PACKAGEDATAFILE</span><span class="cm">,</span> <span class="q">"$PackageDataFile"</span> <span class="k">or</span> <span class="w">croak</span> <span class="q">"Couldn't open $PackageDataFile: $! ..."</span><span class="sc">;</span>
|
|
|
138 125
|
|
|
139 126 <span class="c"># Skip lines up to column labels...</span>
|
|
|
140 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>
|
|
|
141 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>
|
|
|
142 129 <span class="k">last</span> <span class="j">LINE</span><span class="sc">;</span>
|
|
|
143 130 <span class="s">}</span>
|
|
|
144 131 <span class="s">}</span>
|
|
|
145 132
|
|
|
146 133 <span class="c"># Process key/value pairs...</span>
|
|
|
147 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>
|
|
|
148 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>
|
|
|
149 136 <span class="k">next</span> <span class="j">LINE</span><span class="sc">;</span>
|
|
|
150 137 <span class="s">}</span>
|
|
|
151 138 <span class="i">@LineWords</span> = <span class="s">(</span><span class="s">)</span><span class="sc">;</span>
|
|
|
152 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>
|
|
|
153 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>
|
|
|
154 141 <span class="w">croak</span> <span class="q">"Error: The number of data fields, @LineWords, in $PackageDataFile must be 2.\nLine: $Line..."</span><span class="sc">;</span>
|
|
|
155 142 <span class="s">}</span>
|
|
|
156 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>
|
|
|
157 144
|
|
|
158 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>
|
|
|
159 146 <span class="w">carp</span> <span class="q">"Warning: Multiple entries for key, $Key, in $PackageDataFile. Ignoring current line.\nLine: $Line..."</span><span class="sc">;</span>
|
|
|
160 147 <span class="k">next</span> <span class="j">LINE</span><span class="sc">;</span>
|
|
|
161 148 <span class="s">}</span>
|
|
|
162 149
|
|
|
163 150 <span class="i">$PackageDataMap</span>{<span class="i">$Key</span>} = <span class="i">$Value</span><span class="sc">;</span>
|
|
|
164 151 <span class="s">}</span>
|
|
|
165 152 <span class="k">close</span> <span class="w">PACKAGEDATAFILE</span><span class="sc">;</span>
|
|
|
166 153 <span class="s">}</span>
|
|
|
167 154
|
|
|
168 <a name="EOF-"></a></pre>
|
|
|
169 <p> </p>
|
|
|
170 <br />
|
|
|
171 <center>
|
|
|
172 <img src="../../../images/h2o2.png">
|
|
|
173 </center>
|
|
|
174 </body>
|
|
|
175 </html>
|
