Blaine Buxton: Positronic Vibrations From Alto Dorado

So, I whipped out the following code to get words from a character stream (input). I read the next word (all alpha-numeric characters) and return it or nil if none were found. Simple, huh? Here's my implementation:

nextWord
 | wordString |
 wordStream := String new writeStream.
 input do: 
  [:next |
  next isAlphaNumeric
   ifTrue: [wordStream nextPut: next]
   ifFalse: 
    [wordString := wordStream contents.
     wordString isEmpty ifFalse: [^Word on: wordString]].
 wordString := wordStream contents.
 ^wordString isEmpty
  ifTrue: [nil]
  ifFalse: [Word on: wordString]

Simple, but the duplication in it was bugging me. So, I thought, "If I made a block that did the duplicated code, what would that look like?" I quickly made my changes and it looked like this:

nextWord
 | return |
 wordStream := String new writeStream.
 return := [| wordString |
   wordString := wordStream contents.
   wordString isEmpty ifFalse: [^Word on: wordString]].
 input do: 
  [:next | 
   next isAlphaNumeric 
   ifTrue: [wordStream nextPut: next]
   ifFalse: [return value]].
 return value.
 ^nil

Even simpler! This has a distinctive functional programming style to it. I'm using the block to return from the method which is unusual to be used liked this. But, it was in the spirit of "saying it only once". You might think the return could be moved out of the block, but I only want to return if wordStream contents are empty.

I could have done the same thing with exceptions, but it would been cumbersome in such a small method. The duplication is gone and the meat of the method is clear. Exceptions are useful when returns need to happen in nested method calls.

The fun thing about this example is that you could use blocks with return to bail out of searches instead of using Exceptions. Of course, you can do the same thing in Ruby. This is the first opportunity to explore this and like all tricks you should think about its use before you do it. I thought it fit perfectly for this method.

Blocks and closures are too cool. They can help in so many ways. But, they need to be cheap.

posted by Blaine at 8:35 PM |  1 comments |  Post a Comment