Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
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 "Encode::Encoder 3" | |
132 | .TH Encode::Encoder 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide" | |
133 | .SH "NAME" | |
134 | Encode::Encoder \-\- Object Oriented Encoder | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 14 | |
138 | \& use Encode::Encoder; | |
139 | \& # Encode::encode("ISO-8859-1", $data); | |
140 | \& Encode::Encoder->new($data)->iso_8859_1; # OOP way | |
141 | \& # shortcut | |
142 | \& use Encode::Encoder qw(encoder); | |
143 | \& encoder($data)->iso_8859_1; | |
144 | \& # you can stack them! | |
145 | \& encoder($data)->iso_8859_1->base64; # provided base64() is defined | |
146 | \& # you can use it as a decoder as well | |
147 | \& encoder($base64)->bytes('base64')->latin1; | |
148 | \& # stringified | |
149 | \& print encoder($data)->utf8->latin1; # prints the string in latin1 | |
150 | \& # numified | |
151 | \& encoder("\ex{abcd}\ex{ef}g")->utf8 == 6; # true. bytes::length($data) | |
152 | .Ve | |
153 | .SH "ABSTRACT" | |
154 | .IX Header "ABSTRACT" | |
155 | \&\fBEncode::Encoder\fR allows you to use Encode in an object-oriented | |
156 | style. This is not only more intuitive than a functional approach, | |
157 | but also handier when you want to stack encodings. Suppose you want | |
158 | your \s-1UTF\-8\s0 string converted to Latin1 then Base64: you can simply say | |
159 | .PP | |
160 | .Vb 1 | |
161 | \& my $base64 = encoder($utf8)->latin1->base64; | |
162 | .Ve | |
163 | .PP | |
164 | instead of | |
165 | .PP | |
166 | .Vb 2 | |
167 | \& my $latin1 = encode("latin1", $utf8); | |
168 | \& my $base64 = encode_base64($utf8); | |
169 | .Ve | |
170 | .PP | |
171 | or the lazier and more convoluted | |
172 | .PP | |
173 | .Vb 1 | |
174 | \& my $base64 = encode_base64(encode("latin1", $utf8)); | |
175 | .Ve | |
176 | .SH "Description" | |
177 | .IX Header "Description" | |
178 | Here is how to use this module. | |
179 | .IP "\(bu" 4 | |
180 | There are at least two instance variables stored in a hash reference, | |
181 | {data} and {encoding}. | |
182 | .IP "\(bu" 4 | |
183 | When there is no method, it takes the method name as the name of the | |
184 | encoding and encodes the instance \fIdata\fR with \fIencoding\fR. If successful, | |
185 | the instance \fIencoding\fR is set accordingly. | |
186 | .IP "\(bu" 4 | |
187 | You can retrieve the result via \->data but usually you don't have to | |
188 | because the stringify operator ("") is overridden to do exactly that. | |
189 | .Sh "Predefined Methods" | |
190 | .IX Subsection "Predefined Methods" | |
191 | This module predefines the methods below: | |
192 | .ie n .IP "$e = Encode::Encoder\->new([$data, $encoding]);" 4 | |
193 | .el .IP "$e = Encode::Encoder\->new([$data, \f(CW$encoding\fR]);" 4 | |
194 | .IX Item "$e = Encode::Encoder->new([$data, $encoding]);" | |
195 | returns an encoder object. Its data is initialized with \f(CW$data\fR if | |
196 | present, and its encoding is set to \f(CW$encoding\fR if present. | |
197 | .Sp | |
198 | When \f(CW$encoding\fR is omitted, it defaults to utf8 if \f(CW$data\fR is already in | |
199 | utf8 or "" (empty string) otherwise. | |
200 | .IP "\fIencoder()\fR" 4 | |
201 | .IX Item "encoder()" | |
202 | is an alias of Encode::Encoder\->\fInew()\fR. This one is exported on demand. | |
203 | .IP "$e\->data([$data])" 4 | |
204 | .IX Item "$e->data([$data])" | |
205 | When \f(CW$data\fR is present, sets the instance data to \f(CW$data\fR and returns the | |
206 | object itself. Otherwise, the current instance data is returned. | |
207 | .IP "$e\->encoding([$encoding])" 4 | |
208 | .IX Item "$e->encoding([$encoding])" | |
209 | When \f(CW$encoding\fR is present, sets the instance encoding to \f(CW$encoding\fR and | |
210 | returns the object itself. Otherwise, the current instance encoding is | |
211 | returned. | |
212 | .IP "$e\->bytes([$encoding])" 4 | |
213 | .IX Item "$e->bytes([$encoding])" | |
214 | decodes instance data from \f(CW$encoding\fR, or the instance encoding if | |
215 | omitted. If the conversion is successful, the instance encoding | |
216 | will be set to "". | |
217 | .Sp | |
218 | The name \fIbytes\fR was deliberately picked to avoid namespace tainting | |
219 | \&\*(-- this module may be used as a base class so method names that appear | |
220 | in Encode::Encoding are avoided. | |
221 | .Sh "Example: base64 transcoder" | |
222 | .IX Subsection "Example: base64 transcoder" | |
223 | This module is designed to work with Encode::Encoding. | |
224 | To make the Base64 transcoder example above really work, you could | |
225 | write a module like this: | |
226 | .PP | |
227 | .Vb 14 | |
228 | \& package Encode::Base64; | |
229 | \& use base 'Encode::Encoding'; | |
230 | \& __PACKAGE__->Define('base64'); | |
231 | \& use MIME::Base64; | |
232 | \& sub encode{ | |
233 | \& my ($obj, $data) = @_; | |
234 | \& return encode_base64($data); | |
235 | \& } | |
236 | \& sub decode{ | |
237 | \& my ($obj, $data) = @_; | |
238 | \& return decode_base64($data); | |
239 | \& } | |
240 | \& 1; | |
241 | \& __END__ | |
242 | .Ve | |
243 | .PP | |
244 | And your caller module would be something like this: | |
245 | .PP | |
246 | .Vb 2 | |
247 | \& use Encode::Encoder; | |
248 | \& use Encode::Base64; | |
249 | .Ve | |
250 | .PP | |
251 | .Vb 1 | |
252 | \& # now you can really do the following | |
253 | .Ve | |
254 | .PP | |
255 | .Vb 2 | |
256 | \& encoder($data)->iso_8859_1->base64; | |
257 | \& encoder($base64)->bytes('base64')->latin1; | |
258 | .Ve | |
259 | .Sh "Operator Overloading" | |
260 | .IX Subsection "Operator Overloading" | |
261 | This module overloads two operators, stringify ("") and numify (0+). | |
262 | .PP | |
263 | Stringify dumps the data inside the object. | |
264 | .PP | |
265 | Numify returns the number of bytes in the instance data. | |
266 | .PP | |
267 | They come in handy when you want to print or find the size of data. | |
268 | .SH "SEE ALSO" | |
269 | .IX Header "SEE ALSO" | |
270 | Encode, | |
271 | Encode::Encoding |