/ 
parrot-0.7.0
/ art::pp003-oop

Programming Parrot -- Using objects

Yes, you've read correctly. Parrot has the ability to create and manipulate objects (aka, object oriented programming). While it may seem strange for a low-level language like PIR to have the facility for object oriented programming, it makes perfect sense in this particular case. Remember, Parrot's number one goal is to be the underlying implementation for Perl6, which has object oriented features. Parrot's secondary goal is to provide a good platform for other dynamic languages such as Python, Ruby, PHP, Javascript, etc. and those languages too have the ability (if not the requirement) to be object oriented. Thus Parrot contains facilities for a manipulating objects so that language implementors can easily express the appropriate object semantics for their language of interest.

Namespaces

Before I begin talking about how to create classes and instantiate objects, I first need to talk about an intimately related subject: namespaces. Namespaces serve a twofold purpose, they allow you to group related routines together and they allow you to give several subroutines the same name but different, domain specific, implementations. These characteristics are, oddly enough, similar to the basic requirements for a class.

For instance, you may put all of your subroutines dealing with people in a Person namespace and all of your subroutines dealing with computer programs in the Process namespace. Both namespaces may have a subroutine called run() but with radically different implementations. Below is some code to illustrate this example:

Example 1:

.namespace [ "Person" ]

.sub run
    print "Run Forrest, Run!\n"
.end

.namespace [ "Process" ]

.sub run
    print "Running process #53\n"
.end

As you might guess, the .namespace directive tells Parrot what namespace to group subroutines under. A namespace ends when another .namespace directive changes the namespace or when the end of the file is reached. A bare .namespace directive (i.e., with no names in the brackets) changes back to the default namespace.

Perl programmers will recognize that Parrot .namespace declarations are just like Perl package declarations, albeit with different syntax. But there are a few other differences. I'll talk more about how Parrot uses namespaces and classes together in just a minute.

PIR with class

Creating classes in Parrot is relatively easy. There are opcodes for it. The easiest to start with is newclass; just say $P0 = newclass 'Foo' where $P0 is a PMC register, and 'Foo' is the name of the class you want to create.

When you wish to instantiate objects that belong to the class you've created, it's equally simple. Just say myobj = new "Foo" where myobj is a PMC and "Foo" is the classname you've created with newclass. Here's a simple example:

Example 2: A classic Dog

.sub _ :main
    $P0 = newclass 'Dog'
    .local pmc spot
    spot = new 'Dog'
.end

You may notice that I didn't use the return value of newclass. That's only because this is a simple example. :-) I'll talk about what to do with the return value of newclass a little later. Right now, let's talk about methods.

Madness ... er, Methods

So now that I've created a Dog class, how do I add methods to it? Remember before when I talked about namespaces? Well, that's the answer. To add methods to a class, you create a namespace with the same name as the class and then put your subroutines in that namespace. PIR also provides a syntactic marker to let everyone know these subroutines are methods. When declaring the subroutine add the :method modifier after the subroutine name. Here's a familiar example to anyone who has read perlboot.

Example 3: Barnyard animals

.namespace [ "Cow" ]

.sub speak :method
    print "Moo\n"
.end

.namespace [ "Dog" ]

.sub speak :method
    print "Woof\n"
.end

.namespace [ "Pig" ]

.sub speak :method
    print "Oink\n"
.end

.namespace []

.sub _ :main
    $P0 = newclass "Cow"
    $P0 = newclass "Dog"
    $P0 = newclass "Pig"

    .local pmc elsie, fido, porky

    elsie   = new "Cow"
    fido    = new "Dog"
    porky   = new "Pig"

    elsie.'speak'()
    fido.'speak'()
    porky.'speak'()
.end

It's important to note that even though I've declared the namespaces and put subroutines in them, this does not automatically create classes. The newclass declarations tell Parrot to create a class and as a side effect, namespaces with the same name as the class may be used to store methods for that class.

One thing you may notice about method calls is that the method names are quoted. Why is that? In the current design, quoting the method name is the only way to avoid ambiguity between actual method names and local variables that contain the method name.

Example 4: variable methods

.namespace [ 'Foo' ]

.sub foo :method
    print "foo\n"
.end

.sub bar :method
    print "bar\n"
.end

.namespace []

.sub _ :main
    $P0 = newclass "Foo"
    .local pmc f
    f = new "Foo"

    .local string m
    m = "foo"
    f.m()
    m = "bar"
    f.m()
.end

There has been some discussion of changing the syntax slightly so that when a variable is used for the method name, it is designated in some way so that the common case of calling a normal method name does not need to be quoted, but as of this writing, no such change has happened.

But where do I store my stuff?

So far I've talked about namespaces and creating classes and associating methods with those classes, but what about storing data in the class? Remember how the newclass opcode returned a PMC that I didn't do anything to/with? Well, here's where it's used. The PMC returned from newclass is the handle by which you manipulate the class. One such manipulation involves class "attributes". Attributes are where you store your class-specific data.

