This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix a doc typo and a warning typo in VMS::DCLsym
[perl5.git] / vms / ext / DCLsym / DCLsym.pm
CommitLineData
5f05dabc
PP
1package VMS::DCLsym;
2
3use Carp;
4use DynaLoader;
5use vars qw( @ISA $VERSION );
6use strict;
7
8# Package globals
9@ISA = ( 'DynaLoader' );
b89b8d61 10$VERSION = '1.03';
5f05dabc
PP
11my(%Locsyms) = ( ':ID' => 'LOCAL' );
12my(%Gblsyms) = ( ':ID' => 'GLOBAL');
13my $DoCache = 1;
14my $Cache_set = 0;
15
16
17#====> OO methods
18
19sub new {
20 my($pkg,$type) = @_;
21 bless { TYPE => $type }, $pkg;
22}
23
24sub DESTROY { }
25
26sub getsym {
27 my($self,$name) = @_;
28 my($val,$table);
29
30 if (($val,$table) = _getsym($name)) {
31 if ($table eq 'GLOBAL') { $Gblsyms{$name} = $val; }
32 else { $Locsyms{$name} = $val; }
33 }
34 wantarray ? ($val,$table) : $val;
35}
36
37sub setsym {
38 my($self,$name,$val,$table) = @_;
39
40 $table = $self->{TYPE} unless $table;
41 if (_setsym($name,$val,$table)) {
42 if ($table eq 'GLOBAL') { $Gblsyms{$name} = $val; }
43 else { $Locsyms{$name} = $val; }
44 1;
45 }
46 else { 0; }
47}
48
49sub delsym {
50 my($self,$name,$table) = @_;
51
52 $table = $self->{TYPE} unless $table;
53 if (_delsym($name,$table)) {
54 if ($table eq 'GLOBAL') { delete $Gblsyms{$name}; }
55 else { delete $Locsyms{$name}; }
56 1;
57 }
58 else { 0; }
59}
60
61sub clearcache {
62 my($self,$perm) = @_;
63 my($old);
64
65 $Cache_set = 0;
66 %Locsyms = ( ':ID' => 'LOCAL');
67 %Gblsyms = ( ':ID' => 'GLOBAL');
68 $old = $DoCache;
69 $DoCache = $perm if defined($perm);
70 $old;
71}
72
73#====> TIEHASH methods
74
75sub TIEHASH {
76 $_[0]->new(@_);
77}
78
79sub FETCH {
80 my($self,$name) = @_;
81 if ($name eq ':GLOBAL') { $self->{TYPE} eq 'GLOBAL'; }
82 elsif ($name eq ':LOCAL' ) { $self->{TYPE} eq 'LOCAL'; }
83 else { scalar($self->getsym($name)); }
84}
85
86sub STORE {
87 my($self,$name,$val) = @_;
88 if ($name eq ':GLOBAL') { $self->{TYPE} = 'GLOBAL'; }
89 elsif ($name eq ':LOCAL' ) { $self->{TYPE} = 'LOCAL'; }
90 else { $self->setsym($name,$val); }
91}
92
93sub DELETE {
94 my($self,$name) = @_;
95
96 $self->delsym($name);
97}
98
99sub FIRSTKEY {
100 my($self) = @_;
101 my($name,$eqs,$val);
102
103 if (!$DoCache || !$Cache_set) {
104 # We should eventually replace this with a C routine which walks the
105 # CLI symbol table directly. If I ever get 'hold of an I&DS manual . . .
106 open(P,'Show Symbol * |');
107 while (<P>) {
108 ($name,$eqs,$val) = /^\s+(\S+) (=+) (.+)/
b89b8d61 109 or carp "VMS::DCLsym: unparseable line $_";
5f05dabc
PP
110 $name =~ s#\*##;
111 $val =~ s/"(.*)"$/$1/ or $val =~ s/^(\S+).*/$1/;
112 if ($eqs eq '==') { $Gblsyms{$name} = $val; }
113 else { $Locsyms{$name} = $val; }
114 }
115 close P;
116 $Cache_set = 1;
117 }
118 $self ->{IDX} = 0;
119 $self->{CACHE} = $self->{TYPE} eq 'GLOBAL' ? \%Gblsyms : \%Locsyms;
120 while (($name,$val) = each(%{$self->{CACHE}}) and !defined($name)) {
121 if ($self->{CACHE}{':ID'} eq 'GLOBAL') { return undef; }
122 $self->{CACHE} = \%Gblsyms;
123 }
124 $name;
125}
126
127sub NEXTKEY {
128 my($self) = @_;
129 my($name,$val);
130
131 while (($name,$val) = each(%{$self->{CACHE}}) and !defined($name)) {
132 if ($self->{CACHE}{':ID'} eq 'GLOBAL') { return undef; }
133 $self->{CACHE} = \%Gblsyms;
134 }
135 $name;
136}
137
138
139sub EXISTS { defined($_[0]->FETCH(@_)) ? 1 : 0 }
140
141sub CLEAR { }
142
143
144bootstrap VMS::DCLsym;
145
1461;
147
148__END__
149
150=head1 NAME
151
152VMS::DCLsym - Perl extension to manipulate DCL symbols
153
154=head1 SYNOPSIS
155
156 tie %allsyms, VMS::DCLsym;
157 tie %cgisyms, VMS::DCLsym, 'GLOBAL';
158
159
b89b8d61 160 $handle = new VMS::DCLsym;
5f05dabc
PP
161 $value = $handle->getsym($name);
162 $handle->setsym($name,$value,'GLOBAL') or die "Can't create symbol: $!\n";
163 $handle->delsym($name,'LOCAL') or die "Can't delete symbol: $!\n";
164 $handle->clearcache();
165
166=head1 DESCRIPTION
167
168The VMS::DCLsym extension provides access to DCL symbols using a
169tied hash interface. This allows Perl scripts to manipulate symbols in
170a manner similar to the way in which logical names are manipulated via
171the built-in C<%ENV> hash. Alternatively, one can call methods in this
172package directly to read, create, and delete symbols.
173
174=head2 Tied hash interface
175
176This interface lets you treat the DCL symbol table as a Perl associative array,
177in which the key of each element is the symbol name, and the value of the
178element is that symbol's value. Case is not significant in the key string, as
179DCL converts symbol names to uppercase, but it is significant in the value
180string. All of the usual operations on associative arrays are supported.
181Reading an element retrieves the current value of the symbol, assigning to it
182defines a new symbol (or overwrites the old value of an existing symbol), and
183deleting an element deletes the corresponding symbol. Setting an element to
184C<undef>, or C<undef>ing it directly, sets the corresponding symbol to the null
185string. You may also read the special keys ':GLOBAL' and ':LOCAL' to find out
186whether a default symbol table has been specified for this hash (see C<table>
187below), or set either or these keys to specify a default symbol table.
188
189When you call the C<tie> function to bind an associative array to this package,
190you may specify as an optional argument the symbol table in which you wish to
191create and delete symbols. If the argument is the string 'GLOBAL', then the
192global symbol table is used; any other string causes the local symbol table to
193be used. Note that this argument does not affect attempts to read symbols; if
194a symbol with the specified name exists in the local symbol table, it is always
195returned in preference to a symbol by the same name in the global symbol table.
196
197=head2 Object interface
198
199Although it's less convenient in some ways than the tied hash interface, you
200can also call methods directly to manipulate individual symbols. In some
201cases, this allows you finer control than using a tied hash aggregate. The
202following methods are supported:
203
4ac9195f 204=over 4
2ceaccd7 205
5f05dabc
PP
206=item new
207
208This creates a C<VMS::DCLsym> object which can be used as a handle for later
209method calls. The single optional argument specifies the symbol table used
210by default in future method calls, in the same way as the optional argument to
211C<tie> described above.
212
213=item getsym
214
215If called in a scalar context, C<getsym> returns the value of the symbol whose
216name is given as the argument to the call, or C<undef> if no such symbol
217exists. Symbols in the local symbol table are always used in preference to
91e74348 218symbols in the global symbol table. If called in a list context, C<getsym>
5f05dabc
PP
219returns a two-element list, whose first element is the value of the symbol, and
220whose second element is the string 'GLOBAL' or 'LOCAL', indicating the table
221from which the symbol's value was read.
222
223=item setsym
224
225The first two arguments taken by this method are the name of the symbol and the
226value which should be assigned to it. The optional third argument is a string
227specifying the symbol table to be used; 'GLOBAL' specifies the global symbol
228table, and any other string specifies the local symbol table. If this argument
229is omitted, the default symbol table for the object is used. C<setsym> returns
230TRUE if successful, and FALSE otherwise.
231
232=item delsym
233
234This method deletes the symbol whose name is given as the first argument. The
235optional second argument specifies the symbol table, as described above under
236C<setsym>. It returns TRUE if the symbol was successfully deleted, and FALSE
237if it was not.
238
239=item clearcache
240
241Because of the overhead associated with obtaining the list of defined symbols
242for the tied hash iterator, it is only done once, and the list is reused for
243subsequent iterations. Changes to symbols made through this package are
244recorded, but in the rare event that someone changes the process' symbol table
245from outside (as is possible using some software from the net), the iterator
246will be out of sync with the symbol table. If you expect this to happen, you
247can reset the cache by calling this method. In addition, if you pass a FALSE
248value as the first argument, caching will be disabled. It can be reenabled
249later by calling C<clearcache> again with a TRUE value as the first argument.
250It returns TRUE or FALSE to indicate whether caching was previously enabled or
251disabled, respectively.
252
253This method is a stopgap until we can incorporate code into this extension to
254traverse the process' symbol table directly, so it may disappear in a future
255version of this package.
256
4ac9195f
MS
257=back
258
5f05dabc
PP
259=head1 AUTHOR
260
bd3fa61c 261Charles Bailey bailey@newman.upenn.edu
5f05dabc
PP
262
263=head1 VERSION
264
2651.01 08-Dec-1996
266
267=head1 BUGS
268
269The list of symbols for the iterator is assembled by spawning off a
270subprocess, which can be slow. Ideally, we should just traverse the
271process' symbol table directly from C.
272