Commit | Line | Data |
---|---|---|
694468e3 GS |
1 | =head1 NAME |
2 | ||
3 | perlboot - Beginner's Object-Oriented Tutorial | |
4 | ||
5 | =head1 DESCRIPTION | |
6 | ||
7 | If you're not familiar with objects from other languages, some of the | |
8 | other Perl object documentation may be a little daunting, such as | |
9 | L<perlobj>, a basic reference in using objects, and L<perltoot>, which | |
dbe48302 | 10 | introduces readers to the peculiarities of Perl's object system in a |
694468e3 GS |
11 | tutorial way. |
12 | ||
13 | So, let's take a different approach, presuming no prior object | |
14 | experience. It helps if you know about subroutines (L<perlsub>), | |
15 | references (L<perlref> et. seq.), and packages (L<perlmod>), so become | |
16 | familiar with those first if you haven't already. | |
17 | ||
18 | =head2 If we could talk to the animals... | |
19 | ||
20 | Let's let the animals talk for a moment: | |
21 | ||
22 | sub Cow::speak { | |
23 | print "a Cow goes moooo!\n"; | |
24 | } | |
25 | sub Horse::speak { | |
26 | print "a Horse goes neigh!\n"; | |
27 | } | |
28 | sub Sheep::speak { | |
bb32c4e1 | 29 | print "a Sheep goes baaaah!\n"; |
694468e3 GS |
30 | } |
31 | ||
32 | Cow::speak; | |
33 | Horse::speak; | |
34 | Sheep::speak; | |
35 | ||
36 | This results in: | |
37 | ||
38 | a Cow goes moooo! | |
39 | a Horse goes neigh! | |
40 | a Sheep goes baaaah! | |
41 | ||
42 | Nothing spectacular here. Simple subroutines, albeit from separate | |
43 | packages, and called using the full package name. So let's create | |
44 | an entire pasture: | |
45 | ||
46 | # Cow::speak, Horse::speak, Sheep::speak as before | |
84f709e7 JH |
47 | @pasture = qw(Cow Cow Horse Sheep Sheep); |
48 | foreach $animal (@pasture) { | |
694468e3 GS |
49 | &{$animal."::speak"}; |
50 | } | |
51 | ||
52 | This results in: | |
53 | ||
54 | a Cow goes moooo! | |
55 | a Cow goes moooo! | |
56 | a Horse goes neigh! | |
57 | a Sheep goes baaaah! | |
58 | a Sheep goes baaaah! | |
59 | ||
60 | Wow. That symbolic coderef de-referencing there is pretty nasty. | |
074a7adc | 61 | We're counting on C<no strict refs> mode, certainly not recommended |
84f709e7 JH |
62 | for larger programs. And why was that necessary? Because the name of |
63 | the package seems to be inseparable from the name of the subroutine we | |
64 | want to invoke within that package. | |
694468e3 GS |
65 | |
66 | Or is it? | |
67 | ||
68 | =head2 Introducing the method invocation arrow | |
69 | ||
c47ff5f1 | 70 | For now, let's say that C<< Class->method >> invokes subroutine |
694468e3 GS |
71 | C<method> in package C<Class>. (Here, "Class" is used in its |
72 | "category" meaning, not its "scholastic" meaning.) That's not | |
73 | completely accurate, but we'll do this one step at a time. Now let's | |
74 | use it like so: | |
75 | ||
76 | # Cow::speak, Horse::speak, Sheep::speak as before | |
77 | Cow->speak; | |
78 | Horse->speak; | |
79 | Sheep->speak; | |
80 | ||
81 | And once again, this results in: | |
82 | ||
83 | a Cow goes moooo! | |
84 | a Horse goes neigh! | |
85 | a Sheep goes baaaah! | |
86 | ||
87 | That's not fun yet. Same number of characters, all constant, no | |
88 | variables. But yet, the parts are separable now. Watch: | |
89 | ||
84f709e7 | 90 | $a = "Cow"; |
694468e3 GS |
91 | $a->speak; # invokes Cow->speak |
92 | ||
93 | Ahh! Now that the package name has been parted from the subroutine | |
94 | name, we can use a variable package name. And this time, we've got | |
84f709e7 | 95 | something that works even when C<use strict refs> is enabled. |
694468e3 GS |
96 | |
97 | =head2 Invoking a barnyard | |
98 | ||
99 | Let's take that new arrow invocation and put it back in the barnyard | |
100 | example: | |
101 | ||
102 | sub Cow::speak { | |
103 | print "a Cow goes moooo!\n"; | |
104 | } | |
105 | sub Horse::speak { | |
106 | print "a Horse goes neigh!\n"; | |
107 | } | |
108 | sub Sheep::speak { | |
bb32c4e1 | 109 | print "a Sheep goes baaaah!\n"; |
694468e3 GS |
110 | } |
111 | ||
84f709e7 JH |
112 | @pasture = qw(Cow Cow Horse Sheep Sheep); |
113 | foreach $animal (@pasture) { | |
694468e3 GS |
114 | $animal->speak; |
115 | } | |
116 | ||
117 | There! Now we have the animals all talking, and safely at that, | |
118 | without the use of symbolic coderefs. | |
119 | ||
120 | But look at all that common code. Each of the C<speak> routines has a | |
121 | similar structure: a C<print> operator and a string that contains | |
122 | common text, except for two of the words. It'd be nice if we could | |
123 | factor out the commonality, in case we decide later to change it all | |
124 | to C<says> instead of C<goes>. | |
125 | ||
126 | And we actually have a way of doing that without much fuss, but we | |
127 | have to hear a bit more about what the method invocation arrow is | |
128 | actually doing for us. | |
129 | ||
130 | =head2 The extra parameter of method invocation | |
131 | ||
132 | The invocation of: | |
133 | ||
134 | Class->method(@args) | |
135 | ||
136 | attempts to invoke subroutine C<Class::method> as: | |
137 | ||
138 | Class::method("Class", @args); | |
139 | ||
140 | (If the subroutine can't be found, "inheritance" kicks in, but we'll | |
141 | get to that later.) This means that we get the class name as the | |
dbe48302 GS |
142 | first parameter (the only parameter, if no arguments are given). So |
143 | we can rewrite the C<Sheep> speaking subroutine as: | |
694468e3 GS |
144 | |
145 | sub Sheep::speak { | |
146 | my $class = shift; | |
147 | print "a $class goes baaaah!\n"; | |
148 | } | |
149 | ||
150 | And the other two animals come out similarly: | |
151 | ||
152 | sub Cow::speak { | |
153 | my $class = shift; | |
154 | print "a $class goes moooo!\n"; | |
155 | } | |
156 | sub Horse::speak { | |
157 | my $class = shift; | |
158 | print "a $class goes neigh!\n"; | |
159 | } | |
160 | ||
161 | In each case, C<$class> will get the value appropriate for that | |
162 | subroutine. But once again, we have a lot of similar structure. Can | |
163 | we factor that out even further? Yes, by calling another method in | |
164 | the same class. | |
165 | ||
166 | =head2 Calling a second method to simplify things | |
167 | ||
168 | Let's call out from C<speak> to a helper method called C<sound>. | |
169 | This method provides the constant text for the sound itself. | |
170 | ||
84f709e7 | 171 | { package Cow; |
694468e3 GS |
172 | sub sound { "moooo" } |
173 | sub speak { | |
549d696a MW |
174 | my $class = shift; |
175 | print "a $class goes ", $class->sound, "!\n"; | |
694468e3 GS |
176 | } |
177 | } | |
178 | ||
c47ff5f1 GS |
179 | Now, when we call C<< Cow->speak >>, we get a C<$class> of C<Cow> in |
180 | C<speak>. This in turn selects the C<< Cow->sound >> method, which | |
694468e3 GS |
181 | returns C<moooo>. But how different would this be for the C<Horse>? |
182 | ||
84f709e7 | 183 | { package Horse; |
694468e3 GS |
184 | sub sound { "neigh" } |
185 | sub speak { | |
549d696a MW |
186 | my $class = shift; |
187 | print "a $class goes ", $class->sound, "!\n"; | |
694468e3 GS |
188 | } |
189 | } | |
190 | ||
191 | Only the name of the package and the specific sound change. So can we | |
192 | somehow share the definition for C<speak> between the Cow and the | |
193 | Horse? Yes, with inheritance! | |
194 | ||
195 | =head2 Inheriting the windpipes | |
196 | ||
197 | We'll define a common subroutine package called C<Animal>, with the | |
198 | definition for C<speak>: | |
199 | ||
84f709e7 | 200 | { package Animal; |
694468e3 | 201 | sub speak { |
549d696a MW |
202 | my $class = shift; |
203 | print "a $class goes ", $class->sound, "!\n"; | |
694468e3 GS |
204 | } |
205 | } | |
206 | ||
207 | Then, for each animal, we say it "inherits" from C<Animal>, along | |
208 | with the animal-specific sound: | |
209 | ||
84f709e7 | 210 | { package Cow; |
694468e3 GS |
211 | @ISA = qw(Animal); |
212 | sub sound { "moooo" } | |
213 | } | |
214 | ||
4dfdcbc9 | 215 | Note the added C<@ISA> array (pronounced "is a"). We'll get to that in a minute. |
694468e3 | 216 | |
c47ff5f1 | 217 | But what happens when we invoke C<< Cow->speak >> now? |
694468e3 GS |
218 | |
219 | First, Perl constructs the argument list. In this case, it's just | |
220 | C<Cow>. Then Perl looks for C<Cow::speak>. But that's not there, so | |
221 | Perl checks for the inheritance array C<@Cow::ISA>. It's there, | |
222 | and contains the single name C<Animal>. | |
223 | ||
224 | Perl next checks for C<speak> inside C<Animal> instead, as in | |
225 | C<Animal::speak>. And that's found, so Perl invokes that subroutine | |
226 | with the already frozen argument list. | |
227 | ||
228 | Inside the C<Animal::speak> subroutine, C<$class> becomes C<Cow> (the | |
229 | first argument). So when we get to the step of invoking | |
c47ff5f1 | 230 | C<< $class->sound >>, it'll be looking for C<< Cow->sound >>, which |
694468e3 GS |
231 | gets it on the first try without looking at C<@ISA>. Success! |
232 | ||
233 | =head2 A few notes about @ISA | |
234 | ||
4dfdcbc9 MW |
235 | This magical C<@ISA> variable has declared that C<Cow> "is a" C<Animal>. |
236 | Note that it's an array, not a simple single value, because on rare | |
237 | occasions, it makes sense to have more than one parent class searched | |
238 | for the missing methods. | |
694468e3 GS |
239 | |
240 | If C<Animal> also had an C<@ISA>, then we'd check there too. The | |
dd69841b BB |
241 | search is recursive, depth-first, left-to-right in each C<@ISA> by |
242 | default (see L<mro> for alternatives). Typically, each C<@ISA> has | |
243 | only one element (multiple elements means multiple inheritance and | |
244 | multiple headaches), so we get a nice tree of inheritance. | |
694468e3 GS |
245 | |
246 | When we turn on C<use strict>, we'll get complaints on C<@ISA>, since | |
247 | it's not a variable containing an explicit package name, nor is it a | |
dbe48302 GS |
248 | lexical ("my") variable. We can't make it a lexical variable though |
249 | (it has to belong to the package to be found by the inheritance mechanism), | |
694468e3 GS |
250 | so there's a couple of straightforward ways to handle that. |
251 | ||
252 | The easiest is to just spell the package name out: | |
253 | ||
254 | @Cow::ISA = qw(Animal); | |
255 | ||
016e9c56 RGS |
256 | Or declare it as package global variable: |
257 | ||
258 | package Cow; | |
259 | our @ISA = qw(Animal); | |
260 | ||
dbe48302 | 261 | Or allow it as an implicitly named package variable: |
694468e3 GS |
262 | |
263 | package Cow; | |
84f709e7 JH |
264 | use vars qw(@ISA); |
265 | @ISA = qw(Animal); | |
694468e3 | 266 | |
2ee409f9 MW |
267 | If the C<Animal> class comes from another (object-oriented) module, then |
268 | just employ C<use base> to specify that C<Animal> should serve as the basis | |
269 | for the C<Cow> class: | |
694468e3 GS |
270 | |
271 | package Cow; | |
272 | use base qw(Animal); | |
273 | ||
2ee409f9 | 274 | Now that's pretty darn simple! |
694468e3 GS |
275 | |
276 | =head2 Overriding the methods | |
277 | ||
278 | Let's add a mouse, which can barely be heard: | |
279 | ||
84f709e7 JH |
280 | # Animal package from before |
281 | { package Mouse; | |
282 | @ISA = qw(Animal); | |
694468e3 GS |
283 | sub sound { "squeak" } |
284 | sub speak { | |
285 | my $class = shift; | |
549d696a MW |
286 | print "a $class goes ", $class->sound, "!\n"; |
287 | print "[but you can barely hear it!]\n"; | |
694468e3 GS |
288 | } |
289 | } | |
290 | ||
291 | Mouse->speak; | |
292 | ||
293 | which results in: | |
294 | ||
295 | a Mouse goes squeak! | |
296 | [but you can barely hear it!] | |
297 | ||
c47ff5f1 | 298 | Here, C<Mouse> has its own speaking routine, so C<< Mouse->speak >> |
c98e0e85 MW |
299 | doesn't immediately invoke C<< Animal->speak >>. This is known as |
300 | "overriding". In fact, we don't even need to say that a C<Mouse> is | |
301 | an C<Animal> at all, because all of the methods needed for C<speak> are | |
302 | completely defined for C<Mouse>; this is known as "duck typing": | |
303 | "If it walks like a duck and quacks like a duck, I would call it a duck" | |
304 | (James Whitcomb). However, it would probably be beneficial to allow a | |
305 | closer examination to conclude that a C<Mouse> is indeed an C<Animal>, | |
306 | so it is actually better to define C<Mouse> with C<Animal> as its base | |
307 | (that is, it is better to "derive C<Mouse> from C<Animal>"). | |
308 | ||
309 | Moreover, this duplication of code could become a maintenance headache | |
310 | (though code-reuse is not actually a good reason for inheritance; good | |
311 | design practices dictate that a derived class should be usable wherever | |
312 | its base class is usable, which might not be the outcome if code-reuse | |
313 | is the sole criterion for inheritance. Just remember that a C<Mouse> | |
314 | should always act like an C<Animal>). | |
315 | ||
316 | So, let's make C<Mouse> an C<Animal>! | |
694468e3 | 317 | |
c7b05296 | 318 | The obvious solution is to invoke C<Animal::speak> directly: |
694468e3 | 319 | |
84f709e7 JH |
320 | # Animal package from before |
321 | { package Mouse; | |
322 | @ISA = qw(Animal); | |
694468e3 GS |
323 | sub sound { "squeak" } |
324 | sub speak { | |
325 | my $class = shift; | |
326 | Animal::speak($class); | |
549d696a | 327 | print "[but you can barely hear it!]\n"; |
694468e3 GS |
328 | } |
329 | } | |
330 | ||
c7b05296 MW |
331 | Note that we're using C<Animal::speak>. If we were to invoke |
332 | C<< Animal->speak >> instead, the first parameter to C<Animal::speak> | |
333 | would automatically be C<"Animal"> rather than C<"Mouse">, so that | |
334 | the call to C<< $class->sound >> in C<Animal::speak> would become | |
335 | C<< Animal->sound >> rather than C<< Mouse->sound >>. | |
336 | ||
337 | Also, without the method arrow C<< -> >>, it becomes necessary to specify | |
338 | the first parameter to C<Animal::speak> ourselves, which is why C<$class> | |
339 | is explicitly passed: C<Animal::speak($class)>. | |
340 | ||
341 | However, invoking C<Animal::speak> directly is a mess: Firstly, it assumes | |
342 | that the C<speak> method is a member of the C<Animal> class; what if C<Animal> | |
343 | actually inherits C<speak> from its own base? Because we are no longer using | |
344 | C<< -> >> to access C<speak>, the special method look up mechanism wouldn't be | |
345 | used, so C<speak> wouldn't even be found! | |
346 | ||
347 | The second problem is more subtle: C<Animal> is now hardwired into the subroutine | |
348 | selection. Let's assume that C<Animal::speak> does exist. What happens when, | |
349 | at a later time, someone expands the class hierarchy by having C<Mouse> | |
350 | inherit from C<Mus> instead of C<Animal>. Unless the invocation of C<Animal::speak> | |
351 | is also changed to an invocation of C<Mus::speak>, centuries worth of taxonomical | |
352 | classification could be obliterated! | |
353 | ||
354 | What we have here is a fragile or leaky abstraction; it is the beginning of a | |
355 | maintenance nightmare. What we need is the ability to search for the right | |
356 | method wih as few assumptions as possible. | |
694468e3 GS |
357 | |
358 | =head2 Starting the search from a different place | |
359 | ||
c7b05296 MW |
360 | A I<better> solution is to tell Perl where in the inheritance chain to begin searching |
361 | for C<speak>. This can be achieved with a modified version of the method arrow C<< -> >>: | |
362 | ||
363 | ClassName->FirstPlaceToLook::method | |
364 | ||
365 | So, the improved C<Mouse> class is: | |
694468e3 GS |
366 | |
367 | # same Animal as before | |
84f709e7 | 368 | { package Mouse; |
694468e3 GS |
369 | # same @ISA, &sound as before |
370 | sub speak { | |
371 | my $class = shift; | |
372 | $class->Animal::speak; | |
373 | print "[but you can barely hear it!]\n"; | |
374 | } | |
375 | } | |
376 | ||
c7b05296 MW |
377 | Using this syntax, we start with C<Animal> to find C<speak>, and then |
378 | use all of C<Animal>'s inheritance chain if it is not found immediately. | |
379 | As usual, the first parameter to C<speak> would be C<$class>, so we no | |
380 | longer need to pass C<$class> explicitly to C<speak>. | |
694468e3 | 381 | |
c7b05296 MW |
382 | But what about the second problem? We're still hardwiring C<Animal> into |
383 | the method lookup. | |
694468e3 GS |
384 | |
385 | =head2 The SUPER way of doing things | |
386 | ||
c7b05296 MW |
387 | If C<Animal> is replaced with the special placeholder C<SUPER> in that |
388 | invocation, then the contents of C<Mouse>'s C<@ISA> are used for the | |
389 | search, beginning with C<$ISA[0]>. So, all of the problems can be fixed | |
390 | as follows: | |
694468e3 GS |
391 | |
392 | # same Animal as before | |
84f709e7 | 393 | { package Mouse; |
694468e3 GS |
394 | # same @ISA, &sound as before |
395 | sub speak { | |
396 | my $class = shift; | |
397 | $class->SUPER::speak; | |
398 | print "[but you can barely hear it!]\n"; | |
399 | } | |
400 | } | |
401 | ||
c7b05296 MW |
402 | In general, C<SUPER::speak> means look in the current package's C<@ISA> |
403 | for a class that implements C<speak>, and invoke the first one found. | |
404 | The placeholder is called C<SUPER>, because many other languages refer | |
405 | to base classes as "I<super>classes", and Perl likes to be eclectic. | |
406 | ||
407 | Note that a call such as | |
408 | ||
409 | $class->SUPER::method; | |
410 | ||
411 | does I<not> look in the C<@ISA> of C<$class> unless C<$class> happens to | |
412 | be the current package. | |
694468e3 | 413 | |
507fa6a5 | 414 | =head2 Let's review... |
694468e3 GS |
415 | |
416 | So far, we've seen the method arrow syntax: | |
417 | ||
418 | Class->method(@args); | |
419 | ||
420 | or the equivalent: | |
421 | ||
84f709e7 | 422 | $a = "Class"; |
694468e3 GS |
423 | $a->method(@args); |
424 | ||
425 | which constructs an argument list of: | |
426 | ||
427 | ("Class", @args) | |
428 | ||
429 | and attempts to invoke | |
430 | ||
507fa6a5 | 431 | Class::method("Class", @args); |
694468e3 GS |
432 | |
433 | However, if C<Class::method> is not found, then C<@Class::ISA> is examined | |
434 | (recursively) to locate a package that does indeed contain C<method>, | |
435 | and that subroutine is invoked instead. | |
436 | ||
507fa6a5 MW |
437 | Using this simple syntax, we have class methods, (multiple) inheritance, |
438 | overriding, and extending. Using just what we've seen so far, we've | |
439 | been able to factor out common code (though that's never a good reason | |
440 | for inheritance!), and provide a nice way to reuse implementations with | |
441 | variations. | |
442 | ||
443 | Now, what about data? | |
694468e3 GS |
444 | |
445 | =head2 A horse is a horse, of course of course -- or is it? | |
446 | ||
447 | Let's start with the code for the C<Animal> class | |
448 | and the C<Horse> class: | |
449 | ||
84f709e7 | 450 | { package Animal; |
694468e3 GS |
451 | sub speak { |
452 | my $class = shift; | |
bb32c4e1 | 453 | print "a $class goes ", $class->sound, "!\n"; |
694468e3 GS |
454 | } |
455 | } | |
84f709e7 JH |
456 | { package Horse; |
457 | @ISA = qw(Animal); | |
694468e3 GS |
458 | sub sound { "neigh" } |
459 | } | |
460 | ||
c47ff5f1 | 461 | This lets us invoke C<< Horse->speak >> to ripple upward to |
694468e3 GS |
462 | C<Animal::speak>, calling back to C<Horse::sound> to get the specific |
463 | sound, and the output of: | |
464 | ||
465 | a Horse goes neigh! | |
466 | ||
467 | But all of our Horse objects would have to be absolutely identical. | |
468 | If I add a subroutine, all horses automatically share it. That's | |
469 | great for making horses the same, but how do we capture the | |
470 | distinctions about an individual horse? For example, suppose I want | |
471 | to give my first horse a name. There's got to be a way to keep its | |
472 | name separate from the other horses. | |
473 | ||
474 | We can do that by drawing a new distinction, called an "instance". | |
475 | An "instance" is generally created by a class. In Perl, any reference | |
476 | can be an instance, so let's start with the simplest reference | |
477 | that can hold a horse's name: a scalar reference. | |
478 | ||
84f709e7 | 479 | my $name = "Mr. Ed"; |
694468e3 GS |
480 | my $talking = \$name; |
481 | ||
482 | So now C<$talking> is a reference to what will be the instance-specific | |
483 | data (the name). The final step in turning this into a real instance | |
484 | is with a special operator called C<bless>: | |
485 | ||
486 | bless $talking, Horse; | |
487 | ||
488 | This operator stores information about the package named C<Horse> into | |
489 | the thing pointed at by the reference. At this point, we say | |
490 | C<$talking> is an instance of C<Horse>. That is, it's a specific | |
491 | horse. The reference is otherwise unchanged, and can still be used | |
492 | with traditional dereferencing operators. | |
493 | ||
494 | =head2 Invoking an instance method | |
495 | ||
496 | The method arrow can be used on instances, as well as names of | |
497 | packages (classes). So, let's get the sound that C<$talking> makes: | |
498 | ||
499 | my $noise = $talking->sound; | |
500 | ||
501 | To invoke C<sound>, Perl first notes that C<$talking> is a blessed | |
502 | reference (and thus an instance). It then constructs an argument | |
503 | list, in this case from just C<($talking)>. (Later we'll see that | |
504 | arguments will take their place following the instance variable, | |
505 | just like with classes.) | |
506 | ||
507 | Now for the fun part: Perl takes the class in which the instance was | |
508 | blessed, in this case C<Horse>, and uses that to locate the subroutine | |
509 | to invoke the method. In this case, C<Horse::sound> is found directly | |
510 | (without using inheritance), yielding the final subroutine invocation: | |
511 | ||
512 | Horse::sound($talking) | |
513 | ||
514 | Note that the first parameter here is still the instance, not the name | |
515 | of the class as before. We'll get C<neigh> as the return value, and | |
516 | that'll end up as the C<$noise> variable above. | |
517 | ||
518 | If Horse::sound had not been found, we'd be wandering up the | |
519 | C<@Horse::ISA> list to try to find the method in one of the | |
520 | superclasses, just as for a class method. The only difference between | |
521 | a class method and an instance method is whether the first parameter | |
dbe48302 | 522 | is an instance (a blessed reference) or a class name (a string). |
694468e3 GS |
523 | |
524 | =head2 Accessing the instance data | |
525 | ||
526 | Because we get the instance as the first parameter, we can now access | |
527 | the instance-specific data. In this case, let's add a way to get at | |
528 | the name: | |
529 | ||
84f709e7 JH |
530 | { package Horse; |
531 | @ISA = qw(Animal); | |
694468e3 GS |
532 | sub sound { "neigh" } |
533 | sub name { | |
534 | my $self = shift; | |
535 | $$self; | |
536 | } | |
537 | } | |
c47ff5f1 | 538 | |
694468e3 GS |
539 | Now we call for the name: |
540 | ||
541 | print $talking->name, " says ", $talking->sound, "\n"; | |
542 | ||
543 | Inside C<Horse::name>, the C<@_> array contains just C<$talking>, | |
544 | which the C<shift> stores into C<$self>. (It's traditional to shift | |
545 | the first parameter off into a variable named C<$self> for instance | |
546 | methods, so stay with that unless you have strong reasons otherwise.) | |
547 | Then, C<$self> gets de-referenced as a scalar ref, yielding C<Mr. Ed>, | |
548 | and we're done with that. The result is: | |
549 | ||
550 | Mr. Ed says neigh. | |
551 | ||
552 | =head2 How to build a horse | |
553 | ||
554 | Of course, if we constructed all of our horses by hand, we'd most | |
555 | likely make mistakes from time to time. We're also violating one of | |
556 | the properties of object-oriented programming, in that the "inside | |
557 | guts" of a Horse are visible. That's good if you're a veterinarian, | |
558 | but not if you just like to own horses. So, let's let the Horse class | |
559 | build a new horse: | |
560 | ||
84f709e7 JH |
561 | { package Horse; |
562 | @ISA = qw(Animal); | |
694468e3 GS |
563 | sub sound { "neigh" } |
564 | sub name { | |
565 | my $self = shift; | |
566 | $$self; | |
567 | } | |
568 | sub named { | |
569 | my $class = shift; | |
84f709e7 | 570 | my $name = shift; |
694468e3 GS |
571 | bless \$name, $class; |
572 | } | |
573 | } | |
574 | ||
575 | Now with the new C<named> method, we can build a horse: | |
576 | ||
577 | my $talking = Horse->named("Mr. Ed"); | |
578 | ||
579 | Notice we're back to a class method, so the two arguments to | |
580 | C<Horse::named> are C<Horse> and C<Mr. Ed>. The C<bless> operator | |
581 | not only blesses C<$name>, it also returns the reference to C<$name>, | |
582 | so that's fine as a return value. And that's how to build a horse. | |
583 | ||
dbe48302 GS |
584 | We've called the constructor C<named> here, so that it quickly denotes |
585 | the constructor's argument as the name for this particular C<Horse>. | |
586 | You can use different constructors with different names for different | |
587 | ways of "giving birth" to the object (like maybe recording its | |
588 | pedigree or date of birth). However, you'll find that most people | |
589 | coming to Perl from more limited languages use a single constructor | |
590 | named C<new>, with various ways of interpreting the arguments to | |
591 | C<new>. Either style is fine, as long as you document your particular | |
592 | way of giving birth to an object. (And you I<were> going to do that, | |
593 | right?) | |
594 | ||
694468e3 GS |
595 | =head2 Inheriting the constructor |
596 | ||
597 | But was there anything specific to C<Horse> in that method? No. Therefore, | |
598 | it's also the same recipe for building anything else that inherited from | |
599 | C<Animal>, so let's put it there: | |
600 | ||
84f709e7 | 601 | { package Animal; |
694468e3 GS |
602 | sub speak { |
603 | my $class = shift; | |
bb32c4e1 | 604 | print "a $class goes ", $class->sound, "!\n"; |
694468e3 GS |
605 | } |
606 | sub name { | |
607 | my $self = shift; | |
608 | $$self; | |
609 | } | |
610 | sub named { | |
611 | my $class = shift; | |
84f709e7 | 612 | my $name = shift; |
694468e3 GS |
613 | bless \$name, $class; |
614 | } | |
615 | } | |
84f709e7 JH |
616 | { package Horse; |
617 | @ISA = qw(Animal); | |
694468e3 GS |
618 | sub sound { "neigh" } |
619 | } | |
620 | ||
621 | Ahh, but what happens if we invoke C<speak> on an instance? | |
622 | ||
623 | my $talking = Horse->named("Mr. Ed"); | |
624 | $talking->speak; | |
625 | ||
626 | We get a debugging value: | |
627 | ||
628 | a Horse=SCALAR(0xaca42ac) goes neigh! | |
629 | ||
630 | Why? Because the C<Animal::speak> routine is expecting a classname as | |
631 | its first parameter, not an instance. When the instance is passed in, | |
632 | we'll end up using a blessed scalar reference as a string, and that | |
633 | shows up as we saw it just now. | |
634 | ||
635 | =head2 Making a method work with either classes or instances | |
636 | ||
637 | All we need is for a method to detect if it is being called on a class | |
638 | or called on an instance. The most straightforward way is with the | |
639 | C<ref> operator. This returns a string (the classname) when used on a | |
3e9e48b0 | 640 | blessed reference, and an empty string when used on a string (like a |
694468e3 GS |
641 | classname). Let's modify the C<name> method first to notice the change: |
642 | ||
643 | sub name { | |
644 | my $either = shift; | |
645 | ref $either | |
84f709e7 | 646 | ? $$either # it's an instance, return name |
694468e3 GS |
647 | : "an unnamed $either"; # it's a class, return generic |
648 | } | |
649 | ||
650 | Here, the C<?:> operator comes in handy to select either the | |
651 | dereference or a derived string. Now we can use this with either an | |
652 | instance or a class. Note that I've changed the first parameter | |
653 | holder to C<$either> to show that this is intended: | |
654 | ||
655 | my $talking = Horse->named("Mr. Ed"); | |
84f709e7 | 656 | print Horse->name, "\n"; # prints "an unnamed Horse\n" |
694468e3 GS |
657 | print $talking->name, "\n"; # prints "Mr Ed.\n" |
658 | ||
659 | and now we'll fix C<speak> to use this: | |
660 | ||
661 | sub speak { | |
662 | my $either = shift; | |
663 | print $either->name, " goes ", $either->sound, "\n"; | |
664 | } | |
665 | ||
666 | And since C<sound> already worked with either a class or an instance, | |
667 | we're done! | |
668 | ||
669 | =head2 Adding parameters to a method | |
670 | ||
671 | Let's train our animals to eat: | |
672 | ||
84f709e7 | 673 | { package Animal; |
694468e3 GS |
674 | sub named { |
675 | my $class = shift; | |
84f709e7 | 676 | my $name = shift; |
694468e3 GS |
677 | bless \$name, $class; |
678 | } | |
679 | sub name { | |
680 | my $either = shift; | |
681 | ref $either | |
549d696a MW |
682 | ? $$either # it's an instance, return name |
683 | : "an unnamed $either"; # it's a class, return generic | |
694468e3 GS |
684 | } |
685 | sub speak { | |
686 | my $either = shift; | |
687 | print $either->name, " goes ", $either->sound, "\n"; | |
688 | } | |
689 | sub eat { | |
690 | my $either = shift; | |
84f709e7 | 691 | my $food = shift; |
694468e3 GS |
692 | print $either->name, " eats $food.\n"; |
693 | } | |
694 | } | |
84f709e7 JH |
695 | { package Horse; |
696 | @ISA = qw(Animal); | |
694468e3 GS |
697 | sub sound { "neigh" } |
698 | } | |
84f709e7 JH |
699 | { package Sheep; |
700 | @ISA = qw(Animal); | |
694468e3 GS |
701 | sub sound { "baaaah" } |
702 | } | |
703 | ||
704 | And now try it out: | |
705 | ||
706 | my $talking = Horse->named("Mr. Ed"); | |
707 | $talking->eat("hay"); | |
708 | Sheep->eat("grass"); | |
709 | ||
710 | which prints: | |
711 | ||
712 | Mr. Ed eats hay. | |
713 | an unnamed Sheep eats grass. | |
714 | ||
715 | An instance method with parameters gets invoked with the instance, | |
716 | and then the list of parameters. So that first invocation is like: | |
717 | ||
718 | Animal::eat($talking, "hay"); | |
719 | ||
720 | =head2 More interesting instances | |
721 | ||
722 | What if an instance needs more data? Most interesting instances are | |
723 | made of many items, each of which can in turn be a reference or even | |
724 | another object. The easiest way to store these is often in a hash. | |
725 | The keys of the hash serve as the names of parts of the object (often | |
726 | called "instance variables" or "member variables"), and the | |
727 | corresponding values are, well, the values. | |
728 | ||
729 | But how do we turn the horse into a hash? Recall that an object was | |
730 | any blessed reference. We can just as easily make it a blessed hash | |
731 | reference as a blessed scalar reference, as long as everything that | |
732 | looks at the reference is changed accordingly. | |
733 | ||
734 | Let's make a sheep that has a name and a color: | |
735 | ||
84f709e7 | 736 | my $bad = bless { Name => "Evil", Color => "black" }, Sheep; |
694468e3 | 737 | |
c47ff5f1 GS |
738 | so C<< $bad->{Name} >> has C<Evil>, and C<< $bad->{Color} >> has |
739 | C<black>. But we want to make C<< $bad->name >> access the name, and | |
694468e3 GS |
740 | that's now messed up because it's expecting a scalar reference. Not |
741 | to worry, because that's pretty easy to fix up: | |
742 | ||
743 | ## in Animal | |
744 | sub name { | |
745 | my $either = shift; | |
746 | ref $either ? | |
747 | $either->{Name} : | |
748 | "an unnamed $either"; | |
749 | } | |
750 | ||
751 | And of course C<named> still builds a scalar sheep, so let's fix that | |
752 | as well: | |
753 | ||
754 | ## in Animal | |
755 | sub named { | |
756 | my $class = shift; | |
84f709e7 JH |
757 | my $name = shift; |
758 | my $self = { Name => $name, Color => $class->default_color }; | |
694468e3 GS |
759 | bless $self, $class; |
760 | } | |
761 | ||
762 | What's this C<default_color>? Well, if C<named> has only the name, | |
763 | we still need to set a color, so we'll have a class-specific initial color. | |
764 | For a sheep, we might define it as white: | |
765 | ||
766 | ## in Sheep | |
767 | sub default_color { "white" } | |
768 | ||
769 | And then to keep from having to define one for each additional class, | |
770 | we'll define a "backstop" method that serves as the "default default", | |
771 | directly in C<Animal>: | |
772 | ||
773 | ## in Animal | |
774 | sub default_color { "brown" } | |
775 | ||
776 | Now, because C<name> and C<named> were the only methods that | |
777 | referenced the "structure" of the object, the rest of the methods can | |
778 | remain the same, so C<speak> still works as before. | |
779 | ||
780 | =head2 A horse of a different color | |
781 | ||
782 | But having all our horses be brown would be boring. So let's add a | |
783 | method or two to get and set the color. | |
784 | ||
785 | ## in Animal | |
786 | sub color { | |
787 | $_[0]->{Color} | |
788 | } | |
789 | sub set_color { | |
790 | $_[0]->{Color} = $_[1]; | |
791 | } | |
792 | ||
793 | Note the alternate way of accessing the arguments: C<$_[0]> is used | |
794 | in-place, rather than with a C<shift>. (This saves us a bit of time | |
795 | for something that may be invoked frequently.) And now we can fix | |
796 | that color for Mr. Ed: | |
797 | ||
798 | my $talking = Horse->named("Mr. Ed"); | |
799 | $talking->set_color("black-and-white"); | |
800 | print $talking->name, " is colored ", $talking->color, "\n"; | |
801 | ||
802 | which results in: | |
803 | ||
804 | Mr. Ed is colored black-and-white | |
805 | ||
806 | =head2 Summary | |
807 | ||
808 | So, now we have class methods, constructors, instance methods, | |
809 | instance data, and even accessors. But that's still just the | |
810 | beginning of what Perl has to offer. We haven't even begun to talk | |
811 | about accessors that double as getters and setters, destructors, | |
812 | indirect object notation, subclasses that add instance data, per-class | |
813 | data, overloading, "isa" and "can" tests, C<UNIVERSAL> class, and so | |
814 | on. That's for the rest of the Perl documentation to cover. | |
815 | Hopefully, this gets you started, though. | |
816 | ||
817 | =head1 SEE ALSO | |
818 | ||
819 | For more information, see L<perlobj> (for all the gritty details about | |
820 | Perl objects, now that you've seen the basics), L<perltoot> (the | |
890a53b9 | 821 | tutorial for those who already know objects), L<perltooc> (dealing |
8257a158 MS |
822 | with class data), L<perlbot> (for some more tricks), and books such as |
823 | Damian Conway's excellent I<Object Oriented Perl>. | |
824 | ||
825 | Some modules which might prove interesting are Class::Accessor, | |
826 | Class::Class, Class::Contract, Class::Data::Inheritable, | |
827 | Class::MethodMaker and Tie::SecureHash | |
694468e3 GS |
828 | |
829 | =head1 COPYRIGHT | |
830 | ||
831 | Copyright (c) 1999, 2000 by Randal L. Schwartz and Stonehenge | |
832 | Consulting Services, Inc. Permission is hereby granted to distribute | |
833 | this document intact with the Perl distribution, and in accordance | |
834 | with the licenses of the Perl distribution; derived documents must | |
835 | include this copyright notice intact. | |
836 | ||
837 | Portions of this text have been derived from Perl Training materials | |
838 | originally appearing in the I<Packages, References, Objects, and | |
839 | Modules> course taught by instructors for Stonehenge Consulting | |
840 | Services, Inc. and used with permission. | |
841 | ||
842 | Portions of this text have been derived from materials originally | |
843 | appearing in I<Linux Magazine> and used with permission. |