Parrot has several opcodes for manipulating attributes; they are: addattribute, setattribute, and getattribute. The addattribute opcode lets you add a spot in the class for storing a particular value which may be get and set with getattribute and setattribute respectively. The only restriction on these values is that currently all attributes must be PMCs.

So, say I wanted to give my barnyard animals names (I'll illustrate with just one animal and you can infer how to do the same for the rest):

Example 5: Naming my animals

.namespace [ "Dog" ]

.sub name :method
    .local pmc name
    name = getattribute self, "name"
    print name
.end

.sub speak :method
    print "woof"
.end

.namespace []

.sub _ :main
    $P0 = newclass "Dog"
    addattribute $P0, "name"

    .local pmc dog
    dog = new "Dog"
    $P0 = new "String"
    $P0 = "Phideaux"
    setattribute dog, "name", $P0

    dog.'name'()
    print " says "
    dog.'speak'()
    print "!\n"
.end

Whew! There's a lot of new stuff in this code. I'll take them starting from the top of the program and working towards the bottom.

One of the benefits of tagging your subroutines as methods is that they get a PMC named self that represents the object they are acting on behalf of. The name method takes advantage of this to retrieve the attribute called "name" from the self PMC and print it.

Immediately after I create the class called "Dog", I use the PMC handle returned from newclass to add an attribute called "name" to the class. This just allocates a slot in the class for the value, it does nothing more.

Next, I create a new Dog and give it a name. Because attributes may only be PMCs, in order to give the Dog a name, I first have to create a new String PMC (this is one of the PMCs builtin to Parrot) and assign the name I wish to give the dog to this PMC. Then I can pass this PMC as a parameter to setattribute to give my Dog a name.

Seems kind of complicated, doesn't it? Especially when you think about doing this for each animal. Each animal namespace would have an identical version of the name method. For each call to newclass I'd need to also call addattribute so that all of the animals may have a name. Each time I wish to assign a name to an animal, I'd first need to create a .String and call setattribute on it. Et cetera.

Surely there's a better way?!? There is ...

Inheritance

You saw it coming didn't you? What's object oriented programming without inheritance? Parrot has an opcode subclass that lets you inherit data and methods from an existing class. We can use this ability to create a base class called "Animal" that contains the "name" attribute and 2 methods that are common to all animals: setname and getname Then, to create new animals, I just inherit from the Animal base class like so:

Example 6: inheriting

...
$P0 = newclass "Animal"
addattribute $P0, "name"
$P0 = subclass "Animal", "Cow"
$P0 = subclass "Animal", "Dog"
$P0 = subclass "Animal", "Pig"
...
cow = new 'Cow'
cow.'setname'("Elsie")
...
cow.'getname'()

Each subclass will contain an attribute called "name" that can be used to store the name of the animal. The setname method abstracts out the process of creating a String PMC and calling setattribute on it. And finally the getname method becomes a wrapper around getattribute.

Wrapup

I hope this gives you an idea of how to do object oriented programming using Parrot. The opcodes illustrated here are what any language implementor that targets Parrot would use to implement object oriented features in their language. Of course there are more opcodes for richer object oriented behavior available in Parrot. This article only covers the basics. For more information see parrot/docs/pdds/pdd15_objects.pod.

At the end of this article is a more complete listing of the program that gives my barnyard animals voices. There are many improvements that can be made to this code so take this opportunity to read and experiment and learn more about OOP in Parrot.

Acknowledgements

    * Thanks to Randal Schwartz for providing a neat set of examples in perlboot from which this article shamelessly borrows. * Thanks to the Parrot people for feedback

Author

Jonathan Scott Duff

Example 6: Full barnyard listing

.namespace [ "Animal" ]

.sub setname :method
    .param string name
    $P0 = new 'String'
    $P0 = name
    setattribute self, "name", $P0
.end

.sub getname :method
    $P0 = getattribute self, "name"
    print $P0
.end

.sub speak :method
    .local string name, sound
    name = self.'getname'()
    sound = self.'sound'()
    print name
    print " says "
    print sound
    print "\n"
.end

.namespace [ "Cow" ]

.sub sound :method
    .return( "moo" )
.end

.namespace [ "Dog" ]

.sub sound :method
    .return( "woof" )
.end

.namespace [ "Pig" ]

.sub sound :method
    .return( "oink" )
.end

.namespace []

.sub _ :main
    $P0 = newclass "Animal"
    addattribute $P0, "name"
    $P0 = subclass "Animal", "Cow"
    $P0 = subclass "Animal", "Dog"
    $P0 = subclass "Animal", "Pig"

    .local pmc cow, dog, pig

    cow   = new "Cow"
    cow.'setname'("Elsie")
    dog    = new "Dog"
    dog.'setname'("Snoopy")
    pig   = new "Pig"
    pig.'setname'("Porky")

    cow.'speak'()
    dog.'speak'()
    pig.'speak'()
.end