In the first part of this series, I learned how to use Macro Annotations to add a few simple methods to a class and fill
in the implementation of a trait.
My eventual goal is to be able to take a trait which defines a few basic
and automatically generate a class that would read those fields from a
ByteBuffer. Eg., given this:
My macro should generate the equivalent of:
In the previous post, I was only able to add the methods for one fixed trait – not very useful. If I was going to be able to fill in the implementation for any trait, I’d need to use scala reflection to figure out which methods I needed to add. In this post, we’ll learn scala reflection and then generalize our macro to work on any trait.
Once again, I’d like to warn the reader that is not so much a tutorial, as a journal of my path to discovery, with some mistakes and detours along the way.
The first step when using reflection is getting a handle on the
Type of something, using the
typeOf method from our universe. Once we have a type, we can ask for lots
of information, like all methods and variables. (If you’re familiar with reflection in Java, this should all be similar in spirit.)
Note that the
MemberScope returned by
typ.members is a
Traversable, so I can call
filter, etc. Here I’ve filtered down to just the methods, and
also “cast” them to methods with
I only needed to do some small filtering on top of this. I wanted to filter down to only those methods that (1) take no arguments, (2) return either an
Int or a
Float, and (3) that are undefined. I was able to write some fairly straight-forward utility methods to handle the first two:
I could use these on the type of my example trait, and filter out most of the methods I should ignore:
I only had one problem left. I wanted my macro to only supply an implementation for undefined methods. My example trait supplied an implementation for
y, but I hadn’t filtered it out yet.
Detour: Using Reflection on Methods
There is actually a very simple solution to finding defined and undefined methods. But first, I got the crazy idea of using reflection to discover how to use reflection. This is section is totally unnecessary for my end goal, but hopefully you’ll find it interesting nonetheless.
I needed to find some way to differentiate method
x from method
y. My first instinct was to just look at what was available to me with tab-completion,
hoping something would look like
Hmm, scanning the list, i didn’t see anything that jumped out at me. The list of methods was too long to go through them all by hand.
But then I realized – I could use reflection to call of those methods on both
y, and see which ones yielded different results. That is,
I’d be getting
MethodSymbols that were members of
MethodSymbol. (Yes, there was probably an easier way, but now this just sounded fun.)
To call methods using reflection, you first need to get a runtime mirror, from that get an instance mirror, and then finally from there you can call the methods:
Now I could run this on
y to figure out how to find an abstract method:
That was a little disappointing. The only differences were from the name or the method type. I was expecting a method that returned
y (or vice versa). What gives?
So I turned to stackoverflow. Turns out it was an oversight in the reflection api, but there is a workaround.
Nonetheless, that was a fun little experiment in using reflection. (I warned you it was a detour!)
Runtime and Compile Time Universes
So far I’ve been using runtime reflection as an easy way to learn. But to use in my macros, I’d need to switch to compile time reflection. For the most part, reflection is the same, but you use a different
Universe in compile time reflection. Since all of the types are dependent on the universe, this also means all the types of my methods change.
I really wanted to have common methods which worked for both runtime & compile time reflection, and which I could unit test. To support both, I put all of my methods into a helper class which takes a
scala.reflect.api.Universe (the parent to runtime & compile time universes). Then I can instantiate it with either
context.universe in a macro.
The full code is checked into my learn_macros project, even with some simple unit tests.
I’ve got the basics of reflection – now I just needed to get a handle on the
Type of my target trait inside my macro annotation. This one was surprisingly difficult to figure out, I had to turn to stackoverflow and got the answer from Eugene Burmako.
When using my macro annotation, I make the target trait a type parameter on the annotation class, and then pull it out of the type with a call to
Then the annotation can be used like so:
Again, I put together some unit tests to verify the behavior.
Putting It All Together
We’ve got all the key pieces now. We know how to:
- Template our macro annotation with the type of trait it should add.
- Use reflection inside our macro to find all the getters it needs to define.
- Add methods to the existing class defintion (from part 1).
Since what’s left is mostly normal scala coding, I won’t go through it in
detail here. But you can take a look at the full implementations. There are two versions of my annotation,
@ByteBufferBacked with just getters, and
@MutableByteBufferBacked which also adds in setters, which can be used like so:
You can also take a look at the unit tests or just check out the full project and run the tests yourself.
In these two blog posts, we’ve learned how to use scala macro annotations to automatically expand a class definition so that it implements a trait. Along the way we’ve learned the basics of working with ASTs, how to simplify our lives with quasiquotes, and how to use reflection to explore types. Our macro isn’t the most robust yet – it could use a lot more error handling – but we’ve got a taste for how everything works.
I won’t promise more in this series, but there are few more ideas I’d like to explore. First, Eugene Burmako suggested that I could achieve the functionality I want in my library using normal macros, instead of macro annotations. While it would change the user api somewhat, this is particularly appealing because macro annotations won’t make it into scala until 2.12 at the earliest.
Second, now that I’ve got a proof of concept, I’d really like to explore the idea of having classes store their data in
ByteBuffers. Probably most readers are only interested in the discussion of using macros and reflection, but aren’t sure what the point of my macro is. I hope that by expanding these ideas somewhat, I can make it easy to store general purpose data structures directly in byte buffers. That can have all sorts of potential benefits: save memory, avoid serialization, store data off-heap, and lead to more cache-aware data structures (particularly important for numerical computing). And by using macros, we can still keep a clean user api. But, it’s still just an idea, I need to prove those claims.
I hope you’ve found this helpful in your exploration of macros. Please let me know if you found this useful, if parts are unclear, or if you found any errors.
Thanks to all my coworkers at Quantifind for all their help proofreading this!