projects / OpenSPARC-T2-DV / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Hash::Util.3
CommitLineData
86530b38
AT		 1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "Hash::Util 3"
132.TH Hash::Util 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
133.SH "NAME"
134Hash::Util \- A selection of general\-utility hash subroutines
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 3
138\& use Hash::Util qw(lock_keys unlock_keys
139\& lock_value unlock_value
140\& lock_hash unlock_hash);
141.Ve
142.PP
143.Vb 4
144\& %hash = (foo => 42, bar => 23);
145\& lock_keys(%hash);
146\& lock_keys(%hash, @keyset);
147\& unlock_keys(%hash);
148.Ve
149.PP
150.Vb 2
151\& lock_value (%hash, 'foo');
152\& unlock_value(%hash, 'foo');
153.Ve
154.PP
155.Vb 2
156\& lock_hash (%hash);
157\& unlock_hash(%hash);
158.Ve
159.SH "DESCRIPTION"
160.IX Header "DESCRIPTION"
161\&\f(CW\*(C`Hash::Util\*(C'\fR contains special functions for manipulating hashes that
162don't really warrant a keyword.
163.PP
164By default \f(CW\*(C`Hash::Util\*(C'\fR does not export anything.
165.Sh "Restricted hashes"
166.IX Subsection "Restricted hashes"
1675.8.0 introduces the ability to restrict a hash to a certain set of
168keys. No keys outside of this set can be added. It also introduces
169the ability to lock an individual key so it cannot be deleted and the
170value cannot be changed.
171.PP
172This is intended to largely replace the deprecated pseudo\-hashes.
173.IP "lock_keys" 4
174.IX Item "lock_keys"
175.PD 0
176.IP "unlock_keys" 4
177.IX Item "unlock_keys"
178.PD
179.Vb 2
180\& lock_keys(%hash);
181\& lock_keys(%hash, @keys);
182.Ve
183.Sp
184Restricts the given \f(CW%hash\fR's set of keys to \f(CW@keys\fR. If \f(CW@keys\fR is not
185given it restricts it to its current keyset. No more keys can be
186added. \fIdelete()\fR and \fIexists()\fR will still work, but it does not effect
187the set of allowed keys.
188.Sp
189.Vb 1
190\& unlock_keys(%hash;)
191.Ve
192.Sp
193Removes the restriction on the \f(CW%hash\fR's keyset.
194.IP "lock_value" 4
195.IX Item "lock_value"
196.PD 0
197.IP "unlock_value" 4
198.IX Item "unlock_value"
199.PD
200.Vb 2
201\& lock_key (%hash, $key);
202\& unlock_key(%hash, $key);
203.Ve
204.Sp
205Locks and unlocks an individual key of a hash. The value of a locked
206key cannot be changed.
207.Sp
208%hash must have already been locked for this to have useful effect.
209.IP "\fBlock_hash\fR" 4
210.IX Item "lock_hash"
211.PD 0
212.IP "\fBunlock_hash\fR" 4
213.IX Item "unlock_hash"
214.PD
215.Vb 1
216\& lock_hash(%hash);
217.Ve
218.Sp
219\&\fIlock_hash()\fR locks an entire hash, making all keys and values readonly.
220No value can be changed, no keys can be added or deleted.
221.Sp
222.Vb 1
223\& unlock_hash(%hash);
224.Ve
225.Sp
226\&\fIunlock_hash()\fR does the opposite of \fIlock_hash()\fR. All keys and values
227are made read/write. All values can be changed and keys can be added
228and deleted.
229.SH "AUTHOR"
230.IX Header "AUTHOR"
231Michael G Schwern <schwern@pobox.com> on top of code by Nick
232Ing-Simmons and Jeffrey Friedl.
233.SH "SEE ALSO"
234.IX Header "SEE ALSO"
235Scalar::Util, List::Util, Hash::Util
Full OpenSPARC design & verification tarball including full HDL.